{ "$id": "http://redfish.dmtf.org/schemas/v1/Port.v1_12_0.json", "$ref": "#/definitions/Port", "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", "copyright": "Copyright 2014-2024 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright", "definitions": { "Actions": { "additionalProperties": false, "description": "The available actions for this resource.", "longDescription": "This type shall contain the available actions for this resource.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "#Port.Reset": { "$ref": "#/definitions/Reset" }, "#Port.ResetPPB": { "$ref": "#/definitions/ResetPPB" }, "Oem": { "$ref": "#/definitions/OemActions", "description": "The available OEM-specific actions for this resource.", "longDescription": "This property shall contain the available OEM-specific actions for this resource." } }, "type": "object" }, "CXL": { "additionalProperties": false, "description": "CXL properties for a port.", "longDescription": "This type shall contain CXL-specific properties for a port.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "Congestion": { "anyOf": [ { "$ref": "#/definitions/Congestion" }, { "type": "null" } ], "description": "The congestion properties for this CXL port.", "longDescription": "This property shall contain the congestion properties for this CXL port.", "versionAdded": "v1_8_0" }, "ConnectedDeviceMode": { "anyOf": [ { "$ref": "#/definitions/ConnectedDeviceMode" }, { "type": "null" } ], "description": "The connected device mode.", "longDescription": "This property shall contain the CXL Specification-defined 'Connected Device Mode'.", "readonly": true, "versionAdded": "v1_8_0" }, "ConnectedDeviceType": { "anyOf": [ { "$ref": "#/definitions/ConnectedDeviceType" }, { "type": "null" } ], "description": "The connected device type.", "longDescription": "This property shall contain the CXL Specification-defined 'Connected Device Type'.", "readonly": true, "versionAdded": "v1_8_0" }, "CurrentPortConfigurationState": { "anyOf": [ { "$ref": "#/definitions/CurrentPortConfigurationState" }, { "type": "null" } ], "description": "The current port configuration state.", "longDescription": "This property shall contain the CXL Specification-defined 'Current Port Configuration State'.", "readonly": true, "versionAdded": "v1_8_0" }, "MaxLogicalDeviceCount": { "description": "The maximum number of logical devices supported.", "longDescription": "This property shall contain the CXL Specification-defined 'Supported LD Count'.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_8_0" }, "QoSTelemetryCapabilities": { "anyOf": [ { "$ref": "#/definitions/QoSTelemetryCapabilities" }, { "type": "null" } ], "description": "The quality of service telemetry capabilities for this CXL port.", "longDescription": "This property shall contain the quality of service telemetry capabilities for this CXL port.", "versionAdded": "v1_8_0" }, "SupportedCXLModes": { "description": "The supported device modes.", "items": { "anyOf": [ { "$ref": "#/definitions/ConnectedDeviceMode" }, { "type": "null" } ] }, "longDescription": "This property shall contain the CXL Specification-defined 'Supported CXL Modes'. This property shall not contain the value `Disconnected`.", "readonly": true, "type": "array", "versionAdded": "v1_11_0" }, "TemporaryThroughputReductionEnabled": { "deprecated": "This property has been deprecated in favor of `TemporaryThroughputReductionEnabled` in `PCIeDevice`.", "description": "Indicates whether temporary throughput reduction is enabled.", "longDescription": "This property shall indicate whether the CXL Specification-defined 'Temporary Throughput Reduction' mechanism is enabled.", "readonly": false, "type": [ "boolean", "null" ], "versionAdded": "v1_8_0", "versionDeprecated": "v1_12_0" } }, "type": "object" }, "ConfiguredNetworkLink": { "additionalProperties": false, "description": "A set of link settings that a port is configured to use for autonegotiation.", "longDescription": "This type shall contain a set of link settings that a port is configured to use for autonegotiation.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "ConfiguredLinkSpeedGbps": { "description": "The link speed per lane this port is configured to use for autonegotiation.", "longDescription": "This property shall contain the network link speed per lane this port is configured to allow for autonegotiation purposes. This value includes overhead associated with the protocol.", "readonly": false, "type": [ "number", "null" ], "units": "Gbit/s", "versionAdded": "v1_3_0" }, "ConfiguredWidth": { "description": "The link width this port is configured to use for autonegotiation in conjunction with the link speed.", "longDescription": "This property shall contain the network link width this port is configured to use for autonegotiation purposes.", "readonly": false, "type": [ "integer", "null" ], "versionAdded": "v1_3_0" } }, "type": "object" }, "Congestion": { "additionalProperties": false, "description": "The congestion properties for a CXL port.", "longDescription": "This type shall contain the congestion properties for a CXL port.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "BackpressureSampleInterval": { "description": "The interval for the CXL Specification-defined 'Egress Port Congestion' mechanism to take samples in nanoseconds.", "longDescription": "This property shall contain the CXL Specification-defined 'Backpressure Sample Interval' in nanoseconds.", "readonly": false, "type": [ "integer", "null" ], "versionAdded": "v1_8_0" }, "CompletionCollectionInterval": { "description": "The interval for the CXL Specification-defined 'Completion Counting' mechanism to collect the number of transmitted responses in a single counter in nanoseconds.", "longDescription": "This property shall contain the CXL Specification-defined 'Completion Collection Interval' in nanoseconds.", "readonly": false, "type": [ "integer", "null" ], "versionAdded": "v1_8_0" }, "CongestionTelemetryEnabled": { "description": "Indicates whether congestion telemetry collection is enabled for this port.", "longDescription": "This property shall indicate whether congestion telemetry collection is enabled for this port.", "readonly": false, "type": [ "boolean", "null" ], "versionAdded": "v1_8_0" }, "EgressModeratePercentage": { "description": "The threshold for moderate egress port congestion as a percentage.", "longDescription": "This property shall contain the threshold for moderate egress port congestion for the CXL Specification-defined 'Egress Port Congestion' mechanism as a percentage, `0` to `100`.", "maximum": 100, "minimum": 0, "readonly": false, "type": [ "integer", "null" ], "units": "%", "versionAdded": "v1_8_0" }, "EgressSeverePercentage": { "description": "The threshold for severe egress port congestion as a percentage.", "longDescription": "This property shall contain the CXL Specification-defined 'Egress Severe Percentage' as a percentage, `0` to `100`.", "maximum": 100, "minimum": 0, "readonly": false, "type": [ "integer", "null" ], "units": "%", "versionAdded": "v1_8_0" }, "MaxSustainedRequestCmpBias": { "description": "The estimated maximum sustained sum of requests and recent responses across the entire device, serving as the basis for the CXL Specification-defined 'QoS Limit Fraction'.", "longDescription": "This property shall contain the CXL Specification-defined 'ReqCmpBasis'.", "readonly": false, "type": [ "integer", "null" ], "versionAdded": "v1_8_0" } }, "type": "object" }, "ConnectedDeviceMode": { "enum": [ "Disconnected", "RCD", "CXL68BFlitAndVH", "Standard256BFlit", "CXLLatencyOptimized256BFlit", "PBR" ], "enumDescriptions": { "CXL68BFlitAndVH": "CXL 68B flit and VH.", "CXLLatencyOptimized256BFlit": "CXL latency-optimized 256B flit.", "Disconnected": "The connection is not CXL or is disconnected.", "PBR": "Port-based routing (PBR).", "RCD": "Restricted CXL device (RCD).", "Standard256BFlit": "Standard 256B flit." }, "enumLongDescriptions": { "CXL68BFlitAndVH": "This value shall indicate the connected device mode is CXL 68B flit and VH.", "CXLLatencyOptimized256BFlit": "This value shall indicate the connected device mode is CXL latency-optimized 256B flit.", "Disconnected": "This value shall indicate the connection is not CXL or is disconnected.", "PBR": "This value shall indicate the connected device mode is port-based routing (PBR).", "RCD": "This value shall indicate the connected device mode is restricted CXL device (RCD).", "Standard256BFlit": "This value shall indicate the connected device mode is standard 256B flit." }, "type": "string" }, "ConnectedDeviceType": { "enum": [ "None", "PCIeDevice", "Type1", "Type2", "Type3SLD", "Type3MLD" ], "enumDescriptions": { "None": "No device detected.", "PCIeDevice": "PCIe device.", "Type1": "CXL Type 1 device.", "Type2": "CXL Type 2 device.", "Type3MLD": "CXL Type 3 multi-logical device (MLD).", "Type3SLD": "CXL Type 3 single logical device (SLD)." }, "enumLongDescriptions": { "None": "This value shall indicate no device is detected.", "PCIeDevice": "This value shall indicate the connected device is a PCIe device.", "Type1": "This value shall indicate the connected device is a CXL Type 1 device.", "Type2": "This value shall indicate the connected device is a CXL Type 2 device.", "Type3MLD": "This value shall indicate the connected device is a CXL Type 3 multi-logical device (MLD).", "Type3SLD": "This value shall indicate the connected device is a CXL Type 3 single logical device (SLD)." }, "type": "string" }, "CurrentPortConfigurationState": { "enum": [ "Disabled", "BindInProgress", "UnbindInProgress", "DSP", "USP", "Reserved", "FabricLink" ], "enumDeprecated": { "Reserved": "This value has been deprecated in favor of `FabricLink`." }, "enumDescriptions": { "BindInProgress": "Bind in progress.", "DSP": "Downstream port (DSP).", "Disabled": "Disabled.", "FabricLink": "Fabric link.", "Reserved": "Reserved.", "USP": "Upstream port (USP).", "UnbindInProgress": "Unbind in progress." }, "enumLongDescriptions": { "BindInProgress": "This value shall indicate a bind is in progress for the port.", "DSP": "This value shall indicate the port is enabled as a downstream port (DSP).", "Disabled": "This value shall indicate the port is disabled.", "FabricLink": "This value shall indicate the port is enabled as a fabric link to another switch.", "Reserved": "This value shall indicate the port is in a reserved state.", "USP": "This value shall indicate the port is enabled as an upstream port (USP).", "UnbindInProgress": "This value shall indicate an unbind is in progress for the port." }, "enumVersionAdded": { "FabricLink": "v1_11_0" }, "enumVersionDeprecated": { "Reserved": "v1_11_0" }, "type": "string" }, "EthernetProperties": { "additionalProperties": false, "description": "Ethernet-specific properties for a port.", "longDescription": "This type shall contain Ethernet-specific properties for a port.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "AssociatedMACAddresses": { "description": "An array of configured MAC addresses that are associated with this network port, including the programmed address of the lowest-numbered network device function, the configured but not active address, if applicable, the address for hardware port teaming, or other network addresses.", "items": { "type": [ "string", "null" ] }, "longDescription": "This property shall contain an array of configured MAC addresses that are associated with this network port, including the programmed address of the lowest-numbered network device function, the configured but not active address if applicable, the address for hardware port teaming, or other network addresses.", "pattern": "^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$", "readonly": true, "type": "array", "versionAdded": "v1_4_0" }, "EEEEnabled": { "description": "Indicates whether IEEE 802.3az Energy-Efficient Ethernet (EEE) is enabled on this port.", "longDescription": "This property shall indicate whether IEEE 802.3az Energy-Efficient Ethernet (EEE) is enabled on this port.", "readonly": false, "type": [ "boolean", "null" ], "versionAdded": "v1_5_0" }, "FlowControlConfiguration": { "anyOf": [ { "$ref": "#/definitions/FlowControl" }, { "type": "null" } ], "description": "The locally configured 802.3x flow control setting for this port.", "longDescription": "This property shall contain the locally configured 802.3x flow control setting for this port.", "readonly": false, "versionAdded": "v1_3_0" }, "FlowControlStatus": { "anyOf": [ { "$ref": "#/definitions/FlowControl" }, { "type": "null" } ], "description": "The 802.3x flow control behavior negotiated with the link partner for this port.", "longDescription": "This property shall contain the 802.3x flow control behavior negotiated with the link partner for this port.", "readonly": true, "versionAdded": "v1_3_0" }, "LLDPEnabled": { "description": "Enable/disable LLDP for this port.", "longDescription": "This property shall contain the state indicating whether to enable LLDP for a port. If LLDP is disabled at the adapter level, this property shall be ignored.", "readonly": false, "type": "boolean", "versionAdded": "v1_4_0" }, "LLDPReceive": { "anyOf": [ { "$ref": "#/definitions/LLDPReceive" }, { "type": "null" } ], "description": "LLDP data being received on this link.", "longDescription": "This property shall contain the LLDP data being received on this link.", "versionAdded": "v1_4_0" }, "LLDPTransmit": { "anyOf": [ { "$ref": "#/definitions/LLDPTransmit" }, { "type": "null" } ], "description": "LLDP data being transmitted on this link.", "longDescription": "This property shall contain the LLDP data being transmitted on this link.", "versionAdded": "v1_4_0" }, "SupportedEthernetCapabilities": { "deprecated": "This property has been deprecated in favor of individual fields for the various properties.", "description": "The set of Ethernet capabilities that this port supports.", "items": { "anyOf": [ { "$ref": "#/definitions/SupportedEthernetCapabilities" }, { "type": "null" } ] }, "longDescription": "This property shall contain an array of Ethernet capabilities supported by this port.", "readonly": true, "type": "array", "versionAdded": "v1_3_0", "versionDeprecated": "v1_5_0" }, "WakeOnLANEnabled": { "description": "Indicates whether Wake on LAN (WoL) is enabled on this port.", "longDescription": "This property shall indicate whether Wake on LAN (WoL) is enabled on this port.", "readonly": false, "type": [ "boolean", "null" ], "versionAdded": "v1_5_0" } }, "type": "object" }, "FiberConnectionType": { "enum": [ "SingleMode", "MultiMode" ], "enumDescriptions": { "MultiMode": "The connection is using multi mode operation.", "SingleMode": "The connection is using single mode operation." }, "type": "string" }, "FibreChannelProperties": { "additionalProperties": false, "description": "Fibre Channel-specific properties for a port.", "longDescription": "This type shall contain Fibre Channel-specific properties for a port.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "AssociatedWorldWideNames": { "description": "An array of configured World Wide Names (WWN) that are associated with this network port, including the programmed address of the lowest-numbered network device function, the configured but not active address, if applicable, the address for hardware port teaming, or other network addresses.", "items": { "type": [ "string", "null" ] }, "longDescription": "This property shall contain an array of configured World Wide Names (WWN) that are associated with this network port, including the programmed address of the lowest-numbered network device function, the configured but not active address if applicable, the address for hardware port teaming, or other network addresses.", "pattern": "^([0-9A-Fa-f]{2}[:-]){7}([0-9A-Fa-f]{2})$", "readonly": true, "type": "array", "versionAdded": "v1_4_0" }, "FabricName": { "description": "The Fibre Channel Fabric Name provided by the switch.", "longDescription": "This property shall indicate the Fibre Channel Fabric Name provided by the switch.", "readonly": true, "type": [ "string", "null" ], "versionAdded": "v1_3_0" }, "NumberDiscoveredRemotePorts": { "description": "The number of ports not on the associated device that the associated device has discovered through this port.", "longDescription": "This property shall contain the number of ports not on this associated device that this port has discovered.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_3_0" }, "PortConnectionType": { "anyOf": [ { "$ref": "#/definitions/PortConnectionType" }, { "type": "null" } ], "description": "The connection type of this port.", "longDescription": "This property shall contain the connection type for this port.", "readonly": true, "versionAdded": "v1_3_0" } }, "type": "object" }, "FlowControl": { "enum": [ "None", "TX", "RX", "TX_RX" ], "enumDescriptions": { "None": "No IEEE 802.3x flow control is enabled on this port.", "RX": "IEEE 802.3x flow control might be initiated by the link partner.", "TX": "IEEE 802.3x flow control might be initiated by this station.", "TX_RX": "IEEE 802.3x flow control might be initiated by this station or the link partner." }, "type": "string" }, "FunctionMaxBandwidth": { "additionalProperties": false, "description": "A maximum bandwidth allocation percentage for a network device functions associated with a port.", "longDescription": "This type shall describe a maximum bandwidth percentage allocation for a network device function associated with a port.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "AllocationPercent": { "description": "The maximum bandwidth allocation percentage allocated to the corresponding network device function instance.", "longDescription": "This property shall contain the maximum bandwidth percentage allocation, `0` to `100`, for the associated network device function.", "maximum": 100, "minimum": 0, "readonly": false, "type": [ "integer", "null" ], "units": "%", "versionAdded": "v1_4_0" }, "NetworkDeviceFunction": { "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkDeviceFunction.json#/definitions/NetworkDeviceFunction", "description": "The link to the network device function associated with this bandwidth setting of this network port.", "longDescription": "This property shall contain a link to a resource of type `NetworkDeviceFunction` that represents the network device function associated with this bandwidth setting of this network port.", "readonly": true, "versionAdded": "v1_4_0" } }, "type": "object" }, "FunctionMinBandwidth": { "additionalProperties": false, "description": "A minimum bandwidth allocation percentage for a network device functions associated with a port.", "longDescription": "This type shall describe a minimum bandwidth percentage allocation for a network device function associated with a port.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "AllocationPercent": { "description": "The minimum bandwidth allocation percentage allocated to the corresponding network device function instance.", "longDescription": "This property shall contain the minimum bandwidth percentage allocation, `0` to `100`, for the associated network device function. The sum of all minimum percentages shall not exceed `100`.", "maximum": 100, "minimum": 0, "readonly": false, "type": [ "integer", "null" ], "units": "%", "versionAdded": "v1_4_0" }, "NetworkDeviceFunction": { "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkDeviceFunction.json#/definitions/NetworkDeviceFunction", "description": "The link to the network device function associated with this bandwidth setting of this network port.", "longDescription": "This property shall contain a link to a resource of type `NetworkDeviceFunction` that represents the network device function associated with this bandwidth setting of this network port.", "readonly": true, "versionAdded": "v1_4_0" } }, "type": "object" }, "GenZ": { "additionalProperties": false, "description": "This type defines Gen-Z specific port properties.", "longDescription": "This type shall contain Gen-Z specific port properties.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "LPRT": { "$ref": "http://redfish.dmtf.org/schemas/v1/RouteEntryCollection.json#/definitions/RouteEntryCollection", "description": "The Linear Packet Relay Table for the port.", "longDescription": "This property shall contain a link to a resource collection of type `RouteEntryCollection`, and shall represent the Gen-Z Core Specification-defined Linear Packet Relay Table for this port.", "readonly": true, "versionAdded": "v1_2_0" }, "MPRT": { "$ref": "http://redfish.dmtf.org/schemas/v1/RouteEntryCollection.json#/definitions/RouteEntryCollection", "description": "The Multi-subnet Packet Relay Table for the port.", "longDescription": "This property shall contain a link to a resource collection of type `RouteEntryCollection`, and shall represent the Gen-Z Core Specification-defined Multi-subnet Packet Relay Table for this port.", "readonly": true, "versionAdded": "v1_2_0" }, "VCAT": { "$ref": "http://redfish.dmtf.org/schemas/v1/VCATEntryCollection.json#/definitions/VCATEntryCollection", "description": "The Virtual Channel Action Table for the port.", "longDescription": "This property shall contain a link to a resource collection of type `VCATEntryCollection`.", "readonly": true, "versionAdded": "v1_2_0" } }, "type": "object" }, "IEEE802IdSubtype": { "enum": [ "ChassisComp", "IfAlias", "PortComp", "MacAddr", "NetworkAddr", "IfName", "AgentId", "LocalAssign", "NotTransmitted" ], "enumDescriptions": { "AgentId": "Agent circuit ID, based on the agent-local identifier of the circuit as defined in RFC3046.", "ChassisComp": "Chassis component, based on the value of entPhysicalAlias in RFC4133.", "IfAlias": "Interface alias, based on the ifAlias MIB object.", "IfName": "Interface name, based on the ifName MIB object.", "LocalAssign": "Locally assigned, based on an alphanumeric value locally assigned.", "MacAddr": "MAC address, based on an agent-detected unicast source address as defined in IEEE standard 802.", "NetworkAddr": "Network address, based on an agent-detected network address.", "NotTransmitted": "No data to be sent to/received from remote partner.", "PortComp": "Port component, based on the value of entPhysicalAlias in RFC4133." }, "type": "string" }, "InfiniBandProperties": { "additionalProperties": false, "description": "InfiniBand-specific properties for a port.", "longDescription": "This type shall contain InfiniBand-specific properties for a port.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "AssociatedNodeGUIDs": { "description": "An array of configured node GUIDs that are associated with this network port, including the programmed address of the lowest-numbered network device function, the configured but not active address, if applicable, the address for hardware port teaming, or other network addresses.", "items": { "type": [ "string", "null" ] }, "longDescription": "This property shall contain an array of configured node GUIDs that are associated with this network port, including the programmed address of the lowest-numbered network device function, the configured but not active address if applicable, the address for hardware port teaming, or other network addresses.", "pattern": "^([0-9A-Fa-f]{4}[:-]){3}([0-9A-Fa-f]{4})$", "readonly": true, "type": "array", "versionAdded": "v1_6_0" }, "AssociatedPortGUIDs": { "description": "An array of configured port GUIDs that are associated with this network port, including the programmed address of the lowest-numbered network device function, the configured but not active address, if applicable, the address for hardware port teaming, or other network addresses.", "items": { "type": [ "string", "null" ] }, "longDescription": "This property shall contain an array of configured port GUIDs that are associated with this network port, including the programmed address of the lowest-numbered network device function, the configured but not active address if applicable, the address for hardware port teaming, or other network addresses.", "pattern": "^([0-9A-Fa-f]{4}[:-]){3}([0-9A-Fa-f]{4})$", "readonly": true, "type": "array", "versionAdded": "v1_6_0" }, "AssociatedSystemGUIDs": { "description": "An array of configured system GUIDs that are associated with this network port, including the programmed address of the lowest-numbered network device function, the configured but not active address, if applicable, the address for hardware port teaming, or other network addresses.", "items": { "type": [ "string", "null" ] }, "longDescription": "This property shall contain an array of configured system GUIDs that are associated with this network port, including the programmed address of the lowest-numbered network device function, the configured but not active address if applicable, the address for hardware port teaming, or other network addresses.", "pattern": "^([0-9A-Fa-f]{4}[:-]){3}([0-9A-Fa-f]{4})$", "readonly": true, "type": "array", "versionAdded": "v1_6_0" } }, "type": "object" }, "LLDPReceive": { "additionalProperties": false, "description": "Link Layer Data Protocol (LLDP) data received from the remote partner across this link.", "longDescription": "This type shall contain the LLDP data from the remote partner across this link.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "ChassisId": { "description": "Link Layer Data Protocol (LLDP) chassis ID received from the remote partner across this link.", "longDescription": "This property shall contain the chassis ID received from the remote partner across this link. If no such chassis ID has been received, this property should not be present.", "readonly": true, "type": [ "string", "null" ], "versionAdded": "v1_4_0" }, "ChassisIdSubtype": { "anyOf": [ { "$ref": "#/definitions/IEEE802IdSubtype" }, { "type": "null" } ], "description": "The type of identifier used for the chassis ID received from the remote partner across this link.", "longDescription": "This property shall contain the IEEE 802.1AB-2009 chassis ID subtype received from the remote partner across this link. If no such chassis ID subtype has been received, this property should not be present.", "readonly": true, "versionAdded": "v1_4_0" }, "ManagementAddressIPv4": { "description": "The IPv4 management address received from the remote partner across this link.", "longDescription": "This property shall contain the IPv4 management address received from the remote partner across this link. If no such management address has been received, this property should not be present.", "pattern": "^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}$", "readonly": true, "type": [ "string", "null" ], "versionAdded": "v1_4_0" }, "ManagementAddressIPv6": { "description": "The IPv6 management address received from the remote partner across this link.", "longDescription": "This property shall contain the IPv6 management address received from the remote partner across this link. If no such management address has been received, this property should not be present.", "readonly": true, "type": [ "string", "null" ], "versionAdded": "v1_4_0" }, "ManagementAddressMAC": { "description": "The management MAC address received from the remote partner across this link.", "longDescription": "This property shall contain the management MAC address received from the remote partner across this link. If no such management address has been received, this property should not be present.", "pattern": "^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$", "readonly": true, "type": [ "string", "null" ], "versionAdded": "v1_4_0" }, "ManagementVlanId": { "description": "The management VLAN ID received from the remote partner across this link.", "longDescription": "This property shall contain the management VLAN ID received from the remote partner across this link. If no such management VLAN ID has been received, this property should not be present.", "maximum": 4095, "minimum": 0, "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_4_0" }, "PortId": { "description": "A colon-delimited string of hexadecimal octets identifying a port.", "longDescription": "This property shall contain a colon-delimited string of hexadecimal octets identifying the port received from the remote partner across this link. If no such port ID has been received, this property should not be present.", "pattern": "^([0-9A-F]{2})([:]([0-9A-F]){2}){0,63}$", "readonly": true, "type": [ "string", "null" ], "versionAdded": "v1_4_0" }, "PortIdSubtype": { "anyOf": [ { "$ref": "#/definitions/IEEE802IdSubtype" }, { "type": "null" } ], "description": "The port ID subtype received from the remote partner across this link.", "longDescription": "This property shall contain the port ID subtype from IEEE 802.1AB-2009 Table 8-3 received from the remote partner across this link. If no such port ID subtype has been received, this property should not be present.", "readonly": true, "versionAdded": "v1_4_0" }, "SystemCapabilities": { "description": "The system capabilities received from the remote partner across this link.", "items": { "anyOf": [ { "$ref": "#/definitions/LLDPSystemCapabilities" }, { "type": "null" } ] }, "longDescription": "This property shall contain the system capabilities received from the remote partner across this link. If no such system capabilities have been received, this property shall not be present. This property shall not contain the value `None`.", "readonly": true, "type": "array", "versionAdded": "v1_8_0" }, "SystemDescription": { "description": "The system description received from the remote partner across this link.", "longDescription": "This property shall contain the system description received from the remote partner across this link. If no such system description has been received, this property shall not be present.", "readonly": true, "type": [ "string", "null" ], "versionAdded": "v1_8_0" }, "SystemName": { "description": "The system name received from the remote partner across this link.", "longDescription": "This property shall contain the system name received from the remote partner across this link. If no such system name has been received, this property shall not be present.", "readonly": true, "type": [ "string", "null" ], "versionAdded": "v1_8_0" } }, "type": "object" }, "LLDPSystemCapabilities": { "enum": [ "None", "Bridge", "DOCSISCableDevice", "Other", "Repeater", "Router", "Station", "Telephone", "WLANAccessPoint" ], "enumDescriptions": { "Bridge": "Bridge.", "DOCSISCableDevice": "DOCSIS cable device.", "None": "The system capabilities are transmitted, but no capabilities are set.", "Other": "Other.", "Repeater": "Repeater.", "Router": "Router.", "Station": "Station.", "Telephone": "Telephone.", "WLANAccessPoint": "WLAN access point." }, "enumLongDescriptions": { "Bridge": "This value shall indicate the IEEE802.1AB-defined 'bridge' capability.", "DOCSISCableDevice": "This value shall indicate the IEEE802.1AB-defined 'DOCSIS cable device' capability.", "None": "This value shall indicate the system capabilities are transmitted, but no capabilities are set.", "Other": "This value shall indicate the IEEE802.1AB-defined 'other' capability.", "Repeater": "This value shall indicate the IEEE802.1AB-defined 'repeater' capability.", "Router": "This value shall indicate the IEEE802.1AB-defined 'router' capability.", "Station": "This value shall indicate the IEEE802.1AB-defined 'station' capability.", "Telephone": "This value shall indicate the IEEE802.1AB-defined 'telephone' capability.", "WLANAccessPoint": "This value shall indicate the IEEE802.1AB-defined 'WLAN access point' capability." }, "type": "string" }, "LLDPTransmit": { "additionalProperties": false, "description": "Link Layer Data Protocol (LLDP) data being transmitted on this link.", "longDescription": "This type shall contain the LLDP data to be transmitted from this endpoint.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "ChassisId": { "description": "Link Layer Data Protocol (LLDP) chassis ID.", "longDescription": "This property shall contain the chassis ID to be transmitted from this endpoint. If no such chassis ID is to be transmitted, this value shall be an empty string.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_4_0" }, "ChassisIdSubtype": { "anyOf": [ { "$ref": "#/definitions/IEEE802IdSubtype" }, { "type": "null" } ], "description": "The type of identifier used for the chassis ID.", "longDescription": "This property shall contain the IEEE 802.1AB-2009 chassis ID subtype to be transmitted from this endpoint. If no such chassis ID subtype is to be transmitted, this value shall be `NotTransmitted`.", "readonly": false, "versionAdded": "v1_4_0" }, "ManagementAddressIPv4": { "description": "The IPv4 management address to be transmitted from this endpoint.", "longDescription": "This property shall contain the IPv4 management address to be transmitted from this endpoint. If no such management address is to be transmitted, this value shall be an empty string.", "pattern": "(^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}$)|(^$)", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_4_0" }, "ManagementAddressIPv6": { "description": "The IPv6 management address to be transmitted from this endpoint.", "longDescription": "This property shall contain the IPv6 management address to be transmitted from this endpoint. If no such management address is to be transmitted, this value shall be an empty string.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_4_0" }, "ManagementAddressMAC": { "description": "The management MAC address to be transmitted from this endpoint.", "longDescription": "This property shall contain the management MAC address to be transmitted from this endpoint. If no such management address is to be transmitted, this value shall be an empty string.", "pattern": "(^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$)|(^$)", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_4_0" }, "ManagementVlanId": { "description": "The management VLAN ID to be transmitted from this endpoint.", "longDescription": "This property shall contain the management VLAN ID to be transmitted from this endpoint. If no such port ID is to be transmitted, this value shall be `4095`.", "maximum": 4095, "minimum": 0, "readonly": false, "type": [ "integer", "null" ], "versionAdded": "v1_4_0" }, "PortId": { "description": "A colon-delimited string of hexadecimal octets identifying a port to be transmitted from this endpoint.", "longDescription": "This property shall contain a colon-delimited string of hexadecimal octets identifying the port for an LLDP endpoint. If no such port ID is to be transmitted, this value shall be an empty string.", "pattern": "(^([0-9A-F]{2})([:]([0-9A-F]){2}){0,63}$)|(^$)", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_4_0" }, "PortIdSubtype": { "anyOf": [ { "$ref": "#/definitions/IEEE802IdSubtype" }, { "type": "null" } ], "description": "The port ID subtype to be transmitted from this endpoint.", "longDescription": "This property shall contain the port ID subtype from IEEE 802.1AB-2009 Table 8-3 to be transmitted from this endpoint. If no such port ID subtype is to be transmitted, this value shall be `NotTransmitted`.", "readonly": false, "versionAdded": "v1_4_0" }, "SystemCapabilities": { "description": "The system capabilities to be transmitted from this endpoint.", "items": { "anyOf": [ { "$ref": "#/definitions/LLDPSystemCapabilities" }, { "type": "null" } ] }, "longDescription": "This property shall contain the system capabilities to be transmitted from this endpoint. If no such system capabilities are to be transmitted, this value shall be an empty array. If this property contains the value `None`, an empty set of system capabilities is transmitted from this endpoint.", "readonly": false, "type": "array", "versionAdded": "v1_8_0" }, "SystemDescription": { "description": "The system description to be transmitted from this endpoint.", "longDescription": "This property shall contain the system description to be transmitted from this endpoint. If no such system description is to be transmitted, this value shall be an empty string.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_8_0" }, "SystemName": { "description": "The system name to be transmitted from this endpoint.", "longDescription": "This property shall contain the system name to be transmitted from this endpoint. If no such system name is to be transmitted, this value shall be an empty string.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_8_0" } }, "type": "object" }, "LinkConfiguration": { "additionalProperties": false, "description": "Properties of the link for which this port is configured.", "longDescription": "This type shall contain properties of the link for which this port has been configured.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "AutoSpeedNegotiationCapable": { "description": "An indication of whether the port is capable of autonegotiating speed.", "longDescription": "This property shall indicate whether the port is capable of autonegotiating speed.", "readonly": true, "type": [ "boolean", "null" ], "versionAdded": "v1_3_0" }, "AutoSpeedNegotiationEnabled": { "description": "Controls whether this port is configured to enable autonegotiating speed.", "longDescription": "This property shall indicate whether the port is configured to autonegotiate speed.", "readonly": false, "type": [ "boolean", "null" ], "versionAdded": "v1_3_0" }, "CapableLinkSpeedGbps": { "description": "The set of link speed capabilities of this port.", "items": { "type": [ "number", "null" ] }, "longDescription": "This property shall contain all of the possible network link speed capabilities of this port. This value includes overhead associated with the protocol.", "readonly": true, "type": "array", "units": "Gbit/s", "versionAdded": "v1_3_0" }, "ConfiguredNetworkLinks": { "description": "The set of link speed and width pairs this port is configured to use for autonegotiation.", "items": { "anyOf": [ { "$ref": "#/definitions/ConfiguredNetworkLink" }, { "type": "null" } ] }, "longDescription": "This property shall contain the set of link speed and width pairs to which this port is restricted for autonegotiation purposes.", "type": "array", "versionAdded": "v1_3_0" } }, "type": "object" }, "LinkNetworkTechnology": { "enum": [ "Ethernet", "InfiniBand", "FibreChannel", "GenZ", "PCIe" ], "enumDescriptions": { "Ethernet": "The port is capable of connecting to an Ethernet network.", "FibreChannel": "The port is capable of connecting to a Fibre Channel network.", "GenZ": "The port is capable of connecting to a Gen-Z fabric.", "InfiniBand": "The port is capable of connecting to an InfiniBand network.", "PCIe": "The port is capable of connecting to PCIe and CXL fabrics." }, "enumVersionAdded": { "PCIe": "v1_8_0" }, "type": "string" }, "LinkState": { "enum": [ "Enabled", "Disabled" ], "enumDescriptions": { "Disabled": "The link is disabled and not operational.", "Enabled": "The link is enabled and operational." }, "enumLongDescriptions": { "Disabled": "This value shall indicate the link is disabled and not operational. The port is not allowed to establish a connection with the remote port. However, other types of traffic, such as management traffic, may be sent or received by the port.", "Enabled": "This value shall indicate the link is enabled and operational. The port is allowed to establish a connection with the remote port." }, "type": "string" }, "LinkStatus": { "enum": [ "LinkUp", "Starting", "Training", "LinkDown", "NoLink" ], "enumDescriptions": { "LinkDown": "The link on this interface is down.", "LinkUp": "This link on this interface is up.", "NoLink": "No physical link detected on this interface.", "Starting": "This link on this interface is starting. A physical link has been established, but the port is not able to transfer data.", "Training": "This physical link on this interface is training." }, "type": "string" }, "Links": { "additionalProperties": false, "description": "The links to other resources that are related to this resource.", "longDescription": "This Redfish Specification-described type shall contain links to resources that are related to but are not contained by, or subordinate to, this resource.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "AssociatedEndpoints": { "description": "An array of links to the endpoints at the other end of the link.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Endpoint.json#/definitions/Endpoint" }, "longDescription": "This property shall contain an array of links to resources of type `Endpoint` that represent the endpoints to which this port is connected.", "readonly": true, "type": "array" }, "AssociatedEndpoints@odata.count": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "Cables": { "description": "An array of links to the cables connected to this port.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Cable.json#/definitions/Cable" }, "longDescription": "This property shall contain an array of links to resources of type `Cable` that represent the cables connected to this port.", "readonly": true, "type": "array", "versionAdded": "v1_5_0" }, "Cables@odata.count": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "ConnectedPorts": { "description": "An array of links to the remote device ports at the other end of the link.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Port.json#/definitions/Port" }, "longDescription": "This property shall contain an array of links to resources of type `Port` that represent the remote device ports to which this port is connected.", "readonly": true, "type": "array", "versionAdded": "v1_2_0" }, "ConnectedPorts@odata.count": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "ConnectedSwitchPorts": { "description": "An array of links to the switch ports at the other end of the link.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Port.json#/definitions/Port" }, "longDescription": "This property shall contain an array of links to resources of type `Port` that represent the switch ports to which this port is connected.", "readonly": true, "type": "array" }, "ConnectedSwitchPorts@odata.count": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "ConnectedSwitches": { "description": "An array of links to the switches at the other end of the link.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Switch.json#/definitions/Switch" }, "longDescription": "This property shall contain an array of links to resources of type `Switch` that represent the switches to which this port is connected.", "readonly": true, "type": "array" }, "ConnectedSwitches@odata.count": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "EthernetInterfaces": { "description": "The links to the Ethernet interfaces this port provides.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/EthernetInterface.json#/definitions/EthernetInterface" }, "longDescription": "This property shall contain an array of links to resources of type `EthernetInterface` that represent the Ethernet interfaces this port provides. This property shall not include Ethernet interfaces that are not directly associated to a physical port.", "readonly": true, "type": "array", "versionAdded": "v1_7_0" }, "EthernetInterfaces@odata.count": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" }, "Oem": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", "description": "The OEM extension property.", "longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements." } }, "type": "object" }, "MediumType": { "enum": [ "Copper", "FiberOptic" ], "enumDescriptions": { "Copper": "The medium connected is copper.", "FiberOptic": "The medium connected is fiber optic." }, "type": "string" }, "OemActions": { "additionalProperties": true, "description": "The available OEM-specific actions for this resource.", "longDescription": "This type shall contain the available OEM-specific actions for this resource.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": {}, "type": "object" }, "Port": { "additionalProperties": false, "description": "The `Port` schema contains properties that describe a port of a switch, controller, chassis, or any other device that could be connected to another entity.", "longDescription": "This resource contains a simple port for a Redfish implementation.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "@odata.context": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" }, "@odata.type": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type" }, "Actions": { "$ref": "#/definitions/Actions", "description": "The available actions for this resource.", "longDescription": "This property shall contain the available actions for this resource." }, "ActiveWidth": { "description": "The number of active lanes for this interface.", "longDescription": "This property shall contain the number of active lanes for this interface.", "readonly": true, "type": "integer", "versionAdded": "v1_2_0" }, "CXL": { "anyOf": [ { "$ref": "#/definitions/CXL" }, { "type": "null" } ], "description": "CXL properties for this port.", "longDescription": "This property shall contain CXL-specific properties for this port.", "versionAdded": "v1_8_0" }, "CapableProtocolVersions": { "description": "The protocol versions capable of being sent over this port.", "items": { "type": [ "string", "null" ] }, "longDescription": "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.", "readonly": true, "type": "array", "versionAdded": "v1_4_0" }, "CurrentProtocolVersion": { "description": "The protocol version being sent over this port.", "longDescription": "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.", "readonly": true, "type": [ "string", "null" ], "versionAdded": "v1_4_0" }, "CurrentSpeedGbps": { "description": "The current speed of this port.", "longDescription": "This property shall contain the unidirectional speed of this port currently negotiated and running. This value includes overhead associated with the protocol.", "readonly": true, "type": [ "number", "null" ], "units": "Gbit/s" }, "Description": { "anyOf": [ { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description" }, { "type": "null" } ], "readonly": true }, "Enabled": { "deprecated": "This property has been deprecated in favor of `InterfaceEnabled`.", "description": "An indication of whether this port is enabled.", "longDescription": "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.", "readonly": false, "type": "boolean", "versionAdded": "v1_4_0", "versionDeprecated": "v1_10_0" }, "EnvironmentMetrics": { "$ref": "http://redfish.dmtf.org/schemas/v1/EnvironmentMetrics.json#/definitions/EnvironmentMetrics", "description": "The link to the environment metrics for this port or any attached small form-factor pluggable (SFP) device.", "longDescription": "This property shall contain a link to a resource of type `EnvironmentMetrics` that represents the environment metrics for this port or any attached small form-factor pluggable (SFP) device.", "readonly": true, "versionAdded": "v1_4_0" }, "Ethernet": { "anyOf": [ { "$ref": "#/definitions/EthernetProperties" }, { "type": "null" } ], "description": "Ethernet properties for this port.", "longDescription": "This property shall contain Ethernet-specific properties of the port.", "versionAdded": "v1_3_0" }, "FibreChannel": { "anyOf": [ { "$ref": "#/definitions/FibreChannelProperties" }, { "type": "null" } ], "description": "Fibre Channel properties for this port.", "longDescription": "This property shall contain Fibre Channel-specific properties of the port.", "versionAdded": "v1_3_0" }, "FunctionMaxBandwidth": { "description": "An array of maximum bandwidth allocation percentages for the functions associated with this port.", "items": { "$ref": "#/definitions/FunctionMaxBandwidth" }, "longDescription": "This property shall contain an array of maximum bandwidth allocation percentages for the functions associated with this port.", "type": "array", "versionAdded": "v1_4_0" }, "FunctionMinBandwidth": { "description": "An array of minimum bandwidth allocation percentages for the functions associated with this port.", "items": { "$ref": "#/definitions/FunctionMinBandwidth" }, "longDescription": "This property shall contain an array of minimum bandwidth percentage allocations for each of the functions associated with this port.", "type": "array", "versionAdded": "v1_4_0" }, "GenZ": { "$ref": "#/definitions/GenZ", "description": "Gen-Z specific properties.", "longDescription": "This property shall contain Gen-Z specific properties for this interface.", "versionAdded": "v1_2_0" }, "Id": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", "readonly": true }, "InfiniBand": { "anyOf": [ { "$ref": "#/definitions/InfiniBandProperties" }, { "type": "null" } ], "description": "InfiniBand properties for this port.", "longDescription": "This property shall contain InfiniBand-specific properties of the port.", "versionAdded": "v1_6_0" }, "InterfaceEnabled": { "description": "An indication of whether the port is enabled.", "longDescription": "This property shall indicate whether the port is enabled. When disabled, no traffic of any type, such as link protocol traffic and management traffic, is sent or received by the port.", "readonly": false, "type": [ "boolean", "null" ], "versionAdded": "v1_2_0" }, "LinkConfiguration": { "description": "The link configuration of this port.", "items": { "$ref": "#/definitions/LinkConfiguration" }, "longDescription": "This property shall contain the static capabilities and configuration settings of the port.", "type": "array", "versionAdded": "v1_3_0" }, "LinkNetworkTechnology": { "anyOf": [ { "$ref": "#/definitions/LinkNetworkTechnology" }, { "type": "null" } ], "description": "The link network technology capabilities of this port.", "longDescription": "This property shall contain a network technology capability of this port.", "readonly": true, "versionAdded": "v1_2_0" }, "LinkState": { "$ref": "#/definitions/LinkState", "description": "The desired link state for this interface.", "longDescription": "This property shall contain the desired link state for this interface.", "readonly": false, "versionAdded": "v1_2_0" }, "LinkStatus": { "$ref": "#/definitions/LinkStatus", "description": "The link status for this interface.", "longDescription": "This property shall contain the link status for this interface.", "readonly": true, "versionAdded": "v1_2_0" }, "LinkTransitionIndicator": { "description": "The number of link state transitions for this interface.", "longDescription": "This property shall contain the number of link state transitions for this interface.", "readonly": false, "type": "integer", "versionAdded": "v1_2_0" }, "Links": { "$ref": "#/definitions/Links", "description": "The links to other resources that are related to this resource.", "longDescription": "This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource." }, "Location": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Location", "description": "The location of the port.", "longDescription": "This property shall contain the location information of the associated port.", "versionAdded": "v1_1_0" }, "LocationIndicatorActive": { "description": "An indicator allowing an operator to physically locate this resource.", "longDescription": "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.", "readonly": false, "type": [ "boolean", "null" ], "versionAdded": "v1_3_0" }, "MaxFrameSize": { "description": "The maximum frame size supported by the port.", "longDescription": "This property shall contain the maximum frame size supported by the port.", "readonly": true, "type": [ "integer", "null" ], "units": "By", "versionAdded": "v1_3_0" }, "MaxSpeedGbps": { "description": "The maximum speed of this port as currently configured.", "longDescription": "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.", "readonly": true, "type": [ "number", "null" ], "units": "Gbit/s" }, "Metrics": { "anyOf": [ { "$ref": "http://redfish.dmtf.org/schemas/v1/PortMetrics.json#/definitions/PortMetrics" }, { "type": "null" } ], "description": "The link to the metrics associated with this port.", "longDescription": "This property shall contain a link to the metrics associated with this port.", "readonly": true, "versionAdded": "v1_2_0" }, "Name": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", "readonly": true }, "Oem": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", "description": "The OEM extension property.", "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements." }, "PortId": { "deprecated": "This property has been deprecated in favor of `Location` and `ServiceLabel`.", "description": "The label of this port on the physical package for this port.", "longDescription": "This property shall contain the name of the port as indicated on the device containing the port.", "readonly": true, "type": [ "string", "null" ], "versionDeprecated": "v1_12_0" }, "PortMedium": { "anyOf": [ { "$ref": "#/definitions/PortMedium" }, { "type": "null" } ], "description": "The physical connection medium for this port.", "longDescription": "This property shall contain the physical connection medium for this port.", "readonly": true, "versionAdded": "v1_2_0" }, "PortProtocol": { "anyOf": [ { "$ref": "http://redfish.dmtf.org/schemas/v1/Protocol.json#/definitions/Protocol" }, { "type": "null" } ], "description": "The protocol being sent over this port.", "longDescription": "This property shall contain the protocol being sent over this port.", "readonly": true }, "PortType": { "anyOf": [ { "$ref": "#/definitions/PortType" }, { "type": "null" } ], "description": "The type of this port.", "longDescription": "This property shall contain the port type for this port.", "readonly": false }, "RemotePortId": { "description": "The identifier of the remote port to which this port is connected.", "longDescription": "This property shall contain the identifier of the remote port, such as a switch or device, to which this port is connected.", "readonly": true, "type": [ "string", "null" ], "versionAdded": "v1_8_0" }, "SFP": { "anyOf": [ { "$ref": "#/definitions/SFP" }, { "type": "null" } ], "description": "The small form-factor pluggable (SFP) device associated with this port.", "longDescription": "This property shall contain data about the small form-factor pluggable (SFP) device currently occupying this port.", "versionAdded": "v1_4_0" }, "SignalDetected": { "description": "An indication of whether a signal is detected on this interface.", "longDescription": "This property shall indicate whether a signal that is appropriate for this link technology is detected for this port.", "readonly": true, "type": [ "boolean", "null" ], "versionAdded": "v1_2_0" }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", "description": "The status and health of the resource and its subordinate or dependent resources.", "longDescription": "This property shall contain any status or health properties of the resource." }, "Width": { "description": "The number of lanes, phys, or other physical transport links that this port contains.", "longDescription": "This property shall contain the number of physical transport links that this port contains.", "readonly": true, "type": [ "integer", "null" ] } }, "required": [ "@odata.id", "@odata.type", "Id", "Name" ], "type": "object" }, "PortConnectionType": { "enum": [ "NotConnected", "NPort", "PointToPoint", "PrivateLoop", "PublicLoop", "Generic", "ExtenderFabric", "FPort", "EPort", "TEPort", "NPPort", "GPort", "NLPort", "FLPort", "EXPort", "UPort", "DPort" ], "enumDescriptions": { "DPort": "This port connection type is a diagnostic port.", "EPort": "This port connection type is an extender fabric port.", "EXPort": "This port connection type is an external fabric port.", "ExtenderFabric": "This port connection type is an extender fabric port.", "FLPort": "This port connects in a fabric loop configuration.", "FPort": "This port connection type is a fabric port.", "GPort": "This port connection type is a generic fabric port.", "Generic": "This port connection type is a generic fabric port.", "NLPort": "This port connects in a node loop configuration.", "NPPort": "This port connection type is a proxy N-port for N-port virtualization.", "NPort": "This port connects through an N-port to a switch.", "NotConnected": "This port is not connected.", "PointToPoint": "This port connects in a point-to-point configuration.", "PrivateLoop": "This port connects in a private loop configuration.", "PublicLoop": "This port connects in a public configuration.", "TEPort": "This port connection type is a trunking extender fabric port.", "UPort": "This port connection type is unassigned." }, "enumVersionAdded": { "DPort": "v1_5_0", "EPort": "v1_5_0", "EXPort": "v1_5_0", "FLPort": "v1_5_0", "FPort": "v1_5_0", "GPort": "v1_5_0", "NLPort": "v1_5_0", "NPPort": "v1_5_0", "TEPort": "v1_5_0", "UPort": "v1_5_0" }, "type": "string" }, "PortMedium": { "enum": [ "Electrical", "Optical" ], "enumDescriptions": { "Electrical": "This port has an electrical cable connection.", "Optical": "This port has an optical cable connection." }, "type": "string" }, "PortType": { "enum": [ "UpstreamPort", "DownstreamPort", "InterswitchPort", "ManagementPort", "BidirectionalPort", "UnconfiguredPort" ], "enumDescriptions": { "BidirectionalPort": "This port connects to any type of device.", "DownstreamPort": "This port connects to a target device.", "InterswitchPort": "This port connects to another switch.", "ManagementPort": "This port connects to a switch manager.", "UnconfiguredPort": "This port has not yet been configured.", "UpstreamPort": "This port connects to a host device." }, "type": "string" }, "QoSTelemetryCapabilities": { "additionalProperties": false, "description": "The quality of service telemetry capabilities for a CXL port.", "longDescription": "This type shall contain the quality of service telemetry capabilities for a CXL port.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "EgressPortBackpressureSupported": { "description": "Indicates whether the port supports the CXL Specification-defined 'Egress Port Backpressure' mechanism.", "longDescription": "This property shall indicate whether the port supports the CXL Specification-defined 'Egress Port Backpressure' mechanism.", "readonly": true, "type": [ "boolean", "null" ], "versionAdded": "v1_8_0" }, "TemporaryThroughputReductionSupported": { "deprecated": "This property has been deprecated in favor of `TemporaryThroughputReductionSupported` in `PCIeDevice`.", "description": "Indicates whether the port supports the CXL Specification-defined 'Temporary Throughput Reduction' mechanism.", "longDescription": "This property shall indicate whether the port supports the CXL Specification-defined 'Temporary Throughput Reduction' mechanism.", "readonly": true, "type": [ "boolean", "null" ], "versionAdded": "v1_8_0", "versionDeprecated": "v1_12_0" } }, "type": "object" }, "Reset": { "additionalProperties": false, "description": "This action resets this port.", "longDescription": "This action shall reset this port.", "parameters": { "ResetType": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/ResetType", "description": "The type of reset.", "longDescription": "This parameter shall contain the type of reset. The service can accept a request without the parameter and perform an implementation-specific default reset." } }, "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "target": { "description": "Link to invoke action", "format": "uri-reference", "type": "string" }, "title": { "description": "Friendly action name", "type": "string" } }, "type": "object" }, "ResetPPB": { "additionalProperties": false, "description": "This action resets the PCI-to-PCI bridge (PPB) for this port.", "longDescription": "This action shall reset the PCI-to-PCI bridge (PPB) for this port.", "parameters": {}, "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "target": { "description": "Link to invoke action", "format": "uri-reference", "type": "string" }, "title": { "description": "Friendly action name", "type": "string" } }, "type": "object", "versionAdded": "v1_8_0" }, "SFP": { "additionalProperties": false, "description": "A small form-factor pluggable (SFP) device attached to a port.", "longDescription": "This type shall describe a small form-factor pluggable (SFP) device attached to a port.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "FiberConnectionType": { "anyOf": [ { "$ref": "#/definitions/FiberConnectionType" }, { "type": "null" } ], "description": "The type of fiber connection currently used by this SFP.", "longDescription": "This property shall contain the fiber connection type used by the SFP.", "readonly": true, "versionAdded": "v1_4_0" }, "Manufacturer": { "description": "The manufacturer of this SFP.", "longDescription": "This property shall contain the name of the organization responsible for producing the SFP. This organization may be the entity from which the SFP is purchased, but this is not necessarily true.", "readonly": true, "type": [ "string", "null" ], "versionAdded": "v1_4_0" }, "MediumType": { "anyOf": [ { "$ref": "#/definitions/MediumType" }, { "type": "null" } ], "description": "The medium type connected to this SFP.", "longDescription": "This property shall contain the medium type used by the SFP.", "readonly": true, "versionAdded": "v1_4_0" }, "PartNumber": { "description": "The part number for this SFP.", "longDescription": "This property shall contain the manufacturer-provided part number for the SFP.", "readonly": true, "type": [ "string", "null" ], "versionAdded": "v1_4_0" }, "SerialNumber": { "description": "The serial number for this SFP.", "longDescription": "This property shall contain a manufacturer-allocated number that identifies the SFP.", "readonly": true, "type": [ "string", "null" ], "versionAdded": "v1_4_0" }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", "description": "The status and health of the resource and its subordinate or dependent resources.", "longDescription": "This property shall contain any status or health properties of the resource.", "versionAdded": "v1_4_0" }, "SupportedSFPTypes": { "description": "The types of SFP devices that can be attached to this port.", "items": { "anyOf": [ { "$ref": "#/definitions/SFPType" }, { "type": "null" } ] }, "longDescription": "This property shall contain an array of SFP device types supported by this port.", "readonly": true, "type": "array", "versionAdded": "v1_4_0" }, "Type": { "anyOf": [ { "$ref": "#/definitions/SFPType" }, { "type": "null" } ], "description": "The type of SFP device that is attached to this port.", "longDescription": "This property shall contain the SFP device type currently attached to this port.", "readonly": true, "versionAdded": "v1_4_0" } }, "type": "object" }, "SFPType": { "enum": [ "SFP", "SFPPlus", "SFP28", "cSFP", "SFPDD", "QSFP", "QSFPPlus", "QSFP14", "QSFP28", "QSFP56", "MiniSASHD", "QSFPDD", "OSFP" ], "enumDescriptions": { "MiniSASHD": "The SFP conforms to the SFF Specification SFF-8644.", "OSFP": "The SFP conforms to the OSFP Specification.", "QSFP": "The SFP conforms to the SFF Specification for QSFP.", "QSFP14": "The SFP conforms to the SFF Specification for QSFP14.", "QSFP28": "The SFP conforms to the SFF Specification for QSFP28.", "QSFP56": "The SFP conforms to the SFF Specification for QSFP56.", "QSFPDD": "The SFP conforms to the QSFP Double Density Specification.", "QSFPPlus": "The SFP conforms to the SFF Specification for QSFP+.", "SFP": "The SFP conforms to the SFF Specification for SFP.", "SFP28": "The SFP conforms to the SFF Specification for SFP+ and IEEE 802.3by Specification.", "SFPDD": "The SFP conforms to the SFP-DD MSA Specification.", "SFPPlus": "The SFP conforms to the SFF Specification for SFP+.", "cSFP": "The SFP conforms to the CSFP MSA Specification." }, "enumVersionAdded": { "OSFP": "v1_9_0", "QSFPDD": "v1_9_0" }, "type": "string" }, "SupportedEthernetCapabilities": { "enum": [ "WakeOnLAN", "EEE" ], "enumDescriptions": { "EEE": "IEEE 802.3az Energy-Efficient Ethernet (EEE) is supported on this port.", "WakeOnLAN": "Wake on LAN (WoL) is supported on this port." }, "type": "string" } }, "language": "en", "owningEntity": "DMTF", "release": "2024.1", "title": "#Port.v1_12_0.Port" }