fortinet.fortimanager.fmgr_system_npu_dswqueuedtsprofile 模块 – 配置 NPU DSW 队列 DTS 配置文件。

注意

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

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

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

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

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"

system_npu_dswqueuedtsprofile

字典

设置的顶级参数。

iport

字符串

设置 NPU DSW DTS 输入端口。

选项

  • "EIF0"

  • "eif0"

  • "EIF1"

  • "eif1"

  • "EIF2"

  • "eif2"

  • "EIF3"

  • "eif3"

  • "EIF4"

  • "eif4"

  • "EIF5"

  • "eif5"

  • "EIF6"

  • "eif6"

  • "EIF7"

  • "eif7"

  • "HTX0"

  • "htx0"

  • "HTX1"

  • "htx1"

  • "SSE0"

  • "sse0"

  • "SSE1"

  • "sse1"

  • "SSE2"

  • "sse2"

  • "SSE3"

  • "sse3"

  • "RLT"

  • "rlt"

  • "DFR"

  • "dfr"

  • "IPSECI"

  • "ipseci"

  • "IPSECO"

  • "ipseco"

  • "IPTI"

  • "ipti"

  • "IPTO"

  • "ipto"

  • "VEP0"

  • "vep0"

  • "VEP2"

  • "vep2"

  • "VEP4"

  • "vep4"

  • "VEP6"

  • "vep6"

  • "IVS"

  • "ivs"

  • "L2TI1"

  • "l2ti1"

  • "L2TO"

  • "l2to"

  • "L2TI0"

  • "l2ti0"

  • "PLE"

  • "ple"

  • "SPATH"

  • "spath"

  • "QTM"

  • "qtm"

name

字符串 / 必需

名称。

oport

字符串

设置 NPU DSW DTS 输出端口。

选项

  • "EIF0"

  • "eif0"

  • "EIF1"

  • "eif1"

  • "EIF2"

  • "eif2"

  • "EIF3"

  • "eif3"

  • "EIF4"

  • "eif4"

  • "EIF5"

  • "eif5"

  • "EIF6"

  • "eif6"

  • "EIF7"

  • "eif7"

  • "HRX"

  • "hrx"

  • "SSE0"

  • "sse0"

  • "SSE1"

  • "sse1"

  • "SSE2"

  • "sse2"

  • "SSE3"

  • "sse3"

  • "RLT"

  • "rlt"

  • "DFR"

  • "dfr"

  • "IPSECI"

  • "ipseci"

  • "IPSECO"

  • "ipseco"

  • "IPTI"

  • "ipti"

  • "IPTO"

  • "ipto"

  • "VEP0"

  • "vep0"

  • "VEP2"

  • "vep2"

  • "VEP4"

  • "vep4"

  • "VEP6"

  • "vep6"

  • "IVS"

  • "ivs"

  • "L2TI1"

  • "l2ti1"

  • "L2TO"

  • "l2to"

  • "L2TI0"

  • "l2ti0"

  • "PLE"

  • "ple"

  • "SYNK"

  • "sync"

  • "NSS"

  • "nss"

  • "TSK"

  • "tsk"

  • "QTM"

  • "qtm"

  • "l2tO"

profile_id

别名：profile-id

整数

设置 NPU DSW DTS 配置文件 ID。

queue_select

别名：queue-select

整数

设置 NPU DSW DTS 队列 ID 选择

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 NPU DSW Queue DTS profile.
      fortinet.fortimanager.fmgr_system_npu_dswqueuedtsprofile:
        # 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]>
        system_npu_dswqueuedtsprofile:
          iport: <value in [EIF0, eif0, EIF1, ...]>
          name: <string>
          oport: <value in [EIF0, eif0, EIF1, ...]>
          profile_id: <integer>
          queue_select: <integer>

返回值

通用返回值在此处记录 here，以下是此模块独有的字段

键

描述

元数据

字典

请求的结果。

返回： 始终

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 版本支持，则发出警告。

返回：复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)