This is a summary of information regarding objects below the snmpNotificationMIB MIB object, which is defined within the SNMP-NOTIFICATION-MIB MIB document as .1.3.6.1.6.3.13.
| Name | Type | Access | OID | Description |
|---|
| Name | Type | Access | Description |
|---|---|---|---|
|
1
snmpNotifyName |
OCTETSTR
Legal Lengths: 1 .. 32 SnmpAdminString | NoAccess |
Note: this object is based on the SnmpAdminString TEXTUAL-CONVENTION. The locally arbitrary, but unique identifier associated with this snmpNotifyEntry. |
| Name | Type | Access | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
|
2
snmpNotifyTag |
OCTETSTR
Legal Lengths: 0 .. 255 SnmpTagValue | Create |
Note: this object is based on the SnmpTagValue TEXTUAL-CONVENTION. This object contains a single tag value which is used to select entries in the snmpTargetAddrTable. Any entry in the snmpTargetAddrTable which contains a tag value which is equal to the value of an instance of this object is selected. If this object contains a value of zero length, no entries are selected. |
||||||
|
3
snmpNotifyType |
INTEGER
| Create |
This object determines the type of notification to
be generated for entries in the snmpTargetAddrTable
selected by the corresponding instance of
snmpNotifyTag. This value is only used when
generating notifications, and is ignored when
using the snmpTargetAddrTable for other purposes.
If the value of this object is trap(1), then any
messages generated for selected rows will contain
Unconfirmed-Class PDUs.
If the value of this object is inform(2), then any
messages generated for selected rows will contain
Confirmed-Class PDUs.
Note that if an SNMP entity only supports
generation of Unconfirmed-Class PDUs (and not
Confirmed-Class PDUs), then this object may be
read-only.
|
||||||
|
4
snmpNotifyStorageType |
INTEGER
StorageType (ENUM list below) | Create |
Note: this object is based on the StorageType TEXTUAL-CONVENTION. The storage type for this conceptual row. Conceptual rows having the value 'permanent' need not allow write-access to any columnar objects in the row. |
||||||
|
5
snmpNotifyRowStatus |
INTEGER
RowStatus (ENUM list below) | Create |
Note: this object is based on the RowStatus TEXTUAL-CONVENTION.
The status of this conceptual row.
To create a row in this table, a manager must
set this object to either createAndGo(4) or
createAndWait(5).
|
| Name | Type | Access | Description |
|---|---|---|---|
|
1
snmpTargetParamsName |
OCTETSTR
Legal Lengths: 1 .. 32 SnmpAdminString | NoAccess |
Note: this object is based on the SnmpAdminString TEXTUAL-CONVENTION. The locally arbitrary, but unique identifier associated with this snmpTargetParamsEntry. |
| Name | Type | Access | Description |
|---|---|---|---|
|
1
snmpNotifyFilterProfileName |
OCTETSTR
Legal Lengths: 1 .. 32 SnmpAdminString | Create |
Note: this object is based on the SnmpAdminString TEXTUAL-CONVENTION. The name of the filter profile to be used when generating notifications using the corresponding entry in the snmpTargetAddrTable. |
|
2
snmpNotifyFilterProfileStorType |
INTEGER
StorageType (ENUM list below) | Create |
Note: this object is based on the StorageType TEXTUAL-CONVENTION. The storage type for this conceptual row. Conceptual rows having the value 'permanent' need not allow write-access to any columnar objects in the row. |
|
3
snmpNotifyFilterProfileRowStatus |
INTEGER
RowStatus (ENUM list below) | Create |
Note: this object is based on the RowStatus TEXTUAL-CONVENTION.
The status of this conceptual row.
To create a row in this table, a manager must
set this object to either createAndGo(4) or
createAndWait(5).
Until instances of all corresponding columns are
appropriately configured, the value of the
corresponding instance of the
snmpNotifyFilterProfileRowStatus column is 'notReady'.
In particular, a newly created row cannot be made
active until the corresponding instance of
snmpNotifyFilterProfileName has been set.
|
| Name | Type | Access | Description |
|---|---|---|---|
|
1
snmpNotifyFilterProfileName |
OCTETSTR
Legal Lengths: 1 .. 32 SnmpAdminString | Create |
Note: this object is based on the SnmpAdminString TEXTUAL-CONVENTION. The name of the filter profile to be used when generating notifications using the corresponding entry in the snmpTargetAddrTable. |
|
1
snmpNotifyFilterSubtree | OBJECTID | NoAccess |
The MIB subtree which, when combined with the corresponding instance of snmpNotifyFilterMask, defines a family of subtrees which are included in or excluded from the filter profile. |
| Name | Type | Access | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
|
2
snmpNotifyFilterMask |
OCTETSTR
Legal Lengths: 0 .. 16 | Create |
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. |
||||||
|
3
snmpNotifyFilterType |
INTEGER
| Create |
This object indicates whether the family of filter subtrees defined by this entry are included in or excluded from a filter. A more detailed discussion of the use of this object can be found in section 6. of [SNMP-APPL]. |
||||||
|
4
snmpNotifyFilterStorageType |
INTEGER
StorageType (ENUM list below) | Create |
Note: this object is based on the StorageType TEXTUAL-CONVENTION. The storage type for this conceptual row. Conceptual rows having the value 'permanent' need not allow write-access to any columnar objects in the row. |
||||||
|
5
snmpNotifyFilterRowStatus |
INTEGER
RowStatus (ENUM list below) | Create |
Note: this object is based on the RowStatus TEXTUAL-CONVENTION.
The status of this conceptual row.
To create a row in this table, a manager must
set this object to either createAndGo(4) or
createAndWait(5).
|
SCALAR OBJECTS
TABLE OBJECTS |
These TEXTUAL-CONVENTIONS are used in other parts of the document above. They are SNMP's way of defining a datatype that is used repeatedly by other MIB objects. Any implementation implementing objects that use one of these definitions must follow its DESCRIPTION clause as well as the DESCRIPTION clause of the object itself.
| Name | Type | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| StorageType | INTEGER
| Describes the memory realization of a conceptual row. A row which is volatile(2) is lost upon reboot. A row which is either nonVolatile(3), permanent(4) or readOnly(5), is backed up by stable storage. A row which is permanent(4) can be changed but not deleted. A row which is readOnly(5) cannot be changed nor deleted. If the value of an object with this syntax is either permanent(4) or readOnly(5), it cannot be written. Conversely, if the value is either other(1), volatile(2) or nonVolatile(3), it cannot be modified to be permanent(4) or readOnly(5). (All illegal modifications result in a 'wrongValue' error.) Every usage of this textual convention is required to specify the columnar objects which a permanent(4) row must at a minimum allow to be writable. | ||||||||||||||
| SnmpTagValue | OCTETSTR | An octet string containing a tag value.
Tag values are preferably in human-readable form.
To facilitate internationalization, this information
is represented using the ISO/IEC IS 10646-1 character
set, encoded as an octet string using the UTF-8
character encoding scheme described in RFC 2279.
Since additional code points are added by amendments
to the 10646 standard from time to time,
implementations must be prepared to encounter any code
point from 0x00000000 to 0x7fffffff.
The use of control codes should be avoided, and certain
control codes are not allowed as described below.
For code points not directly supported by user
interface hardware or software, an alternative means
of entry and display, such as hexadecimal, may be
provided.
For information encoded in 7-bit US-ASCII, the UTF-8
representation is identical to the US-ASCII encoding.
Note that when this TC is used for an object that
is used or envisioned to be used as an index, then a
SIZE restriction must be specified so that the number
of sub-identifiers for any object instance does not
exceed the limit of 128, as defined by [RFC1905].
An object of this type contains a single tag value
which is used to select a set of entries in a table.
A tag value is an arbitrary string of octets, but
may not contain a delimiter character. Delimiter
characters are defined to be one of the following:
- An ASCII space character (0x20).
- An ASCII TAB character (0x09).
- An ASCII carriage return (CR) character (0x0D).
- An ASCII line feed (LF) character (0x0A).
Delimiter characters are used to separate tag values
in a tag list. An object of this type may only
contain a single tag value, and so delimiter
characters are not allowed in a value of this type.
Note that a tag value of 0 length means that no tag is
defined. In other words, a tag value of 0 length would
never match anything in a tag list, and would never
select any table entries.
Some examples of valid tag values are:
- 'acme'
- 'router'
- 'host'
The use of a tag value to select table entries is
application and MIB specific. | ||||||||||||||
| RowStatus | INTEGER
| The RowStatus textual convention is used to manage the
creation and deletion of conceptual rows, and is used as the
value of the SYNTAX clause for the status column of a
conceptual row (as described in Section 7.7.1 of [2].)
The status column has six defined values:
- `active', which indicates that the conceptual row is
available for use by the managed device;
- `notInService', which indicates that the conceptual
row exists in the agent, but is unavailable for use by
the managed device (see NOTE below); 'notInService' has
no implication regarding the internal consistency of
the row, availability of resources, or consistency with
the current state of the managed device;
- `notReady', which indicates that the conceptual row
exists in the agent, but is missing information
necessary in order to be available for use by the
managed device (i.e., one or more required columns in
the conceptual row have not been instanciated);
- `createAndGo', which is supplied by a management
station wishing to create a new instance of a
conceptual row and to have its status automatically set
to active, making it available for use by the managed
device;
- `createAndWait', which is supplied by a management
station wishing to create a new instance of a
conceptual row (but not make it available for use by
the managed device); and,
- `destroy', which is supplied by a management station
wishing to delete all of the instances associated with
an existing conceptual row.
Whereas five of the six values (all except `notReady') may
be specified in a management protocol set operation, only
three values will be returned in response to a management
protocol retrieval operation: `notReady', `notInService' or
`active'. That is, when queried, an existing conceptual row
has only three states: it is either available for use by
the managed device (the status column has value `active');
it is not available for use by the managed device, though
the agent has sufficient information to attempt to make it
so (the status column has value `notInService'); or, it is
not available for use by the managed device, and an attempt
to make it so would fail because the agent has insufficient
information (the state column has value `notReady').
NOTE WELL
This textual convention may be used for a MIB table,
irrespective of whether the values of that table's
conceptual rows are able to be modified while it is
active, or whether its conceptual rows must be taken
out of service in order to be modified. That is, it is
the responsibility of the DESCRIPTION clause of the
status column to specify whether the status column must
not be `active' in order for the value of some other
column of the same conceptual row to be modified. If
such a specification is made, affected columns may be
changed by an SNMP set PDU if the RowStatus would not
be equal to `active' either immediately before or after
processing the PDU. In other words, if the PDU also
contained a varbind that would change the RowStatus
value, the column in question may be changed if the
RowStatus was not equal to `active' as the PDU was
received, or if the varbind sets the status | ||||||||||||||
| SnmpAdminString | OCTETSTR | An octet string containing administrative
information, preferably in human-readable form.
To facilitate internationalization, this
information is represented using the ISO/IEC
IS 10646-1 character set, encoded as an octet
string using the UTF-8 transformation format
described in [RFC2279].
Since additional code points are added by
amendments to the 10646 standard from time
to time, implementations must be prepared to
encounter any code point from 0x00000000 to
0x7fffffff. Byte sequences that do not
correspond to the valid UTF-8 encoding of a
code point or are outside this range are
prohibited.
The use of control codes should be avoided.
When it is necessary to represent a newline,
the control code sequence CR LF should be used.
The use of leading or trailing white space should
be avoided.
For code points not directly supported by user
interface hardware or software, an alternative
means of entry and display, such as hexadecimal,
may be provided.
For information encoded in 7-bit US-ASCII,
the UTF-8 encoding is identical to the
US-ASCII encoding.
UTF-8 may require multiple bytes to represent a
single character / code point; thus the length
of this object in octets may be different from
the number of characters encoded. Similarly,
size constraints refer to the number of encoded
octets, not the number of characters represented
by an encoding.
Note that when this TC is used for an object that
is used or envisioned to be used as an index, then
a SIZE restriction MUST be specified so that the
number of sub-identifiers for any object instance
does not exceed the limit of 128, as defined by
[RFC3416].
Note that the size of an SnmpAdminString object is
measured in octets, not characters.
|
Tree view generated by running: snmptranslate -Tp SNMP-NOTIFICATION-MIB::snmpNotificationMIB
+--snmpNotificationMIB(13) | +--snmpNotifyObjects(1) | | | +--snmpNotifyTable(1) | | | | | +--snmpNotifyEntry(1) | | | Index: snmpNotifyName | | | | | +-- ---- String snmpNotifyName(1) | | | Textual Convention: SnmpAdminString | | | Size: 1..32 | | +-- CR-- String snmpNotifyTag(2) | | | Textual Convention: SnmpTagValue | | | Size: 0..255 | | +-- CR-- EnumVal snmpNotifyType(3) | | | Values: trap(1), inform(2) | | +-- CR-- EnumVal snmpNotifyStorageType(4) | | | Textual Convention: StorageType | | | Values: other(1), volatile(2), nonVolatile(3), permanent(4), readOnly(5) | | +-- CR-- EnumVal snmpNotifyRowStatus(5) | | Textual Convention: RowStatus | | Values: active(1), notInService(2), notReady(3), createAndGo(4), createAndWait(5), destroy(6) | | | +--snmpNotifyFilterProfileTable(2) | | | | | +--snmpNotifyFilterProfileEntry(1) | | | Index: snmpTargetParamsName | | | | | +-- CR-- String snmpNotifyFilterProfileName(1) | | | Textual Convention: SnmpAdminString | | | Size: 1..32 | | +-- CR-- EnumVal snmpNotifyFilterProfileStorType(2) | | | Textual Convention: StorageType | | | Values: other(1), volatile(2), nonVolatile(3), permanent(4), readOnly(5) | | +-- CR-- EnumVal snmpNotifyFilterProfileRowStatus(3) | | Textual Convention: RowStatus | | Values: active(1), notInService(2), notReady(3), createAndGo(4), createAndWait(5), destroy(6) | | | +--snmpNotifyFilterTable(3) | | | +--snmpNotifyFilterEntry(1) | | Index: snmpNotifyFilterProfileName, snmpNotifyFilterSubtree | | | +-- ---- ObjID snmpNotifyFilterSubtree(1) | +-- CR-- String snmpNotifyFilterMask(2) | | Size: 0..16 | +-- CR-- EnumVal snmpNotifyFilterType(3) | | Values: included(1), excluded(2) | +-- CR-- EnumVal snmpNotifyFilterStorageType(4) | | Textual Convention: StorageType | | Values: other(1), volatile(2), nonVolatile(3), permanent(4), readOnly(5) | +-- CR-- EnumVal snmpNotifyFilterRowStatus(5) | Textual Convention: RowStatus | Values: active(1), notInService(2), notReady(3), createAndGo(4), createAndWait(5), destroy(6) | +--snmpNotifyConformance(3) | +--snmpNotifyCompliances(1) | | | +--snmpNotifyBasicCompliance(1) | +--snmpNotifyBasicFiltersCompliance(2) | +--snmpNotifyFullCompliance(3) | +--snmpNotifyGroups(2) | +--snmpNotifyGroup(1) +--snmpNotifyFilterGroup(2)
Last modified: Wednesday, 01-Aug-2018 04:41:28 UTC
For questions regarding web content and site functionality, please write to the net-snmp-users mail list.