NHRP-MIB

AddressFamilyNumbers0 = other1 = ipV42 = ipV63 = nsap4 = hdlc5 = bbn18226 = all8027 = e1638 = e1649 = f6910 = x12111 = ipx12 = appleTalk13 = decnetIV14 = banyanVines15 = e164withNsap16 = dns17 = distinguishedName18 = asNumber19 = xtpOverIpv420 = xtpOverIpv621 = xtpNativeModeXTP22 = fibreChannelWWPN23 = fibreChannelWWNN24 = gwid25 = afi26 = mplsTpSectionEndpointIdentifier27 = mplsTpLspEndpointIdentifier28 = mplsTpPseudowireEndpointIdentifier16384 = eigrpCommonServiceFamily16385 = eigrpIpv4ServiceFamily16386 = eigrpIpv6ServiceFamily16387 = lispCanonicalAddressFormat16388 = bgpLs16389 = fortyeightBitMac16390 = sixtyfourBitMac16391 = oui16392 = mac2416393 = mac4016394 = ipv66416395 = rBridgePortID16396 = trillNickname16397 = universallyUniqueIdentifier65535 = reservedThe definition of this textual convention with the addition of newly assigned values is published periodically by the IANA, in either the Assigned Numbers RFC, or some derivative of it specific to Internet Network Management number assignments. (The latest arrangements can be obtained by contacting the IANA.) The enumerations are described as: other(0), -- none of the following ipV4(1), -- IP Version 4 ipV6(2), -- IP Version 6 nsap(3), -- NSAP hdlc(4), -- (8-bit multidrop) bbn1822(5), all802(6), -- (includes all 802 media -- plus Ethernet 'canonical format') e163(7), e164(8), -- (SMDS, Frame Relay, ATM) f69(9), -- (Telex) x121(10), -- (X.25, Frame Relay) ipx(11), -- IPX (Internet Protocol Exchange) appleTalk(12), -- Apple Talk decnetIV(13), -- DEC Net Phase IV banyanVines(14), -- Banyan Vines e164withNsap(15), -- (E.164 with NSAP format subaddress) dns(16), -- (Domain Name System) distinguishedName(17), -- (Distinguished Name, per X.500) asNumber(18), -- (16-bit quantity, per the AS number space) xtpOverIpv4(19), -- XTP over IP version 4 xtpOverIpv6(20), -- XTP over IP version 6 xtpNativeModeXTP(21), -- XTP native mode XTP fibreChannelWWPN(22), -- Fibre Channel World-Wide Port Name fibreChannelWWNN(23), -- Fibre Channel World-Wide Node Name gwid(24), -- Gateway Identifier afi(25), -- AFI for L2VPN information mplsTpSectionEndpointIdentifier(26), -- MPLS-TP Section Endpoint Identifier mplsTpLspEndpointIdentifier(27), -- MPLS-TP LSP Endpoint Identifier mplsTpPseudowireEndpointIdentifier(28), -- MPLS-TP Pseudowire Endpoint Identifier eigrpCommonServiceFamily(16384), -- EIGRP Common Service Family eigrpIpv4ServiceFamily(16385), -- EIGRP IPv4 Service Family eigrpIpv6ServiceFamily(16386), -- EIGRP IPv6 Service Family lispCanonicalAddressFormat(16387), -- LISP Canonical Address Format (LCAF) bgpLs(16388), -- BGP-LS fortyeightBitMacBitMac(16389), -- 48-bit MAC sixtyfourBitMac(16390), -- 64-bit MAC oui(16391), -- OUI mac24(16392), -- MAC/24 mac40(16393), -- MAC/40 ipv664(16394), -- IPv6/64 rBridgePortID(16395), -- RBridge Port ID trillNickname(16396), -- TRILL Nickname universallyUniqueIdentifier(16397), -- Universally Unique Identifier (UUID) reserved(65535) Requests for new values should be made to IANA via email (iana&iana.org). · Integer32

The internetwork layer address type of this Next Hop Resolution Cache entry. The value of this object indicates how to interpret the values of nhrpCacheInternetworkAddr and nhrpCacheNextHopInternetworkAddr.

NhrpGenAddrThe value of an internetwork layer or NBMA address. SIZE (0..64) · OCTET STRING

The value of the internetwork address of the destination.

Unsigned32 (1..4294967295)

An identifier for this entry that has local significance within the scope of the General Group. This identifier is used here to uniquely identify this row, and also used in the 'nhrpPurgeTable' for the value of the 'nhrpPurgeCacheIdentifier'.

Integer32 (0..255)

The number of bits that define the internetwork layer prefix associated with the nhrpCacheInternetworkAddr.

NhrpGenAddrThe value of an internetwork layer or NBMA address. SIZE (0..64) · OCTET STRING

The value of the internetwork address of the next hop.

AddressFamilyNumbers0 = other1 = ipV42 = ipV63 = nsap4 = hdlc5 = bbn18226 = all8027 = e1638 = e1649 = f6910 = x12111 = ipx12 = appleTalk13 = decnetIV14 = banyanVines15 = e164withNsap16 = dns17 = distinguishedName18 = asNumber19 = xtpOverIpv420 = xtpOverIpv621 = xtpNativeModeXTP22 = fibreChannelWWPN23 = fibreChannelWWNN24 = gwid25 = afi26 = mplsTpSectionEndpointIdentifier27 = mplsTpLspEndpointIdentifier28 = mplsTpPseudowireEndpointIdentifier16384 = eigrpCommonServiceFamily16385 = eigrpIpv4ServiceFamily16386 = eigrpIpv6ServiceFamily16387 = lispCanonicalAddressFormat16388 = bgpLs16389 = fortyeightBitMac16390 = sixtyfourBitMac16391 = oui16392 = mac2416393 = mac4016394 = ipv66416395 = rBridgePortID16396 = trillNickname16397 = universallyUniqueIdentifier65535 = reservedThe definition of this textual convention with the addition of newly assigned values is published periodically by the IANA, in either the Assigned Numbers RFC, or some derivative of it specific to Internet Network Management number assignments. (The latest arrangements can be obtained by contacting the IANA.) The enumerations are described as: other(0), -- none of the following ipV4(1), -- IP Version 4 ipV6(2), -- IP Version 6 nsap(3), -- NSAP hdlc(4), -- (8-bit multidrop) bbn1822(5), all802(6), -- (includes all 802 media -- plus Ethernet 'canonical format') e163(7), e164(8), -- (SMDS, Frame Relay, ATM) f69(9), -- (Telex) x121(10), -- (X.25, Frame Relay) ipx(11), -- IPX (Internet Protocol Exchange) appleTalk(12), -- Apple Talk decnetIV(13), -- DEC Net Phase IV banyanVines(14), -- Banyan Vines e164withNsap(15), -- (E.164 with NSAP format subaddress) dns(16), -- (Domain Name System) distinguishedName(17), -- (Distinguished Name, per X.500) asNumber(18), -- (16-bit quantity, per the AS number space) xtpOverIpv4(19), -- XTP over IP version 4 xtpOverIpv6(20), -- XTP over IP version 6 xtpNativeModeXTP(21), -- XTP native mode XTP fibreChannelWWPN(22), -- Fibre Channel World-Wide Port Name fibreChannelWWNN(23), -- Fibre Channel World-Wide Node Name gwid(24), -- Gateway Identifier afi(25), -- AFI for L2VPN information mplsTpSectionEndpointIdentifier(26), -- MPLS-TP Section Endpoint Identifier mplsTpLspEndpointIdentifier(27), -- MPLS-TP LSP Endpoint Identifier mplsTpPseudowireEndpointIdentifier(28), -- MPLS-TP Pseudowire Endpoint Identifier eigrpCommonServiceFamily(16384), -- EIGRP Common Service Family eigrpIpv4ServiceFamily(16385), -- EIGRP IPv4 Service Family eigrpIpv6ServiceFamily(16386), -- EIGRP IPv6 Service Family lispCanonicalAddressFormat(16387), -- LISP Canonical Address Format (LCAF) bgpLs(16388), -- BGP-LS fortyeightBitMacBitMac(16389), -- 48-bit MAC sixtyfourBitMac(16390), -- 64-bit MAC oui(16391), -- OUI mac24(16392), -- MAC/24 mac40(16393), -- MAC/40 ipv664(16394), -- IPv6/64 rBridgePortID(16395), -- RBridge Port ID trillNickname(16396), -- TRILL Nickname universallyUniqueIdentifier(16397), -- Universally Unique Identifier (UUID) reserved(65535) Requests for new values should be made to IANA via email (iana&iana.org). · Integer32

The NBMA address type. The value of this object indicates how to interpret the values of nhrpCacheNbmaAddr and nhrpCacheNbmaSubaddr.

NhrpGenAddrThe value of an internetwork layer or NBMA address. SIZE (0..64) · OCTET STRING

The value of the NBMA subnetwork address of the next hop.

NhrpGenAddrThe value of an internetwork layer or NBMA address. SIZE (0..64) · OCTET STRING

The value of the NBMA subaddress of the next hop. If there is no subaddress concept for the NBMA address family, this value will be a zero-length OCTET STRING.

INTEGER1 = other2 = register3 = resolveAuthoritative4 = resoveNonauthoritative5 = transit6 = administrativelyAdded7 = atmarp8 = scsp · Integer32

An indication of how this cache entry was created. The values are: 'other(1)' The entry was added by some other means. 'register(2)' In a server, added based on a client registration. 'resolveAuthoritative(3)' In a client, added based on receiving an Authoritative NHRP Resolution Reply. 'resolveNonauthoritative(4)' In a client, added based on receiving a Nonauthoritative NHRP Resolution Reply. 'transit(5)' In a transit server, added by examining a forwarded NHRP packet. 'administrativelyAdded(6)' In a client or server, manually added by the administrator. The StorageType of this entry is reflected in 'nhrpCacheStorageType'. 'atmarp(7)' The entry was added due to an ATMARP. 'scsp(8)' The entry was added due to SCSP. When the entry is under creation using the nhrpCacheRowStatus column, the only value that can be specified by the administrator is 'administrativelyAdded'. Attempting to set any other value will cause an 'inconsistentValue' error. The value cannot be modified once the entry is active.

INTEGER1 = incomplete2 = ackReply3 = nakReply · Integer32

An indication of the state of this entry. The values are: 'incomplete(1)' The client has sent a NHRP Resolution Request but has not yet received the NHRP Resolution Reply. 'ackReply(2)' For a client or server, this is a cached valid mapping. 'nakReply(3)' For a client or server, this is a cached NAK mapping.

TruthValue1 = true2 = falseRepresents a boolean value. · Integer32

True(1) is returned if the value of 'nhrpCacheType' is not 'administrativelyAdded'. Since the value of 'nhrpCacheType' was not configured by a user, the value of 'nhrpCacheHoldingTime' is considered valid. In other words, the value of 'nhrpCacheHoldingTime' represents the Holding Time for the cache Entry. If 'nhrpCacheType has been configured by a user, (i.e. the value of 'nhrpCacheType' is 'administrativelyAdded') then false(2) will be returned. This indicates that the value of 'nhrpCacheHoldingTime' is undefined because this row could possibly be backed up in nonvolatile storage.

Unsigned32 (0..65535) · seconds

If the value of 'nhrpCacheHoldingTimeValid is true(1) then this object represents the number of seconds that the cache entry will remain in this table. When this value reaches 0 (zero) the row should be deleted. If the value of 'nhrpCacheHoldingTimeValid is false(2) then this object is undefined.

Integer32 (0..65535)

The maximum transmission unit (MTU) that was negotiated or registered for this entity. In other words, this is the actual MTU being used.

Integer32 (0..255)

An object which reflects the Preference value of the Client Information Entry (CIE). Zero or more Client Information Entries (CIEs) may be included in the NHRP Packet. One of the fields in the CIE is the Preference. For a complete description of the CIE, refer to Section 5.2.0.1 of RFC 2332 [17]. ⓘ

StorageType1 = other2 = volatile3 = nonVolatile4 = permanent5 = readOnlyDescribes 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. · Integer32

This value only has meaning when the 'nhrpCacheType' has the value of 'administrativelyAdded'. When the row is created due to being 'administrativelyAdded', this object reflects whether this row is kept in volatile storage and lost upon reboot or if this row is backed up by non-volatile or permanent storage. If the value of 'nhrpCacheType' has a value which is not 'administrativelyAdded, then the value of this object is 'other(1)'.

