Skip to content

redfish chassis

Jump to bottom
Pola, Sudhir edited this page May 25, 2026 · 1 revision

Redfish Chassis Resource

Table of Contents

Category - Device-Specific

Overview

The Chassis resource represents physical hardware inventory in the Redfish data model, providing comprehensive information about the physical chassis and environmental aspects of managed devices. This resource is device-specific and handles the aggregation of thermal, power, and physical security data from Intel Active Management Technology (AMT) enabled devices.

Physical Chassis Information

  • Physical chassis information mapping
  • Chassis identification and asset information
  • Physical form factor and enclosure details
  • Assembly and component inventory management through Assembly endpoint
  • Physical component relationships and hierarchy
  • Certificate-based device identity and attestation via Certificates collection

Thermal Sensor Data

  • Thermal sensor data aggregation
  • Temperature monitoring across chassis components
  • Thermal threshold management and alerts
  • Modern thermal subsystem monitoring with enhanced capabilities via ThermalSubsystem endpoint
  • Real-time thermal metrics and environmental data collection
  • Comprehensive sensor collection and monitoring through Sensors endpoint

Power Supply and Consumption

  • Power supply and consumption metrics via Power endpoint
  • Power usage monitoring and reporting
  • Power efficiency and capacity information
  • Advanced power subsystem management with redundancy support through PowerSubsystem endpoint
  • Power allocation and budgeting capabilities

Fan Control and Monitoring

  • Fan control and monitoring
  • Fan speed regulation and status
  • Cooling system performance metrics
  • Fan redundancy and thermal control management

Physical Security Settings

  • Physical security settings
  • Intrusion detection capabilities
  • Chassis lock and tamper detection
  • Certificate-based device identity and attestation through Certificates collection
  • Secure boot and hardware security features

Asset Tracking and Inventory

  • Asset tracking and inventory data
  • Serial numbers and asset tags
  • Hardware component inventory through Assembly endpoint
  • Drive and storage device enumeration via Drives collection
  • Physical assembly and sub-component tracking

Environmental Monitoring

  • Environmental monitoring capabilities
  • Ambient temperature and humidity sensing
  • Environmental threshold management
  • Comprehensive sensor collection and monitoring through Sensors endpoint
  • Environmental metrics aggregation and reporting via EnvironmentMetrics endpoint

System Control and Management

  • Controllable chassis elements (fans, LEDs, power buttons) via Controls collection
  • Physical control mechanisms and automation
  • Boot control capabilities and security settings
  • Control parameter ranges and operational modes

Logging and Diagnostics

  • System and security log collection through LogServices endpoint
  • Event logging and audit trail management
  • Log retention policies and remote forwarding
  • Chassis-level diagnostic capabilities

Network and Connectivity

  • Network adapter inventory and management via NetworkAdapters collection
  • Fabric adapter connectivity and status monitoring through FabricAdapters endpoint
  • Network interface configuration and statistics
  • High-speed interconnect management (InfiniBand, Ethernet, Fibre Channel)
  • Network topology discovery and mapping

Memory and Storage Components

  • Memory module inventory and health monitoring through Memory collection
  • Memory configuration and capacity reporting
  • DIMM-level error detection and reporting
  • PCIe device enumeration and management via PCIeDevices collection
  • Expansion card inventory and status
  • Storage device integration and monitoring through Drives collection

Chassis-Level Actions

  • Chassis-level actions and controls
  • Physical reset capabilities
  • Environmental control operations
  • Power management and system lifecycle operations

URIs - Supported

The Redfish Chassis resource implementation provides several endpoints for accessing and managing physical chassis information through the Intel DMT Console API. These endpoints follow the Redfish specification and map to underlying WS-Man interfaces from the wsman-messages repository to aggregate physical hardware inventory and environmental data from Intel AMT enabled devices.

Implementation Overview:

  • WS-Man interface availability varies by AMT version and device capabilities
  • Graceful degradation when specific interfaces are unavailable
  • Event-based monitoring for real-time chassis status updates
  • Retry mechanisms for transient WS-Man communication failures

To Be Added: The following section will be updated to document and analyze URIs listed under "To be Analysed" once their implementation details and support status are reviewed.

URIs - Not Supported

To Be Added: This section will document Redfish Chassis URIs that are not supported by the current implementation. Please update with a list and brief description of unsupported endpoints as they are identified.

URIs - To Be Analysed

GET /redfish/v1/Chassis - Chassis Collection Endpoint

  • Description: Retrieves a collection of chassis resources available in the system
  • Parameters: None
  • WS-Man Operations:
    • CIM_Chassis.Enumerate() - Discovers available chassis instances
    • CIM_Chassis.Pull() - Retrieves chassis collection data
Property Name Category CIM Object
@odata.type Metadata Collection Type Identifier
@odata.id Metadata Collection Resource URI
Name Collection Static Collection Name
Members@odata.count Collection CIM_Chassis.Enumerate() Result Count
Members[@odata.id] Collection CIM_Chassis Instance References

Example Response Structure:

{
  "@odata.type": "#ChassisCollection.ChassisCollection",
  "@odata.id": "/redfish/v1/Chassis",
  "Name": "Chassis Collection",
  "Members@odata.count": 3,
  "Members": [
    {
      "@odata.id": "/redfish/v1/Chassis/12345678-9abc-def0-1234-56789abcdef0"
    },
    {
      "@odata.id": "/redfish/v1/Chassis/87654321-cdef-0123-4567-89abcdef0123"
    },
    {
      "@odata.id": "/redfish/v1/Chassis/abcdef01-2345-6789-abcd-ef0123456789"
    }
  ]
}

GET /redfish/v1/Chassis/{device-guid} - Individual Chassis Endpoint

  • Description: Retrieves detailed information about a specific chassis
  • Parameters:
    • device-guid (path): The unique identifier of the device/chassis
  • WS-Man Operations:
    • CIM_Chassis.Get() - Retrieves chassis physical properties
    • CIM_PhysicalFrame.Get() - Gets physical dimensions and security info
    • CIM_PhysicalPackage.Get() - Retrieves packaging information
