fortinet.fortimanager.fmgr_switchcontroller_dynamicportpolicy_policy 模块 – 具有匹配标准和操作的端口策略。

注意

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

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

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

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

fortinet.fortimanager 2.2.0 中的新增功能

概要

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

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

参数

参数

注释

access_token

字符串

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

adom

字符串 / 必需

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

bypass_validation

布尔值

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

选项

  • false ← (默认)

  • true

dynamic-port-policy

字符串

已弃用，请使用“dynamic_port_policy”

dynamic_port_policy

字符串

请求的 URL 中的参数 (dynamic-port-policy)。

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_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，该值可以是全局的和其他值（包括 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: Port policies with matching criteria and actions.
      fortinet.fortimanager.fmgr_switchcontroller_dynamicportpolicy_policy:
        # 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>
        dynamic_port_policy: <your own value>
        state: present # <value in [present, absent]>
        switchcontroller_dynamicportpolicy_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]>

返回值

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

键

描述

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)