fortinet.fortimanager.fmgr_devprof_device_profile_fortianalyzer 模块 – FortiAnalyzer 系统模板设备配置文件

注意

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

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

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

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

fortinet.fortimanager 1.0.0 中的新增功能

概要 

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

参数 

参数	注释
access_token 字符串	无需用户名和密码即可访问 FortiManager 的令牌。
adom 字符串 / 必需	请求 URL 中的参数 (adom)。
bypass_validation 布尔值	仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而无需验证参数。选项 `false` ← (默认) `true`
devprof 字符串 / 必需	请求 URL 中的参数 (devprof)。
devprof_device_profile_fortianalyzer 字典	设置的顶级参数。
managed_sn 别名：managed-sn 字符串	受管 SN。
target 字符串	目标。选项 `"none"` `"this-fmg"` `"managed"` `"others"`
target_ip 别名：target-ip 字符串	目标 IP。
target_sn 别名：target-sn 任意	(列表) 目标 SN。
enable_log 布尔值	启用/禁用任务日志记录。选项 `false` ← (默认) `true`
forticloud_access_token 字符串	使用 FortiCloud API 访问令牌对 Ansible 客户端进行身份验证。
proposed_method 字符串	底层 Json RPC 请求的覆盖方法。选项 `"update"` `"set"` `"add"`
rc_failed 列表 / 元素=整数	将覆盖失败条件的 rc 代码列表。
rc_succeeded 列表 / 元素=整数	将覆盖成功条件的 rc 代码列表。
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 有助于完成此工作。
通常，当返回非零 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: System template device profile fortianalyzer
      fortinet.fortimanager.fmgr_devprof_device_profile_fortianalyzer:
        # 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>
        devprof: <your own value>
        devprof_device_profile_fortianalyzer:
          managed_sn: <string>
          target: <value in [none, this-fmg, managed, ...]>
          target_ip: <string>
          target_sn: <list or 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 列表 / 元素=字符串	如果剧本中使用的参数不受当前 FortiManager 版本支持，则会发出警告。返回：复杂

作者

杜欣蔚 (@dux-fortinet)
李星 (@lix-fortinet)
薛杰 (@JieX19)
郑凌 (@chillancezen)
沈方 (@fshen01)
卢洪斌 (@fgtdev-hblu)