fortinet.fortimanager.fmgr_dynamic_interface 模块 – 动态接口

注意

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

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

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

要在剧本中使用它，请指定：fortinet.fortimanager.fmgr_dynamic_interface。

fortinet.fortimanager 2.0.0 中的新增功能

概要

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

  • 示例包括所有参数和值，这些参数和值需要在使用前调整为数据源。

参数

参数

注释

access_token

字符串

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

adom

字符串 / 必需

请求的 URL 中的参数 (adom)。

bypass_validation

布尔值

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

选择

  • false ← (默认)

  • true

dynamic_interface

字典

顶层参数集。

color

整数

颜色。

default_mapping

别名: default-mapping

字符串

默认映射。

选择

  • "disable"

  • "enable"

defmap_intf

别名: defmap-intf

字符串

Defmap intf。

defmap_intrazone_deny

别名: defmap-intrazone-deny

字符串

Defmap intrazone deny。

选择

  • "disable"

  • "enable"

defmap_zonemember

别名: defmap-zonemember

任何

(列表) Defmap zonemember。

description

字符串

描述。

dynamic_mapping

列表 / 元素=字典

动态映射。

_scope

列表 / 元素=字典

范围。

name

字符串

名称。

vdom

字符串

Vdom。

egress_shaping_profile

别名: egress-shaping-profile

任何

(列表或字符串) Egress shaping profile。

ingress_shaping_profile

别名: ingress-shaping-profile

任何

(列表或字符串) Ingress shaping profile。

intrazone_deny

别名: intrazone-deny

字符串

Intrazone deny。

选择

  • "disable"

  • "enable"

local_intf

别名: local-intf

任何

(列表) Local intf。

egress_shaping_profile

别名: egress-shaping-profile

任何

(列表或字符串) Egress shaping profile。

ingress_shaping_profile

别名: ingress-shaping-profile

任何

(列表或字符串) Ingress shaping profile。

name

字符串 / 必需

名称。

platform_mapping

列表 / 元素=字典

平台映射。

egress_shaping_profile

别名: egress-shaping-profile

任何

(列表或字符串) Egress shaping profile。

ingress_shaping_profile

别名: ingress-shaping-profile

任何

(列表或字符串) Ingress shaping profile。

intf_zone

别名: intf-zone

字符串

Intf zone。

intrazone_deny

别名: intrazone-deny

字符串

Intrazone deny。

选择

  • "disable"

  • "enable"

name

字符串

名称。

single_intf

别名: single-intf

字符串

Single intf。

选择

  • "disable"

  • "enable"

wildcard

字符串

通配符。

选择

  • "disable"

  • "enable"

wildcard_intf

别名: wildcard-intf

字符串

Wildcard intf。

zone_only

别名: zone-only

字符串

Zone only。

选择

  • "disable"

  • "enable"

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"

workspace_locking_adom

字符串

在工作区模式下为 FortiManager 锁定的 adom，该值可以是全局的以及其他包括 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 有助于完成工作。

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

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

  • 通常，当返回非零 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: Dynamic interface
      fortinet.fortimanager.fmgr_dynamic_interface:
        # 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>
        state: present # <value in [present, absent]>
        dynamic_interface:
          color: <integer>
          default_mapping: <value in [disable, enable]>
          defmap_intf: <string>
          defmap_intrazone_deny: <value in [disable, enable]>
          defmap_zonemember: <list or string>
          description: <string>
          dynamic_mapping:
            -
              _scope:
                -
                  name: <string>
                  vdom: <string>
              egress_shaping_profile: <list or string>
              intrazone_deny: <value in [disable, enable]>
              local_intf: <list or string>
              ingress_shaping_profile: <list or string>
          egress_shaping_profile: <list or string>
          name: <string>
          single_intf: <value in [disable, enable]>
          ingress_shaping_profile: <list or string>
          platform_mapping:
            -
              egress_shaping_profile: <list or string>
              ingress_shaping_profile: <list or string>
              intf_zone: <string>
              intrazone_deny: <value in [disable, enable]>
              name: <string>
          wildcard: <value in [disable, enable]>
          wildcard_intf: <string>
          zone_only: <value in [disable, enable]>

返回值

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

键

描述

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)