RowStatus1 = active2 = notInService3 = notReady4 = createAndGo5 = createAndWait6 = destroyThe 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 to a value other than 'active'. Also note that whenever any elements of a row exist, the RowStatus column must also exist. To summarize the effect of having a conceptual row with a status column having a SYNTAX clause value of RowStatus, consider the following state diagram: STATE +--------------+-----------+-------------+------------- | A | B | C | D | |status col.|status column| |status column | is | is |status column ACTION |does not exist| notReady | notInService| is active --------------+--------------+-----------+-------------+------------- set status |noError ->D|inconsist- |inconsistent-|inconsistent- column to | or | entValue| Value| Value createAndGo |inconsistent- | | | | Value| | | --------------+--------------+-----------+-------------+------------- set status |noError see 1|inconsist- |inconsistent-|inconsistent- column to | or | entValue| Value| Value createAndWait |wrongValue | | | --------------+--------------+-----------+-------------+------------- set status |inconsistent- |inconsist- |noError |noError column to | Value| entValue| | active | | | | | | or | | | | | | | |see 2 ->D|see 8 ->D| ->D --------------+--------------+-----------+-------------+------------- set status |inconsistent- |inconsist- |noError |noError ->C column to | Value| entValue| | notInService | | | | | | or | | or | | | | | |see 3 ->C| ->C|see 6 --------------+--------------+-----------+-------------+------------- set status |noError |noError |noError |noError ->A column to | | | | or destroy | ->A| ->A| ->A|see 7 --------------+--------------+-----------+-------------+------------- set any other |see 4 |noError |noError |see 5 column to some| | | | value | | see 1| ->C| ->D --------------+--------------+-----------+-------------+------------- (1) goto B or C, depending on information available to the agent. (2) if other variable bindings included in the same PDU, provide values for all columns which are missing but required, and all columns have acceptable values, then return noError and goto D. (3) if other variable bindings included in the same PDU, provide legal values for all columns which are missing but required, then return noError and goto C. (4) at the discretion of the agent, the return value may be either: inconsistentName: because the agent does not choose to create such an instance when the corresponding RowStatus instance does not exist, or inconsistentValue: if the supplied value is inconsistent with the state of some other MIB object's value, or noError: because the agent chooses to create the instance. If noError is returned, then the instance of the status column must also be created, and the new state is B or C, depending on the information available to the agent. If inconsistentName or inconsistentValue is returned, the row remains in state A. (5) depending on the MIB definition for the column/table, either noError or inconsistentValue may be returned. (6) the return value can indicate one of the following errors: wrongValue: because the agent does not support notInService (e.g., an agent which does not support createAndWait), or inconsistentValue: because the agent is unable to take the row out of service at this time, perhaps because it is in use and cannot be de-activated. (7) the return value can indicate the following error: inconsistentValue: because the agent is unable to remove the row at this time, perhaps because it is in use and cannot be de-activated. (8) the transition to D can fail, e.g., if the values of the conceptual row are inconsistent, then the error code would be inconsistentValue. NOTE: Other processing of (this and other varbinds of) the set request may result in a response other than noError being returned, e.g., wrongValue, noCreation, etc. Conceptual Row Creation There are four potential interactions when creating a conceptual row: selecting an instance-identifier which is not in use; creating the conceptual row; initializing any objects for which the agent does not supply a default; and, making the conceptual row available for use by the managed device. Interaction 1: Selecting an Instance-Identifier The algorithm used to select an instance-identifier varies for each conceptual row. In some cases, the instance- identifier is semantically significant, e.g., the destination address of a route, and a management station selects the instance-identifier according to the semantics. In other cases, the instance-identifier is used solely to distinguish conceptual rows, and a management station without specific knowledge of the conceptual row might examine the instances present in order to determine an unused instance-identifier. (This approach may be used, but it is often highly sub-optimal; however, it is also a questionable practice for a naive management station to attempt conceptual row creation.) Alternately, the MIB module which defines the conceptual row might provide one or more objects which provide assistance in determining an unused instance-identifier. For example, if the conceptual row is indexed by an integer-value, then an object having an integer-valued SYNTAX clause might be defined for such a purpose, allowing a management station to issue a management protocol retrieval operation. In order to avoid unnecessary collisions between competing management stations, `adjacent' retrievals of this object should be different. Finally, the management station could select a pseudo-random number to use as the index. In the event that this index was already in use and an inconsistentValue was returned in response to the management protocol set operation, the management station should simply select a new pseudo-random number and retry the operation. A MIB designer should choose between the two latter algorithms based on the size of the table (and therefore the efficiency of each algorithm). For tables in which a large number of entries are expected, it is recommended that a MIB object be defined that returns an acceptable index for creation. For tables with small numbers of entries, it is recommended that the latter pseudo-random index mechanism be used. Interaction 2: Creating the Conceptual Row Once an unused instance-identifier has been selected, the management station determines if it wishes to create and activate the conceptual row in one transaction or in a negotiated set of interactions. Interaction 2a: Creating and Activating the Conceptual Row The management station must first determine the column requirements, i.e., it must determine those columns for which it must or must not provide values. Depending on the complexity of the table and the management station's knowledge of the agent's capabilities, this determination can be made locally by the management station. Alternately, the management station issues a management protocol get operation to examine all columns in the conceptual row that it wishes to create. In response, for each column, there are three possible outcomes: - a value is returned, indicating that some other management station has already created this conceptual row. We return to interaction 1. - the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it should supply a value for this column when the conceptual row is to be created. - the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column. Once the column requirements have been determined, a management protocol set operation is accordingly issued. This operation also sets the new instance of the status column to `createAndGo'. When the agent processes the set operation, it verifies that it has sufficient information to make the conceptual row available for use by the managed device. The information available to the agent is provided by two sources: the management protocol set operation which creates the conceptual row, and, implementation-specific defaults supplied by the agent (note that an agent must provide implementation-specific defaults for at least those objects which it implements as read-only). If there is sufficient information available, then the conceptual row is created, a `noError' response is returned, the status column is set to `active', and no further interactions are necessary (i.e., interactions 3 and 4 are skipped). If there is insufficient information, then the conceptual row is not created, and the set operation fails with an error of `inconsistentValue'. On this error, the management station can issue a management protocol retrieval operation to determine if this was because it failed to specify a value for a required column, or, because the selected instance of the status column already existed. In the latter case, we return to interaction 1. In the former case, the management station can re-issue the set operation with the additional information, or begin interaction 2 again using `createAndWait' in order to negotiate creation of the conceptual row. NOTE WELL Regardless of the method used to determine the column requirements, it is possible that the management station might deem a column necessary when, in fact, the agent will not allow that particular columnar instance to be created or written. In this case, the management protocol set operation will fail with an error such as `noCreation' or `notWritable'. In this case, the management station decides whether it needs to be able to set a value for that particular columnar instance. If not, the management station re-issues the management protocol set operation, but without setting a value for that particular columnar instance; otherwise, the management station aborts the row creation algorithm. Interaction 2b: Negotiating the Creation of the Conceptual Row The management station issues a management protocol set operation which sets the desired instance of the status column to `createAndWait'. If the agent is unwilling to process a request of this sort, the set operation fails with an error of `wrongValue'. (As a consequence, such an agent must be prepared to accept a single management protocol set operation, i.e., interaction 2a above, containing all of the columns indicated by its column requirements.) Otherwise, the conceptual row is created, a `noError' response is returned, and the status column is immediately set to either `notInService' or `notReady', depending on whether it has sufficient information to (attempt to) make the conceptual row available for use by the managed device. If there is sufficient information available, then the status column is set to `notInService'; otherwise, if there is insufficient information, then the status column is set to `notReady'. Regardless, we proceed to interaction 3. Interaction 3: Initializing non-defaulted Objects The management station must now determine the column requirements. It issues a management protocol get operation to examine all columns in the created conceptual row. In the response, for each column, there are three possible outcomes: - a value is returned, indicating that the agent implements the object-type associated with this column and had sufficient information to provide a value. For those columns to which the agent provides read-create access (and for which the agent allows their values to be changed after their creation), a value return tells the management station that it may issue additional management protocol set operations, if it desires, in order to change the value associated with this column. - the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. However, the agent does not have sufficient information to provide a value, and until a value is provided, the conceptual row may not be made available for use by the managed device. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it must issue additional management protocol set operations, in order to provide a value associated with this column. - the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column. If the value associated with the status column is `notReady', then the management station must first deal with all `noSuchInstance' columns, if any. Having done so, the value of the status column becomes `notInService', and we proceed to interaction 4. Interaction 4: Making the Conceptual Row Available Once the management station is satisfied with the values associated with the columns of the conceptual row, it issues a management protocol set operation to set the status column to `active'. If the agent has sufficient information to make the conceptual row available for use by the managed device, the management protocol set operation succeeds (a `noError' response is returned). Otherwise, the management protocol set operation fails with an error of `inconsistentValue'. NOTE WELL A conceptual row having a status column with value `notInService' or `notReady' is unavailable to the managed device. As such, it is possible for the managed device to create its own instances during the time between the management protocol set operation which sets the status column to `createAndWait' and the management protocol set operation which sets the status column to `active'. In this case, when the management protocol set operation is issued to set the status column to `active', the values held in the agent supersede those used by the managed device. If the management station is prevented from setting the status column to `active' (e.g., due to management station or network failure) the conceptual row will be left in the `notInService' or `notReady' state, consuming resources indefinitely. The agent must detect conceptual rows that have been in either state for an abnormally long period of time and remove them. It is the responsibility of the DESCRIPTION clause of the status column to indicate what an abnormally long period of time would be. This period of time should be long enough to allow for human response time (including `think time') between the creation of the conceptual row and the setting of the status to `active'. In the absence of such information in the DESCRIPTION clause, it is suggested that this period be approximately 5 minutes in length. This removal action applies not only to newly-created rows, but also to previously active rows which are set to, and left in, the notInService state for a prolonged period exceeding that which is considered normal for such a conceptual row. Conceptual Row Suspension When a conceptual row is `active', the management station may issue a management protocol set operation which sets the instance of the status column to `notInService'. If the agent is unwilling to do so, the set operation fails with an error of `wrongValue' or `inconsistentValue'. Otherwise, the conceptual row is taken out of service, and a `noError' response is returned. It is the responsibility of the DESCRIPTION clause of the status column to indicate under what circumstances the status column should be taken out of service (e.g., in order for the value of some other column of the same conceptual row to be modified). Conceptual Row Deletion For deletion of conceptual rows, a management protocol set operation is issued which sets the instance of the status column to `destroy'. This request may be made regardless of the current value of the status column (e.g., it is possible to delete conceptual rows which are either `notReady', `notInService' or `active'.) If the operation succeeds, then all instances associated with the conceptual row are immediately removed. · Integer32

An object that allows entries in this table to be created and deleted using the RowStatus convention.

Unsigned32 (1..4294967295)

An index for this entry that has local significance within the scope of this table.

Unsigned32 (1..4294967295)

This object identifies which row in 'nhrpCacheTable' is being purged. This object should have the same value as the 'nhrpCacheIndex' in the 'nhrpCacheTable'.

Integer32 (0..255)

In the case of NHRP Purge Requests, this specifies the equivalence class of addresses which match the first 'Prefix Length' bit positions of the Client Protocol Address specified in the Client Information Entry (CIE).

Unsigned32

The Request ID used in the purge request.

TruthValue1 = true2 = falseRepresents a boolean value. · Integer32

An indication of whether this Purge Request has the 'N' Bit cleared (off).

RowStatus1 = active2 = notInService3 = notReady4 = createAndGo5 = createAndWait6 = destroyThe 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 to a value other than 'active'. Also note that whenever any elements of a row exist, the RowStatus column must also exist. To summarize the effect of having a conceptual row with a status column having a SYNTAX clause value of RowStatus, consider the following state diagram: STATE +--------------+-----------+-------------+------------- | A | B | C | D | |status col.|status column| |status column | is | is |status column ACTION |does not exist| notReady | notInService| is active --------------+--------------+-----------+-------------+------------- set status |noError ->D|inconsist- |inconsistent-|inconsistent- column to | or | entValue| Value| Value createAndGo |inconsistent- | | | | Value| | | --------------+--------------+-----------+-------------+------------- set status |noError see 1|inconsist- |inconsistent-|inconsistent- column to | or | entValue| Value| Value createAndWait |wrongValue | | | --------------+--------------+-----------+-------------+------------- set status |inconsistent- |inconsist- |noError |noError column to | Value| entValue| | active | | | | | | or | | | | | | | |see 2 ->D|see 8 ->D| ->D --------------+--------------+-----------+-------------+------------- set status |inconsistent- |inconsist- |noError |noError ->C column to | Value| entValue| | notInService | | | | | | or | | or | | | | | |see 3 ->C| ->C|see 6 --------------+--------------+-----------+-------------+------------- set status |noError |noError |noError |noError ->A column to | | | | or destroy | ->A| ->A| ->A|see 7 --------------+--------------+-----------+-------------+------------- set any other |see 4 |noError |noError |see 5 column to some| | | | value | | see 1| ->C| ->D --------------+--------------+-----------+-------------+------------- (1) goto B or C, depending on information available to the agent. (2) if other variable bindings included in the same PDU, provide values for all columns which are missing but required, and all columns have acceptable values, then return noError and goto D. (3) if other variable bindings included in the same PDU, provide legal values for all columns which are missing but required, then return noError and goto C. (4) at the discretion of the agent, the return value may be either: inconsistentName: because the agent does not choose to create such an instance when the corresponding RowStatus instance does not exist, or inconsistentValue: if the supplied value is inconsistent with the state of some other MIB object's value, or noError: because the agent chooses to create the instance. If noError is returned, then the instance of the status column must also be created, and the new state is B or C, depending on the information available to the agent. If inconsistentName or inconsistentValue is returned, the row remains in state A. (5) depending on the MIB definition for the column/table, either noError or inconsistentValue may be returned. (6) the return value can indicate one of the following errors: wrongValue: because the agent does not support notInService (e.g., an agent which does not support createAndWait), or inconsistentValue: because the agent is unable to take the row out of service at this time, perhaps because it is in use and cannot be de-activated. (7) the return value can indicate the following error: inconsistentValue: because the agent is unable to remove the row at this time, perhaps because it is in use and cannot be de-activated. (8) the transition to D can fail, e.g., if the values of the conceptual row are inconsistent, then the error code would be inconsistentValue. NOTE: Other processing of (this and other varbinds of) the set request may result in a response other than noError being returned, e.g., wrongValue, noCreation, etc. Conceptual Row Creation There are four potential interactions when creating a conceptual row: selecting an instance-identifier which is not in use; creating the conceptual row; initializing any objects for which the agent does not supply a default; and, making the conceptual row available for use by the managed device. Interaction 1: Selecting an Instance-Identifier The algorithm used to select an instance-identifier varies for each conceptual row. In some cases, the instance- identifier is semantically significant, e.g., the destination address of a route, and a management station selects the instance-identifier according to the semantics. In other cases, the instance-identifier is used solely to distinguish conceptual rows, and a management station without specific knowledge of the conceptual row might examine the instances present in order to determine an unused instance-identifier. (This approach may be used, but it is often highly sub-optimal; however, it is also a questionable practice for a naive management station to attempt conceptual row creation.) Alternately, the MIB module which defines the conceptual row might provide one or more objects which provide assistance in determining an unused instance-identifier. For example, if the conceptual row is indexed by an integer-value, then an object having an integer-valued SYNTAX clause might be defined for such a purpose, allowing a management station to issue a management protocol retrieval operation. In order to avoid unnecessary collisions between competing management stations, `adjacent' retrievals of this object should be different. Finally, the management station could select a pseudo-random number to use as the index. In the event that this index was already in use and an inconsistentValue was returned in response to the management protocol set operation, the management station should simply select a new pseudo-random number and retry the operation. A MIB designer should choose between the two latter algorithms based on the size of the table (and therefore the efficiency of each algorithm). For tables in which a large number of entries are expected, it is recommended that a MIB object be defined that returns an acceptable index for creation. For tables with small numbers of entries, it is recommended that the latter pseudo-random index mechanism be used. Interaction 2: Creating the Conceptual Row Once an unused instance-identifier has been selected, the management station determines if it wishes to create and activate the conceptual row in one transaction or in a negotiated set of interactions. Interaction 2a: Creating and Activating the Conceptual Row The management station must first determine the column requirements, i.e., it must determine those columns for which it must or must not provide values. Depending on the complexity of the table and the management station's knowledge of the agent's capabilities, this determination can be made locally by the management station. Alternately, the management station issues a management protocol get operation to examine all columns in the conceptual row that it wishes to create. In response, for each column, there are three possible outcomes: - a value is returned, indicating that some other management station has already created this conceptual row. We return to interaction 1. - the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it should supply a value for this column when the conceptual row is to be created. - the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column. Once the column requirements have been determined, a management protocol set operation is accordingly issued. This operation also sets the new instance of the status column to `createAndGo'. When the agent processes the set operation, it verifies that it has sufficient information to make the conceptual row available for use by the managed device. The information available to the agent is provided by two sources: the management protocol set operation which creates the conceptual row, and, implementation-specific defaults supplied by the agent (note that an agent must provide implementation-specific defaults for at least those objects which it implements as read-only). If there is sufficient information available, then the conceptual row is created, a `noError' response is returned, the status column is set to `active', and no further interactions are necessary (i.e., interactions 3 and 4 are skipped). If there is insufficient information, then the conceptual row is not created, and the set operation fails with an error of `inconsistentValue'. On this error, the management station can issue a management protocol retrieval operation to determine if this was because it failed to specify a value for a required column, or, because the selected instance of the status column already existed. In the latter case, we return to interaction 1. In the former case, the management station can re-issue the set operation with the additional information, or begin interaction 2 again using `createAndWait' in order to negotiate creation of the conceptual row. NOTE WELL Regardless of the method used to determine the column requirements, it is possible that the management station might deem a column necessary when, in fact, the agent will not allow that particular columnar instance to be created or written. In this case, the management protocol set operation will fail with an error such as `noCreation' or `notWritable'. In this case, the management station decides whether it needs to be able to set a value for that particular columnar instance. If not, the management station re-issues the management protocol set operation, but without setting a value for that particular columnar instance; otherwise, the management station aborts the row creation algorithm. Interaction 2b: Negotiating the Creation of the Conceptual Row The management station issues a management protocol set operation which sets the desired instance of the status column to `createAndWait'. If the agent is unwilling to process a request of this sort, the set operation fails with an error of `wrongValue'. (As a consequence, such an agent must be prepared to accept a single management protocol set operation, i.e., interaction 2a above, containing all of the columns indicated by its column requirements.) Otherwise, the conceptual row is created, a `noError' response is returned, and the status column is immediately set to either `notInService' or `notReady', depending on whether it has sufficient information to (attempt to) make the conceptual row available for use by the managed device. If there is sufficient information available, then the status column is set to `notInService'; otherwise, if there is insufficient information, then the status column is set to `notReady'. Regardless, we proceed to interaction 3. Interaction 3: Initializing non-defaulted Objects The management station must now determine the column requirements. It issues a management protocol get operation to examine all columns in the created conceptual row. In the response, for each column, there are three possible outcomes: - a value is returned, indicating that the agent implements the object-type associated with this column and had sufficient information to provide a value. For those columns to which the agent provides read-create access (and for which the agent allows their values to be changed after their creation), a value return tells the management station that it may issue additional management protocol set operations, if it desires, in order to change the value associated with this column. - the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. However, the agent does not have sufficient information to provide a value, and until a value is provided, the conceptual row may not be made available for use by the managed device. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it must issue additional management protocol set operations, in order to provide a value associated with this column. - the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column. If the value associated with the status column is `notReady', then the management station must first deal with all `noSuchInstance' columns, if any. Having done so, the value of the status column becomes `notInService', and we proceed to interaction 4. Interaction 4: Making the Conceptual Row Available Once the management station is satisfied with the values associated with the columns of the conceptual row, it issues a management protocol set operation to set the status column to `active'. If the agent has sufficient information to make the conceptual row available for use by the managed device, the management protocol set operation succeeds (a `noError' response is returned). Otherwise, the management protocol set operation fails with an error of `inconsistentValue'. NOTE WELL A conceptual row having a status column with value `notInService' or `notReady' is unavailable to the managed device. As such, it is possible for the managed device to create its own instances during the time between the management protocol set operation which sets the status column to `createAndWait' and the management protocol set operation which sets the status column to `active'. In this case, when the management protocol set operation is issued to set the status column to `active', the values held in the agent supersede those used by the managed device. If the management station is prevented from setting the status column to `active' (e.g., due to management station or network failure) the conceptual row will be left in the `notInService' or `notReady' state, consuming resources indefinitely. The agent must detect conceptual rows that have been in either state for an abnormally long period of time and remove them. It is the responsibility of the DESCRIPTION clause of the status column to indicate what an abnormally long period of time would be. This period of time should be long enough to allow for human response time (including `think time') between the creation of the conceptual row and the setting of the status to `active'. In the absence of such information in the DESCRIPTION clause, it is suggested that this period be approximately 5 minutes in length. This removal action applies not only to newly-created rows, but also to previously active rows which are set to, and left in, the notInService state for a prolonged period exceeding that which is considered normal for such a conceptual row. Conceptual Row Suspension When a conceptual row is `active', the management station may issue a management protocol set operation which sets the instance of the status column to `notInService'. If the agent is unwilling to do so, the set operation fails with an error of `wrongValue' or `inconsistentValue'. Otherwise, the conceptual row is taken out of service, and a `noError' response is returned. It is the responsibility of the DESCRIPTION clause of the status column to indicate under what circumstances the status column should be taken out of service (e.g., in order for the value of some other column of the same conceptual row to be modified). Conceptual Row Deletion For deletion of conceptual rows, a management protocol set operation is issued which sets the instance of the status column to `destroy'. This request may be made regardless of the current value of the status column (e.g., it is possible to delete conceptual rows which are either `notReady', `notInService' or `active'.) If the operation succeeds, then all instances associated with the conceptual row are immediately removed. · Integer32

An object that allows entries in this table to be created and deleted using the RowStatus convention.

Unsigned32 (1..4294967295)

An identifier for the NHRP client that is unique within the scope of this agent. The 'nhrpNextIndex' value should be consulted (read), prior to creating a row in this table, and the value returned from reading 'nhrpNextIndex' should be used as this object's value.

AddressFamilyNumbers0 = other1 = ipV42 = ipV63 = nsap4 = hdlc5 = bbn18226 = all8027 = e1638 = e1649 = f6910 = x12111 = ipx12 = appleTalk13 = decnetIV14 = banyanVines15 = e164withNsap16 = dns17 = distinguishedName18 = asNumber19 = xtpOverIpv420 = xtpOverIpv621 = xtpNativeModeXTP22 = fibreChannelWWPN23 = fibreChannelWWNN24 = gwid25 = afi26 = mplsTpSectionEndpointIdentifier27 = mplsTpLspEndpointIdentifier28 = mplsTpPseudowireEndpointIdentifier16384 = eigrpCommonServiceFamily16385 = eigrpIpv4ServiceFamily16386 = eigrpIpv6ServiceFamily16387 = lispCanonicalAddressFormat16388 = bgpLs16389 = fortyeightBitMac16390 = sixtyfourBitMac16391 = oui16392 = mac2416393 = mac4016394 = ipv66416395 = rBridgePortID16396 = trillNickname16397 = universallyUniqueIdentifier65535 = reservedThe definition of this textual convention with the addition of newly assigned values is published periodically by the IANA, in either the Assigned Numbers RFC, or some derivative of it specific to Internet Network Management number assignments. (The latest arrangements can be obtained by contacting the IANA.) The enumerations are described as: other(0), -- none of the following ipV4(1), -- IP Version 4 ipV6(2), -- IP Version 6 nsap(3), -- NSAP hdlc(4), -- (8-bit multidrop) bbn1822(5), all802(6), -- (includes all 802 media -- plus Ethernet 'canonical format') e163(7), e164(8), -- (SMDS, Frame Relay, ATM) f69(9), -- (Telex) x121(10), -- (X.25, Frame Relay) ipx(11), -- IPX (Internet Protocol Exchange) appleTalk(12), -- Apple Talk decnetIV(13), -- DEC Net Phase IV banyanVines(14), -- Banyan Vines e164withNsap(15), -- (E.164 with NSAP format subaddress) dns(16), -- (Domain Name System) distinguishedName(17), -- (Distinguished Name, per X.500) asNumber(18), -- (16-bit quantity, per the AS number space) xtpOverIpv4(19), -- XTP over IP version 4 xtpOverIpv6(20), -- XTP over IP version 6 xtpNativeModeXTP(21), -- XTP native mode XTP fibreChannelWWPN(22), -- Fibre Channel World-Wide Port Name fibreChannelWWNN(23), -- Fibre Channel World-Wide Node Name gwid(24), -- Gateway Identifier afi(25), -- AFI for L2VPN information mplsTpSectionEndpointIdentifier(26), -- MPLS-TP Section Endpoint Identifier mplsTpLspEndpointIdentifier(27), -- MPLS-TP LSP Endpoint Identifier mplsTpPseudowireEndpointIdentifier(28), -- MPLS-TP Pseudowire Endpoint Identifier eigrpCommonServiceFamily(16384), -- EIGRP Common Service Family eigrpIpv4ServiceFamily(16385), -- EIGRP IPv4 Service Family eigrpIpv6ServiceFamily(16386), -- EIGRP IPv6 Service Family lispCanonicalAddressFormat(16387), -- LISP Canonical Address Format (LCAF) bgpLs(16388), -- BGP-LS fortyeightBitMacBitMac(16389), -- 48-bit MAC sixtyfourBitMac(16390), -- 64-bit MAC oui(16391), -- OUI mac24(16392), -- MAC/24 mac40(16393), -- MAC/40 ipv664(16394), -- IPv6/64 rBridgePortID(16395), -- RBridge Port ID trillNickname(16396), -- TRILL Nickname universallyUniqueIdentifier(16397), -- Universally Unique Identifier (UUID) reserved(65535) Requests for new values should be made to IANA via email (iana&iana.org). · Integer32

The type of the internetwork layer address of this client. This object indicates how the value of nhrpClientInternetworkAddr is to be interpreted.

NhrpGenAddrThe value of an internetwork layer or NBMA address. SIZE (0..64) · OCTET STRING

The value of the internetwork layer address of this client.

AddressFamilyNumbers0 = other1 = ipV42 = ipV63 = nsap4 = hdlc5 = bbn18226 = all8027 = e1638 = e1649 = f6910 = x12111 = ipx12 = appleTalk13 = decnetIV14 = banyanVines15 = e164withNsap16 = dns17 = distinguishedName18 = asNumber19 = xtpOverIpv420 = xtpOverIpv621 = xtpNativeModeXTP22 = fibreChannelWWPN23 = fibreChannelWWNN24 = gwid25 = afi26 = mplsTpSectionEndpointIdentifier27 = mplsTpLspEndpointIdentifier28 = mplsTpPseudowireEndpointIdentifier16384 = eigrpCommonServiceFamily16385 = eigrpIpv4ServiceFamily16386 = eigrpIpv6ServiceFamily16387 = lispCanonicalAddressFormat16388 = bgpLs16389 = fortyeightBitMac16390 = sixtyfourBitMac16391 = oui16392 = mac2416393 = mac4016394 = ipv66416395 = rBridgePortID16396 = trillNickname16397 = universallyUniqueIdentifier65535 = reservedThe definition of this textual convention with the addition of newly assigned values is published periodically by the IANA, in either the Assigned Numbers RFC, or some derivative of it specific to Internet Network Management number assignments. (The latest arrangements can be obtained by contacting the IANA.) The enumerations are described as: other(0), -- none of the following ipV4(1), -- IP Version 4 ipV6(2), -- IP Version 6 nsap(3), -- NSAP hdlc(4), -- (8-bit multidrop) bbn1822(5), all802(6), -- (includes all 802 media -- plus Ethernet 'canonical format') e163(7), e164(8), -- (SMDS, Frame Relay, ATM) f69(9), -- (Telex) x121(10), -- (X.25, Frame Relay) ipx(11), -- IPX (Internet Protocol Exchange) appleTalk(12), -- Apple Talk decnetIV(13), -- DEC Net Phase IV banyanVines(14), -- Banyan Vines e164withNsap(15), -- (E.164 with NSAP format subaddress) dns(16), -- (Domain Name System) distinguishedName(17), -- (Distinguished Name, per X.500) asNumber(18), -- (16-bit quantity, per the AS number space) xtpOverIpv4(19), -- XTP over IP version 4 xtpOverIpv6(20), -- XTP over IP version 6 xtpNativeModeXTP(21), -- XTP native mode XTP fibreChannelWWPN(22), -- Fibre Channel World-Wide Port Name fibreChannelWWNN(23), -- Fibre Channel World-Wide Node Name gwid(24), -- Gateway Identifier afi(25), -- AFI for L2VPN information mplsTpSectionEndpointIdentifier(26), -- MPLS-TP Section Endpoint Identifier mplsTpLspEndpointIdentifier(27), -- MPLS-TP LSP Endpoint Identifier mplsTpPseudowireEndpointIdentifier(28), -- MPLS-TP Pseudowire Endpoint Identifier eigrpCommonServiceFamily(16384), -- EIGRP Common Service Family eigrpIpv4ServiceFamily(16385), -- EIGRP IPv4 Service Family eigrpIpv6ServiceFamily(16386), -- EIGRP IPv6 Service Family lispCanonicalAddressFormat(16387), -- LISP Canonical Address Format (LCAF) bgpLs(16388), -- BGP-LS fortyeightBitMacBitMac(16389), -- 48-bit MAC sixtyfourBitMac(16390), -- 64-bit MAC oui(16391), -- OUI mac24(16392), -- MAC/24 mac40(16393), -- MAC/40 ipv664(16394), -- IPv6/64 rBridgePortID(16395), -- RBridge Port ID trillNickname(16396), -- TRILL Nickname universallyUniqueIdentifier(16397), -- Universally Unique Identifier (UUID) reserved(65535) Requests for new values should be made to IANA via email (iana&iana.org). · Integer32

The type of the NBMA subnetwork address of this client. This object indicates how the values of nhrpClientNbmaAddr and nhrpClientNbmaSubaddr are to be interpreted.

NhrpGenAddrThe value of an internetwork layer or NBMA address. SIZE (0..64) · OCTET STRING

The NBMA subnetwork address of this client.

NhrpGenAddrThe value of an internetwork layer or NBMA address. SIZE (0..64) · OCTET STRING

The NBMA subaddress of this client. For NBMA address families without a subaddress concept, this will be a zero-length OCTET STRING.

Integer32 (1..900) · seconds

The number of seconds that the client will wait before timing out an NHRP initial request. This object only has meaning for the initial timeout period.

Integer32 (0..65535)

The number of times the client will retry the registration request before failure. A value of 0 means don't retry. A value of 65535 means retry forever.

Integer32 (0..65535)

The number of times the client will retry the resolution request before failure. A value of 0 means don't retry. A value of 65535 means retry forever.

Integer32 (0..65535)

The number of times the client will retry a purge request before failure. A value of 0 means don't retry. A value of 65535 means retry forever.

Unsigned32 (0..65535)

The default maximum transmission unit (MTU) of the LIS/LAG which this client should use. This object will be initialized by the agent to the default MTU of the LIS/LAG (which is 9180) unless a different MTU value is specified during creation of this Client. ⓘ

Unsigned32 (0..65535) · seconds

The hold time the client will register.

Unsigned32

The Request ID used to register this client with its server. According to Section 5.2.3 of the NHRP Specification, RFC 2332 [17], the Request ID must be kept in non-volatile storage, so that if an NHC crashes and re-initializes, it will use a different Request ID during the registration process when reregistering with the same NHS. ⓘ

StorageType1 = other2 = volatile3 = nonVolatile4 = permanent5 = readOnlyDescribes 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. · Integer32

This object defines whether this row is kept in volatile storage and lost upon a Client crash or reboot situation, or if this row is backed up by nonvolatile or permanent storage.

RowStatus1 = active2 = notInService3 = notReady4 = createAndGo5 = createAndWait6 = destroyThe 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 to a value other than 'active'. Also note that whenever any elements of a row exist, the RowStatus column must also exist. To summarize the effect of having a conceptual row with a status column having a SYNTAX clause value of RowStatus, consider the following state diagram: STATE +--------------+-----------+-------------+------------- | A | B | C | D | |status col.|status column| |status column | is | is |status column ACTION |does not exist| notReady | notInService| is active --------------+--------------+-----------+-------------+------------- set status |noError ->D|inconsist- |inconsistent-|inconsistent- column to | or | entValue| Value| Value createAndGo |inconsistent- | | | | Value| | | --------------+--------------+-----------+-------------+------------- set status |noError see 1|inconsist- |inconsistent-|inconsistent- column to | or | entValue| Value| Value createAndWait |wrongValue | | | --------------+--------------+-----------+-------------+------------- set status |inconsistent- |inconsist- |noError |noError column to | Value| entValue| | active | | | | | | or | | | | | | | |see 2 ->D|see 8 ->D| ->D --------------+--------------+-----------+-------------+------------- set status |inconsistent- |inconsist- |noError |noError ->C column to | Value| entValue| | notInService | | | | | | or | | or | | | | | |see 3 ->C| ->C|see 6 --------------+--------------+-----------+-------------+------------- set status |noError |noError |noError |noError ->A column to | | | | or destroy | ->A| ->A| ->A|see 7 --------------+--------------+-----------+-------------+------------- set any other |see 4 |noError |noError |see 5 column to some| | | | value | | see 1| ->C| ->D --------------+--------------+-----------+-------------+------------- (1) goto B or C, depending on information available to the agent. (2) if other variable bindings included in the same PDU, provide values for all columns which are missing but required, and all columns have acceptable values, then return noError and goto D. (3) if other variable bindings included in the same PDU, provide legal values for all columns which are missing but required, then return noError and goto C. (4) at the discretion of the agent, the return value may be either: inconsistentName: because the agent does not choose to create such an instance when the corresponding RowStatus instance does not exist, or inconsistentValue: if the supplied value is inconsistent with the state of some other MIB object's value, or noError: because the agent chooses to create the instance. If noError is returned, then the instance of the status column must also be created, and the new state is B or C, depending on the information available to the agent. If inconsistentName or inconsistentValue is returned, the row remains in state A. (5) depending on the MIB definition for the column/table, either noError or inconsistentValue may be returned. (6) the return value can indicate one of the following errors: wrongValue: because the agent does not support notInService (e.g., an agent which does not support createAndWait), or inconsistentValue: because the agent is unable to take the row out of service at this time, perhaps because it is in use and cannot be de-activated. (7) the return value can indicate the following error: inconsistentValue: because the agent is unable to remove the row at this time, perhaps because it is in use and cannot be de-activated. (8) the transition to D can fail, e.g., if the values of the conceptual row are inconsistent, then the error code would be inconsistentValue. NOTE: Other processing of (this and other varbinds of) the set request may result in a response other than noError being returned, e.g., wrongValue, noCreation, etc. Conceptual Row Creation There are four potential interactions when creating a conceptual row: selecting an instance-identifier which is not in use; creating the conceptual row; initializing any objects for which the agent does not supply a default; and, making the conceptual row available for use by the managed device. Interaction 1: Selecting an Instance-Identifier The algorithm used to select an instance-identifier varies for each conceptual row. In some cases, the instance- identifier is semantically significant, e.g., the destination address of a route, and a management station selects the instance-identifier according to the semantics. In other cases, the instance-identifier is used solely to distinguish conceptual rows, and a management station without specific knowledge of the conceptual row might examine the instances present in order to determine an unused instance-identifier. (This approach may be used, but it is often highly sub-optimal; however, it is also a questionable practice for a naive management station to attempt conceptual row creation.) Alternately, the MIB module which defines the conceptual row might provide one or more objects which provide assistance in determining an unused instance-identifier. For example, if the conceptual row is indexed by an integer-value, then an object having an integer-valued SYNTAX clause might be defined for such a purpose, allowing a management station to issue a management protocol retrieval operation. In order to avoid unnecessary collisions between competing management stations, `adjacent' retrievals of this object should be different. Finally, the management station could select a pseudo-random number to use as the index. In the event that this index was already in use and an inconsistentValue was returned in response to the management protocol set operation, the management station should simply select a new pseudo-random number and retry the operation. A MIB designer should choose between the two latter algorithms based on the size of the table (and therefore the efficiency of each algorithm). For tables in which a large number of entries are expected, it is recommended that a MIB object be defined that returns an acceptable index for creation. For tables with small numbers of entries, it is recommended that the latter pseudo-random index mechanism be used. Interaction 2: Creating the Conceptual Row Once an unused instance-identifier has been selected, the management station determines if it wishes to create and activate the conceptual row in one transaction or in a negotiated set of interactions. Interaction 2a: Creating and Activating the Conceptual Row The management station must first determine the column requirements, i.e., it must determine those columns for which it must or must not provide values. Depending on the complexity of the table and the management station's knowledge of the agent's capabilities, this determination can be made locally by the management station. Alternately, the management station issues a management protocol get operation to examine all columns in the conceptual row that it wishes to create. In response, for each column, there are three possible outcomes: - a value is returned, indicating that some other management station has already created this conceptual row. We return to interaction 1. - the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it should supply a value for this column when the conceptual row is to be created. - the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column. Once the column requirements have been determined, a management protocol set operation is accordingly issued. This operation also sets the new instance of the status column to `createAndGo'. When the agent processes the set operation, it verifies that it has sufficient information to make the conceptual row available for use by the managed device. The information available to the agent is provided by two sources: the management protocol set operation which creates the conceptual row, and, implementation-specific defaults supplied by the agent (note that an agent must provide implementation-specific defaults for at least those objects which it implements as read-only). If there is sufficient information available, then the conceptual row is created, a `noError' response is returned, the status column is set to `active', and no further interactions are necessary (i.e., interactions 3 and 4 are skipped). If there is insufficient information, then the conceptual row is not created, and the set operation fails with an error of `inconsistentValue'. On this error, the management station can issue a management protocol retrieval operation to determine if this was because it failed to specify a value for a required column, or, because the selected instance of the status column already existed. In the latter case, we return to interaction 1. In the former case, the management station can re-issue the set operation with the additional information, or begin interaction 2 again using `createAndWait' in order to negotiate creation of the conceptual row. NOTE WELL Regardless of the method used to determine the column requirements, it is possible that the management station might deem a column necessary when, in fact, the agent will not allow that particular columnar instance to be created or written. In this case, the management protocol set operation will fail with an error such as `noCreation' or `notWritable'. In this case, the management station decides whether it needs to be able to set a value for that particular columnar instance. If not, the management station re-issues the management protocol set operation, but without setting a value for that particular columnar instance; otherwise, the management station aborts the row creation algorithm. Interaction 2b: Negotiating the Creation of the Conceptual Row The management station issues a management protocol set operation which sets the desired instance of the status column to `createAndWait'. If the agent is unwilling to process a request of this sort, the set operation fails with an error of `wrongValue'. (As a consequence, such an agent must be prepared to accept a single management protocol set operation, i.e., interaction 2a above, containing all of the columns indicated by its column requirements.) Otherwise, the conceptual row is created, a `noError' response is returned, and the status column is immediately set to either `notInService' or `notReady', depending on whether it has sufficient information to (attempt to) make the conceptual row available for use by the managed device. If there is sufficient information available, then the status column is set to `notInService'; otherwise, if there is insufficient information, then the status column is set to `notReady'. Regardless, we proceed to interaction 3. Interaction 3: Initializing non-defaulted Objects The management station must now determine the column requirements. It issues a management protocol get operation to examine all columns in the created conceptual row. In the response, for each column, there are three possible outcomes: - a value is returned, indicating that the agent implements the object-type associated with this column and had sufficient information to provide a value. For those columns to which the agent provides read-create access (and for which the agent allows their values to be changed after their creation), a value return tells the management station that it may issue additional management protocol set operations, if it desires, in order to change the value associated with this column. - the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. However, the agent does not have sufficient information to provide a value, and until a value is provided, the conceptual row may not be made available for use by the managed device. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it must issue additional management protocol set operations, in order to provide a value associated with this column. - the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column. If the value associated with the status column is `notReady', then the management station must first deal with all `noSuchInstance' columns, if any. Having done so, the value of the status column becomes `notInService', and we proceed to interaction 4. Interaction 4: Making the Conceptual Row Available Once the management station is satisfied with the values associated with the columns of the conceptual row, it issues a management protocol set operation to set the status column to `active'. If the agent has sufficient information to make the conceptual row available for use by the managed device, the management protocol set operation succeeds (a `noError' response is returned). Otherwise, the management protocol set operation fails with an error of `inconsistentValue'. NOTE WELL A conceptual row having a status column with value `notInService' or `notReady' is unavailable to the managed device. As such, it is possible for the managed device to create its own instances during the time between the management protocol set operation which sets the status column to `createAndWait' and the management protocol set operation which sets the status column to `active'. In this case, when the management protocol set operation is issued to set the status column to `active', the values held in the agent supersede those used by the managed device. If the management station is prevented from setting the status column to `active' (e.g., due to management station or network failure) the conceptual row will be left in the `notInService' or `notReady' state, consuming resources indefinitely. The agent must detect conceptual rows that have been in either state for an abnormally long period of time and remove them. It is the responsibility of the DESCRIPTION clause of the status column to indicate what an abnormally long period of time would be. This period of time should be long enough to allow for human response time (including `think time') between the creation of the conceptual row and the setting of the status to `active'. In the absence of such information in the DESCRIPTION clause, it is suggested that this period be approximately 5 minutes in length. This removal action applies not only to newly-created rows, but also to previously active rows which are set to, and left in, the notInService state for a prolonged period exceeding that which is considered normal for such a conceptual row. Conceptual Row Suspension When a conceptual row is `active', the management station may issue a management protocol set operation which sets the instance of the status column to `notInService'. If the agent is unwilling to do so, the set operation fails with an error of `wrongValue' or `inconsistentValue'. Otherwise, the conceptual row is taken out of service, and a `noError' response is returned. It is the responsibility of the DESCRIPTION clause of the status column to indicate under what circumstances the status column should be taken out of service (e.g., in order for the value of some other column of the same conceptual row to be modified). Conceptual Row Deletion For deletion of conceptual rows, a management protocol set operation is issued which sets the instance of the status column to `destroy'. This request may be made regardless of the current value of the status column (e.g., it is possible to delete conceptual rows which are either `notReady', `notInService' or `active'.) If the operation succeeds, then all instances associated with the conceptual row are immediately removed. · Integer32

An object that allows entries in this table to be created and deleted using the RowStatus convention.

Unsigned32 (1..4294967295)

An identifier for this entry such that it identifies a specific Registration Request from the NHC represented by the nhrpClientIndex.

INTEGER1 = requestUnique2 = requestNotUnique · Integer32

The Uniqueness indicator for this Registration Request. If this object has the value of requestUnique(1), then the Uniqueness bit is set in the the NHRP Registration Request represented by this row. The value cannot be changed once the row is created.

INTEGER1 = other2 = registering3 = ackRegisterReply4 = nakRegisterReply · Integer32

The registration state of this client. The values are: 'other(1)' The state of the registration request is not one of 'registering', 'ackRegisterReply' or 'nakRegisterReply'. 'registering(2)' A registration request has been issued and a registration reply is expected. 'ackRegisterReply(3)' A positive registration reply has been received. 'nakRegisterReply(4)' The client has received a negative registration reply (NAK).

RowStatus1 = active2 = notInService3 = notReady4 = createAndGo5 = createAndWait6 = destroyThe 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 to a value other than 'active'. Also note that whenever any elements of a row exist, the RowStatus column must also exist. To summarize the effect of having a conceptual row with a status column having a SYNTAX clause value of RowStatus, consider the following state diagram: STATE +--------------+-----------+-------------+------------- | A | B | C | D | |status col.|status column| |status column | is | is |status column ACTION |does not exist| notReady | notInService| is active --------------+--------------+-----------+-------------+------------- set status |noError ->D|inconsist- |inconsistent-|inconsistent- column to | or | entValue| Value| Value createAndGo |inconsistent- | | | | Value| | | --------------+--------------+-----------+-------------+------------- set status |noError see 1|inconsist- |inconsistent-|inconsistent- column to | or | entValue| Value| Value createAndWait |wrongValue | | | --------------+--------------+-----------+-------------+------------- set status |inconsistent- |inconsist- |noError |noError column to | Value| entValue| | active | | | | | | or | | | | | | | |see 2 ->D|see 8 ->D| ->D --------------+--------------+-----------+-------------+------------- set status |inconsistent- |inconsist- |noError |noError ->C column to | Value| entValue| | notInService | | | | | | or | | or | | | | | |see 3 ->C| ->C|see 6 --------------+--------------+-----------+-------------+------------- set status |noError |noError |noError |noError ->A column to | | | | or destroy | ->A| ->A| ->A|see 7 --------------+--------------+-----------+-------------+------------- set any other |see 4 |noError |noError |see 5 column to some| | | | value | | see 1| ->C| ->D --------------+--------------+-----------+-------------+------------- (1) goto B or C, depending on information available to the agent. (2) if other variable bindings included in the same PDU, provide values for all columns which are missing but required, and all columns have acceptable values, then return noError and goto D. (3) if other variable bindings included in the same PDU, provide legal values for all columns which are missing but required, then return noError and goto C. (4) at the discretion of the agent, the return value may be either: inconsistentName: because the agent does not choose to create such an instance when the corresponding RowStatus instance does not exist, or inconsistentValue: if the supplied value is inconsistent with the state of some other MIB object's value, or noError: because the agent chooses to create the instance. If noError is returned, then the instance of the status column must also be created, and the new state is B or C, depending on the information available to the agent. If inconsistentName or inconsistentValue is returned, the row remains in state A. (5) depending on the MIB definition for the column/table, either noError or inconsistentValue may be returned. (6) the return value can indicate one of the following errors: wrongValue: because the agent does not support notInService (e.g., an agent which does not support createAndWait), or inconsistentValue: because the agent is unable to take the row out of service at this time, perhaps because it is in use and cannot be de-activated. (7) the return value can indicate the following error: inconsistentValue: because the agent is unable to remove the row at this time, perhaps because it is in use and cannot be de-activated. (8) the transition to D can fail, e.g., if the values of the conceptual row are inconsistent, then the error code would be inconsistentValue. NOTE: Other processing of (this and other varbinds of) the set request may result in a response other than noError being returned, e.g., wrongValue, noCreation, etc. Conceptual Row Creation There are four potential interactions when creating a conceptual row: selecting an instance-identifier which is not in use; creating the conceptual row; initializing any objects for which the agent does not supply a default; and, making the conceptual row available for use by the managed device. Interaction 1: Selecting an Instance-Identifier The algorithm used to select an instance-identifier varies for each conceptual row. In some cases, the instance- identifier is semantically significant, e.g., the destination address of a route, and a management station selects the instance-identifier according to the semantics. In other cases, the instance-identifier is used solely to distinguish conceptual rows, and a management station without specific knowledge of the conceptual row might examine the instances present in order to determine an unused instance-identifier. (This approach may be used, but it is often highly sub-optimal; however, it is also a questionable practice for a naive management station to attempt conceptual row creation.) Alternately, the MIB module which defines the conceptual row might provide one or more objects which provide assistance in determining an unused instance-identifier. For example, if the conceptual row is indexed by an integer-value, then an object having an integer-valued SYNTAX clause might be defined for such a purpose, allowing a management station to issue a management protocol retrieval operation. In order to avoid unnecessary collisions between competing management stations, `adjacent' retrievals of this object should be different. Finally, the management station could select a pseudo-random number to use as the index. In the event that this index was already in use and an inconsistentValue was returned in response to the management protocol set operation, the management station should simply select a new pseudo-random number and retry the operation. A MIB designer should choose between the two latter algorithms based on the size of the table (and therefore the efficiency of each algorithm). For tables in which a large number of entries are expected, it is recommended that a MIB object be defined that returns an acceptable index for creation. For tables with small numbers of entries, it is recommended that the latter pseudo-random index mechanism be used. Interaction 2: Creating the Conceptual Row Once an unused instance-identifier has been selected, the management station determines if it wishes to create and activate the conceptual row in one transaction or in a negotiated set of interactions. Interaction 2a: Creating and Activating the Conceptual Row The management station must first determine the column requirements, i.e., it must determine those columns for which it must or must not provide values. Depending on the complexity of the table and the management station's knowledge of the agent's capabilities, this determination can be made locally by the management station. Alternately, the management station issues a management protocol get operation to examine all columns in the conceptual row that it wishes to create. In response, for each column, there are three possible outcomes: - a value is returned, indicating that some other management station has already created this conceptual row. We return to interaction 1. - the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it should supply a value for this column when the conceptual row is to be created. - the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column. Once the column requirements have been determined, a management protocol set operation is accordingly issued. This operation also sets the new instance of the status column to `createAndGo'. When the agent processes the set operation, it verifies that it has sufficient information to make the conceptual row available for use by the managed device. The information available to the agent is provided by two sources: the management protocol set operation which creates the conceptual row, and, implementation-specific defaults supplied by the agent (note that an agent must provide implementation-specific defaults for at least those objects which it implements as read-only). If there is sufficient information available, then the conceptual row is created, a `noError' response is returned, the status column is set to `active', and no further interactions are necessary (i.e., interactions 3 and 4 are skipped). If there is insufficient information, then the conceptual row is not created, and the set operation fails with an error of `inconsistentValue'. On this error, the management station can issue a management protocol retrieval operation to determine if this was because it failed to specify a value for a required column, or, because the selected instance of the status column already existed. In the latter case, we return to interaction 1. In the former case, the management station can re-issue the set operation with the additional information, or begin interaction 2 again using `createAndWait' in order to negotiate creation of the conceptual row. NOTE WELL Regardless of the method used to determine the column requirements, it is possible that the management station might deem a column necessary when, in fact, the agent will not allow that particular columnar instance to be created or written. In this case, the management protocol set operation will fail with an error such as `noCreation' or `notWritable'. In this case, the management station decides whether it needs to be able to set a value for that particular columnar instance. If not, the management station re-issues the management protocol set operation, but without setting a value for that particular columnar instance; otherwise, the management station aborts the row creation algorithm. Interaction 2b: Negotiating the Creation of the Conceptual Row The management station issues a management protocol set operation which sets the desired instance of the status column to `createAndWait'. If the agent is unwilling to process a request of this sort, the set operation fails with an error of `wrongValue'. (As a consequence, such an agent must be prepared to accept a single management protocol set operation, i.e., interaction 2a above, containing all of the columns indicated by its column requirements.) Otherwise, the conceptual row is created, a `noError' response is returned, and the status column is immediately set to either `notInService' or `notReady', depending on whether it has sufficient information to (attempt to) make the conceptual row available for use by the managed device. If there is sufficient information available, then the status column is set to `notInService'; otherwise, if there is insufficient information, then the status column is set to `notReady'. Regardless, we proceed to interaction 3. Interaction 3: Initializing non-defaulted Objects The management station must now determine the column requirements. It issues a management protocol get operation to examine all columns in the created conceptual row. In the response, for each column, there are three possible outcomes: - a value is returned, indicating that the agent implements the object-type associated with this column and had sufficient information to provide a value. For those columns to which the agent provides read-create access (and for which the agent allows their values to be changed after their creation), a value return tells the management station that it may issue additional management protocol set operations, if it desires, in order to change the value associated with this column. - the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. However, the agent does not have sufficient information to provide a value, and until a value is provided, the conceptual row may not be made available for use by the managed device. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it must issue additional management protocol set operations, in order to provide a value associated with this column. - the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column. If the value associated with the status column is `notReady', then the management station must first deal with all `noSuchInstance' columns, if any. Having done so, the value of the status column becomes `notInService', and we proceed to interaction 4. Interaction 4: Making the Conceptual Row Available Once the management station is satisfied with the values associated with the columns of the conceptual row, it issues a management protocol set operation to set the status column to `active'. If the agent has sufficient information to make the conceptual row available for use by the managed device, the management protocol set operation succeeds (a `noError' response is returned). Otherwise, the management protocol set operation fails with an error of `inconsistentValue'. NOTE WELL A conceptual row having a status column with value `notInService' or `notReady' is unavailable to the managed device. As such, it is possible for the managed device to create its own instances during the time between the management protocol set operation which sets the status column to `createAndWait' and the management protocol set operation which sets the status column to `active'. In this case, when the management protocol set operation is issued to set the status column to `active', the values held in the agent supersede those used by the managed device. If the management station is prevented from setting the status column to `active' (e.g., due to management station or network failure) the conceptual row will be left in the `notInService' or `notReady' state, consuming resources indefinitely. The agent must detect conceptual rows that have been in either state for an abnormally long period of time and remove them. It is the responsibility of the DESCRIPTION clause of the status column to indicate what an abnormally long period of time would be. This period of time should be long enough to allow for human response time (including `think time') between the creation of the conceptual row and the setting of the status to `active'. In the absence of such information in the DESCRIPTION clause, it is suggested that this period be approximately 5 minutes in length. This removal action applies not only to newly-created rows, but also to previously active rows which are set to, and left in, the notInService state for a prolonged period exceeding that which is considered normal for such a conceptual row. Conceptual Row Suspension When a conceptual row is `active', the management station may issue a management protocol set operation which sets the instance of the status column to `notInService'. If the agent is unwilling to do so, the set operation fails with an error of `wrongValue' or `inconsistentValue'. Otherwise, the conceptual row is taken out of service, and a `noError' response is returned. It is the responsibility of the DESCRIPTION clause of the status column to indicate under what circumstances the status column should be taken out of service (e.g., in order for the value of some other column of the same conceptual row to be modified). Conceptual Row Deletion For deletion of conceptual rows, a management protocol set operation is issued which sets the instance of the status column to `destroy'. This request may be made regardless of the current value of the status column (e.g., it is possible to delete conceptual rows which are either `notReady', `notInService' or `active'.) If the operation succeeds, then all instances associated with the conceptual row are immediately removed. · Integer32

An object that allows entries in this table to be created and deleted using the RowStatus convention.

Unsigned32 (1..4294967295)

An identifier for an NHS available to an NHC.

AddressFamilyNumbers0 = other1 = ipV42 = ipV63 = nsap4 = hdlc5 = bbn18226 = all8027 = e1638 = e1649 = f6910 = x12111 = ipx12 = appleTalk13 = decnetIV14 = banyanVines15 = e164withNsap16 = dns17 = distinguishedName18 = asNumber19 = xtpOverIpv420 = xtpOverIpv621 = xtpNativeModeXTP22 = fibreChannelWWPN23 = fibreChannelWWNN24 = gwid25 = afi26 = mplsTpSectionEndpointIdentifier27 = mplsTpLspEndpointIdentifier28 = mplsTpPseudowireEndpointIdentifier16384 = eigrpCommonServiceFamily16385 = eigrpIpv4ServiceFamily16386 = eigrpIpv6ServiceFamily16387 = lispCanonicalAddressFormat16388 = bgpLs16389 = fortyeightBitMac16390 = sixtyfourBitMac16391 = oui16392 = mac2416393 = mac4016394 = ipv66416395 = rBridgePortID16396 = trillNickname16397 = universallyUniqueIdentifier65535 = reservedThe definition of this textual convention with the addition of newly assigned values is published periodically by the IANA, in either the Assigned Numbers RFC, or some derivative of it specific to Internet Network Management number assignments. (The latest arrangements can be obtained by contacting the IANA.) The enumerations are described as: other(0), -- none of the following ipV4(1), -- IP Version 4 ipV6(2), -- IP Version 6 nsap(3), -- NSAP hdlc(4), -- (8-bit multidrop) bbn1822(5), all802(6), -- (includes all 802 media -- plus Ethernet 'canonical format') e163(7), e164(8), -- (SMDS, Frame Relay, ATM) f69(9), -- (Telex) x121(10), -- (X.25, Frame Relay) ipx(11), -- IPX (Internet Protocol Exchange) appleTalk(12), -- Apple Talk decnetIV(13), -- DEC Net Phase IV banyanVines(14), -- Banyan Vines e164withNsap(15), -- (E.164 with NSAP format subaddress) dns(16), -- (Domain Name System) distinguishedName(17), -- (Distinguished Name, per X.500) asNumber(18), -- (16-bit quantity, per the AS number space) xtpOverIpv4(19), -- XTP over IP version 4 xtpOverIpv6(20), -- XTP over IP version 6 xtpNativeModeXTP(21), -- XTP native mode XTP fibreChannelWWPN(22), -- Fibre Channel World-Wide Port Name fibreChannelWWNN(23), -- Fibre Channel World-Wide Node Name gwid(24), -- Gateway Identifier afi(25), -- AFI for L2VPN information mplsTpSectionEndpointIdentifier(26), -- MPLS-TP Section Endpoint Identifier mplsTpLspEndpointIdentifier(27), -- MPLS-TP LSP Endpoint Identifier mplsTpPseudowireEndpointIdentifier(28), -- MPLS-TP Pseudowire Endpoint Identifier eigrpCommonServiceFamily(16384), -- EIGRP Common Service Family eigrpIpv4ServiceFamily(16385), -- EIGRP IPv4 Service Family eigrpIpv6ServiceFamily(16386), -- EIGRP IPv6 Service Family lispCanonicalAddressFormat(16387), -- LISP Canonical Address Format (LCAF) bgpLs(16388), -- BGP-LS fortyeightBitMacBitMac(16389), -- 48-bit MAC sixtyfourBitMac(16390), -- 64-bit MAC oui(16391), -- OUI mac24(16392), -- MAC/24 mac40(16393), -- MAC/40 ipv664(16394), -- IPv6/64 rBridgePortID(16395), -- RBridge Port ID trillNickname(16396), -- TRILL Nickname universallyUniqueIdentifier(16397), -- Universally Unique Identifier (UUID) reserved(65535) Requests for new values should be made to IANA via email (iana&iana.org). · Integer32

The type of the internetwork layer address of the NHRP server represented in this entry. This object indicates how the value of nhrpClientNhsInternetworkAddr is to be interpreted.

NhrpGenAddrThe value of an internetwork layer or NBMA address. SIZE (0..64) · OCTET STRING

The value of the destination internetwork layer address of the NHRP server represented by this entry. If this value is not known, this will be a zero-length OCTET STRING.

AddressFamilyNumbers0 = other1 = ipV42 = ipV63 = nsap4 = hdlc5 = bbn18226 = all8027 = e1638 = e1649 = f6910 = x12111 = ipx12 = appleTalk13 = decnetIV14 = banyanVines15 = e164withNsap16 = dns17 = distinguishedName18 = asNumber19 = xtpOverIpv420 = xtpOverIpv621 = xtpNativeModeXTP22 = fibreChannelWWPN23 = fibreChannelWWNN24 = gwid25 = afi26 = mplsTpSectionEndpointIdentifier27 = mplsTpLspEndpointIdentifier28 = mplsTpPseudowireEndpointIdentifier16384 = eigrpCommonServiceFamily16385 = eigrpIpv4ServiceFamily16386 = eigrpIpv6ServiceFamily16387 = lispCanonicalAddressFormat16388 = bgpLs16389 = fortyeightBitMac16390 = sixtyfourBitMac16391 = oui16392 = mac2416393 = mac4016394 = ipv66416395 = rBridgePortID16396 = trillNickname16397 = universallyUniqueIdentifier65535 = reservedThe definition of this textual convention with the addition of newly assigned values is published periodically by the IANA, in either the Assigned Numbers RFC, or some derivative of it specific to Internet Network Management number assignments. (The latest arrangements can be obtained by contacting the IANA.) The enumerations are described as: other(0), -- none of the following ipV4(1), -- IP Version 4 ipV6(2), -- IP Version 6 nsap(3), -- NSAP hdlc(4), -- (8-bit multidrop) bbn1822(5), all802(6), -- (includes all 802 media -- plus Ethernet 'canonical format') e163(7), e164(8), -- (SMDS, Frame Relay, ATM) f69(9), -- (Telex) x121(10), -- (X.25, Frame Relay) ipx(11), -- IPX (Internet Protocol Exchange) appleTalk(12), -- Apple Talk decnetIV(13), -- DEC Net Phase IV banyanVines(14), -- Banyan Vines e164withNsap(15), -- (E.164 with NSAP format subaddress) dns(16), -- (Domain Name System) distinguishedName(17), -- (Distinguished Name, per X.500) asNumber(18), -- (16-bit quantity, per the AS number space) xtpOverIpv4(19), -- XTP over IP version 4 xtpOverIpv6(20), -- XTP over IP version 6 xtpNativeModeXTP(21), -- XTP native mode XTP fibreChannelWWPN(22), -- Fibre Channel World-Wide Port Name fibreChannelWWNN(23), -- Fibre Channel World-Wide Node Name gwid(24), -- Gateway Identifier afi(25), -- AFI for L2VPN information mplsTpSectionEndpointIdentifier(26), -- MPLS-TP Section Endpoint Identifier mplsTpLspEndpointIdentifier(27), -- MPLS-TP LSP Endpoint Identifier mplsTpPseudowireEndpointIdentifier(28), -- MPLS-TP Pseudowire Endpoint Identifier eigrpCommonServiceFamily(16384), -- EIGRP Common Service Family eigrpIpv4ServiceFamily(16385), -- EIGRP IPv4 Service Family eigrpIpv6ServiceFamily(16386), -- EIGRP IPv6 Service Family lispCanonicalAddressFormat(16387), -- LISP Canonical Address Format (LCAF) bgpLs(16388), -- BGP-LS fortyeightBitMacBitMac(16389), -- 48-bit MAC sixtyfourBitMac(16390), -- 64-bit MAC oui(16391), -- OUI mac24(16392), -- MAC/24 mac40(16393), -- MAC/40 ipv664(16394), -- IPv6/64 rBridgePortID(16395), -- RBridge Port ID trillNickname(16396), -- TRILL Nickname universallyUniqueIdentifier(16397), -- Universally Unique Identifier (UUID) reserved(65535) Requests for new values should be made to IANA via email (iana&iana.org). · Integer32

The type of the NBMA subnetwork address of the NHRP Server represented by this entry. This object indicates how the values of nhrpClientNhsNbmaAddr and nhrpClientNhsNbmaSubaddr are to be interpreted.

NhrpGenAddrThe value of an internetwork layer or NBMA address. SIZE (0..64) · OCTET STRING

The NBMA subnetwork address of the NHS. The type of the address is indicated by the corresponding value of nhrpClientNhsNbmaAddrType.

NhrpGenAddrThe value of an internetwork layer or NBMA address. SIZE (0..64) · OCTET STRING

The NBMA subaddress of the NHS. For NMBA address families that do not have the concept of subaddress, this will be a zero-length OCTET STRING.

TruthValue1 = true2 = falseRepresents a boolean value. · Integer32

An indication of whether this NHS is in use by the NHC.

RowStatus1 = active2 = notInService3 = notReady4 = createAndGo5 = createAndWait6 = destroyThe 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 to a value other than 'active'. Also note that whenever any elements of a row exist, the RowStatus column must also exist. To summarize the effect of having a conceptual row with a status column having a SYNTAX clause value of RowStatus, consider the following state diagram: STATE +--------------+-----------+-------------+------------- | A | B | C | D | |status col.|status column| |status column | is | is |status column ACTION |does not exist| notReady | notInService| is active --------------+--------------+-----------+-------------+------------- set status |noError ->D|inconsist- |inconsistent-|inconsistent- column to | or | entValue| Value| Value createAndGo |inconsistent- | | | | Value| | | --------------+--------------+-----------+-------------+------------- set status |noError see 1|inconsist- |inconsistent-|inconsistent- column to | or | entValue| Value| Value createAndWait |wrongValue | | | --------------+--------------+-----------+-------------+------------- set status |inconsistent- |inconsist- |noError |noError column to | Value| entValue| | active | | | | | | or | | | | | | | |see 2 ->D|see 8 ->D| ->D --------------+--------------+-----------+-------------+------------- set status |inconsistent- |inconsist- |noError |noError ->C column to | Value| entValue| | notInService | | | | | | or | | or | | | | | |see 3 ->C| ->C|see 6 --------------+--------------+-----------+-------------+------------- set status |noError |noError |noError |noError ->A column to | | | | or destroy | ->A| ->A| ->A|see 7 --------------+--------------+-----------+-------------+------------- set any other |see 4 |noError |noError |see 5 column to some| | | | value | | see 1| ->C| ->D --------------+--------------+-----------+-------------+------------- (1) goto B or C, depending on information available to the agent. (2) if other variable bindings included in the same PDU, provide values for all columns which are missing but required, and all columns have acceptable values, then return noError and goto D. (3) if other variable bindings included in the same PDU, provide legal values for all columns which are missing but required, then return noError and goto C. (4) at the discretion of the agent, the return value may be either: inconsistentName: because the agent does not choose to create such an instance when the corresponding RowStatus instance does not exist, or inconsistentValue: if the supplied value is inconsistent with the state of some other MIB object's value, or noError: because the agent chooses to create the instance. If noError is returned, then the instance of the status column must also be created, and the new state is B or C, depending on the information available to the agent. If inconsistentName or inconsistentValue is returned, the row remains in state A. (5) depending on the MIB definition for the column/table, either noError or inconsistentValue may be returned. (6) the return value can indicate one of the following errors: wrongValue: because the agent does not support notInService (e.g., an agent which does not support createAndWait), or inconsistentValue: because the agent is unable to take the row out of service at this time, perhaps because it is in use and cannot be de-activated. (7) the return value can indicate the following error: inconsistentValue: because the agent is unable to remove the row at this time, perhaps because it is in use and cannot be de-activated. (8) the transition to D can fail, e.g., if the values of the conceptual row are inconsistent, then the error code would be inconsistentValue. NOTE: Other processing of (this and other varbinds of) the set request may result in a response other than noError being returned, e.g., wrongValue, noCreation, etc. Conceptual Row Creation There are four potential interactions when creating a conceptual row: selecting an instance-identifier which is not in use; creating the conceptual row; initializing any objects for which the agent does not supply a default; and, making the conceptual row available for use by the managed device. Interaction 1: Selecting an Instance-Identifier The algorithm used to select an instance-identifier varies for each conceptual row. In some cases, the instance- identifier is semantically significant, e.g., the destination address of a route, and a management station selects the instance-identifier according to the semantics. In other cases, the instance-identifier is used solely to distinguish conceptual rows, and a management station without specific knowledge of the conceptual row might examine the instances present in order to determine an unused instance-identifier. (This approach may be used, but it is often highly sub-optimal; however, it is also a questionable practice for a naive management station to attempt conceptual row creation.) Alternately, the MIB module which defines the conceptual row might provide one or more objects which provide assistance in determining an unused instance-identifier. For example, if the conceptual row is indexed by an integer-value, then an object having an integer-valued SYNTAX clause might be defined for such a purpose, allowing a management station to issue a management protocol retrieval operation. In order to avoid unnecessary collisions between competing management stations, `adjacent' retrievals of this object should be different. Finally, the management station could select a pseudo-random number to use as the index. In the event that this index was already in use and an inconsistentValue was returned in response to the management protocol set operation, the management station should simply select a new pseudo-random number and retry the operation. A MIB designer should choose between the two latter algorithms based on the size of the table (and therefore the efficiency of each algorithm). For tables in which a large number of entries are expected, it is recommended that a MIB object be defined that returns an acceptable index for creation. For tables with small numbers of entries, it is recommended that the latter pseudo-random index mechanism be used. Interaction 2: Creating the Conceptual Row Once an unused instance-identifier has been selected, the management station determines if it wishes to create and activate the conceptual row in one transaction or in a negotiated set of interactions. Interaction 2a: Creating and Activating the Conceptual Row The management station must first determine the column requirements, i.e., it must determine those columns for which it must or must not provide values. Depending on the complexity of the table and the management station's knowledge of the agent's capabilities, this determination can be made locally by the management station. Alternately, the management station issues a management protocol get operation to examine all columns in the conceptual row that it wishes to create. In response, for each column, there are three possible outcomes: - a value is returned, indicating that some other management station has already created this conceptual row. We return to interaction 1. - the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it should supply a value for this column when the conceptual row is to be created. - the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column. Once the column requirements have been determined, a management protocol set operation is accordingly issued. This operation also sets the new instance of the status column to `createAndGo'. When the agent processes the set operation, it verifies that it has sufficient information to make the conceptual row available for use by the managed device. The information available to the agent is provided by two sources: the management protocol set operation which creates the conceptual row, and, implementation-specific defaults supplied by the agent (note that an agent must provide implementation-specific defaults for at least those objects which it implements as read-only). If there is sufficient information available, then the conceptual row is created, a `noError' response is returned, the status column is set to `active', and no further interactions are necessary (i.e., interactions 3 and 4 are skipped). If there is insufficient information, then the conceptual row is not created, and the set operation fails with an error of `inconsistentValue'. On this error, the management station can issue a management protocol retrieval operation to determine if this was because it failed to specify a value for a required column, or, because the selected instance of the status column already existed. In the latter case, we return to interaction 1. In the former case, the management station can re-issue the set operation with the additional information, or begin interaction 2 again using `createAndWait' in order to negotiate creation of the conceptual row. NOTE WELL Regardless of the method used to determine the column requirements, it is possible that the management station might deem a column necessary when, in fact, the agent will not allow that particular columnar instance to be created or written. In this case, the management protocol set operation will fail with an error such as `noCreation' or `notWritable'. In this case, the management station decides whether it needs to be able to set a value for that particular columnar instance. If not, the management station re-issues the management protocol set operation, but without setting a value for that particular columnar instance; otherwise, the management station aborts the row creation algorithm. Interaction 2b: Negotiating the Creation of the Conceptual Row The management station issues a management protocol set operation which sets the desired instance of the status column to `createAndWait'. If the agent is unwilling to process a request of this sort, the set operation fails with an error of `wrongValue'. (As a consequence, such an agent must be prepared to accept a single management protocol set operation, i.e., interaction 2a above, containing all of the columns indicated by its column requirements.) Otherwise, the conceptual row is created, a `noError' response is returned, and the status column is immediately set to either `notInService' or `notReady', depending on whether it has sufficient information to (attempt to) make the conceptual row available for use by the managed device. If there is sufficient information available, then the status column is set to `notInService'; otherwise, if there is insufficient information, then the status column is set to `notReady'. Regardless, we proceed to interaction 3. Interaction 3: Initializing non-defaulted Objects The management station must now determine the column requirements. It issues a management protocol get operation to examine all columns in the created conceptual row. In the response, for each column, there are three possible outcomes: - a value is returned, indicating that the agent implements the object-type associated with this column and had sufficient information to provide a value. For those columns to which the agent provides read-create access (and for which the agent allows their values to be changed after their creation), a value return tells the management station that it may issue additional management protocol set operations, if it desires, in order to change the value associated with this column. - the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. However, the agent does not have sufficient information to provide a value, and until a value is provided, the conceptual row may not be made available for use by the managed device. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it must issue additional management protocol set operations, in order to provide a value associated with this column. - the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column. If the value associated with the status column is `notReady', then the management station must first deal with all `noSuchInstance' columns, if any. Having done so, the value of the status column becomes `notInService', and we proceed to interaction 4. Interaction 4: Making the Conceptual Row Available Once the management station is satisfied with the values associated with the columns of the conceptual row, it issues a management protocol set operation to set the status column to `active'. If the agent has sufficient information to make the conceptual row available for use by the managed device, the management protocol set operation succeeds (a `noError' response is returned). Otherwise, the management protocol set operation fails with an error of `inconsistentValue'. NOTE WELL A conceptual row having a status column with value `notInService' or `notReady' is unavailable to the managed device. As such, it is possible for the managed device to create its own instances during the time between the management protocol set operation which sets the status column to `createAndWait' and the management protocol set operation which sets the status column to `active'. In this case, when the management protocol set operation is issued to set the status column to `active', the values held in the agent supersede those used by the managed device. If the management station is prevented from setting the status column to `active' (e.g., due to management station or network failure) the conceptual row will be left in the `notInService' or `notReady' state, consuming resources indefinitely. The agent must detect conceptual rows that have been in either state for an abnormally long period of time and remove them. It is the responsibility of the DESCRIPTION clause of the status column to indicate what an abnormally long period of time would be. This period of time should be long enough to allow for human response time (including `think time') between the creation of the conceptual row and the setting of the status to `active'. In the absence of such information in the DESCRIPTION clause, it is suggested that this period be approximately 5 minutes in length. This removal action applies not only to newly-created rows, but also to previously active rows which are set to, and left in, the notInService state for a prolonged period exceeding that which is considered normal for such a conceptual row. Conceptual Row Suspension When a conceptual row is `active', the management station may issue a management protocol set operation which sets the instance of the status column to `notInService'. If the agent is unwilling to do so, the set operation fails with an error of `wrongValue' or `inconsistentValue'. Otherwise, the conceptual row is taken out of service, and a `noError' response is returned. It is the responsibility of the DESCRIPTION clause of the status column to indicate under what circumstances the status column should be taken out of service (e.g., in order for the value of some other column of the same conceptual row to be modified). Conceptual Row Deletion For deletion of conceptual rows, a management protocol set operation is issued which sets the instance of the status column to `destroy'. This request may be made regardless of the current value of the status column (e.g., it is possible to delete conceptual rows which are either `notReady', `notInService' or `active'.) If the operation succeeds, then all instances associated with the conceptual row are immediately removed. · Integer32

An object that allows entries in this table to be created and deleted using the RowStatus convention.

Counter32

The number of NHRP Resolution Requests transmitted by this client. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Client re-initialization and at other times as indicated by the value of nhrpClientStatDiscontinuityTime.

Counter32

The number of positively acknowledged NHRP Resolution Replies received by this client. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Client re-initialization and at other times as indicated by the value of nhrpClientStatDiscontinuityTime.

Counter32

The number of NAKed NHRP Resolution Replies received by this client that contained the code indicating 'Administratively Prohibited'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Client re-initialization and at other times as indicated by the value of nhrpClientStatDiscontinuityTime.

Counter32

The number of NAKed NHRP Resolution Replies received by this client that contained the code indicating 'Insufficient Resources'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Client re-initialization and at other times as indicated by the value of nhrpClientStatDiscontinuityTime.

Counter32

The number of NAKed NHRP Resolution Replies received by this client that contained the code indicating 'No Internetworking Layer Address to NBMA Address Binding Exists'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Client re-initialization and at other times as indicated by the value of nhrpClientStatDiscontinuityTime.

Counter32

The number of NAKed NHRP Resolution Replies received by this client that contained the code indicating 'Binding Exists But Is Not Unique'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Client re-initialization and at other times as indicated by the value of nhrpClientStatDiscontinuityTime.

Counter32

The number of NHRP Registration Requests transmitted by this client. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Client re-initialization and at other times as indicated by the value of nhrpClientStatDiscontinuityTime.

Counter32

The number of positively acknowledged NHRP Registration Replies received by this client. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Client re-initialization and at other times as indicated by the value of nhrpClientStatDiscontinuityTime.

Counter32

The number of NAKed NHRP Registration Replies received by this client that contained the code indicating 'Administratively Prohibited'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Client re-initialization and at other times as indicated by the value of nhrpClientStatDiscontinuityTime.

Counter32

The number of NAKed NHRP Registration Replies received by this client that contained the code indicating 'Insufficient Resources'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Client re-initialization and at other times as indicated by the value of nhrpClientStatDiscontinuityTime.

Counter32

The number of NAKed NHRP Registration Replies received by this client that contained the code indicating 'Unique Internetworking Layer Address Already Registered'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Client re-initialization and at other times as indicated by the value of nhrpClientStatDiscontinuityTime.

Counter32

The number of NHRP Purge Requests received by this client. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Client re-initialization and at other times as indicated by the value of nhrpClientStatDiscontinuityTime.

Counter32

The number of NHRP Purge Requests transmitted by this client. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Client re-initialization and at other times as indicated by the value of nhrpClientStatDiscontinuityTime.

Counter32

The number of NHRP Purge Replies received by this client. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Client re-initialization and at other times as indicated by the value of nhrpClientStatDiscontinuityTime.

Counter32

The number of NHRP Purge Replies transmitted by this client. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Client re-initialization and at other times as indicated by the value of nhrpClientStatDiscontinuityTime.

Counter32

The number of NHRP Error Indication packets transmitted by this client. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Client re-initialization and at other times as indicated by the value of nhrpClientStatDiscontinuityTime. ⓘ

Counter32

The number of NHRP Error Indication packets received by this client with the error code 'Unrecognized Extension'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Client re-initialization and at other times as indicated by the value of nhrpClientStatDiscontinuityTime. ⓘ

Counter32

The number of NHRP Error Indication packets received by this client with the error code 'NHRP Loop Detected'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Client re-initialization and at other times as indicated by the value of nhrpClientStatDiscontinuityTime. ⓘ

Counter32

The number of NHRP Error Indication packets received by this client with the error code 'Protocol Address Unreachable'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Client re-initialization and at other times as indicated by the value of nhrpClientStatDiscontinuityTime. ⓘ

Counter32

The number of NHRP Error Indication packets received by this client with the error code 'Protocol Error'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Client re-initialization and at other times as indicated by the value of nhrpClientStatDiscontinuityTime. ⓘ

Counter32

The number of NHRP Error Indication packets received by this client with the error code 'NHRP SDU Size Exceeded'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Client re-initialization and at other times as indicated by the value of nhrpClientStatDiscontinuityTime. ⓘ

Counter32

The number of NHRP Error Indication packets received by this client with the error code 'Invalid Extension'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Client re-initialization and at other times as indicated by the value of nhrpClientStatDiscontinuityTime. ⓘ

Counter32

The number of NHRP Error Indication packets received by this client with the error code 'Authentication Failure'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Client re-initialization and at other times as indicated by the value of nhrpClientStatDiscontinuityTime. ⓘ

Counter32

The number of NHRP Error Indication packets received by this client with the error code 'Hop Count Exceeded'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Client re-initialization and at other times as indicated by the value of nhrpClientStatDiscontinuityTime. ⓘ

TimeStampThe value of the sysUpTime object at which a specific occurrence happened. The specific occurrence must be defined in the description of any object defined using this type. If sysUpTime is reset to zero as a result of a re- initialization of the network management (sub)system, then the values of all TimeStamp objects are also reset. However, after approximately 497 days without a re- initialization, the sysUpTime object will reach 2^^32-1 and then increment around to zero; in this case, existing values of TimeStamp objects do not change. This can lead to ambiguities in the value of TimeStamp objects. · TimeTicks

The value of sysUpTime on the most recent occasion at which any one or more of this Client's counters suffered a discontinuity. If no such discontinuities have occurred since the last re-initialization of the local management subsystem or the NHRP Client re-initialization associated with this entry, then this object contains a zero value. ⓘ

Unsigned32 (1..4294967295)

An identifier for the server that is unique within the scope of this agent.

AddressFamilyNumbers0 = other1 = ipV42 = ipV63 = nsap4 = hdlc5 = bbn18226 = all8027 = e1638 = e1649 = f6910 = x12111 = ipx12 = appleTalk13 = decnetIV14 = banyanVines15 = e164withNsap16 = dns17 = distinguishedName18 = asNumber19 = xtpOverIpv420 = xtpOverIpv621 = xtpNativeModeXTP22 = fibreChannelWWPN23 = fibreChannelWWNN24 = gwid25 = afi26 = mplsTpSectionEndpointIdentifier27 = mplsTpLspEndpointIdentifier28 = mplsTpPseudowireEndpointIdentifier16384 = eigrpCommonServiceFamily16385 = eigrpIpv4ServiceFamily16386 = eigrpIpv6ServiceFamily16387 = lispCanonicalAddressFormat16388 = bgpLs16389 = fortyeightBitMac16390 = sixtyfourBitMac16391 = oui16392 = mac2416393 = mac4016394 = ipv66416395 = rBridgePortID16396 = trillNickname16397 = universallyUniqueIdentifier65535 = reservedThe definition of this textual convention with the addition of newly assigned values is published periodically by the IANA, in either the Assigned Numbers RFC, or some derivative of it specific to Internet Network Management number assignments. (The latest arrangements can be obtained by contacting the IANA.) The enumerations are described as: other(0), -- none of the following ipV4(1), -- IP Version 4 ipV6(2), -- IP Version 6 nsap(3), -- NSAP hdlc(4), -- (8-bit multidrop) bbn1822(5), all802(6), -- (includes all 802 media -- plus Ethernet 'canonical format') e163(7), e164(8), -- (SMDS, Frame Relay, ATM) f69(9), -- (Telex) x121(10), -- (X.25, Frame Relay) ipx(11), -- IPX (Internet Protocol Exchange) appleTalk(12), -- Apple Talk decnetIV(13), -- DEC Net Phase IV banyanVines(14), -- Banyan Vines e164withNsap(15), -- (E.164 with NSAP format subaddress) dns(16), -- (Domain Name System) distinguishedName(17), -- (Distinguished Name, per X.500) asNumber(18), -- (16-bit quantity, per the AS number space) xtpOverIpv4(19), -- XTP over IP version 4 xtpOverIpv6(20), -- XTP over IP version 6 xtpNativeModeXTP(21), -- XTP native mode XTP fibreChannelWWPN(22), -- Fibre Channel World-Wide Port Name fibreChannelWWNN(23), -- Fibre Channel World-Wide Node Name gwid(24), -- Gateway Identifier afi(25), -- AFI for L2VPN information mplsTpSectionEndpointIdentifier(26), -- MPLS-TP Section Endpoint Identifier mplsTpLspEndpointIdentifier(27), -- MPLS-TP LSP Endpoint Identifier mplsTpPseudowireEndpointIdentifier(28), -- MPLS-TP Pseudowire Endpoint Identifier eigrpCommonServiceFamily(16384), -- EIGRP Common Service Family eigrpIpv4ServiceFamily(16385), -- EIGRP IPv4 Service Family eigrpIpv6ServiceFamily(16386), -- EIGRP IPv6 Service Family lispCanonicalAddressFormat(16387), -- LISP Canonical Address Format (LCAF) bgpLs(16388), -- BGP-LS fortyeightBitMacBitMac(16389), -- 48-bit MAC sixtyfourBitMac(16390), -- 64-bit MAC oui(16391), -- OUI mac24(16392), -- MAC/24 mac40(16393), -- MAC/40 ipv664(16394), -- IPv6/64 rBridgePortID(16395), -- RBridge Port ID trillNickname(16396), -- TRILL Nickname universallyUniqueIdentifier(16397), -- Universally Unique Identifier (UUID) reserved(65535) Requests for new values should be made to IANA via email (iana&iana.org). · Integer32

The type of the internetwork layer address of this server. This object is used to interpret the value of nhrpServerInternetworkAddr.

NhrpGenAddrThe value of an internetwork layer or NBMA address. SIZE (0..64) · OCTET STRING

The value of the internetwork layer address of this server.

AddressFamilyNumbers0 = other1 = ipV42 = ipV63 = nsap4 = hdlc5 = bbn18226 = all8027 = e1638 = e1649 = f6910 = x12111 = ipx12 = appleTalk13 = decnetIV14 = banyanVines15 = e164withNsap16 = dns17 = distinguishedName18 = asNumber19 = xtpOverIpv420 = xtpOverIpv621 = xtpNativeModeXTP22 = fibreChannelWWPN23 = fibreChannelWWNN24 = gwid25 = afi26 = mplsTpSectionEndpointIdentifier27 = mplsTpLspEndpointIdentifier28 = mplsTpPseudowireEndpointIdentifier16384 = eigrpCommonServiceFamily16385 = eigrpIpv4ServiceFamily16386 = eigrpIpv6ServiceFamily16387 = lispCanonicalAddressFormat16388 = bgpLs16389 = fortyeightBitMac16390 = sixtyfourBitMac16391 = oui16392 = mac2416393 = mac4016394 = ipv66416395 = rBridgePortID16396 = trillNickname16397 = universallyUniqueIdentifier65535 = reservedThe definition of this textual convention with the addition of newly assigned values is published periodically by the IANA, in either the Assigned Numbers RFC, or some derivative of it specific to Internet Network Management number assignments. (The latest arrangements can be obtained by contacting the IANA.) The enumerations are described as: other(0), -- none of the following ipV4(1), -- IP Version 4 ipV6(2), -- IP Version 6 nsap(3), -- NSAP hdlc(4), -- (8-bit multidrop) bbn1822(5), all802(6), -- (includes all 802 media -- plus Ethernet 'canonical format') e163(7), e164(8), -- (SMDS, Frame Relay, ATM) f69(9), -- (Telex) x121(10), -- (X.25, Frame Relay) ipx(11), -- IPX (Internet Protocol Exchange) appleTalk(12), -- Apple Talk decnetIV(13), -- DEC Net Phase IV banyanVines(14), -- Banyan Vines e164withNsap(15), -- (E.164 with NSAP format subaddress) dns(16), -- (Domain Name System) distinguishedName(17), -- (Distinguished Name, per X.500) asNumber(18), -- (16-bit quantity, per the AS number space) xtpOverIpv4(19), -- XTP over IP version 4 xtpOverIpv6(20), -- XTP over IP version 6 xtpNativeModeXTP(21), -- XTP native mode XTP fibreChannelWWPN(22), -- Fibre Channel World-Wide Port Name fibreChannelWWNN(23), -- Fibre Channel World-Wide Node Name gwid(24), -- Gateway Identifier afi(25), -- AFI for L2VPN information mplsTpSectionEndpointIdentifier(26), -- MPLS-TP Section Endpoint Identifier mplsTpLspEndpointIdentifier(27), -- MPLS-TP LSP Endpoint Identifier mplsTpPseudowireEndpointIdentifier(28), -- MPLS-TP Pseudowire Endpoint Identifier eigrpCommonServiceFamily(16384), -- EIGRP Common Service Family eigrpIpv4ServiceFamily(16385), -- EIGRP IPv4 Service Family eigrpIpv6ServiceFamily(16386), -- EIGRP IPv6 Service Family lispCanonicalAddressFormat(16387), -- LISP Canonical Address Format (LCAF) bgpLs(16388), -- BGP-LS fortyeightBitMacBitMac(16389), -- 48-bit MAC sixtyfourBitMac(16390), -- 64-bit MAC oui(16391), -- OUI mac24(16392), -- MAC/24 mac40(16393), -- MAC/40 ipv664(16394), -- IPv6/64 rBridgePortID(16395), -- RBridge Port ID trillNickname(16396), -- TRILL Nickname universallyUniqueIdentifier(16397), -- Universally Unique Identifier (UUID) reserved(65535) Requests for new values should be made to IANA via email (iana&iana.org). · Integer32

The type of the NBMA subnetwork address of this server. This object is used to interpret the value of nhrpServerNbmaAddr.

NhrpGenAddrThe value of an internetwork layer or NBMA address. SIZE (0..64) · OCTET STRING

The value of the NBMA subnetwork address of this server.

NhrpGenAddrThe value of an internetwork layer or NBMA address. SIZE (0..64) · OCTET STRING

The value of the NBMA subaddress of this server. For NBMA address families without a subaddress concept, this will be a zero-length OCTET STRING.

StorageType1 = other2 = volatile3 = nonVolatile4 = permanent5 = readOnlyDescribes 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. · Integer32

This object defines whether this row is kept in volatile storage and lost upon a Server crash or reboot situation, or if this row is backed up by nonvolatile or permanent storage.

RowStatus1 = active2 = notInService3 = notReady4 = createAndGo5 = createAndWait6 = destroyThe 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 to a value other than 'active'. Also note that whenever any elements of a row exist, the RowStatus column must also exist. To summarize the effect of having a conceptual row with a status column having a SYNTAX clause value of RowStatus, consider the following state diagram: STATE +--------------+-----------+-------------+------------- | A | B | C | D | |status col.|status column| |status column | is | is |status column ACTION |does not exist| notReady | notInService| is active --------------+--------------+-----------+-------------+------------- set status |noError ->D|inconsist- |inconsistent-|inconsistent- column to | or | entValue| Value| Value createAndGo |inconsistent- | | | | Value| | | --------------+--------------+-----------+-------------+------------- set status |noError see 1|inconsist- |inconsistent-|inconsistent- column to | or | entValue| Value| Value createAndWait |wrongValue | | | --------------+--------------+-----------+-------------+------------- set status |inconsistent- |inconsist- |noError |noError column to | Value| entValue| | active | | | | | | or | | | | | | | |see 2 ->D|see 8 ->D| ->D --------------+--------------+-----------+-------------+------------- set status |inconsistent- |inconsist- |noError |noError ->C column to | Value| entValue| | notInService | | | | | | or | | or | | | | | |see 3 ->C| ->C|see 6 --------------+--------------+-----------+-------------+------------- set status |noError |noError |noError |noError ->A column to | | | | or destroy | ->A| ->A| ->A|see 7 --------------+--------------+-----------+-------------+------------- set any other |see 4 |noError |noError |see 5 column to some| | | | value | | see 1| ->C| ->D --------------+--------------+-----------+-------------+------------- (1) goto B or C, depending on information available to the agent. (2) if other variable bindings included in the same PDU, provide values for all columns which are missing but required, and all columns have acceptable values, then return noError and goto D. (3) if other variable bindings included in the same PDU, provide legal values for all columns which are missing but required, then return noError and goto C. (4) at the discretion of the agent, the return value may be either: inconsistentName: because the agent does not choose to create such an instance when the corresponding RowStatus instance does not exist, or inconsistentValue: if the supplied value is inconsistent with the state of some other MIB object's value, or noError: because the agent chooses to create the instance. If noError is returned, then the instance of the status column must also be created, and the new state is B or C, depending on the information available to the agent. If inconsistentName or inconsistentValue is returned, the row remains in state A. (5) depending on the MIB definition for the column/table, either noError or inconsistentValue may be returned. (6) the return value can indicate one of the following errors: wrongValue: because the agent does not support notInService (e.g., an agent which does not support createAndWait), or inconsistentValue: because the agent is unable to take the row out of service at this time, perhaps because it is in use and cannot be de-activated. (7) the return value can indicate the following error: inconsistentValue: because the agent is unable to remove the row at this time, perhaps because it is in use and cannot be de-activated. (8) the transition to D can fail, e.g., if the values of the conceptual row are inconsistent, then the error code would be inconsistentValue. NOTE: Other processing of (this and other varbinds of) the set request may result in a response other than noError being returned, e.g., wrongValue, noCreation, etc. Conceptual Row Creation There are four potential interactions when creating a conceptual row: selecting an instance-identifier which is not in use; creating the conceptual row; initializing any objects for which the agent does not supply a default; and, making the conceptual row available for use by the managed device. Interaction 1: Selecting an Instance-Identifier The algorithm used to select an instance-identifier varies for each conceptual row. In some cases, the instance- identifier is semantically significant, e.g., the destination address of a route, and a management station selects the instance-identifier according to the semantics. In other cases, the instance-identifier is used solely to distinguish conceptual rows, and a management station without specific knowledge of the conceptual row might examine the instances present in order to determine an unused instance-identifier. (This approach may be used, but it is often highly sub-optimal; however, it is also a questionable practice for a naive management station to attempt conceptual row creation.) Alternately, the MIB module which defines the conceptual row might provide one or more objects which provide assistance in determining an unused instance-identifier. For example, if the conceptual row is indexed by an integer-value, then an object having an integer-valued SYNTAX clause might be defined for such a purpose, allowing a management station to issue a management protocol retrieval operation. In order to avoid unnecessary collisions between competing management stations, `adjacent' retrievals of this object should be different. Finally, the management station could select a pseudo-random number to use as the index. In the event that this index was already in use and an inconsistentValue was returned in response to the management protocol set operation, the management station should simply select a new pseudo-random number and retry the operation. A MIB designer should choose between the two latter algorithms based on the size of the table (and therefore the efficiency of each algorithm). For tables in which a large number of entries are expected, it is recommended that a MIB object be defined that returns an acceptable index for creation. For tables with small numbers of entries, it is recommended that the latter pseudo-random index mechanism be used. Interaction 2: Creating the Conceptual Row Once an unused instance-identifier has been selected, the management station determines if it wishes to create and activate the conceptual row in one transaction or in a negotiated set of interactions. Interaction 2a: Creating and Activating the Conceptual Row The management station must first determine the column requirements, i.e., it must determine those columns for which it must or must not provide values. Depending on the complexity of the table and the management station's knowledge of the agent's capabilities, this determination can be made locally by the management station. Alternately, the management station issues a management protocol get operation to examine all columns in the conceptual row that it wishes to create. In response, for each column, there are three possible outcomes: - a value is returned, indicating that some other management station has already created this conceptual row. We return to interaction 1. - the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it should supply a value for this column when the conceptual row is to be created. - the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column. Once the column requirements have been determined, a management protocol set operation is accordingly issued. This operation also sets the new instance of the status column to `createAndGo'. When the agent processes the set operation, it verifies that it has sufficient information to make the conceptual row available for use by the managed device. The information available to the agent is provided by two sources: the management protocol set operation which creates the conceptual row, and, implementation-specific defaults supplied by the agent (note that an agent must provide implementation-specific defaults for at least those objects which it implements as read-only). If there is sufficient information available, then the conceptual row is created, a `noError' response is returned, the status column is set to `active', and no further interactions are necessary (i.e., interactions 3 and 4 are skipped). If there is insufficient information, then the conceptual row is not created, and the set operation fails with an error of `inconsistentValue'. On this error, the management station can issue a management protocol retrieval operation to determine if this was because it failed to specify a value for a required column, or, because the selected instance of the status column already existed. In the latter case, we return to interaction 1. In the former case, the management station can re-issue the set operation with the additional information, or begin interaction 2 again using `createAndWait' in order to negotiate creation of the conceptual row. NOTE WELL Regardless of the method used to determine the column requirements, it is possible that the management station might deem a column necessary when, in fact, the agent will not allow that particular columnar instance to be created or written. In this case, the management protocol set operation will fail with an error such as `noCreation' or `notWritable'. In this case, the management station decides whether it needs to be able to set a value for that particular columnar instance. If not, the management station re-issues the management protocol set operation, but without setting a value for that particular columnar instance; otherwise, the management station aborts the row creation algorithm. Interaction 2b: Negotiating the Creation of the Conceptual Row The management station issues a management protocol set operation which sets the desired instance of the status column to `createAndWait'. If the agent is unwilling to process a request of this sort, the set operation fails with an error of `wrongValue'. (As a consequence, such an agent must be prepared to accept a single management protocol set operation, i.e., interaction 2a above, containing all of the columns indicated by its column requirements.) Otherwise, the conceptual row is created, a `noError' response is returned, and the status column is immediately set to either `notInService' or `notReady', depending on whether it has sufficient information to (attempt to) make the conceptual row available for use by the managed device. If there is sufficient information available, then the status column is set to `notInService'; otherwise, if there is insufficient information, then the status column is set to `notReady'. Regardless, we proceed to interaction 3. Interaction 3: Initializing non-defaulted Objects The management station must now determine the column requirements. It issues a management protocol get operation to examine all columns in the created conceptual row. In the response, for each column, there are three possible outcomes: - a value is returned, indicating that the agent implements the object-type associated with this column and had sufficient information to provide a value. For those columns to which the agent provides read-create access (and for which the agent allows their values to be changed after their creation), a value return tells the management station that it may issue additional management protocol set operations, if it desires, in order to change the value associated with this column. - the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. However, the agent does not have sufficient information to provide a value, and until a value is provided, the conceptual row may not be made available for use by the managed device. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it must issue additional management protocol set operations, in order to provide a value associated with this column. - the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column. If the value associated with the status column is `notReady', then the management station must first deal with all `noSuchInstance' columns, if any. Having done so, the value of the status column becomes `notInService', and we proceed to interaction 4. Interaction 4: Making the Conceptual Row Available Once the management station is satisfied with the values associated with the columns of the conceptual row, it issues a management protocol set operation to set the status column to `active'. If the agent has sufficient information to make the conceptual row available for use by the managed device, the management protocol set operation succeeds (a `noError' response is returned). Otherwise, the management protocol set operation fails with an error of `inconsistentValue'. NOTE WELL A conceptual row having a status column with value `notInService' or `notReady' is unavailable to the managed device. As such, it is possible for the managed device to create its own instances during the time between the management protocol set operation which sets the status column to `createAndWait' and the management protocol set operation which sets the status column to `active'. In this case, when the management protocol set operation is issued to set the status column to `active', the values held in the agent supersede those used by the managed device. If the management station is prevented from setting the status column to `active' (e.g., due to management station or network failure) the conceptual row will be left in the `notInService' or `notReady' state, consuming resources indefinitely. The agent must detect conceptual rows that have been in either state for an abnormally long period of time and remove them. It is the responsibility of the DESCRIPTION clause of the status column to indicate what an abnormally long period of time would be. This period of time should be long enough to allow for human response time (including `think time') between the creation of the conceptual row and the setting of the status to `active'. In the absence of such information in the DESCRIPTION clause, it is suggested that this period be approximately 5 minutes in length. This removal action applies not only to newly-created rows, but also to previously active rows which are set to, and left in, the notInService state for a prolonged period exceeding that which is considered normal for such a conceptual row. Conceptual Row Suspension When a conceptual row is `active', the management station may issue a management protocol set operation which sets the instance of the status column to `notInService'. If the agent is unwilling to do so, the set operation fails with an error of `wrongValue' or `inconsistentValue'. Otherwise, the conceptual row is taken out of service, and a `noError' response is returned. It is the responsibility of the DESCRIPTION clause of the status column to indicate under what circumstances the status column should be taken out of service (e.g., in order for the value of some other column of the same conceptual row to be modified). Conceptual Row Deletion For deletion of conceptual rows, a management protocol set operation is issued which sets the instance of the status column to `destroy'. This request may be made regardless of the current value of the status column (e.g., it is possible to delete conceptual rows which are either `notReady', `notInService' or `active'.) If the operation succeeds, then all instances associated with the conceptual row are immediately removed. · Integer32

An object that allows entries in this table to be created and deleted using the RowStatus convention.

TruthValue1 = true2 = falseRepresents a boolean value. · Integer32

An indication of whether this cache entry is authoritative, which means the entry was added because of a direct registration request with this server or by Server Cache Synchronization Protocol (SCSP) from an authoritative source.

TruthValue1 = true2 = falseRepresents a boolean value. · Integer32

The Uniqueness indicator for this cache entry used in duplicate address detection. This value cannot be changed after the entry is active.

Unsigned32 (1..4294967295)

An identifier for an NHC available to an NHS.

Integer32 (0..255)

The number of bits that define the internetwork layer prefix associated with the nhrpServerNhcInternetworkAddr.

AddressFamilyNumbers0 = other1 = ipV42 = ipV63 = nsap4 = hdlc5 = bbn18226 = all8027 = e1638 = e1649 = f6910 = x12111 = ipx12 = appleTalk13 = decnetIV14 = banyanVines15 = e164withNsap16 = dns17 = distinguishedName18 = asNumber19 = xtpOverIpv420 = xtpOverIpv621 = xtpNativeModeXTP22 = fibreChannelWWPN23 = fibreChannelWWNN24 = gwid25 = afi26 = mplsTpSectionEndpointIdentifier27 = mplsTpLspEndpointIdentifier28 = mplsTpPseudowireEndpointIdentifier16384 = eigrpCommonServiceFamily16385 = eigrpIpv4ServiceFamily16386 = eigrpIpv6ServiceFamily16387 = lispCanonicalAddressFormat16388 = bgpLs16389 = fortyeightBitMac16390 = sixtyfourBitMac16391 = oui16392 = mac2416393 = mac4016394 = ipv66416395 = rBridgePortID16396 = trillNickname16397 = universallyUniqueIdentifier65535 = reservedThe definition of this textual convention with the addition of newly assigned values is published periodically by the IANA, in either the Assigned Numbers RFC, or some derivative of it specific to Internet Network Management number assignments. (The latest arrangements can be obtained by contacting the IANA.) The enumerations are described as: other(0), -- none of the following ipV4(1), -- IP Version 4 ipV6(2), -- IP Version 6 nsap(3), -- NSAP hdlc(4), -- (8-bit multidrop) bbn1822(5), all802(6), -- (includes all 802 media -- plus Ethernet 'canonical format') e163(7), e164(8), -- (SMDS, Frame Relay, ATM) f69(9), -- (Telex) x121(10), -- (X.25, Frame Relay) ipx(11), -- IPX (Internet Protocol Exchange) appleTalk(12), -- Apple Talk decnetIV(13), -- DEC Net Phase IV banyanVines(14), -- Banyan Vines e164withNsap(15), -- (E.164 with NSAP format subaddress) dns(16), -- (Domain Name System) distinguishedName(17), -- (Distinguished Name, per X.500) asNumber(18), -- (16-bit quantity, per the AS number space) xtpOverIpv4(19), -- XTP over IP version 4 xtpOverIpv6(20), -- XTP over IP version 6 xtpNativeModeXTP(21), -- XTP native mode XTP fibreChannelWWPN(22), -- Fibre Channel World-Wide Port Name fibreChannelWWNN(23), -- Fibre Channel World-Wide Node Name gwid(24), -- Gateway Identifier afi(25), -- AFI for L2VPN information mplsTpSectionEndpointIdentifier(26), -- MPLS-TP Section Endpoint Identifier mplsTpLspEndpointIdentifier(27), -- MPLS-TP LSP Endpoint Identifier mplsTpPseudowireEndpointIdentifier(28), -- MPLS-TP Pseudowire Endpoint Identifier eigrpCommonServiceFamily(16384), -- EIGRP Common Service Family eigrpIpv4ServiceFamily(16385), -- EIGRP IPv4 Service Family eigrpIpv6ServiceFamily(16386), -- EIGRP IPv6 Service Family lispCanonicalAddressFormat(16387), -- LISP Canonical Address Format (LCAF) bgpLs(16388), -- BGP-LS fortyeightBitMacBitMac(16389), -- 48-bit MAC sixtyfourBitMac(16390), -- 64-bit MAC oui(16391), -- OUI mac24(16392), -- MAC/24 mac40(16393), -- MAC/40 ipv664(16394), -- IPv6/64 rBridgePortID(16395), -- RBridge Port ID trillNickname(16396), -- TRILL Nickname universallyUniqueIdentifier(16397), -- Universally Unique Identifier (UUID) reserved(65535) Requests for new values should be made to IANA via email (iana&iana.org). · Integer32

The type of the internetwork layer address of the NHRP Client represented in this entry. This object indicates how the value of nhrpServerNhcInternetworkAddr is to be interpreted.

NhrpGenAddrThe value of an internetwork layer or NBMA address. SIZE (0..64) · OCTET STRING

The value of the internetwork layer address of the NHRP Client represented by this entry. If this value is not known, this will be a zero-length OCTET STRING.

AddressFamilyNumbers0 = other1 = ipV42 = ipV63 = nsap4 = hdlc5 = bbn18226 = all8027 = e1638 = e1649 = f6910 = x12111 = ipx12 = appleTalk13 = decnetIV14 = banyanVines15 = e164withNsap16 = dns17 = distinguishedName18 = asNumber19 = xtpOverIpv420 = xtpOverIpv621 = xtpNativeModeXTP22 = fibreChannelWWPN23 = fibreChannelWWNN24 = gwid25 = afi26 = mplsTpSectionEndpointIdentifier27 = mplsTpLspEndpointIdentifier28 = mplsTpPseudowireEndpointIdentifier16384 = eigrpCommonServiceFamily16385 = eigrpIpv4ServiceFamily16386 = eigrpIpv6ServiceFamily16387 = lispCanonicalAddressFormat16388 = bgpLs16389 = fortyeightBitMac16390 = sixtyfourBitMac16391 = oui16392 = mac2416393 = mac4016394 = ipv66416395 = rBridgePortID16396 = trillNickname16397 = universallyUniqueIdentifier65535 = reservedThe definition of this textual convention with the addition of newly assigned values is published periodically by the IANA, in either the Assigned Numbers RFC, or some derivative of it specific to Internet Network Management number assignments. (The latest arrangements can be obtained by contacting the IANA.) The enumerations are described as: other(0), -- none of the following ipV4(1), -- IP Version 4 ipV6(2), -- IP Version 6 nsap(3), -- NSAP hdlc(4), -- (8-bit multidrop) bbn1822(5), all802(6), -- (includes all 802 media -- plus Ethernet 'canonical format') e163(7), e164(8), -- (SMDS, Frame Relay, ATM) f69(9), -- (Telex) x121(10), -- (X.25, Frame Relay) ipx(11), -- IPX (Internet Protocol Exchange) appleTalk(12), -- Apple Talk decnetIV(13), -- DEC Net Phase IV banyanVines(14), -- Banyan Vines e164withNsap(15), -- (E.164 with NSAP format subaddress) dns(16), -- (Domain Name System) distinguishedName(17), -- (Distinguished Name, per X.500) asNumber(18), -- (16-bit quantity, per the AS number space) xtpOverIpv4(19), -- XTP over IP version 4 xtpOverIpv6(20), -- XTP over IP version 6 xtpNativeModeXTP(21), -- XTP native mode XTP fibreChannelWWPN(22), -- Fibre Channel World-Wide Port Name fibreChannelWWNN(23), -- Fibre Channel World-Wide Node Name gwid(24), -- Gateway Identifier afi(25), -- AFI for L2VPN information mplsTpSectionEndpointIdentifier(26), -- MPLS-TP Section Endpoint Identifier mplsTpLspEndpointIdentifier(27), -- MPLS-TP LSP Endpoint Identifier mplsTpPseudowireEndpointIdentifier(28), -- MPLS-TP Pseudowire Endpoint Identifier eigrpCommonServiceFamily(16384), -- EIGRP Common Service Family eigrpIpv4ServiceFamily(16385), -- EIGRP IPv4 Service Family eigrpIpv6ServiceFamily(16386), -- EIGRP IPv6 Service Family lispCanonicalAddressFormat(16387), -- LISP Canonical Address Format (LCAF) bgpLs(16388), -- BGP-LS fortyeightBitMacBitMac(16389), -- 48-bit MAC sixtyfourBitMac(16390), -- 64-bit MAC oui(16391), -- OUI mac24(16392), -- MAC/24 mac40(16393), -- MAC/40 ipv664(16394), -- IPv6/64 rBridgePortID(16395), -- RBridge Port ID trillNickname(16396), -- TRILL Nickname universallyUniqueIdentifier(16397), -- Universally Unique Identifier (UUID) reserved(65535) Requests for new values should be made to IANA via email (iana&iana.org). · Integer32

The type of the NBMA subnetwork address of the NHRP Client represented by this entry. This object indicates how the values of nhrpServerNhcNbmaAddr and nhrpServerNhcNbmaSubaddr are to be interpreted.

NhrpGenAddrThe value of an internetwork layer or NBMA address. SIZE (0..64) · OCTET STRING

The NBMA subnetwork address of the NHC. The type of the address is indicated by the corresponding value of nhrpServerNbmaAddrType.

NhrpGenAddrThe value of an internetwork layer or NBMA address. SIZE (0..64) · OCTET STRING

The NBMA subaddress of the NHC. For NMBA address familes that do not have the concept of subaddress, this will be a zero-length OCTET STRING.

TruthValue1 = true2 = falseRepresents a boolean value. · Integer32

An indication of whether this NHC is in use by the NHS.

RowStatus1 = active2 = notInService3 = notReady4 = createAndGo5 = createAndWait6 = destroyThe 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 to a value other than 'active'. Also note that whenever any elements of a row exist, the RowStatus column must also exist. To summarize the effect of having a conceptual row with a status column having a SYNTAX clause value of RowStatus, consider the following state diagram: STATE +--------------+-----------+-------------+------------- | A | B | C | D | |status col.|status column| |status column | is | is |status column ACTION |does not exist| notReady | notInService| is active --------------+--------------+-----------+-------------+------------- set status |noError ->D|inconsist- |inconsistent-|inconsistent- column to | or | entValue| Value| Value createAndGo |inconsistent- | | | | Value| | | --------------+--------------+-----------+-------------+------------- set status |noError see 1|inconsist- |inconsistent-|inconsistent- column to | or | entValue| Value| Value createAndWait |wrongValue | | | --------------+--------------+-----------+-------------+------------- set status |inconsistent- |inconsist- |noError |noError column to | Value| entValue| | active | | | | | | or | | | | | | | |see 2 ->D|see 8 ->D| ->D --------------+--------------+-----------+-------------+------------- set status |inconsistent- |inconsist- |noError |noError ->C column to | Value| entValue| | notInService | | | | | | or | | or | | | | | |see 3 ->C| ->C|see 6 --------------+--------------+-----------+-------------+------------- set status |noError |noError |noError |noError ->A column to | | | | or destroy | ->A| ->A| ->A|see 7 --------------+--------------+-----------+-------------+------------- set any other |see 4 |noError |noError |see 5 column to some| | | | value | | see 1| ->C| ->D --------------+--------------+-----------+-------------+------------- (1) goto B or C, depending on information available to the agent. (2) if other variable bindings included in the same PDU, provide values for all columns which are missing but required, and all columns have acceptable values, then return noError and goto D. (3) if other variable bindings included in the same PDU, provide legal values for all columns which are missing but required, then return noError and goto C. (4) at the discretion of the agent, the return value may be either: inconsistentName: because the agent does not choose to create such an instance when the corresponding RowStatus instance does not exist, or inconsistentValue: if the supplied value is inconsistent with the state of some other MIB object's value, or noError: because the agent chooses to create the instance. If noError is returned, then the instance of the status column must also be created, and the new state is B or C, depending on the information available to the agent. If inconsistentName or inconsistentValue is returned, the row remains in state A. (5) depending on the MIB definition for the column/table, either noError or inconsistentValue may be returned. (6) the return value can indicate one of the following errors: wrongValue: because the agent does not support notInService (e.g., an agent which does not support createAndWait), or inconsistentValue: because the agent is unable to take the row out of service at this time, perhaps because it is in use and cannot be de-activated. (7) the return value can indicate the following error: inconsistentValue: because the agent is unable to remove the row at this time, perhaps because it is in use and cannot be de-activated. (8) the transition to D can fail, e.g., if the values of the conceptual row are inconsistent, then the error code would be inconsistentValue. NOTE: Other processing of (this and other varbinds of) the set request may result in a response other than noError being returned, e.g., wrongValue, noCreation, etc. Conceptual Row Creation There are four potential interactions when creating a conceptual row: selecting an instance-identifier which is not in use; creating the conceptual row; initializing any objects for which the agent does not supply a default; and, making the conceptual row available for use by the managed device. Interaction 1: Selecting an Instance-Identifier The algorithm used to select an instance-identifier varies for each conceptual row. In some cases, the instance- identifier is semantically significant, e.g., the destination address of a route, and a management station selects the instance-identifier according to the semantics. In other cases, the instance-identifier is used solely to distinguish conceptual rows, and a management station without specific knowledge of the conceptual row might examine the instances present in order to determine an unused instance-identifier. (This approach may be used, but it is often highly sub-optimal; however, it is also a questionable practice for a naive management station to attempt conceptual row creation.) Alternately, the MIB module which defines the conceptual row might provide one or more objects which provide assistance in determining an unused instance-identifier. For example, if the conceptual row is indexed by an integer-value, then an object having an integer-valued SYNTAX clause might be defined for such a purpose, allowing a management station to issue a management protocol retrieval operation. In order to avoid unnecessary collisions between competing management stations, `adjacent' retrievals of this object should be different. Finally, the management station could select a pseudo-random number to use as the index. In the event that this index was already in use and an inconsistentValue was returned in response to the management protocol set operation, the management station should simply select a new pseudo-random number and retry the operation. A MIB designer should choose between the two latter algorithms based on the size of the table (and therefore the efficiency of each algorithm). For tables in which a large number of entries are expected, it is recommended that a MIB object be defined that returns an acceptable index for creation. For tables with small numbers of entries, it is recommended that the latter pseudo-random index mechanism be used. Interaction 2: Creating the Conceptual Row Once an unused instance-identifier has been selected, the management station determines if it wishes to create and activate the conceptual row in one transaction or in a negotiated set of interactions. Interaction 2a: Creating and Activating the Conceptual Row The management station must first determine the column requirements, i.e., it must determine those columns for which it must or must not provide values. Depending on the complexity of the table and the management station's knowledge of the agent's capabilities, this determination can be made locally by the management station. Alternately, the management station issues a management protocol get operation to examine all columns in the conceptual row that it wishes to create. In response, for each column, there are three possible outcomes: - a value is returned, indicating that some other management station has already created this conceptual row. We return to interaction 1. - the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it should supply a value for this column when the conceptual row is to be created. - the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column. Once the column requirements have been determined, a management protocol set operation is accordingly issued. This operation also sets the new instance of the status column to `createAndGo'. When the agent processes the set operation, it verifies that it has sufficient information to make the conceptual row available for use by the managed device. The information available to the agent is provided by two sources: the management protocol set operation which creates the conceptual row, and, implementation-specific defaults supplied by the agent (note that an agent must provide implementation-specific defaults for at least those objects which it implements as read-only). If there is sufficient information available, then the conceptual row is created, a `noError' response is returned, the status column is set to `active', and no further interactions are necessary (i.e., interactions 3 and 4 are skipped). If there is insufficient information, then the conceptual row is not created, and the set operation fails with an error of `inconsistentValue'. On this error, the management station can issue a management protocol retrieval operation to determine if this was because it failed to specify a value for a required column, or, because the selected instance of the status column already existed. In the latter case, we return to interaction 1. In the former case, the management station can re-issue the set operation with the additional information, or begin interaction 2 again using `createAndWait' in order to negotiate creation of the conceptual row. NOTE WELL Regardless of the method used to determine the column requirements, it is possible that the management station might deem a column necessary when, in fact, the agent will not allow that particular columnar instance to be created or written. In this case, the management protocol set operation will fail with an error such as `noCreation' or `notWritable'. In this case, the management station decides whether it needs to be able to set a value for that particular columnar instance. If not, the management station re-issues the management protocol set operation, but without setting a value for that particular columnar instance; otherwise, the management station aborts the row creation algorithm. Interaction 2b: Negotiating the Creation of the Conceptual Row The management station issues a management protocol set operation which sets the desired instance of the status column to `createAndWait'. If the agent is unwilling to process a request of this sort, the set operation fails with an error of `wrongValue'. (As a consequence, such an agent must be prepared to accept a single management protocol set operation, i.e., interaction 2a above, containing all of the columns indicated by its column requirements.) Otherwise, the conceptual row is created, a `noError' response is returned, and the status column is immediately set to either `notInService' or `notReady', depending on whether it has sufficient information to (attempt to) make the conceptual row available for use by the managed device. If there is sufficient information available, then the status column is set to `notInService'; otherwise, if there is insufficient information, then the status column is set to `notReady'. Regardless, we proceed to interaction 3. Interaction 3: Initializing non-defaulted Objects The management station must now determine the column requirements. It issues a management protocol get operation to examine all columns in the created conceptual row. In the response, for each column, there are three possible outcomes: - a value is returned, indicating that the agent implements the object-type associated with this column and had sufficient information to provide a value. For those columns to which the agent provides read-create access (and for which the agent allows their values to be changed after their creation), a value return tells the management station that it may issue additional management protocol set operations, if it desires, in order to change the value associated with this column. - the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. However, the agent does not have sufficient information to provide a value, and until a value is provided, the conceptual row may not be made available for use by the managed device. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it must issue additional management protocol set operations, in order to provide a value associated with this column. - the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column. If the value associated with the status column is `notReady', then the management station must first deal with all `noSuchInstance' columns, if any. Having done so, the value of the status column becomes `notInService', and we proceed to interaction 4. Interaction 4: Making the Conceptual Row Available Once the management station is satisfied with the values associated with the columns of the conceptual row, it issues a management protocol set operation to set the status column to `active'. If the agent has sufficient information to make the conceptual row available for use by the managed device, the management protocol set operation succeeds (a `noError' response is returned). Otherwise, the management protocol set operation fails with an error of `inconsistentValue'. NOTE WELL A conceptual row having a status column with value `notInService' or `notReady' is unavailable to the managed device. As such, it is possible for the managed device to create its own instances during the time between the management protocol set operation which sets the status column to `createAndWait' and the management protocol set operation which sets the status column to `active'. In this case, when the management protocol set operation is issued to set the status column to `active', the values held in the agent supersede those used by the managed device. If the management station is prevented from setting the status column to `active' (e.g., due to management station or network failure) the conceptual row will be left in the `notInService' or `notReady' state, consuming resources indefinitely. The agent must detect conceptual rows that have been in either state for an abnormally long period of time and remove them. It is the responsibility of the DESCRIPTION clause of the status column to indicate what an abnormally long period of time would be. This period of time should be long enough to allow for human response time (including `think time') between the creation of the conceptual row and the setting of the status to `active'. In the absence of such information in the DESCRIPTION clause, it is suggested that this period be approximately 5 minutes in length. This removal action applies not only to newly-created rows, but also to previously active rows which are set to, and left in, the notInService state for a prolonged period exceeding that which is considered normal for such a conceptual row. Conceptual Row Suspension When a conceptual row is `active', the management station may issue a management protocol set operation which sets the instance of the status column to `notInService'. If the agent is unwilling to do so, the set operation fails with an error of `wrongValue' or `inconsistentValue'. Otherwise, the conceptual row is taken out of service, and a `noError' response is returned. It is the responsibility of the DESCRIPTION clause of the status column to indicate under what circumstances the status column should be taken out of service (e.g., in order for the value of some other column of the same conceptual row to be modified). Conceptual Row Deletion For deletion of conceptual rows, a management protocol set operation is issued which sets the instance of the status column to `destroy'. This request may be made regardless of the current value of the status column (e.g., it is possible to delete conceptual rows which are either `notReady', `notInService' or `active'.) If the operation succeeds, then all instances associated with the conceptual row are immediately removed. · Integer32

An object that allows entries in this table to be created and deleted using the RowStatus convention.

Counter32

The number of NHRP Resolution Requests received by this server. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime.

Counter32

The number of positively acknowledged NHRP Resolution Replies transmitted by this server. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime.

Counter32

The number of NAKed NHRP Resolution Replies transmitted by this server with the code 'Administratively Prohibited'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime.

Counter32

The number of NAKed NHRP Resolution Replies transmitted by this server with the code 'Insufficient Resources'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime.

Counter32

The number of NAKed NHRP Resolution Replies transmitted by this server with the code 'No Internetworking Layer Address to NBMA Address Binding Exists'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime.

Counter32

The number of NAKed NHRP Resolution Replies transmitted by this server with the code 'Binding Exists But Is Not Unique'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime.

Counter32

The number of NHRP Registration Requests received by this server. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime.

Counter32

The number of positively acknowledged NHRP Registration Replies transmitted by this server. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime.

Counter32

The number of NAKed NHRP Registration Replies transmitted by this server with the code 'Administratively Prohibited'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime.

Counter32

The number of NAKed NHRP Registration Replies transmitted by this server with the code 'Insufficient Resources'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime.

Counter32

The number of NAKed NHRP Registration Replies transmitted by this server with the code 'Unique Internetworking Layer Address Already Registered'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime.

Counter32

The number of NHRP Purge Requests received by this server. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime.

Counter32

The number of NHRP Purge Requests transmitted by this server. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime.

Counter32

The number of NHRP Purge Replies received by this server. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime.

Counter32

The number of NHRP Purge Replies transmitted by this server. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime.

Counter32

The number of NHRP Error Indication packets received by this server with the error code 'Unrecognized Extension'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime. ⓘ

Counter32

The number of NHRP Error Indication packets received by this server with the error code 'NHRP Loop Detected'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime. ⓘ

Counter32

The number of NHRP Error Indication packets received by this server with the error code 'Protocol Address Unreachable'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime. ⓘ

Counter32

The number of NHRP Error Indication packets received by this server with the error code 'Protocol Error'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime. ⓘ

Counter32

The number of NHRP Error Indication packets received by this server with the error code 'NHRP SDU Size Exceeded'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime. ⓘ

Counter32

The number of NHRP Error Indication packets received by this server with the error code 'Invalid Extension'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime. ⓘ

Counter32

The number of NHRP Error Indication packets received by this server with the error code 'Invalid Resolution Reply Received'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime. ⓘ

Counter32

The number of NHRP Error Indication packets received by this server with the error code 'Authentication Failure'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime. ⓘ

Counter32

The number of NHRP Error Indication packets received by this server with the error code 'Hop Count Exceeded'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime. ⓘ

Counter32

The number of NHRP Error Indication packets transmitted by this server with the error code 'Unrecognized Extension'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime. ⓘ

Counter32

The number of NHRP Error Indication packets transmitted by this server with the error code 'NHRP Loop Detected'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime. ⓘ

Counter32

The number of NHRP Error Indication packets transmitted by this server with the error code 'Protocol Address Unreachable'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime. ⓘ

Counter32

The number of NHRP Error Indication packets transmitted by this server with the error code 'Protocol Error'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime. ⓘ

Counter32

The number of NHRP Error Indication packets transmitted by this server with the error code 'NHRP SDU Size Exceeded'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime. ⓘ

Counter32

The number of NHRP Error Indication packets transmitted by this server with the error code 'Invalid Extension'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime. ⓘ

Counter32

The number of NHRP Error Indication packets transmitted by this server with the error code 'Authentication Failure'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime. ⓘ

Counter32

The number of NHRP Error Indication packets transmitted by this server with the error code 'Hop Count Exceeded'. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime. ⓘ

Counter32

The number of NHRP Resolution Requests forwarded by this server acting as a transit NHS. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime.

Counter32

The number of NHRP Resolution Replies forwarded by this server acting as a transit NHS. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime.

Counter32

The number of NHRP Registration Requests forwarded by this server acting as a transit NHS. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime.

Counter32

The number of NHRP Registration Replies forwarded by this server acting as a transit NHS. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime.

Counter32

The number of NHRP Purge Requests forwarded by this server acting as a transit NHS. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime.

Counter32

The number of NHRP Purge Replies forwarded by this server acting as a transit NHS. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime.

Counter32

The number of NHRP Error Indication packets forwarded by this server acting as a transit NHS. Discontinuities in the value of this counter can occur at re-initialization of the management system, at NHRP Server re-initialization and at other times as indicated by the value of nhrpServerStatDiscontinuityTime.

TimeStampThe value of the sysUpTime object at which a specific occurrence happened. The specific occurrence must be defined in the description of any object defined using this type. If sysUpTime is reset to zero as a result of a re- initialization of the network management (sub)system, then the values of all TimeStamp objects are also reset. However, after approximately 497 days without a re- initialization, the sysUpTime object will reach 2^^32-1 and then increment around to zero; in this case, existing values of TimeStamp objects do not change. This can lead to ambiguities in the value of TimeStamp objects. · TimeTicks

The value of sysUpTime on the most recent occasion at which any one or more of this Server's counters suffered a discontinuity. If no such discontinuities have occurred since the last re-initialization of the local management subsystem or the NHRP Server re-initialization associated with this entry, then this object contains a zero value. ⓘ