All MIBs › SNMP-VIEW-BASED-ACM-MIB › vacmViewTreeFamilyMask
vacmViewTreeFamilyMask
Module: SNMP-VIEW-BASED-ACM-MIB
OID (symbolic): SNMP-VIEW-BASED-ACM-MIB::vacmViewTreeFamilyMask
OID (numeric): 1.3.6.1.6.3.16.1.5.2.1.3
Node type: OBJECT-TYPE
Type: OCTET STRING
Access: read-create
Description: The bit mask which, in combination with the corresponding instance of vacmViewTreeFamilySubtree, defines a family of view subtrees.
Each bit of this bit mask corresponds to a sub-identifier of vacmViewTreeFamilySubtree, 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 is in this family of view 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 view subtrees if, for each sub-identifier of the value of vacmViewTreeFamilySubtree, either:
the i-th bit of vacmViewTreeFamilyMask is 0, or
the i-th sub-identifier of X is equal to the i-th sub-identifier of the value of vacmViewTreeFamilySubtree.
If the value of this bit mask is M bits long and
there are more than M sub-identifiers in the corresponding instance of vacmViewTreeFamilySubtree, 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 view subtrees is the one view subtree uniquely identified by the corresponding instance of vacmViewTreeFamilySubtree.
Note that masks of length greater than zero length do not need to be supported. In this case this object is made read-only.
What is vacmViewTreeFamilyMask?
This read-create bit mask, up to 16 octets and defaulting to the empty string, combines with vacmViewTreeFamilySubtree to define a family of view subtrees: each bit maps to one sub-identifier of the subtree OID, where a 1 bit requires an exact match and a 0 bit acts as a wildcard matching any sub-identifier value, with a zero-length mask meaning no wildcarding (exact match on the single subtree). Admins set this to define flexible OID subtree matching rules for a MIB view, such as matching a specific table column across all row indexes. For example, a mask that wildcards the trailing bits corresponding to a table's index lets the view match every row of that table rather than just one instance.
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.16 | snmpVacmMIB | SNMP-VIEW-BASED-ACM-MIB |
| 1.3.6.1.6.3.16.1 | vacmMIBObjects | SNMP-VIEW-BASED-ACM-MIB |
| 1.3.6.1.6.3.16.1.5 | vacmMIBViews | SNMP-VIEW-BASED-ACM-MIB |
| 1.3.6.1.6.3.16.1.5.2 | vacmViewTreeFamilyTable | SNMP-VIEW-BASED-ACM-MIB |
| 1.3.6.1.6.3.16.1.5.2.1 | vacmViewTreeFamilyEntry | SNMP-VIEW-BASED-ACM-MIB |
| 1.3.6.1.6.3.16.1.5.2.1.3 | vacmViewTreeFamilyMask | SNMP-VIEW-BASED-ACM-MIB |