fortios_system_snmp_user.rst

source:	fortios_system_snmp_user.py
orphan:

fortios_system_snmp_user -- SNMP user configuration in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

• Synopsis
• Requirements
• Tips
• FortiOS Version Compatibility
• Parameters
• Notes
• Examples
• Return Values
• Status
• Authors

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

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

	Supported Version Ranges
fortios_system_snmp_user	v6.0.0 -> latest

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

  	Supported Version Ranges
  system_snmp_user	v6.0.0 -> latest

• auth_proto - Authentication protocol. type: str choices: md5, sha, sha224, sha256, sha384, sha512 more...

  	Supported Version Ranges
  auth_proto	v6.0.0 -> latest
  [md5]	v6.0.0 -> latest
  [sha]	v6.0.0 -> latest
  [sha224]	v6.2.0 -> latest
  [sha256]	v6.2.0 -> latest
  [sha384]	v6.2.0 -> latest
  [sha512]	v6.2.0 -> latest

• auth_pwd - Password for authentication protocol. type: str more...

  	Supported Version Ranges
  auth_pwd	v6.0.0 -> latest

• 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, faz, 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...

  	Supported Version Ranges
  events	v6.0.0 -> latest
  [cpu-high]	v6.0.0 -> latest
  [mem-low]	v6.0.0 -> latest
  [log-full]	v6.0.0 -> latest
  [intf-ip]	v6.0.0 -> latest
  [vpn-tun-up]	v6.0.0 -> latest
  [vpn-tun-down]	v6.0.0 -> latest
  [ha-switch]	v6.0.0 -> latest
  [ha-hb-failure]	v6.0.0 -> latest
  [ips-signature]	v6.0.0 -> latest
  [ips-anomaly]	v6.0.0 -> latest
  [av-virus]	v6.0.0 -> latest
  [av-oversize]	v6.0.0 -> latest
  [av-pattern]	v6.0.0 -> latest
  [av-fragmented]	v6.0.0 -> latest
  [fm-if-change]	v6.0.0 -> latest
  [fm-conf-change]	v6.0.0 -> latest
  [bgp-established]	v6.0.0 -> latest
  [bgp-backward-transition]	v6.0.0 -> latest
  [ha-member-up]	v6.0.0 -> latest
  [ha-member-down]	v6.0.0 -> latest
  [ent-conf-change]	v6.0.0 -> latest
  [av-conserve]	v6.0.0 -> latest
  [av-bypass]	v6.0.0 -> latest
  [av-oversize-passed]	v6.0.0 -> latest
  [av-oversize-blocked]	v6.0.0 -> latest
  [ips-pkg-update]	v6.0.0 -> latest
  [ips-fail-open]	v6.0.0 -> latest
  [faz-disconnect]	v6.0.0 -> latest
  [faz]	v7.4.1 -> latest
  [wc-ap-up]	v6.0.0 -> latest
  [wc-ap-down]	v6.0.0 -> latest
  [fswctl-session-up]	v6.0.0 -> latest
  [fswctl-session-down]	v6.0.0 -> latest
  [load-balance-real-server-down]	v6.0.0 -> latest
  [device-new]	v6.0.0 -> latest
  [per-cpu-high]	v6.0.0 -> latest
  [dhcp]	v6.4.0 -> latest
  [pool-usage]	v7.0.6 -> v7.0.12	v7.2.1 -> latest
  [ospf-nbr-state-change]	v7.0.0 -> latest
  [ospf-virtnbr-state-change]	v7.0.0 -> latest
  [temperature-high]	v6.0.0 -> latest
  [voltage-alert]	v6.0.0 -> latest
  [power-supply-failure]	v6.0.0 -> latest
  [fan-failure]	v6.0.0 -> latest

• ha_direct - Enable/disable direct management of HA cluster members. type: str choices: enable, disable more...

  	Supported Version Ranges
  ha_direct	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• mib_view - SNMP access control MIB view. Source system.snmp.mib-view.name. type: str more...

  	Supported Version Ranges
  mib_view	v7.2.0 -> latest

• name - SNMP user name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> latest

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

  	Supported Version Ranges
  priv_proto	v6.0.0 -> latest
  [aes]	v6.0.0 -> latest
  [des]	v6.0.0 -> latest
  [aes256]	v6.0.0 -> latest
  [aes256cisco]	v6.0.0 -> latest

• priv_pwd - Password for privacy (encryption) protocol. type: str more...

  	Supported Version Ranges
  priv_pwd	v6.0.0 -> latest

• queries - Enable/disable SNMP queries for this user. type: str choices: enable, disable more...

  	Supported Version Ranges
  queries	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• query_port - SNMPv3 query port . type: int more...

  	Supported Version Ranges
  query_port	v6.0.0 -> latest

• security_level - Security level for message authentication and encryption. type: str choices: no-auth-no-priv, auth-no-priv, auth-priv more...

  	Supported Version Ranges
  security_level	v6.0.0 -> latest
  [no-auth-no-priv]	v6.0.0 -> latest
  [auth-no-priv]	v6.0.0 -> latest
  [auth-priv]	v6.0.0 -> latest

• source_ip - Source IP for SNMP trap. type: str more...

  	Supported Version Ranges
  source_ip	v6.0.0 -> latest

• source_ipv6 - Source IPv6 for SNMP trap. type: str more...

  	Supported Version Ranges
  source_ipv6	v6.0.0 -> latest

• status - Enable/disable this SNMP user. type: str choices: enable, disable more...

  	Supported Version Ranges
  status	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• trap_lport - SNMPv3 local trap port . type: int more...

  	Supported Version Ranges
  trap_lport	v6.0.0 -> latest

• trap_rport - SNMPv3 trap remote port . type: int more...

  	Supported Version Ranges
  trap_rport	v6.0.0 -> latest

• trap_status - Enable/disable traps for this SNMP user. type: str choices: enable, disable more...

  	Supported Version Ranges
  trap_status	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• vdoms - SNMP access control VDOMs. type: list member_path: vdoms:name more...

  	Supported Version Ranges
  vdoms	v7.2.0 -> latest

• name - VDOM name. Source system.vdom.name. type: str required: true more...

  	Supported Version Ranges
  name	v7.2.0 -> latest

Notes

Note

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

Examples

- name: SNMP user configuration.
  fortinet.fortios.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

Status

• This module is not guaranteed to have a backwards compatible interface.

Authors

• Link Zheng (@chillancezen)
• Jie Xue (@JieX19)
• Hongbin Lu (@fgtdev-hblu)
• Frank Shen (@frankshen01)
• Miguel Angel Munoz (@mamunozgonzalez)
• Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.