fortinet.fortios.fortios_wireless_controller_snmp – Configure SNMP in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 2.1.2).
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.
To use it in a playbook, specify: fortinet.fortios.fortios_wireless_controller_snmp.
New in version 2.10: of fortinet.fortios
Synopsis
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller feature and snmp 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.9.0
Parameters
| Parameter | Choices/Defaults | Comments | |||
|---|---|---|---|---|---|
| access_token
string
|
Token-based authentication. Generated from GUI of Fortigate.
|
||||
| enable_log
boolean
|
|
Enable/Disable logging for task.
|
|||
| 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.
|
|||
| wireless_controller_snmp
dictionary
|
Configure SNMP.
|
||||
| community
list / elements=string
|
SNMP Community Configuration.
|
||||
| hosts
list / elements=string
|
Configure IPv4 SNMP managers (hosts).
|
||||
| id
integer / required
|
Host entry ID.
|
||||
| ip
string
|
IPv4 address of the SNMP manager (host).
|
||||
| id
integer / required
|
Community ID.
|
||||
| name
string
|
Community name.
|
||||
| query_v1_status
string
|
|
Enable/disable SNMP v1 queries.
|
|||
| query_v2c_status
string
|
|
Enable/disable SNMP v2c queries.
|
|||
| status
string
|
|
Enable/disable this SNMP community.
|
|||
| trap_v1_status
string
|
|
Enable/disable SNMP v1 traps.
|
|||
| trap_v2c_status
string
|
|
Enable/disable SNMP v2c traps.
|
|||
| contact_info
string
|
Contact Information.
|
||||
| engine_id
string
|
AC SNMP engineId string (maximum 24 characters).
|
||||
| trap_high_cpu_threshold
integer
|
CPU usage when trap is sent.
|
||||
| trap_high_mem_threshold
integer
|
Memory usage when trap is sent.
|
||||
| user
list / elements=string
|
SNMP User Configuration.
|
||||
| auth_proto
string
|
|
Authentication protocol.
|
|||
| auth_pwd
string
|
Password for authentication protocol.
|
||||
| name
string / required
|
SNMP User Name
|
||||
| notify_hosts
string
|
Configure SNMP User Notify Hosts.
|
||||
| priv_proto
string
|
|
Privacy (encryption) protocol.
|
|||
| priv_pwd
string
|
Password for privacy (encryption) protocol.
|
||||
| queries
string
|
|
Enable/disable SNMP queries for this user.
|
|||
| security_level
string
|
|
Security level for message authentication and encryption.
|
|||
| status
string
|
|
SNMP User Enable
|
|||
| trap_status
string
|
|
Enable/disable traps for this SNMP user.
|
|||
Notes
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure SNMP.
fortios_wireless_controller_snmp:
vdom: "{{ vdom }}"
wireless_controller_snmp:
community:
-
hosts:
-
id: "5"
ip: "<your_own_value>"
id: "7"
name: "default_name_8"
query_v1_status: "enable"
query_v2c_status: "enable"
status: "enable"
trap_v1_status: "enable"
trap_v2c_status: "enable"
contact_info: "<your_own_value>"
engine_id: "<your_own_value>"
trap_high_cpu_threshold: "16"
trap_high_mem_threshold: "17"
user:
-
auth_proto: "md5"
auth_pwd: "<your_own_value>"
name: "default_name_21"
notify_hosts: "<your_own_value>"
priv_proto: "aes"
priv_pwd: "<your_own_value>"
queries: "enable"
security_level: "no-auth-no-priv"
status: "enable"
trap_status: "enable"
Return Values
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
|
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_wireless_controller_snmp_module.html