fortios_switch_controller_snmp_community – Configure FortiSwitch SNMP v1/v2c communities globally in Fortinet’s FortiOS and FortiGate.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller feature and snmp_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.9.0
FortiOS Version Compatibility¶
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
|
fortios_switch_controller_snmp_community | yes | yes | yes | yes | yes | yes | yes | yes |
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
- state - Indicates whether to create or remove the object. type: str required: True choices: present, absent
- switch_controller_snmp_community - Configure FortiSwitch SNMP v1/v2c communities globally. type: dict more...
- events - SNMP notifications (traps) to send. type: list choices: cpu-high, mem-low, log-full, intf-ip, ent-conf-change more...
- hosts - Configure IPv4 SNMP managers (hosts). type: list more...
- id - Host entry ID. type: int required: True more...
- ip - IPv4 address of the SNMP manager (host). type: str more...
- id - SNMP community ID. type: int required: True more...
- name - SNMP community name. type: str more...
- query_v1_port - SNMP v1 query port . type: int more...
- query_v1_status - Enable/disable SNMP v1 queries. type: str choices: disable, enable more...
- query_v2c_port - SNMP v2c query port . type: int more...
- query_v2c_status - Enable/disable SNMP v2c queries. type: str choices: disable, enable more...
- status - Enable/disable this SNMP community. type: str choices: disable, enable more...
- trap_v1_lport - SNMP v2c trap local port . type: int more...
- trap_v1_rport - SNMP v2c trap remote port . type: int more...
- trap_v1_status - Enable/disable SNMP v1 traps. type: str choices: disable, enable more...
- trap_v2c_lport - SNMP v2c trap local port . type: int more...
- trap_v2c_rport - SNMP v2c trap remote port . type: int more...
- trap_v2c_status - Enable/disable SNMP v2c traps. type: str choices: disable, enable more...
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 FortiSwitch SNMP v1/v2c communities globally.
fortios_switch_controller_snmp_community:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_snmp_community:
events: "cpu-high"
hosts:
-
id: "5"
ip: "<your_own_value>"
id: "7"
name: "default_name_8"
query_v1_port: "9"
query_v1_status: "disable"
query_v2c_port: "11"
query_v2c_status: "disable"
status: "disable"
trap_v1_lport: "14"
trap_v1_rport: "15"
trap_v1_status: "disable"
trap_v2c_lport: "17"
trap_v2c_rport: "18"
trap_v2c_status: "disable"
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