fortinet.fortimanager.fmgr_switchcontroller_dynamicportpolicy 模块 – 配置通过 DPP 设备应用在托管 FortiSwitch 端口上的动态端口策略。

注意

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

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

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

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

fortinet.fortimanager 2.2.0 中的新增功能

概要

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

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

参数

参数

注释

access_token

字符串

在不使用用户名和密码的情况下访问 FortiManager 的令牌。

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

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"

switchcontroller_dynamicportpolicy

字典

设置的顶级参数。

description

字符串

动态端口策略的描述。

任意

（列表）此动态端口策略所属的 FortiLink 接口。

name

字符串 / 必需

动态端口策略名称。

policy

列表 / 元素=字典

策略。

802_1x

别名：802-1x

字符串

bounce_port_link

别名：bounce-port-link

字符串

启用/禁用反弹

选择

  • "disable"

  • "enable"

category

字符串

动态端口策略的类别。

选择

  • "device"

  • "interface-tag"

description

字符串

策略的描述。

family

字符串

基于系列匹配策略。

host

字符串

基于主机匹配策略。

hw_vendor

别名：hw-vendor

字符串

基于硬件供应商匹配策略。

interface_tags

别名：interface-tags

任意

（列表）基于 FortiSwitch 接口对象标签匹配策略。

lldp_profile

别名：lldp-profile

字符串

使用此策略时要应用的 LLDP 配置文件。

mac

字符串

基于 MAC 地址匹配策略。

match_period

别名：match-period

整数

保留匹配设备的天数

match_type

别名：match-type

字符串

基于类型匹配并保留设备。

选择

  • "dynamic"

  • "override"

name

字符串

策略名称。

qos_policy

别名：qos-policy

字符串

使用此策略时要应用的 QoS 策略。

status

字符串

启用/禁用策略。

选择

  • "disable"

  • "enable"

type

字符串

基于类型匹配策略。

vlan_policy

别名：vlan-policy

字符串

使用此策略时要应用的 VLAN 策略。

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 (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: Configure Dynamic port policy to be applied on the managed FortiSwitch ports through DPP device.
      fortinet.fortimanager.fmgr_switchcontroller_dynamicportpolicy:
        # 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]>
        switchcontroller_dynamicportpolicy:
          description: <string>
          name: <string>
          policy:
            -
              802_1x: <string>
              bounce_port_link: <value in [disable, enable]>
              category: <value in [device, interface-tag]>
              description: <string>
              family: <string>
              host: <string>
              hw_vendor: <string>
              interface_tags: <list or string>
              lldp_profile: <string>
              mac: <string>
              name: <string>
              qos_policy: <string>
              status: <value in [disable, enable]>
              type: <string>
              vlan_policy: <string>
              match_period: <integer>
              match_type: <value in [dynamic, override]>
          fortilink: <list or string>

返回值

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

键

描述

元数据

字典

请求的结果。

返回： 总是

请求网址

字符串

请求的完整 URL。

返回： 总是

示例： "/sys/login/user"

响应代码

整数

API 请求的状态。

返回： 总是

示例： 0

响应数据

列表 / 元素=字符串

API 响应。

返回： 总是

响应消息

字符串

API 响应的描述性消息。

返回： 总是

示例： "OK."

系统信息

字典

目标系统的信息。

返回： 总是

rc

整数

请求的状态。

返回： 总是

示例： 0

版本检查警告

列表 / 元素=字符串

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

返回： 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)