Get SNMP Configuration (Meraki)
This object returns the current SNMP configuration and community ID.
Input Parameters
Name | Type | Required | Description |
---|---|---|---|
Meraki API Key | String | Yes | The API key that will be used to pull information about the environment. The account used to obtain this key must have as a recommended minimum, full read-only access. |
Organization ID | String | Yes | The unique Organization ID for which to pull the SNMP configuration. |
Output Parameters
Name | Type | Description |
---|---|---|
Is Version 2c enabled | Boolean | A true/false flag as to whether SNMP v2 is enabled. |
Version 2 community string | String | The community id (access key) for SNMP V2 (if enabled). |
Is Version 3 enabled | Boolean | A true/false flag as to whether SNMP v3 is enabled. |
Version 3 authentication mode | String | The version 3 authentication mode (if applicable). |
Version 3 privacy mode | String | The version 3 selected privacy mode (if applicable). |
Peers IP | String | The list of peer IP addresses. |
Hostname | String | The hostname to contact to do SNMP queries. |
Port | Number | The port on which to contact that host name. |
Result | Number | Returns a success value of zero or any value other than zero to indicate failure. |
Result String | String | Object execution error details. |
Example Input Parameters
Name | Type | Required | Example |
---|---|---|---|
Meraki API Key | String | Yes | 1a1a1a1a1a1a1a1a1a1a1a2a2a2a2a2a2a2a3a3a |
Organization ID | String | Yes | L_3421423 |