Update Snmp Collector
Updates the snmp collector configuration with the configuration provided. This configuration change is not reflected in the running collector. It is stored in an intermediate database, with the status as "NOT_SYNC".
Request
URI
PUT
https://{api_host}/tcsa.host.com/tcsa/api/v1/snmp/collector
COPY
Query Parameters
string
snmpIntegration
Optional
The name of the current snmp integration
snmpIntegration example
snmp-integration
Request Body
The Snmp Collector to be created
SnmpCollectorRequest of type(s) application/json
Required
Show optional properties
{
"dcName": "_core",
"collectorConfiguration": {
"name": "collectora"
}
}{
"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": "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
}
],
"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": [
{
"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"
}
],
"loadFactor": 5000,
"distributionFactor": 100,
"pollingPeriod": 300
}string
dcName
Required
The name of the data-center where this collector runs
collectorConfiguration
Required
All collector configurations are listed here
array of SnmpAgentRequest
snmpAgents
Optional
All the configured agents for this collector can be listed here, alongside with their respective properties and polling settings
array of PollingGroupRequest
pollingGroups
Optional
All Polling group configurations associated with the particular collector are listed here.
integer
loadFactor
Optional
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.
integer
distributionFactor
Optional
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.
integer
pollingPeriod
Optional
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
Responses
200
OK Returned successfully updated configuration of an SNMP collector, with state as NOT_SYNC
Returns SnmpCollectorResponse of type(s) application/json
{
"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
}string
dcName
Required
The name of the data-center where this collector runs
collectorConfiguration
Required
All collector configurations are listed here
array of SnmpAgentResponse
snmpAgents
Optional
All the configured agents for this collector can be listed here, alongside with their respective properties and polling settings
array of PollingGroupResponse
pollingGroups
Optional
All Polling group configurations associated with the particular collector are listed here.
integer
loadFactor
Optional
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.
integer
usedLoad
Optional
The current load of the collector
integer
distributionFactor
Optional
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.
array of string
capabilitiesList
Optional
The capabilities available on ths collector. This list is always empty as by default all capabilities are applicable to all Snmp collectors.
string
ipAddress
Optional
The ipAddress of the collector
string
status
Optional
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
Possible values are : NOT_SYNC, IN_SYNC,
string
collectorNameInK8
Optional
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.
integer
pollingPeriod
Optional
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
number
creationTime
Optional
The epoch time of creation of the snmp collector.
400
BAD REQUEST Error in the request sent
Returns SnmpError of type(s) application/json
{
"code": "SNMP_COLLECTOR_API_006",
"reason": "No Snmp collector running, discovery cannot be performed",
"status": "404 Not Found"
}string
code
Optional
This code refers to the internal error codes used in the code base.
string
reason
Optional
This specifies the reason for failure.
string
status
Optional
This specifies the HTTP status code error
404
NOT FOUND Requested object not found
Returns SnmpError of type(s) application/json
{
"code": "SNMP_COLLECTOR_API_006",
"reason": "No Snmp collector running, discovery cannot be performed",
"status": "404 Not Found"
}string
code
Optional
This code refers to the internal error codes used in the code base.
string
reason
Optional
This specifies the reason for failure.
string
status
Optional
This specifies the HTTP status code error
500
INTERNAL SERVER ERROR Error on the server
Returns SnmpError of type(s) application/json
{
"code": "SNMP_COLLECTOR_API_006",
"reason": "No Snmp collector running, discovery cannot be performed",
"status": "404 Not Found"
}string
code
Optional
This code refers to the internal error codes used in the code base.
string
reason
Optional
This specifies the reason for failure.
string
status
Optional
This specifies the HTTP status code error
On This Page
Snmp Operations
POST
Add Polling Group
POST
Add Snmp Agent
POST
Add Snmp Mask
POST
Cancel Discovery
DELETE
Delete Polling Groups
DELETE
Delete Snmp Agent
DELETE
Delete Snmp Collector
DELETE
Delete Snmp Mask
POST
Discover Capabilities
GET
Download Snmp Agents
GET
Get All Mib Files
GET
Get All Snmp Agents
GET
Get All Snmp Collectors
GET
Get Entire Snmp Integration
GET
Get Polling Groups
GET
Get Snmp Actions
GET
Get Snmp Masks
GET
Get Snmp Translations
POST
Initialize Snmp Collector
POST
Poll Agents For Affected Polling Groups
POST
Poll Collectors For Affected Polling Groups
POST
Poll Masks For Affected Polling Groups
GET
Retrieve Polling Group
GET
Retrieve Snmp Action
GET
Retrieve Snmp Agent
GET
Retrieve Snmp Collectors
GET
Retrieve Snmp Mask
POST
Send Collector Configurations
PUT
Update Polling Group
PUT
Update Snmp Agent
PUT
Update Snmp Collector
POST
Update Snmp Integration
PUT
Update Snmp Mask
POST
Upload Mib
POST
Upload Snmp Actions
POST
Upload Snmp Agents
POST
Upload Snmp Mask
POST
Upload Snmp Translations