Name Property Category CIM Object
ChassisType Physical CIM_Chassis.ChassisPackageType
Manufacturer Asset CIM_Chassis.Manufacturer
Model Asset CIM_Chassis.Model
SerialNumber Asset CIM_Chassis.SerialNumber
PartNumber Asset CIM_Chassis.PartNumber
AssetTag Asset CIM_Chassis.Tag
SKU Asset CIM_Chassis.VendorEquipmentType
PowerState Power CIM_PowerManagementService.PowerState
IndicatorLED Physical CIM_PhysicalFrame.VisibleAlarm
LocationIndicatorActive Physical CIM_PhysicalFrame.AudibleAlarm
PhysicalSecurity.IntrusionSensor Security CIM_PhysicalFrame.SecurityBreach
PhysicalSecurity.IntrusionSensorNumber Security CIM_PhysicalFrame.SecurityBreachDescription
Status.State Status CIM_ManagedSystemElement.EnabledState
Status.Health Status CIM_ManagedSystemElement.HealthState
PowerConsumedWatts Power IPS_PowerManagementService.PowerConsumedWatts
EnvironmentalClass Environmental AMT_EnvironmentDetectionSettingData.DetectionAlgorithm

Example Response Structure:

{
  "@odata.type": "#Chassis.v1_14_0.Chassis",
  "@odata.id": "/redfish/v1/Chassis/{device-guid}",
  "Id": "{device-guid}",
  "Name": "Computer System Chassis",
  "ChassisType": "RackMount|Desktop|Laptop|Tablet|Other",
  "Manufacturer": "Intel Corporation",
  "Model": "AMT Enabled Device",
  "SerialNumber": "ABC123456789",
  "PartNumber": "PART-12345",
  "AssetTag": "ASSET-TAG-001",
  "Status": {
    "State": "Enabled",
    "Health": "OK"
  },
  "PhysicalSecurity": {
    "IntrusionSensorNumber": 1,
    "IntrusionSensor": "Normal"
  },
  "Power": {
    "@odata.id": "/redfish/v1/Chassis/{device-guid}/Power"
  },
  "Thermal": {
    "@odata.id": "/redfish/v1/Chassis/{device-guid}/Thermal"
  },
  "Links": {
    "ComputerSystems": [
      {
        "@odata.id": "/redfish/v1/Systems/{device-guid}"
      }
    ],
    "ManagedBy": [
      {
        "@odata.id": "/redfish/v1/Managers/{device-guid}"
      }
    ]
  },
  "Actions": {
    "#Chassis.Reset": {
      "target": "/redfish/v1/Chassis/{device-guid}/Actions/Chassis.Reset",
      "ResetType@Redfish.AllowableValues": [
        "PowerCycle"
      ]
    }
  }
}

GET /redfish/v1/Chassis/{device-guid}/Power - Power Subsystem Endpoint

  • Description: Retrieves power consumption and supply information for the chassis
  • WS-Man Operations:
    • CIM_PowerManagementService.Get() - Power management capabilities
    • IPS_PowerManagementService.Get() - Intel-specific power features
    • CIM_AssociatedPowerManagementService.Pull() - Power state associations
Property Name Category CIM Object
PowerConsumedWatts Power IPS_PowerManagementService.PowerConsumedWatts
PowerRequestedWatts Power CIM_PowerManagementService.RequestedPowerState
PowerAvailableWatts Power CIM_PowerManagementService.AvailableRequestedPowerStates
PowerCapacityWatts Power CIM_PowerSupply.MaxPowerOutput
PowerAllocatedWatts Power CIM_PowerManagementService.PowerAllocationState
PowerMetrics.MinConsumedWatts Metrics IPS_PowerManagementService.MinPowerConsumption
PowerMetrics.MaxConsumedWatts Metrics IPS_PowerManagementService.MaxPowerConsumption
PowerMetrics.AverageConsumedWatts Metrics IPS_PowerManagementService.AveragePowerConsumption
PowerSupplies.PowerInputWatts Supply CIM_PowerSupply.InputPower
PowerSupplies.PowerOutputWatts Supply CIM_PowerSupply.OutputPower
PowerSupplies.EfficiencyPercent Supply CIM_PowerSupply.Efficiency
PowerSupplies.PowerSupplyType Supply CIM_PowerSupply.PowerSupplyType
PowerSupplies.LineInputVoltageType Supply CIM_PowerSupply.InputVoltage
Status.State Status CIM_ManagedSystemElement.EnabledState
Status.Health Status CIM_ManagedSystemElement.HealthState

Example Response Structure:

{
  "@odata.type": "#Power.v1_5_0.Power",
  "@odata.id": "/redfish/v1/Chassis/{device-guid}/Power",
  "Id": "Power",
  "Name": "Power",
  "PowerControl": [
    {
      "@odata.id": "/redfish/v1/Chassis/{device-guid}/Power#/PowerControl/0",
      "MemberId": "0",
      "Name": "System Power Control",
      "PowerConsumedWatts": 65,
      "PowerRequestedWatts": 100,
      "PowerAvailableWatts": 150,
      "PowerCapacityWatts": 200,
      "PowerAllocatedWatts": 100,
      "PowerMetrics": {
        "IntervalInMin": 1,
        "MinConsumedWatts": 45,
        "MaxConsumedWatts": 85,
        "AverageConsumedWatts": 65
      },
      "Status": {
        "State": "Enabled",
        "Health": "OK"
      }
    }
  ],
  "PowerSupplies": [
    {
      "@odata.id": "/redfish/v1/Chassis/{device-guid}/Power#/PowerSupplies/0",
      "MemberId": "0",
      "Name": "Power Supply 1",
      "Status": {
        "State": "Enabled",
        "Health": "OK"
      },
      "PowerCapacityWatts": 200,
      "PowerInputWatts": 70,
      "PowerOutputWatts": 65,
      "EfficiencyPercent": 92.8,
      "PowerSupplyType": "AC",
      "LineInputVoltageType": "AC120V"
    }
  ]
}

