SnmpReferenceTableRequest

SnmpReferenceTableRequest
SnmpReferenceTableRequest

The reference table that exists within another Snmp Table

JSON Example
{
    "name": "string",
    "referenceTableOid": "string",
    "refTableColIdxOid": "string",
    "parentTablecolIdxOidPositions": "string",
    "propertyName": "string",
    "propertyValueAppendOid": "string",
    "hexValue": false,
    "usePropertyValueInVariableName": false,
    "nextRefTableColIdxOid": "string",
    "longLifeCaching": false,
    "indexEntryMask": "string",
    "nextSnmpReferenceTable": {
        "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"
    }
}
string
name
Required

This is the reference table name. It has to be unique as it used as an identifier in the polling process.

string
referenceTableOid
Required

This is the base reference table OID. For instance, ifTable OID would be .1.3.6.1.2.1.2.2

string
refTableColIdxOid
Required

This specifies the SNMP reference table index columns. These columns are used to join the reference table to the parent table. Its format is .1.X .1.Y .1.Z, where X, Y, Z are column numbers

string
parentTablecolIdxOidPositions
Optional

The positions here are used to identify which OIDs to use from the parent Next Reference OID. For instance, if the parent Next Reference OID value is .1.2 .1.3 .1.6, then specifying 1 3 would mean to use the OIDs .1.2 and .1.6 from the parent table in order to join it with this one.

string
propertyName
Optional

The name of the property to define. Please note that it has to be less than 8 characters long.

string
propertyValueAppendOid
Optional

The column where the property value will be taken. It must be specified in the format .1.X, where X is the column number.

boolean
hexValue
Optional

If set, the hexadecimal value will be kept and not translated into a string. This proves particularly useful when gathering IPs. In that case, hex values need to be kept and a specific filter has to be applied for the right value to be collected.

boolean
usePropertyValueInVariableName
Optional

This tells the collector to use the value polled in this table when creating the RawValue variable name. It is therefore possible to create a variable name entirely based on values polled from a reference table.

string
nextRefTableColIdxOid
Optional

Specifies the join columns to use when a further reference table is defined within this one. It is possible to define a chain of reference table elements in order to get properties that are several tables away from where the value is polled. It is always specified in the .1.X .1.Y .1.Z form, where X, Y, Z are column numbers.

boolean
longLifeCaching
Optional

Cache the reference table to avoid polling it on every cycle. The reference table will be refreshed when the properties are refreshed. Do not use this option if the reference table, or its nested reference tables, is used to build the varaible name.

string
indexEntryMask
Optional

Has to be set when the reference table does not have index columns for all its indexes. The meaning is exactly the same as the one of the main table property.

nextSnmpReferenceTable
Optional

The reference table that exists within another Snmp Table