dux_fortinet / dux_fortinet.fortianalyzer_dev / 1.4.0 / module / faz_cli_system_snmp_sysinfo SNMP 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_sysinfo (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 configuration. fortinet.fortianalyzer.faz_cli_system_snmp_sysinfo: cli_system_snmp_sysinfo: contact_info: self description: Ansible crreated it. # engine_id: <value of string> fortianalyzer_legacy_sysoid: disable # location: <value of string> status: disable # trap_cpu_high_exclude_nice_threshold: <value of integer> # trap_high_cpu_threshold: <value of integer> # trap_low_memory_threshold: <value of integer> vars: ansible_httpapi_port: 443 ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false
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_sysinfo: description: The top level parameters set. required: false suboptions: contact_info: description: Contact information. type: str description: description: System description. type: str engine-id: description: Local SNMP engineID string (maximum 24 characters). type: str fortianalyzer-legacy-sysoid: choices: - disable - enable description: - Enable legacy FortiAnalyzer sysObjectOID. - disable - Disable setting. - enable - Enable setting. type: str location: description: System location. type: str status: choices: - disable - enable description: - Enable/disable SNMP. - disable - Disable setting. - enable - Enable setting. type: str trap-cpu-high-exclude-nice-threshold: description: SNMP trap for CPU usage threshold (exclude NICE processes). type: int trap-high-cpu-threshold: description: SNMP trap for CPU usage threshold. type: int trap-low-memory-threshold: description: SNMP trap for memory usage threshold. type: int 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