Add Snmp Mask
API to add a single mask
The name of the current snmp integration
snmp-integration
The snmpMaskRequest object containing the details of the mask to be added
Show optional properties
{
"name": "CISCO-IPSLA-STATSTABLE-NEW"
}
{
"name": "string",
"version": "string",
"mibFiles": [
"string"
],
"snmpTables": [
{
"id": "string",
"name": "string",
"oid": "string",
"tableIndex": "string",
"indexEntryMask": "string",
"tableColNameOid": "string",
"partType": "string",
"useSnmpV2cMultipleRowPolling": false,
"snmpRepeaters": 0,
"cacheAllSnmpReferenceTables": false,
"sortOnOid": false,
"tableRowSpecificationFile": "string",
"matchNFirstOidSuffixOnly": 0,
"nextRefTableColIdxOid": "string",
"innerJointName": "string",
"innerJointColumns": "string",
"referenceTableOid": "string",
"refTableColIdxOid": "string",
"refTableColNameOid": "string",
"propertyValues": [
{
"name": "string",
"value": "string"
}
],
"snmpColumns": [
{
"name": "string",
"appendOid": "string",
"as": "string",
"unit": "string",
"partType": "string",
"propertyName": "string",
"propertyValueAppendOid": "string",
"varNameGenOidSequence": "string",
"refreshOnPropertyChange": false,
"propertyValues": [
{
"name": "string",
"value": "string"
}
],
"snmpFilters": [
{
"name": "string",
"appendOid": "string",
"onTableName": "string",
"onTableOid": "string",
"onTableColumnName": "string",
"indexEntryMask": "string",
"valueEquals": "string",
"invertMatch": false,
"outerJointName": "string",
"outerJointColumns": "string",
"innerJointName": "string",
"innerJointColumns": "string",
"snmpFilters": [
"SnmpFilterRequest Object"
]
}
]
}
],
"snmpFilters": [
{
"name": "string",
"appendOid": "string",
"onTableName": "string",
"onTableOid": "string",
"onTableColumnName": "string",
"indexEntryMask": "string",
"valueEquals": "string",
"invertMatch": false,
"outerJointName": "string",
"outerJointColumns": "string",
"innerJointName": "string",
"innerJointColumns": "string",
"snmpFilters": [
"SnmpFilterRequest Object"
]
}
],
"nextSnmpReferenceTables": [
{
"name": "string",
"referenceTableOid": "string",
"refTableColIdxOid": "string",
"parentTablecolIdxOidPositions": "string",
"propertyName": "string",
"propertyValueAppendOid": "string",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": "string",
"longLifeCaching": false,
"indexEntryMask": "string",
"nextSnmpReferenceTable": "SnmpReferenceTableRequest Object"
}
]
}
],
"snmpOids": [
{
"id": "string",
"name": "string",
"oid": "string",
"as": "string",
"unit": "string",
"part": "string",
"partType": "string",
"propertyValues": [
{
"name": "string",
"value": "string"
}
]
}
],
"snmpProperties": [
{
"id": "string",
"name": "string",
"value": "string",
"oid": "string"
}
],
"actions": 2,
"snmpActionRequest": {
"capabilityName": "CISCO-MEMORY",
"loadFactor": 1,
"defaultPollingPeriod": 0,
"discoveryPasses": [
{
"capabilityConditionGroup": [
{
"name": "SingleOidContainsSnmpCondition",
"oid": ".1.3.6.1.2.1.1.2.0",
"matchValue": "\\.1\\.3\\.6\\.1\\.4\\.1\\.9\\..*",
"invertResult": false
}
]
}
]
}
}
Name of the snmp mask
A string which contains this mask version. This can obly be changed through the API or by editing the mask xml file and uploading the same.
The list of MIBs used by this mask
These properties (OID or static value) will be attached to every metrics collected by the mask.
The number of actions that are present in this mask. The number is count of DiscoverPasses on the actions.
The snmpAction which contains the rules based on which a capability/mask is discovered on an agent.
OK Returned configuration of added mask
{
"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"
}
]
}
Name of the snmp mask
A string which contains this mask version. This can obly be changed through the API or by editing the mask xml file and uploading the same.
The list of MIBs used by this mask
These properties (OID or static value) will be attached to every metrics collected by the mask.
The number of actions that are present in this mask. The number is count of DiscoverPasses on the actions.
The snmpAction which contains the rules based on which a capability/mask is discovered on an agent.
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
CONFLICT Object already exists
{
"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