fortinet.fortimanager.fmgr_wtpprofile_platform 模块 – WTP、FortiAP 或 AP 平台。

注意

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

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

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

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

fortinet.fortimanager 2.0.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 代码列表。

workspace_locking_adom

字符串

在工作区模式下为 FortiManager 锁定的 adom，该值可以是 global 和其他值，包括 root。

workspace_locking_timeout

整数

等待其他用户释放工作区锁的最大时间（秒）。

默认值： 300

wtp-profile

字符串

已弃用，请使用“wtp_profile”

wtp_profile

字符串

请求 URL 中的参数 (wtp-profile)。

wtpprofile_platform

字典

设置的顶级参数。

_local_platform_str

字符串

本地平台字符串。

ddscan

字符串

启用/禁用使用一个无线电进行专用的双频段扫描以检测 RF 特性并进行无线威胁管理。

选项

  • "disable"

  • "enable"

mode

字符串

配置 5G 无线电的操作模式

选项

  • "dual-5G"

  • "single-5G"

type

字符串

WTP、FortiAP 或 AP 平台类型。

选项

  • "30B-50B"

  • "60B"

  • "80CM-81CM"

  • "220A"

  • "220B"

  • "210B"

  • "60C"

  • "222B"

  • "112B"

  • "320B"

  • "11C"

  • "14C"

  • "223B"

  • "28C"

  • "320C"

  • "221C"

  • "25D"

  • "222C"

  • "224D"

  • "214B"

  • "21D"

  • "24D"

  • "112D"

  • "223C"

  • "321C"

  • "C220C"

  • "C225C"

  • "S321C"

  • "S323C"

  • "FWF"

  • "S311C"

  • "S313C"

  • "AP-11N"

  • "S322C"

  • "S321CR"

  • "S322CR"

  • "S323CR"

  • "S421E"

  • "S422E"

  • "S423E"

  • "421E"

  • "423E"

  • "C221E"

  • "C226E"

  • "C23JD"

  • "C24JE"

  • "C21D"

  • "U421E"

  • "U423E"

  • "221E"

  • "222E"

  • "223E"

  • "S221E"

  • "S223E"

  • "U221EV"

  • "U223EV"

  • "U321EV"

  • "U323EV"

  • "224E"

  • "U422EV"

  • "U24JEV"

  • "321E"

  • "U431F"

  • "U433F"

  • "231E"

  • "431F"

  • "433F"

  • "231F"

  • "432F"

  • "234F"

  • "23JF"

  • "U231F"

  • "831F"

  • "U234F"

  • "U432F"

  • "431FL"

  • "432FR"

  • "433FL"

  • "231FL"

  • "231G"

  • "233G"

  • "431G"

  • "433G"

  • "U231G"

  • "U441G"

  • "234G"

  • "432G"

  • "441K"

  • "443K"

  • "241K"

  • "243K"

  • "231K"

  • "23JK"

注释

注意

  • 从 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: WTP, FortiAP, or AP platform.
      fortinet.fortimanager.fmgr_wtpprofile_platform:
        # 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>
        wtp_profile: <your own value>
        wtpprofile_platform:
          type: <value in [30B-50B, 60B, 80CM-81CM, ...]>
          mode: <value in [dual-5G, single-5G]>
          ddscan: <value in [disable, enable]>
          _local_platform_str: <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

列表 / 元素=字符串

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

返回： 复杂类型

作者

  • 杜欣伟 (@dux-fortinet)

  • 李星 (@lix-fortinet)

  • 薛杰 (@JieX19)

  • 郑琳 (@chillancezen)

  • 沈方 (@fshen01)

  • 陆洪斌 (@fgtdev-hblu)