fortinet.fortios.fortios_system_snmp_user 模块 – Fortinet FortiOS 和 FortiGate 中的 SNMP 用户配置。

注意

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

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

要安装它，请使用：ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块，请参阅 要求 以了解详情。

要在 playbook 中使用它，请指定：fortinet.fortios.fortios_system_snmp_user。

fortinet.fortios 2.0.0 中的新增功能

概要

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

要求

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

  • ansible>=2.15

参数

参数

注释

access_token

字符串

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

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

member_path

字符串

要操作的成员属性路径。

如果有多个属性，则用斜杠字符分隔。

标有 member_path 的参数对于执行成员操作是合法的。

member_state

字符串

在指定的属性路径下添加或删除成员。

指定 member_state 时，将忽略 state 选项。

选项

  • "present"

  • "absent"

state

字符串 / 必需

指示是创建还是删除对象。

选项

  • "present"

  • "absent"

system_snmp_user

字典

SNMP 用户配置。

auth_proto

字符串

身份验证协议。

选项

  • "md5"

  • "sha"

  • "sha224"

  • "sha256"

  • "sha384"

  • "sha512"

auth_pwd

字符串

身份验证协议的密码。

events

列表 / 元素=字符串

要发送的 SNMP 通知（陷阱）。

选项

  • "cpu-high"

  • "mem-low"

  • "log-full"

  • "intf-ip"

  • "vpn-tun-up"

  • "vpn-tun-down"

  • "ha-switch"

  • "ha-hb-failure"

  • "ips-signature"

  • "ips-anomaly"

  • "av-virus"

  • "av-oversize"

  • "av-pattern"

  • "av-fragmented"

  • "fm-if-change"

  • "fm-conf-change"

  • "bgp-established"

  • "bgp-backward-transition"

  • "ha-member-up"

  • "ha-member-down"

  • "ent-conf-change"

  • "av-conserve"

  • "av-bypass"

  • "av-oversize-passed"

  • "av-oversize-blocked"

  • "ips-pkg-update"

  • "ips-fail-open"

  • "faz-disconnect"

  • "faz"

  • "wc-ap-up"

  • "wc-ap-down"

  • "fswctl-session-up"

  • "fswctl-session-down"

  • "load-balance-real-server-down"

  • "device-new"

  • "per-cpu-high"

  • "dhcp"

  • "pool-usage"

  • "ippool"

  • "interface"

  • "ospf-nbr-state-change"

  • "ospf-virtnbr-state-change"

  • "temperature-high"

  • "voltage-alert"

  • "power-supply"

  • "fan-failure"

  • "power-supply-failure"

ha_direct

字符串

启用/禁用 HA 集群成员的直接管理。

选项

  • "enable"

  • "disable"

interface

字符串

指定到达服务器的出站接口。源 system.interface.name。

interface_select_method

字符串

指定如何选择到达服务器的出站接口。

选项

  • "auto"

  • "sdwan"

  • "specify"

mib_view

字符串

SNMP 访问控制 MIB 视图。源 system.snmp.mib-view.name。

name

字符串 / 必需

SNMP 用户名。

notify_hosts

列表 / 元素=字符串

要向其发送通知（陷阱）的 SNMP 管理器。

notify_hosts6

列表 / 元素=字符串

要向其发送通知（陷阱）的 IPv6 SNMP 管理器。

priv_proto

字符串

隐私（加密）协议。

选项

  • "aes"

  • "des"

  • "aes256"

  • "aes256cisco"

priv_pwd

字符串

隐私（加密）协议的密码。

queries

字符串

启用/禁用此用户的 SNMP 查询。

选项

  • "enable"

  • "disable"

query_port

整数

SNMPv3 查询端口。

security_level

字符串

消息身份验证和加密的安全级别。

选项

  • "no-auth-no-priv"

  • "auth-no-priv"

  • "auth-priv"

source_ip

字符串

SNMP 陷阱的源 IP。

source_ipv6

字符串

SNMP 陷阱的源 IPv6。

status

字符串

启用/禁用此 SNMP 用户。

选项

  • "enable"

  • "disable"

trap_lport

整数

SNMPv3 本地陷阱端口。

trap_rport

整数

SNMPv3 陷阱远程端口。

trap_status

字符串

启用/禁用此 SNMP 用户的陷阱。

选项

  • "enable"

  • "disable"

vdoms

列表 / 元素=字典

SNMP 访问控制 VDOM。

name

字符串 / 必需

VDOM 名称。源 system.vdom.name。

vdom

字符串

虚拟域，在之前定义的那些域中。VDOM 是 FortiGate 的虚拟实例，可以将其配置并用作不同的单元。

默认值： "root"

备注

注意

  • 旧版 fortiosapi 已弃用，httpapi 是运行 playbook 的首选方式。

  • 此模块支持 check_mode。

示例

- name: SNMP user configuration.
  fortinet.fortios.fortios_system_snmp_user:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_snmp_user:
          auth_proto: "md5"
          auth_pwd: "<your_own_value>"
          events: "cpu-high"
          ha_direct: "enable"
          interface: "<your_own_value> (source system.interface.name)"
          interface_select_method: "auto"
          mib_view: "<your_own_value> (source system.snmp.mib-view.name)"
          name: "default_name_10"
          notify_hosts: "<your_own_value>"
          notify_hosts6: "<your_own_value>"
          priv_proto: "aes"
          priv_pwd: "<your_own_value>"
          queries: "enable"
          query_port: "161"
          security_level: "no-auth-no-priv"
          source_ip: "84.230.14.43"
          source_ipv6: "<your_own_value>"
          status: "enable"
          trap_lport: "162"
          trap_rport: "162"
          trap_status: "enable"
          vdoms:
              -
                  name: "default_name_25 (source system.vdom.name)"

返回值

常见的返回值已在 此处 文档中说明，以下是此模块特有的字段：

键

描述

build

字符串

FortiGate镜像的版本号

返回值： 始终返回

示例： "1547"

http_method

字符串

上次用于将内容配置到 FortiGate 的方法

返回值： 始终返回

示例： "PUT"

http_status

字符串

FortiGate 在上次执行的操作中给出的最后结果

返回值： 始终返回

示例： "200"

mkey

字符串

上次调用 FortiGate 时使用的主密钥 (ID)

返回值： 成功

示例： "id"

name

字符串

用于完成请求的表的名称

返回值： 始终返回

示例： "urlfilter"

path

字符串

用于完成请求的表的路径

返回值： 始终返回

示例： "webfilter"

revision

字符串

内部版本号

返回值： 始终返回

示例： "17.0.2.10658"

serial

字符串

设备的序列号

返回值： 始终返回

示例： "FGVMEVYYQT3AB5352"

status

字符串

操作结果指示

返回值： 始终返回

示例： "success"

vdom

字符串

使用的虚拟域

返回值： 始终返回

示例： "root"

version

字符串

FortiGate 的版本

返回值： 始终返回

示例： "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • 薛杰 (@JieX19)

  • 卢洪斌 (@fgtdev-hblu)

  • 沈方 (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)