fortinet.fortimanager.fmgr_system_snmp_user module – SNMP user configuration.

Note

This module is part of the fortinet.fortimanager collection (version 2.1.5).

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

To use it in a playbook, specify: fortinet.fortimanager.fmgr_system_snmp_user.

New in version 2.10: of fortinet.fortimanager

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter

Comments

bypass_validation

boolean

only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters

Choices:

  • no ← (default)

  • yes

enable_log

boolean

Enable/Disable logging for task

Choices:

  • no ← (default)

  • yes

proposed_method

string

The overridden method for the underlying Json RPC request

Choices:

  • update

  • set

  • add

rc_failed

list / elements=string

the rc codes list with which the conditions to fail will be overriden

rc_succeeded

list / elements=string

the rc codes list with which the conditions to succeed will be overriden

state

string / required

the directive to create, update or delete an object

Choices:

  • present

  • absent

system_snmp_user

dictionary

the top level parameters set

auth-proto

string

Authentication protocol.

md5 - HMAC-MD5-96 authentication protocol.

sha - HMAC-SHA-96 authentication protocol.

Choices:

  • md5

  • sha ← (default)

auth-pwd

string

Password for authentication protocol.

events

list / elements=string

SNMP notifications (traps) to send.

Choices:

  • disk_low

  • ha_switch

  • intf_ip_chg

  • sys_reboot

  • cpu_high

  • mem_low

  • log-alert

  • log-rate

  • log-data-rate

  • lic-gbday

  • lic-dev-quota

  • cpu-high-exclude-nice

name

string

SNMP user name.

notify-hosts

string

Hosts to send notifications (traps) to.

notify-hosts6

string

IPv6 hosts to send notifications (traps) to.

priv-proto

string

Privacy (encryption) protocol.

aes - CFB128-AES-128 symmetric encryption protocol.

des - CBC-DES symmetric encryption protocol.

Choices:

  • aes ← (default)

  • des

priv-pwd

string

Password for privacy (encryption) protocol.

queries

string

Enable/disable queries for this user.

disable - Disable setting.

enable - Enable setting.

Choices:

  • disable

  • enable ← (default)

query-port

integer

SNMPv3 query port.

Default: 161

security-level

string

Security level for message authentication and encryption.

no-auth-no-priv - Message with no authentication and no privacy (encryption).

auth-no-priv - Message with authentication but no privacy (encryption).

auth-priv - Message with authentication and privacy (encryption).

Choices:

  • no-auth-no-priv ← (default)

  • auth-no-priv

  • auth-priv

workspace_locking_adom

string

the adom to lock for FortiManager running in workspace mode, the value can be global and others including root

workspace_locking_timeout

integer

the maximum time in seconds to wait for other user to release the workspace lock

Default: 300

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state present directive.

  • To delete an object, use state absent directive.

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- name: gathering fortimanager facts
  hosts: fortimanager00
  gather_facts: no
  connection: httpapi
  collections:
    - fortinet.fortimanager
  vars:
    ansible_httpapi_use_ssl: True
    ansible_httpapi_validate_certs: False
    ansible_httpapi_port: 443
  tasks:
   - name: retrieve all the SNMP users
     fmgr_fact:
       facts:
           selector: 'system_snmp_user'
           params:
               user: ''

- hosts: fortimanager00
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: SNMP user configuration.
     fmgr_system_snmp_user:
        bypass_validation: False
        state: present
        system_snmp_user:
           auth-proto: md5 #<value in [md5, sha]>
           auth-pwd: fortinet
           events:
             - disk_low
             - ha_switch
             - intf_ip_chg
             - sys_reboot
             - cpu_high
             - mem_low
             - log-alert
             - log-rate
             - log-data-rate
             - lic-gbday
             - lic-dev-quota
             - cpu-high-exclude-nice
           name: ansible-test-snmpuser
           queries: disable
           security-level: no-auth-no-priv #<value in [no-auth-no-priv, auth-no-priv, auth-priv]>

Return Values

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

Key

Description

request_url

string

The full url requested

Returned: always

Sample: “/sys/login/user”

response_code

integer

The status of api request

Returned: always

Sample: 0

response_message

string

The descriptive message of the api response

Returned: always

Sample: “OK.”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)