CISCO-APS-EXT-MIB

INTEGER1 = hopByHop2 = endToEnd · Integer32

The span (hopByHop or endToEnd) for the APS group. hopByHop This refers to linear APS, e.g. linear SONET APS, or hopByHop CDL APS. In a DWDM system, an APS channel may be associated with either an individual wavelength or an optical fiber. All APS channels within an APS group must be of the same type. Systems that support linear APS on an individual wavelength basis, must assign an ifIndex to each such wavelength. endToEnd This refers to path APS, e.g. endToEnd CDL APS. In this configuration, each APS channel in the APS group is associated with an endToEnd user path. This codepoint does not apply to interfaces with an ifType value of 'sonet'. This object may not be modified if the associated cApsConfigRowStatus object is equal to 'active'.

INTEGER1 = noYcable2 = ycable3 = ycableXconnectCommon · Integer32

The Y-cable configuration for the APS group associated with user channels. noYcable The APS channels in the APS group are not connected to an external Y-cable. ycable Two user-side interfaces (not necessarily SONET or CDL) are connected to an external y-cable and are grouped into an APS group for endToEnd APS. The received user signal is split in the y-cable coupler and is received on both the interfaces. However, only one interface must transmit toward the user at any given time. With cApsConfigYcable set to 'ycable', the cApsConfigSpan must be set to 'endToEnd'. There must be only two APS channels in an APS group with cApsConfigYcable set to 'ycable'. ycableXconnectCommon This refers to a configuration where two user-side interfaces are connected to an external y-cable. The two signals received on these interface are connected to the same cross connect in the switch. The switch fabric selects one of the two received signals, duplicates it, and forwards it to two network side interfaces grouped for 1+1 linear APS. The received signal from the network side is transmitted to only one user-side interface. cApsConfigSpan is ignored if cApsConfigYcable is set to 'ycableXconnectCommon'. There must be only two APS channels in an APS group with cApsConfigYcable set to 'ycableXconnectCommon'. This object may not be modified if the associated cApsConfigRowStatus object is equal to 'active'. If this object is set to 'ycable' or 'ycableXconnectCommon', the user must shut one of the two channels before setting cApsConfigRowStatus to 'notInService'.

Integer32 (1..120)

This object is instantiated only when the standby interface is not monitored. If both interfaces go down and the standby interface is not monitored, successive switchovers may be used in order to search for an interface that is up. This object specifies the minimum time interval between switchovers when both interfaces go down. A backoff algorithm should be used to increase the time interval between successive switchovers.

Integer32 (1..120) · seconds

This object is instantiated only when the standby interface is not monitored. If both interfaces go down and the standby interface is not monitored, successive switchovers may be used in order to search for an interface that is up. This object specifies the maximum time interval between switchovers when both interfaces go down.

Integer32 (1..120) · seconds

This object specifies the value of the timer to control the minimum interval between switchovers. After a switchover, APS is re-enabled only after this amount of time has elapsed, in order to prevent quick successive switchovers.

CApsMessageTransport1 = none2 = autoSelect3 = dcc4 = apsChannel5 = ip6 = oscThe type of transport used to exchange APS protocol messages. none There is no APS message exchange between the endpoints of the associated channels. autoSelect APS automatically selects a transport mechanism to send APS messages. The following transport mechanisms are attempted, in the following order of priority: - apsChannel - dcc - osc dcc APS messages are transmitted over the data communications channels (DCCs) in the overhead of the associated channels. apsChannel APS messages are transmitted in overhead bytes of the associated channels that are defined specifically to carry APS messages. ip APS messages are transmitted over IP. The IP network can consist of any combination of data communication channels (DCCs), optical supervisory channels (OSCs), and out-of-band Data Communication Networks (DCNs). osc APS messages are transmitted over the Optical Supervisory Channel (OSC). · Integer32

This object specifies the type of transport configured for exchange of APS protocol messages. The type of transport currently being used is indicated in the cApsStatusMessageTransport object. When this object is set to 'ip', values must be specified for the cApsConfigFarEndIpAddressType, cApsConfigFarEndIpAddress and cApsConfigFarEndGroupName objects.

Integer32 (100..10000) · milliseconds

The value specified in this object applies when the value of cApsStatusMessageTransport is 'dcc', 'ip', or 'osc'. APS messages are exchanged between systems to support bidirectional or linear operation. To avoid potential system misbehavior in which APS messages would be triggered in an uncontrolled fashion, a hold down timer is introduced that prevents successive event-triggered APS messages from being sent in too short a time interval. This object specifies the minimum time between event driven requests.

