fortinet.fortimanager.fmgr_system_interface 模块 – 接口配置。

注意

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

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

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

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

fortinet.fortimanager 1.0.0 中的新增功能

概要

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

• 示例包含所有需要在使用前根据数据源调整的参数和值。

参数

参数	注释
access_token 字符串	无需使用用户名和密码即可访问 FortiManager 的令牌。
bypass_validation 布尔值	仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而无需验证参数。 选项 false ← (默认) true
enable_log 布尔值	启用/禁用任务的日志记录。 选项 false ← (默认) true
forticloud_access_token 字符串	使用 forticloud API 访问令牌验证 Ansible 客户端。
proposed_method 字符串	底层 Json RPC 请求的覆盖方法。 选项 "update" "set" "add"
rc_failed 列表 / 元素=整数	将覆盖失败条件的 rc 代码列表。
rc_succeeded 列表 / 元素=整数	将覆盖成功条件的 rc 代码列表。
state 字符串 / 必填	创建、更新或删除对象的指令。 选项 "present" "absent"
system_interface 字典	设置的顶级参数。
aggregate 字符串	聚合接口。
alias 字符串	别名。
allowaccess 列表 / 元素=字符串	允许对接口进行管理访问。 ping - PING 访问。 https - HTTPS 访问。 ssh - SSH 访问。 snmp - SNMP 访问。 http - HTTP 访问。 webservice - Web 服务访问。 https-logging - 通过 HTTPS 访问进行日志记录。 选项 "ping" "https" "ssh" "snmp" "http" "webservice" "https-logging" "soc-fabric" "fabric"
defaultgw 字符串	启用/禁用默认网关。 disable - 禁用设置。 enable - 启用设置。 选项 "disable" "enable"
description 字符串	描述。
dhcp_client_identifier 别名：dhcp-client-identifier 字符串	DHCP 客户端标识符。
dns_server_override 别名：dns-server-override 字符串	启用/禁用使用 DHCP 或 PPPoE 获取的 DNS。 disable - 禁用设置。 enable - 启用设置。 选项 "disable" "enable"
interface 字符串	底层接口名称。
ip 字符串	接口的 IP 地址。
ipv6 字典	IPv6。
ip6_address 别名：ip6-address 字符串	接口的 IPv6 地址/前缀。
ip6_allowaccess 别名：ip6-allowaccess 列表 / 元素=字符串	允许对接口进行管理访问。 ping - PING 访问。 https - HTTPS 访问。 ssh - SSH 访问。 snmp - SNMP 访问。 http - HTTP 访问。 webservice - Web 服务访问。 https-logging - 通过 HTTPS 访问进行日志记录。 选项 "ping" "https" "ssh" "snmp" "http" "webservice" "https-logging" "fabric"
ip6_autoconf 别名：ip6-autoconf 字符串	启用/禁用地址自动配置 disable - 禁用设置。 enable - 启用设置。 选项 "disable" "enable"
lacp_mode 别名：lacp-mode 字符串	LACP 模式。 active - 主动使用 LACP 来协商 802.3ad。 选项 "active"
lacp_speed 别名：lacp-speed 字符串	接口发送 LACP 消息的频率。 slow - 每 30 秒发送一次 LACP 消息。 fast - 每秒发送一次 LACP 消息。 选项 "slow" "fast"
link_up_delay 别名：link-up-delay 整数	在认为链路已连接之前要等待的毫秒数。
lldp 字符串	启用/禁用 LLDP disable - 禁用设置。 enable - 启用设置。 选项 "disable" "enable"
member 列表 / 元素=字典	成员。
interface_name 别名：interface-name 字符串	物理接口名称。
min_links 别名：min-links 整数	必须处于活动状态的最小聚合端口数。
min_links_down 别名：min-links-down 字符串	当活动链接数少于配置的最小链接数时要采取的操作。 operational - 将聚合设置为操作性关闭。 administrative - 将聚合设置为管理性关闭。 选项 "operational" "administrative"
mode 字符串	寻址模式 static - 静态设置。 dhcp - 外部 DHCP 客户端模式。 选项 "static" "dhcp"
mtu 整数	最大传输单元
mtu_override 别名：mtu-override 字符串	启用/禁用使用 DHCP 或 PPPoE 获取的 MTU。 disable - 禁用设置。 enable - 启用设置。 选项 "disable" "enable"
name 字符串 / 必填	接口名称。
rating_service_ip 别名：rating-service-ip 字符串	fgt 评级服务的 IP 地址，必须与接口 IP 位于同一子网。
serviceaccess 列表 / 元素=字符串	允许对接口进行服务访问。 fgtupdates - FortiGate 更新访问。 fclupdates - FortiClient 更新访问。 webfilter-antispam - Web 过滤和反垃圾邮件访问。 选项 "fgtupdates" "fclupdates" “webfilter-antispam”
速度 字符串	速度。 auto - 自动调整速度。 10full - 10M 全双工。 10half - 10M 半双工。 100full - 100M 全双工。 100half - 100M 半双工。 1000full - 1000M 全双工。 10000full - 10000M 全双工。 选项 “auto” “10full” “10half” “100full” “100half” “1000full” “10000full” “1g/full” “2.5g/full” “5g/full” “10g/full” “14g/full” “20g/full” “25g/full” “40g/full” “50g/full” “56g/full” “100g/full” “1g/half” “200g/full” “400g/full”
状态 字符串	接口状态。 down - 接口关闭。 up - 接口开启。 选项 “down” “up” "disable" "enable"
类型 字符串	接口类型。 vlan - VLAN 接口。 physical - 物理接口。 aggregate - 聚合接口。 选项 “vlan” “physical” “aggregate”
update_service_ip 别名: update-service-ip 字符串	FGT/FCT 更新服务的IP地址，必须与接口IP位于同一子网。
vlan_protocol 别名: vlan-protocol 字符串	VLAN 的以太网协议。 8021q - IEEE 802.1Q。 8021ad - IEEE 802.1ad。 选项 “8021q” “8021ad”
vlanid 整数	VLAN ID
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 有助于完成此工作。

• 要创建或更新对象，请使用 state present 指令。

• 要删除对象，请使用 state absent 指令。

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

示例

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Interface configuration.
      fortinet.fortimanager.fmgr_system_interface:
        bypass_validation: false
        state: present
        system_interface:
          allowaccess:
            - ping
          ip: "222.222.22.2/24"
          mtu: 1500
          name: port4
          serviceaccess:
            - fgtupdates
          speed: auto # <value in [auto, 10full, 10half, ...]>
          status: up

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the interfaces
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_interface"
          params:
            interface: "your_value"

返回值

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

键	描述
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 列表 / 元素=字符串	如果剧本中使用的参数不受当前 FortiManager 版本支持，则会发出警告。 返回值: 复杂类型

作者

• 杜欣蔚 (@dux-fortinet)

• 李星 (@lix-fortinet)

• 薛杰 (@JieX19)

• 郑链 (@chillancezen)

• 沈方 (@fshen01)

• 陆洪滨 (@fgtdev-hblu)

资源链接

• 问题跟踪器
• 主页
• 代码仓库