GET /redfish/v1/Chassis/{device-guid}/Thermal - Thermal Subsystem Endpoint

  • Description: Retrieves thermal sensor data and fan information for the chassis
  • WS-Man Operations:
    • AMT_EVENT_DATA.Pull() - Sensor event data with EventSensorType filtering
    • CIM_PhysicalPackage.Pull() - Physical components with PackageType = Fan/Sensor
    • AMT_EnvironmentDetectionSettingData.Get() - Environmental monitoring settings
Property Name Category CIM Object
Temperatures.Name Sensor AMT_EVENT_DATA.EventSensorType
Temperatures.SensorNumber Sensor AMT_EVENT_DATA.SensorNumber
Temperatures.ReadingCelsius Sensor AMT_EVENT_DATA.EventData
Temperatures.UpperThresholdNonCritical Threshold AMT_EVENT_DATA.EventData
Temperatures.UpperThresholdCritical Threshold AMT_EVENT_DATA.EventData
Temperatures.UpperThresholdFatal Threshold AMT_EVENT_DATA.EventData
Temperatures.LowerThresholdNonCritical Threshold AMT_EVENT_DATA.EventData
Temperatures.LowerThresholdCritical Threshold AMT_EVENT_DATA.EventData
Temperatures.PhysicalContext Physical CIM_PhysicalPackage.PackageType
Fans.Name Fan CIM_PhysicalPackage.Name
Fans.Reading Fan CIM_Fan.DesiredSpeed
Fans.ReadingUnits Fan CIM_Fan.SpeedUnits
Fans.MinReadingRange Fan CIM_Fan.MinSpeed
Fans.MaxReadingRange Fan CIM_Fan.MaxSpeed
Fans.PhysicalContext Physical CIM_PhysicalPackage.PackageType
Status.State Status CIM_ManagedSystemElement.EnabledState
Status.Health Status CIM_ManagedSystemElement.HealthState

Example Response Structure:

{
  "@odata.type": "#Thermal.v1_6_0.Thermal",
  "@odata.id": "/redfish/v1/Chassis/{device-guid}/Thermal",
  "Id": "Thermal",
  "Name": "Thermal",
  "Temperatures": [
    {
      "@odata.id": "/redfish/v1/Chassis/{device-guid}/Thermal#/Temperatures/0",
      "MemberId": "0",
      "Name": "CPU Temperature",
      "SensorNumber": 1,
      "Status": {
        "State": "Enabled",
        "Health": "OK"
      },
      "ReadingCelsius": 45,
      "UpperThresholdNonCritical": 75,
      "UpperThresholdCritical": 85,
      "UpperThresholdFatal": 95,
      "LowerThresholdNonCritical": 5,
      "LowerThresholdCritical": 0,
      "PhysicalContext": "CPU",
      "RelatedItem": [
        {
          "@odata.id": "/redfish/v1/Systems/{device-guid}/Processors/CPU1"
        }
      ]
    }
  ],
  "Fans": [
    {
      "@odata.id": "/redfish/v1/Chassis/{device-guid}/Thermal#/Fans/0",
      "MemberId": "0",
      "Name": "System Fan 1",
      "Status": {
        "State": "Enabled",
        "Health": "OK"
      },
      "Reading": 2500,
      "ReadingUnits": "RPM",
      "MinReadingRange": 0,
      "MaxReadingRange": 5000,
      "PhysicalContext": "SystemBoard",
      "RelatedItem": [
        {
          "@odata.id": "/redfish/v1/Chassis/{device-guid}"
        }
      ]
    }
  ]
}

GET /redfish/v1/Chassis/{device-guid}/Assembly - Assembly Endpoint

  • Description: Retrieves assembly information and component details for the chassis
  • Parameters:
    • device-guid (path): The unique identifier of the device/chassis
  • WS-Man Operations:
    • CIM_PhysicalElement.Enumerate() - Retrieves physical components
    • CIM_Realizes.Pull() - Gets physical-to-logical relationships
    • CIM_PhysicalComponent.Get() - Individual component details
Property Name Category CIM Object
Assemblies.Name Assembly CIM_PhysicalElement.Name
Assemblies.Description Assembly CIM_PhysicalElement.Description
Assemblies.Model Assembly CIM_PhysicalElement.Model
Assemblies.PartNumber Assembly CIM_PhysicalElement.PartNumber
Assemblies.SerialNumber Assembly CIM_PhysicalElement.SerialNumber
Assemblies.Manufacturer Assembly CIM_PhysicalElement.Manufacturer
Assemblies.Version Assembly CIM_PhysicalElement.Version
Assemblies.SKU Assembly CIM_PhysicalElement.VendorEquipmentType
Assemblies.SparePartNumber Assembly CIM_PhysicalElement.OtherIdentifyingInfo
Assemblies.PhysicalContext Physical CIM_PhysicalElement.ElementName
Assemblies.BinaryDataURI Binary CIM_SoftwareElement.SoftwareElementID
Status.State Status CIM_ManagedSystemElement.EnabledState
Status.Health Status CIM_ManagedSystemElement.HealthState

Example Response Structure:

{
  "@odata.type": "#Assembly.v1_2_0.Assembly",
  "@odata.id": "/redfish/v1/Chassis/{device-guid}/Assembly",
  "Id": "Assembly",
  "Name": "Chassis Assembly",
  "Assemblies": [
    {
      "@odata.id": "/redfish/v1/Chassis/{device-guid}/Assembly#/Assemblies/0",
      "MemberId": "0",
      "Name": "System Board",
      "Description": "Main system board assembly",
      "Model": "SystemBoard-001",
      "PartNumber": "PN-SB-12345",
      "SerialNumber": "SB123456789",
      "Manufacturer": "Intel Corporation",
      "Version": "1.0",
      "SKU": "16392",
      "PhysicalContext": "SystemBoard",
      "Status": {
        "State": "Enabled",
        "Health": "OK"
      }
    }
  ]
}

GET /redfish/v1/Chassis/{device-guid}/Certificates - Certificates Collection Endpoint

  • Description: Retrieves a collection of certificates for device identity and attestation
  • Parameters:
    • device-guid (path): The unique identifier of the device/chassis
  • WS-Man Operations:
    • AMT_X509Certificate.Enumerate() - Retrieves X.509 certificates
    • AMT_TLSCredentialContext.Pull() - Gets TLS credential associations
    • AMT_KeyManagementService.Get() - Key management information
