fortinet.fortimanager.fmgr_devprof_system_snmp_community 模块 – SNMP 社区配置。

注意

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

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

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

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

fortinet.fortimanager 1.0.0 中的新增功能

概要

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

• 示例包含所有需要在使用前根据数据源调整的参数和值。

参数

参数	注释
access_token 字符串	无需使用用户名和密码即可访问 FortiManager 的令牌。
adom 字符串 / 必填	请求 URL 中的参数 (adom)。
bypass_validation 布尔值	仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而无需验证参数。 选项 false ← (默认) true
devprof 字符串 / 必填	请求 URL 中的参数 (devprof)。
devprof_system_snmp_community 字典	设置的顶级参数。
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" "temperature-high" "voltage-alert" "ha-member-up" "ha-member-down" "ent-conf-change" "av-conserve" "av-bypass" "av-oversize-passed" "av-oversize-blocked" "ips-pkg-update" "power-supply-failure" "amc-bypass" "faz-disconnect" "fan-failure" "bgp-established" "bgp-backward-transition" "wc-ap-up" "wc-ap-down" "fswctl-session-up" "fswctl-session-down" "ips-fail-open" "load-balance-real-server-down" "device-new" "enter-intf-bypass" "exit-intf-bypass" "per-cpu-high" "power-blade-down" "confsync_failure" "dhcp" "pool-usage" "power-redundancy-degrade" "power-redundancy-failure" "ospf-nbr-state-change" "ospf-virtnbr-state-change" "disk-failure" "disk-overload" "faz-main-failover" "faz-alt-failover" "slbc" "faz" "power-supply" "ippool" "interface" "security_level_change" "cert-expiry"
hosts 列表 / 元素=字典	主机。
ha_direct 别名：ha-direct 字符串	启用/禁用 HA 集群成员的直接管理。 选项 "disable" "enable"
host_type 别名：host-type 字符串	控制 SNMP 管理器是否发送 SNMP 查询、接收 SNMP 陷阱或同时执行这两项操作。 选项 "any" "query" "trap"
id 整数	主机条目 ID。
interface 任意	(列表) 指定到达服务器的出站接口。
interface_select_method 别名：interface-select-method 字符串	指定如何选择到达服务器的出站接口。 选项 "auto" "sdwan" "specify"
ip 字符串	SNMP 管理器的 IPv4 地址
source_ip 别名：source-ip 字符串	SNMP 陷阱的源 IPv4 地址。
hosts6 列表 / 元素=字典	Hosts6。
ha_direct 别名：ha-direct 字符串	启用/禁用 HA 集群成员的直接管理。 选项 "disable" "enable"
host_type 别名：host-type 字符串	控制 SNMP 管理器是否发送 SNMP 查询、接收 SNMP 陷阱或同时执行这两项操作。 选项 "any" "query" "trap"
id 整数	Host6 条目 ID。
interface 任意	(列表) 指定到达服务器的出站接口。
interface_select_method 别名：interface-select-method 字符串	指定如何选择到达服务器的出站接口。 选项 "auto" "sdwan" "specify"
ipv6 字符串	SNMP 管理器的 IPv6 地址前缀。
source_ipv6 别名：source-ipv6 字符串	SNMP 陷阱的源 IPv6 地址。
id 整数 / 必填	社区 ID。
mib_view 别名：mib-view 字符串	SNMP 访问控制 MIB 视图。
name 字符串	社区名称。
query_v1_port 别名：query-v1-port 整数	SNMP v1 查询端口
query_v1_status 别名：query-v1-status 字符串	启用/禁用 SNMP v1 查询。 选项 "disable" "enable"
query_v2c_port 别名：query-v2c-port 整数	SNMP v2c 查询端口
query_v2c_status 别名：query-v2c-status 字符串	启用/禁用 SNMP v2c 查询。 选项 "disable" "enable"
status 字符串	启用/禁用此 SNMP 社区。 选项 "disable" "enable"
trap_v1_lport 别名：trap-v1-lport 整数	SNMP v1 陷阱本地端口
trap_v1_rport 别名：trap-v1-rport 整数	SNMP v1 陷阱远程端口
trap_v1_status 别名：trap-v1-status 字符串	启用/禁用 SNMP v1 陷阱。 选项 "disable" "enable"
trap_v2c_lport 别名：trap-v2c-lport 整数	SNMP v2c 陷阱本地端口
trap_v2c_rport 别名：trap-v2c-rport 整数	SNMP v2c 陷阱远程端口
trap_v2c_status 别名：trap-v2c-status 字符串	启用/禁用 SNMP v2c 陷阱。 选项 "disable" "enable"
vdoms 任意	（列表）SNMP 访问控制 VDOM。
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"
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
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: SNMP community configuration.
      fortinet.fortimanager.fmgr_devprof_system_snmp_community:
        bypass_validation: false
        adom: ansible
        devprof: "ansible-test" # system template name, could find it in FortiManager UI: Device Manager --> Provisioning Templates --> System Templates
        state: present
        devprof_system_snmp_community:
          events:
            - 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
            - temperature-high
            - voltage-alert
            - ha-member-up
            - ha-member-down
            - ent-conf-change
            - av-conserve
            - av-bypass
            - av-oversize-passed
            - av-oversize-blocked
            - ips-pkg-update
            - power-supply-failure
            - amc-bypass
            - faz-disconnect
            - fan-failure
            - bgp-established
            - bgp-backward-transition
            - wc-ap-up
            - wc-ap-down
            - fswctl-session-up
            - fswctl-session-down
            - ips-fail-open
            - load-balance-real-server-down
            - device-new
            - enter-intf-bypass
            - exit-intf-bypass
            - per-cpu-high
            - power-blade-down
            - confsync_failure
          hosts:
            - ha-direct: enable
              host-type: any
              id: 1
          id: 1
          name: "ansible-test"

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the communities in system template
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "devprof_system_snmp_community"
          params:
            adom: "ansible"
            devprof: "ansible-test" # system template name, could find it in FortiManager UI: Device Manager --> Provisioning Templates --> System Templates
            community: "your_value"

返回值

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

键	描述
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 版本支持，则会发出警告。 返回值： 复杂

作者

• 杜欣伟 (@dux-fortinet)

• 李兴 (@lix-fortinet)

• 薛杰 (@JieX19)

• 郑凌 (@chillancezen)

• 沈峰 (@fshen01)

• 陆宏斌 (@fgtdev-hblu)

收藏链接

• 问题跟踪器
• 主页
• 资源库（源代码）