SnmpColumnRequest

SnmpColumnRequest
SnmpColumnRequest

These are the snmpColumns to be returned when performing a cross table query. SnmpColumns may, in turn, also contain SnmpFilters.

JSON Example
{
    "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"
            ]
        }
    ]
}
string
name
Required

The name of the element. In case of the column, the name is an attribute.

string
appendOid
Required

The column on which filtering is applied. Must be in the .1.X form, where X is the column number in the SNMP table.

string
as
Optional

The "Specifies how the polled values must be handled" feature has four possible values: NONE, DELTA, RATE, and POSITIVE RATE. The NONE value means that no calculation is applied to the polled value, and it is sent as is. This is the default behavior and does not require specification. The DELTA value computes the difference between polled values and sends this result as the polled value. The RATE value computes the rate between polled values and sends this result as the polled value, where the rate is calculated as (PV2-PV1)/(T2-T1). The POSITIVE RATE value computes the rate between polled values and sends this result as the real value, where in most cases, PolledValue = (PV2-PV1)/(T2-T1). However, when PV2 < PV1, PV2/(T2-T1) is used instead. Therefore, the result from this calculation will always be positive, but no wrap-around handling is done. It is important to note that the computed rate may be smaller than normal in this case.

Possible values are : DELTA, DELTAP, RATE, RATEP,
string
unit
Optional

It specifies the unit to apply to the polled value. This does not involve any calculation and fills the unit property in the resulting RawValue.

string
partType
Optional

The part type for the column, if different from the one set on the table.

string
propertyName
Optional

Adds the named property to the RawValue properties, which results from polling this column. The value of the property will be the one from the column specified below. Please note that it has to be less than 8 characters long.

string
propertyValueAppendOid
Optional

Only used if a property name has been given above. These are columns (ex: .1.2 .1.3) which values are assigned to the Property Column name, for this polled column only.

string
varNameGenOidSequence
Optional

If filled with OIDs relative to the table (ex: .1.2 .1.3), then these OIDs will be used in order to generate the variable name for this column

boolean
refreshOnPropertyChange
Optional

Automatically refreshes the RawValue properties on change. If set too often, this may have a performance impact on the polling process

propertyValues
Optional

The list of propertyValues

snmpFilters
Optional

The Filters to be applied

Property Of