Property Name Category CIM Object
Members[@odata.id] Collection AMT_X509Certificate Instance References
Members@odata.count Collection AMT_X509Certificate.Enumerate() Result Count
Certificate.CertificateString Certificate AMT_X509Certificate.X509Certificate
Certificate.CertificateType Certificate AMT_X509Certificate.TrustedRootCertficate
Certificate.Issuer.CommonName Certificate AMT_X509Certificate.Issuer
Certificate.Subject.CommonName Certificate AMT_X509Certificate.Subject
Certificate.ValidNotBefore Certificate AMT_X509Certificate.NotBefore
Certificate.ValidNotAfter Certificate AMT_X509Certificate.NotAfter
Certificate.KeyUsage Certificate AMT_X509Certificate.KeyUsage
Certificate.Fingerprint Certificate AMT_X509Certificate.Fingerprint
Certificate.SerialNumber Certificate AMT_X509Certificate.SerialNumber
Status.State Status CIM_ManagedSystemElement.EnabledState
Status.Health Status CIM_ManagedSystemElement.HealthState

Example Response Structure:

{
  "@odata.type": "#CertificateCollection.CertificateCollection",
  "@odata.id": "/redfish/v1/Chassis/{device-guid}/Certificates",
  "Name": "Certificate Collection",
  "Members@odata.count": 2,
  "Members": [
    {
      "@odata.id": "/redfish/v1/Chassis/{device-guid}/Certificates/1"
    },
    {
      "@odata.id": "/redfish/v1/Chassis/{device-guid}/Certificates/2"
    }
  ]
}

GET /redfish/v1/Chassis/{device-guid}/Controls - Controls Collection Endpoint

  • Description: Retrieves a collection of controls located in the chassis for managing system behavior
  • Parameters:
    • device-guid (path): The unique identifier of the device/chassis
  • WS-Man Operations:
    • CIM_PhysicalElement.Enumerate() - Retrieves controllable physical elements
    • AMT_BootCapabilities.Get() - Boot control capabilities
    • CIM_PowerManagementService.Get() - Power control capabilities
Property Name Category CIM Object
Members[@odata.id] Collection CIM_PhysicalElement Instance References
Members@odata.count Collection CIM_PhysicalElement.Enumerate() Result Count
Control.Name Control CIM_PhysicalElement.Name
Control.ControlType Control CIM_PhysicalElement.ElementName
Control.PhysicalContext Physical CIM_PhysicalElement.PackageType
Control.SetPoint Control CIM_ControlledBy.SetPoint
Control.SettingRangeMin Control CIM_ControlledBy.MinValue
Control.SettingRangeMax Control CIM_ControlledBy.MaxValue
Control.AllowableNumericValues Control CIM_ControlledBy.AllowableValues
Control.ControlMode Control CIM_ControlledBy.ControlMode
Control.SetPointAccuracy Control CIM_ControlledBy.Accuracy
Control.DeadBand Control CIM_ControlledBy.DeadBand
Status.State Status CIM_ManagedSystemElement.EnabledState
Status.Health Status CIM_ManagedSystemElement.HealthState

Example Response Structure:

{
  "@odata.type": "#ControlCollection.ControlCollection",
  "@odata.id": "/redfish/v1/Chassis/{device-guid}/Controls",
  "Name": "Controls Collection",
  "Members@odata.count": 3,
  "Members": [
    {
      "@odata.id": "/redfish/v1/Chassis/{device-guid}/Controls/FanControl1"
    },
    {
      "@odata.id": "/redfish/v1/Chassis/{device-guid}/Controls/LEDControl1"
    },
    {
      "@odata.id": "/redfish/v1/Chassis/{device-guid}/Controls/PowerButton"
    }
  ]
}

GET /redfish/v1/Chassis/{device-guid}/Drives - Drives Collection Endpoint

  • Description: Retrieves a collection of drives within the chassis
  • Parameters:
    • device-guid (path): The unique identifier of the device/chassis
  • WS-Man Operations:
    • CIM_DiskDrive.Enumerate() - Retrieves physical disk drives
    • CIM_StorageExtent.Pull() - Gets storage extent information
    • CIM_SystemDevice.Pull() - Device associations with the system
Property Name Category CIM Object
Members[@odata.id] Collection CIM_DiskDrive Instance References
Members@odata.count Collection CIM_DiskDrive.Enumerate() Result Count
Drive.Name Drive CIM_DiskDrive.Name
Drive.Model Drive CIM_DiskDrive.Model
Drive.SerialNumber Drive CIM_DiskDrive.SerialNumber
Drive.Manufacturer Drive CIM_DiskDrive.Manufacturer
Drive.Revision Drive CIM_DiskDrive.Revision
Drive.CapacityBytes Drive CIM_DiskDrive.Capacity
Drive.Protocol Drive CIM_DiskDrive.InterfaceType
Drive.MediaType Drive CIM_DiskDrive.MediaType
Drive.RotationSpeedRPM Drive CIM_DiskDrive.MaxMediaSize
Drive.BlockSizeBytes Drive CIM_DiskDrive.DefaultBlockSize
Drive.FailurePredicted Drive CIM_DiskDrive.ErrorMethodology
Drive.Location.PartLocation.ServiceLabel Physical CIM_PhysicalElement.ElementName
Status.State Status CIM_ManagedSystemElement.EnabledState
Status.Health Status CIM_ManagedSystemElement.HealthState

Example Response Structure:

{
  "@odata.type": "#DriveCollection.DriveCollection",
  "@odata.id": "/redfish/v1/Chassis/{device-guid}/Drives",
  "Name": "Drive Collection",
  "Members@odata.count": 2,
  "Members": [
    {
      "@odata.id": "/redfish/v1/Chassis/{device-guid}/Drives/Drive1"
    },
    {
      "@odata.id": "/redfish/v1/Chassis/{device-guid}/Drives/Drive2"
    }
  ]
}

