The Duplex is an enumeration representing the configured, negotiated, or actual duplex mode of an Ethernet interface (aDuplexStatus is defined in IEEE 802.3-2022, 30.3.1.1.32, aDuplexStatus). The values of the Duplex Enumeration are defined in Table 18.
Name |
Value |
Description |
Full |
0 |
Full duplex. |
Half |
1 |
Half duplex. |
Unknown |
2 |
Link is currently disconnected or initializing. |
Its representation in the AddressSpace is defined in Table 19.
Attribute |
Value |
|||||
BrowseName |
Duplex |
|||||
IsAbstract |
False |
|||||
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
Subtype of the Enumeration type defined in OPC 10000-5 |
||||||
HasProperty |
Variable |
EnumValues |
EnumValueType[] |
PropertyType |
|
|
Conformance Units |
||||||
BNM Ethernet Base Info |
The InterfaceAdminStatus is an enumeration for the possible desired states of the network interface (ifAdminStatus is defined in IETF RFC 2863: The Interfaces Group MIB - ifAdminStatus). The values of the InterfaceAdminStatus Enumeration are defined in Table 20.
Table 20 – InterfaceAdminStatus Values
Name |
Value |
Description |
Up |
0 |
Ready to pass packets. |
Down |
1 |
Not ready to pass packets and not in some test mode. |
Testing |
2 |
In some test mode. |
Its representation in the AddressSpace is defined in Table 21.
Table 21 – InterfaceAdminStatus Definition
Attribute |
Value |
|||||
BrowseName |
InterfaceAdminStatus |
|||||
IsAbstract |
False |
|||||
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
Subtype of the Enumeration type defined in OPC 10000-5 |
||||||
HasProperty |
Variable |
EnumValues |
EnumValueType[] |
PropertyType |
|
|
Conformance Units |
||||||
BNM Ethernet Base Info |
The InterfaceOperStatus is an enumeration for the possible operational states of the network interface (ifOperStatus is defined in IETF RFC 2863: The Interfaces Group MIB - ifOperStatus). The values of the InterfaceOperStatus Enumeration are defined in Table 22.
Table 22 – InterfaceOperStatus Values
Name |
Value |
Description |
Up |
0 |
Ready to pass packets. |
Down |
1 |
The interface does not pass any packets. |
Testing |
2 |
In some test mode. No operational packets can be passed. |
Unknown |
3 |
Status cannot be determined for some reason. |
Dormant |
4 |
Waiting for some external event. |
NotPresent |
5 |
Some component (typically hardware) is missing. |
LowerLayerDown |
6 |
Down due to state of lower-layer interface(s). |
Its representation in the AddressSpace is defined in Table 23.
Table 23 – InterfaceOperStatus Definition
Attribute |
Value |
|||||
BrowseName |
InterfaceOperStatus |
|||||
IsAbstract |
False |
|||||
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
Subtype of the Enumeration type defined in OPC 10000-5 |
||||||
HasProperty |
Variable |
EnumValues |
EnumValueType[] |
PropertyType |
|
|
Conformance Units |
||||||
BNM Ethernet Base Info |
The NegotiationStatus is an enumeration representing the status of the auto-negotiation protocol (aAutoNegAutoConfig is defined in IEEE 802.3-2022, clause 30.6.1.1.4, aAutoNegAutoConfig). The values of the NegotiationStatus Enumeration are defined in Table 24.
Table 24 – NegotiationStatus Values
Name |
Value |
Description |
InProgress |
0 |
The auto-negotiation protocol is running and negotiation is currently in-progress. |
Complete |
1 |
The auto-negotiation protocol has completed successfully. |
Failed |
2 |
The auto-negotiation protocol has failed. |
Unknown |
3 |
The auto-negotiation status is not currently known, this could be because it is still negotiating or the protocol cannot run (e.g., if no medium is present). |
NoNegotiation |
4 |
No auto-negotiation is executed. The auto-negotiation function is either not supported on this interface or has not been enabled. |
Its representation in the AddressSpace is defined in Table 25.
Table 25 – NegotiationStatus Definition
Attribute |
Value |
|||||
BrowseName |
NegotiationStatus |
|||||
IsAbstract |
False |
|||||
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
Subtype of the Enumeration type defined in OPC 10000-5 |
||||||
HasProperty |
Variable |
EnumValues |
EnumValueType[] |
PropertyType |
|
|
Conformance Units |
||||||
BNM AutoNeg |
The TsnFailureCode is an Enumeration to provide detailed error information for failures occurring during TSN stream establishment (TSN Failure Codes are defined in IEEE 802.1Qcc-2018, Table 46-15, TSN Failure Codes). The TsnFailureCode Enumeration is defined in Table 26.
Table 26 – TsnFailureCode values
Name |
Value |
Description |
NoFailure |
0 |
No failure |
InsufficientBandwidth |
1 |
Insufficient bandwidth |
InsufficientResources |
2 |
Insufficient bridge resources |
InsufficientTrafficClassBandwidth |
3 |
Insufficient bandwidth for Traffic Class |
StreamIdInUse |
4 |
StreamID in use by another Talker |
StreamDestinationAddressInUse |
5 |
Stream destination address already in use |
StreamPreemptedByHigherRank |
6 |
Stream pre-empted by higher rank |
LatencyHasChanged |
7 |
Reported latency has changed |
EgressPortNotAvbCapable |
8 |
Egress port is not AVBCapable |
UseDifferentDestinationAddress |
9 |
Use a different destination address |
OutOfMsrpResources |
10 |
Out of MSRP resources |
OutOfMmrpResources |
11 |
Out of MMRP resources |
CannotStoreDestinationAddress |
12 |
Cannot store destination address |
PriorityIsNotAnSrcClass |
13 |
Requested priority is not an SR Class priority |
MaxFrameSizeTooLarge |
14 |
MaxFrameSize is too large for media |
MaxFanInPortsLimitReached |
15 |
MaxFanInPorts limit has been reached |
FirstValueChangedForStreamId |
16 |
Changes in FirstValue for a registered StreamID |
VlanBlockedOnEgress |
17 |
VLAN is blocked on this egress port (Registration Forbidden) |
VlanTaggingDisabledOnEgress |
18 |
VLAN tagging is disabled on this egress port (untagged set) |
SrClassPriorityMismatch |
19 |
SR class priority mismatch |
FeatureNotPropagated |
20 |
Enhanced feature cannot be propagated to original Port |
MaxLatencyExceeded |
21 |
MaxLatency exceeded |
BridgeDoesNotProvideNetworkId |
22 |
Nearest Bridge cannot provide network identification for stream transformation |
StreamTransformNotSupported |
23 |
Stream transformation not supported |
StreamIdTypeNotSupported |
24 |
Stream identification type not supported for stream transformation |
FeatureNotSupported |
25 |
Enhanced feature cannot be supported without a CNC |
Its representation in the AddressSpace is defined in Table 27.
Table 27 – TsnFailureCode Definition
Attribute |
Value |
|||||
BrowseName |
TsnFailureCode |
|||||
IsAbstract |
False |
|||||
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
Subtype of the Enumeration type defined in OPC 10000-5 |
||||||
HasProperty |
Variable |
EnumValues |
EnumValueType[] |
PropertyType |
|
|
Conformance Units |
||||||
BNM TSN Base Info |
The TsnStreamState is an enumeration representing the state of the configuration process of a TSN Talker or Listener.
The default value is Disabled. The TsnStreamState Enumeration is defined in Table 28.
Table 28 – TsnStreamState Values
Its representation in the AddressSpace is defined in Table 29.
Table 29 – TsnStreamState Definition
Attribute |
Value |
|||||
BrowseName |
TsnStreamState |
|||||
IsAbstract |
False |
|||||
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
Subtype of the Enumeration type defined in OPC 10000-5 |
||||||
HasProperty |
Variable |
EnumValues |
EnumValueType[] |
PropertyType |
|
|
Conformance Units |
||||||
BNM TSN Base Info |
The TsnTalkerStatus is an enumeration representing the state of the TSN Talker configuration.
The default value is None. The TsnTalkerStatus Enumeration is defined in Table 30Table 30.
Table 30 – TsnTalkerStatus Values
Name |
Value |
Description |
None |
0 |
No Talker detected. |
Ready |
1 |
Talker ready (configured). |
Failed |
2 |
Talker failed. |
Its representation in the AddressSpace is defined in Table 31Table 31.
Table 31 – TsnTalkerStatus Definition
Attribute |
Value |
|||||
BrowseName |
TsnTalkerStatus |
|||||
IsAbstract |
False |
|||||
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
Subtype of the Enumeration type defined in OPC 10000-5 |
||||||
HasProperty |
Variable |
EnumValues |
EnumValueType[] |
PropertyType |
|
|
Conformance Units |
||||||
BNM TSN Base Info |
The TsnListenerStatus is an enumeration representing the state of the TSN Listener configuration.
The default value is None. The TsnListenerStatus Enumeration is defined in Table 32Table 32.
Table 32 – TsnListenerStatus Values
Name |
Value |
Description |
None |
0 |
No Listener detected. |
Ready |
1 |
Listener ready (configured). |
PartialFailed |
2 |
One or more Listeners ready, and one or more Listeners failed. |
Failed |
3 |
Listener failed. |
Its representation in the AddressSpace is defined in Table 33Table 33.
Table 33 – TsnListenerStatus Definition
Attribute |
Value |
|||||
BrowseName |
TsnListenerStatus |
|||||
IsAbstract |
False |
|||||
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
Subtype of the Enumeration type defined in OPC 10000-5 |
||||||
HasProperty |
Variable |
EnumValues |
EnumValueType[] |
PropertyType |
|
|
Conformance Units |
||||||
BNM TSN Base Info |
The ChassisIdSubtype is an enumeration representing different types of chassis identifier as defined in IEEE 802.1AB-2016, Table 8-2, chassis ID subtype.
The ChassisIdSubtype Enumeration is defined in Table 34.
Table 34 – ChassisIdSubtype Values
Name |
Value |
Description |
ChassisComponent |
1 |
Represents a chassis identifier based on the value of entPhysicalAlias object (defined in IETF RFC 2737) for a chassis component (i.e., an entPhysicalClass value of chassis(3)) |
InterfaceAlias |
2 |
Represents a chassis identifier based on the value of ifAlias object (defined in IETF RFC 2863) for an interface on the containing chassis. |
PortComponent |
3 |
Represents a chassis identifier based on the value of entPhysicalAlias object (defined in IETF RFC 2737) for a port or backplane component (i.e., entPhysicalClass has a value of port(10), or backplane(4)), within the containing chassis. |
MacAddress |
4 |
Represents a chassis identifier based on the value of a unicast source address (encoded in network byte order and IEEE 802.3 canonical bit order) of a port on the containing chassis as defined in IEEE Std 802-2014. |
NetworkAddress |
5 |
Represents a chassis identifier based on a network address associated with a particular chassis. The encoded address is actually composed of two fields. The first field is a single octet, representing the IANA AddressFamilyNumbers value for the specific address type, and the second field is the network address value. |
InterfaceName |
6 |
Represents a chassis identifier based on the value of ifName object (defined in IETF RFC 2863) for an interface on the containing chassis. |
Local |
7 |
Represents a chassis identifier based on a locally defined value. |
Its representation in the AddressSpace is defined in Table 35.
Table 35 – ChassisIdSubtype Definition
Attribute |
Value |
|||||
BrowseName |
ChassisIdSubtype |
|||||
IsAbstract |
False |
|||||
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
Subtype of the Enumeration type defined in OPC 10000-5 |
||||||
HasProperty |
Variable |
EnumValues |
EnumValueType[] |
PropertyType |
|
|
Conformance Units |
||||||
BNM IEEE LLDP Info |
The PortIdSubtype is an enumeration representing different types of port identifier as defined in IEEE 802.1AB-2016, Table 8-3, port ID subtype.
The PortIdSubtype Enumeration is defined in Table 36.
Table 36 – PortIdSubtype Values
Name |
Value |
Description |
InterfaceAlias |
1 |
Represents a port identifier based on the ifAlias MIB object defined in IETF RFC 2863. |
PortComponent |
2 |
Represents a port identifier based on the value of entPhysicalAlias (defined in IETF RFC 2737) for a port component (i.e., entPhysicalClass value of port(10) or backplane(4)), within the containing chassis. |
MacAddress |
3 |
Represents a port identifier based on a unicast source address (encoded in network byte order and IEEE 802.3 canonical bit order) which has been detected by the agent and associated with a particular port (IEEE Std 802-2014). |
NetworkAddress |
4 |
Represents a port identifier based on a network address, detected by the agent and associated with a particular port. |
InterfaceName |
5 |
Represents a port identifier based on the ifName MIB object, defined in IETF RFC 2863. |
AgentCircuitId |
6 |
Represents a port identifier based on the agent-local identifier of the circuit (defined in IETF RFC 3046), detected by the agent and associated with a particular port. |
Local |
7 |
Represents a port identifier based on a value locally assigned. |
Its representation in the AddressSpace is defined in Table 37.
Table 37 – PortIdSubtype Definition
Attribute |
Value |
|||||
BrowseName |
PortIdSubtype |
|||||
IsAbstract |
False |
|||||
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
Subtype of the Enumeration type defined in OPC 10000-5 |
||||||
HasProperty |
Variable |
EnumValues |
EnumValueType[] |
PropertyType |
|
|
Conformance Units |
||||||
BNM IEEE LLDP Info |
The ManAddrIfSubtype is an enumeration representing different types of management address interface as defined in IEEE 802.1AB-2016, Section 8.5.9.5, interface numbering subtype.
The ManAddrIfSubtype Enumeration is defined in Table 38.
Table 38 – ManAddrIfSubtype Values
Name |
Value |
Description |
None |
0 |
Optional variable is not set. |
Unknown |
1 |
Interface is not known. |
PortRef |
2 |
Interface based on the port-ref MIB object. |
SystemPortNumber |
3 |
Interface based on the system port number. |
Its representation in the AddressSpace is defined in Table 39.
Table 39 – ManAddrIfSubtype Definition
Attribute |
Value |
|||||
BrowseName |
ManAddrIfSubtype |
|||||
IsAbstract |
False |
|||||
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
Subtype of the Enumeration type defined in OPC 10000-5 |
||||||
HasProperty |
Variable |
EnumValues |
EnumValueType[] |
PropertyType |
|
|
Conformance Units |
||||||
BNM IEEE LLDP Info |
This Structure DataType is used to represent an entry in the PriorityMappingTableType. The PriorityMappingEntryType is formally defined in Table 40.
Table 40 – PriorityMappingEntryType structure
Name |
Type |
Description |
PriorityMappingEntryType |
Structure |
|
MappingUri |
String |
Named identifier of a well-known predefined set of priority labels. |
PriorityLabel |
String |
Textual representation of the desired transport priority. |
PriorityValue_PCP |
Byte |
VLAN Tag based priority value. PriorityValue_PCP shall be a value between 0 and 7, or 0xFF. The value 0xFF indicates the PriorityValue_PCP is not used. |
PriorityValue_DSCP |
UInt32 |
IP header based priority value. PriorityValue_DSCP shall be a value between 0 and 63, or 0xFFFFFFFF.The value 0xFFFFFFFF indicates the PriorityValue_PCP is not used. |
Its representation in the AddressSpace is defined in Table 41.
Table 41 – PriorityMappingEntryType Definition
Attribute |
Value |
|||||
BrowseName |
PriorityMappingEntryType |
|||||
IsAbstract |
False |
|||||
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
Subtype of the Structure DataType defined in OPC 10000-5 |
||||||
Conformance Units |
||||||
BNM Priority Mapping 2 |
This Structure DataType represents the YANG list management-address-tx-port as defined in IEEE 802.1ABcu-2021. The LldpManagementAddressTxPortType is formally defined in Table 42.
Table 42 – LldpManagementAddressTxPortType structure
Name |
Type |
Description |
LldpManagementAddressTxPortType |
Structure |
|
AddressSubtype |
UInt32 |
Type of address (8.5.9.3 of IEEE Std 802.1AB-2016, enumeration based on ianaAddressFamilyNumbers IETF RFC 3232) |
ManAddress |
String |
Management address associated with this TLV (8.5.9.4 of IEEE Std 802.1AB-2016) |
TxEnable |
Boolean |
Transmission enabled status (9.1.2.1 of IEEE Std 802.1AB-2016) |
AddrLen |
UInt32 |
Length of the management address subtype and the management address fields in LLDPDUs transmitted by the local LLDP agent (8.5.9.2 of IEEE Std 802.1AB-2016) |
IfSubtype |
ManAddrIfSubtype |
Interface numbering method used for defining the interface number, associated with the local system (8.5.9.5 of IEEE Std 802.1AB-2016) |
IfId |
UInt32 |
Interface number for the management address component associated with the local system (8.5.9.6 of IEEE Std 802.1AB-2016) |
The AddressSubtype and ManAddress are mandatory. The TxEnable has the default value false. The AddrLen is an optional element and shall be set to 0 if this variable is unititialized. The IfSubtype is an optional Enumeration element and shall be set to None if this variable is uninitialized. The IfId is an optional element and shall be set to 0 if this element is uninitialized or unknown.
Its representation in the AddressSpace is defined in Table 43.
Table 43 – LldpManagementAddressTxPortType Definition
Attribute |
Value |
|||||
BrowseName |
LldpManagementAddressTxPortType |
|||||
IsAbstract |
False |
|||||
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
Subtype of the Structure DataType defined in OPC 10000-5 |
||||||
Conformance Units |
||||||
BNM IEEE LLDP Info |
This Structure DataType is used to represent the YANG list management-address as defined in IEEE 802.1ABcu-2021. The LldpManagementAddressType is formally defined in Table 44.
Table 44 – LldpManagementAddressType structure
Name |
Type |
Description |
LldpManagementAddressType |
Structure |
|
AddressSubtype |
UInt32 |
Type of address (8.5.9.3 of IEEE Std 802.1AB-2016), enumeration based on ianaAddressFamilyNumbers IETF RFC 3232) |
Address |
String |
Management address associated with this TLV. (8.5.9.4 of IEEE Std 802.1AB-2016) |
IfSubtype |
ManAddrIfSubtype |
Interface numbering method used for defining the interface number, associated with the local system. (8.5.9.5 of IEEE Std 802.1AB-2016) |
IfId |
UInt32 |
Interface number for the management address component associated with the local system. (8.5.9.6 of IEEE Std 802.1AB-2016) |
The AddressSubtype and Address are mandatory. The IfSubtype is an optional variable and shall be set to None if this variable is unset. The IfId is an optional variable and shall be set to 0 if this variable is not set or unknown.
Its representation in the AddressSpace is defined in Table 45.
Table 45 – LldpManagementAddressType Definition
Attribute |
Value |
|||||
BrowseName |
LldpManagementAddressType |
|||||
IsAbstract |
False |
|||||
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
Subtype of the Structure DataType defined in OPC 10000-5 |
||||||
Conformance Units |
||||||
BNM IEEE LLDP Info |
This Structure DataType is used to represent the YANG list remote-unknown-tlv as defined in IEEE 802.1ABcu-2021. The LldpTlvType is formally defined in Table 46.
Table 46 – LldpTlvType structure
Name |
Type |
Description |
LldpTlvType |
Structure |
|
TlvType |
UInt32 |
Type of TLV (9.2.7.7.1 of IEEE Std 802.1AB-2016) |
TlvInfo |
ByteString |
Value extracted from TLV. (9.2.7.7.1 of IEEE Std 802.1AB-2016) |
The TlvType and TlvInfo are mandatory.
Its representation in the AddressSpace is defined in Table 47.
Table 47 – LldpTlvType Definition
Attribute |
Value |
|||||
BrowseName |
LldpTlvType |
|||||
IsAbstract |
False |
|||||
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
Subtype of the Structure DataType defined in OPC 10000-5 |
||||||
Conformance Units |
||||||
BNM IEEE LLDP Info |
The LldpSystemCapabilitiesMap OptionSet is based on UInt32. It is used to represent the bitmap for the capabilities of a system as defined in IEEE 802.1AB-2016. All possible options for the LldpSystemCapabilitiesMap are formally defined in Table 48.
Table 48 – LldpSystemCapabilitiesMap OptionSet
Value |
Bit No. |
Description |
Other |
0 |
System has capabilities other than those listed below |
Repeater |
1 |
System has repeater capability |
Bridge |
2 |
System has bridge capability |
WlanAccessPoint |
3 |
System has WLAN access point capability |
Router |
4 |
System has router capability |
Telephone |
5 |
System has telephone capability |
DocsisCableDevice |
6 |
System has DOCSIS cable device capability (IETF RFC 4639) |
StationOnly |
7 |
System has only station capability |
CvlanComponent |
8 |
System has C-VLAN component functionality |
SvlanComponent |
9 |
System has S-VLAN component functionality |
TwoPortMacRelay |
10 |
System has Two-port MAC Relay (TPMR) functionality. |
All variables in the LldpSystemCapabilitiesMap OptionSet are per default set to False. The variable Other indicates that the system has capabilities, which are not specified in the OptionSet. All other variables shall only be set to True, if they are applicable for this device.
Its representation in the AddressSpace is defined in Table 49.
Table 49 – LldpSystemCapabilitiesMap OptionSet Definition
Attribute |
Value |
|||||||||
BrowseName |
LldpSystemCapabilitiesMap |
|||||||||
IsAbstract |
False |
|||||||||
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|||||
Subtype of 0:UInt32 defined in OPC 10000-5 |
||||||||||
0:HasProperty |
Variable |
OptionSetValues |
0:LocalizedText[] |
0:PropertyType |
|
|||||
Conformance Units |
||||||||||
BNM IEEE LLDP Info |