fmgr_devprof_system_snmp_user – SNMP user configuration.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v6.0.0.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- adom - The parameter in requested url type: str required: true
- devprof - The parameter in requested url type: str required: true
- devprof_system_snmp_user - SNMP user configuration. type: dict
- auth-proto - Authentication protocol. type: str choices: [md5, sha]
- auth-pwd - No description for the parameter type: str
- events - No description for the parameter type: array choices: [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 - Enable/disable direct management of HA cluster members. type: str choices: [disable, enable]
- name - SNMP user name. type: str
- notify-hosts - No description for the parameter type: str
- notify-hosts6 - IPv6 SNMP managers to send notifications (traps) to. type: str
- priv-proto - Privacy (encryption) protocol. type: str choices: [aes, des, aes256, aes256cisco]
- priv-pwd - No description for the parameter type: str
- queries - Enable/disable SNMP queries for this user. type: str choices: [disable, enable]
- query-port - SNMPv3 query port (default = 161). type: int
- security-level - Security level for message authentication and encryption. type: str choices: [no-auth-no-priv, auth-no-priv, auth-priv]
- source-ip - Source IP for SNMP trap. type: str
- source-ipv6 - Source IPv6 for SNMP trap. type: str
- status - Enable/disable this SNMP user. type: str choices: [disable, enable]
- trap-lport - SNMPv3 local trap port (default = 162). type: int
- trap-rport - SNMPv3 trap remote port (default = 162). type: int
- trap-status - Enable/disable traps for this SNMP user. type: str choices: [disable, enable]
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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- request_url - The full url requested returned: always type: str sample: /sys/login/user
- response_code - The status of api request returned: always type: int sample: 0
- response_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict