fortinet.fortimanager.fmgr_log_npuserver_servergroup 模块 – 创建服务器组。

注意

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

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

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

要在剧本中使用它，请指定：fortinet.fortimanager.fmgr_log_npuserver_servergroup。

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_servergroup

字典

设置的顶级参数。

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）设置通过驱动程序进行软件日志记录的标志。

proposed_method

字符串

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

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

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

rc_succeeded

列表 / 元素=整数

将覆盖成功条件的 rc 代码列表。

state

字符串 / 必需

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

选项

  • "present"

  • "absent"

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 有助于完成工作。

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

  • 要删除对象，请使用 state 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: Create server group.
      fortinet.fortimanager.fmgr_log_npuserver_servergroup:
        # 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>
        state: present # <value in [present, absent]>
        log_npuserver_servergroup:
          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]>

返回值

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

键

描述

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

列表 / 元素=字符串

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

返回： 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)