Switch

Schema Definition

Switch contains properties describing a simple fabric 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.
Chassis {	Reference(Chassis)			read-only	A reference to the chassis which contains this switch.
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
Oem { }	Object			read-write	Oem extension object.
}
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 Switch extension
PCIeFunctions {	Reference(PCIeFunctionCollection)	Yes		read-only	This is a link to a collection of PCIeFunctions provided by this switch. They can be exposed by ports of this switch.
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
SwitchType	String			read-only	The type of the switch. Possible Values: Ethernet PCIe
VLANs {	Reference(VLanNetworkInterfaceCollection)	Yes		read-only	This is a link to a collection of VLANs provided by this switch. They can be added to ports of this switch.
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
}
}
Ports {	Reference(PortCollection)			read-only	A collection of references to the ports for this switch.
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
PowerState	String	Yes		read-only	This is the current power state of the switch. Possible Values: On: The state is powered On. Off: The state is powered Off. PoweringOn: A temporary state between Off and On. PoweringOff: A temporary state between On and Off.
Status {	Object			read-write	This type describes the status and health of a resource and its children.
Health	String	Yes		read-only	This represents the health state of this resource in the absence of its dependent resources. Possible Values: OK: Normal. Warning: A condition exists that requires attention. Critical: A critical condition exists that requires immediate attention.
HealthRollup	String	Yes		read-only	This represents the overall health state from the view of this resource. Possible Values: OK: Normal. Warning: A condition exists that requires attention. Critical: A critical condition exists that requires immediate attention.
Oem { }	Object			read-write	Oem extension object.
State	String	Yes		read-only	This indicates the known state of the resource, such as if it is enabled. Possible Values: Enabled: This function or resource has been enabled. Disabled: This function or resource has been disabled. StandbyOffline: This function or resource is enabled, but awaiting an external action to activate it. StandbySpare: This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. InTest: This function or resource is undergoing testing. Starting: This function or resource is starting. Absent: This function or resource is not present or not detected. UnavailableOffline: This function or resource is present but cannot be used. Deferring: The element will not process any commands but will queue new requests. Quiesced: The element is enabled but only processes a restricted set of commands. Updating: The element is updating and may be unavailable or degraded.
}
TotalSwitchWidth	Int64	Yes		read-only	The total number of lanes, phys, or other physical transport links that this switch contains.

Operations

GET

Request

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

Response

{
    "@odata.context": "uri",
    "@odata.id": "/redfish/v1/Chassis/Chassis1/Switch1",
    "@odata.type": "String",
    "Actions": {
        "Oem": { }
    }
    "Description": "String",
    "Id": "String",
    "Links": {
        "Chassis": {
            "@odata.id": "/redfish/v1/Chassis/Chassis1"
        },
        "Oem": { }
    }
    "Name": "String",
    "Oem": {
        "EID_47597": {
            "PCIeFunctions": {
                "@odata.id": "/redfish/v1/Chassis/Chassis1/Switch1/PCIeFunctions"
            },
            "SwitchType": "Ethernet",
            "VLANs": {
                "@odata.id": "/redfish/v1/Chassis/Chassis1/Switch1/VLANs"
            }
        }
    }
    "Ports": {
        "@odata.id": "/redfish/v1/Chassis/Chassis1/Switch1/Ports"
    },
    "PowerState": "On",
    "Status": {
        "Health": "OK",
        "HealthRollup": "OK",
        "Oem": { },
        "State": "Enabled"
    }
    "TotalSwitchWidth": 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

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

HTTP/1.1 405 Method Not Allowed

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

Switch

Schema Definition

Properties

Operations

GET

Request

Response

POST

PATCH

DELETE