fortinet.fortimanager.fmgr_system_snmp_community – SNMP community configuration.

Note

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

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

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

New in version 2.10: of fortinet.fortimanager

Synopsis
Parameters
Notes
Examples
Return Values

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
bypass_validation boolean			no ← yes	only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
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			present absent	the directive to create, update or delete an object
system_snmp_community dictionary				the top level parameters set
	events list / elements=string		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	no description
	hosts list / elements=string			no description
		id integer	Default: 0	Host entry ID.
		interface string		Allow interface name.
		ip string	Default: "0.0.0.0 0.0.0.0"	Allow host IP address.
	hosts6 list / elements=string			no description
		id integer	Default: 0	Host entry ID.
		interface string		Allow interface name.
		ip string	Default: "::/0"	Allow host IP address.
	id integer		Default: 0	Community ID.
	name string			Community name.
	query_v1_port integer		Default: 161	SNMP v1 query port.
	query_v1_status string		disable enable ←	Enable/disable SNMP v1 query. disable - Disable setting. enable - Enable setting.
	query_v2c_port integer		Default: 161	SNMP v2c query port.
	query_v2c_status string		disable enable ←	Enable/disable SNMP v2c query. disable - Disable setting. enable - Enable setting.
	status string		disable enable ←	Enable/disable community. disable - Disable setting. enable - Enable setting.
	trap_v1_rport integer		Default: 162	SNMP v1 trap remote port.
	trap_v1_status string		disable enable ←	Enable/disable SNMP v1 trap. disable - Disable setting. enable - Enable setting.
	trap_v2c_rport integer		Default: 162	SNMP v2c trap remote port.
	trap_v2c_status string		disable enable ←	Enable/disable SNMP v2c trap. disable - Disable setting. enable - Enable setting.
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: SNMP community configuration.
     fmgr_system_snmp_community:
        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, ...]
        state: <value in [present, absent]>
        system_snmp_community:
           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
           hosts:
             -
                 id: <value of integer>
                 interface: <value of string>
                 ip: <value of string>
           hosts6:
             -
                 id: <value of integer>
                 interface: <value of string>
                 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_rport: <value of integer>
           trap_v1_status: <value in [disable, enable]>
           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/2.11/collections/fortinet/fortimanager/fmgr_system_snmp_community_module.html