GET /redfish/v1/Chassis/{device-guid}/EnvironmentMetrics - Environment Metrics Endpoint

  • Description: Retrieves environmental metrics for the chassis including power and thermal data
  • Parameters:
    • device-guid (path): The unique identifier of the device/chassis
  • WS-Man Operations:
    • AMT_EnvironmentDetectionSettingData.Get() - Environmental detection settings
    • IPS_PowerManagementService.Get() - Power consumption metrics
    • AMT_EVENT_DATA.Pull() - Environmental sensor event data
Property Name Category CIM Object
TemperatureCelsius.Reading Temperature AMT_EVENT_DATA.EventData (Temperature)
TemperatureCelsius.DataSourceUri Temperature AMT_EVENT_DATA.EventSensorType Reference
HumiditPercent.Reading Humidity AMT_EnvironmentDetectionSettingData.HumidityDetection
PowerWatts.Reading Power IPS_PowerManagementService.PowerConsumedWatts
PowerWatts.MinValue Power IPS_PowerManagementService.MinPowerConsumption
PowerWatts.MaxValue Power IPS_PowerManagementService.MaxPowerConsumption
PowerWatts.AverageValue Power IPS_PowerManagementService.AveragePowerConsumption
EnergyJoules.Reading Energy IPS_PowerManagementService.AccumulatedEnergyConsumption
EnergykWh.Reading Energy IPS_PowerManagementService.AccumulatedEnergyConsumption
FanSpeedsPercent.Reading Fan CIM_Fan.DesiredSpeed
FanSpeedsPercent.DataSourceUri Fan CIM_Fan Instance Reference
Status.State Status CIM_ManagedSystemElement.EnabledState
Status.Health Status CIM_ManagedSystemElement.HealthState

Example Response Structure:

{
  "@odata.type": "#EnvironmentMetrics.v1_3_0.EnvironmentMetrics",
  "@odata.id": "/redfish/v1/Chassis/{device-guid}/EnvironmentMetrics",
  "Id": "EnvironmentMetrics",
  "Name": "Chassis Environment Metrics",
  "TemperatureCelsius": {
    "Reading": 42.5,
    "DataSourceUri": "/redfish/v1/Chassis/{device-guid}/Thermal#/Temperatures/0"
  },
  "PowerWatts": {
    "Reading": 125.7,
    "MinValue": 45.2,
    "MaxValue": 185.3,
    "AverageValue": 78.9
  },
  "EnergyJoules": {
    "Reading": 1234567
  },
  "EnergykWh": {
    "Reading": 0.343
  },
  "FanSpeedsPercent": [
    {
      "Reading": 65.5,
      "DataSourceUri": "/redfish/v1/Chassis/{device-guid}/Thermal#/Fans/0"
    }
  ]
}

GET /redfish/v1/Chassis/{device-guid}/FabricAdapters - Fabric Adapters Collection Endpoint

  • Description: Retrieves a collection of fabric adapters within the chassis for high-speed interconnect management
  • Parameters:
    • device-guid (path): The unique identifier of the device/chassis
  • WS-Man Operations:
    • CIM_NetworkAdapter.Enumerate() - Retrieves network adapter instances with fabric capabilities
    • CIM_FibreChannelAdapter.Pull() - Gets Fibre Channel adapter information
    • CIM_InfiniBandController.Pull() - InfiniBand controller data
Property Name Category CIM Object
Members[@odata.id] Collection CIM_NetworkAdapter Instance References (Fabric)
Members@odata.count Collection CIM_NetworkAdapter.Enumerate() Result Count
FabricAdapter.Name Adapter CIM_NetworkAdapter.Name
FabricAdapter.Manufacturer Adapter CIM_NetworkAdapter.Manufacturer
FabricAdapter.Model Adapter CIM_NetworkAdapter.ProductName
FabricAdapter.SerialNumber Adapter CIM_NetworkAdapter.SerialNumber
FabricAdapter.PartNumber Adapter CIM_NetworkAdapter.PartNumber
FabricAdapter.SpeedGbps Performance CIM_NetworkAdapter.MaxSpeed
FabricAdapter.FirmwareVersion Firmware CIM_NetworkAdapter.DriverVersion
FabricAdapter.FabricType Fabric CIM_NetworkAdapter.NetworkConnectionMode
FabricAdapter.WWN Fabric CIM_FibreChannelAdapter.PermanentAddress
FabricAdapter.WWNN Fabric CIM_FibreChannelAdapter.NodeWWN
FabricAdapter.WWPN Fabric CIM_FibreChannelAdapter.PortWWN
FabricAdapter.InfiniBandGUID Fabric CIM_InfiniBandController.SystemName
Status.State Status CIM_ManagedSystemElement.EnabledState
Status.Health Status CIM_ManagedSystemElement.HealthState

Example Response Structure:

{
  "@odata.type": "#FabricAdapterCollection.FabricAdapterCollection",
  "@odata.id": "/redfish/v1/Chassis/{device-guid}/FabricAdapters",
  "Name": "Fabric Adapter Collection",
  "Members@odata.count": 2,
  "Members": [
    {
      "@odata.id": "/redfish/v1/Chassis/{device-guid}/FabricAdapters/FabricAdapter1"
    },
    {
      "@odata.id": "/redfish/v1/Chassis/{device-guid}/FabricAdapters/FabricAdapter2"
    }
  ]
}

GET /redfish/v1/Chassis/{device-guid}/LogServices - Log Services Collection Endpoint

  • Description: Retrieves a collection of log services available for the chassis
  • Parameters:
    • device-guid (path): The unique identifier of the device/chassis
  • WS-Man Operations:
    • AMT_MessageLog.Enumerate() - AMT system logs
    • CIM_LogicalFile.Pull() - Log file associations
    • AMT_AuditLog.Get() - Security audit logs
