fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_system_snmp_user SNMP user configuration. | "added in version" 2.0.0 of fortinet.fortimanager" Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communityfortinet.fortimanager.fmgr_system_snmp_user (2.4.0) — module
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections: - name: fortinet.fortimanager version: 2.4.0
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- name: Example playbook hosts: fortimanagers connection: httpapi vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: SNMP user configuration. fortinet.fortimanager.fmgr_system_snmp_user: bypass_validation: false state: present system_snmp_user: auth-proto: md5 # <value in [md5, sha]> auth-pwd: fortinet 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: ansible-test-snmpuser queries: disable security-level: no-auth-no-priv # <value in [no-auth-no-priv, auth-no-priv, auth-priv]>
- name: Gathering fortimanager facts hosts: fortimanagers gather_facts: false connection: httpapi vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: Retrieve all the SNMP users fortinet.fortimanager.fmgr_fact: facts: selector: "system_snmp_user" params: user: "your_value"
state: choices: - present - absent description: The directive to create, update or delete an object. required: true type: str rc_failed: description: The rc codes list with which the conditions to fail will be overriden. elements: int type: list enable_log: default: false description: Enable/Disable logging for task. type: bool access_token: description: The token to access FortiManager without using username and password. type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. type: str system_snmp_user: description: The top level parameters set. required: false suboptions: auth-proto: choices: - md5 - sha description: - Deprecated, please rename it to auth_proto. - Authentication protocol. - md5 - HMAC-MD5-96 authentication protocol. - sha - HMAC-SHA-96 authentication protocol. type: str auth-pwd: description: (list) Deprecated, please rename it to auth_pwd. Password for authentication protocol. type: raw events: 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 description: - SNMP notifications - disk_low - Disk usage too high. - ha_switch - HA switch. - intf_ip_chg - Interface IP address changed. - sys_reboot - System reboot. - cpu_high - CPU usage too high. - mem_low - Available memory is low. - log-alert - Log base alert message. - log-rate - High incoming log rate detected. - log-data-rate - High incoming log data rate detected. - lic-gbday - High licensed log GB/day detected. - lic-dev-quota - High licensed device quota detected. - cpu-high-exclude-nice - CPU usage exclude NICE threshold. elements: str type: list name: description: SNMP user name. required: true type: str notify-hosts: description: Deprecated, please rename it to notify_hosts. Hosts to send notifications type: str notify-hosts6: description: Deprecated, please rename it to notify_hosts6. IPv6 hosts to send notifications type: str priv-proto: choices: - aes - des description: - Deprecated, please rename it to priv_proto. - Privacy - aes - CFB128-AES-128 symmetric encryption protocol. - des - CBC-DES symmetric encryption protocol. type: str priv-pwd: description: (list) Deprecated, please rename it to priv_pwd. Password for privacy type: raw queries: choices: - disable - enable description: - Enable/disable queries for this user. - disable - Disable setting. - enable - Enable setting. type: str query-port: description: Deprecated, please rename it to query_port. SNMPv3 query port. type: int security-level: choices: - no-auth-no-priv - auth-no-priv - auth-priv description: - Deprecated, please rename it to security_level. - Security level for message authentication and encryption. - no-auth-no-priv - Message with no authentication and no privacy - auth-no-priv - Message with authentication but no privacy - auth-priv - Message with authentication and privacy type: str type: dict bypass_validation: default: false description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool workspace_locking_adom: description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. type: int
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 FortiManager version. returned: complex type: list