fortinet.fortimanager.fmgr_switchcontroller_managedswitch_snmpcommunity – Configuration method to edit Simple Network Management Protocol

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_switchcontroller_managedswitch_snmpcommunity.

New in version 2.10: of fortinet.fortimanager

Synopsis

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.

Parameters

Parameter			Choices/Defaults	Comments
adom string / required				the parameter (adom) in requested url
bypass_validation boolean			Choices: no ← yes	only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log boolean			Choices: no ← yes	Enable/Disable logging for task
managed-switch string / required				the parameter (managed-switch) in requested url
proposed_method string			Choices: update set add	The overridden method for the underlying Json RPC request
rc_failed list / elements=string				the rc codes list with which the conditions to fail will be overriden
rc_succeeded list / elements=string				the rc codes list with which the conditions to succeed will be overriden
state string / required			Choices: present absent	the directive to create, update or delete an object
switchcontroller_managedswitch_snmpcommunity dictionary				the top level parameters set
	events list / elements=string		Choices: cpu-high mem-low log-full intf-ip ent-conf-change	no description
	hosts list / elements=string			no description
		id integer		Host entry ID.
		ip string		IPv4 address of the SNMP manager (host).
	id integer			SNMP community ID.
	name string			SNMP community name.
	query-v1-port integer			SNMP v1 query port (default = 161).
	query-v1-status string		Choices: disable enable	Enable/disable SNMP v1 queries.
	query-v2c-port integer			SNMP v2c query port (default = 161).
	query-v2c-status string		Choices: disable enable	Enable/disable SNMP v2c queries.
	status string		Choices: disable enable	Enable/disable this SNMP community.
	trap-v1-lport integer			SNMP v2c trap local port (default = 162).
	trap-v1-rport integer			SNMP v2c trap remote port (default = 162).
	trap-v1-status string		Choices: disable enable	Enable/disable SNMP v1 traps.
	trap-v2c-lport integer			SNMP v2c trap local port (default = 162).
	trap-v2c-rport integer			SNMP v2c trap remote port (default = 162).
	trap-v2c-status string		Choices: disable enable	Enable/disable SNMP v2c traps.
workspace_locking_adom string				the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
workspace_locking_timeout integer			Default: 300	the maximum time in seconds to wait for other user to release the workspace lock

Notes

Note

Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
To create or update an object, use state present directive.
To delete an object, use state absent directive.
Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  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
     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: <value in [present, absent]>
        switchcontroller_managedswitch_snmpcommunity:
           events:
             - cpu-high
             - mem-low
             - log-full
             - intf-ip
             - ent-conf-change
           hosts:
             -
                 id: <value of integer>
                 ip: <value of string>
           id: <value of integer>
           name: <value of string>
           query-v1-port: <value of integer>
           query-v1-status: <value in [disable, enable]>
           query-v2c-port: <value of integer>
           query-v2c-status: <value in [disable, enable]>
           status: <value in [disable, enable]>
           trap-v1-lport: <value of integer>
           trap-v1-rport: <value of integer>
           trap-v1-status: <value in [disable, enable]>
           trap-v2c-lport: <value of integer>
           trap-v2c-rport: <value of integer>
           trap-v2c-status: <value in [disable, enable]>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
request_url string	always	The full url requested Sample: /sys/login/user
response_code integer	always	The status of api request
response_message string	always	The descriptive message of the api response Sample: OK.

Authors

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_switchcontroller_managedswitch_snmpcommunity_module.html

Docs

Docs4dev

Title here