Property Name Category CIM Object
Members[@odata.id] Collection AMT_MessageLog Instance References
Members@odata.count Collection AMT_MessageLog.Enumerate() Result Count
LogService.Name LogService AMT_MessageLog.Name
LogService.Description LogService AMT_MessageLog.Description
LogService.ServiceEnabled LogService AMT_MessageLog.EnabledState
LogService.MaxNumberOfRecords LogService AMT_MessageLog.MaxLogSize
LogService.OverWritePolicy LogService AMT_MessageLog.LogState
LogService.LogEntryType LogService AMT_MessageLog.LogFormat
LogService.LogPurgePolicy LogService AMT_MessageLog.LogBehavior
LogService.DateTimeLocalOffset LogService CIM_TimeService.TimeOffset
LogService.SyslogFacility LogService AMT_SystemLog.SyslogFacility
LogService.SyslogSeverity LogService AMT_SystemLog.SyslogSeverity
Status.State Status CIM_ManagedSystemElement.EnabledState
Status.Health Status CIM_ManagedSystemElement.HealthState

Example Response Structure:

{
  "@odata.type": "#LogServiceCollection.LogServiceCollection",
  "@odata.id": "/redfish/v1/Chassis/{device-guid}/LogServices",
  "Name": "Log Service Collection",
  "Members@odata.count": 2,
  "Members": [
    {
      "@odata.id": "/redfish/v1/Chassis/{device-guid}/LogServices/SystemLog"
    },
    {
      "@odata.id": "/redfish/v1/Chassis/{device-guid}/LogServices/SecurityLog"
    }
  ]
}

GET /redfish/v1/Chassis/{device-guid}/Memory - Memory Collection Endpoint

  • Description: Retrieves a collection of memory modules within the chassis
  • Parameters:
    • device-guid (path): The unique identifier of the device/chassis
  • WS-Man Operations:
    • CIM_PhysicalMemory.Enumerate() - Retrieves physical memory modules
    • CIM_MemoryDevice.Pull() - Gets memory device information
    • CIM_SystemDevice.Pull() - Memory associations with the system
Property Name Category CIM Object
Members[@odata.id] Collection CIM_PhysicalMemory Instance References
Members@odata.count Collection CIM_PhysicalMemory.Enumerate() Result Count
Memory.Name Memory CIM_PhysicalMemory.Name
Memory.MemoryType Memory CIM_PhysicalMemory.MemoryType
Memory.MemoryDeviceType Memory CIM_PhysicalMemory.FormFactor
Memory.CapacityMiB Memory CIM_PhysicalMemory.Capacity
Memory.DataWidthBits Memory CIM_PhysicalMemory.DataWidth
Memory.BusWidthBits Memory CIM_PhysicalMemory.TotalWidth
Memory.SpeedMHz Memory CIM_PhysicalMemory.Speed
Memory.Manufacturer Memory CIM_PhysicalMemory.Manufacturer
Memory.SerialNumber Memory CIM_PhysicalMemory.SerialNumber
Memory.PartNumber Memory CIM_PhysicalMemory.PartNumber
Memory.DeviceLocator Physical CIM_PhysicalMemory.DeviceLocator
Memory.BankLocator Physical CIM_PhysicalMemory.BankLabel
Memory.RankCount Memory CIM_PhysicalMemory.Attributes
Memory.ErrorCorrection Memory CIM_PhysicalMemory.ErrorCorrection
Memory.VolatileRegionSizeLimitMiB Memory CIM_PhysicalMemory.MaxMemorySpeed
Status.State Status CIM_ManagedSystemElement.EnabledState
Status.Health Status CIM_ManagedSystemElement.HealthState

Example Response Structure:

{
  "@odata.type": "#MemoryCollection.MemoryCollection",
  "@odata.id": "/redfish/v1/Chassis/{device-guid}/Memory",
  "Name": "Memory Collection",
  "Members@odata.count": 4,
  "Members": [
    {
      "@odata.id": "/redfish/v1/Chassis/{device-guid}/Memory/DIMM1"
    },
    {
      "@odata.id": "/redfish/v1/Chassis/{device-guid}/Memory/DIMM2"
    },
    {
      "@odata.id": "/redfish/v1/Chassis/{device-guid}/Memory/DIMM3"
    },
    {
      "@odata.id": "/redfish/v1/Chassis/{device-guid}/Memory/DIMM4"
    }
  ]
}

GET /redfish/v1/Chassis/{device-guid}/NetworkAdapters - Network Adapters Collection Endpoint

  • Description: Retrieves a collection of network adapters within the chassis
  • Parameters:
    • device-guid (path): The unique identifier of the device/chassis
  • WS-Man Operations:
    • CIM_NetworkAdapter.Enumerate() - Retrieves network adapter instances
    • CIM_NetworkPort.Pull() - Gets network port information
    • CIM_EthernetAdapter.Get() - Ethernet-specific adapter details
Property Name Category CIM Object
Members[@odata.id] Collection CIM_NetworkAdapter Instance References
Members@odata.count Collection CIM_NetworkAdapter.Enumerate() Result Count
NetworkAdapter.Name Adapter CIM_NetworkAdapter.Name
NetworkAdapter.Manufacturer Adapter CIM_NetworkAdapter.Manufacturer
NetworkAdapter.Model Adapter CIM_NetworkAdapter.ProductName
NetworkAdapter.SerialNumber Adapter CIM_NetworkAdapter.SerialNumber
NetworkAdapter.PartNumber Adapter CIM_NetworkAdapter.PartNumber
NetworkAdapter.SpeedMbps Performance CIM_NetworkAdapter.MaxSpeed
NetworkAdapter.FirmwareVersion Firmware CIM_NetworkAdapter.DriverVersion
NetworkAdapter.NetworkPorts Ports CIM_NetworkPort Collection References
NetworkAdapter.NetworkDeviceFunctions Functions CIM_NetworkAdapter.DeviceFunctions
NetworkPorts.LinkStatus Port CIM_NetworkPort.LinkTechnology
NetworkPorts.SupportedLinkCapabilities Port CIM_NetworkPort.SupportedMaximumTransmissionUnit
NetworkPorts.AssociatedNetworkAddresses Port CIM_NetworkPort.PermanentAddress
NetworkPorts.PhysicalPortNumber Physical CIM_NetworkPort.PortNumber
Status.State Status CIM_ManagedSystemElement.EnabledState
Status.Health Status CIM_ManagedSystemElement.HealthState

Example Response Structure:

