fortinet.fortios.fortios_system_snmp_community – SNMP community configuration in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 1.1.8).

To install it use: ansible-galaxy collection install fortinet.fortios.

To use it in a playbook, specify: fortinet.fortios.fortios_system_snmp_community.

New in version 2.9: of fortinet.fortios

Synopsis

• This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system_snmp feature and community category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

The below requirements are needed on the host that executes this module.

• ansible>=2.9.0

Parameters

Parameter			Choices/Defaults	Comments
access_token string				Token-based authentication. Generated from GUI of Fortigate.
state string / required			Choices: present absent	Indicates whether to create or remove the object.
system_snmp_community dictionary				SNMP community configuration.
	events list / elements=string		Choices: 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 wc-ap-up wc-ap-down fswctl-session-up fswctl-session-down load-balance-real-server-down device-new per-cpu-high	SNMP trap events.
	hosts list / elements=string			Configure IPv4 SNMP managers (hosts).
		ha_direct string	Choices: enable disable	Enable/disable direct management of HA cluster members.
		host_type string	Choices: any query trap	Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both.
		id integer / required		Host entry ID.
		ip string		IPv4 address of the SNMP manager (host).
		source_ip string		Source IPv4 address for SNMP traps.
	hosts6 list / elements=string			Configure IPv6 SNMP managers.
		ha_direct string	Choices: enable disable	Enable/disable direct management of HA cluster members.
		host_type string	Choices: any query trap	Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both.
		id integer / required		Host6 entry ID.
		ipv6 string		SNMP manager IPv6 address prefix.
		source_ipv6 string		Source IPv6 address for SNMP traps.
	id integer / required			Community ID.
	name string			Community name.
	query_v1_port integer			SNMP v1 query port .
	query_v1_status string		Choices: enable disable	Enable/disable SNMP v1 queries.
	query_v2c_port integer			SNMP v2c query port .
	query_v2c_status string		Choices: enable disable	Enable/disable SNMP v2c queries.
	status string		Choices: enable disable	Enable/disable this SNMP community.
	trap_v1_lport integer			SNMP v1 trap local port .
	trap_v1_rport integer			SNMP v1 trap remote port .
	trap_v1_status string		Choices: enable disable	Enable/disable SNMP v1 traps.
	trap_v2c_lport integer			SNMP v2c trap local port .
	trap_v2c_rport integer			SNMP v2c trap remote port .
	trap_v2c_status string		Choices: enable disable	Enable/disable SNMP v2c traps.
vdom string			Default: "root"	Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit.

Notes

Note

• Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: SNMP community configuration.
    fortios_system_snmp_community:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_snmp_community:
        events: "cpu-high"
        hosts:
         -
            ha_direct: "enable"
            host_type: "any"
            id:  "7"
            ip: "<your_own_value>"
            source_ip: "84.230.14.43"
        hosts6:
         -
            ha_direct: "enable"
            host_type: "any"
            id:  "13"
            ipv6: "<your_own_value>"
            source_ipv6: "<your_own_value>"
        id:  "16"
        name: "default_name_17"
        query_v1_port: "18"
        query_v1_status: "enable"
        query_v2c_port: "20"
        query_v2c_status: "enable"
        status: "enable"
        trap_v1_lport: "23"
        trap_v1_rport: "24"
        trap_v1_status: "enable"
        trap_v2c_lport: "26"
        trap_v2c_rport: "27"
        trap_v2c_status: "enable"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
build string	always	Build number of the fortigate image Sample: 1547
http_method string	always	Last method used to provision the content into FortiGate Sample: PUT
http_status string	always	Last result given by FortiGate on last operation applied Sample: 200
mkey string	success	Master key (id) used in the last call to FortiGate Sample: id
name string	always	Name of the table used to fulfill the request Sample: urlfilter
path string	always	Path of the table used to fulfill the request Sample: webfilter
revision string	always	Internal revision number Sample: 17.0.2.10658
serial string	always	Serial number of the unit Sample: FGVMEVYYQT3AB5352
status string	always	Indication of the operation's result Sample: success
vdom string	always	Virtual domain used Sample: root
version string	always	Version of the FortiGate Sample: v5.6.3

Authors

• Link Zheng (@chillancezen)

• Jie Xue (@JieX19)

• Hongbin Lu (@fgtdev-hblu)

• Frank Shen (@frankshen01)

• Miguel Angel Munoz (@mamunozgonzalez)

• Nicolas Thomas (@thomnico)