Integer32 (2..10)

The value specified in this object applies when the value of cApsStatusMessageTransport is 'dcc', 'ip', or 'osc'. The maximum number of APS messages that can be sent within one cApsConfigMessageHolddown interval.

Integer32 (1000..120000) · milliseconds

The value specified in this object applies when the value of cApsStatusMessageTransport is 'dcc', 'ip', or 'osc'. An APS message is sent unconditionally, whenever the amount of time specified by this object has elapsed since the last transmission of an APS message.

SnmpAdminStringAn octet string containing administrative information, preferably in human-readable form. To facilitate internationalization, this information is represented using the ISO/IEC IS 10646-1 character set, encoded as an octet string using the UTF-8 transformation format described in [RFC2279]. Since additional code points are added by amendments to the 10646 standard from time to time, implementations must be prepared to encounter any code point from 0x00000000 to 0x7fffffff. Byte sequences that do not correspond to the valid UTF-8 encoding of a code point or are outside this range are prohibited. The use of control codes should be avoided. When it is necessary to represent a newline, the control code sequence CR LF should be used. The use of leading or trailing white space should be avoided. For code points not directly supported by user interface hardware or software, an alternative means of entry and display, such as hexadecimal, may be provided. For information encoded in 7-bit US-ASCII, the UTF-8 encoding is identical to the US-ASCII encoding. UTF-8 may require multiple bytes to represent a single character / code point; thus the length of this object in octets may be different from the number of characters encoded. Similarly, size constraints refer to the number of encoded octets, not the number of characters represented by an encoding. Note that when this TC is used for an object that is used or envisioned to be used as an index, then a SIZE restriction MUST be specified so that the number of sub-identifiers for any object instance does not exceed the limit of 128, as defined by [RFC3416]. Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..32) · OCTET STRING · hint 255t

The value specified in this object applies when the value of cApsStatusMessageTransport is 'dcc', 'ip', or 'osc'. APS messages, used to support bidirectional or linear operation, can be sent out-of-band over an IP network. In this case, this object is used to specify the a textual name for the APS group at the far-end to which the message is being sent.

InetAddressType0 = unknown1 = ipv42 = ipv63 = ipv4z4 = ipv6z16 = dnsA value that represents a type of Internet address. unknown(0) An unknown address type. This value MUST be used if the value of the corresponding InetAddress object is a zero-length string. It may also be used to indicate an IP address that is not in one of the formats defined below. ipv4(1) An IPv4 address as defined by the InetAddressIPv4 textual convention. ipv6(2) An IPv6 address as defined by the InetAddressIPv6 textual convention. ipv4z(3) A non-global IPv4 address including a zone index as defined by the InetAddressIPv4z textual convention. ipv6z(4) A non-global IPv6 address including a zone index as defined by the InetAddressIPv6z textual convention. dns(16) A DNS domain name as defined by the InetAddressDNS textual convention. Each definition of a concrete InetAddressType value must be accompanied by a definition of a textual convention for use with that InetAddressType. To support future extensions, the InetAddressType textual convention SHOULD NOT be sub-typed in object type definitions. It MAY be sub-typed in compliance statements in order to require only a subset of these address types for a compliant implementation. Implementations must ensure that InetAddressType objects and any dependent objects (e.g., InetAddress objects) are consistent. An inconsistentValue error must be generated if an attempt to change an InetAddressType object would, for example, lead to an undefined InetAddress value. In particular, InetAddressType/InetAddress pairs must be changed together if the address type changes (e.g., from ipv6(2) to ipv4(1)). · Integer32

This object can be set only when the value of cApsConfigMessageTransport is 'ip'. This object specifies the type of IP address defined in cApsConfigFarEndIpAddress.

InetAddressDenotes a generic Internet address. An InetAddress value is always interpreted within the context of an InetAddressType value. Every usage of the InetAddress textual convention is required to specify the InetAddressType object that provides the context. It is suggested that the InetAddressType object be logically registered before the object(s) that use the InetAddress textual convention, if they appear in the same logical row. The value of an InetAddress object must always be consistent with the value of the associated InetAddressType object. Attempts to set an InetAddress object to a value inconsistent with the associated InetAddressType must fail with an inconsistentValue error. When this textual convention is used as the syntax of an index object, there may be issues with the limit of 128 sub-identifiers specified in SMIv2, STD 58. In this case, the object definition MUST include a 'SIZE' clause to limit the number of potential instance sub-identifiers; otherwise the applicable constraints MUST be stated in the appropriate conceptual row DESCRIPTION clauses, or in the surrounding documentation if there is no single DESCRIPTION clause that is appropriate. SIZE (0..255) · OCTET STRING

