fortinet.fortimanager.fmgr_log_npuserver 模块 – 配置所有日志服务器并创建服务器组。

注意

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

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

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

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

fortinet.fortimanager 2.2.0 中的新增功能

概要

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

  • 示例包括所有参数和值，在使用前需要根据数据源进行调整。

参数

参数

注释

access_token

字符串

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

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

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

选择

  • false ← (默认)

  • true

enable_log

布尔值

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

选择

  • false ← (默认)

  • true

forticloud_access_token

字符串

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

log_npuserver

字典

设置的顶层参数。

enforce_seq_order

别名：enforce-seq-order

字符串

如果启用该选项，Sw 会话 netflow 日志将按严格顺序传递。

选择

  • "disable"

  • "enable"

fmgr_syslog_facility

别名：syslog-facility

整数

配置 syslog 功能。

log_processing

别名：log-processing

字符串

配置主机处理的日志是否丢弃。

选择

  • "may-drop"

  • "no-drop"

log_processor

别名：log-processor

字符串

配置日志模块。

选择

  • "hardware"

  • "host"

netflow_ver

别名：netflow-ver

字符串

配置 netfow 版本。

选择

  • "v9"

  • "v10"

server_group

别名：server-group

列表 / 元素=字典

服务器组。

group_name

别名：group-name

字符串

服务器组名称。

log_format

别名：log-format

字符串

设置日志格式

选择

  • "syslog"

  • "netflow"

log_gen_event

别名：log-gen-event

字符串

启用/禁用为每个映射日志生成事件

选择

  • "disable"

  • "enable"

log_mode

别名：log-mode

字符串

设置日志模式

选择

  • "per-session"

  • "per-nat-mapping"

  • "per-session-ending"

log_tx_mode

别名：log-tx-mode

字符串

配置日志传输模式。

选择

  • "multicast"

  • "roundrobin"

log_user_info

别名：log-user-info

字符串

启用/禁用记录用户信息。

选择

  • "disable"

  • "enable"

server_number

别名：server-number

整数

此组中的服务器数量。

server_start_id

别名：server-start-id

整数

此组中连续服务器系列的起始 ID，[1,16]。

sw_log_flags

别名：sw-log-flags

任意

(int 或 str) 设置通过驱动程序进行软件日志记录的标志。

server_info

别名：server-info

列表 / 元素=字典

服务器信息。

dest_port

别名：dest-port

整数

设置日志数据包的目标端口

id

整数

服务器 ID。

ip_family

别名：ip-family

字符串

设置 IP 地址的版本

选择

  • "v4"

  • "v6"

ipv4_server

别名：ipv4-server

字符串

设置日志服务器的 IPv4 地址

ipv6_server

别名：ipv6-server

字符串

设置日志服务器的 IPv6 地址

log_transport

别名：log-transport

字符串

设置传输协议

选择

  • "udp"

  • "tcp"

source_port

别名: source-port

整数

设置日志数据包的源端口

template_tx_timeout

别名: template-tx-timeout

整数

设置模板发送超时时间

vdom

字符串

连接到日志服务器的接口所在的虚拟域

syslog_severity

别名: syslog-severity

整数

配置系统日志级别。

proposed_method

字符串

底层 JSON RPC 请求的覆盖方法。

选择

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

用于覆盖失败条件的返回码列表。

rc_succeeded

list / elements=integer

用于覆盖成功条件的返回码列表。

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 帮助完成此工作。

  • 通常，当返回非零 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: Configure all the log servers and create the server groups.
      fortinet.fortimanager.fmgr_log_npuserver:
        # 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>
        log_npuserver:
          log_processing: <value in [may-drop, no-drop]>
          log_processor: <value in [hardware, host]>
          netflow_ver: <value in [v9, v10]>
          server_group:
            -
              group_name: <string>
              log_format: <value in [syslog, netflow]>
              log_mode: <value in [per-session, per-nat-mapping, per-session-ending]>
              log_tx_mode: <value in [multicast, roundrobin]>
              server_number: <integer>
              server_start_id: <integer>
              sw_log_flags: <integer or string> <value in [tcp-udp-only, enable-all-log, disable-all-log]>
              log_gen_event: <value in [disable, enable]>
              log_user_info: <value in [disable, enable]>
          server_info:
            -
              dest_port: <integer>
              id: <integer>
              ip_family: <value in [v4, v6]>
              ipv4_server: <string>
              ipv6_server: <string>
              source_port: <integer>
              template_tx_timeout: <integer>
              vdom: <string>
              log_transport: <value in [udp, tcp]>
          fmgr_syslog_facility: <integer>
          syslog_severity: <integer>
          enforce_seq_order: <value in [disable, enable]>

返回值

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

键

描述

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)