MA5600T&MA5603T ifIndex MIB Encoding Rules
SmartAX MA5600T&MA5603T Multi-Service Access Module DOCPROPERTY ProductVersion ifIndex MIB Encoding Rules
Issue1.08
Date2014-04-30
Copyright Huawei Technologies Co., Ltd. 2013. All rights reserved.No part of this document may be reproduced or transmitted in any form or by any means without prior written consent of Huawei Technologies Co., Ltd.
Trademarks and Permissions and other Huawei trademarks are trademarks of Huawei Technologies Co., Ltd.
All other trademarks and trade names mentioned in this document are the property of their respective holders.
Notice
The purchased products, services and features are stipulated by the contract made between Huawei and the customer. All or part of the products, services and features described in this document may not be within the purchase scope or the usage scope. Unless otherwise specified in the contract, all statements, information, and recommendations in this document are provided "AS IS" without warranties, guarantees or representations of any kind, either express or implied.
The information in this document is subject to change without notice. Every effort has been made in the preparation of this document to ensure accuracy of the contents, but all statements, information, and recommendations in this document do not constitute a warranty of any kind, express or implied.
Huawei Technologies Co., Ltd.
Address:Huawei Industrial Base
Bantian, Longgang
Shenzhen 518129
People's Republic of China
Website:http://www.huawei.com
Email:[email protected]
About This Document
Author
Prepared bySun Ruiyan Date2009-12-09
Reviewed byLi Xinyi
Xu Xin
Li Honghai
Xie Xianhu
Luo Liang
Pei DaoyuLi KeDate2010-03-16
Approved byZhen FangminDate2010-03-18
Approved byZhang ZhaoDate2010-03-19
HistoryIssueDetailsDateAuthor
V1.00First release version.2009-12-09Sun Ruiyan
V1.011. Added boards supporting types of interfaces.2. Added interface types, shelf IDs, slot IDs, SNs, and ranges of parameters.3. Added SN description.2010-03-19Sun Ruiyan
V1.024. Added value remarks for the shelf ID.5. Added encoding rules for the xDSL channel.2010-03-29Sun Ruiyan
V1.03Add parenthesis for comments.2010-5-14Zhou Xinru
V1.04Change xDSL channel range2010-8-20Li Xinyi
V1.05Added description for ifIndex of L3 interface in chapter 2.22010-09-03Xu xin
V1.06Modified the title page for general versions.2013-06-14Song Jialei
V1.07Modified the chapter 2.2
REF _Ref255560517 \h Encoding Rules.2013-12-18Tang Jianwen
V1.08Added description for the ifindex recorded in the operation log in chapter 2.2 Note. 2014-04-21Liu Weiwen
Keywords:MA5600T&MA5603T, ifIndex (interface index)Abstract:
This document describes the common ifIndex encoding rules of the MA5600T&MA5603T, which provides the reference for deployment and routine maintenance.Contents
11 Overview of ifIndex
22 ifIndex Encoding Rules
22.1 Encoding Element
32.2 Encoding Rules
62.3 Internal Interface
82.4 Encoding Examples
1 Overview of ifIndex
RFC2863 (RFC1213) defines ifTable MIB to manage various types of interfaces provided by devices in the network in a unified manner. In ifTable, the ifIndex is defined as the index of every interface. As defined in RFC2863, ifIndex ranges from 1 to ifNumber (the number of interfaces currently provided by a device in a network). In addition, ifNumber maps an interface uniquely in the stable period (that is, from the current system start to the next system start). Note that RFC does not define meanings of interfaces; therefore, the interfaces can be specific physical interfaces or abstract network interfaces. Working as the network access product, the MA5600T&MA5603T supports a large number of services that are configured based on different interfaces, such as ADSL, SHDSL, and Ethernet interfaces. Therefore, generally, the network device interfaces of the MA5600T&MA5603T that map ifTable are specific interfaces; however, there are also abstract network interfaces. In addition, there are various types of interfaces for service access. To facilitate unified management, the indexes of different types of physical interfaces are encoded in a systematic manner in the MA5600T&MA5603T. In this case, the range of ifIndex displayed on the MA5600T&MA5603T is not subject to 1ifNumber.2 ifIndex Encoding Rules
This chapter describes the ifIndex encoding rules based on different interfaces.2.1 Encoding Element
Generally, the ifIndex of an interface of the MA5600T&MA5603T depends on the following elements: Internal interface
Shelf ID of the interface, ranging from 0 to 1 (currently, only 0 is used and 1 is reserved for expansion.) Slot ID of the interface, ranging from 0 to 22
Sequence number (SN) of the interface (for value range, see 2.2
REF _Ref255560525 \h \* MERGEFORMAT Encoding Rules) (Here, the SN can be a port ID, or a VLAN ID, or IMA group ID or IMA link ID.)
Interface parameter (for parameters, see 2.2
REF _Ref255560525 \h \* MERGEFORMAT Encoding Rules) (currently, this element is used for only xDSL channel interfaces)
The ifIndex encoding of an interface is a 32-bit digit. The sequence of the preceding five elements in the ifIndex encoding is encoding, shelf ID, slot ID, SN, and parameter in a descending order.
In the ifIndex encoding, the SN refers to the ID of the interface such as the ADSL interface, SHDSL interface, and Ethernet interface. In the case of the abstract interface, the SN is the index of the system resource because the interface does not have the mapping interface. The Ethernet VLAN interface is such an interface.
To configure the encoding rules, the shelf and slot IDs of the Ethernet VLAN interface invariably use the shelf ID and slot ID of the active control board, and the SN of the Ethernet VLAN interface is the index of the VLAN.
The Ethernet VLAN interface is used for only creating the service interface and is invisible in ifTable and ifXTable.
2.2 Encoding RulesThe rules for internal interface encoding are listed in the following table. InterfaceEncoding Rules
M ( L
7 bits
000 000 06 bits
000 0006 bits
000 00013 bits
000 000 000 000 0
Internal InterfaceShelf IDSlot IDSN
Ethernet VLAN480102214095
GPON12501022000 00
070 000 000 0
Reserved
EPON12601022000 00
070 000 000 0
Reserved
TDM upstream E19701022000 00
0150 000 000 0
Reserved
ATM401022000 000 0030 000 000 0
Reserved
ADSL601022000 000 0
06300 000 0
Reserved
VDSL212401022000 000 0
04700 000 0
Reserved
SHDSL4401022000 000 0
01500 000 0
Reserved
Ethernet interface701022000 000 0
04700 000 0
Reserved
IMA3901022000 000 0
163100 000 0
Reserved
IMA link5101022000 000 0
01500 000 0
Reserved
Trunk aggregation5401022000 000 0
04700 000 0
Reserved
BITS9601022000 000 0
0100 000 0
Reserved
xDSL channel12301022000 000 0
06300 000 0
12
DOCSIS up channel5903101000 000000 00014
DOCSIS down channel6003101000 000000 000116
DOCSIS port6103101000000 000 000Reserved
If the Shelf ID is equal to or larger than 32, the rules for the following internal interface encoding are extended. Specifically, the Shelf ID occupies 9 bits and the most significant bit is 1. Bits occupied by Slot ID and Port ID remain the same. For details, see the following.InterfaceEncoding Rules
M ( L
7 bits
000 000 09 bits
000 000 0006 bits
000 00010 bits
000 000 000 0
Internal InterfaceShelf IDSlot IDSN
GPON125288384022000 0007000 00Reserved
EPON126288384022000 0007000 00Reserved
ADSL6288384022000 000 0063000 Reserved
VDSL2124288384022000 000 0047000Reserved
xDSL channel123288384022000 000 006300012
Ethernet interface7288384022000 000 004700012
DOCSIS up channel5928838401000 000000 00014
DOCSIS down channel6028838401000 000000 000116
DOCSIS port6128838401000 000000 000Reserved
In the case of the abstract interface, the ifIndex is the index of the system resource allocated from internal index pool because the interface does not provide the fixed encoding rule. The Ethernet VLAN L3 interface & loopback interface & null interface are such interfaces, so for these abstract interfaces the encoding rule is invisible for OSS system.The MA5600T&MA5603T system provides a query interface (get) in MIB for VLAN L3 interface & loopback interface & null interface so that the operator/OSS can use this query interface to get ifIndex for specific L3 interface or loopback interface.
For details of query interface, see chapter 1.6.9 in the HUAWEI-ANSOI-INTERFACE.Configure the MA5600T&MA5603T through the OSS system, if the ifindex recorded in the operation log of the MA5600T&MA5603T system is a negative value, the ifindex is converted to Integer32. Then, need to convert the value to Unsigned Integer32 to show a correct ifindex.2.3 Internal Interface
The enumerated values of the MA5600T&MA5603T interfaces are as follows. Internal InterfaceEnumerated Values in MIBRemarks
ATM4ATM interface
Supported by H801AIUG.
ADSL6ADSL interface
Supported by H808ADIE, H805ADLF, H808ADIF, H808ADLF, H802ADKM, H802ADPD, H802ADQD, and H805ADPD.
Ethernet7Ethernet switch interface
Supported by H801SCUN, H801SCUB, H801SCUF, H801X1CA, H801X2CA, H801X2CS, H801GICG, H801GICF, H801GICK, H801GICD, H801GICE, H801GSCA, H801GICA, H801SPUA, H801ETHA, H801ETHB, H801OPFA, and H801OPGD.
IMA39IMA interface
Supported by H80ASHLM.
SHDSL44SHDSL interface
Supported by H802SHLB, H80ASHLM, and H803SHDA.
Ethernet VLAN48Virtual Ethernet interface, only applied to service connection management. It is invisible in ifTable and ifXTable.
IMA link51IMA link interface
Supported by H80ASHLM.
Trunk aggregation54Trunk aggregation interface
Supported by H801SCUN, H801SCUB, H801SCUF, H801X1CA, H801X2CA, H801X2CS, H801GICG, H801GICF, H801GICK, H801GICD, H801GICE, H801GSCA, H801GICA, H801SPUA, H801ETHA, H801ETHB, H801OPFA, and H801OPGD.
DOCSIS up channel59DOCSIS up channelSupported by MA5633
DOCSIS down channel60DOCSIS down channelSupported by MA5633
DOCSIS PORT61DOCSIS portSupported by MA5633
BITS96BITS interface
Supported by H801BIUA, H801BIUB, and H801CITD.
E197E1 interface
Supported by H801TOPA.
VDSL2124VDSL2 interface
Supported by H805VDSF, H805VDSA, H805VDTF, H805VDRD, H805VDMF, H802VDNF, H80BVDMM, and H802VDJM.
GPON125GPON interface
EPON126EPON interface
xDSL channel123xDSL channel interfaceSupported by H808ADIE, H805ADLF, H808ADIF, H808ADLF, H802ADKM, H802ADPD, H802ADQD, H805ADPD, H805VDSF, H805VDSA, H805VDTF, H805VDRD, H805VDMF, H802VDNF, H80BVDMM, and H802VDJM.
2.4 Encoding Examples
Example 1. To encode ADSL interface 0/3/0 (shelf/slot/interface), do as follows:Encoding: ADSL (6): 0000110, 7 bitsShelf 0: 000000, 6 bitsSlot 3: 000011, 6 bitsSN 0: 0000000, 7 bitsReserved: 000000, 6 bitsBinary code of the ifIndex: 00001100000000000110000000000000Corresponding decimal number: 201351168 Example 2. To encode GPON interface 0/5/1 (shelf/slot/interface), do as follows:
Encoding: GPON (125): 1111101, 7 bitsShelf 0: 000000, 6 bitsSlot 5: 000101, 6 bitsSN 1: 00001, 5 bitsReserved: 00000000, 8 bitsBinary code of the ifIndex: 11111010000000001010000100000000Corresponding decimal number: 4194345216 Example 3. To encode an xDSL channel interface of channel 1 in interface 0/11/1 (shelf/slot/interface), do as follows:
Encoding: xDSL channel (123): 1111011, 7 bitsShelf 0: 000000, 6 bitsSlot 11: 001011, 6 bitsSN 1: 0000001, 7 bitsChannel ID1: 000001, 6 bitsBinary code of the ifIndex: 11110110000000010110000001000001Corresponding decimal number: 4127285313 Example 4. To encode an interface of VLAN 100, do as follows:
Encoding: Ethernet VLAN (48): 0110000, 7 bitsShelf 0: 000000, 6 bitsSlot 10: 001010, 6 bitsSN 100: 0000001100100, 13 bitsBinary code of the ifIndex: 01100000000000010100000001100100Corresponding decimal number: 1610694756 Example 5. To obtain the information about the ADSL interface from ifIndex, do as follows:
Index: 201343040Corresponding binary number (appended with 32 bits in higher bit: 00001100000000000100000001000000)Encoding: 0000110, that is, ADSL (6), index of its mapping interface has 7 bits.Shelf ID: 000000, that is, shelf 0.Slot ID: 000010, that is, slot 2.Interface ID: 0000001, that is, interface 1.Reserved: 000000, 6 bits Example 6. To obtain the information about the VLAN interface from ifIndex, do as follows:Index: 1610694756Corresponding binary number (appended with 32 bits in higher bit: 01100000000000010100000001100100)Encoding: 0110000, that is, Ethernet VLAN (48), index of its mapping interface has 13 bitsShelf ID: 000000, that is, shelf 0.Slot ID: 001010, that is, slot 10, which is used for the active control board.
Slot index: 0000001100100, that is, VLAN 100. Example 7. To obtain the information about the GPON interface from ifIndex, do as follows:
Index: 4194345728Corresponding binary number (appended with 32 bits in higher bit: 11111010000000001010001100000000)Encoding: 1111101, that, is, GPON (125), index of its mapping interface has 7 bits.Shelf ID: 000000, that is, shelf 0.Slot ID: 000101, that is, slot 5.Interface ID: 00011, that is, interface 3.Reserved: 00000000, 8 bits Example 8. To obtain the information about the xDSL channel interface from ifIndex, do as follows:
Index: 4127260673Corresponding binary number (appended with 32 bits in higher bit: 11110110000000010000000000000001)Encoding: 1111011, that is, xDSL channel (123), index of its mapping interface has 7 bits.Shelf ID: 000000, that is, shelf 0.Slot ID: 001000, that is, slot 8.Interface ID: 0000000, that is, interface 0.Channel ID: 000001, that is, channel 1.ixHuawei Proprietary and Confidential Copyright Huawei Technologies Co., LtdIssue 1.07 (2013-12-18)