fortinet.fortios.fortios_system_snmp_community module – SNMP community configuration in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortios
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_system_snmp_community
.
New in fortinet.fortios 2.0.0
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.15
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
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. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
SNMP community configuration. |
|
SNMP trap events. Choices:
|
|
Configure IPv4 SNMP managers (hosts). |
|
Enable/disable direct management of HA cluster members. Choices:
|
|
Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both. No traps will be sent when IP type is subnet. Choices:
|
|
Host entry ID. see <a href=’#notes’>Notes</a>. |
|
Specify outgoing interface to reach server. Source system.interface.name. |
|
Specify how to select outgoing interface to reach server. Choices:
|
|
IPv4 address of the SNMP manager (host). |
|
Source IPv4 address for SNMP traps. |
|
Configure IPv6 SNMP managers. |
|
Enable/disable direct management of HA cluster members. Choices:
|
|
Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both. Choices:
|
|
Host6 entry ID. see <a href=’#notes’>Notes</a>. |
|
Specify outgoing interface to reach server. Source system.interface.name. |
|
Specify how to select outgoing interface to reach server. Choices:
|
|
SNMP manager IPv6 address prefix. |
|
Source IPv6 address for SNMP traps. |
|
Community ID. see <a href=’#notes’>Notes</a>. |
|
SNMP access control MIB view. Source system.snmp.mib-view.name. |
|
Community name. |
|
SNMP v1 query port . |
|
Enable/disable SNMP v1 queries. Choices:
|
|
SNMP v2c query port . |
|
Enable/disable SNMP v2c queries. Choices:
|
|
Enable/disable this SNMP community. Choices:
|
|
SNMP v1 trap local port . |
|
SNMP v1 trap remote port . |
|
Enable/disable SNMP v1 traps. Choices:
|
|
SNMP v2c trap local port . |
|
SNMP v2c trap remote port . |
|
Enable/disable SNMP v2c traps. Choices:
|
|
SNMP access control VDOMs. |
|
VDOM name. Source system.vdom.name. |
|
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. Default: |
Notes
Note
We highly recommend using your own value as the id instead of 0, while ‘0’ is a special placeholder that allows the backend to assign the latest available number for the object, it does have limitations. Please find more details in Q&A.
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
Examples
- 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"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
ip: "<your_own_value>"
source_ip: "84.230.14.43"
hosts6:
-
ha_direct: "enable"
host_type: "any"
id: "15"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
ipv6: "<your_own_value>"
source_ipv6: "<your_own_value>"
id: "20"
mib_view: "<your_own_value> (source system.snmp.mib-view.name)"
name: "default_name_22"
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_35 (source system.vdom.name)"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |