cisco.meraki.meraki_snmp module – Manage organizations in the Meraki cloud
Note
This module is part of the cisco.meraki collection (version 2.18.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 cisco.meraki
.
To use it in a playbook, specify: cisco.meraki.meraki_snmp
.
DEPRECATED
- Removed in:
version 3.0.0
- Why:
Updated modules released with increased functionality
- Alternative:
cisco.meraki.networks_snmp
Synopsis
Allows for management of SNMP settings for Meraki.
Parameters
Parameter |
Comments |
---|---|
Type of SNMP access. Choices:
|
|
Authentication key provided by the dashboard. Required if environmental variable |
|
SNMP community string. Only relevant if |
|
Hostname for Meraki dashboard. Can be used to access regional Meraki environments, such as China. Default: |
|
Number of seconds to retry if server returns an internal server error. Default: |
|
ID of network. |
|
Name of network. |
|
ID of organization. |
|
Name of organization. |
|
Instructs module whether response keys should be snake case (ex. Choices:
|
|
Set amount of debug output during module execution. Choices:
|
|
List of IP addresses which can perform SNMP queries. |
|
Number of seconds to retry if rate limiter is triggered. Default: |
|
Specifies whether SNMP information should be queried or modified. Choices:
|
|
Time to timeout for HTTP requests. Default: |
|
If Only useful for internal Meraki developers. Choices:
|
|
If Choices:
|
|
Information about users with access to SNMP. Only relevant if |
|
Passphrase for user SNMP access. |
|
Username of user with access. |
|
Specifies whether SNMPv2c is enabled. Choices:
|
|
Sets authentication mode for SNMPv3. Choices:
|
|
Authentication password for SNMPv3. Must be at least 8 characters long. |
|
Specifies whether SNMPv3 is enabled. Choices:
|
|
Specifies privacy mode for SNMPv3. Choices:
|
|
Privacy password for SNMPv3. Must be at least 8 characters long. |
|
Whether to validate HTTP certificates. Choices:
|
Notes
Note
More information about the Meraki API can be found at https://dashboard.meraki.com/api_docs.
Some of the options are likely only used for developers within Meraki.
As of Ansible 2.9, Meraki modules output keys as snake case. To use camel case, set the
ANSIBLE_MERAKI_FORMAT
environment variable tocamelcase
.Ansible’s Meraki modules will stop supporting camel case output in Ansible 2.13. Please update your playbooks.
Check Mode downloads the current configuration from the dashboard, then compares changes against this download. Check Mode will report changed if there are differences in the configurations, but does not submit changes to the API for validation of change.
Examples
- name: Query SNMP values
meraki_snmp:
auth_key: abc12345
org_name: YourOrg
state: query
delegate_to: localhost
- name: Enable SNMPv2
meraki_snmp:
auth_key: abc12345
org_name: YourOrg
state: present
v2c_enabled: yes
delegate_to: localhost
- name: Disable SNMPv2
meraki_snmp:
auth_key: abc12345
org_name: YourOrg
state: present
v2c_enabled: no
delegate_to: localhost
- name: Enable SNMPv3
meraki_snmp:
auth_key: abc12345
org_name: YourOrg
state: present
v3_enabled: true
v3_auth_mode: SHA
v3_auth_pass: ansiblepass
v3_priv_mode: AES128
v3_priv_pass: ansiblepass
peer_ips: 192.0.1.1;192.0.1.2
delegate_to: localhost
- name: Set network access type to community string
meraki_snmp:
auth_key: abc1235
org_name: YourOrg
net_name: YourNet
state: present
access: community
community_string: abc123
delegate_to: localhost
- name: Set network access type to username
meraki_snmp:
auth_key: abc1235
org_name: YourOrg
net_name: YourNet
state: present
access: users
users:
- username: ansibleuser
passphrase: ansiblepass
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Information about SNMP settings. Returned: always |
|
Type of SNMP access. Returned: success, when network specified |
|
SNMP community string. Only relevant if Returned: success, when network specified |
|
Hostname of SNMP server. Returned: success and no network specified. Sample: |
|
Semi-colon delimited list of IPs which can poll SNMP information. Returned: success and no network specified. Sample: |
|
Port number of SNMP. Returned: success and no network specified. Sample: |
|
Information about users with access to SNMP. Only relevant if Returned: success |
|
Passphrase for user SNMP access. Returned: success, when network specified |
|
Username of user with access. Returned: success, when network specified |
|
Automatically generated community string for SNMPv2c. Returned: When SNMPv2c is enabled and no network specified. Sample: |
|
Shows enabled state of SNMPv2c Returned: success and no network specified. Sample: |
|
The SNMP version 3 authentication mode either MD5 or SHA. Returned: success and no network specified. Sample: |
|
Shows enabled state of SNMPv3 Returned: success and no network specified. Sample: |
|
The SNMP version 3 privacy mode DES or AES128. Returned: success and no network specified. Sample: |
|
Automatically generated username for SNMPv3. Returned: When SNMPv3c is enabled and no network specified. Sample: |
Status
This module will be removed in version 3.0.0. [deprecated]
For more information see DEPRECATED.