Try SpotterSNMP community configuration in Fortinet's FortiOS and FortiGate.
| "added in version" 2.0.0 of fortinet.fortios"
Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortios:==2.3.6
collections:
- name: fortinet.fortios
version: 2.3.6This 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
- name: SNMP community configuration.
fortinet.fortios.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"
mib_view: "<your_own_value> (source system.snmp.mib-view.name)"
name: "default_name_18"
query_v1_port: "161"
query_v1_status: "enable"
query_v2c_port: "161"
query_v2c_status: "enable"
status: "enable"
trap_v1_lport: "162"
trap_v1_rport: "162"
trap_v1_status: "enable"
trap_v2c_lport: "162"
trap_v2c_rport: "162"
trap_v2c_status: "enable"
vdoms:
-
name: "default_name_31 (source system.vdom.name)"
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
state:
choices:
- present
- absent
description:
- Indicates whether to create or remove the object.
required: true
type: str
enable_log:
default: false
description:
- Enable/Disable logging for task.
required: false
type: bool
member_path:
description:
- Member attribute path to operate on.
- Delimited by a slash character if there are more than one attribute.
- Parameter marked with member_path is legitimate for doing member operation.
type: str
access_token:
description:
- Token-based authentication. Generated from GUI of Fortigate.
required: false
type: str
member_state:
choices:
- present
- absent
description:
- Add or delete a member under specified attribute path.
- When member_state is specified, the state option is ignored.
type: str
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
- 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
- ospf-nbr-state-change
- ospf-virtnbr-state-change
- temperature-high
- voltage-alert
- power-supply
- fan-failure
- power-supply-failure
description:
- SNMP trap events.
elements: str
type: list
hosts:
description:
- Configure IPv4 SNMP managers (hosts).
elements: dict
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. No traps will be sent when IP type is subnet.
type: str
id:
description:
- Host entry ID. see <a href='#notes'>Notes</a>.
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.
elements: dict
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. see <a href='#notes'>Notes</a>.
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. see <a href='#notes'>Notes</a>.
required: true
type: int
mib_view:
description:
- SNMP access control MIB view. Source system.snmp.mib-view.name.
type: str
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
vdoms:
description:
- SNMP access control VDOMs.
elements: dict
suboptions:
name:
description:
- VDOM name. Source system.vdom.name.
required: true
type: str
type: list
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