meraki_snmp – Manage organizations in the Meraki cloud
meraki_snmp – Manage organizations in the Meraki cloud
New in version 2.6.
Synopsis
- Allows for management of SNMP settings for Meraki.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
auth_key - |
Authentication key provided by the dashboard. Required if environmental variable MERAKI_KEY is not set. | |
host string |
Default: "api.meraki.com" |
Hostname for Meraki dashboard Only useful for internal Meraki developers |
org_id - |
ID of organization. | |
org_name - |
Name of organization.
| |
output_level - |
|
Set amount of debug output during module execution |
peer_ips - |
Semi-colon delimited IP addresses which can perform SNMP queries. | |
state - |
|
Specifies whether SNMP information should be queried or modified. |
timeout integer |
Default: 30 |
Time to timeout for HTTP requests. |
use_https boolean |
|
If Only useful for internal Meraki developers |
use_proxy boolean |
|
If |
v2c_enabled boolean |
|
Specifies whether SNMPv2c is enabled. |
v3_auth_mode - |
|
Sets authentication mode for SNMPv3. |
v3_auth_pass - |
Authentication password for SNMPv3. Must be at least 8 characters long. | |
v3_enabled boolean |
|
Specifies whether SNMPv3 is enabled. |
v3_priv_mode - |
|
Specifies privacy mode for SNMPv3. |
v3_priv_pass - |
Privacy password for SNMPv3. Must be at least 8 characters long. | |
validate_certs boolean |
|
Whether to validate HTTP certificates. |
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
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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
data complex |
always |
Information about SNMP settings.
| |
hostname string |
success |
Hostname of SNMP server.
Sample: n1.meraki.com | |
peerIps string |
success |
Semi-colon delimited list of IPs which can poll SNMP information.
Sample: 192.0.1.1 | |
port string |
success |
Port number of SNMP.
Sample: 16100 | |
v2cEnabled boolean |
success |
Shows enabled state of SNMPv2c
Sample: True | |
v2CommunityString string |
When SNMPv2c is enabled. |
Automatically generated community string for SNMPv2c.
Sample: o/8zd-JaSb | |
v3AuthMode string |
success |
The SNMP version 3 authentication mode either MD5 or SHA.
Sample: SHA | |
v3Enabled boolean |
success |
Shows enabled state of SNMPv3
Sample: True | |
v3PrivMode string |
success |
The SNMP version 3 privacy mode DES or AES128.
Sample: AES128 | |
v3User string |
When SNMPv3c is enabled. |
Automatically generated username for SNMPv3.
Sample: o/8zd-JaSb |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Kevin Breit (@kbreit)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/meraki_snmp_module.html