fortinet.fortimanager.fmgr_switchcontroller_fortilinksettings_nacports 模块 – NAC 特定配置。

注意

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

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

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

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

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 客户端。

字符串

已弃用，请使用 “fortilink_settings”

fortilink_settings

字符串

请求的 URL 中的参数 (fortilink-settings)。

proposed_method

字符串

底层 Json RPC 请求的覆盖方法。

选择

  • "update"

  • "set"

  • "add"

rc_failed

列表 / elements=integer

将覆盖失败条件的 rc 代码列表。

rc_succeeded

列表 / elements=integer

将覆盖成功条件的 rc 代码列表。

switchcontroller_fortilinksettings_nacports

字典

设置的顶级参数。

bounce_nac_port

别名：bounce-nac-port

字符串

启用/禁用反弹

选择

  • "disable"

  • "enable"

lan_segment

别名：lan-segment

字符串

在 FortiLink 接口上启用/禁用 LAN 段功能。

选择

  • "disabled"

  • "enabled"

member_change

别名：member-change

整数

成员更改。

nac_lan_interface

别名：nac-lan-interface

字符串

配置 NAC LAN 接口。

nac_segment_vlans

别名：nac-segment-vlans

任意

（列表）配置 NAC 段 VLAN。

onboarding_vlan

别名：onboarding-vlan

字符串

发现 NAC 设备时的默认 NAC 入职 VLAN。

parent_key

别名：parent-key

字符串

父键。

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 帮助完成工作。

  • 通常，当返回非零 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: NAC specific configuration.
      fortinet.fortimanager.fmgr_switchcontroller_fortilinksettings_nacports:
        # 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>
        fortilink_settings: <your own value>
        switchcontroller_fortilinksettings_nacports:
          lan_segment: <value in [disabled, enabled]>
          member_change: <integer>
          nac_lan_interface: <string>
          nac_segment_vlans: <list or string>
          onboarding_vlan: <string>
          parent_key: <string>
          bounce_nac_port: <value in [disable, enable]>

返回值

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

键

描述

元

字典

请求的结果。

返回：始终

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)