SnmpFilterRequest

SnmpFilterRequest
SnmpFilterRequest

The filters to be applied on the Snmp Tables.

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

This setting is user defined and has no effect on polling. It is used for commenting purposes only but must still be supported.

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
onTableName
Required

This is the filter table name. It must be set only when this filtering table is not based at the same OID as the table which contains it

string
onTableOid
Required

This is the filter table base OID. This must be set when the filter table is not set at the same OID as the table which contains it

string
onTableColumnName
Optional

This setting is user defined and has no effect on polling. It is used for commenting purposes only.

string
indexEntryMask
Optional

This defines the Outer Join column, if not accessible in the filter table. Must be in the oid...X form

string
valueEquals
Required

The value used for filtering. It is in fact a regular expression, whose simplest form is an equality: value="value" performs the SQL equivalent of =, as in: SELECT ... FROM table WHERE column='value'. value="ethernet.*" performs the SQL equivalent of LIKE, as in: SELECT ... FROM table WHERE column LIKE 'ethernet%'

boolean
invertMatch
Optional

When set to true, inverts the regular expression match result. If the regular expression matches, match is false. If the regular expression does not match, match is true.

string
outerJointName
Optional

This name must match the Inner Joint name on the table. It allows this table's rows to be matched against the main table's rows so that filtering on this table is also done on the main table.

string As (\.1\.[0-9]+ )*\.1\.[0-9]+
outerJointColumns
Optional

hese OIDS specify this table's columns on which the joint will take place. The values of these columns must match the values found in the main table's Inner Joint Columns.

string
innerJointName
Optional

The name of the joint specification, used to join this table with external filter tables.

string As (\.1\.[0-9]+ )*\.1\.[0-9]+
innerJointColumns
Optional

The OIDs of the columns used to join this table with external filter tables.

snmpFilters
Optional

The Filters to be applied