dux_fortinet / dux_fortinet.fortianalyzer_dev / 1.4.0 / module / faz_cli_system_snmp_community SNMP community configuration. | "added in version" 1.0.0 of dux_fortinet.fortianalyzer_dev" Authors: Xinwei Du (@dux-fortinet), Link Zheng (@chillancezen), Jie Xue (@JieX19), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communitydux_fortinet.fortianalyzer_dev.faz_cli_system_snmp_community (1.4.0) — module
Install with ansible-galaxy collection install dux_fortinet.fortianalyzer_dev:==1.4.0
collections: - name: dux_fortinet.fortianalyzer_dev 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 community configuration. fortinet.fortianalyzer.faz_cli_system_snmp_community: cli_system_snmp_community: id: 1 name: foosnmpcommunity status: disable state: present 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 forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. required: false type: str cli_system_snmp_community: description: The top level parameters set. required: false suboptions: 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 hosts: description: no description elements: dict suboptions: id: description: Host entry ID. type: int interface: description: Allow interface name. type: str ip: description: Allow host IP address. type: str type: list hosts6: description: no description elements: dict suboptions: id: description: Host entry ID. type: int interface: description: Allow interface name. type: str ip: description: Allow host IP address. type: str type: list id: description: Community ID. type: int name: description: Community name. type: str query_v1_port: description: SNMP v1 query port. type: int query_v1_status: choices: - disable - enable description: - Enable/disable SNMP v1 query. - disable - Disable setting. - enable - Enable setting. type: str query_v2c_port: description: SNMP v2c query port. type: int query_v2c_status: choices: - disable - enable description: - Enable/disable SNMP v2c query. - disable - Disable setting. - enable - Enable setting. type: str status: choices: - disable - enable description: - Enable/disable community. - disable - Disable setting. - enable - Enable setting. type: str trap_v1_rport: description: SNMP v1 trap remote port. type: int trap_v1_status: choices: - disable - enable description: - Enable/disable SNMP v1 trap. - disable - Disable setting. - enable - Enable setting. type: str trap_v2c_rport: description: SNMP v2c trap remote port. type: int trap_v2c_status: choices: - disable - enable description: - Enable/disable SNMP v2c trap. - disable - Disable setting. - enable - Enable setting. type: str type: dict
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