This object can be set only when the value of cApsConfigMessageTransport is 'ip'. This object specifies the IP address of the far end, which is used as the destination address in APS messages transmitted by this network element.

CdlApsBytesThis Textual Convention describes an object that stores the APS protocol field used in CDL. The semantics of the CDL APS protocol field are similar to those of the SONET K1 and K2 byte APS protocol field. SIZE (2) · OCTET STRING

The current value of the APS bytes received on the protection channel. This object applies only to CDL interfaces. This is equivalent to cApsStatusK1K2Rcv for SONET.

CdlApsBytesThis Textual Convention describes an object that stores the APS protocol field used in CDL. The semantics of the CDL APS protocol field are similar to those of the SONET K1 and K2 byte APS protocol field. SIZE (2) · OCTET STRING

The current value of the APS bytes transmitted on the protection channel. This object applies only to CDL interfaces. This is equivalent to cApsStatusK1K2Trans for SONET.

CApsMessageTransport1 = none2 = autoSelect3 = dcc4 = apsChannel5 = ip6 = oscThe type of transport used to exchange APS protocol messages. none There is no APS message exchange between the endpoints of the associated channels. autoSelect APS automatically selects a transport mechanism to send APS messages. The following transport mechanisms are attempted, in the following order of priority: - apsChannel - dcc - osc dcc APS messages are transmitted over the data communications channels (DCCs) in the overhead of the associated channels. apsChannel APS messages are transmitted in overhead bytes of the associated channels that are defined specifically to carry APS messages. ip APS messages are transmitted over IP. The IP network can consist of any combination of data communication channels (DCCs), optical supervisory channels (OSCs), and out-of-band Data Communication Networks (DCNs). osc APS messages are transmitted over the Optical Supervisory Channel (OSC). · Integer32

This object specifies the type of transport currently being used for exchange of APS protocol messages. The value of this object is the same as the value specified in the cApsConfigMessageTransport object, except when the value of that object is 'autoSelect'. In that case, the type of transport that has been automatically selected is indicated by this object.

CApsK1K2This Textual Convention describes an object that stores a SONET K1 and K2 byte Aps protocol field. K1 is located in the first octet, K2 is located in the second octet. Bits are numbered from left to right, with the most significant bit being the leftmost. Bits 1-4 of the K1 byte indicate a request. 1111 Lockout of Protection 1110 Forced Switch 1101 SF - High Priority 1100 SF - Low Priority 1011 SD - High Priority 1010 SD - Low Priority 1001 not used 1000 Manual Switch 0111 not used 0110 Wait-to-Restore 0101 not used 0100 Exercise 0011 not used 0010 Reverse Request 0001 Do Not Revert 0000 No Request Bits 5-8 of the K1 byte indicate the channel associated with the request defined in bits 1-4. 0000 is the Null channel. 1-14 are working channels. 15 is the extra traffic channel Bits 1-4 of the K2 byte indicate a channel. The channel is defined with the same syntax as K1 Bits 5-8. Bit 5 of the K2 byte indicates the architecture. 0 if the architecture is 1+1 1 if the architecture is 1:n Bits 6-8 of the K2 byte indicates the mode. 000 - 011 are reserved for future use 100 indicates the mode is unidirectional 101 indicates the mode is bidirectional 110 RDI-L 111 AIS-LReference: Bellcore (Telcordia Technologies) GR-253-CORE, Issue 2,Revision 2 (January 1999), 5.3.5. SIZE (2) · OCTET STRING

The highest priority local request for a channel in an APS group. This object uses only the 'Type of Request' part (bits 1-4) of the K1 byte.

TruthValue1 = true2 = falseRepresents a boolean value. · Integer32

Indicates whether the channel is in reflector mode or not. Reflector mode establishes a communication channel between the local PTE and the remote PTE at the other end of the SONET path. This object has a value of true(1), if reflector mode is configured and a value of false(2), if the reflector mode is not configured on the channel.