{
  "@odata.type": "#NetworkAdapterCollection.NetworkAdapterCollection",
  "@odata.id": "/redfish/v1/Chassis/{device-guid}/NetworkAdapters",
  "Name": "Network Adapter Collection",
  "Members@odata.count": 2,
  "Members": [
    {
      "@odata.id": "/redfish/v1/Chassis/{device-guid}/NetworkAdapters/NetworkAdapter1"
    },
    {
      "@odata.id": "/redfish/v1/Chassis/{device-guid}/NetworkAdapters/NetworkAdapter2"
    }
  ]
}

GET /redfish/v1/Chassis/{device-guid}/PCIeDevices - PCIe Devices Collection Endpoint

  • Description: Retrieves a collection of PCIe devices within the chassis
  • Parameters:
    • device-guid (path): The unique identifier of the device/chassis
  • WS-Man Operations:
    • CIM_PCIDevice.Enumerate() - Retrieves PCIe device instances
    • CIM_PCIController.Pull() - Gets PCIe controller information
    • CIM_SystemDevice.Pull() - PCIe device associations
Property Name Category CIM Object
Members[@odata.id] Collection CIM_PCIDevice Instance References
Members@odata.count Collection CIM_PCIDevice.Enumerate() Result Count
PCIeDevice.Name Device CIM_PCIDevice.Name
PCIeDevice.Manufacturer Device CIM_PCIDevice.Manufacturer
PCIeDevice.Model Device CIM_PCIDevice.ProductName
PCIeDevice.SerialNumber Device CIM_PCIDevice.SerialNumber
PCIeDevice.PartNumber Device CIM_PCIDevice.PartNumber
PCIeDevice.SKU Device CIM_PCIDevice.VendorEquipmentType
PCIeDevice.DeviceType Device CIM_PCIDevice.ClassCode
PCIeDevice.FirmwareVersion Firmware CIM_PCIDevice.DriverVersion
PCIeDevice.PCIeInterface.MaxPCIeType Interface CIM_PCIDevice.MaxDataWidth
PCIeDevice.PCIeInterface.MaxLanes Interface CIM_PCIDevice.MaxNumberOfPorts
PCIeDevice.PCIeInterface.PCIeType Interface CIM_PCIDevice.DataWidth
PCIeDevice.PCIeInterface.LanesInUse Interface CIM_PCIDevice.NumberOfPorts
PCIeDevice.PCIeFunctions Functions CIM_PCIDevice Collection References
PCIeDevice.SlotType Physical CIM_PCIController.AdapterType
PCIeDevice.SlotNumber Physical CIM_PCIController.DeviceNumber
Status.State Status CIM_ManagedSystemElement.EnabledState
Status.Health Status CIM_ManagedSystemElement.HealthState

Example Response Structure:

{
  "@odata.type": "#PCIeDeviceCollection.PCIeDeviceCollection",
  "@odata.id": "/redfish/v1/Chassis/{device-guid}/PCIeDevices",
  "Name": "PCIe Device Collection",
  "Members@odata.count": 5,
  "Members": [
    {
      "@odata.id": "/redfish/v1/Chassis/{device-guid}/PCIeDevices/PCIeDevice1"
    },
    {
      "@odata.id": "/redfish/v1/Chassis/{device-guid}/PCIeDevices/PCIeDevice2"
    },
    {
      "@odata.id": "/redfish/v1/Chassis/{device-guid}/PCIeDevices/PCIeDevice3"
    },
    {
      "@odata.id": "/redfish/v1/Chassis/{device-guid}/PCIeDevices/PCIeDevice4"
    },
    {
      "@odata.id": "/redfish/v1/Chassis/{device-guid}/PCIeDevices/PCIeDevice5"
    }
  ]
}

GET /redfish/v1/Chassis/{device-guid}/Sensors - Sensors Collection Endpoint

  • Description: Retrieves a collection of sensors located in the chassis and sub-components
  • Parameters:
    • device-guid (path): The unique identifier of the device/chassis
  • WS-Man Operations:
    • AMT_EVENT_DATA.Enumerate() - All sensor event data
    • CIM_Sensor.Pull() - Physical sensor information
    • CIM_NumericSensor.Get() - Numeric sensor readings
Property Name Category CIM Object
Members[@odata.id] Collection AMT_EVENT_DATA Instance References
Members@odata.count Collection AMT_EVENT_DATA.Enumerate() Result Count
Sensor.Name Sensor AMT_EVENT_DATA.EventSensorType
Sensor.Reading Sensor AMT_EVENT_DATA.EventData
Sensor.ReadingType Sensor AMT_EVENT_DATA.EventData Type
Sensor.ReadingUnits Sensor CIM_NumericSensor.Units
Sensor.PhysicalContext Physical CIM_Sensor.DeviceID
Sensor.PhysicalSubContext Physical CIM_Sensor.ElementName
Sensor.ReadingRangeMin Range CIM_NumericSensor.MinValue
Sensor.ReadingRangeMax Range CIM_NumericSensor.MaxValue
Sensor.Accuracy Accuracy CIM_NumericSensor.Accuracy
Sensor.Precision Accuracy CIM_NumericSensor.Resolution
Sensor.SensingFrequency Frequency CIM_NumericSensor.SensingInterval
Status.State Status CIM_ManagedSystemElement.EnabledState
Status.Health Status CIM_ManagedSystemElement.HealthState

Example Response Structure:

{
  "@odata.type": "#SensorCollection.SensorCollection",
  "@odata.id": "/redfish/v1/Chassis/{device-guid}/Sensors",
  "Name": "Sensor Collection",
  "Members@odata.count": 12,
  "Members": [
    {
      "@odata.id": "/redfish/v1/Chassis/{device-guid}/Sensors/CPUTemp"
    },
    {
      "@odata.id": "/redfish/v1/Chassis/{device-guid}/Sensors/SystemFan1"
    },
    {
      "@odata.id": "/redfish/v1/Chassis/{device-guid}/Sensors/12VRail"
    }
  ]
}

