fortinet.fortimanager.fmgr_devprof_log_syslogd_setting 模块 – 远程 Syslog 服务器的全局设置。

注意

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

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

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

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

fortinet.fortimanager 1.0.0 中的新增功能

概要

  • 此模块能够配置 FortiManager 设备。

  • 示例包括所有参数和值，需要在使用前将其调整为数据源。

参数

参数

注释

access_token

字符串

无需使用用户名和密码即可访问 FortiManager 的令牌。

adom

字符串 / 必需

请求的 URL 中的参数 (adom)。

bypass_validation

布尔值

仅当模块架构与 FortiManager API 结构不同时才设置为 True，模块将继续执行而不验证参数。

选择

  • false ←（默认）

  • true

devprof

字符串 / 必需

请求的 URL 中的参数 (devprof)。

devprof_log_syslogd_setting

字典

设置的顶级参数。

certificate

字符串

用于与 Syslog 服务器通信的证书。

csv

字符串

启用/禁用日志的 CSV 格式。

选择

  • "disable"

  • "enable"

custom_field_name

别名: custom-field-name

列表 / 元素=字典

自定义字段名称。

custom

字符串

字段自定义名称。

id

整数

条目 ID。

name

字符串

字段名称。

enc_algorithm

别名: enc-algorithm

字符串

启用/禁用使用 TLS 加密的可靠 Syslog 记录。

选择

  • "high"

  • "low"

  • "disable"

  • "high-medium"

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

字符串

指定用于到达服务器的传出接口。

interface_select_method

别名: interface-select-method

字符串

指定如何选择传出接口以到达服务器。

选择

  • "auto"

  • "sdwan"

  • "specify"

max_log_rate

别名: max-log-rate

整数

Syslog 最大日志速率（MBps）

mode

字符串

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

选择

  • "udp"

  • "legacy-reliable"

  • "reliable"

port

整数

服务器侦听端口。

priority

字符串

设置日志传输优先级。

选择

  • "low"

  • "default"

reliable

字符串

启用/禁用可靠日志记录

选择

  • "disable"

  • "enable"

server

字符串

远程 Syslog 服务器的地址。

source_ip

别名: source-ip

字符串

Syslog 的源 IP 地址。

source_ip_interface

别名: source-ip-interface

any

（列表）Syslog 的源接口。

ssl_min_proto_version

别名: ssl-min-proto-version

字符串

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

选择

  • "default"

  • "TLSv1-1"

  • "TLSv1-2"

  • "SSLv3"

  • "TLSv1"

  • "TLSv1-3"

status

字符串

启用/禁用远程 Syslog 记录。

选择

  • "disable"

  • "enable"

syslog_type

别名: syslog-type

整数

Syslog 类型。

enable_log

布尔值

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

选择

  • false ←（默认）

  • true

forticloud_access_token

字符串

使用 FortiCloud API 访问令牌验证 Ansible 客户端。

proposed_method

字符串

底层 Json RPC 请求的重写方法。

选择

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

将覆盖失败条件的 rc 代码列表。

rc_succeeded

list / elements=integer

将覆盖成功条件的 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 settings for remote syslog server.
      fortinet.fortimanager.fmgr_devprof_log_syslogd_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_syslogd_setting:
          certificate: <string>
          enc_algorithm: <value in [high, low, disable, ...]>
          facility: <value in [kernel, user, mail, ...]>
          mode: <value in [udp, legacy-reliable, reliable]>
          port: <integer>
          server: <string>
          ssl_min_proto_version: <value in [default, TLSv1-1, TLSv1-2, ...]>
          status: <value in [disable, enable]>
          reliable: <value in [disable, enable]>
          csv: <value in [disable, enable]>
          max_log_rate: <integer>
          priority: <value in [low, default]>
          interface: <string>
          interface_select_method: <value in [auto, sdwan, specify]>
          format: <value in [default, csv, cef, ...]>
          syslog_type: <integer>
          custom_field_name:
            -
              custom: <string>
              id: <integer>
              name: <string>
          source_ip: <string>
          source_ip_interface: <list or string>

返回值

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

键

描述

meta

字典

请求的结果。

返回: 总是

request_url

字符串

请求的完整 URL。

返回: 总是

示例: "/sys/login/user"

response_code

整数

API 请求的状态。

返回: 总是

示例: 0

response_data

list / elements=string

API 响应。

返回: 总是

response_message

字符串

API 响应的描述性消息。

返回: 总是

示例: "OK."

system_information

字典

目标系统的信息。

返回: 总是

rc

整数

请求的状态。

返回: 总是

示例: 0

version_check_warning

list / elements=string

如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则发出警告。

返回: 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)