fortinet.fortimanager.fmgr_system_snmp_user module – SNMP user configuration.
Note
This module is part of the fortinet.fortimanager collection (version 2.8.2).
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 fortinet.fortimanager 2.0.0
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 |
|---|---|
The token to access FortiManager without using username and password. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The top level parameters set. |
|
Authentication protocol. md5 - HMAC-MD5-96 authentication protocol. sha - HMAC-SHA-96 authentication protocol. Choices:
|
|
(list) Password for authentication protocol. |
|
SNMP notifications disk_low - Disk usage too high. ha_switch - HA switch. intf_ip_chg - Interface IP address changed. sys_reboot - System reboot. cpu_high - CPU usage too high. mem_low - Available memory is low. log-alert - Log base alert message. log-rate - High incoming log rate detected. log-data-rate - High incoming log data rate detected. lic-gbday - High licensed log GB/day detected. lic-dev-quota - High licensed device quota detected. cpu-high-exclude-nice - CPU usage exclude NICE threshold. Choices:
|
|
SNMP user name. |
|
Hosts to send notifications |
|
IPv6 hosts to send notifications |
|
Privacy aes - CFB128-AES-128 symmetric encryption protocol. des - CBC-DES symmetric encryption protocol. Choices:
|
|
(list) Password for privacy |
|
Enable/disable queries for this user. disable - Disable setting. enable - Enable setting. Choices:
|
|
SNMPv3 query port. |
|
Security level for message authentication and encryption. no-auth-no-priv - Message with no authentication and no privacy auth-no-priv - Message with authentication but no privacy auth-priv - Message with authentication and privacy Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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: Example playbook
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: SNMP user configuration.
fortinet.fortimanager.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]>
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the SNMP users
fortinet.fortimanager.fmgr_fact:
facts:
selector: "system_snmp_user"
params:
user: "your_value"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |