fmgr_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
- system_snmp_user - SNMP user configuration. type: dict
- auth-proto - Authentication protocol. type: str choices: [md5, sha] default: sha
- auth-pwd - No description for the parameter type: str
- events - No description for the parameter type: array 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 - SNMP user name. type: str
- notify-hosts - Hosts to send notifications (traps) to. type: str
- notify-hosts6 - IPv6 hosts to send notifications (traps) to. type: str
- priv-proto - Privacy (encryption) protocol. type: str choices: [aes, des] default: aes
- priv-pwd - No description for the parameter type: str
- queries - Enable/disable queries for this user. type: str choices: [disable, enable] default: enable
- query-port - SNMPv3 query port. type: int default: 161
- security-level - Security level for message authentication and encryption. type: str choices: [no-auth-no-priv, auth-no-priv, auth-priv] default: no-auth-no-priv
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: 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