fortinet.fortimanager.fmgr_devprof_log_fortianalyzer_setting 模块 – 全局 FortiAnalyzer 设置。

注意

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

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

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

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

fortinet.fortimanager 2.0.0 中的新增功能

概要 

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

参数 

参数	注释
access_token 字符串	无需用户名和密码即可访问 FortiManager 的令牌。
adom 字符串 / 必填	请求 URL 中的参数 (adom)。
bypass_validation 布尔值	仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而无需验证参数。选项 `false` ← (默认) `true`
devprof 字符串 / 必填	请求 URL 中的参数 (devprof)。
devprof_log_fortianalyzer_setting 字典	设置的顶级参数。
__change_ip 整数	隐藏属性。
access_config 别名：access-config 字符串	启用/禁用 FortiAnalyzer 访问配置和数据。选项 `"disable"` `"enable"`
alt_server 别名：alt-server 字符串	备用服务器。
certificate 字符串	用于与 FortiAnalyzer 通信的证书。
certificate_verification 别名：certificate-verification 字符串	启用/禁用使用证书对 FortiAnalyzer 的身份验证。选项 `"disable"` `"enable"`
conn_timeout 别名：conn-timeout 整数	FortiAnalyzer 连接超时时间（秒）。
enc_algorithm 别名：enc-algorithm 字符串	启用/禁用使用 SSL 加密发送 FortiAnalyzer 日志数据。选项 `"default"` `"high"` `"low"` `"disable"` `"high-medium"` `"low-medium"`
fallback_to_primary 别名：fallback-to-primary 字符串	启用/禁用此 FortiGate 单元在主 FortiAnalyzer 可用时回退到主 FortiAnalyzer。选项 `"disable"` `"enable"`
hmac_algorithm 别名：hmac-algorithm 字符串	FortiAnalyzer IPsec 隧道 HMAC 算法。选项 `"sha256"` `"sha1"`
interface 字符串	指定到达服务器的出站接口。
interface_select_method 别名：interface-select-method 字符串	指定如何选择到达服务器的出站接口。选项 `"auto"` `"sdwan"` `"specify"`
ips_archive 别名：ips-archive 字符串	启用/禁用 IPS 数据包存档日志记录。选项 `"disable"` `"enable"`
max_log_rate 别名：max-log-rate 整数	FortiAnalyzer 最大日志速率（MBps）。
monitor_failure_retry_period 别名：monitor-failure-retry-period 整数	FortiAnalyzer 连接重试之间的时间间隔（秒）。
monitor_keepalive_period 别名：monitor-keepalive-period 整数	OFTP 保持活动之间的时间间隔（秒）。
preshared_key 别名：preshared-key 字符串	用于 FortiAnalyzer 上自动授权的预共享密钥。
priority 字符串	设置日志传输优先级。选项 `"low"` `"default"`
reliable 字符串	启用/禁用对 FortiAnalyzer 的可靠日志记录。选项 `"disable"` `"enable"`
serial 任意	(列表) FortiAnalyzer 的序列号。
server 字符串	远程 FortiAnalyzer。
server_cert_ca 别名：server-cert-ca 字符串	服务器证书链中 FortiGate 中的强制 CA。
source_ip 别名：source-ip 字符串	用于与 FortiAnalyzer 通信的源 IPv4 或 IPv6 地址。
ssl_min_proto_version 别名：ssl-min-proto-version 字符串	SSL/TLS 连接支持的最低协议版本。选项 `"default"` `"TLSv1"` `"TLSv1.1"` `"TLSv1.2"` `"SSLv3"` `"TLSv1.3"`
status 字符串	启用/禁用对 FortiAnalyzer 的日志记录。选项 `"disable"` `"enable"`
upload_day 别名：upload-day 字符串	星期几
upload_interval 别名: upload-interval 字符串	上传日志文件到FortiAnalyzer的频率。选项 `“daily”` `“weekly”` `“monthly”`
upload_option 别名: upload-option 字符串	启用/禁用将日志记录到硬盘，然后上传到FortiAnalyzer。选项 `“store-and-upload”` `“realtime”` `“1-minute”` `“5-minute”`
upload_time 别名: upload-time 字符串	上传日志的时间
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，值可以是全局的和其他包括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: Global FortiAnalyzer settings.
      fortinet.fortimanager.fmgr_devprof_log_fortianalyzer_setting:
        # 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_log_fortianalyzer_setting:
          certificate: <string>
          conn_timeout: <integer>
          enc_algorithm: <value in [default, high, low, ...]>
          hmac_algorithm: <value in [sha256, sha1]>
          ips_archive: <value in [disable, enable]>
          monitor_failure_retry_period: <integer>
          monitor_keepalive_period: <integer>
          reliable: <value in [disable, enable]>
          ssl_min_proto_version: <value in [default, TLSv1, TLSv1-1, ...]>
          upload_day: <string>
          upload_interval: <value in [daily, weekly, monthly]>
          upload_option: <value in [store-and-upload, realtime, 1-minute, ...]>
          upload_time: <string>
          access_config: <value in [disable, enable]>
          certificate_verification: <value in [disable, enable]>
          max_log_rate: <integer>
          priority: <value in [low, default]>
          interface: <string>
          interface_select_method: <value in [auto, sdwan, specify]>
          preshared_key: <string>
          alt_server: <string>
          fallback_to_primary: <value in [disable, enable]>
          server_cert_ca: <string>
          serial: <list or string>
          source_ip: <string>
          status: <value in [disable, enable]>
          __change_ip: <integer>
          server: <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)