5 Model ToC Previous Next

5.3 DataTypes ToC Previous Next

5.3.1 Enumeration DataTypes ToC Previous Next

5.3.1.1 Duplex enumeration ToC

The Duplex is an enumeration representing the configured, negotiated, or actual duplex mode of an Ethernet interface (see IEEE Std 802.3, 30.3.1.1.32, aDuplexStatus). The values of the Duplex Enumeration are defined in Table 18.

Table 18 – Duplex Values

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.

Table 19 – Duplex Definition

Attribute Value
BrowseName Duplex
IsAbstract False

Subtype of the Enumeration type defined in OPC 10000-5

References NodeClass BrowseName DataType TypeDefinition Other
HasProperty Variable EnumValues EnumValueType[] PropertyType  
Conformance Units          
BNM Ethernet Base Info          

5.3.1.2 InterfaceAdminStatus enumeration ToC

The InterfaceAdminStatus is an enumeration for the possible desired states of the network interface (see 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

Subtype of the Enumeration type defined in OPC 10000-5

References NodeClass BrowseName DataType TypeDefinition Other
HasProperty Variable EnumValues EnumValueType[] PropertyType  
Conformance Units          
BNM Ethernet Base Info          

5.3.1.3 InterfaceOperStatus enumeration ToC

The InterfaceOperStatus is an enumeration for the possible operational states of the network interface (see 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

Subtype of the Enumeration type defined in OPC 10000-5

References NodeClass BrowseName DataType TypeDefinition Other
HasProperty Variable EnumValues EnumValueType[] PropertyType  
Conformance Units          
BNM Ethernet Base Info          

5.3.1.4 NegotiationStatus enumeration ToC

The NegotiationStatus is an enumeration representing the status of the auto-negotiation protocol (see IEEE Std 802.3, 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

Subtype of the Enumeration type defined in OPC 10000-5

References NodeClass BrowseName DataType TypeDefinition Other
HasProperty Variable EnumValues EnumValueType[] PropertyType  
Conformance Units          
BNM AutoNeg          

5.3.1.5 TsnFailureCode Enumeration ToC

The TsnFailureCode is an Enumeration to provide detailed error information for failures occurring during TSN stream establishment (see 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

Subtype of the Enumeration type defined in OPC 10000-5

References NodeClass BrowseName DataType TypeDefinition Other
HasProperty Variable EnumValues EnumValueType[] PropertyType  
Conformance Units          
BNM TSN Base Info          

5.3.1.6 TsnStreamState Enumeration ToC

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

Name Value Description
Disabled 0 The related TSN Stream is currently disabled.
Configuring 1 The related TSN Stream is in the process of receiving configuration parameters from the TSN Control Layer.
Ready 2 The 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.
Operational 3 The related TSN Stream object is configured and all other required preconditions (e.g. synchronization state) for sending / receiving data are valid.
Error 4 The 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
BrowseName TsnStreamState
IsAbstract False

Subtype of the Enumeration type defined in OPC 10000-5

References NodeClass BrowseName DataType TypeDefinition Other
HasProperty Variable EnumValues EnumValueType[] PropertyType  
Conformance Units          
BNM TSN Base Info          

5.3.1.7 TsnTalkerStatus Enumeration ToC

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 28.

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 29.

Table 31 – TsnTalkerStatus Definition

Attribute Value
BrowseName TsnTalkerStatus
IsAbstract False

Subtype of the Enumeration type defined in OPC 10000-5

References NodeClass BrowseName DataType TypeDefinition Other
HasProperty Variable EnumValues EnumValueType[] PropertyType  
Conformance Units          
BNM TSN Base Info          

5.3.1.8 TsnListenerStatus Enumeration ToC

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 28.

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 29.

Table 33 – TsnListenerStatus Definition

Attribute Value
BrowseName TsnListenerStatus
IsAbstract False

Subtype of the Enumeration type defined in OPC 10000-5

References NodeClass BrowseName DataType TypeDefinition Other
HasProperty Variable EnumValues EnumValueType[] PropertyType  
Conformance Units          
BNM TSN Base Info          

Previous Next