fortinet.fortimanager.fmgr_switchcontroller_dsl_policy 模块 – DSL 策略。

注意

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

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

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

要在 Playbook 中使用它，请指定： fortinet.fortimanager.fmgr_switchcontroller_dsl_policy。

在 fortinet.fortimanager 2.1.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_dsl_policy 字典	顶层参数集。
append_padding 字符串	设备暂停帧配置。选择 `"disable"` `"enable"`
cpe_aele 别名: cpe-aele 字符串	Cpe AELE。选择 `"disable"` `"enable"`
cpe_aele_mode 别名: cpe-aele-mode 字符串	具有给定字符串的 Cpe AELE-Mode。选择 `"ELE_M0"` `"ELE_DS"` `"ELE_PB"` `"ELE_MIN"`
cs 列表 / 元素=字符串	CPE 运营商集。选择 `"A43"` `"B43"` `"A43C"` `"V43"`
ds_bitswap 别名: ds-bitswap 字符串	启用/禁用位交换。选择 `"disable"` `"enable"`
name 字符串 / 必填	策略名称。
pause_frame 别名: pause-frame 字符串	设备暂停帧配置。选择 `"disable"` `"enable"`
profile 字符串	Vdsl CPE 配置文件。选择 `"auto-30a"` `"auto-17a"` `"auto-12ab"`
type 字符串	类型。选择 `"Procend"` `"Proscend"`
us_bitswap 别名: us-bitswap 字符串	启用/禁用位交换。选择 `"disable"` `"enable"`
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: DSL policy.
      fortinet.fortimanager.fmgr_switchcontroller_dsl_policy:
        # 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_dsl_policy:
          append_padding: <value in [disable, enable]>
          cpe_aele: <value in [disable, enable]>
          cpe_aele_mode: <value in [ELE_M0, ELE_DS, ELE_PB, ...]>
          cs:
            - "A43"
            - "B43"
            - "A43C"
            - "V43"
          ds_bitswap: <value in [disable, enable]>
          name: <string>
          pause_frame: <value in [disable, enable]>
          profile: <value in [auto-30a, auto-17a, auto-12ab]>
          type: <value in [Procend, Proscend]>
          us_bitswap: <value in [disable, enable]>

返回值 

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

键	描述
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 版本支持，则会发出警告。返回：复杂数据

作者

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)