fortinet.fortimanager.fmgr_devprof_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_devprof_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 | |
|---|---|---|---|
| adom string / required | the parameter (adom) in requested url | ||
| bypass_validation boolean |
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters | |
| devprof string / required | the parameter (devprof) in requested url | ||
| devprof_system_snmp_user dictionary | the top level parameters set | ||
| auth-proto string |
| Authentication protocol. | |
| auth-pwd string | no description | ||
| events list / elements=string |
| no description | |
| ha-direct string |
| Enable/disable direct management of HA cluster members. | |
| name string | SNMP user name. | ||
| notify-hosts string | no description | ||
| notify-hosts6 string | IPv6 SNMP managers to send notifications (traps) to. | ||
| priv-proto string |
| Privacy (encryption) protocol. | |
| priv-pwd string | no description | ||
| queries string |
| Enable/disable SNMP queries for this user. | |
| query-port integer | SNMPv3 query port (default = 161). | ||
| security-level string |
| Security level for message authentication and encryption. | |
| source-ip string | Source IP for SNMP trap. | ||
| source-ipv6 string | Source IPv6 for SNMP trap. | ||
| status string |
| Enable/disable this SNMP user. | |
| trap-lport integer | SNMPv3 local trap port (default = 162). | ||
| trap-rport integer | SNMPv3 trap remote port (default = 162). | ||
| trap-status string |
| Enable/disable traps for this SNMP user. | |
| 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 | |
| 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_devprof_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, ...]
adom: <your own value>
devprof: <your own value>
state: <value in [present, absent]>
devprof_system_snmp_user:
auth-proto: <value in [md5, sha]>
auth-pwd: <value of string>
events:
- cpu-high
- mem-low
- log-full
- intf-ip
- vpn-tun-up
- vpn-tun-down
- ha-switch
- fm-conf-change
- ips-signature
- ips-anomaly
- temperature-high
- voltage-alert
- av-virus
- av-oversize
- av-pattern
- av-fragmented
- ha-hb-failure
- fan-failure
- ha-member-up
- ha-member-down
- ent-conf-change
- av-conserve
- av-bypass
- av-oversize-passed
- av-oversize-blocked
- ips-pkg-update
- fm-if-change
- power-supply-failure
- amc-bypass
- faz-disconnect
- bgp-established
- bgp-backward-transition
- wc-ap-up
- wc-ap-down
- fswctl-session-up
- fswctl-session-down
- ips-fail-open
- load-balance-real-server-down
- device-new
- enter-intf-bypass
- exit-intf-bypass
- per-cpu-high
- power-blade-down
- confsync_failure
ha-direct: <value in [disable, enable]>
name: <value of string>
notify-hosts: <value of string>
notify-hosts6: <value of string>
priv-proto: <value in [aes, des, aes256, ...]>
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]>
source-ip: <value of string>
source-ipv6: <value of string>
status: <value in [disable, enable]>
trap-lport: <value of integer>
trap-rport: <value of integer>
trap-status: <value in [disable, enable]>
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_devprof_system_snmp_user_module.html