fortios_wireless_controller_snmp – Configure SNMP in Fortinet’s FortiOS and FortiGate.
New in version 2.0.0.
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.15
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v6.2.0 -> 7.4.3
Parameters
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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 default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- wireless_controller_snmp - Configure SNMP. type: dict more...
- community - SNMP Community Configuration. type: list member_path: community:id more...
- hosts - Configure IPv4 SNMP managers (hosts). type: list member_path: community:id/hosts:id more...
- id - Host entry ID. see Notes. type: int required: true more...
- ip - IPv4 address of the SNMP manager (host). type: str more...
- id - Community ID. see Notes. type: int required: true more...
- name - Community name. type: str more...
- query_v1_status - Enable/disable SNMP v1 queries. type: str choices: enable, disable more...
- query_v2c_status - Enable/disable SNMP v2c queries. type: str choices: enable, disable more...
- status - Enable/disable this SNMP community. type: str choices: enable, disable more...
- trap_v1_status - Enable/disable SNMP v1 traps. type: str choices: enable, disable more...
- trap_v2c_status - Enable/disable SNMP v2c traps. type: str choices: enable, disable more...
- contact_info - Contact Information. type: str more...
- engine_id - AC SNMP engineID string (maximum 24 characters). type: str more...
- trap_high_cpu_threshold - CPU usage when trap is sent. type: int more...
- trap_high_mem_threshold - Memory usage when trap is sent. type: int more...
- user - SNMP User Configuration. type: list member_path: user:name more...
- auth_proto - Authentication protocol. type: str choices: md5, sha more...
- auth_pwd - Password for authentication protocol. type: str more...
- name - SNMP user name. type: str required: true more...
- notify_hosts - Configure SNMP User Notify Hosts. type: list
- priv_proto - Privacy (encryption) protocol. type: str choices: aes, des, aes256, aes256cisco more...
- priv_pwd - Password for privacy (encryption) protocol. type: str more...
- queries - Enable/disable SNMP queries for this user. type: str choices: enable, disable more...
- security_level - Security level for message authentication and encryption. type: str choices: no-auth-no-priv, auth-no-priv, auth-priv more...
- status - SNMP user enable. type: str choices: enable, disable more...
- trap_status - Enable/disable traps for this SNMP user. type: str choices: enable, disable more...
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Configure SNMP.
fortinet.fortios.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: "80"
trap_high_mem_threshold: "80"
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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
Status
This module is not guaranteed to have a backwards compatible interface.