fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_switchcontroller_managedswitch_snmpcommunity Configuration method to edit Simple Network Management Protocol | "added in version" 2.1.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_switchcontroller_managedswitch_snmpcommunity (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 (generated based on argument schema) hosts: fortimanagers connection: httpapi vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: Configuration method to edit Simple Network Management Protocol fortinet.fortimanager.fmgr_switchcontroller_managedswitch_snmpcommunity: # 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, ...] adom: <your own value> managed_switch: <your own value> state: present # <value in [present, absent]> switchcontroller_managedswitch_snmpcommunity: events: - cpu-high - mem-low - log-full - intf-ip - ent-conf-change hosts: - id: <integer> ip: <string> id: <integer> name: <string> query_v1_port: <integer> query_v1_status: <value in [disable, enable]> query_v2c_port: <integer> query_v2c_status: <value in [disable, enable]> status: <value in [disable, enable]> trap_v1_lport: <integer> trap_v1_rport: <integer> trap_v1_status: <value in [disable, enable]> trap_v2c_lport: <integer> trap_v2c_rport: <integer> trap_v2c_status: <value in [disable, enable]>
adom: description: The parameter (adom) in requested url. required: true type: str 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 managed-switch: description: Deprecated, please use "managed_switch" type: str managed_switch: description: The parameter (managed-switch) in requested url. type: str proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. type: str 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 switchcontroller_managedswitch_snmpcommunity: description: The top level parameters set. required: false suboptions: events: choices: - cpu-high - mem-low - log-full - intf-ip - ent-conf-change description: No description. elements: str type: list hosts: description: No description. elements: dict suboptions: id: description: Host entry ID. type: int ip: description: IPv4 address of the SNMP manager type: str type: list id: description: SNMP community ID. required: true type: int name: description: SNMP community name. type: str query-v1-port: description: Deprecated, please rename it to query_v1_port. SNMP v1 query port type: int query-v1-status: choices: - disable - enable description: Deprecated, please rename it to query_v1_status. Enable/disable SNMP v1 queries. type: str query-v2c-port: description: Deprecated, please rename it to query_v2c_port. SNMP v2c query port type: int query-v2c-status: choices: - disable - enable description: Deprecated, please rename it to query_v2c_status. Enable/disable SNMP v2c queries. type: str status: choices: - disable - enable description: Enable/disable this SNMP community. type: str trap-v1-lport: description: Deprecated, please rename it to trap_v1_lport. SNMP v2c trap local port type: int trap-v1-rport: description: Deprecated, please rename it to trap_v1_rport. SNMP v2c trap remote port type: int trap-v1-status: choices: - disable - enable description: Deprecated, please rename it to trap_v1_status. Enable/disable SNMP v1 traps. type: str trap-v2c-lport: description: Deprecated, please rename it to trap_v2c_lport. SNMP v2c trap local port type: int trap-v2c-rport: description: Deprecated, please rename it to trap_v2c_rport. SNMP v2c trap remote port type: int trap-v2c-status: choices: - disable - enable description: Deprecated, please rename it to trap_v2c_status. Enable/disable SNMP v2c traps. 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 FortiManager version. returned: complex type: list