Note
This plugin is part of the fortinet.fortimanager collection (version 2.0.1).
To install it use: ansible-galaxy collection install fortinet.fortimanager.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_devprof_system_snmp_community.
New in version 2.10: of fortinet.fortimanager
| Parameter | Choices/Defaults | Comments | ||
|---|---|---|---|---|
| adom string / required | the parameter (adom) in requested url | |||
| bypass_validation boolean |
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters | ||
| devprof string / required | the parameter (devprof) in requested url | |||
| devprof_system_snmp_community dictionary | the top level parameters set | |||
| events list / elements=string |
| no description | ||
| hosts list / elements=string | no description | |||
| 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 | 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 | no description | |||
| 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 | Host6 entry ID. | |||
| ipv6 string | SNMP manager IPv6 address prefix. | |||
| source-ipv6 string | Source IPv6 address for SNMP traps. | |||
| id integer | Community ID. | |||
| name string | Community name. | |||
| query-v1-port integer | SNMP v1 query port (default = 161). | |||
| query-v1-status string |
| Enable/disable SNMP v1 queries. | ||
| query-v2c-port integer | SNMP v2c query port (default = 161). | |||
| 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 (default = 162). | |||
| trap-v1-rport integer | SNMP v1 trap remote port (default = 162). | |||
| trap-v1-status string |
| Enable/disable SNMP v1 traps. | ||
| trap-v2c-lport integer | SNMP v2c trap local port (default = 162). | |||
| trap-v2c-rport integer | SNMP v2c trap remote port (default = 162). | |||
| trap-v2c-status string |
| Enable/disable SNMP v2c traps. | ||
| rc_failed list / elements=string | the rc codes list with which the conditions to fail will be overriden | |||
| rc_succeeded list / elements=string | the rc codes list with which the conditions to succeed will be overriden | |||
| state string / required |
| the directive to create, update or delete an object | ||
| workspace_locking_adom string | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root | |||
| workspace_locking_timeout integer | Default: 300 | the maximum time in seconds to wait for other user to release the workspace lock | ||
Note
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: SNMP community configuration.
fmgr_devprof_system_snmp_community:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
devprof: <your own value>
state: <value in [present, absent]>
devprof_system_snmp_community:
events:
- 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
- temperature-high
- voltage-alert
- ha-member-up
- ha-member-down
- ent-conf-change
- av-conserve
- av-bypass
- av-oversize-passed
- av-oversize-blocked
- ips-pkg-update
- power-supply-failure
- amc-bypass
- faz-disconnect
- fan-failure
- bgp-established
- bgp-backward-transition
- wc-ap-up
- wc-ap-down
- fswctl-session-up
- fswctl-session-down
- ips-fail-open
- load-balance-real-server-down
- device-new
- enter-intf-bypass
- exit-intf-bypass
- per-cpu-high
- power-blade-down
- confsync_failure
hosts:
-
ha-direct: <value in [disable, enable]>
host-type: <value in [any, query, trap]>
id: <value of integer>
ip: <value of string>
source-ip: <value of string>
hosts6:
-
ha-direct: <value in [disable, enable]>
host-type: <value in [any, query, trap]>
id: <value of integer>
ipv6: <value of string>
source-ipv6: <value of string>
id: <value of integer>
name: <value of string>
query-v1-port: <value of integer>
query-v1-status: <value in [disable, enable]>
query-v2c-port: <value of integer>
query-v2c-status: <value in [disable, enable]>
status: <value in [disable, enable]>
trap-v1-lport: <value of integer>
trap-v1-rport: <value of integer>
trap-v1-status: <value in [disable, enable]>
trap-v2c-lport: <value of integer>
trap-v2c-rport: <value of integer>
trap-v2c-status: <value in [disable, enable]>
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| request_url string | always | The full url requested Sample: /sys/login/user |
| response_code integer | always | The status of api request |
| response_message string | always | The descriptive message of the api response Sample: OK. |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_devprof_system_snmp_community_module.html