snmpHelper.instanceFilter database table

Edit online

The snmpHelper.instanceFilter database table configures SNMP interface filters for the SNMP helper.

Schema

The snmpHelper.instanceFilter database table schema is described in the following table:

Table 1. snmpHelper.instanceFilter database table schema

Column name

Constraints

Data type

Description
m_FilterName not null, primary key text The name of the interface filter. The name must be unique.
m_DeviceFilter not null text

The device filter is applied to each discovered device to determine whether or not to apply the interface filter.

The filter must be in the following form:
mibVariableName expression values [ optional_Boolean_operator expression optional_Boolean_operator .. ]
For example, the following are all valid filters:
// Apply the interface filter to only a specific type of device
sysObjectID = '1.3.6.1.4.1.4874.1.1.1.1.3'

// More complex example of the above
sysObjectID = '1.3.6.1.4.1.4874.1.1.1.1.3' OR sysDescr LIKE 'ERX-1440'

// Apply the interface filter only to devices in certain locations
sysLocation in ( 'location1', 'location2' )

//Apply the interface filter to all types of device.
sysObjectID != ''
m_DeviceFilterOids list type text Specifies any OIDs that need to be retrieved in order to allow the evaluation of the device filter defined in the m_DeviceFilter field. The OIDs are usually determined programatically from the value of m_DeviceFilter. You do not normally need to define the OIDs manually.
m_InstanceFilter text

The interface filter to be applied to the filtered tables. The interface filter is only applied to devices that match the device filter. Only rows from those tables with interfaces that match this filter are returned.

The filter must be in the following form:
mibVariableName expression values [ optional_Boolean_operator expression optional_Boolean_operator .. ]
For example, the following are all valid filters:
// Only interfaces with names like this are returned
ifName like 'Gi0'

// This filter is against 2 distinct tables (ifTable and ifXTable) with the requirement that these share a common index (ifIndex)
ifName like 'Gi0' or ifDescr like 'FastEthernet'

// Filter out interfaces of these types
ifType not in ( 1, 53, 166 )
Restriction: You can configure inserts into only one of the m_InstanceFilter or m_InstanceFilterTable fields.
Restriction:

The MIB variable used in the interface filter must be from a table that is keyed on ifIndex, for example, from ifTable or ifXTable.
m_InstanceFilterTable text Defines a table that is not to be queried.
Restriction: You can configure inserts into only one of the m_InstanceFilter or m_InstanceFilterTable fields.
Restriction: If you define a table that is not to be queried using the m_InstanceFilterTable field, you must not apply other filters to the same MIB table for the same device.
m_InstanceFilters list type object type vblist

The m_InstanceFilters field contains the full collection of interface filters. The full interface filters are automatically generated from the contents of the m_InstanceFilter or m_InstanceFilterTable fields.

Restriction: User-configured inserts into this field are not supported.