5.3.1 Enumeration DataTypes

5.3.1.1 Duplex Enumeration

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.

Table 18 – Duplex Values
NameValueDescription
Full0Full duplex.
Half1Half duplex.
Unknown2Link is currently disconnected or initializing.

Its representation in the AddressSpace is defined in Table 19.

Table 19 – Duplex Definition
Attribute Value
BrowseNameDuplex
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the Enumeration type defined in OPC 10000-5
HasPropertyVariableEnumValuesEnumValueType[]PropertyType
Conformance Units
BNM Ethernet Base Info
5.3.1.2 InterfaceAdminStatus Enumeration

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
NameValueDescription
Up0Ready to pass packets.
Down1Not ready to pass packets and not in some test mode.
Testing2In some test mode.

Its representation in the AddressSpace is defined in Table 21.

Table 21 – InterfaceAdminStatus Definition
Attribute Value
BrowseNameInterfaceAdminStatus
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the Enumeration type defined in OPC 10000-5
HasPropertyVariableEnumValuesEnumValueType[]PropertyType
Conformance Units
BNM Ethernet Base Info
5.3.1.3 InterfaceOperStatus Enumeration

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
NameValueDescription
Up0Ready to pass packets.
Down1The interface does not pass any packets.
Testing2In some test mode. No operational packets can be passed.
Unknown3Status cannot be determined for some reason.
Dormant4Waiting for some external event.
NotPresent5Some component (typically hardware) is missing.
LowerLayerDown6Down due to state of lower-layer interface(s).

Its representation in the AddressSpace is defined in Table 23.

Table 23 – InterfaceOperStatus Definition
Attribute Value
BrowseNameInterfaceOperStatus
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the Enumeration type defined in OPC 10000-5
HasPropertyVariableEnumValuesEnumValueType[]PropertyType
Conformance Units
BNM Ethernet Base Info
5.3.1.4 NegotiationStatus Enumeration

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
NameValueDescription
InProgress0The auto-negotiation protocol is running and negotiation is currently in-progress.
Complete1The auto-negotiation protocol has completed successfully.
Failed2The auto-negotiation protocol has failed.
Unknown3The 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).
NoNegotiation4No 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
BrowseNameNegotiationStatus
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the Enumeration type defined in OPC 10000-5
HasPropertyVariableEnumValuesEnumValueType[]PropertyType
Conformance Units
BNM AutoNeg
5.3.1.5 TsnFailureCode Enumeration

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
NameValueDescription
NoFailure0No failure
InsufficientBandwidth1Insufficient bandwidth
InsufficientResources2Insufficient bridge resources
InsufficientTrafficClassBandwidth3Insufficient bandwidth for Traffic Class
StreamIdInUse4StreamID in use by another Talker
StreamDestinationAddressInUse5Stream destination address already in use
StreamPreemptedByHigherRank6Stream pre-empted by higher rank
LatencyHasChanged7Reported latency has changed
EgressPortNotAvbCapable8Egress port is not AVBCapable
UseDifferentDestinationAddress9Use a different destination address
OutOfMsrpResources10Out of MSRP resources
OutOfMmrpResources11Out of MMRP resources
CannotStoreDestinationAddress12Cannot store destination address
PriorityIsNotAnSrcClass13Requested priority is not an SR Class priority
MaxFrameSizeTooLarge14MaxFrameSize is too large for media
MaxFanInPortsLimitReached15MaxFanInPorts limit has been reached
FirstValueChangedForStreamId16Changes in FirstValue for a registered StreamID
VlanBlockedOnEgress17VLAN is blocked on this egress port (Registration Forbidden)
VlanTaggingDisabledOnEgress18VLAN tagging is disabled on this egress port (untagged set)
SrClassPriorityMismatch19SR class priority mismatch
FeatureNotPropagated20Enhanced feature cannot be propagated to original Port
MaxLatencyExceeded21MaxLatency exceeded
BridgeDoesNotProvideNetworkId22Nearest Bridge cannot provide network identification for stream transformation
StreamTransformNotSupported23Stream transformation not supported
StreamIdTypeNotSupported24Stream identification type not supported for stream transformation
FeatureNotSupported25Enhanced feature cannot be supported without a CNC

Its representation in the AddressSpace is defined in Table 27.

