fortinet.fortimanager.fmgr_system_locallog_fortianalyzer3_setting 模块 – 用于配置本地日志到 FortiAnalyzer 的设置。

注意

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

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

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

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

fortinet.fortimanager 2.0.0 中的新增功能

概要 

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

参数 

参数	注释
access_token 字符串	用于在不使用用户名和密码的情况下访问 FortiManager 的令牌。
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 代码列表。
system_locallog_fortianalyzer3_setting 字典	设置的顶级参数。
peer_cert_cn 别名：peer-cert-cn 字符串	远程 FortiAnalyzer 的证书公用名称。
reliable 字符串	启用/禁用可靠的实时日志记录。 disable - 禁用可靠的实时日志记录。 enable - 启用可靠的实时日志记录。选项 `"disable"` `"enable"`
secure_connection 别名：secure-connection 字符串	启用/禁用 TLS/SSL 保护的连接。 disable - 禁用 SSL 连接。 enable - 启用 SSL 连接。选项 `"disable"` `"enable"`
server 字符串	远程 FortiAnalyzer 服务器 FQDN、主机名或 IP 地址
server_ip 别名：server-ip 字符串	远程 FortiAnalyzer 服务器 IP 地址。
severity 字符串	要记录的最低严重级别。 emergency - 紧急级别。 alert - 警报级别。 critical - 严重级别。 error - 错误级别。 warning - 警告级别。 notification - 通知级别。 information - 信息级别。 debug - 调试级别。选项 `"emergency"` `"alert"` `"critical"` `"error"` `"warning"` `"notification"` `"information"` `"debug"`
status 字符串	记录到 FortiAnalyzer 的状态。 disable - 禁用记录到 FortiAnalyzer。 realtime - 实时记录到 FortiAnalyzer。 upload - 在计划时间记录到 FortiAnalyzer。选项 `"disable"` `"realtime"` `"upload"`
upload_time 别名：upload-time 任意	（列表）上传本地日志文件的时间
workspace_locking_adom 字符串	要在工作区模式下运行的 FortiManager 上锁定的 ADOM，该值可以是全局的，也可以是包括根目录在内的其他值。
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: Settings for locallog to fortianalyzer.
      fortinet.fortimanager.fmgr_system_locallog_fortianalyzer3_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, ...]
        system_locallog_fortianalyzer3_setting:
          reliable: <value in [disable, enable]>
          secure_connection: <value in [disable, enable]>
          server_ip: <string>
          severity: <value in [emergency, alert, critical, ...]>
          status: <value in [disable, realtime, upload]>
          upload_time: <list or string>
          server: <string>
          peer_cert_cn: <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版本支持，则会发出警告。返回：复杂

作者

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