fortinet / fortinet.fortianalyzer / 1.4.0 / module / faz_cli_system_snmp_user SNMP user configuration. | "added in version" 1.0.0 of fortinet.fortianalyzer" Authors: Xinwei Du (@dux-fortinet), Link Zheng (@chillancezen), Jie Xue (@JieX19), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communityfortinet.fortianalyzer.faz_cli_system_snmp_user (1.4.0) — module
Install with ansible-galaxy collection install fortinet.fortianalyzer:==1.4.0
collections: - name: fortinet.fortianalyzer version: 1.4.0
This module is able to configure a FortiAnalyzer device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- name: Example playbook connection: httpapi hosts: fortianalyzers tasks: - name: SNMP user configuration. fortinet.fortianalyzer.faz_cli_system_snmp_user: cli_system_snmp_user: # auth_proto: <value in [md5, sha]> # auth_pwd: <value of string> events: - disk_low - 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: foosnmpuser # notify_hosts: <value of string> # notify_hosts6: <value of string> priv_proto: aes priv_pwd: foopass queries: disable # query_port: <value of integer> # security_level: <value in [no-auth-no-priv, auth-no-priv, auth-priv]> state: present vars: ansible_httpapi_port: 443 ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false
- name: Example playbook connection: httpapi hosts: fortianalyzers tasks: - name: Create snap user. fortinet.fortianalyzer.faz_cli_system_snmp_user: state: present cli_system_snmp_user: name: foosnmp auth_proto: md5 auth_pwd: foopwd - name: Alert destination. fortinet.fortianalyzer.faz_cli_system_alertevent_alertdestination: alert_event: fooevent cli_system_alertevent_alertdestination: type: snmp snmp_name: foosnmp state: present when: false vars: ansible_httpapi_port: 443 ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false
state: choices: - present - absent description: The directive to create, update or delete an object required: true type: str log_path: default: /tmp/fortianalyzer.ansible.log description: - The path to save log. Used if enable_log is true. - Please use absolute path instead of relative path. - If the log_path setting is incorrect, the log will be saved in /tmp/fortianalyzer.ansible.log required: false type: str rc_failed: description: the rc codes list with which the conditions to fail will be overriden elements: int required: false type: list enable_log: default: false description: Enable/Disable logging for task required: false type: bool access_token: description: The token to access FortiManager without using username and password. required: false type: str rc_succeeded: description: the rc codes list with which the conditions to succeed will be overriden elements: int required: false type: list proposed_method: choices: - set - update - add description: The overridden method for the underlying Json RPC request required: false type: str bypass_validation: default: false description: only set to True when module schema diffs with FortiAnalyzer API structure, module continues to execute without validating parameters required: false type: bool cli_system_snmp_user: description: The top level parameters set. required: false suboptions: auth-proto: choices: - md5 - sha description: - Authentication protocol. - md5 - HMAC-MD5-96 authentication protocol. - sha - HMAC-SHA-96 authentication protocol. type: str auth-pwd: description: no description type: str events: choices: - disk_low - 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 description: no description elements: str type: list name: description: SNMP user name. type: str notify-hosts: description: Hosts to send notifications (traps) to. type: str notify-hosts6: description: IPv6 hosts to send notifications (traps) to. type: str priv-proto: choices: - aes - des description: - Privacy (encryption) protocol. - aes - CFB128-AES-128 symmetric encryption protocol. - des - CBC-DES symmetric encryption protocol. type: str priv-pwd: description: no description type: str queries: choices: - disable - enable description: - Enable/disable queries for this user. - disable - Disable setting. - enable - Enable setting. type: str query-port: description: SNMPv3 query port. type: int security-level: choices: - no-auth-no-priv - auth-no-priv - auth-priv description: - 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). type: str type: dict forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. required: false type: str
meta: contains: request_url: description: The full url requested returned: always sample: /sys/login/user type: str response_code: description: The status of api request returned: always sample: 0 type: int response_data: description: The api response returned: always type: list response_message: description: The descriptive message of the api response returned: always sample: OK. type: str system_information: description: The information of the target system. returned: always type: dict description: The result of the request. returned: always type: dict rc: description: The status the request. returned: always sample: 0 type: int version_check_warning: description: Warning if the parameters used in the playbook are not supported by the current fortianalyzer version. returned: complex type: list