Retrieve Snmp Collectors
Gets a single snmp collector based on the id provided
Id of the request snmp collector
The name of the current snmp integration
snmp-integration
OK Returned configuration of the requested SNMP collector.
{
"dcName": "_core",
"collectorConfiguration": {
"name": "collector-a",
"pollerPrefix": "string",
"groupName": "string",
"oidsThreads": 0,
"tableThreads": 0,
"alwaysPushProperties": false,
"handleCounterWrapAround": false,
"oidAsPropertyInRawValues": false,
"usePollerPrefixInVariable": false,
"pollingGroupsWereSplit": false,
"localCommunicationSettings": {
"hostIpAddress": "localhost",
"communicationPort": 2008,
"communicationInterfaceIpAddress": "string",
"outInterfaceIPAddresses": [
"string"
],
"maxConcurrentSessions": 0,
"acceptCommandsFromIPAddresses": [
"string"
]
}
},
"snmpAgents": [
{
"name": "Agent1",
"agentId": "0.0.0.0:161",
"ipAddress": "0.0.0.0",
"snmpPort": 161,
"transportProtocol": "udp",
"snmpTimeout": 1000,
"snmpNumberOfRetries": 2,
"snmpVersion": "v2c",
"snmpCommunityOrUserV3Name": "public",
"snmpV3AuthenticationProtocol": "sha",
"snmpV3AuthenticationPassword": "changeme",
"snmpV3PrivacyProtocol": "aes",
"snmpV3PrivacyPassword": "aespass",
"maxBulkSize": 50,
"v3ContextName": "string",
"v3ContextEngineId": "string",
"useV3ContextName": false,
"useV3ContextEnginedId": false,
"devType": "Node",
"contactPropertyValue": "string",
"devdescPropertyValue": "string",
"locationPropertyValue": "string",
"modelPropertyValue": "string",
"discoveryStarted": false,
"v1TableRowPolling": false,
"lastSysUpTimeValue": 0,
"lastSysUpTimePollTimestamp": 0,
"shortestPollingPeriod": 0,
"port": "string",
"onFailTryWith": "string",
"doNotUseGetBulkRequests": false,
"refreshPropertiesLastRequestTime": 0,
"doNotUseCapabilityList": [
"CISCO-MEMORY-OLD"
],
"collectorNameList": [
"collector-a",
"collector-b"
],
"pollingPeriod": 300,
"capabilitiesWithPollingPeriod": [
{
"capabilityName": "CISCO-MEMORY-OLD",
"pollingPeriod": "number"
}
],
"discoveryStatus": "string",
"discoveryMessage": [
"string"
]
}
],
"snmpMasks": {
"configVersion": "6.6",
"snmpMasks": [
{
"doNotEdit": true,
"mibFiles": [
"CISCO-RTTMON-W4N-V2-MIB.my"
],
"snmpActionRequest": {
"loadFactor": 5,
"capabilityName": "CISCO-IPSLA-STATSTABLE-NEW",
"defaultPollingPeriod": 0,
"discoveryPasses": [
{
"capabilityConditionGroup": [
{
"invertResult": false,
"name": "SingleOidContainsSnmpCondition",
"matchValue": "\\\\.1\\\\.3\\\\.6\\\\.1\\\\.4\\\\.1\\\\.9\\\\..*",
"oid": ".1.3.6.1.2.1.1.2.0"
}
]
},
{
"capabilityConditionGroup": [
{
"invertResult": false,
"name": "TableColumnExistsSnmpCondition",
"matchValue": "",
"oid": ".1.3.6.1.4.1.9.9.42.1.3.1.1.5"
},
{
"invertResult": false,
"name": "TableColumnExistsSnmpCondition",
"matchValue": "",
"oid": ".1.3.6.1.4.1.9.9.42.1.3.2.1.1"
}
]
}
]
},
"name": "CISCO-IPSLA-STATSTABLE-NEW",
"snmpTables": [
{
"indexEntryMask": "oid._._.100.101.102+",
"nextSnmpReferenceTables": [
{
"indexEntryMask": "oid._._.100",
"usePropertyValueInVariableName": false,
"parentTablecolIdxOidPositions": "1",
"referenceTableOid": ".1.3.6.1.4.1.9.9.42.1.2.1",
"refTableColIdxOid": ".1.100",
"propertyName": "owner",
"propertyValueAppendOid": ".1.2",
"hexValue": false,
"name": "rttMonCtrlAdminTable.2",
"longLifeCaching": false,
"nextSnmpReferenceTableConstraint": true
},
{
"indexEntryMask": "oid._._.100",
"usePropertyValueInVariableName": false,
"parentTablecolIdxOidPositions": "1",
"referenceTableOid": ".1.3.6.1.4.1.9.9.42.1.2.1",
"refTableColIdxOid": ".1.100",
"propertyName": "tag",
"propertyValueAppendOid": ".1.3",
"hexValue": false,
"name": "rttMonCtrlAdminTable.3",
"longLifeCaching": false,
"nextSnmpReferenceTableConstraint": true
},
{
"indexEntryMask": "oid._._.100",
"usePropertyValueInVariableName": false,
"parentTablecolIdxOidPositions": "1",
"referenceTableOid": ".1.3.6.1.4.1.9.9.42.1.2.1",
"refTableColIdxOid": ".1.100",
"propertyName": "rtttype",
"propertyValueAppendOid": ".1.4",
"hexValue": false,
"name": "rttMonCtrlAdminTable.4",
"longLifeCaching": false,
"nextSnmpReferenceTableConstraint": true
},
{
"indexEntryMask": "oid._._.100",
"usePropertyValueInVariableName": false,
"parentTablecolIdxOidPositions": "1",
"referenceTableOid": ".1.3.6.1.4.1.9.9.42.1.3.2",
"refTableColIdxOid": ".1.100",
"propertyName": "colladdr",
"propertyValueAppendOid": ".1.8",
"hexValue": false,
"name": "rttMonStatsCollectTable.8",
"longLifeCaching": false,
"nextSnmpReferenceTableConstraint": true
}
],
"innerJointName": "probeNumber",
"tableColNameOid": ".1.100",
"snmpFilters": [
{
"indexEntryMask": "oid._._.100",
"outerJointColumns": ".1.100",
"appendOid": ".1.4",
"onTableOid": ".1.3.6.1.4.1.9.9.42.1.2.1",
"outerJointName": "probeNumber",
"name": "probeTypeisnotpathEcho",
"valueEquals": "[^p].*",
"onTableName": "extFilterRttCtrlAdminTable",
"invertMatch": false
}
],
"sortOnOid": false,
"innerJointColumns": ".1.100",
"cacheAllSnmpReferenceTables": false,
"innerJoinConstraint": true,
"matchNFirstOidSuffixOnly": 0,
"oid": ".1.3.6.1.4.1.9.9.42.1.3.2",
"useSnmpV2cMultipleRowPolling": true,
"tableFilterColumnConstraint": true,
"allOrNone": true,
"snmpRepeaters": 70,
"name": "rttMonStatsCollectTable",
"nextRefTableColIdxOid": ".1.100.1.101",
"snmpColumns": [
{
"appendOid": ".1.1",
"allOrNone": true,
"propertyName": "statsStartTimeIndex",
"propertyValueAppendOid": ".1.101",
"name": "StatsCollectNumDisconnects",
"varNameGenOidSequence": ".1.100",
"refreshOnPropertyChange": false
},
{
"appendOid": ".1.2",
"allOrNone": true,
"propertyName": "statsStartTimeIndex",
"propertyValueAppendOid": ".1.101",
"name": "StatsCollectTimeouts",
"varNameGenOidSequence": ".1.100",
"refreshOnPropertyChange": false
},
{
"appendOid": ".1.3",
"allOrNone": true,
"propertyName": "statsStartTimeIndex",
"propertyValueAppendOid": ".1.101",
"name": "StatsCollectBusies",
"varNameGenOidSequence": ".1.100",
"refreshOnPropertyChange": false
},
{
"appendOid": ".1.4",
"allOrNone": true,
"propertyName": "statsStartTimeIndex",
"propertyValueAppendOid": ".1.101",
"name": "StatsCollectNoConnections",
"varNameGenOidSequence": ".1.100",
"refreshOnPropertyChange": false
},
{
"appendOid": ".1.5",
"allOrNone": true,
"propertyName": "statsStartTimeIndex",
"propertyValueAppendOid": ".1.101",
"name": "StatsCollectDrops",
"varNameGenOidSequence": ".1.100",
"refreshOnPropertyChange": false
},
{
"appendOid": ".1.6",
"allOrNone": true,
"propertyName": "statsStartTimeIndex",
"propertyValueAppendOid": ".1.101",
"name": "StatsCollectSequenceErrors",
"varNameGenOidSequence": ".1.100",
"refreshOnPropertyChange": false
},
{
"appendOid": ".1.7",
"allOrNone": true,
"propertyName": "statsStartTimeIndex",
"propertyValueAppendOid": ".1.101",
"name": "StatsCollectVerifyErrors",
"varNameGenOidSequence": ".1.100",
"refreshOnPropertyChange": false
}
],
"id": "rttMSCoT",
"partType": "SAAPROBE",
"tableIndex": ".1.100.1.101.1.102"
},
{
"indexEntryMask": "oid._._.100.101.102+",
"nextSnmpReferenceTables": [
{
"indexEntryMask": "oid._._.100",
"usePropertyValueInVariableName": false,
"parentTablecolIdxOidPositions": "1",
"referenceTableOid": ".1.3.6.1.4.1.9.9.42.1.2.1",
"refTableColIdxOid": ".1.100",
"propertyName": "owner",
"propertyValueAppendOid": ".1.2",
"hexValue": false,
"name": "rttMonCtrlAdminTable.2",
"longLifeCaching": false,
"nextSnmpReferenceTableConstraint": true
},
{
"indexEntryMask": "oid._._.100",
"usePropertyValueInVariableName": false,
"parentTablecolIdxOidPositions": "1",
"referenceTableOid": ".1.3.6.1.4.1.9.9.42.1.2.1",
"refTableColIdxOid": ".1.100",
"propertyName": "tag",
"propertyValueAppendOid": ".1.3",
"hexValue": false,
"name": "rttMonCtrlAdminTable.3",
"longLifeCaching": false,
"nextSnmpReferenceTableConstraint": true
},
{
"indexEntryMask": "oid._._.100",
"usePropertyValueInVariableName": false,
"parentTablecolIdxOidPositions": "1",
"referenceTableOid": ".1.3.6.1.4.1.9.9.42.1.2.1",
"refTableColIdxOid": ".1.100",
"propertyName": "rtttype",
"propertyValueAppendOid": ".1.4",
"hexValue": false,
"name": "rttMonCtrlAdminTable.4",
"longLifeCaching": false,
"nextSnmpReferenceTableConstraint": true
}
],
"innerJointName": "probeNumber",
"tableColNameOid": ".1.100",
"snmpFilters": [
{
"indexEntryMask": "oid._._.100",
"outerJointColumns": ".1.100",
"appendOid": ".1.4",
"onTableOid": ".1.3.6.1.4.1.9.9.42.1.2.1",
"outerJointName": "probeNumber",
"name": "probeTypeisnotpathEcho",
"valueEquals": "[^p].*",
"onTableName": "extFilterRttCtrlAdminTable",
"invertMatch": false
}
],
"sortOnOid": false,
"innerJointColumns": ".1.100",
"cacheAllSnmpReferenceTables": false,
"innerJoinConstraint": true,
"matchNFirstOidSuffixOnly": 0,
"oid": ".1.3.6.1.4.1.9.9.42.1.3.1",
"useSnmpV2cMultipleRowPolling": true,
"tableFilterColumnConstraint": true,
"allOrNone": true,
"snmpRepeaters": 70,
"name": "rttMonStatsCaptureTable",
"nextRefTableColIdxOid": ".1.100.1.101",
"snmpColumns": [
{
"appendOid": ".1.5",
"allOrNone": true,
"propertyName": "statsStartTimeIndex",
"propertyValueAppendOid": ".1.101",
"name": "StatsCaptureCompletions",
"varNameGenOidSequence": ".1.100",
"refreshOnPropertyChange": false
},
{
"appendOid": ".1.6",
"allOrNone": true,
"propertyName": "statsStartTimeIndex",
"propertyValueAppendOid": ".1.101",
"name": "StatsCaptureOverThresholds",
"varNameGenOidSequence": ".1.100",
"refreshOnPropertyChange": false
},
{
"appendOid": ".1.7",
"unit": "ms",
"allOrNone": true,
"propertyName": "statsStartTimeIndex",
"propertyValueAppendOid": ".1.101",
"name": "StatsCaptureSumCompletionTime",
"varNameGenOidSequence": ".1.100",
"refreshOnPropertyChange": false
}
],
"id": "rttMSCaT",
"partType": "SAAPROBE",
"tableIndex": ".1.100.1.101.1.102"
}
],
"actions": 2,
"version": "v7-601",
"snmpProperties": [
{
"name": "metricType",
"id": "metricType",
"oneOrNone": true,
"value": "cisco-ipsla"
},
{
"name": "datagrp",
"id": "datagrp",
"oneOrNone": true,
"value": "CISCO-IPSLA-STATSTABLE"
},
{
"name": "w4ncert",
"id": "w4ncert",
"oneOrNone": true,
"value": "S1.0"
}
]
}
]
},
"translations": {
"variableSpecificTranslations": [
{
"name": "ifAdminStatus",
"valueMatches": [
{
"rename": "up",
"value": "100"
}
]
}
],
"configVersion": "6.6"
},
"pollingGroups": [
{
"name": "polling-group",
"pollingPeriod": 300,
"tableDiscoveryTime": "00:00:00",
"groupName": "group",
"uniformTimestamps": false,
"startAtDefinedPeriod": false,
"startTimeOffset": 0,
"pollingMaskNames": [
"CISCO-MEMORY-OLD",
"GENERIC-INTERFACES"
],
"snmpAgentIps": [
"string"
],
"snmpAgentNames": [
"0.0.0.0:161"
],
"snmpAgentsIPGroupNames": [
{
"name": "string",
"ipAddressMask": "string",
"matchEngine": "string"
}
],
"snmpAgentsExplicitGroupNames": [
{
"name": "string",
"agents": [
"string"
]
}
],
"enabled": false,
"pollingGroups": {
"pollingGroups": {
"pollingMaskNames": [
"GENERIC-SYSUPTIME",
"GENERIC-INTERFACES"
],
"pollingPeriod": 300,
"startAtDefinedPeriod": false,
"startTimeOffset": 0,
"enabled": true,
"assignedTo": "collector-a",
"groupName": "group",
"uniformTimestamps": false,
"name": "GEN-VEIVN9SWIB-300-check",
"snmpAgentNames": [
"10.106.232.11:161"
],
"tableDiscoveryTime": "00:00:00"
}
},
"snmpAgents": {
"snmpAgents": {
"name": "V2Agent",
"ipAddress": "10.106.126.64",
"snmpPort": 161,
"transportProtocol": "udp",
"snmpTimeout": 1000,
"snmpNumberOfRetries": 5,
"snmpVersion": "v2c",
"snmpCommunityOrUserV3Name": "public",
"maxBulkSize": 50,
"devType": "Switch",
"onFailTryWith": "v1",
"doNotUseGetBulkRequests": false,
"doNotUseCapabilityList": [],
"collectorNameList": [
"check-1"
],
"pollingPeriod": 200
}
},
"assignedTo": "collector-a"
}
],
"loadFactor": 5000,
"usedLoad": 0,
"distributionFactor": 100,
"capabilitiesList": [],
"ipAddress": "0.0.0.0",
"status": "IN_SYNC",
"collectorNameInK8": "collector-name",
"pollingPeriod": 300,
"creationTime": 1699861322429
}
The name of the data-center where this collector runs
All collector configurations are listed here
All the configured agents for this collector can be listed here, alongside with their respective properties and polling settings
All Polling group configurations associated with the particular collector are listed here.
This number indicates the maximum load which should be applied to the linked SNMP Collector. This load may be exceeded depending upon the Device distribution weight assigned to this collector.
The current load of the collector
This is the proportional weight of the Collector when Device distribution and configuration generation takes place. This Collector will poll its share of the Device set, proportional to the sum of all applicable Collector distribution weights.
The capabilities available on ths collector. This list is always empty as by default all capabilities are applicable to all Snmp collectors.
The ipAddress of the collector
The status of the collector. If the configuration has not been sent to the collector manager then the status is NOT_SYNC otherwise it is SYNC
Given a user entered collector name, it is converted into a format that can be displayed in K8s. That involves converting uppercase to lowercase, underscores and periods to hyphens.
The default polling period with which polling groups will be generated for this particular collector after discovery. Note: There is an order of precedence followed when assigning polling periods to generated polling groups - 1] Polling period of the Capability 2] Polling Period of Agent 3] Polling Period of the Collector
The epoch time of creation of the snmp collector.
BAD REQUEST Error in request sent
{
"code": "SNMP_COLLECTOR_API_006",
"reason": "No Snmp collector running, discovery cannot be performed",
"status": "404 Not Found"
}
This code refers to the internal error codes used in the code base.
This specifies the reason for failure.
This specifies the HTTP status code error
NOT FOUND Requested object not found
{
"code": "SNMP_COLLECTOR_API_006",
"reason": "No Snmp collector running, discovery cannot be performed",
"status": "404 Not Found"
}
This code refers to the internal error codes used in the code base.
This specifies the reason for failure.
This specifies the HTTP status code error
INTERNAL SERVER ERROR Error on the server
{
"code": "SNMP_COLLECTOR_API_006",
"reason": "No Snmp collector running, discovery cannot be performed",
"status": "404 Not Found"
}
This code refers to the internal error codes used in the code base.
This specifies the reason for failure.
This specifies the HTTP status code error