SnmpAdminStringAn octet string containing administrative information, preferably in human-readable form. To facilitate internationalization, this information is represented using the ISO/IEC IS 10646-1 character set, encoded as an octet string using the UTF-8 transformation format described in [RFC2279]. Since additional code points are added by amendments to the 10646 standard from time to time, implementations must be prepared to encounter any code point from 0x00000000 to 0x7fffffff. Byte sequences that do not correspond to the valid UTF-8 encoding of a code point or are outside this range are prohibited. The use of control codes should be avoided. When it is necessary to represent a newline, the control code sequence CR LF should be used. The use of leading or trailing white space should be avoided. For code points not directly supported by user interface hardware or software, an alternative means of entry and display, such as hexadecimal, may be provided. For information encoded in 7-bit US-ASCII, the UTF-8 encoding is identical to the US-ASCII encoding. UTF-8 may require multiple bytes to represent a single character / code point; thus the length of this object in octets may be different from the number of characters encoded. Similarly, size constraints refer to the number of encoded octets, not the number of characters represented by an encoding. Note that when this TC is used for an object that is used or envisioned to be used as an index, then a SIZE restriction MUST be specified so that the number of sub-identifiers for any object instance does not exceed the limit of 128, as defined by [RFC3416]. Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (1..32) · OCTET STRING · hint 255t

A textual name for the APS group which this channel is included in.

CApsChannelConfigNumberThis Textual Convention describes an object that is set to a unique channel number within an APS group. The value 0 indicates the null channel. The values 1-14 define a working channel.Reference: Bellcore (Telcordia Technologies) GR-253-CORE, Issue 2,Revision 2 (January 1999), 5.3.2. (0..14) · Integer32

This field is set to a unique working/protection channel number within an APS group. The value 0 indicates the null channel. The values 1-14 define a working channel.

CApsChannelConfigNumberThis Textual Convention describes an object that is set to a unique channel number within an APS group. The value 0 indicates the null channel. The values 1-14 define a working channel.Reference: Bellcore (Telcordia Technologies) GR-253-CORE, Issue 2,Revision 2 (January 1999), 5.3.2. (0..14) · Integer32

This field is set to the associated working/protection channel number corresponding to the field cApsChanAssociationNumber within an APS group. The value 0 indicates the null channel. The values 1-14 define a working channel.

InetAddressType0 = unknown1 = ipv42 = ipv63 = ipv4z4 = ipv6z16 = dnsA value that represents a type of Internet address. unknown(0) An unknown address type. This value MUST be used if the value of the corresponding InetAddress object is a zero-length string. It may also be used to indicate an IP address that is not in one of the formats defined below. ipv4(1) An IPv4 address as defined by the InetAddressIPv4 textual convention. ipv6(2) An IPv6 address as defined by the InetAddressIPv6 textual convention. ipv4z(3) A non-global IPv4 address including a zone index as defined by the InetAddressIPv4z textual convention. ipv6z(4) A non-global IPv6 address including a zone index as defined by the InetAddressIPv6z textual convention. dns(16) A DNS domain name as defined by the InetAddressDNS textual convention. Each definition of a concrete InetAddressType value must be accompanied by a definition of a textual convention for use with that InetAddressType. To support future extensions, the InetAddressType textual convention SHOULD NOT be sub-typed in object type definitions. It MAY be sub-typed in compliance statements in order to require only a subset of these address types for a compliant implementation. Implementations must ensure that InetAddressType objects and any dependent objects (e.g., InetAddress objects) are consistent. An inconsistentValue error must be generated if an attempt to change an InetAddressType object would, for example, lead to an undefined InetAddress value. In particular, InetAddressType/InetAddress pairs must be changed together if the address type changes (e.g., from ipv6(2) to ipv4(1)). · Integer32

This object specifies the type of IP address defined in cApsChanAssociationIpAddress.

InetAddressDenotes a generic Internet address. An InetAddress value is always interpreted within the context of an InetAddressType value. Every usage of the InetAddress textual convention is required to specify the InetAddressType object that provides the context. It is suggested that the InetAddressType object be logically registered before the object(s) that use the InetAddress textual convention, if they appear in the same logical row. The value of an InetAddress object must always be consistent with the value of the associated InetAddressType object. Attempts to set an InetAddress object to a value inconsistent with the associated InetAddressType must fail with an inconsistentValue error. When this textual convention is used as the syntax of an index object, there may be issues with the limit of 128 sub-identifiers specified in SMIv2, STD 58. In this case, the object definition MUST include a 'SIZE' clause to limit the number of potential instance sub-identifiers; otherwise the applicable constraints MUST be stated in the appropriate conceptual row DESCRIPTION clauses, or in the surrounding documentation if there is no single DESCRIPTION clause that is appropriate. SIZE (0..255) · OCTET STRING

IP Address of the working/protection channel. If cApsChanAssociationNumber represents a working channel number, this object indicates the IP Address of the associated protection channel. If cApsChanAssociationNumber represents a protection channel number, this object indicates the IP Address of the associated working channel.