GET /redfish/v1/Chassis/{device-guid}/PowerSubsystem - Power Subsystem Endpoint

  • Description: Retrieves detailed power subsystem information for the chassis (preferred over deprecated Power endpoint)
  • Parameters:
    • device-guid (path): The unique identifier of the device/chassis
  • WS-Man Operations:
    • IPS_PowerManagementService.Get() - Intel power management capabilities
    • CIM_PowerSupply.Enumerate() - Power supply enumeration
    • CIM_PowerManagementCapabilities.Get() - Power management features
Property Name Category CIM Object
PowerSupplies[@odata.id] Collection CIM_PowerSupply Instance References
PowerSupplies@odata.count Collection CIM_PowerSupply.Enumerate() Result Count
PowerSupplyRedundancy Redundancy CIM_RedundancySet.RedundancyStatus
AllocationPercent Allocation IPS_PowerManagementService.PowerAllocationPercent
CapacityWatts Capacity CIM_PowerSupply.TotalOutputPower
ConsumedWatts Consumption IPS_PowerManagementService.PowerConsumedWatts
PowerSupplies.EfficiencyPercent Efficiency CIM_PowerSupply.EfficiencyPercent
PowerSupplies.FirmwareVersion Firmware CIM_PowerSupply.FirmwareVersion
PowerSupplies.HotPluggable Physical CIM_PowerSupply.HotSwappable
PowerSupplies.InputVoltage Input CIM_PowerSupply.InputVoltage
PowerSupplies.LineInputVoltageType Input CIM_PowerSupply.InputVoltageRange
PowerSupplies.OutputVoltage Output CIM_PowerSupply.OutputVoltage
Status.State Status CIM_ManagedSystemElement.EnabledState
Status.Health Status CIM_ManagedSystemElement.HealthState

Example Response Structure:

{
  "@odata.type": "#PowerSubsystem.v1_1_0.PowerSubsystem",
  "@odata.id": "/redfish/v1/Chassis/{device-guid}/PowerSubsystem",
  "Id": "PowerSubsystem",
  "Name": "Power Subsystem",
  "Status": {
    "State": "Enabled",
    "Health": "OK"
  },
  "CapacityWatts": 500,
  "AllocationPercent": 75.2,
  "PowerSupplies": {
    "@odata.id": "/redfish/v1/Chassis/{device-guid}/PowerSubsystem/PowerSupplies"
  },
  "PowerSupplyRedundancy": [
    {
      "RedundancyType": "NPlusOne",
      "MaxSupportedInGroup": 2,
      "MinNeededInGroup": 1,
      "Status": {
        "State": "Enabled",
        "Health": "OK"
      }
    }
  ]
}

GET /redfish/v1/Chassis/{device-guid}/ThermalSubsystem - Thermal Subsystem Endpoint

  • Description: Retrieves detailed thermal subsystem information for the chassis (preferred over deprecated Thermal endpoint)
  • Parameters:
    • device-guid (path): The unique identifier of the device/chassis
  • WS-Man Operations:
    • AMT_EnvironmentDetectionSettingData.Get() - Environmental detection settings
    • CIM_Fan.Enumerate() - Fan enumeration and control
    • CIM_TemperatureSensor.Pull() - Temperature sensor data
Property Name Category CIM Object
ThermalMetrics[@odata.id] Metrics AMT_EnvironmentDetectionSettingData Reference
Fans[@odata.id] Collection CIM_Fan Instance References
Fans@odata.count Collection CIM_Fan.Enumerate() Result Count
ThermalDirection Thermal CIM_Chassis.ThermalDirection
ThermalManagedByParent Management CIM_Chassis.ThermalManagedByParent
FanRedundancy Redundancy CIM_RedundancySet.RedundancyStatus
Fans.SpeedPercent Fan CIM_Fan.DesiredSpeed
Fans.SpeedRPM Fan CIM_Fan.ActiveCooling
Fans.Controllable Fan CIM_Fan.VariableSpeed
Fans.HotPluggable Physical CIM_Fan.HotSwappable
Fans.LocationIndicatorActive Physical CIM_Fan.StatusInfo
Fans.PhysicalContext Physical CIM_Fan.DeviceID
TemperatureSensors.ReadingCelsius Temperature CIM_TemperatureSensor.CurrentReading
TemperatureSensors.PhysicalContext Physical CIM_TemperatureSensor.DeviceID
Status.State Status CIM_ManagedSystemElement.EnabledState
Status.Health Status CIM_ManagedSystemElement.HealthState

Example Response Structure:

{
  "@odata.type": "#ThermalSubsystem.v1_3_0.ThermalSubsystem",
  "@odata.id": "/redfish/v1/Chassis/{device-guid}/ThermalSubsystem",
  "Id": "ThermalSubsystem",
  "Name": "Thermal Subsystem",
  "Status": {
    "State": "Enabled",
    "Health": "OK"
  },
  "ThermalMetrics": {
    "@odata.id": "/redfish/v1/Chassis/{device-guid}/ThermalSubsystem/ThermalMetrics"
  },
  "Fans": {
    "@odata.id": "/redfish/v1/Chassis/{device-guid}/ThermalSubsystem/Fans"
  },
  "FanRedundancy": [
    {
      "RedundancyType": "NPlusOne",
      "MaxSupportedInGroup": 3,
      "MinNeededInGroup": 2,
      "Status": {
        "State": "Enabled",
        "Health": "OK"
      }
    }
  ]
}

POST /redfish/v1/Chassis/{device-guid}/Actions/Chassis.Reset - Chassis Actions

  • Description: Performs chassis-level reset operations
  • Request Body:
{
  "ResetType": "PowerCycle"
}
  • WS-Man Operations:
    • CIM_PowerManagementService.RequestPowerStateChange() - Standard power operations
    • IPS_PowerManagementService.RequestOSPowerSavingStateChange() - OS power states
Property Name Category CIM Object
ResetType Action CIM_PowerManagementService.PowerState
PowerCycle Action CIM_PowerManagementService.RequestPowerStateChange(PowerState=5)
ForceRestart Action CIM_PowerManagementService.RequestPowerStateChange(PowerState=11)
MessageId Response Action Result Status
Message Response Action Result Description
MessageArgs Response Action Parameters
Severity Response Result Severity Level

Console Wiki

ADRs

Clone this wiki locally