All MIBs › SNMP-NOTIFICATION-MIB › snmpNotifyFilterMask
snmpNotifyFilterMask
Module: SNMP-NOTIFICATION-MIB
OID (symbolic): SNMP-NOTIFICATION-MIB::snmpNotifyFilterMask
OID (numeric): 1.3.6.1.6.3.13.1.3.1.2
Node type: OBJECT-TYPE
Type: OCTET STRING
Access: read-create
Description: The bit mask which, in combination with the corresponding instance of snmpNotifyFilterSubtree, defines a family of subtrees which are included in or excluded from the filter profile.
Each bit of this bit mask corresponds to a sub-identifier of snmpNotifyFilterSubtree, with the most significant bit of the i-th octet of this octet string value (extended if necessary, see below) corresponding to the (8*i - 7)-th sub-identifier, and the least significant bit of the i-th octet of this octet string corresponding to the (8*i)-th sub-identifier, where i is in the range 1 through 16.
Each bit of this bit mask specifies whether or not the corresponding sub-identifiers must match when determining if an OBJECT IDENTIFIER matches this family of filter subtrees; a '1' indicates that an exact match must occur; a '0' indicates 'wild card', i.e., any sub-identifier value matches.
Thus, the OBJECT IDENTIFIER X of an object instance is contained in a family of filter subtrees if, for each sub-identifier of the value of snmpNotifyFilterSubtree, either:
the i-th bit of snmpNotifyFilterMask is 0, or
the i-th sub-identifier of X is equal to the i-th sub-identifier of the value of snmpNotifyFilterSubtree.
If the value of this bit mask is M bits long and there are more than M sub-identifiers in the corresponding instance of snmpNotifyFilterSubtree, then the bit mask is extended with 1's to be the required length.
Note that when the value of this object is the zero-length string, this extension rule results in a mask of all-1's being used (i.e., no 'wild card'), and the family of filter subtrees is the one subtree uniquely identified by the corresponding instance of snmpNotifyFilterSubtree.
What is snmpNotifyFilterMask?
This bit mask works together with the corresponding filter subtree OID to define a family of MIB subtrees included in or excluded from a notification filter profile, where each '1' bit requires an exact match on that sub-identifier and each '0' bit acts as a wildcard. An admin uses it to broaden or narrow which object instances a filter subtree covers, rather than matching only a single exact OID. For example, a zero-length mask (the default) means no wildcarding is applied, so the filter matches only the single subtree it names exactly.
OID Breakdown
Upper-level ancestors (6 from the standard OID tree / other modules)
| Numeric OID | Name | Module |
|---|---|---|
| 1 | iso | LANART-AGENT |
| 1.3 | org | AirPair-MIB |
| 1.3.6 | dod | AirPair-MIB |
| 1.3.6.1 | internet | AirPair-MIB |
| 1.3.6.1.6 | snmpV2 | DASAN-DHCP-MIB |
| 1.3.6.1.6.3 | snmpModules | RAPID-CITY |
| Numeric OID | Name | Module |
|---|---|---|
| 1.3.6.1.6.3.13 | snmpNotificationMIB | SNMP-NOTIFICATION-MIB |
| 1.3.6.1.6.3.13.1 | snmpNotifyObjects | SNMP-NOTIFICATION-MIB |
| 1.3.6.1.6.3.13.1.3 | snmpNotifyFilterTable | SNMP-NOTIFICATION-MIB |
| 1.3.6.1.6.3.13.1.3.1 | snmpNotifyFilterEntry | SNMP-NOTIFICATION-MIB |
| 1.3.6.1.6.3.13.1.3.1.2 | snmpNotifyFilterMask | SNMP-NOTIFICATION-MIB |