fortinet.fortimanager.fmgr_switchcontroller_qos_ipdscpmap 模块 – 配置 FortiSwitch QoS IP 优先级/DSCP。

注意

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

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

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

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

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 代码列表。

state

字符串 / 必需

用于创建、更新或删除对象的指令。

选项

  • "present"

  • "absent"

switchcontroller_qos_ipdscpmap

字典

顶层参数集。

description

字符串

IP-DSCP 映射名称的描述。

map

列表 / 元素=字典

映射。

cos_queue

别名: cos-queue

整数

COS 队列号。

diffserv

列表 / 元素=字符串

区分服务。

选项

  • "CS0"

  • "CS1"

  • "AF11"

  • "AF12"

  • "AF13"

  • "CS2"

  • "AF21"

  • "AF22"

  • "AF23"

  • "CS3"

  • "AF31"

  • "AF32"

  • "AF33"

  • "CS4"

  • "AF41"

  • "AF42"

  • "AF43"

  • "CS5"

  • "EF"

  • "CS6"

  • "CS7"

ip_precedence

别名: ip-precedence

列表 / 元素=字符串

IP 优先级。

选项

  • "network-control"

  • "internetwork-control"

  • "critic-ecp"

  • "flashoverride"

  • "flash"

  • "immediate"

  • "priority"

  • "routine"

name

字符串

Dscp 映射条目名称。

value

字符串

DSCP 的原始值

name

字符串 / 必需

Dscp 映射名称。

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 FortiSwitch QoS IP precedence/DSCP.
      fortinet.fortimanager.fmgr_switchcontroller_qos_ipdscpmap:
        # 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_qos_ipdscpmap:
          description: <string>
          map:
            -
              cos_queue: <integer>
              diffserv:
                - "CS0"
                - "CS1"
                - "AF11"
                - "AF12"
                - "AF13"
                - "CS2"
                - "AF21"
                - "AF22"
                - "AF23"
                - "CS3"
                - "AF31"
                - "AF32"
                - "AF33"
                - "CS4"
                - "AF41"
                - "AF42"
                - "AF43"
                - "CS5"
                - "EF"
                - "CS6"
                - "CS7"
              ip_precedence:
                - "network-control"
                - "internetwork-control"
                - "critic-ecp"
                - "flashoverride"
                - "flash"
                - "immediate"
                - "priority"
                - "routine"
              name: <string>
              value: <string>
          name: <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)