ansible / ansible.builtin / v2.9.27 / module / fortios_system_snmp_community SNMP community configuration in Fortinet's FortiOS and FortiGate. | "added in version" 2.9 of ansible.builtin" Authors: Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico) preview | supported by communityansible.builtin.fortios_system_snmp_community (v2.9.27) — module
pip
Install with pip install ansible==2.9.27
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.5
- hosts: localhost vars: host: "192.168.122.40" username: "admin" password: "" vdom: "root" ssl_verify: "False" tasks: - name: SNMP community configuration. fortios_system_snmp_community: host: "{{ host }}" username: "{{ username }}" password: "{{ password }}" vdom: "{{ vdom }}" https: "False" state: "present" 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"
host: description: - FortiOS or FortiGate IP address. required: false type: str vdom: default: root description: - 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. type: str https: default: true description: - Indicates if the requests towards FortiGate must use HTTPS protocol. type: bool state: choices: - present - absent description: - Indicates whether to create or remove the object. required: true type: str password: default: '' description: - FortiOS or FortiGate password. type: str username: description: - FortiOS or FortiGate username. required: false type: str ssl_verify: default: true description: - Ensures FortiGate certificate must be verified by a proper CA. type: bool system_snmp_community: default: null description: - SNMP community configuration. suboptions: events: 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 description: - SNMP trap events. type: str hosts: description: - Configure IPv4 SNMP managers (hosts). suboptions: ha_direct: choices: - enable - disable description: - Enable/disable direct management of HA cluster members. type: str host_type: choices: - any - query - trap description: - Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both. type: str id: description: - Host entry ID. required: true type: int ip: description: - IPv4 address of the SNMP manager (host). type: str source_ip: description: - Source IPv4 address for SNMP traps. type: str type: list hosts6: description: - Configure IPv6 SNMP managers. suboptions: ha_direct: choices: - enable - disable description: - Enable/disable direct management of HA cluster members. type: str host_type: choices: - any - query - trap description: - Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both. type: str id: description: - Host6 entry ID. required: true type: int ipv6: description: - SNMP manager IPv6 address prefix. type: str source_ipv6: description: - Source IPv6 address for SNMP traps. type: str type: list id: description: - Community ID. required: true type: int name: description: - Community name. type: str query_v1_port: description: - SNMP v1 query port . type: int query_v1_status: choices: - enable - disable description: - Enable/disable SNMP v1 queries. type: str query_v2c_port: description: - SNMP v2c query port . type: int query_v2c_status: choices: - enable - disable description: - Enable/disable SNMP v2c queries. type: str status: choices: - enable - disable description: - Enable/disable this SNMP community. type: str trap_v1_lport: description: - SNMP v1 trap local port . type: int trap_v1_rport: description: - SNMP v1 trap remote port . type: int trap_v1_status: choices: - enable - disable description: - Enable/disable SNMP v1 traps. type: str trap_v2c_lport: description: - SNMP v2c trap local port . type: int trap_v2c_rport: description: - SNMP v2c trap remote port . type: int trap_v2c_status: choices: - enable - disable description: - Enable/disable SNMP v2c traps. type: str type: dict
build: description: Build number of the fortigate image returned: always sample: '1547' type: str http_method: description: Last method used to provision the content into FortiGate returned: always sample: PUT type: str http_status: description: Last result given by FortiGate on last operation applied returned: always sample: '200' type: str mkey: description: Master key (id) used in the last call to FortiGate returned: success sample: id type: str name: description: Name of the table used to fulfill the request returned: always sample: urlfilter type: str path: description: Path of the table used to fulfill the request returned: always sample: webfilter type: str revision: description: Internal revision number returned: always sample: 17.0.2.10658 type: str serial: description: Serial number of the unit returned: always sample: FGVMEVYYQT3AB5352 type: str status: description: Indication of the operation's result returned: always sample: success type: str vdom: description: Virtual domain used returned: always sample: root type: str version: description: Version of the FortiGate returned: always sample: v5.6.3 type: str