fortinet.fortimanager.fmgr_casb_profile_saasapplication_customcontrol 模块 – CASB 配置文件自定义控制。

注意

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

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

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

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

fortinet.fortimanager 2.3.0 中的新增功能

概要 

此模块能够配置 FortiManager 设备。
示例包括所有在使用前需要调整为数据源的参数和值。

参数 

参数	注释
access_token 字符串	无需使用用户名和密码即可访问 FortiManager 的令牌。
adom 字符串 / 必需	请求 URL 中的参数 (adom)。
bypass_validation 布尔值	仅当模块模式与 FortiManager API 结构不同时才设置为 True，模块将继续执行而不验证参数。选择 `false` ← (默认) `true`
casb_profile_saasapplication_customcontrol 字典	设置的顶级参数。
name 字符串 / 必需	CASB 自定义控制用户活动名称。
option 列表 / 元素=字典	选项。
name 字符串	CASB 自定义控制选项名称。
user_input 别名：user-input 列表 / 元素=字符串	CASB 自定义控制用户输入。
enable_log 布尔值	启用/禁用任务日志记录。选择 `false` ← (默认) `true`
forticloud_access_token 字符串	使用 forticloud API 访问令牌验证 Ansible 客户端。
profile 字符串 / 必需	请求 URL 中的参数 (profile)。
proposed_method 字符串	覆盖底层 Json RPC 请求的方法。选择 `"update"` `"set"` `"add"`
rc_failed 列表 / 元素=整数	将覆盖失败条件的 rc 代码列表。
rc_succeeded 列表 / 元素=整数	将覆盖成功条件的 rc 代码列表。
saas-application 字符串	已弃用，请使用 “saas_application”
saas_application 字符串	请求 URL 中的参数 (saas-application)。
state 字符串 / 必需	创建、更新或删除对象的指令。选择 `"present"` `"absent"`
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: CASB profile custom control.
      fortinet.fortimanager.fmgr_casb_profile_saasapplication_customcontrol:
        # 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>
        profile: <your own value>
        saas_application: <your own value>
        state: present # <value in [present, absent]>
        casb_profile_saasapplication_customcontrol:
          name: <string>
          option:
            -
              name: <string>
              user_input: <list or string>

返回值 

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

键	描述
meta 字典	请求的结果。返回值：总是
request_url 字符串	请求的完整 URL。返回值：总是示例： `"/sys/login/user"`
response_code 整数	API 请求的状态。返回值：总是示例： `0`
response_data 列表 / 元素=字符串	API 响应。返回值：总是
response_message 字符串	API 响应的描述性消息。返回值：总是示例： `"OK."`
系统信息字典	目标系统的信息。返回值：总是
返回码整数	请求的状态。返回值：总是示例： `0`
版本检查警告列表 / 元素=字符串	如果剧本中使用的参数不受当前FortiManager版本支持，则发出警告。返回: 复杂

作者

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