Table 27 – TsnFailureCode Definition
Attribute Value
BrowseNameTsnFailureCode
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the Enumeration type defined in OPC 10000-5
HasPropertyVariableEnumValuesEnumValueType[]PropertyType
Conformance Units
BNM TSN Base Info
5.3.1.6 TsnStreamState Enumeration

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
NameValueDescription
Disabled0The related TSN Stream is currently disabled.
Configuring1The related TSN Stream is in the process of receiving configuration parameters from the TSN Control Layer.
Ready2The related TSN Stream has successfully received and applied the configuration from the TSN Control Layer. The related TSN Stream is not fully operational as long as local preconditions (e.g. synchronization state) are not valid.
Operational3The related TSN Stream object is configured and all other required preconditions (e.g. synchronization state) for sending / receiving data are valid.
Error4The related TSN Stream object is in an error state.

Its representation in the AddressSpace is defined in Table 29.

Table 29 – TsnStreamState Definition
Attribute Value
BrowseNameTsnStreamState
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the Enumeration type defined in OPC 10000-5
HasPropertyVariableEnumValuesEnumValueType[]PropertyType
Conformance Units
BNM TSN Base Info
5.3.1.7 TsnTalkerStatus Enumeration

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
NameValueDescription
None0No Talker detected.
Ready1Talker ready (configured).
Failed2Talker failed.

Its representation in the AddressSpace is defined in Table 31Table 31.

Table 31 – TsnTalkerStatus Definition
Attribute Value
BrowseNameTsnTalkerStatus
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the Enumeration type defined in OPC 10000-5
HasPropertyVariableEnumValuesEnumValueType[]PropertyType
Conformance Units
BNM TSN Base Info
5.3.1.8 TsnListenerStatus Enumeration

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
NameValueDescription
None0No Listener detected.
Ready1Listener ready (configured).
PartialFailed2One or more Listeners ready, and one or more Listeners failed.
Failed3Listener failed.

Its representation in the AddressSpace is defined in Table 33Table 33.

Table 33 – TsnListenerStatus Definition
Attribute Value
BrowseNameTsnListenerStatus
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the Enumeration type defined in OPC 10000-5
HasPropertyVariableEnumValuesEnumValueType[]PropertyType
Conformance Units
BNM TSN Base Info
5.3.1.9 ChassisIdSubtype Enumeration

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
NameValueDescription
ChassisComponent1Represents 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))
InterfaceAlias2Represents a chassis identifier based on the value of ifAlias object (defined in IETF RFC 2863) for an interface on the containing chassis.
PortComponent3Represents 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.
MacAddress4Represents 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.
NetworkAddress5Represents 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.
InterfaceName6Represents a chassis identifier based on the value of ifName object (defined in IETF RFC 2863) for an interface on the containing chassis.
Local7Represents 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
BrowseNameChassisIdSubtype
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the Enumeration type defined in OPC 10000-5
HasPropertyVariableEnumValuesEnumValueType[]PropertyType
Conformance Units
BNM IEEE LLDP Info
5.3.1.10 PortIdSubtype Enumeration

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
NameValueDescription
InterfaceAlias1Represents a port identifier based on the ifAlias MIB object defined in IETF RFC 2863.
PortComponent2Represents 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.
MacAddress3Represents 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).
NetworkAddress4Represents a port identifier based on a network address, detected by the agent and associated with a particular port.
InterfaceName5Represents a port identifier based on the ifName MIB object, defined in IETF RFC 2863.
AgentCircuitId6Represents 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.
Local7Represents 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
BrowseNamePortIdSubtype
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the Enumeration type defined in OPC 10000-5
HasPropertyVariableEnumValuesEnumValueType[]PropertyType
Conformance Units
BNM IEEE LLDP Info
5.3.1.11 ManAddrIfSubtype Enumeration

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
NameValueDescription
None0Optional variable is not set.
Unknown1Interface is not known.
PortRef2Interface based on the port-ref MIB object.
SystemPortNumber3Interface based on the system port number.

Its representation in the AddressSpace is defined in Table 39.

Table 39 – ManAddrIfSubtype Definition
Attribute Value
BrowseNameManAddrIfSubtype
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the Enumeration type defined in OPC 10000-5
HasPropertyVariableEnumValuesEnumValueType[]PropertyType
Conformance Units
BNM IEEE LLDP Info