New in version 2.9.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | ||
---|---|---|---|---|
host string | FortiOS or FortiGate IP address. | |||
https boolean |
| Indicates if the requests towards FortiGate must use HTTPS protocol. | ||
password string | Default: "" | FortiOS or FortiGate password. | ||
ssl_verify boolean |
| Ensures FortiGate certificate must be verified by a proper CA. | ||
state string / required |
| Indicates whether to create or remove the object. | ||
system_snmp_community dictionary | Default: null | SNMP community configuration. | ||
events string |
| SNMP trap events. | ||
hosts list | Configure IPv4 SNMP managers (hosts). | |||
ha_direct string |
| Enable/disable direct management of HA cluster members. | ||
host_type string |
| 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 | Configure IPv6 SNMP managers. | |||
ha_direct string |
| Enable/disable direct management of HA cluster members. | ||
host_type string |
| 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 |
| Enable/disable SNMP v1 queries. | ||
query_v2c_port integer | SNMP v2c query port . | |||
query_v2c_status string |
| Enable/disable SNMP v2c queries. | ||
status string |
| 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 |
| 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 |
| Enable/disable SNMP v2c traps. | ||
username string | FortiOS or FortiGate username. | |||
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. |
Note
- 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"
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 |
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_system_snmp_community_module.html