Chassis
Schema Definition
The Chassis schema represents the physical components of a system. This resource represents the sheet-metal confined spaces and logical zones such as racks, enclosures, chassis and all other containers. Subsystems (like sensors) that operate outside of a system's data plane (meaning the resources are not accessible to software running on the system) are linked either directly or indirectly through this resource.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. | ||
} | |||||
ChassisType | String | GET | read-only | The type of physical form factor of the chassis. Possible Values:
| |
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. | ||
ComputerSystems [ { | Array[Reference(ComputerSystem)] | read-only | An array of references to the computer systems contained in this chassis. This will only reference ComputerSystems that are directly and wholly contained in this chassis. | ||
@odata.id | String | read-only | The unique identifier for a resource. Format: uri | ||
} ] | |||||
ComputerSystems@odata.count | Int32 | read-only | The number of items in a collection. | ||
Oem { | Object | read-write | Oem extension object. | ||
EID_47597 { | Object | read-only | RECS|Box Chassis links extension. | ||
Baseboards { | Reference(BaseboardCollection) | read-only | This is a link to a collection of Baseboards within this Chassis. | ||
@odata.id | String | read-only | The unique identifier for a resource. Format: uri | ||
} | |||||
ComposedNodes { | Reference(ComposedNodeCollection) | read-only | This is a link to a collection of ComposedNodes. | ||
@odata.id | String | read-only | The unique identifier for a resource. Format: uri | ||
} | |||||
Switches [ { | Array[Reference(Switch)] | read-only | An array of references to Ethernet- and PCIeSwitches hosted within this Chassis. | ||
@odata.id | String | read-only | The unique identifier for a resource. Format: uri | ||
} ] | |||||
Switches@odata.count | Int32 | read-only | The number of items in a collection. | ||
} | |||||
} | |||||
PCIeDevices [ { | Array[Reference(PCIeDevice)] | read-only | An array of references to the PCIe Devices located in this Chassis. | ||
@odata.id | String | read-only | The unique identifier for a resource. Format: uri | ||
} ] | |||||
PCIeDevices@odata.count | Int32 | read-only | The number of items in a collection. | ||
} | |||||
Manufacturer | String | Yes | read-only | The manufacturer of this chassis. | |
Model | String | Yes | read-only | The model number of the chassis. | |
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 Chassis extension | ||
FanProfile | String | read-write | Gets/Sets the current fan profile of the chassis. Possible Values:
| ||
ImageInventory { | Reference(SoftwareInventoryCollection) | Yes | read-only | A inventory of operating system images. | |
@odata.id | String | read-only | The unique identifier for a resource. Format: uri | ||
} | |||||
NodeOnKVM { | Reference(ComputerSystem) | Yes | read-only | This is a link to the ComputerSystem, which is set to KVM/iKVM | |
@odata.id | String | read-only | The unique identifier for a resource. Format: uri | ||
} | |||||
OverallFanSpeedPercent | SByte | read-write | Gets/Sets the overall fan speed of all fans in the chassis in percent. Minimum: 0 Maximum: 100 | ||
} | |||||
} | |||||
PartNumber | String | Yes | read-only | The part number of the chassis. | |
Power { | Reference(Power) | read-only | A reference to the power properties (power supplies, power policies, sensors) of this chassis. | ||
@odata.id | String | read-only | The unique identifier for a resource. Format: uri | ||
} | |||||
PowerState | String | Yes | read-only | The current power state of the chassis. Possible Values:
| |
SKU | String | Yes | read-only | The SKU of the chassis. | |
SerialNumber | String | Yes | read-only | The serial number of the chassis. | |
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:
| |
HealthRollup | String | Yes | read-only | This represents the overall health state from the view of this resource. Possible Values:
| |
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:
| |
} | |||||
Thermal { | Reference(Thermal) | read-only | A reference to the thermal properties (fans, cooling, sensors) of this chassis. | ||
@odata.id | String | read-only | The unique identifier for a resource. Format: uri | ||
} |
Operations
GET
Request
GET /redfish/v1/Chassis/Chassis1
Content-Type: application/json
Content-Type: application/json
Response
{
"@odata.context": "uri",
"@odata.id": "/redfish/v1/Chassis/Chassis1",
"@odata.type": "String",
"Actions": {
"Oem": { }
}
"ChassisType": "Enclosure",
"Description": "String",
"Id": "String",
"Links": {
"ComputerSystems": [{
"@odata.id": "/redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1/ComputerSystems/ComputerSystem1"
}],
"ComputerSystems@odata.count": 1,
"Oem": {
"EID_47597": {
"Baseboards": {
"@odata.id": "/redfish/v1/Chassis/Chassis1/Baseboards"
},
"ComposedNodes": {
"@odata.id": "/redfish/v1/Chassis/Chassis1/ComposedNodes"
},
"Switches": [{
"@odata.id": "/redfish/v1/Chassis/Chassis1/Switch1"
}],
"Switches@odata.count": 1
}
}
"PCIeDevices": [{
"@odata.id": "/redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1/PCIeDevices/PCIeDevice1"
}],
"PCIeDevices@odata.count": 1
}
"Manufacturer": "String",
"Model": "String",
"Name": "String",
"Oem": {
"EID_47597": {
"FanProfile": "Manual",
"FanProfile@Redfish.AllowableValues": ["Manual", "Auto"],
"ImageInventory": {
"@odata.id": "/redfish/v1/Chassis/Chassis1/ImageInventory"
},
"NodeOnKVM": {
"@odata.id": "/redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1/ComputerSystems/ComputerSystem1"
},
"OverallFanSpeedPercent": 0
}
}
"PartNumber": "String",
"Power": {
"@odata.id": "/redfish/v1/Chassis/Chassis1/Power"
},
"PowerState": "On",
"SKU": "String",
"SerialNumber": "String",
"Status": {
"Health": "OK",
"HealthRollup": "OK",
"Oem": { },
"State": "Enabled"
}
"Thermal": {
"@odata.id": "/redfish/v1/Chassis/Chassis1/Thermal"
}
}
"@odata.context": "uri",
"@odata.id": "/redfish/v1/Chassis/Chassis1",
"@odata.type": "String",
"Actions": {
"Oem": { }
}
"ChassisType": "Enclosure",
"Description": "String",
"Id": "String",
"Links": {
"ComputerSystems": [{
"@odata.id": "/redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1/ComputerSystems/ComputerSystem1"
}],
"ComputerSystems@odata.count": 1,
"Oem": {
"EID_47597": {
"Baseboards": {
"@odata.id": "/redfish/v1/Chassis/Chassis1/Baseboards"
},
"ComposedNodes": {
"@odata.id": "/redfish/v1/Chassis/Chassis1/ComposedNodes"
},
"Switches": [{
"@odata.id": "/redfish/v1/Chassis/Chassis1/Switch1"
}],
"Switches@odata.count": 1
}
}
"PCIeDevices": [{
"@odata.id": "/redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1/PCIeDevices/PCIeDevice1"
}],
"PCIeDevices@odata.count": 1
}
"Manufacturer": "String",
"Model": "String",
"Name": "String",
"Oem": {
"EID_47597": {
"FanProfile": "Manual",
"FanProfile@Redfish.AllowableValues": ["Manual", "Auto"],
"ImageInventory": {
"@odata.id": "/redfish/v1/Chassis/Chassis1/ImageInventory"
},
"NodeOnKVM": {
"@odata.id": "/redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1/ComputerSystems/ComputerSystem1"
},
"OverallFanSpeedPercent": 0
}
}
"PartNumber": "String",
"Power": {
"@odata.id": "/redfish/v1/Chassis/Chassis1/Power"
},
"PowerState": "On",
"SKU": "String",
"SerialNumber": "String",
"Status": {
"Health": "OK",
"HealthRollup": "OK",
"Oem": { },
"State": "Enabled"
}
"Thermal": {
"@odata.id": "/redfish/v1/Chassis/Chassis1/Thermal"
}
}
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
Content-Type: application/json
{
"Oem": {
"EID_47597": {
"FanProfile": "Manual",
"OverallFanSpeedPercent": 0
}
}
}
Content-Type: application/json
{
"Oem": {
"EID_47597": {
"FanProfile": "Manual",
"OverallFanSpeedPercent": 0
}
}
}
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