fortinet.fortios.fortios_log_syslogd3_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_syslogd3_override_setting。

fortinet.fortios 2.0.0 中的新增功能

概要

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

要求

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

  • ansible>=2.15

参数

参数

注释

access_token

字符串

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

enable_log

布尔值

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

选择

  • false ←（默认）

  • true

log_syslogd3_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_syslogd3_override_setting:
      vdom: "{{ vdom }}"
      log_syslogd3_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"

修订版本

字符串

内部修订号

返回： 始终

示例: "17.0.2.10658"

序列号

字符串

设备的序列号

返回： 始终

示例: "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)