Port

Schema Definition

Port contains properties describing a port of a switch.

Properties

Property	Type	Nullable	Required	Permission	Description
@odata.context	String			read-only	The OData description of a payload. Format: uri
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
@odata.type	String			read-only	The type of a resource.
Actions {	Object			read-write	The available actions for this resource.
Oem { }	Object			read-write	The available OEM specific actions for this resource.
}
Description	String	Yes		read-only	Provides a description of this resource and is used for commonality in the schema definitions.
Id	String		GET	read-only	Uniquely identifies the resource within the collection of like resources.
Links {	Object			read-write	Contains references to other resources that are related to this resource.
Oem { }	Object			read-write	Oem extension object.
}
MaxSpeedGbps	Decimal	Yes		read-only	The maximum speed of this port as currently configured. Unit: Gbit/s
Name	String		GET	read-only	The name of the resource or array element.
Oem {	Object			read-write	This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.
EID_47597 {	Object			read-write	RECS\|Box Port extension
ComposedIn {	Reference(ComposedNode)	Yes		read-only	This is a link to the ComposedNode, this Port is composed in. It can only be non-null for PCIe ports.
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
HSLLInterface {	Reference(HSLLInterface)	Yes		read-only	This is a link to the HSLLInterface provided by this port
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
PCIeFunctions [ {	Array[Reference(PCIeFunction)]			read-only	An array of references to PCIeFunctions exposed by this port. This property is patchable for ports of a PCIe switch only and has to be a subset of PCIeFunctions provided by the switch.
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
} ]
PCIeFunctions@odata.count	Int32			read-only	The number of items in a collection.
Provider {	Reference			read-only	The provider of this Port. This can either be a Switch or a ComposedNode.
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
TaggedVLANs [ {	Array[Reference(VLanNetworkInterface)]			read-write	An array of references to tagged VLanNetworkInterfaces of this port. This property is patchable for ports of a Ethernet switch only and has to be a subset of VLanNetworkInterfaces provided by the switch.
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
} ]
TaggedVLANs@odata.count	Int32			read-only	The number of items in a collection.
UntaggedVLAN {	Reference(VLanNetworkInterface)	Yes		read-write	A reference to the untagged VLanNetworkInterface of this port. This property is patchable for ports of a Ethernet switch only and has to be a subset of VLanNetworkInterfaces provided by the switch.
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
}
}
Width	Int64	Yes		read-only	The number of lanes, phys, or other physical transport links that this port contains.

Operations

GET

Request

GET /redfish/v1/Chassis/Chassis1/Switch1/Ports/Port1
Content-Type: application/json

Response

{
    "@odata.context": "uri",
    "@odata.id": "/redfish/v1/Chassis/Chassis1/Switch1/Ports/Port1",
    "@odata.type": "String",
    "Actions": {
        "Oem": { }
    }
    "Description": "String",
    "Id": "String",
    "Links": {
        "Oem": { }
    }
    "MaxSpeedGbps": 0,
    "Name": "String",
    "Oem": {
        "EID_47597": {
            "ComposedIn": {
                "@odata.id": "/redfish/v1/Chassis/Chassis1/ComposedNodes/ComposedNode1"
            },
            "HSLLInterface": {
                "@odata.id": "/redfish/v1/Chassis/Chassis1/Switch1/Ports/Port1/HSLLInterface"
            },
            "PCIeFunctions": [{
                "@odata.id": "/redfish/v1/Chassis/Chassis1/ComposedNodes/ComposedNode1/ProvidedPorts/Port1/PCIeFunction1"
            }],
            "PCIeFunctions@odata.count": 1,
            "Provider": {
                "@odata.id": "uri"
            },
            "TaggedVLANs": [{
                "@odata.id": "/redfish/v1/Chassis/Chassis1/Switch1/VLANs/VLanNetworkInterface1"
            }],
            "TaggedVLANs@odata.count": 1,
            "UntaggedVLAN": {
                "@odata.id": "/redfish/v1/Chassis/Chassis1/Switch1/Ports/Port1/UntaggedVLAN"
            }
        }
    }
    "Width": 0
}

POST

This operation is not supported on this resource and will result in the following response:

HTTP/1.1 405 Method Not Allowed

PATCH

Request

PATCH /redfish/v1/Chassis/Chassis1/Switch1/Ports/Port1
Content-Type: application/json
{
    "Oem": {
        "EID_47597": {
            "TaggedVLANs": [{
                "@odata.id": "/redfish/v1/Chassis/Chassis1/Switch1/VLANs/VLanNetworkInterface1"
            }],
            "UntaggedVLAN": {
                "@odata.id": "/redfish/v1/Chassis/Chassis1/Switch1/Ports/Port1/UntaggedVLAN"
            }
        }
    }
}

Response

HTTP/1.1 204 No Content

DELETE

This operation is not supported on this resource and will result in the following response:

HTTP/1.1 405 Method Not Allowed

Schema Navigation

Port

Schema Definition

Properties

Operations

GET

Request

Response

POST

PATCH

Request

Response

DELETE