fortinet.fortimanager.fmgr_system_syslog 模块 – Syslog 服务器。

注意

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

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

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

要在 Playbook 中使用它，请指定：fortinet.fortimanager.fmgr_system_syslog。

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 代码列表。

state

字符串 / 必填

创建、更新或删除对象的指令。

选择

  • "present"

  • "absent"

system_syslog

字典

设置的顶级参数。

ip

字符串

Syslog 服务器 IP 地址或主机名。

local_cert

别名：local-cert

字符串

选择用于安全连接的本地证书。

name

字符串 / 必填

Syslog 服务器名称。

peer_cert_cn

别名：peer-cert-cn

字符串

Syslog 服务器的证书公用名称。

port

整数

Syslog 服务器端口。

reliable

字符串

启用/禁用与 Syslog 服务器的可靠连接。

disable - 禁用与 Syslog 服务器的可靠连接。

enable - 启用与 Syslog 服务器的可靠连接。

选择

  • "disable"

  • "enable"

secure_connection

别名：secure-connection

字符串

启用/禁用 TLS/SSL 保护的连接。

disable - 禁用 SSL 连接。

enable - 启用 SSL 连接。

选择

  • "disable"

  • "enable"

ssl_protocol

别名：ssl-protocol

字符串

设置与 Syslog 服务器连接的最低 SSL 协议版本。

follow-global-ssl-protocol - 跟随系统。

sslv3 - 将 SSLv3 设置为最低版本。

tlsv1。

tlsv1。

tlsv1。

tlsv1。

选择

  • "follow-global-ssl-protocol"

  • "sslv3"

  • "tlsv1.0"

  • "tlsv1.1"

  • "tlsv1.2"

  • "tlsv1.3"

workspace_locking_adom

字符串

要在工作区模式下运行的 FortiManager 中锁定的 ADOM，该值可以是 global 以及包括 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 有助于完成工作。

  • 要创建或更新对象，请使用状态 present 指令。

  • 要删除对象，请使用状态 absent 指令。

  • 通常，当返回非零 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: Syslog servers.
      fortinet.fortimanager.fmgr_system_syslog:
        # 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, ...]
        state: present # <value in [present, absent]>
        system_syslog:
          ip: <string>
          name: <string>
          port: <integer>
          local_cert: <string>
          peer_cert_cn: <string>
          reliable: <value in [disable, enable]>
          secure_connection: <value in [disable, enable]>
          ssl_protocol: <value in [follow-global-ssl-protocol, sslv3, tlsv1.0, ...]>

返回值

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

键

描述

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

列表 / 元素=字符串

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

返回值： 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)