Get SNMP Configuration by ID
Use this API to retrieve information about an SNMP configuration.
URI
https://[host]/api/juniper/servicenow/global-setting-management/snmp-configuration -management/snmpConfiguration/{id} (HTTP method = GET)
URI Parameters
Parameter | Type | Required | Description |
---|---|---|---|
id | Integer | Yes | ID of the SNMP configuration to be retrieved |
Consumes
None
Produces
application/vnd.juniper.servicenow.global-setting-management.snmp-configuration -management.snmpConfiguration+xml;version=1
application/vnd.juniper.servicenow.global-setting-management.snmp-configuration -management.snmpConfiguration+json;version=1
Response Elements
Element | Type | Description |
---|---|---|
uri | String | URI of the SNMP configuration |
href | String | Link to the SNMP configuration |
configurationName | String | Name of the SNMP configuration |
server | String | IP address in the IPv4 or IPv6 format or hostname of the SNMP server |
udpPort | Integer | Port for SNMP communication |
communityString | String | SNMP community string |
protocolVersion | String | Version of SNMP protocol used Possible values—v1, v2c |
Sample Output
Sample XML Output
<snmpConfigurations uri="/api/juniper/servicenow/global-setting-management/snmp-configuration- management/snmpConfiguration" size="1"> <snmpConfiguration href= "/api/juniper/servicenow/global-setting-management/snmp-configuration- management/snmpConfiguration/98304" uri="/api/juniper/servicenow/global-setting-management/snmp-configuration- management/snmpConfiguration/98304" key="98304"> <configurationName>testEdit</configurationName> <server>test</server> <udpPort>161</udpPort> <communityString>testingRestF</communityString> <protocolVersion>v1</protocolVersion> </snmpConfiguration> </snmpConfigurations>
Sample JSON Output
{ "snmpConfigurations": { "@uri": "/api/juniper/servicenow/global-setting-management/snmp-configuration- management/snmpConfiguration", "@size": "1", "snmpConfiguration": { "@href": "/api/juniper/servicenow/global-setting-management/snmp-configuration- management/snmpConfiguration/98304", "@uri": "/api/juniper/servicenow/global-setting-management/snmp-configuration- management/snmpConfiguration/98304", "@key": "98304", "configurationName": "testEdit", "server": "test", "udpPort": "161", "communityString": "testingRestF", "protocolVersion": "v1" } } }