cisco.meraki.meraki_snmp – Manage organizations in the Meraki cloud

Note

This plugin is part of the cisco.meraki collection (version 2.5.0).

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.

Synopsis

  • Allows for management of SNMP settings for Meraki.

Parameters

Parameter

Comments

access

string

Type of SNMP access.

Choices:

  • community

  • none

  • users

auth_key

string / required

Authentication key provided by the dashboard. Required if environmental variable MERAKI_KEY is not set.

community_string

string

SNMP community string.

Only relevant if access is set to community.

host

string

Hostname for Meraki dashboard.

Can be used to access regional Meraki environments, such as China.

Default: “api.meraki.com”

internal_error_retry_time

integer

Number of seconds to retry if server returns an internal server error.

Default: 60

net_id

string

ID of network.

net_name

string

Name of network.

org_id

string

ID of organization.

org_name

aliases: organization

string

Name of organization.

output_format

string

Instructs module whether response keys should be snake case (ex. net_id) or camel case (ex. netId).

Choices:

  • snakecase ← (default)

  • camelcase

output_level

string

Set amount of debug output during module execution.

Choices:

  • debug

  • normal ← (default)

peer_ips

list / elements=string

List of IP addresses which can perform SNMP queries.

rate_limit_retry_time

integer

Number of seconds to retry if rate limiter is triggered.

Default: 165

state

string

Specifies whether SNMP information should be queried or modified.

Choices:

  • query

  • present ← (default)

timeout

integer

Time to timeout for HTTP requests.

Default: 30

use_https

boolean

If no, it will use HTTP. Otherwise it will use HTTPS.

Only useful for internal Meraki developers.

Choices:

  • no

  • yes ← (default)

use_proxy

boolean

If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.

Choices:

  • no ← (default)

  • yes

users

list / elements=dictionary

Information about users with access to SNMP.

Only relevant if access is set to users.

passphrase

string

Passphrase for user SNMP access.

username

string

Username of user with access.

v2c_enabled

boolean

Specifies whether SNMPv2c is enabled.

Choices:

  • no

  • yes

v3_auth_mode

string

Sets authentication mode for SNMPv3.

Choices:

  • MD5

  • SHA

v3_auth_pass

string

Authentication password for SNMPv3.

Must be at least 8 characters long.

v3_enabled

boolean

Specifies whether SNMPv3 is enabled.

Choices:

  • no

  • yes

v3_priv_mode

string

Specifies privacy mode for SNMPv3.

Choices:

  • DES

  • AES128

v3_priv_pass

string

Privacy password for SNMPv3.

Must be at least 8 characters long.

validate_certs

boolean

Whether to validate HTTP certificates.

Choices:

  • no

  • yes ← (default)

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 to camelcase.

  • 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

data

complex

Information about SNMP settings.

Returned: always

access

string

Type of SNMP access.

Returned: success, when network specified

community_string

string

SNMP community string. Only relevant if access is set to community.

Returned: success, when network specified

hostname

string

Hostname of SNMP server.

Returned: success and no network specified.

Sample: “n1.meraki.com”

peer_ips

string

Semi-colon delimited list of IPs which can poll SNMP information.

Returned: success and no network specified.

Sample: “192.0.1.1”

port

string

Port number of SNMP.

Returned: success and no network specified.

Sample: 16100

users

complex

Information about users with access to SNMP. Only relevant if access is set to users.

Returned: success

passphrase

string

Passphrase for user SNMP access.

Returned: success, when network specified

username

string

Username of user with access.

Returned: success, when network specified

v2_community_string

string

Automatically generated community string for SNMPv2c.

Returned: When SNMPv2c is enabled and no network specified.

Sample: “o/8zd-JaSb”

v2c_enabled

boolean

Shows enabled state of SNMPv2c

Returned: success and no network specified.

Sample: true

v3_auth_mode

string

The SNMP version 3 authentication mode either MD5 or SHA.

Returned: success and no network specified.

Sample: “SHA”

v3_enabled

boolean

Shows enabled state of SNMPv3

Returned: success and no network specified.

Sample: true

v3_priv_mode

string

The SNMP version 3 privacy mode DES or AES128.

Returned: success and no network specified.

Sample: “AES128”

v3_user

string

Automatically generated username for SNMPv3.

Returned: When SNMPv3c is enabled and no network specified.

Sample: “o/8zd-JaSb”

Authors

  • Kevin Breit (@kbreit)