Port
Description
This resource contains a simple port for a Redfish implementation.
Fields
| Field | Type | Description |
|---|---|---|
ActiveWidth | integer | This property shall contain the number of active lanes for this interface. |
CapableProtocolVersions | array | This property shall contain the protocol versions capable of being sent over this port. This property should only be used for protocols where the version and not the speed is of primary interest such as USB, DisplayPort, or HDMI. |
ConfiguredSpeedGbps | number | This property shall contain the unidirectional speed to which this port is configured to train. This value includes overhead associated with the protocol. If `AutoSpeedNegotiationEnabled` contains `true`, this property shall be ignored. |
ConfiguredWidth | integer | This property shall contain the number of physical transport links to which this port is configured to train. If `AutoSpeedNegotiationEnabled` contains `true`, this property shall be ignored. |
CurrentProtocolVersion | string | This property shall contain the protocol version being sent over this port. This property should only be used for protocols where the version and not the speed is of primary interest such as USB, DisplayPort, or HDMI. |
CurrentSpeedGbps | number | This property shall contain the unidirectional speed of this port currently negotiated and running. This value includes overhead associated with the protocol. |
CXL | CXL | This property shall contain CXL-specific properties for this port. |
Description | Description | |
Enabled | boolean | The value of this property shall indicate if this port is enabled. Disabling a port will disconnect any devices only connected to the system through this port. |
HostDevice | HostDeviceType | This property shall contain the current host device of port. |
Id | Id | |
LinkConfiguration | array | This property shall contain the static capabilities and configuration settings of the port. |
LinkNetworkTechnology | LinkNetworkTechnology | This property shall contain the current network technology for this port. |
Links | Links | This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource. |
LinkState | LinkState | This property shall contain the desired link state for this interface. |
LinkStatus | LinkStatus | This property shall contain the link status for this interface. |
Location | Location | This property shall contain the location information of the associated port. |
LocationIndicatorActive | boolean | This property shall contain the state of the indicator used to physically identify or locate this resource. A write to this property shall update the value of `IndicatorLED` in this resource, if supported, to reflect the implementation of the locating function. |
MaxSpeedGbps | number | This property shall contain the maximum unidirectional speed of which this port is capable of being configured. If capable of autonegotiation, the system shall attempt to negotiate at the maximum speed set. This value includes overhead associated with the protocol. |
Metrics | PortMetrics | This property shall contain a link to the metrics associated with this port. |
Name | Name | |
Oem | Oem | This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements. |
PortId | string | This property shall contain the hardware-defined identifier of this port. The human-readable name of this port is described in the `ServiceLabel` property within `Location` for this port. |
PortMedium | PortMedium | This property shall contain the physical connection medium for this port. |
PortProtocol | Protocol | This property shall contain the protocol being sent over this port. |
PortType | PortType | This property shall contain the port type for this port. |
RemotePortId | string | This property shall contain the identifier of the remote port, such as a switch or device, to which this port is connected. |
SignalDetected | boolean | This property shall indicate whether a signal that is appropriate for this link technology is detected for this port. |
Status | Status | This property shall contain any status or health properties of the resource. |
Width | integer | This property shall contain the number of physical transport links that this port contains. |