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。

要在剧本中使用它，请指定： 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模式。选项 `"ELE_M0"` `"ELE_DS"` `"ELE_PB"` `"ELE_MIN"`
cs 列表 / 元素=字符串	CPE载波集。选项 `"A43"` `"B43"` `"A43C"` `"V43"`
ds_bitswap 别名：ds-bitswap 字符串	启用/禁用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 字符串	启用/禁用bitswap。选项 `"disable"` `"enable"`
workspace_locking_adom 字符串	在工作区模式下运行FortiManager时要锁定的ADOM，该值可以是全局的和其他包括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) 字典	请求的结果。返回值：始终返回
请求URL (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)