fortinet.fortimanager.fmgr_system_snmp_user – SNMP user configuration.
fortinet.fortimanager.fmgr_system_snmp_user – SNMP user configuration.
Note
This plugin is part of the fortinet.fortimanager collection (version 2.0.1).
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 | Choices/Defaults | Comments | |
---|---|---|---|
bypass_validation boolean |
|
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters | |
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 | |
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. | |
auth-pwd string |
no description | ||
events list / elements=string |
|
no description | |
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. | |
priv-pwd string |
no description | ||
queries string |
|
Enable/disable queries for this user. disable - Disable setting. enable - Enable setting. | |
query-port integer |
Default: 161 |
SNMPv3 query port. | |
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). | |
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 |
Default: 300 |
the maximum time in seconds to wait for other user to release the workspace lock |
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
- hosts: fortimanager-inventory
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
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
state: <value in [present, absent]>
system_snmp_user:
auth-proto: <value in [md5, sha]>
auth-pwd: <value of string>
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: <value of string>
notify-hosts: <value of string>
notify-hosts6: <value of string>
priv-proto: <value in [aes, des]>
priv-pwd: <value of string>
queries: <value in [disable, enable]>
query-port: <value of integer>
security-level: <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 | Returned | Description |
---|---|---|
request_url string |
always |
The full url requested
Sample: /sys/login/user |
response_code integer |
always |
The status of api request
|
response_message string |
always |
The descriptive message of the api response
Sample: OK. |
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_system_snmp_user_module.html