fortios_system_snmp_user – SNMP user configuration 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 system_snmp feature and user category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
FortiOS Version Compatibility¶
v6.0.0 |
v6.0.5 |
v6.0.11 |
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.0.3 |
v7.0.4 |
v7.0.5 |
v7.0.6 |
v7.0.7 |
v7.0.8 |
v7.2.0 |
v7.2.1 |
v7.2.2 |
|
fortios_system_snmp_user | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | 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
- 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
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- system_snmp_user - SNMP user configuration. type: dict more...
- auth_proto - Authentication protocol. type: str choices: md5, sha, sha224, sha256, sha384, sha512 more...
- auth_pwd - Password for authentication protocol. type: str more...
- events - SNMP notifications (traps) to send. type: list choices: 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, bgp-established, bgp-backward-transition, ha-member-up, ha-member-down, ent-conf-change, av-conserve, av-bypass, av-oversize-passed, av-oversize-blocked, ips-pkg-update, ips-fail-open, faz-disconnect, wc-ap-up, wc-ap-down, fswctl-session-up, fswctl-session-down, load-balance-real-server-down, device-new, per-cpu-high, dhcp, pool-usage, ospf-nbr-state-change, ospf-virtnbr-state-change, temperature-high, voltage-alert, power-supply-failure, fan-failure more...
- ha_direct - Enable/disable direct management of HA cluster members. type: str choices: enable, disable more...
- mib_view - SNMP access control MIB view. Source system.snmp.mib-view.name. type: str more...
- name - SNMP user name. type: str required: true more...
- notify_hosts - SNMP managers to send notifications (traps) to. type: list
- notify_hosts6 - IPv6 SNMP managers to send notifications (traps) to. 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...
- query_port - SNMPv3 query port . type: int more...
- security_level - Security level for message authentication and encryption. type: str choices: no-auth-no-priv, auth-no-priv, auth-priv more...
- source_ip - Source IP for SNMP trap. type: str more...
- source_ipv6 - Source IPv6 for SNMP trap. type: str more...
- status - Enable/disable this SNMP user. type: str choices: enable, disable more...
- trap_lport - SNMPv3 local trap port . type: int more...
- trap_rport - SNMPv3 trap remote port . type: int more...
- trap_status - Enable/disable traps for this SNMP user. type: str choices: enable, disable more...
- vdoms - SNMP access control VDOMs. type: list more...
- name - VDOM name Source system.vdom.name. type: str 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: SNMP user configuration.
fortios_system_snmp_user:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_snmp_user:
auth_proto: "md5"
auth_pwd: "<your_own_value>"
events: "cpu-high"
ha_direct: "enable"
mib_view: "<your_own_value> (source system.snmp.mib-view.name)"
name: "default_name_8"
notify_hosts: "<your_own_value>"
notify_hosts6: "<your_own_value>"
priv_proto: "aes"
priv_pwd: "<your_own_value>"
queries: "enable"
query_port: "161"
security_level: "no-auth-no-priv"
source_ip: "84.230.14.43"
source_ipv6: "<your_own_value>"
status: "enable"
trap_lport: "162"
trap_rport: "162"
trap_status: "enable"
vdoms:
-
name: "default_name_23 (source system.vdom.name)"
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