Get Snmp Masks
API to get a list of masks.
Request
URI
GET
https://{api_host}/tcsa.host.com/tcsa/api/v1/snmp/masks
COPY
Query Parameters
integer
offset
Optional
Requested index for start of resources to be provided in response
integer
limit
Optional
Requested number of resources to be provided in response
string
snmpIntegration
Optional
The name of the current snmp integration
snmpIntegration example
snmp-integration
Responses
200
OK Returned list of all masks
Returns Array of SnmpMask of type(s) application/json
[
{
"name": "GENERIC-INTERFACES",
"version": "3.0",
"mibFiles": [
"RFC1213-MIB.mib",
"IANAifType-MIB.mib",
"IF-MIB.my",
"SNMPv2-MIB.my",
"SNMPv2-SMI.mib",
"IP-MIB.mib",
"SNMPv2-CONF.mib",
"SNMPv2-TC.mib"
],
"snmpTables": [
{
"allOrNone": true,
"tableFilterColumnConstraint": true,
"id": "stdIfT1",
"name": "stdIfTable1",
"oid": ".1.3.6.1.2.1.2.2",
"tableIndex": ".1.100",
"indexEntryMask": "oid._._.100",
"tableColNameOid": ".1.2",
"partType": "Interface",
"useSnmpV2cMultipleRowPolling": false,
"snmpRepeaters": -1,
"cacheAllSnmpReferenceTables": false,
"sortOnOid": false,
"tableRowSpecificationFile": null,
"matchNFirstOidSuffixOnly": 0,
"innerJoinOnList": null,
"nextRefTableColIdxOid": ".1.100",
"referenceTableOid": null,
"refTableColIdxOid": null,
"refTableColNameOid": null,
"snmpColumns": [
{
"allOrNone": true,
"name": "ifAdminStatus",
"appendOid": ".1.7",
"as": null,
"unit": null,
"partType": null,
"propertyName": "ifindex",
"propertyValueAppendOid": ".1.100",
"varNameGenOidSequence": null,
"refreshOnPropertyChange": false,
"propertyValues": null,
"snmpFilters": null
},
{
"allOrNone": true,
"name": "ifOperStatus",
"appendOid": ".1.8",
"as": null,
"unit": null,
"partType": null,
"propertyName": "ifindex",
"propertyValueAppendOid": ".1.100",
"varNameGenOidSequence": null,
"refreshOnPropertyChange": false,
"propertyValues": null,
"snmpFilters": null
}
],
"propertyValues": null,
"snmpFilters": null,
"nextSnmpReferenceTables": [
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifTable.ifDescr",
"referenceTableOid": ".1.3.6.1.2.1.2.2",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "part",
"propertyValueAppendOid": ".1.2",
"hexValue": false,
"usePropertyValueInVariableName": true,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifTable.ifType",
"referenceTableOid": ".1.3.6.1.2.1.2.2",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "iftype",
"propertyValueAppendOid": ".1.3",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifTable.ifSpeed",
"referenceTableOid": ".1.3.6.1.2.1.2.2",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "maxspeed",
"propertyValueAppendOid": ".1.5",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifTable.ifPhysAddress",
"referenceTableOid": ".1.3.6.1.2.1.2.2",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "ifacemac",
"propertyValueAppendOid": ".1.6",
"hexValue": true,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifTable.ifOperStatus",
"referenceTableOid": ".1.3.6.1.2.1.2.2",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "partstat",
"propertyValueAppendOid": ".1.8",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ipAddrTable.ipAdEntAddr",
"referenceTableOid": ".1.3.6.1.2.1.4.20",
"refTableColIdxOid": ".1.2",
"parentTablecolIdxOidPositions": "1",
"propertyName": "ifaceip",
"propertyValueAppendOid": ".1.1",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": null,
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifXTable.ifName",
"referenceTableOid": ".1.3.6.1.2.1.31.1.1",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "ifname",
"propertyValueAppendOid": ".1.1",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifXTable.ifAlias",
"referenceTableOid": ".1.3.6.1.2.1.31.1.1",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "ifalias",
"propertyValueAppendOid": ".1.18",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifXTable.ifHighSpeed",
"referenceTableOid": ".1.3.6.1.2.1.31.1.1",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "mxhspeed",
"propertyValueAppendOid": ".1.15",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
}
]
},
{
"allOrNone": true,
"tableFilterColumnConstraint": true,
"id": "stdIfT2",
"name": "stdIfTable2",
"oid": ".1.3.6.1.2.1.2.2",
"tableIndex": ".1.100",
"indexEntryMask": "oid._._.100",
"tableColNameOid": ".1.2",
"partType": "Interface",
"useSnmpV2cMultipleRowPolling": false,
"snmpRepeaters": -1,
"cacheAllSnmpReferenceTables": false,
"sortOnOid": false,
"tableRowSpecificationFile": null,
"matchNFirstOidSuffixOnly": 0,
"innerJoinOnList": null,
"nextRefTableColIdxOid": ".1.100",
"referenceTableOid": null,
"refTableColIdxOid": null,
"refTableColNameOid": null,
"snmpColumns": [
{
"allOrNone": true,
"name": "ifInDiscards",
"appendOid": ".1.13",
"as": "RATEP",
"unit": "Pkts/s",
"partType": null,
"propertyName": "ifindex",
"propertyValueAppendOid": ".1.100",
"varNameGenOidSequence": null,
"refreshOnPropertyChange": false,
"propertyValues": null,
"snmpFilters": null
},
{
"allOrNone": true,
"name": "ifInErrors",
"appendOid": ".1.14",
"as": "RATEP",
"unit": "Pkts/s",
"partType": null,
"propertyName": "ifindex",
"propertyValueAppendOid": ".1.100",
"varNameGenOidSequence": null,
"refreshOnPropertyChange": false,
"propertyValues": null,
"snmpFilters": null
},
{
"allOrNone": true,
"name": "ifInUnknownProtos",
"appendOid": ".1.15",
"as": "RATEP",
"unit": "Pkts/s",
"partType": null,
"propertyName": "ifindex",
"propertyValueAppendOid": ".1.100",
"varNameGenOidSequence": null,
"refreshOnPropertyChange": false,
"propertyValues": null,
"snmpFilters": null
},
{
"allOrNone": true,
"name": "ifOutDiscards",
"appendOid": ".1.19",
"as": "RATEP",
"unit": "Pkts/s",
"partType": null,
"propertyName": "ifindex",
"propertyValueAppendOid": ".1.100",
"varNameGenOidSequence": null,
"refreshOnPropertyChange": false,
"propertyValues": null,
"snmpFilters": null
},
{
"allOrNone": true,
"name": "ifOutErrors",
"appendOid": ".1.20",
"as": "RATEP",
"unit": "Pkts/s",
"partType": null,
"propertyName": "ifindex",
"propertyValueAppendOid": ".1.100",
"varNameGenOidSequence": null,
"refreshOnPropertyChange": false,
"propertyValues": null,
"snmpFilters": null
}
],
"propertyValues": null,
"snmpFilters": [
{
"name": null,
"appendOid": ".1.7",
"onTableName": null,
"onTableOid": null,
"onTableColumnName": null,
"indexEntryMask": null,
"valueEquals": "up",
"invertMatch": false,
"outerJoinOnList": null,
"innerJoinOnList": null,
"snmpFilters": null
}
],
"nextSnmpReferenceTables": [
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifTable.ifDescr",
"referenceTableOid": ".1.3.6.1.2.1.2.2",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "part",
"propertyValueAppendOid": ".1.2",
"hexValue": false,
"usePropertyValueInVariableName": true,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifTable.ifType",
"referenceTableOid": ".1.3.6.1.2.1.2.2",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "iftype",
"propertyValueAppendOid": ".1.3",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifTable.ifSpeed",
"referenceTableOid": ".1.3.6.1.2.1.2.2",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "maxspeed",
"propertyValueAppendOid": ".1.5",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifTable.ifPhysAddress",
"referenceTableOid": ".1.3.6.1.2.1.2.2",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "ifacemac",
"propertyValueAppendOid": ".1.6",
"hexValue": true,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifTable.ifOperStatus",
"referenceTableOid": ".1.3.6.1.2.1.2.2",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "partstat",
"propertyValueAppendOid": ".1.8",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ipAddrTable.ipAdEntAddr",
"referenceTableOid": ".1.3.6.1.2.1.4.20",
"refTableColIdxOid": ".1.2",
"parentTablecolIdxOidPositions": "1",
"propertyName": "ifaceip",
"propertyValueAppendOid": ".1.1",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": null,
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifXTable.ifName",
"referenceTableOid": ".1.3.6.1.2.1.31.1.1",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "ifname",
"propertyValueAppendOid": ".1.1",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifXTable.ifAlias",
"referenceTableOid": ".1.3.6.1.2.1.31.1.1",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "ifalias",
"propertyValueAppendOid": ".1.18",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifXTable.ifHighSpeed",
"referenceTableOid": ".1.3.6.1.2.1.31.1.1",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "mxhspeed",
"propertyValueAppendOid": ".1.15",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
}
]
},
{
"allOrNone": true,
"tableFilterColumnConstraint": true,
"id": "stdIfT3",
"name": "stdIfTable3",
"oid": ".1.3.6.1.2.1.2.2",
"tableIndex": ".1.100",
"indexEntryMask": "oid._._.100",
"tableColNameOid": null,
"partType": "Interface",
"useSnmpV2cMultipleRowPolling": false,
"snmpRepeaters": -1,
"cacheAllSnmpReferenceTables": false,
"sortOnOid": false,
"tableRowSpecificationFile": null,
"matchNFirstOidSuffixOnly": 0,
"innerJoinOnList": null,
"nextRefTableColIdxOid": ".1.100",
"referenceTableOid": null,
"refTableColIdxOid": null,
"refTableColNameOid": null,
"snmpColumns": [
{
"allOrNone": true,
"name": "ifSpeed",
"appendOid": ".1.5",
"as": null,
"unit": "1",
"partType": null,
"propertyName": "ifindex",
"propertyValueAppendOid": ".1.100",
"varNameGenOidSequence": null,
"refreshOnPropertyChange": false,
"propertyValues": null,
"snmpFilters": null
},
{
"allOrNone": true,
"name": "ifInOctets",
"appendOid": ".1.10",
"as": "RATEP",
"unit": "Octets/s",
"partType": null,
"propertyName": "ifindex",
"propertyValueAppendOid": ".1.100",
"varNameGenOidSequence": null,
"refreshOnPropertyChange": false,
"propertyValues": null,
"snmpFilters": null
},
{
"allOrNone": true,
"name": "ifOutOctets",
"appendOid": ".1.16",
"as": "RATEP",
"unit": "Octets/s",
"partType": null,
"propertyName": "ifindex",
"propertyValueAppendOid": ".1.100",
"varNameGenOidSequence": null,
"refreshOnPropertyChange": false,
"propertyValues": null,
"snmpFilters": null
},
{
"allOrNone": true,
"name": "ifInUcastPkts",
"appendOid": ".1.11",
"as": "RATEP",
"unit": "Pkts/s",
"partType": null,
"propertyName": "ifindex",
"propertyValueAppendOid": ".1.100",
"varNameGenOidSequence": null,
"refreshOnPropertyChange": false,
"propertyValues": null,
"snmpFilters": null
},
{
"allOrNone": true,
"name": "ifInNUcastPkts",
"appendOid": ".1.12",
"as": "RATEP",
"unit": "Pkts/s",
"partType": null,
"propertyName": "ifindex",
"propertyValueAppendOid": ".1.100",
"varNameGenOidSequence": null,
"refreshOnPropertyChange": false,
"propertyValues": null,
"snmpFilters": null
},
{
"allOrNone": true,
"name": "ifOutUcastPkts",
"appendOid": ".1.17",
"as": "RATEP",
"unit": "Pkts/s",
"partType": null,
"propertyName": "ifindex",
"propertyValueAppendOid": ".1.100",
"varNameGenOidSequence": null,
"refreshOnPropertyChange": false,
"propertyValues": null,
"snmpFilters": null
},
{
"allOrNone": true,
"name": "ifOutNUcastPkts",
"appendOid": ".1.18",
"as": "RATEP",
"unit": "Pkts/s",
"partType": null,
"propertyName": "ifindex",
"propertyValueAppendOid": ".1.100",
"varNameGenOidSequence": null,
"refreshOnPropertyChange": false,
"propertyValues": null,
"snmpFilters": null
}
],
"propertyValues": null,
"snmpFilters": [
{
"name": null,
"appendOid": ".1.7",
"onTableName": null,
"onTableOid": null,
"onTableColumnName": null,
"indexEntryMask": null,
"valueEquals": "up",
"invertMatch": false,
"outerJoinOnList": null,
"innerJoinOnList": null,
"snmpFilters": [
{
"name": null,
"appendOid": ".1.5",
"onTableName": null,
"onTableOid": null,
"onTableColumnName": null,
"indexEntryMask": null,
"valueEquals": "100000000|[0-9]{1,8}",
"invertMatch": false,
"outerJoinOnList": null,
"innerJoinOnList": null,
"snmpFilters": null
}
]
}
],
"nextSnmpReferenceTables": [
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifTable.ifDescr",
"referenceTableOid": ".1.3.6.1.2.1.2.2",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "part",
"propertyValueAppendOid": ".1.2",
"hexValue": false,
"usePropertyValueInVariableName": true,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifTable.ifType",
"referenceTableOid": ".1.3.6.1.2.1.2.2",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "iftype",
"propertyValueAppendOid": ".1.3",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifTable.ifSpeed",
"referenceTableOid": ".1.3.6.1.2.1.2.2",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "maxspeed",
"propertyValueAppendOid": ".1.5",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifTable.ifPhysAddress",
"referenceTableOid": ".1.3.6.1.2.1.2.2",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "ifacemac",
"propertyValueAppendOid": ".1.6",
"hexValue": true,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifTable.ifOperStatus",
"referenceTableOid": ".1.3.6.1.2.1.2.2",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "partstat",
"propertyValueAppendOid": ".1.8",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ipAddrTable.ipAdEntAddr",
"referenceTableOid": ".1.3.6.1.2.1.4.20",
"refTableColIdxOid": ".1.2",
"parentTablecolIdxOidPositions": "1",
"propertyName": "ifaceip",
"propertyValueAppendOid": ".1.1",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": null,
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifXTable.ifName",
"referenceTableOid": ".1.3.6.1.2.1.31.1.1",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "ifname",
"propertyValueAppendOid": ".1.1",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifXTable.ifAlias",
"referenceTableOid": ".1.3.6.1.2.1.31.1.1",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "ifalias",
"propertyValueAppendOid": ".1.18",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifXTable.ifHighSpeed",
"referenceTableOid": ".1.3.6.1.2.1.31.1.1",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "mxhspeed",
"propertyValueAppendOid": ".1.15",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
}
]
},
{
"allOrNone": true,
"tableFilterColumnConstraint": true,
"id": "stdIfXT3",
"name": "stdIfXTable3",
"oid": ".1.3.6.1.2.1.31.1.1",
"tableIndex": ".1.100",
"indexEntryMask": "oid._._.100",
"tableColNameOid": null,
"partType": "Interface",
"useSnmpV2cMultipleRowPolling": false,
"snmpRepeaters": -1,
"cacheAllSnmpReferenceTables": false,
"sortOnOid": false,
"tableRowSpecificationFile": null,
"matchNFirstOidSuffixOnly": 0,
"innerJoinOnList": [
{
"name": "ifIndex",
"appendOid": ".1.100"
}
],
"nextRefTableColIdxOid": ".1.100",
"referenceTableOid": null,
"refTableColIdxOid": null,
"refTableColNameOid": null,
"snmpColumns": [
{
"allOrNone": true,
"name": "ifSpeed",
"appendOid": ".1.15",
"as": null,
"unit": "1000000",
"partType": null,
"propertyName": "ifindex",
"propertyValueAppendOid": ".1.100",
"varNameGenOidSequence": null,
"refreshOnPropertyChange": false,
"propertyValues": null,
"snmpFilters": null
},
{
"allOrNone": true,
"name": "ifInOctets",
"appendOid": ".1.6",
"as": "RATEP",
"unit": "Octets/s",
"partType": null,
"propertyName": "ifindex",
"propertyValueAppendOid": ".1.100",
"varNameGenOidSequence": null,
"refreshOnPropertyChange": false,
"propertyValues": null,
"snmpFilters": null
},
{
"allOrNone": true,
"name": "ifOutOctets",
"appendOid": ".1.10",
"as": "RATEP",
"unit": "Octets/s",
"partType": null,
"propertyName": "ifindex",
"propertyValueAppendOid": ".1.100",
"varNameGenOidSequence": null,
"refreshOnPropertyChange": false,
"propertyValues": null,
"snmpFilters": null
},
{
"allOrNone": true,
"name": "ifInUcastPkts",
"appendOid": ".1.7",
"as": "RATEP",
"unit": "Pkts/s",
"partType": null,
"propertyName": "ifindex",
"propertyValueAppendOid": ".1.100",
"varNameGenOidSequence": null,
"refreshOnPropertyChange": false,
"propertyValues": null,
"snmpFilters": null
},
{
"allOrNone": true,
"name": "ifInMulticastPkts",
"appendOid": ".1.8",
"as": "RATEP",
"unit": "Pkts/s",
"partType": null,
"propertyName": "ifindex",
"propertyValueAppendOid": ".1.100",
"varNameGenOidSequence": null,
"refreshOnPropertyChange": false,
"propertyValues": null,
"snmpFilters": null
},
{
"allOrNone": true,
"name": "ifInBroadcastPkts",
"appendOid": ".1.9",
"as": "RATEP",
"unit": "Pkts/s",
"partType": null,
"propertyName": "ifindex",
"propertyValueAppendOid": ".1.100",
"varNameGenOidSequence": null,
"refreshOnPropertyChange": false,
"propertyValues": null,
"snmpFilters": null
},
{
"allOrNone": true,
"name": "ifOutUcastPkts",
"appendOid": ".1.11",
"as": "RATEP",
"unit": "Pkts/s",
"partType": null,
"propertyName": "ifindex",
"propertyValueAppendOid": ".1.100",
"varNameGenOidSequence": null,
"refreshOnPropertyChange": false,
"propertyValues": null,
"snmpFilters": null
},
{
"allOrNone": true,
"name": "ifOutMulticastPkts",
"appendOid": ".1.12",
"as": "RATEP",
"unit": "Pkts/s",
"partType": null,
"propertyName": "ifindex",
"propertyValueAppendOid": ".1.100",
"varNameGenOidSequence": null,
"refreshOnPropertyChange": false,
"propertyValues": null,
"snmpFilters": null
},
{
"allOrNone": true,
"name": "ifOutBroadcastPkts",
"appendOid": ".1.13",
"as": "RATEP",
"unit": "Pkts/s",
"partType": null,
"propertyName": "ifindex",
"propertyValueAppendOid": ".1.100",
"varNameGenOidSequence": null,
"refreshOnPropertyChange": false,
"propertyValues": null,
"snmpFilters": null
}
],
"propertyValues": null,
"snmpFilters": [
{
"name": null,
"appendOid": ".1.15",
"onTableName": null,
"onTableOid": null,
"onTableColumnName": null,
"indexEntryMask": null,
"valueEquals": "[0-9]{4,}|[2-9][0-9]{2}|1[1-9][0-9]|10[1-9]",
"invertMatch": false,
"outerJoinOnList": null,
"innerJoinOnList": null,
"snmpFilters": [
{
"name": "ifTable.ifAdminStatusFilter",
"appendOid": ".1.7",
"onTableName": "ifTable.ifAdminStatusFilter",
"onTableOid": ".1.3.6.1.2.1.2.2",
"onTableColumnName": "ifAdminStatus",
"indexEntryMask": "oid._._.100",
"valueEquals": "up",
"invertMatch": false,
"outerJoinOnList": [
{
"name": "ifIndex",
"appendOid": ".1.100"
}
],
"innerJoinOnList": null,
"snmpFilters": null
}
]
}
],
"nextSnmpReferenceTables": [
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifTable.ifDescr",
"referenceTableOid": ".1.3.6.1.2.1.2.2",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "part",
"propertyValueAppendOid": ".1.2",
"hexValue": false,
"usePropertyValueInVariableName": true,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifTable.ifType",
"referenceTableOid": ".1.3.6.1.2.1.2.2",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "iftype",
"propertyValueAppendOid": ".1.3",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifTable.ifSpeed",
"referenceTableOid": ".1.3.6.1.2.1.2.2",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "maxspeed",
"propertyValueAppendOid": ".1.5",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifTable.ifPhysAddress",
"referenceTableOid": ".1.3.6.1.2.1.2.2",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "ifacemac",
"propertyValueAppendOid": ".1.6",
"hexValue": true,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifTable.ifOperStatus",
"referenceTableOid": ".1.3.6.1.2.1.2.2",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "partstat",
"propertyValueAppendOid": ".1.8",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ipAddrTable.ipAdEntAddr",
"referenceTableOid": ".1.3.6.1.2.1.4.20",
"refTableColIdxOid": ".1.2",
"parentTablecolIdxOidPositions": "1",
"propertyName": "ifaceip",
"propertyValueAppendOid": ".1.1",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": null,
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifXTable.ifName",
"referenceTableOid": ".1.3.6.1.2.1.31.1.1",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "ifname",
"propertyValueAppendOid": ".1.1",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifXTable.ifAlias",
"referenceTableOid": ".1.3.6.1.2.1.31.1.1",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "ifalias",
"propertyValueAppendOid": ".1.18",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifXTable.ifHighSpeed",
"referenceTableOid": ".1.3.6.1.2.1.31.1.1",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "mxhspeed",
"propertyValueAppendOid": ".1.15",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
}
]
},
{
"allOrNone": true,
"tableFilterColumnConstraint": true,
"id": "stdIfXT4a",
"name": "stdIfXTable4a",
"oid": ".1.3.6.1.2.1.31.1.1",
"tableIndex": ".1.100",
"indexEntryMask": "oid._._.100",
"tableColNameOid": null,
"partType": "Interface",
"useSnmpV2cMultipleRowPolling": false,
"snmpRepeaters": -1,
"cacheAllSnmpReferenceTables": false,
"sortOnOid": false,
"tableRowSpecificationFile": null,
"matchNFirstOidSuffixOnly": 0,
"innerJoinOnList": [
{
"name": "ifIndex",
"appendOid": ".1.100"
}
],
"nextRefTableColIdxOid": ".1.100",
"referenceTableOid": null,
"refTableColIdxOid": null,
"refTableColNameOid": null,
"snmpColumns": [
{
"allOrNone": true,
"name": "ifInMulticastPkts",
"appendOid": ".1.2",
"as": "RATEP",
"unit": "Pkts/s",
"partType": null,
"propertyName": "ifindex",
"propertyValueAppendOid": ".1.100",
"varNameGenOidSequence": null,
"refreshOnPropertyChange": false,
"propertyValues": null,
"snmpFilters": null
},
{
"allOrNone": true,
"name": "ifInBroadcastPkts",
"appendOid": ".1.3",
"as": "RATEP",
"unit": "Pkts/s",
"partType": null,
"propertyName": "ifindex",
"propertyValueAppendOid": ".1.100",
"varNameGenOidSequence": null,
"refreshOnPropertyChange": false,
"propertyValues": null,
"snmpFilters": null
},
{
"allOrNone": true,
"name": "ifOutMulticastPkts",
"appendOid": ".1.4",
"as": "RATEP",
"unit": "Pkts/s",
"partType": null,
"propertyName": "ifindex",
"propertyValueAppendOid": ".1.100",
"varNameGenOidSequence": null,
"refreshOnPropertyChange": false,
"propertyValues": null,
"snmpFilters": null
},
{
"allOrNone": true,
"name": "ifOutBroadcastPkts",
"appendOid": ".1.5",
"as": "RATEP",
"unit": "Pkts/s",
"partType": null,
"propertyName": "ifindex",
"propertyValueAppendOid": ".1.100",
"varNameGenOidSequence": null,
"refreshOnPropertyChange": false,
"propertyValues": null,
"snmpFilters": null
}
],
"propertyValues": null,
"snmpFilters": [
{
"name": "ifTable.ifAdminStatusSpeedFilter",
"appendOid": ".1.7",
"onTableName": "ifTable.ifAdminStatusSpeedFilter",
"onTableOid": ".1.3.6.1.2.1.2.2",
"onTableColumnName": "ifAdminStatus",
"indexEntryMask": "oid._._.100",
"valueEquals": "up",
"invertMatch": false,
"outerJoinOnList": [
{
"name": "ifIndex",
"appendOid": ".1.100"
}
],
"innerJoinOnList": null,
"snmpFilters": [
{
"name": null,
"appendOid": ".1.5",
"onTableName": null,
"onTableOid": null,
"onTableColumnName": null,
"indexEntryMask": null,
"valueEquals": "100000000|[0-9]{1,8}",
"invertMatch": false,
"outerJoinOnList": null,
"innerJoinOnList": null,
"snmpFilters": null
}
]
}
],
"nextSnmpReferenceTables": [
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifTable.ifDescr",
"referenceTableOid": ".1.3.6.1.2.1.2.2",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "part",
"propertyValueAppendOid": ".1.2",
"hexValue": false,
"usePropertyValueInVariableName": true,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifTable.ifType",
"referenceTableOid": ".1.3.6.1.2.1.2.2",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "iftype",
"propertyValueAppendOid": ".1.3",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifTable.ifSpeed",
"referenceTableOid": ".1.3.6.1.2.1.2.2",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "maxspeed",
"propertyValueAppendOid": ".1.5",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifTable.ifPhysAddress",
"referenceTableOid": ".1.3.6.1.2.1.2.2",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "ifacemac",
"propertyValueAppendOid": ".1.6",
"hexValue": true,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifTable.ifOperStatus",
"referenceTableOid": ".1.3.6.1.2.1.2.2",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "partstat",
"propertyValueAppendOid": ".1.8",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ipAddrTable.ipAdEntAddr",
"referenceTableOid": ".1.3.6.1.2.1.4.20",
"refTableColIdxOid": ".1.2",
"parentTablecolIdxOidPositions": "1",
"propertyName": "ifaceip",
"propertyValueAppendOid": ".1.1",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": null,
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifXTable.ifName",
"referenceTableOid": ".1.3.6.1.2.1.31.1.1",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "ifname",
"propertyValueAppendOid": ".1.1",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifXTable.ifAlias",
"referenceTableOid": ".1.3.6.1.2.1.31.1.1",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "ifalias",
"propertyValueAppendOid": ".1.18",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
},
{
"nextSnmpReferenceTableConstraint": true,
"name": "ifXTable.ifHighSpeed",
"referenceTableOid": ".1.3.6.1.2.1.31.1.1",
"refTableColIdxOid": ".1.100",
"parentTablecolIdxOidPositions": "1",
"propertyName": "mxhspeed",
"propertyValueAppendOid": ".1.15",
"hexValue": false,
"usePropertyValueInVariableName": false,
"nextRefTableColIdxOid": null,
"longLifeCaching": false,
"indexEntryMask": "oid._._.100",
"nextSnmpReferenceTable": null
}
]
}
],
"snmpOids": [
{
"id": "ipForwDatagrams",
"name": "ipForwDatagrams",
"oid": ".1.3.6.1.2.1.4.6.0",
"as": "RATEP",
"unit": null,
"part": null,
"partType": null,
"propertyValues": null
},
{
"id": "ipForwarding",
"name": "ipForwarding",
"oid": ".1.3.6.1.2.1.4.1.0",
"as": null,
"unit": null,
"part": null,
"partType": null,
"propertyValues": null
}
],
"snmpProperties": [
{
"oneOrNone": true,
"id": "w4ncert",
"name": "w4ncert",
"value": "1.0",
"oid": null
},
{
"oneOrNone": true,
"id": "datagrp",
"name": "datagrp",
"value": "GENERIC-INTERFACES",
"oid": null
},
{
"oneOrNone": true,
"id": "altsrc",
"name": "altsrc",
"value": "Generic-SNMP",
"oid": null
}
],
"snmpActionRequest": {
"capabilityName": "GENERIC-INTERFACES",
"loadFactor": 40,
"defaultPollingPeriod": 0,
"discoveryPasses": [
{
"capabilityConditionGroup": [
{
"name": "TableExistsSnmpCondition",
"oid": ".1.3.6.1.2.1.2.2",
"matchValue": "",
"invertResult": false
},
{
"name": "TableColumnUniqueValuesSnmpCondition",
"oid": ".1.3.6.1.2.1.2.2.1.2",
"matchValue": "",
"invertResult": false
},
{
"name": "TableExistsSnmpCondition",
"oid": ".1.3.6.1.2.1.31.1.1",
"matchValue": "",
"invertResult": false
}
]
},
{
"capabilityConditionGroup": [
{
"name": "TableColumnExistsSnmpCondition",
"oid": ".1.3.6.1.2.1.31.1.1.1.6",
"matchValue": "",
"invertResult": false
},
{
"name": "TableColumnExistsSnmpCondition",
"oid": ".1.3.6.1.2.1.31.1.1.1.10",
"matchValue": "",
"invertResult": false
}
]
}
]
},
"actions": 2,
"doNotEdit": true
}
]
400
BAD REQUEST Error in 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
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
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