blob: 9f940b597192a308d71ba652e7f2cb35adcaddf4 [file] [log] [blame]
{
"$id": "http://redfish.dmtf.org/schemas/v1/Chassis.v1_25_0.json",
"$ref": "#/definitions/Chassis",
"$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
"copyright": "Copyright 2014-2023 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": {
"#Chassis.Reset": {
"$ref": "#/definitions/Reset"
},
"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"
},
"Chassis": {
"additionalProperties": false,
"description": "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, such as sensors, that operate outside of a system's data plane are linked either directly or indirectly through this resource. A subsystem that operates outside of a system's data plane are not accessible to software that runs on the system. It also describes the location, such as a slot, socket, or bay, where a unit can be installed, by populating a resource instance with an absent state if a unit is not present.",
"longDescription": "This resource shall represent a chassis or other physical enclosure for a Redfish implementation. It may also represent a location, such as a slot, socket, or bay, where a unit may be installed, but the State property within the Status property contains `Absent`.",
"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."
},
"Assembly": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Assembly.json#/definitions/Assembly",
"description": "The link to the assembly associated with this chassis.",
"longDescription": "This property shall contain a link to a resource of type Assembly.",
"readonly": true,
"versionAdded": "v1_6_0"
},
"AssetTag": {
"description": "The user-assigned asset tag of this chassis.",
"longDescription": "This property shall contain an identifying string that tracks the chassis for inventory purposes. Modifying this property may modify the AssetTag in the resource that represents the functional view of this Chassis, such as a ComputerSystem resource.",
"readonly": false,
"type": [
"string",
"null"
]
},
"Certificates": {
"$ref": "http://redfish.dmtf.org/schemas/v1/CertificateCollection.json#/definitions/CertificateCollection",
"description": "The link to a collection of certificates for device identity and attestation.",
"longDescription": "This property shall contain a link to a resource collection of type CertificateCollection that contains certificates for device identity and attestation.",
"readonly": true,
"versionAdded": "v1_15_0"
},
"ChassisType": {
"$ref": "#/definitions/ChassisType",
"description": "The type of physical form factor of the chassis.",
"longDescription": "This property shall indicate the physical form factor for the type of chassis.",
"readonly": true
},
"Controls": {
"$ref": "http://redfish.dmtf.org/schemas/v1/ControlCollection.json#/definitions/ControlCollection",
"description": "The link to the collection of controls located in this chassis.",
"longDescription": "This property shall contain a link to a resource collection of type ControlCollection.",
"readonly": true,
"versionAdded": "v1_17_0"
},
"DepthMm": {
"description": "The depth of the chassis.",
"longDescription": "This property shall represent the depth (length) of the chassis, in millimeter units, as specified by the manufacturer.",
"minimum": 0,
"readonly": true,
"type": [
"number",
"null"
],
"units": "mm",
"versionAdded": "v1_4_0"
},
"Description": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
},
{
"type": "null"
}
],
"readonly": true
},
"Doors": {
"$ref": "#/definitions/Doors",
"description": "The doors or access panels of the chassis.",
"longDescription": "This property shall contain information about the doors or access panels of the chassis.",
"versionAdded": "v1_24_0"
},
"Drives": {
"$ref": "http://redfish.dmtf.org/schemas/v1/DriveCollection.json#/definitions/DriveCollection",
"description": "The link to the collection of drives within this chassis.",
"longDescription": "This property shall contain a link to a resource collection of type DriveCollection.",
"versionAdded": "v1_14_0"
},
"ElectricalSourceManagerURIs": {
"description": "The URIs of the management interfaces for the external electrical source connections for this chassis.",
"format": "uri-reference",
"items": {
"type": [
"string",
"null"
]
},
"longDescription": "This property shall contain an array of URIs to the management applications or devices that provide monitoring or control of the external electrical sources that provide power to this chassis.",
"readonly": false,
"type": "array",
"versionAdded": "v1_18_0"
},
"ElectricalSourceNames": {
"description": "The names of the external electrical sources, such as circuits or outlets, connected to this chassis.",
"items": {
"type": [
"string",
"null"
]
},
"longDescription": "This property shall contain an array of strings that identify the external electrical sources, such as the names of circuits or outlets, that provide power to this chassis.",
"readonly": false,
"type": "array",
"versionAdded": "v1_18_0"
},
"EnvironmentMetrics": {
"$ref": "http://redfish.dmtf.org/schemas/v1/EnvironmentMetrics.json#/definitions/EnvironmentMetrics",
"description": "The link to the environment metrics for this chassis.",
"longDescription": "This property shall contain a link to a resource of type EnvironmentMetrics that specifies the environment metrics for this chassis.",
"readonly": true,
"versionAdded": "v1_15_0"
},
"EnvironmentalClass": {
"anyOf": [
{
"$ref": "#/definitions/EnvironmentalClass"
},
{
"type": "null"
}
],
"description": "The ASHRAE Environmental Class for this chassis.",
"longDescription": "This property shall contain the ASHRAE Environmental Class for this chassis, as defined by ASHRAE Thermal Guidelines for Data Processing Environments. These classes define respective environmental limits that include temperature, relative humidity, dew point, and maximum allowable elevation.",
"readonly": false,
"versionAdded": "v1_9_0"
},
"FabricAdapters": {
"$ref": "http://redfish.dmtf.org/schemas/v1/FabricAdapterCollection.json#/definitions/FabricAdapterCollection",
"description": "The link to the collection of fabric adapters located in this chassis that provide access to fabric-related resource pools.",
"longDescription": "This property shall contain a link to a resource collection of type FabricAdapterCollection that represents fabric adapters in this chassis that provide access to fabric-related resource pools.",
"readonly": true,
"versionAdded": "v1_20_0"
},
"HeatingCoolingEquipmentNames": {
"description": "The names of the external heating or cooling equipment, such as coolant distribution units, connected to this chassis.",
"items": {
"type": [
"string",
"null"
]
},
"longDescription": "This property shall contain an array of strings that identify the external heating or cooling equipment, such as the names of specific coolant distribution units, that provide thermal management for this chassis.",
"readonly": false,
"type": "array",
"versionAdded": "v1_25_0"
},
"HeatingCoolingManagerURIs": {
"description": "The URIs of the management interfaces for the external heating or cooling equipment for this chassis.",
"format": "uri-reference",
"items": {
"type": [
"string",
"null"
]
},
"longDescription": "This property shall contain an array of URIs to the management applications or devices that provide monitoring or control of the external heating or cooling equipment that provide thermal management for this chassis.",
"readonly": false,
"type": "array",
"versionAdded": "v1_25_0"
},
"HeightMm": {
"description": "The height of the chassis.",
"longDescription": "This property shall represent the height of the chassis, in millimeter units, as specified by the manufacturer.",
"minimum": 0,
"readonly": true,
"type": [
"number",
"null"
],
"units": "mm",
"versionAdded": "v1_4_0"
},
"HotPluggable": {
"description": "An indication of whether this component can be inserted or removed while the equipment is in operation.",
"longDescription": "This property shall indicate whether the component can be inserted or removed while the underlying equipment otherwise remains in its current operational state. Components indicated as hot-pluggable shall allow the component to become operable without altering the operational state of the underlying equipment. Components that cannot be inserted or removed from equipment in operation, or components that cannot become operable without affecting the operational state of that equipment, shall be indicated as not hot-pluggable.",
"readonly": true,
"type": [
"boolean",
"null"
],
"versionAdded": "v1_21_0"
},
"Id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
"readonly": true
},
"IndicatorLED": {
"anyOf": [
{
"$ref": "#/definitions/IndicatorLED"
},
{
"type": "null"
}
],
"deprecated": "This property has been deprecated in favor of the LocationIndicatorActive property.",
"description": "The state of the indicator LED, which identifies the chassis.",
"longDescription": "This property shall contain the indicator light state for the indicator light associated with this system.",
"readonly": false,
"versionDeprecated": "v1_14_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 chassis.",
"longDescription": "This property shall contain the location information of the associated chassis.",
"versionAdded": "v1_2_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. Modifying this property may modify the LocationIndicatorActive in the resource that represents the functional view of this Chassis, such as a ComputerSystem resource.",
"readonly": false,
"type": [
"boolean",
"null"
],
"versionAdded": "v1_14_0"
},
"LogServices": {
"$ref": "http://redfish.dmtf.org/schemas/v1/LogServiceCollection.json#/definitions/LogServiceCollection",
"description": "The link to the logs for this chassis.",
"longDescription": "This property shall contain a link to a resource collection of type LogServiceCollection.",
"readonly": true
},
"Manufacturer": {
"description": "The manufacturer of this chassis.",
"longDescription": "This property shall contain the name of the organization responsible for producing the chassis. This organization may be the entity from whom the chassis is purchased, but this is not necessarily true.",
"readonly": true,
"type": [
"string",
"null"
]
},
"MaxPowerWatts": {
"description": "The upper bound of the total power consumed by the chassis.",
"longDescription": "This property shall contain the upper bound of the total power consumed by the chassis.",
"readonly": true,
"type": [
"number",
"null"
],
"units": "W",
"versionAdded": "v1_12_0"
},
"Measurements": {
"deprecated": "This property has been deprecated in favor of the ComponentIntegrity resource.",
"description": "An array of DSP0274-defined measurement blocks.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/SoftwareInventory.json#/definitions/MeasurementBlock"
},
"longDescription": "This property shall contain an array of DSP0274-defined measurement blocks.",
"type": "array",
"versionAdded": "v1_15_0",
"versionDeprecated": "v1_19_0"
},
"MediaControllers": {
"$ref": "http://redfish.dmtf.org/schemas/v1/MediaControllerCollection.json#/definitions/MediaControllerCollection",
"deprecated": "This property has been deprecated in favor of FabricAdapters.",
"description": "The link to the collection of media controllers located in this chassis.",
"longDescription": "This property shall contain a link to a resource collection of type MediaControllerCollection.",
"readonly": true,
"versionAdded": "v1_11_0",
"versionDeprecated": "v1_20_0"
},
"Memory": {
"$ref": "http://redfish.dmtf.org/schemas/v1/MemoryCollection.json#/definitions/MemoryCollection",
"description": "The link to the collection of memory located in this chassis that belong to fabric-related resource pools.",
"longDescription": "This property shall contain a link to a resource collection of type MemoryCollection that represents memory in this chassis that belong to fabric-related resource pools.",
"readonly": true,
"versionAdded": "v1_11_0"
},
"MemoryDomains": {
"$ref": "http://redfish.dmtf.org/schemas/v1/MemoryDomainCollection.json#/definitions/MemoryDomainCollection",
"description": "The link to the collection of memory domains located in this chassis that belong to fabric-related resource pools.",
"longDescription": "This property shall contain a link to a resource collection of type MemoryDomainCollection that represents memory domains in this chassis that belong to fabric-related resource pools.",
"readonly": true,
"versionAdded": "v1_11_0"
},
"MinPowerWatts": {
"description": "The lower bound of the total power consumed by the chassis.",
"longDescription": "This property shall contain the lower bound of the total power consumed by the chassis.",
"readonly": true,
"type": [
"number",
"null"
],
"units": "W",
"versionAdded": "v1_12_0"
},
"Model": {
"description": "The model number of the chassis.",
"longDescription": "This property shall contain the name by which the manufacturer generally refers to the chassis.",
"readonly": true,
"type": [
"string",
"null"
]
},
"Name": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
"readonly": true
},
"NetworkAdapters": {
"$ref": "http://redfish.dmtf.org/schemas/v1/NetworkAdapterCollection.json#/definitions/NetworkAdapterCollection",
"description": "The link to the collection of network adapters associated with this chassis.",
"longDescription": "This property shall contain a link to a resource collection of type NetworkAdapterCollection.",
"readonly": true,
"versionAdded": "v1_4_0"
},
"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."
},
"PCIeDevices": {
"$ref": "http://redfish.dmtf.org/schemas/v1/PCIeDeviceCollection.json#/definitions/PCIeDeviceCollection",
"description": "The link to the collection of PCIe devices located in this chassis.",
"longDescription": "This property shall contain a link to a resource collection of type PCIeDeviceCollection.",
"readonly": true,
"versionAdded": "v1_10_0"
},
"PCIeSlots": {
"$ref": "http://redfish.dmtf.org/schemas/v1/PCIeSlots.json#/definitions/PCIeSlots",
"deprecated": "This property has been deprecated in favor of the PCIeDevices property. The PCIeSlots schema has been deprecated in favor of the PCIeDevice schema. Empty PCIe slots are represented by PCIeDevice resources using the `Absent` value of the State property within Status.",
"description": "The link to the PCIe slot properties for this chassis.",
"longDescription": "This property shall contain a link to the resource of type PCIeSlots that represents the PCIe slot information for this chassis.",
"readonly": true,
"versionAdded": "v1_8_0",
"versionDeprecated": "v1_24_0"
},
"PartNumber": {
"description": "The part number of the chassis.",
"longDescription": "This property shall contain a part number assigned by the organization that is responsible for producing or manufacturing the chassis.",
"readonly": true,
"type": [
"string",
"null"
]
},
"PhysicalSecurity": {
"$ref": "#/definitions/PhysicalSecurity",
"description": "The physical security state of the chassis.",
"longDescription": "This property shall contain the physical security state of the chassis. Services may construct this state from multiple physical sensors.",
"versionAdded": "v1_1_0"
},
"Power": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Power.json#/definitions/Power",
"deprecated": "This link has been deprecated in favor of the PowerSubsystem link property.",
"description": "The link to the power properties, or power supplies, power policies, and sensors, for this chassis.",
"longDescription": "This property shall contain a link to a resource of type Power that represents the power characteristics of this chassis.",
"readonly": true,
"versionDeprecated": "v1_15_0"
},
"PowerState": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/PowerState"
},
{
"type": "null"
}
],
"description": "The current power state of the chassis.",
"longDescription": "This property shall contain the power state of the chassis.",
"readonly": true,
"versionAdded": "v1_0_1"
},
"PowerSubsystem": {
"$ref": "http://redfish.dmtf.org/schemas/v1/PowerSubsystem.json#/definitions/PowerSubsystem",
"description": "The link to the power subsystem properties for this chassis.",
"longDescription": "This property shall contain a link to a resource of type PowerSubsystem that represents the power subsystem information for this chassis.",
"readonly": true,
"versionAdded": "v1_15_0"
},
"PoweredByParent": {
"description": "Indicates that the chassis receives power from the containing chassis.",
"longDescription": "This property shall indicate whether the chassis receives power from the chassis that contains it. The value `true` shall indicate that the containing chassis provides power. The value `false` shall indicate the chassis receives power from its own power subsystem, another chassis instance's power supplies, or outlets.",
"readonly": true,
"type": [
"boolean",
"null"
],
"versionAdded": "v1_20_0"
},
"Processors": {
"$ref": "http://redfish.dmtf.org/schemas/v1/ProcessorCollection.json#/definitions/ProcessorCollection",
"description": "The link to the collection of processors located in this chassis that belong to fabric-related resource pools.",
"longDescription": "This property shall contain a link to a resource collection of type ProcessorCollection that represents processors in this chassis that belong to fabric-related resource pools.",
"readonly": true,
"versionAdded": "v1_22_0"
},
"Replaceable": {
"description": "An indication of whether this component can be independently replaced as allowed by the vendor's replacement policy.",
"longDescription": "This property shall indicate whether this component can be independently replaced as allowed by the vendor's replacement policy. A value of `false` indicates the component needs to be replaced by policy as part of another component. If the `LocationType` property of this component contains `Embedded`, this property shall contain `false`.",
"readonly": true,
"type": [
"boolean",
"null"
],
"versionAdded": "v1_21_0"
},
"SKU": {
"description": "The SKU of the chassis.",
"longDescription": "This property shall contain the stock-keeping unit number for this chassis.",
"readonly": true,
"type": [
"string",
"null"
]
},
"Sensors": {
"$ref": "http://redfish.dmtf.org/schemas/v1/SensorCollection.json#/definitions/SensorCollection",
"description": "The link to the collection of sensors located in the equipment and sub-components.",
"longDescription": "This property shall contain a link to a resource collection of type SensorCollection that contains the sensors located in the chassis and sub-components.",
"readonly": true,
"versionAdded": "v1_9_0"
},
"SerialNumber": {
"description": "The serial number of the chassis.",
"longDescription": "This property shall contain a manufacturer-allocated number that identifies the chassis.",
"readonly": true,
"type": [
"string",
"null"
]
},
"SparePartNumber": {
"description": "The spare part number of the chassis.",
"longDescription": "This property shall contain the spare part number of the chassis.",
"readonly": true,
"type": [
"string",
"null"
],
"versionAdded": "v1_16_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."
},
"Thermal": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Thermal.json#/definitions/Thermal",
"deprecated": "This link has been deprecated in favor of the ThermalSubsystem link property.",
"description": "The link to the thermal properties, such as fans, cooling, and sensors, for this chassis.",
"longDescription": "This property shall contain a link to a resource of type Thermal that represents the thermal characteristics of this chassis.",
"readonly": true,
"versionDeprecated": "v1_15_0"
},
"ThermalDirection": {
"anyOf": [
{
"$ref": "#/definitions/ThermalDirection"
},
{
"type": "null"
}
],
"description": "Indicates the thermal management path through the chassis.",
"longDescription": "This property shall indicate the general direction of the thermal management path through the chassis.",
"readonly": true,
"versionAdded": "v1_20_0"
},
"ThermalManagedByParent": {
"description": "Indicates that the chassis is thermally managed by the parent chassis.",
"longDescription": "This property shall indicate whether the chassis relies on the containing chassis to provide thermal management. The value `true` shall indicate that the chassis relies on the containing chassis to provide thermal management. The value `false` shall indicate the chassis provides thermal management, and may provide details in a ThermalSubsystem resource, or by populating the Fans property in Links.",
"readonly": true,
"type": [
"boolean",
"null"
],
"versionAdded": "v1_20_0"
},
"ThermalSubsystem": {
"$ref": "http://redfish.dmtf.org/schemas/v1/ThermalSubsystem.json#/definitions/ThermalSubsystem",
"description": "The link to the thermal subsystem properties for this chassis.",
"longDescription": "This property shall contain a link to a resource of type ThermalSubsystem that represents the thermal subsystem information for this chassis.",
"readonly": true,
"versionAdded": "v1_15_0"
},
"TrustedComponents": {
"$ref": "http://redfish.dmtf.org/schemas/v1/TrustedComponentCollection.json#/definitions/TrustedComponentCollection",
"description": "The link to the trusted components in this chassis.",
"longDescription": "This property shall contain a link to a resource collection of type TrustedComponentCollection.",
"readonly": true,
"versionAdded": "v1_21_0"
},
"UUID": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/UUID"
},
{
"type": "null"
}
],
"description": "The UUID for this chassis.",
"longDescription": "This property shall contain the universally unique identifier number for this chassis.",
"readonly": true,
"versionAdded": "v1_7_0"
},
"Version": {
"description": "The hardware version of this chassis.",
"longDescription": "This property shall contain the hardware version of this chassis as determined by the vendor or supplier.",
"readonly": true,
"type": [
"string",
"null"
],
"versionAdded": "v1_21_0"
},
"WeightKg": {
"description": "The weight of the chassis.",
"longDescription": "This property shall represent the published mass, commonly referred to as weight, of the chassis, in kilogram units.",
"minimum": 0,
"readonly": true,
"type": [
"number",
"null"
],
"units": "kg",
"versionAdded": "v1_4_0"
},
"WidthMm": {
"description": "The width of the chassis.",
"longDescription": "This property shall represent the width of the chassis, in millimeter units, as specified by the manufacturer.",
"minimum": 0,
"readonly": true,
"type": [
"number",
"null"
],
"units": "mm",
"versionAdded": "v1_4_0"
}
},
"required": [
"ChassisType",
"@odata.id",
"@odata.type",
"Id",
"Name"
],
"type": "object"
},
"ChassisType": {
"enum": [
"Rack",
"Blade",
"Enclosure",
"StandAlone",
"RackMount",
"Card",
"Cartridge",
"Row",
"Pod",
"Expansion",
"Sidecar",
"Zone",
"Sled",
"Shelf",
"Drawer",
"Module",
"Component",
"IPBasedDrive",
"RackGroup",
"StorageEnclosure",
"ImmersionTank",
"HeatExchanger",
"PowerStrip",
"Other"
],
"enumDescriptions": {
"Blade": "An enclosed or semi-enclosed, typically vertically-oriented, system chassis that must be plugged into a multi-system chassis to function normally.",
"Card": "A loose device or circuit board intended to be installed in a system or other enclosure.",
"Cartridge": "A small self-contained system intended to be plugged into a multi-system chassis.",
"Component": "A small chassis, card, or device that contains devices for a particular subsystem or function.",
"Drawer": "An enclosed or semi-enclosed, typically horizontally-oriented, system chassis that can be slid into a multi-system chassis.",
"Enclosure": "A generic term for a chassis that does not fit any other description.",
"Expansion": "A chassis that expands the capabilities or capacity of another chassis.",
"HeatExchanger": "A heat exchanger.",
"IPBasedDrive": "A chassis in a drive form factor with IP-based network connections.",
"ImmersionTank": "An immersion cooling tank.",
"Module": "A small, typically removable, chassis or card that contains devices for a particular subsystem or function.",
"Other": "A chassis that does not fit any of these definitions.",
"Pod": "A collection of equipment racks in a large, likely transportable, container.",
"PowerStrip": "A power strip, typically placed in the zero-U space of a rack.",
"Rack": "An equipment rack, typically a 19-inch wide freestanding unit.",
"RackGroup": "A group of racks that form a single entity or share infrastructure.",
"RackMount": "A single-system chassis designed specifically for mounting in an equipment rack.",
"Row": "A collection of equipment racks.",
"Shelf": "An enclosed or semi-enclosed, typically horizontally-oriented, system chassis that must be plugged into a multi-system chassis to function normally.",
"Sidecar": "A chassis that mates mechanically with another chassis to expand its capabilities or capacity.",
"Sled": "An enclosed or semi-enclosed, system chassis that must be plugged into a multi-system chassis to function normally similar to a blade type chassis.",
"StandAlone": "A single, free-standing system, commonly called a tower or desktop chassis.",
"StorageEnclosure": "A chassis that encloses storage.",
"Zone": "A logical division or portion of a physical chassis that contains multiple devices or systems that cannot be physically separated."
},
"enumVersionAdded": {
"HeatExchanger": "v1_23_0",
"IPBasedDrive": "v1_3_0",
"ImmersionTank": "v1_23_0",
"PowerStrip": "v1_25_0",
"RackGroup": "v1_4_0",
"StorageEnclosure": "v1_6_0"
},
"type": "string"
},
"Door": {
"additionalProperties": false,
"description": "A door or access panel on the chassis.",
"longDescription": "This type shall describe a door or access panel on the chassis.",
"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": {
"DoorState": {
"anyOf": [
{
"$ref": "#/definitions/DoorState"
},
{
"type": "null"
}
],
"description": "The state of the door.",
"longDescription": "This property shall contain the current state of the door.",
"readonly": true,
"versionAdded": "v1_24_0"
},
"Locked": {
"description": "Indicates if the door is locked.",
"longDescription": "This property shall indicate if the door is locked.",
"readonly": false,
"type": [
"boolean",
"null"
],
"versionAdded": "v1_24_0"
},
"UserLabel": {
"description": "A user-assigned label.",
"longDescription": "This property shall contain a user-assigned label used to identify this resource. If a value has not been assigned by a user, the value of this property shall be an empty string.",
"readonly": false,
"type": "string",
"versionAdded": "v1_24_0"
}
},
"type": "object"
},
"DoorState": {
"enum": [
"Locked",
"Closed",
"LockedAndOpen",
"Open"
],
"enumDescriptions": {
"Closed": "Door is closed.",
"Locked": "Door is closed and locked.",
"LockedAndOpen": "Door is open and locked.",
"Open": "Door is open."
},
"enumLongDescriptions": {
"Closed": "This value shall indicate that the door is closed but unlocked.",
"Locked": "This value shall indicate that the door is both closed and locked. In this state, the door cannot be opened unless the value of the Locked property is set to `false`.",
"LockedAndOpen": "This value shall indicate that the door is open but the lock has been engaged. It may be possible to close the door while in this state.",
"Open": "This value shall indicate that the door is open."
},
"type": "string"
},
"Doors": {
"additionalProperties": false,
"description": "The doors or access panels of the chassis.",
"longDescription": "This type shall describe the doors or access panels of the chassis.",
"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": {
"Front": {
"anyOf": [
{
"$ref": "#/definitions/Door"
},
{
"type": "null"
}
],
"description": "The front door of the chassis.",
"longDescription": "This property shall contain information related to the front door, as defined by the manufacturer, of the chassis.",
"versionAdded": "v1_24_0"
},
"Rear": {
"anyOf": [
{
"$ref": "#/definitions/Door"
},
{
"type": "null"
}
],
"description": "The rear door of the chassis.",
"longDescription": "This property shall contain information related to the rear door, as defined by the manufacturer, of the chassis.",
"versionAdded": "v1_24_0"
}
},
"type": "object"
},
"EnvironmentalClass": {
"enum": [
"A1",
"A2",
"A3",
"A4"
],
"enumDescriptions": {
"A1": "ASHRAE Environmental Class 'A1'.",
"A2": "ASHRAE Environmental Class 'A2'.",
"A3": "ASHRAE Environmental Class 'A3'.",
"A4": "ASHRAE Environmental Class 'A4'."
},
"type": "string"
},
"IndicatorLED": {
"enum": [
"Unknown",
"Lit",
"Blinking",
"Off"
],
"enumDeprecated": {
"Unknown": "This value has been deprecated in favor of returning `null` if the state is unknown."
},
"enumDescriptions": {
"Blinking": "The indicator LED is blinking.",
"Lit": "The indicator LED is lit.",
"Off": "The indicator LED is off.",
"Unknown": "The state of the indicator LED cannot be determined."
},
"enumLongDescriptions": {
"Blinking": "This value shall represent the indicator LED is in a blinking state where the LED is being turned on and off in repetition. If the service does not support this value, it shall reject PATCH or PUT requests containing this value by returning the HTTP 400 (Bad Request) status code.",
"Lit": "This value shall represent the indicator LED is in a solid on state. If the service does not support this value, it shall return the HTTP 400 (Bad Request) status code to reject PATCH or PUT requests that contain this value.",
"Off": "This value shall represent the indicator LED is in a solid off state. If the service does not support this value, it shall reject PATCH or PUT requests containing this value by returning the HTTP 400 (Bad Request) status code.",
"Unknown": "This value shall represent the indicator LED is in an unknown state. The service shall reject PATCH or PUT requests containing this value by returning the HTTP 400 (Bad Request) status code."
},
"enumVersionDeprecated": {
"Unknown": "v1_2_0"
},
"type": "string"
},
"IntrusionSensor": {
"enum": [
"Normal",
"HardwareIntrusion",
"TamperingDetected"
],
"enumDescriptions": {
"HardwareIntrusion": "A door, lock, or other mechanism protecting the internal system hardware from being accessed is detected to be in an insecure state.",
"Normal": "No physical security condition is detected at this time.",
"TamperingDetected": "Physical tampering of the monitored entity is detected."
},
"type": "string"
},
"IntrusionSensorReArm": {
"enum": [
"Manual",
"Automatic"
],
"enumDescriptions": {
"Automatic": "The sensor is automatically restored to the normal state when no security condition is detected.",
"Manual": "A user is required to clear the sensor to restore it to the normal state."
},
"enumLongDescriptions": {
"Automatic": "This value shall indicate the service sets the IntrusionSensor property to `Normal` when no security condition is detected.",
"Manual": "This value shall indicate a user is required to set the IntrusionSensor property to `Normal` to restore the sensor to its normal state."
},
"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": {
"Cables": {
"description": "An array of links to the cables connected to this chassis.",
"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 chassis.",
"readonly": true,
"type": "array",
"versionAdded": "v1_17_0"
},
"Cables@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
},
"ComputerSystems": {
"description": "An array of links to the computer systems that this chassis directly and wholly contains.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/ComputerSystem.json#/definitions/ComputerSystem"
},
"longDescription": "This property shall contain an array of links to resources of type ComputerSystem with which this physical container is associated. If a chassis also links to a computer system to which this resource also links, this chassis shall not link to that computer system.",
"readonly": true,
"type": "array"
},
"ComputerSystems@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
},
"ConnectedCoolingLoops": {
"description": "An array of links to cooling loops connected to this chassis.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/CoolingLoop.json#/definitions/CoolingLoop"
},
"longDescription": "This property shall contain an array of links to resources of type CoolingLoop that represent the cooling loops connected to this chassis.",
"readonly": false,
"type": "array",
"versionAdded": "v1_23_0"
},
"ConnectedCoolingLoops@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
},
"ContainedBy": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis",
"description": "The link to the chassis that contains this chassis.",
"longDescription": "This property shall contain a link to a resource of type Chassis that represents the chassis that contains this chassis.",
"readonly": false
},
"Contains": {
"description": "An array of links to any other chassis that this chassis has in it.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis"
},
"longDescription": "This property shall contain an array of links to resources of type Chassis that represent the chassis instances that this chassis contains.",
"readonly": false,
"type": "array"
},
"Contains@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
},
"CooledBy": {
"deprecated": "This property has been deprecated in favor of the Fans link property, and details provided in the ThermalSubsystem resource.",
"description": "An array of links to resources or objects that cool this chassis. Normally, the link is for either a chassis or a specific set of fans.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef"
},
"longDescription": "This property shall contain an array of links to resources or objects that cool this chassis.",
"readonly": true,
"type": "array",
"versionDeprecated": "v1_20_0"
},
"CooledBy@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
},
"CoolingUnits": {
"description": "An array of links to cooling unit functionality contained in this chassis.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/CoolingUnit.json#/definitions/CoolingUnit"
},
"longDescription": "This property shall contain an array of links to resources of type CoolingUnit that represent the cooling unit functionality contained within this chassis.",
"readonly": false,
"type": "array",
"versionAdded": "v1_23_0"
},
"CoolingUnits@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
},
"Drives": {
"description": "An array of links to the drives located in this chassis.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Drive.json#/definitions/Drive"
},
"longDescription": "This property shall contain an array of links to resources of type Drive that are in this chassis.",
"readonly": true,
"type": "array",
"versionAdded": "v1_2_0"
},
"Drives@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
},
"Facility": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Facility.json#/definitions/Facility",
"description": "The link to the facility that contains this chassis.",
"longDescription": "This property shall contain a link to the resource of type Facility and shall represent the smallest facility that contains this chassis. This property shall not appear in resources that include a ContainedBy property within the Links property.",
"readonly": false,
"versionAdded": "v1_11_0"
},
"Fans": {
"description": "An array of links to the fans that cool this chassis.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Fan.json#/definitions/Fan"
},
"longDescription": "This property shall contain an array of links to resources of type Fan that represent the fans that provide cooling to this chassis. This property shall not be present if the ThermalManagedByParent property contains `true` or if the fans are contained in the ThermalSubsystem resource for this chassis.",
"readonly": true,
"type": "array",
"versionAdded": "v1_20_0"
},
"Fans@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
},
"ManagedBy": {
"description": "An array of links to the managers responsible for managing this chassis.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Manager.json#/definitions/Manager"
},
"longDescription": "This property shall contain an array of links to resources of type Manager that manage this chassis.",
"readonly": true,
"type": "array"
},
"ManagedBy@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
},
"ManagersInChassis": {
"description": "An array of links to the managers located in this chassis.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Manager.json#/definitions/Manager"
},
"longDescription": "This property shall contain an array of links to resources of type Manager that are in this chassis.",
"readonly": true,
"type": "array",
"versionAdded": "v1_2_0"
},
"ManagersInChassis@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."
},
"PCIeDevices": {
"deprecated": "This property has been deprecated in favor of the PCIeDevices resource collection in the root of this resource.",
"description": "An array of links to the PCIe devices located in this chassis.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/PCIeDevice.json#/definitions/PCIeDevice"
},
"longDescription": "This property shall contain an array of links to resources of type PCIeDevice.",
"readonly": true,
"type": "array",
"versionAdded": "v1_4_0",
"versionDeprecated": "v1_10_0"
},
"PCIeDevices@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
},
"PowerDistribution": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/PowerDistribution.json#/definitions/PowerDistribution"
},
{
"type": "null"
}
],
"description": "A link to power distribution functionality contained in this chassis.",
"longDescription": "This property shall contain a link to a resource of type PowerDistribution that represents the power distribution functionality contained within this chassis.",
"readonly": true,
"versionAdded": "v1_20_0"
},
"PowerOutlets": {
"description": "An array of links to the outlets that provide power to this chassis.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Outlet.json#/definitions/Outlet"
},
"longDescription": "This property shall contain an array of links to resources of type Outlet that represent the outlets that provide power to this chassis. This property shall not be present if the PoweredByParent property contains `true`.",
"readonly": false,
"type": "array",
"versionAdded": "v1_18_0"
},
"PowerOutlets@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
},
"PowerSupplies": {
"description": "An array of links to the power supplies that provide power to this chassis.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/PowerSupply.json#/definitions/PowerSupply"
},
"longDescription": "This property shall contain an array of links to resources of type PowerSupply that represent the power supplies that provide power to this chassis. This property shall not be present if the PoweredByParent property contains `true` or if the power supplies are contained in the PowerSubsystem resource for this chassis.",
"readonly": true,
"type": "array",
"versionAdded": "v1_20_0"
},
"PowerSupplies@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
},
"PoweredBy": {
"deprecated": "This property has been deprecated in favor of the PowerOutlets and PowerSupplies link properties, and details provided in the PowerSubsystem resource.",
"description": "An array of links to resources or objects that power this chassis. Normally, the link is for either a chassis or a specific set of power supplies.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef"
},
"longDescription": "This property shall contain an array of links to resources or objects that power this chassis.",
"readonly": true,
"type": "array",
"versionDeprecated": "v1_20_0"
},
"PoweredBy@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
},
"Processors": {
"description": "An array of links to the processors located in this chassis.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Processor.json#/definitions/Processor"
},
"longDescription": "This property shall contain an array of links to resources of type Processor type that this chassis contains.",
"readonly": true,
"type": "array",
"versionAdded": "v1_9_0"
},
"Processors@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
},
"ResourceBlocks": {
"description": "An array of links to the resource blocks located in this chassis.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/ResourceBlock.json#/definitions/ResourceBlock"
},
"longDescription": "This property shall contain an array of links to resources of type ResourceBlock that this chassis contains.",
"readonly": true,
"type": "array",
"versionAdded": "v1_5_0"
},
"ResourceBlocks@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
},
"Storage": {
"description": "An array of links to the storage subsystems connected to or inside this chassis.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Storage.json#/definitions/Storage"
},
"longDescription": "This property shall contain an array of links to resources of type Storage that are connected to or contained in this chassis.",
"readonly": true,
"type": "array",
"versionAdded": "v1_2_0"
},
"Storage@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
},
"Switches": {
"description": "An array of links to the switches located in this chassis.",
"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 this chassis contains.",
"readonly": true,
"type": "array",
"versionAdded": "v1_7_0"
},
"Switches@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
}
},
"type": "object"
},
"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"
},
"PhysicalSecurity": {
"additionalProperties": false,
"description": "The physical security state of the chassis.",
"longDescription": "This type shall describe the physical security state of the chassis.",
"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": {
"IntrusionSensor": {
"anyOf": [
{
"$ref": "#/definitions/IntrusionSensor"
},
{
"type": "null"
}
],
"description": "The physical security state of the chassis, such as if hardware intrusion is detected.",
"longDescription": "This property shall contain the physical security state of the chassis. If the IntrusionSensorReArm property contains `Manual`, a client may set this property to `Normal` to reset the physical security state.",
"readonly": false,
"versionAdded": "v1_1_0"
},
"IntrusionSensorNumber": {
"deprecated": "This property has been deprecated in order to allow for multiple physical sensors to construct this object.",
"description": "A numerical identifier to represent the physical security sensor.",
"longDescription": "This property shall contain a numerical identifier for this physical security sensor that is unique within this resource.",
"readonly": true,
"type": [
"integer",
"null"
],
"versionAdded": "v1_1_0",
"versionDeprecated": "v1_22_0"
},
"IntrusionSensorReArm": {
"anyOf": [
{
"$ref": "#/definitions/IntrusionSensorReArm"
},
{
"type": "null"
}
],
"description": "The policy that describes how the physical security state of the chassis returns to a normal state.",
"longDescription": "This property shall contain the policy that describes how the IntrusionSensor property returns to the `Normal` value.",
"readonly": false,
"versionAdded": "v1_1_0"
}
},
"type": "object"
},
"Reset": {
"additionalProperties": false,
"description": "This action resets the chassis. Additionally, it could reset systems or other contained resources depending on the ResetType used to invoke this action.",
"longDescription": "This action shall reset the chassis. Additionally, it may reset systems or other contained resources depending on the ResetType used to invoke this action.",
"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 complete an implementation-specific default reset. Services should include the @Redfish.AllowableValues annotation for this parameter to ensure compatibility with clients, even when ActionInfo has been implemented."
}
},
"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"
},
"ThermalDirection": {
"enum": [
"FrontToBack",
"BackToFront",
"TopExhaust",
"Sealed"
],
"enumDescriptions": {
"BackToFront": "A chassis with the air intake in the back and exhaust out the front.",
"FrontToBack": "A chassis with the air intake in the front and exhaust out the back.",
"Sealed": "A sealed chassis with no air pathway.",
"TopExhaust": "A chassis with air exhaust on the top."
},
"enumLongDescriptions": {
"BackToFront": "This value shall indicate a chassis with the air intake generally from the back of the chassis and the air exhaust out the front of the chassis.",
"FrontToBack": "This value shall indicate a chassis with the air intake generally from the front of the chassis and the air exhaust out the back of the chassis.",
"Sealed": "This value shall indicate a sealed chassis with no air pathway through the chassis.",
"TopExhaust": "This value shall indicate a chassis with the air exhaust out the top of the chassis."
},
"type": "string"
}
},
"owningEntity": "DMTF",
"release": "2023.3",
"title": "#Chassis.v1_25_0.Chassis"
}