New in version 2.6.
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. aliases: 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 int | Default: 30 | Time to timeout for HTTP requests. |
use_https bool |
| If no , it will use HTTP. Otherwise it will use HTTPS.Only useful for internal Meraki developers |
use_proxy bool |
| If no , it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
v2c_enabled bool |
| 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 bool |
| 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 bool |
| Whether to validate HTTP certificates. |
Note
- 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
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. | |
peerIps string | success | Semi-colon delimited list of IPs which can poll SNMP information. Sample: 192.0.1.1 | |
v3AuthMode string | success | The SNMP version 3 authentication mode either MD5 or SHA. Sample: SHA | |
v3User string | When SNMPv3c is enabled. | Automatically generated username for SNMPv3. Sample: o/8zd-JaSb | |
v3Enabled bool | success | Shows enabled state of SNMPv3 Sample: True | |
hostname string | success | Hostname of SNMP server. Sample: n1.meraki.com | |
v3PrivMode string | success | The SNMP version 3 privacy mode DES or AES128. Sample: AES128 | |
v2CommunityString string | When SNMPv2c is enabled. | Automatically generated community string for SNMPv2c. Sample: o/8zd-JaSb | |
v2cEnabled bool | success | Shows enabled state of SNMPv2c Sample: True | |
port string | success | Port number of SNMP. Sample: 16100 |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/meraki_snmp_module.html