fortinet.fortimanager.fmgr_switchcontroller_vlanpolicy 模块 – 配置 VLAN 策略，通过 dynamic-port-policy 应用于受管的 FortiSwitch 端口。

注意

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

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

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

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

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_vlanpolicy

字典

顶级参数集。

allowed_vlans

别名: allowed-vlans

任意

（列表）使用此 VLAN 策略时允许应用的 VLAN。

allowed_vlans_all

别名: allowed-vlans-all

字符串

使用此 VLAN 策略时，启用/禁用所有已定义的 VLAN。

选项

  • "disable"

  • "enable"

description

字符串

VLAN 策略的描述。

discard_mode

别名: discard-mode

字符串

使用此 VLAN 策略时要应用的丢弃模式。

选项

  • "none"

  • "all-untagged"

  • "all-tagged"

任意

（列表）此 VLAN 策略所属的 FortiLink 接口。

name

字符串 / 必需

VLAN 策略名称。

untagged_vlans

别名: untagged-vlans

任意

（列表）使用此 VLAN 策略时要应用的未标记 VLAN。

vlan

字符串

使用此 VLAN 策略时要应用的本机 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 VLAN policy to be applied on the managed FortiSwitch ports through dynamic-port-policy.
      fortinet.fortimanager.fmgr_switchcontroller_vlanpolicy:
        # 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_vlanpolicy:
          allowed_vlans: <list or string>
          allowed_vlans_all: <value in [disable, enable]>
          description: <string>
          discard_mode: <value in [none, all-untagged, all-tagged]>
          name: <string>
          untagged_vlans: <list or string>
          vlan: <string>
          fortilink: <list or string>

返回值

通用返回值记录在 这里，以下是此模块特有的字段

键

描述

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)