Try SpotterSNMP user configuration in Fortinet's FortiOS and FortiGate.
| "added in version" 2.9 of ansible.builtin"
Authors: Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)
preview | supported by community
pipInstall with pip install ansible==2.9.27
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.5
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
ssl_verify: "False"
tasks:
- name: SNMP user configuration.
fortios_system_snmp_user:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
state: "present"
system_snmp_user:
auth_proto: "md5"
auth_pwd: "<your_own_value>"
events: "cpu-high"
ha_direct: "enable"
name: "default_name_7"
notify_hosts: "<your_own_value>"
notify_hosts6: "<your_own_value>"
priv_proto: "aes"
priv_pwd: "<your_own_value>"
queries: "enable"
query_port: "13"
security_level: "no-auth-no-priv"
source_ip: "84.230.14.43"
source_ipv6: "<your_own_value>"
status: "enable"
trap_lport: "18"
trap_rport: "19"
trap_status: "enable"
host:
description:
- FortiOS or FortiGate IP address.
required: false
type: str
vdom:
default: root
description:
- 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
https:
default: true
description:
- Indicates if the requests towards FortiGate must use HTTPS protocol.
type: bool
state:
choices:
- present
- absent
description:
- Indicates whether to create or remove the object.
required: true
type: str
password:
default: ''
description:
- FortiOS or FortiGate password.
type: str
username:
description:
- FortiOS or FortiGate username.
required: false
type: str
ssl_verify:
default: true
description:
- Ensures FortiGate certificate must be verified by a proper CA.
type: bool
system_snmp_user:
default: null
description:
- SNMP user configuration.
suboptions:
auth_proto:
choices:
- md5
- sha
description:
- Authentication protocol.
type: str
auth_pwd:
description:
- Password for authentication protocol.
type: str
events:
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
description:
- SNMP notifications (traps) to send.
type: list
ha_direct:
choices:
- enable
- disable
description:
- Enable/disable direct management of HA cluster members.
type: str
name:
description:
- SNMP user name.
required: true
type: str
notify_hosts:
description:
- SNMP managers to send notifications (traps) to.
type: list
notify_hosts6:
description:
- IPv6 SNMP managers to send notifications (traps) to.
type: list
priv_proto:
choices:
- aes
- des
- aes256
- aes256cisco
description:
- Privacy (encryption) protocol.
type: str
priv_pwd:
description:
- Password for privacy (encryption) protocol.
type: str
queries:
choices:
- enable
- disable
description:
- Enable/disable SNMP queries for this user.
type: str
query_port:
description:
- SNMPv3 query port .
type: int
security_level:
choices:
- no-auth-no-priv
- auth-no-priv
- auth-priv
description:
- Security level for message authentication and encryption.
type: str
source_ip:
description:
- Source IP for SNMP trap.
type: str
source_ipv6:
description:
- Source IPv6 for SNMP trap.
type: str
status:
choices:
- enable
- disable
description:
- Enable/disable this SNMP user.
type: str
trap_lport:
description:
- SNMPv3 local trap port .
type: int
trap_rport:
description:
- SNMPv3 trap remote port .
type: int
trap_status:
choices:
- enable
- disable
description:
- Enable/disable traps for this SNMP user.
type: str
type: dict
build: description: Build number of the fortigate image returned: always sample: '1547' type: str http_method: description: Last method used to provision the content into FortiGate returned: always sample: PUT type: str http_status: description: Last result given by FortiGate on last operation applied returned: always sample: '200' type: str mkey: description: Master key (id) used in the last call to FortiGate returned: success sample: id type: str name: description: Name of the table used to fulfill the request returned: always sample: urlfilter type: str path: description: Path of the table used to fulfill the request returned: always sample: webfilter type: str revision: description: Internal revision number returned: always sample: 17.0.2.10658 type: str serial: description: Serial number of the unit returned: always sample: FGVMEVYYQT3AB5352 type: str status: description: Indication of the operation's result returned: always sample: success type: str vdom: description: Virtual domain used returned: always sample: root type: str version: description: Version of the FortiGate returned: always sample: v5.6.3 type: str