You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

fortinet.fortios.fortios_system_snmp_user – SNMP user configuration in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.3).

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_system_snmp_user.

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 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

Requirements

The below requirements are needed on the host that executes this module.

• ansible>=2.9.0

Parameters

Parameter	Comments
access_token string	Token-based authentication. Generated from GUI of Fortigate.
enable_log boolean	Enable/Disable logging for task. Choices: no ← (default) yes
member_path string	Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation.
member_state string	Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices: present absent
state string / required	Indicates whether to create or remove the object. Choices: present absent
system_snmp_user dictionary	SNMP user configuration.
auth_proto string	Authentication protocol. Choices: md5 sha sha224 sha256 sha384 sha512
auth_pwd string	Password for authentication protocol.
events list / elements=string	SNMP notifications (traps) to send. 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 temperature-high voltage-alert power-supply-failure faz-disconnect fan-failure wc-ap-up wc-ap-down fswctl-session-up fswctl-session-down load-balance-real-server-down device-new per-cpu-high dhcp ospf-nbr-state-change ospf-virtnbr-state-change
ha_direct string	Enable/disable direct management of HA cluster members. Choices: enable disable
name string / required	SNMP user name.
notify_hosts string	SNMP managers to send notifications (traps) to.
notify_hosts6 string	IPv6 SNMP managers to send notifications (traps) to.
priv_proto string	Privacy (encryption) protocol. Choices: aes des aes256 aes256cisco
priv_pwd string	Password for privacy (encryption) protocol.
queries string	Enable/disable SNMP queries for this user. Choices: enable disable
query_port integer	SNMPv3 query port .
security_level string	Security level for message authentication and encryption. Choices: no-auth-no-priv auth-no-priv auth-priv
source_ip string	Source IP for SNMP trap.
source_ipv6 string	Source IPv6 for SNMP trap.
status string	Enable/disable this SNMP user. Choices: enable disable
trap_lport integer	SNMPv3 local trap port .
trap_rport integer	SNMPv3 trap remote port .
trap_status string	Enable/disable traps for this SNMP user. Choices: enable disable
vdom string	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. Default: “root”

Notes

Note

• Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- collections:
  - fortinet.fortios
  connection: httpapi
  hosts: fortigate01
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    vdom: root
  tasks:
  - name: fortios_system_snmp_user
    fortios_system_snmp_user:
      vdom: root
      state: present
      system_snmp_user:
        auth_proto: sha
        events: cpu-high
        ha_direct: disable
        name: '1'
        priv_proto: aes
        queries: disable
        query_port: 161
        security_level: no-auth-no-priv
        source_ip: 0.0.0.0
        source_ipv6: '::'
        status: disable
        trap_lport: 162
        trap_rport: 162
        trap_status: enable

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
build string	Build number of the fortigate image Returned: always Sample: “1547”
http_method string	Last method used to provision the content into FortiGate Returned: always Sample: “PUT”
http_status string	Last result given by FortiGate on last operation applied Returned: always Sample: “200”
mkey string	Master key (id) used in the last call to FortiGate Returned: success Sample: “id”
name string	Name of the table used to fulfill the request Returned: always Sample: “urlfilter”
path string	Path of the table used to fulfill the request Returned: always Sample: “webfilter”
revision string	Internal revision number Returned: always Sample: “17.0.2.10658”
serial string	Serial number of the unit Returned: always Sample: “FGVMEVYYQT3AB5352”
status string	Indication of the operation’s result Returned: always Sample: “success”
vdom string	Virtual domain used Returned: always Sample: “root”
version string	Version of the FortiGate Returned: always 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)