meraki_snmp – Manage organizations in the Meraki cloud¶
New in version 2.6.
Parameters¶
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
access
string
added in 2.9 |
|
Type of SNMP access.
|
|
auth_key
string
/ required
|
Authentication key provided by the dashboard. Required if environmental variable
MERAKI_KEY is not set. |
||
community_string
string
added in 2.9 |
SNMP community string.
Only relevant if
access is set to community . |
||
host
string
|
Default: "api.meraki.com"
|
Hostname for Meraki dashboard.
Can be used to access regional Meraki environments, such as China.
|
|
internal_error_retry_time
integer
|
Default: 60
|
Number of seconds to retry if server returns an internal server error.
|
|
net_id
string
added in 2.9 |
ID of network.
|
||
net_name
string
added in 2.9 |
Name of network.
|
||
org_id
string
|
ID of organization.
|
||
org_name
string
|
Name of organization.
aliases: organization |
||
output_format
string
|
|
Instructs module whether response keys should be snake case (ex.
net_id ) or camel case (ex. netId ). |
|
output_level
string
|
|
Set amount of debug output during module execution.
|
|
peer_ips
-
|
Semi-colon delimited IP addresses which can perform SNMP queries.
|
||
rate_limit_retry_time
integer
|
Default: 165
|
Number of seconds to retry if rate limiter is triggered.
|
|
state
-
|
|
Specifies whether SNMP information should be queried or modified.
|
|
timeout
integer
|
Default: 30
|
Time to timeout for HTTP requests.
|
|
use_https
boolean
|
|
If
no , it will use HTTP. Otherwise it will use HTTPS.Only useful for internal Meraki developers.
|
|
use_proxy
boolean
|
|
If
no , it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
|
users
list
added in 2.9 |
Information about users with access to SNMP.
Only relevant if
access is set to users . |
||
passphrase
string
added in 2.9 |
Passphrase for user SNMP access.
|
||
username
string
added in 2.9 |
Username of user with access.
|
||
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.
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.
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 | Returned | Description | ||
---|---|---|---|---|
data
complex
|
always |
Information about SNMP settings.
|
||
access
string
|
success, when network specified |
Type of SNMP access.
|
||
community_string
string
|
success, when network specified |
SNMP community string. Only relevant if
access is set to community . |
||
hostname
string
|
success and no network specified. |
Hostname of SNMP server.
Sample:
n1.meraki.com
|
||
peerIps
string
|
success and no network specified. |
Semi-colon delimited list of IPs which can poll SNMP information.
Sample:
192.0.1.1
|
||
port
string
|
success and no network specified. |
Port number of SNMP.
Sample:
16100
|
||
users
complex
|
Information about users with access to SNMP. Only relevant if
access is set to users . |
|||
passphrase
string
|
success, when network specified |
Passphrase for user SNMP access.
|
||
username
string
|
success, when network specified |
Username of user with access.
|
||
v2_community_string
string
|
When SNMPv2c is enabled and no network specified. |
Automatically generated community string for SNMPv2c.
Sample:
o/8zd-JaSb
|
||
v2c_enabled
boolean
|
success and no network specified. |
Shows enabled state of SNMPv2c
Sample:
True
|
||
v3_auth_mode
string
|
success and no network specified. |
The SNMP version 3 authentication mode either MD5 or SHA.
Sample:
SHA
|
||
v3_enabled
boolean
|
success and no network specified. |
Shows enabled state of SNMPv3
Sample:
True
|
||
v3_priv_mode
string
|
success and no network specified. |
The SNMP version 3 privacy mode DES or AES128.
Sample:
AES128
|
||
v3_user
string
|
When SNMPv3c is enabled and no network specified. |
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)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.