SnmpTableRequest

SnmpTableRequest
SnmpTableRequest

The list of Tables in the snmp mask

JSON Example
{
    "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",
    "innerJoinOnList": [
        {
            "name": "probeNumber",
            "appendOid": ".1.100"
        }
    ],
    "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,
                    "outerJoinOnList": [
                        {
                            "name": "probeNumber",
                            "appendOid": ".1.100"
                        }
                    ],
                    "innerJoinOnList": [
                        {
                            "name": "probeNumber",
                            "appendOid": ".1.100"
                        }
                    ],
                    "snmpFilters": [
                        "SnmpFilterRequest Object"
                    ]
                }
            ]
        }
    ],
    "snmpFilters": [
        {
            "name": "string",
            "appendOid": "string",
            "onTableName": "string",
            "onTableOid": "string",
            "onTableColumnName": "string",
            "indexEntryMask": "string",
            "valueEquals": "string",
            "invertMatch": false,
            "outerJoinOnList": [
                {
                    "name": "probeNumber",
                    "appendOid": ".1.100"
                }
            ],
            "innerJoinOnList": [
                {
                    "name": "probeNumber",
                    "appendOid": ".1.100"
                }
            ],
            "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"
        }
    ]
}
string
id
Required

The table ID which is a unique identifier among all properties, OIDs, and tables

string
name
Required

The oid name or the user-defined name for this snmp object. In this case the table name

string
oid
Required

The table complete OID. For instance, for ifTable, this would be .1.3.6.1.2.1.2.2.

string
tableIndex
Required

The table index columns, separated with a space. For instance, ".1.1 .1.2" means indexes are column 1 and 2 of the table.

string
indexEntryMask
Required

This describes the table's rows OID structure and is used to generate index pseudo-columns when the table does not have explicit index columns. By using indexEntryMask="oid...100.101", it is possible to assign the pseudo-column 100 to cpmCPUTotalIndex and pseudo-column 101 to cpmProcessPID.

string
tableColNameOid
Optional

This attribute specifies which column values will be used, in the table, to set the part property for all polled columns. i.e.: tableColNameOid=".1.1 .1.2" will use column 1 and 2 values for the part property.

string
partType
Optional

It specifies the parttype property in the resulting RawValue.

boolean
useSnmpV2cMultipleRowPolling
Optional

If set, the collector will poll this table (and all nested tables) by using a row based method, using SNMP v2c getBulk requests. This ensures row data integrity is maintained.

integer
snmpRepeaters
Optional

The number of repeaters to use when multiple row polling is enabled. This number is used by the getBulk request to tell the agents how many varbinds should be returned in the PDU. Leaving this unset tells the collector to calculate this by itself. A good value to start with, when polling counters only, is 50.

boolean
cacheAllSnmpReferenceTables
Optional

When enabled, the polled values output order will be the same as provided by the agent OIDs order.

boolean
sortOnOid
Optional

Cache the SNMP reference tables until the properties must be refreshed. Enabling this option offers some performance enhancement under the right conditions. Please consult the AGP-SNMP-Collector-Admin-Guide, section 8.1, for further information.

string
tableRowSpecificationFile
Optional

The Collector will search for this file upon startup and, when polling this table, will match the rows with the file's content, filtering out useless data. Please consult the AGP-SNMP-Collector-Admin-Guide, section 8.1 and appendix E and F for further information. (tableRowSpecificationFile)

integer
matchNFirstOidSuffixOnly
Optional

This value is used only when the table row specification file is used. Please consult the AGP-SNMP-Collector-Admin-Guide, section 8.1 and appendix E and F for further information.

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.

innerJoinOnList
Optional

The joint specifications, used to join this table with external filter tables.

string
referenceTableOid
Optional

Table OID

string
refTableColIdxOid
Optional

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
refTableColNameOid
Optional

refTableColNameOid

propertyValues
Optional

The list of PropertyValues

snmpColumns
Required

Columns to be polled

snmpFilters
Optional

Filters to be applied

nextSnmpReferenceTables
Optional

Specifies the reference tables

Property Of