fortinet.fortimanager.fmgr_firewall_internetservice 模块 – 显示互联网服务应用程序。

注意

此模块是 fortinet.fortimanager 集合（版本 2.8.2）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install fortinet.fortimanager。

要在 playbook 中使用它，请指定：fortinet.fortimanager.fmgr_firewall_internetservice。

fortinet.fortimanager 2.0.0 中的新增功能

概要

  • 此模块能够配置 FortiManager 设备。

  • 示例包括所有参数和值，在使用前需要根据数据源进行调整。

参数

参数

注释

access_token

字符串

用于访问 FortiManager 的令牌，无需使用用户名和密码。

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

仅当模块架构与 FortiManager API 结构不同时才设置为 True，模块将继续执行而不验证参数。

选择

  • false ←（默认）

  • true

enable_log

布尔值

启用/禁用任务日志记录。

选择

  • false ←（默认）

  • true

firewall_internetservice

字典

设置的顶级参数。

city

任何

（列表）城市序号列表。

city6

任何

（列表）IPv6 城市序号列表。

country

任何

（列表）国家序号列表。

country6

任何

（列表）IPv6 国家序号列表。

database

字符串

数据库。

选择

  • "isdb"

  • "irdb"

direction

字符串

方向。

选择

  • "src"

  • "dst"

  • "both"

entry

列表 / elements=字典

条目。

id

整数

条目 ID。

ip_number

别名：ip-number

整数

IP 地址总数。

ip_range_number

别名：ip-range-number

整数

IP 范围总数。

port

任何

（列表）TCP/IP 端口的整数值

protocol

整数

IANA 定义的协议类型的整数值

extra_ip6_range_number

别名：extra-ip6-range-number

整数

额外的 ip6 范围数。

extra_ip_range_number

别名：extra-ip-range-number

整数

额外的 IP 范围数。

icon_id

别名：icon-id

整数

图标 ID。

id

整数

Id。

ip6_range_number

别名：ip6-range-number

整数

Ip6 范围数。

ip_number

别名：ip-number

整数

IP 数。

ip_range_number

别名：ip-range-number

整数

IP 范围数。

jitter_threshold

别名：jitter-threshold

整数

抖动阈值。

latency_threshold

别名：latency-threshold

整数

延迟阈值。

name

字符串

名称。

obsolete

整数

已过时。

offset

整数

偏移量。

packetloss_threshold

别名：packetloss-threshold

整数

丢包阈值。

region

任何

（列表）区域序号列表。

region6

任何

（列表）IPv6 区域序号列表。

reputation

整数

信誉。

singularity

整数

单点性。

sld_id

别名：sld-id

整数

Sld id。

forticloud_access_token

字符串

使用 forticloud API 访问令牌验证 Ansible 客户端。

proposed_method

字符串

用于底层 Json RPC 请求的覆盖方法。

选择

  • "update"

  • "set"

  • "add"

rc_failed

列表 / elements=整数

将覆盖失败条件的 rc 代码列表。

rc_succeeded

列表 / elements=整数

将覆盖成功条件的 rc 代码列表。

workspace_locking_adom

字符串

用于在工作区模式下运行的 FortiManager 的锁定 adom，该值可以是 global 和其他值，包括 root。

workspace_locking_timeout

整数

等待其他用户释放工作区锁定的最长时间（以秒为单位）。

默认值： 300

注意

注意

  • 从 2.4.0 版本开始，所有输入参数都使用下划线命名约定 (snake_case) 命名。请将诸如 “var-name” 之类的参数更改为 “var_name”。旧的参数名称仍然可用，但您会收到弃用警告。您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。

  • 此 FortiManager 模块支持在工作区锁定模式下运行，顶级参数 workspace_locking_adom 和 workspace_locking_timeout 有助于完成工作。

  • 通常情况下，当返回非零 rc 值时，运行一个模块可能会失败。您也可以使用参数 rc_failed 和 rc_succeeded 来覆盖失败或成功的条件。

示例

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Show Internet Service application.
      fortinet.fortimanager.fmgr_firewall_internetservice:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        firewall_internetservice:
          database: <value in [isdb, irdb]>
          direction: <value in [src, dst, both]>
          entry:
            -
              id: <integer>
              ip_number: <integer>
              ip_range_number: <integer>
              port: <list or integer>
              protocol: <integer>
          icon_id: <integer>
          id: <integer>
          name: <string>
          offset: <integer>
          reputation: <integer>
          sld_id: <integer>
          extra_ip_range_number: <integer>
          ip_number: <integer>
          ip_range_number: <integer>
          jitter_threshold: <integer>
          latency_threshold: <integer>
          obsolete: <integer>
          packetloss_threshold: <integer>
          singularity: <integer>
          city: <list or integer>
          country: <list or integer>
          region: <list or integer>
          city6: <list or integer>
          country6: <list or integer>
          extra_ip6_range_number: <integer>
          ip6_range_number: <integer>
          region6: <list or integer>

返回值

常见的返回值记录在此处，以下是此模块特有的字段

键

描述

meta

字典

请求的结果。

返回: 始终

request_url

字符串

请求的完整 URL。

返回: 始终

示例: "/sys/login/user"

response_code

整数

API 请求的状态。

返回: 始终

示例: 0

response_data

列表 / 元素=字符串

API 响应。

返回: 始终

response_message

字符串

API 响应的描述性消息。

返回: 始终

示例: "OK."

system_information

字典

目标系统的信息。

返回: 始终

rc

整数

请求的状态。

返回: 始终

示例: 0

version_check_warning

列表 / 元素=字符串

如果 playbook 中使用的参数不受当前 FortiManager 版本支持的警告。

返回: 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)