fortinet.fortios.fortios_log_fortianalyzer_setting 模块 – Fortinet FortiOS 和 FortiGate 中的全局 FortiAnalyzer 设置。

注意

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

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

要安装它，请使用：ansible-galaxy collection install fortinet.fortios。您需要进一步的要求才能使用此模块，请参阅 要求 获取详细信息。

要在 playbook 中使用它，请指定：fortinet.fortios.fortios_log_fortianalyzer_setting。

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够通过允许用户设置和修改 log_fortianalyzer 功能和设置类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括在使用前需要调整为数据源的所有参数和值。已使用 FOS v6.0.0 进行测试

要求

执行此模块的主机上需要以下要求。

  • ansible>=2.15

参数

参数

注释

access_token

字符串

基于令牌的身份验证。从 FortiGate 的 GUI 生成。

enable_log

布尔值

启用/禁用任务的日志记录。

选项

  • false ← （默认）

  • true

log_fortianalyzer_setting

字典

全局 FortiAnalyzer 设置。

__change_ip

整数

隐藏属性。

access_config

字符串

启用/禁用 FortiAnalyzer 对配置和数据的访问。

选项

  • "enable"

  • "disable"

alt_server

字符串

备用 FortiAnalyzer。

certificate

字符串

用于与 FortiAnalyzer 通信的证书。源 certificate.local.name。

certificate_verification

字符串

启用/禁用通过使用证书对 FortiAnalyzer 进行身份验证。

选项

  • "enable"

  • "disable"

conn_timeout

整数

FortiAnalyzer 连接超时（以秒为单位）（用于状态和日志缓冲区）。

enc_algorithm

字符串

配置与 FortiAnalyzer 安全通信的 SSL 保护级别。

选项

  • "high-medium"

  • "high"

  • "low"

fallback_to_primary

字符串

启用/禁用此 FortiGate 设备在主 FortiAnalyzer 可用时回退到主 FortiAnalyzer。

选项

  • "enable"

  • "disable"

faz_type

整数

FortiAnalyzer 的隐藏设置索引。

hmac_algorithm

字符串

OFTP 登录哈希算法。

选项

  • "sha256"

  • "sha1"

interface

字符串

指定用于连接服务器的传出接口。源 system.interface.name。

interface_select_method

字符串

指定如何选择用于连接服务器的传出接口。

选项

  • "auto"

  • "sdwan"

  • "specify"

ips_archive

字符串

启用/禁用 IPS 数据包存档日志记录。

选项

  • "enable"

  • "disable"

max_log_rate

整数

FortiAnalyzer 最大日志速率（以 MBps 为单位）（0 = 无限制）。

mgmt_name

字符串

FortiAnalyzer 的隐藏管理名称。

monitor_failure_retry_period

整数

FortiAnalyzer 连接重试之间的时间（以秒为单位）（用于状态和日志缓冲区）。

monitor_keepalive_period

整数

OFTP keepalive 之间的时间（以秒为单位）（用于状态和日志缓冲区）。

preshared_key

字符串

用于在 FortiAnalyzer 上进行自动授权的预共享密钥。

priority

字符串

设置日志传输优先级。

选项

  • "default"

  • "low"

reliable

字符串

启用/禁用到 FortiAnalyzer 的可靠日志记录。

选项

  • "enable"

  • "disable"

serial

列表 / 元素=字典

FortiAnalyzer 的序列号。

name

字符串 / 必需

序列号。

server

字符串

远程 FortiAnalyzer。

server_cert_ca

字符串

服务器证书链中 FortiGate 上的强制 CA。源 certificate.ca.name vpn.certificate.ca.name。

source_ip

字符串

用于与 FortiAnalyzer 通信的源 IPv4 或 IPv6 地址。

ssl_min_proto_version

字符串

SSL/TLS 连接支持的最低协议版本。

选项

  • "default"

  • "SSLv3"

  • "TLSv1"

  • "TLSv1-1"

  • "TLSv1-2"

  • "TLSv1-3"

status

字符串

启用/禁用到 FortiAnalyzer 的日志记录。

选项

  • "enable"

  • "disable"

upload_day

字符串

上传日志的星期几（月）。

upload_interval

字符串

将日志文件上传到 FortiAnalyzer 的频率。

选项

  • "daily"

  • "weekly"

  • "monthly"

upload_option

字符串

启用/禁用将日志记录到硬盘，然后上传到 FortiAnalyzer。

选项

  • "store-and-upload"

  • "realtime"

  • "1-minute"

  • "5-minute"

upload_time

字符串

上传日志的时间 (hh:mm)。

member_path

字符串

要操作的成员属性路径。

如果有多个属性，则用斜杠字符分隔。

标记为 member_path 的参数对于执行成员操作是合法的。

member_state

字符串

在指定的属性路径下添加或删除成员。

当指定 member_state 时，将忽略 state 选项。

选项

  • "present"

  • "absent"

vdom

字符串

虚拟域，在之前定义的那些之中。vdom 是 FortiGate 的一个虚拟实例，可以配置并用作不同的单元。

默认值： "root"

备注

注意

  • 传统的 fortiosapi 已被弃用，httpapi 是运行 playbook 的首选方式

示例

- name: Global FortiAnalyzer settings.
  fortinet.fortios.fortios_log_fortianalyzer_setting:
      vdom: "{{ vdom }}"
      log_fortianalyzer_setting:
          __change_ip: "127"
          access_config: "enable"
          alt_server: "<your_own_value>"
          certificate: "<your_own_value> (source certificate.local.name)"
          certificate_verification: "enable"
          conn_timeout: "10"
          enc_algorithm: "high-medium"
          fallback_to_primary: "enable"
          faz_type: "2147483647"
          hmac_algorithm: "sha256"
          interface: "<your_own_value> (source system.interface.name)"
          interface_select_method: "auto"
          ips_archive: "enable"
          max_log_rate: "0"
          mgmt_name: "<your_own_value>"
          monitor_failure_retry_period: "5"
          monitor_keepalive_period: "5"
          preshared_key: "<your_own_value>"
          priority: "default"
          reliable: "enable"
          serial:
              -
                  name: "default_name_24"
          server: "192.168.100.40"
          server_cert_ca: "<your_own_value> (source certificate.ca.name vpn.certificate.ca.name)"
          source_ip: "84.230.14.43"
          ssl_min_proto_version: "default"
          status: "enable"
          upload_day: "<your_own_value>"
          upload_interval: "daily"
          upload_option: "store-and-upload"
          upload_time: "<your_own_value>"

返回值

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

键

描述

构建版本

字符串

FortiGate 镜像的构建编号

返回值： 总是

示例： "1547"

http_method

字符串

上次用于将内容配置到 FortiGate 中的方法

返回值： 总是

示例： "PUT"

http_status

字符串

上次操作应用后 FortiGate 给出的最后结果

返回值： 总是

示例： "200"

mkey

字符串

上次调用 FortiGate 时使用的主键 (id)

返回值： 成功

示例： "id"

name

字符串

用于满足请求的表名

返回值： 总是

示例： "urlfilter"

path

字符串

用于满足请求的表的路径

返回值： 总是

示例： "webfilter"

revision

字符串

内部修订号

返回值： 总是

示例： "17.0.2.10658"

serial

字符串

设备的序列号

返回值： 总是

示例： "FGVMEVYYQT3AB5352"

status

字符串

操作结果的指示

返回值： 总是

示例： "success"

vdom

字符串

使用的虚拟域

返回值： 总是

示例： "root"

version

字符串

FortiGate 的版本

返回值： 总是

示例： "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)