fortinet.fortios.fortios_log_syslogd4_override_setting 模块 – 用于覆盖 Fortinet FortiOS 和 FortiGate 中远程 syslog 服务器的设置。

注意

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

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

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

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

在 fortinet.fortios 2.0.0 中新增

概要

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

要求

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

  • ansible>=2.15

参数

参数

注释

access_token

字符串

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

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

log_syslogd4_override_setting

字典

覆盖远程 syslog 服务器的设置。

certificate

字符串

用于与 Syslog 服务器通信的证书。源 certificate.local.name。

custom_field_name

列表 / 元素=字典

CEF 格式日志记录的自定义字段名称。

custom

字符串

字段自定义名称 [A-Za-z0-9_]。

id

整数 / 必需

条目 ID。请参阅 <a href=’#notes’>备注</a>。

name

字符串

字段名称 [A-Za-z0-9_]。

enc_algorithm

字符串

启用/禁用带有 TLS 加密的可靠 syslog 记录。

选项

  • "high-medium"

  • "high"

  • "low"

  • "disable"

facility

字符串

远程 syslog 工具。

选项

  • "kernel"

  • "user"

  • "mail"

  • "daemon"

  • "auth"

  • "syslog"

  • "lpr"

  • "news"

  • "uucp"

  • "cron"

  • "authpriv"

  • "ftp"

  • "ntp"

  • "audit"

  • "alert"

  • "clock"

  • "local0"

  • "local1"

  • "local2"

  • "local3"

  • "local4"

  • "local5"

  • "local6"

  • "local7"

format

字符串

日志格式。

选项

  • "default"

  • "csv"

  • "cef"

  • "rfc5424"

  • "json"

interface

字符串

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

interface_select_method

字符串

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

选项

  • "auto"

  • "sdwan"

  • "specify"

max_log_rate

整数

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

mode

字符串

通过 UDP/可靠 TCP 进行远程 syslog 记录。

选项

  • "udp"

  • "legacy-reliable"

  • "reliable"

override

字符串

启用/禁用覆盖 syslog 设置。

选项

  • "enable"

  • "disable"

port

整数

服务器侦听端口。

priority

字符串

设置日志传输优先级。

选项

  • "default"

  • "low"

server

字符串

远程 syslog 服务器的地址。

source_ip

字符串

syslog 的源 IP 地址。

source_ip_interface

字符串

syslog 的源接口。源 system.interface.name。

ssl_min_proto_version

字符串

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

选项

  • "default"

  • "SSLv3"

  • "TLSv1"

  • "TLSv1-1"

  • "TLSv1-2"

  • "TLSv1-3"

status

字符串

启用/禁用远程 syslog 记录。

选项

  • "enable"

  • "disable"

syslog_type

整数

Syslog 的隐藏设置索引。

use_management_vdom

字符串

启用/禁用将管理 VDOM 用作发送到 syslog 服务器的日志的源 VDOM。

选项

  • "enable"

  • "disable"

member_path

字符串

要操作的成员属性路径。

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

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

member_state

字符串

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

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

选项

  • "present"

  • "absent"

vdom

字符串

虚拟域，在先前定义的那些中。vdom 是 FortiGate 的虚拟实例，可以将其配置为不同的单元并使用。

默认值： "root"

备注

注意

  • 旧版 fortiosapi 已被弃用，httpapi 是运行 playbook 的首选方法

示例

- name: Override settings for remote syslog server.
  fortinet.fortios.fortios_log_syslogd4_override_setting:
      vdom: "{{ vdom }}"
      log_syslogd4_override_setting:
          certificate: "<your_own_value> (source certificate.local.name)"
          custom_field_name:
              -
                  custom: "<your_own_value>"
                  id: "6"
                  name: "default_name_7"
          enc_algorithm: "high-medium"
          facility: "kernel"
          format: "default"
          interface: "<your_own_value> (source system.interface.name)"
          interface_select_method: "auto"
          max_log_rate: "0"
          mode: "udp"
          override: "enable"
          port: "514"
          priority: "default"
          server: "192.168.100.40"
          source_ip: "84.230.14.43"
          source_ip_interface: "<your_own_value> (source system.interface.name)"
          ssl_min_proto_version: "default"
          status: "enable"
          syslog_type: "2147483647"
          use_management_vdom: "enable"

返回值

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

键

描述

build

字符串

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"

版本

字符串

FortiGate 的版本

返回值： 总是

示例： "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)