Skip to content

redfish systems

Jump to bottom
Pola, Sudhir edited this page Dec 1, 2025 · 4 revisions

Redfish Systems Resource

Table of Contents

Overview

The Systems resource represents computer or system instances in the Redfish data model, providing comprehensive information about the software-visible resources and computing capabilities of managed devices. This resource is device-specific and handles the aggregation of processor, memory, storage, and network data from Intel Active Management Technology (AMT) enabled devices.

Endpoint Overview:

  • Systems Collection - Retrieves all managed computer systems in the service
  • Individual System - Provides detailed system information including hardware specs, power state, and boot configuration
  • System Reset Action - Performs power operations like reset, power on/off, and graceful shutdown/restart
  • Firmware Inventory Collection - Lists all firmware components installed on the system
  • Individual Firmware Item - Shows detailed information about specific firmware components including version and status
  • Processors Collection - Enumerates all CPU processors with specifications and capabilities
  • Memory Collection - Lists physical memory modules with capacity and configuration details
  • Memory Domains Collection - Provides memory topology and domain configuration information
  • Storage Collection - Enumerates storage subsystems including drives and controllers
  • Simple Storage Collection - Lists basic storage controllers with simple interface management
  • Ethernet Interfaces Collection - Shows network interfaces with IP configuration and VLAN settings
  • Network Interfaces Collection - Provides advanced network adapter management including WiFi endpoints
  • BIOS Configuration - Accesses and manages BIOS settings and configuration parameters
  • Secure Boot Configuration - Manages secure boot settings, certificates, and trusted platform module integration
  • Boot Options Collection - Lists available boot devices and boot sequence configuration
  • Log Services Collection - Provides access to system logs including audit and message logs
  • PCIe Devices Collection - Enumerates PCIe devices with slot mapping and device information
  • PCIe Functions Collection - Lists PCIe device functions with configuration space access
  • Graphics Controllers Collection - Shows graphics and video controllers with display configuration
  • Fabric Adapters Collection - Lists high-speed fabric adapters like InfiniBand and Fibre Channel
  • Certificates Collection - Manages system certificates for device identity and attestation
  • Operating System Information - Provides host operating system details including version and kernel information

References

Implementation Guidelines

The implemented endpoints follow a consistent architecture pattern:

  1. Repository Layer: Database operations for device lookup via uc.repo.GetByID()
  2. WS-Man Client Setup: Device communication setup via uc.device.SetupWsmanClient()
  3. WS-Man Operations: CIM/AMT-specific operations through the device client
  4. Data Transformation: Entity to DTO conversion for API responses
  5. Error Handling: Consistent error propagation and logging

Integration Patterns:

  • System Collection: Database-only operation for device enumeration
  • System Instance: WS-Man client + multiple CIM operations for comprehensive system data
  • Power Actions: WS-Man client + power management service calls with validation
  • Firmware Inventory: WS-Man client + AMT software identity operations

URIs - Supported

This section lists the Redfish Systems URIs that are currently supported and implemented by the DMT console application.

Status Indicators

The property mapping tables use the following status indicators:

  • ✅ Can be supported: Property can be fully implemented and supported through the DMT console application
  • ⚠️ AMT Limitation: Property has limitations due to Intel AMT capabilities or WS-Man CIM implementation constraints
  • ❌ Not applicable: Property is not applicable for the kind of devices that are managed by DMT console

GET /redfish/v1/Systems - Systems Collection Endpoint

  • Description: Retrieves the collection of computer systems managed by this service
  • Parameters: None
  • Use Case: devices.Get() - Device collection retrieval

Property Mapping

Property Name Status CIM Object Use Case Name
@odata.id ✅ Can be supported Static: "/redfish/v1/Systems" N/A (Static)
@odata.type ✅ Can be supported Static: "#ComputerSystemCollection.ComputerSystemCollection" N/A (Static)
Description ✅ Can be supported Static: "Collection of Computer Systems" N/A (Static)
Members ✅ Can be supported Array of device references devices.Get()
Members.@odata.id ✅ Can be supported "/redfish/v1/Systems/{device-guid}" devices.Get()
Members@odata.count ✅ Can be supported Device count from database devices.Get()
Name ✅ Can be supported Static: "Computer System Collection" N/A (Static)

GET /redfish/v1/Systems/{device-guid} - Individual System Endpoint

  • Description: Retrieves detailed information about a specific computer system
  • Parameters:
    • device-guid (path): The unique identifier of the device/system
  • Use Case: devices.GetByID() and devices.GetPowerState() - Individual device information with power state

Property Mapping

Property Name Status CIM Object Use Case Name
@odata.id ✅ Can be supported Static: "/redfish/v1/Systems/{device-guid}" N/A (Static)
@odata.type ✅ Can be supported Static: "#ComputerSystem.v1_5_0.ComputerSystem" N/A (Static)
Actions ✅ Can be supported Static action references N/A (Static)
AssetTag ✅ Can be supported CIM_ComputerSystem.AssetTag devices.GetByID()
Bios ✅ Can be supported Link reference to BIOS configuration N/A (Static)
BiosVersion ✅ Can be supported CIM_BIOSElement.Version devices.GetByID()
Boot.AliasBootOrder To be Analysed
Boot.AutomaticRetryAttempts To be Analysed
Boot.AutomaticRetryConfig To be Analysed
Boot.BootNext ✅ Can be supported CIM_BootConfigSetting.BootNext devices.GetBootOrder()
Boot.AutomaticRetryAttempts ✅ Can be supported Collection reference to CIM_BootSourceSetting devices.GetBootOptions()
Boot.BootOptions To be Analysed
Boot.BootOrder ✅ Can be supported CIM_BootConfigSetting.BootOrder devices.GetBootOrder()
Boot.BootOrderPropertySelection To be Analysed
Boot.BootSourceOverrideEnabled ✅ Can be supported AMT_BootSettingData.BootSourceOverrideEnabled devices.GetByID()
Boot.BootSourceOverrideMode ✅ Can be supported AMT_BootSettingData.BootSourceOverrideMode devices.GetByID()
Boot.BootSourceOverrideTarget ✅ Can be supported AMT_BootSettingData.BootSourceOverrideTarget devices.GetByID()
Boot.Certificates To be Analysed
Boot.HttpBootUri To be Analysed
Boot.RemainingAutomaticRetryAttempts To be Analysed
Boot.StopBootOnFault To be Analysed
Boot.TrustedModuleRequiredToBoot To be Analysed
Boot.UefiTargetBootSourceOverride ✅ Can be supported AMT_BootSettingData.UefiTargetBootSourceOverride devices.GetByID()
BootProgress.LastBootTimeSeconds ⚠️ AMT Limitation N/A (Boot progress not available in AMT) N/A
BootProgress.LastState ⚠️ AMT Limitation N/A (Boot progress not available in AMT) N/A
BootProgress.LastStateTime ⚠️ AMT Limitation N/A (Boot progress not available in AMT) N/A
Certificates ✅ Can be supported Collection reference to AMT_PublicKeyCertificate devices.GetCertificates()
Composition To be Analysed
Description ✅ Can be supported CIM_ComputerSystem.Description devices.GetByID()
EthernetInterfaces ✅ Can be supported Collection reference to ethernet interfaces devices.GetEthernetInterfaces()
FabricAdapters ❌ Not applicable N/A (High-speed fabric adapters not supported) N/A
GraphicalConsole.ConnectTypesSupported ✅ Can be supported CIM_KVMRedirectionSAP.ConnectTypesSupported devices.GetKVMCapabilities()
GraphicalConsole.MaxConcurrentSessions ✅ Can be supported CIM_KVMRedirectionSAP.MaxConcurrentSessions devices.GetKVMCapabilities()
GraphicalConsole.Port ✅ Can be supported CIM_KVMRedirectionSAP.Port devices.GetKVMCapabilities()
GraphicalConsole.ServiceEnabled ✅ Can be supported CIM_KVMRedirectionSAP.EnabledState devices.GetKVMCapabilities()
GraphicsControllers To be analysed
HostName ✅ Can be supported CIM_ComputerSystem.DNSHostName devices.GetByID()
HostWatchdogTimer.FunctionEnabled ⚠️ AMT Limitation N/A (Watchdog timer details may be limited) N/A
HostWatchdogTimer.Status ⚠️ AMT Limitation N/A (Watchdog timer details may be limited) N/A
HostWatchdogTimer.TimeoutAction ⚠️ AMT Limitation N/A (Watchdog timer details may be limited) N/A
HostWatchdogTimer.WarningAction ⚠️ AMT Limitation N/A (Watchdog timer details may be limited) N/A
HostedServices.StorageServices ✅ Can be supported Collection reference to CIM_ServiceAvailableToElement devices.GetStorageServices()
HostingRoles ❌ Not applicable N/A (Hosting roles not relevant for AMT endpoints) N/A
IPMIHostInterface To be analysed
Id ✅ Can be supported Device GUID from database devices.GetByID()
IdlePowerSaver.Enabled ⚠️ AMT Limitation N/A (Power saving configuration may be limited) N/A
IdlePowerSaver.EnterDwellTimeSeconds ⚠️ AMT Limitation N/A (Power saving configuration may be limited) N/A
IdlePowerSaver.EnterUtilizationPercent ⚠️ AMT Limitation N/A (Power saving configuration may be limited) N/A
IdlePowerSaver.ExitDwellTimeSeconds ⚠️ AMT Limitation N/A (Power saving configuration may be limited) N/A
IdlePowerSaver.ExitUtilizationPercent ⚠️ AMT Limitation N/A (Power saving configuration may be limited) N/A
IndicatorLED ⚠️ AMT Limitation N/A (LED control may be limited) N/A
KeyManagement.KMIPCertificates ✅ Can be supported AMT_PublicKeyCertificate collection reference devices.GetCertificates()
KeyManagement.KMIPServers ✅ Can be supported AMT_PublicKeyManagementService reference devices.GetKeyManagement()
LastResetCause ⚠️ AMT Limitation N/A (Reset cause information may be limited) N/A
LastResetTime ⚠️ AMT Limitation N/A (Reset timestamp may be limited) N/A
Links.Chassis ❌ Not applicable CIM_SystemPackaging.Antecedent devices.GetByID()
Links.ManagedBy ✅ Can be supported CIM_ComputerSystemPackage.SystemElement devices.GetByID()
LocationIndicatorActive ⚠️ AMT Limitation N/A (Location indicator control may be limited) N/A
LogServices ✅ Can be supported Collection reference to AMT_AuditLog and AMT_MessageLog devices.GetLogServices()
Manufacturer ✅ Can be supported CIM_ComputerSystem.Manufacturer devices.GetByID()
ManufacturingMode ❌ Not applicable N/A (Manufacturing mode not relevant for AMT) N/A
Measurements ❌ Not applicable N/A (TPM measurements not supported in basic AMT) N/A
Memory ✅ Can be supported Collection reference to CIM_PhysicalMemory devices.GetMemory()
MemoryDomains ❌ Not applicable N/A (Memory domain topology not available) N/A
MemorySummary.MemoryMirroring ⚠️ AMT Limitation N/A (Memory mirroring configuration not available) N/A
MemorySummary.MemoryMirroring ⚠️ AMT Limitation N/A (Memory mirroring configuration not available) N/A
MemorySummary.Metrics To be Analysed
MemorySummary.Status ✅ Can be supported CIM_PhysicalMemory.HealthState devices.GetByID()
MemorySummary.TotalSystemMemoryGiB ✅ Can be supported CIM_PhysicalMemory.TotalWidth devices.GetByID()
MemorySummary.TotalSystemPersistentMemoryGiB To be Analysed
Model ✅ Can be supported CIM_ComputerSystem.Model devices.GetByID()
MultipartImportConfigurationPushURI To be Analysed
Name ✅ Can be supported CIM_ComputerSystem.Name devices.GetByID()
NetworkInterfaces ✅ Can be supported Collection reference to network interfaces devices.GetNetworkInterfaces()
Oem ✅ Can be supported Static Intel OEM extensions reference N/A (Static)
OperatingSystem.Type ⚠️ AMT Limitation N/A (OS information may be limited) N/A
OperatingSystem.Version ⚠️ AMT Limitation N/A (OS information may be limited) N/A
PCIeDevices To be Analysed
PCIeDevices@odata.count To be Analysed
PCIeFunctions To be Analysed
PCIeFunctions@odata.count To be Analysed
PartNumber ✅ Can be supported CIM_ComputerSystem.PartNumber devices.GetByID()
PowerCycleDelaySeconds ⚠️ AMT Limitation N/A (Power cycle delay configuration may be limited) N/A
PowerMode ⚠️ AMT Limitation N/A (Power mode settings may be limited) N/A
PowerOffDelaySeconds ⚠️ AMT Limitation N/A (Power off delay configuration may be limited) N/A
PowerOnDelaySeconds ⚠️ AMT Limitation N/A (Power on delay configuration may be limited) N/A
PowerRestorePolicy ⚠️ AMT Limitation N/A (Power restore policy may be limited) N/A
PowerState ✅ Can be supported CIM_AssociatedPowerManagementService.PowerState devices.GetPowerState()
ProcessorSummary.CoreCount ✅ Can be supported CIM_Processor.NumberOfEnabledCores devices.GetByID()
ProcessorSummary.Count ✅ Can be supported CIM_Processor.Enumerate().Count devices.GetByID()
ProcessorSummary.LogicalProcessorCount ✅ Can be supported CIM_Processor.NumberOfEnabledCores devices.GetByID()
ProcessorSummary.Model ✅ Can be supported CIM_Processor.Family devices.GetByID()
ProcessorSummary.Status ✅ Can be supported CIM_Processor.HealthState devices.GetByID()
Processors ✅ Can be supported Collection reference to CIM_Processor devices.GetProcessors()
Redundancy ❌ Not applicable N/A (Redundancy configurations not supported) N/A
Redundancy@odata.count To be Analysed
SKU ✅ Can be supported CIM_ComputerSystem.ElementName devices.GetByID()
SecureBoot.SecureBootCurrentBoot ⚠️ AMT Limitation N/A (Secure boot information may be limited) N/A
SecureBoot.SecureBootEnable ⚠️ AMT Limitation N/A (Secure boot information may be limited) N/A
SerialConsole.ConnectTypesSupported ✅ Supported AMT_RedirectionService.EnabledState SOL connection type determined from redirection service state
SerialConsole.MaxConcurrentSessions ✅ Supported Static value: 1 AMT SOL architecture supports single session only
SerialConsole.ServiceEnabled ✅ Supported AMT_RedirectionService.EnabledState SOL service enabled state (values 32770/32771 indicate SOL enabled)
SerialNumber ✅ Can be supported CIM_ComputerSystem.SerialNumber devices.GetByID()
SimpleStorage ✅ Can be supported Collection reference to CIM_MediaAccessDevice devices.GetSimpleStorage()
Status.Health ✅ Can be supported CIM_ComputerSystem.HealthState devices.GetByID()
Status.State ✅ Can be supported CIM_ComputerSystem.EnabledState devices.GetByID()
Storage ✅ Can be supported Collection reference to storage subsystems devices.GetStorage()
SubModel ✅ Can be supported CIM_ComputerSystem.OtherIdentifyingInfo devices.GetByID()
SystemType ✅ Can be supported Static: "Physical" N/A (Static)
TrustedModules ⚠️ AMT Limitation N/A (TPM module information may be limited) N/A
USBControllers ❌ Not applicable N/A (USB controller details not available) N/A
UUID ✅ Can be supported CIM_ComputerSystem.UUID devices.GetByID()
VirtualMedia ✅ Can be supported AMT virtual media service reference devices.GetVirtualMedia()
VirtualMediaConfig.ServiceEnabled ✅ Can be supported AMT virtual media configuration reference devices.GetVirtualMediaConfig()

POST /redfish/v1/Systems/{device-guid}/Actions/ComputerSystem.Reset - System Reset Action

  • Description: Performs reset operations on the computer system
  • Parameters:
    • device-guid (path): The unique identifier of the device/system
    • ResetType (body): Type of reset operation (On, ForceOff, ForceRestart, PowerCycle)
  • Use Case: devices.SendPowerAction() - Power management operations

Property Mapping

Property Name Status CIM Object Use Case Name
@Redfish.AllowableValues ✅ Can be supported Static list of supported reset types N/A (Static)
ResetType ✅ Can be supported CIM_PowerManagementService.RequestedPowerState devices.SendPowerAction()
ResetType: "ForceOff" ✅ Can be supported CIM_PowerManagementService.PowerOff devices.SendPowerAction()
ResetType: "ForceRestart" ✅ Can be supported CIM_PowerManagementService.PowerCycle devices.SendPowerAction()
ResetType: "GracefulRestart" ✅ Can be supported IPS_PowerManagementService.RequestOSPowerSavingStateChange devices.SendPowerAction()
ResetType: "GracefulShutdown" ✅ Can be supported IPS_PowerManagementService.RequestOSPowerSavingStateChange devices.SendPowerAction()
ResetType: "On" ✅ Can be supported CIM_PowerManagementService.PowerOn devices.SendPowerAction()
ResetType: "PowerCycle" ✅ Can be supported CIM_PowerManagementService.PowerCycle devices.SendPowerAction()

GET /redfish/v1/Systems/{device-guid}/FirmwareInventory - Firmware Inventory Collection

  • Description: Retrieves the collection of firmware components for the system
  • Parameters:
    • device-guid (path): The unique identifier of the device/system
  • Use Case: devices.GetVersion() and devices.GetHardwareInfo() - Firmware and version information

Property Mapping

Property Name Status CIM Object Use Case Name
@odata.id ✅ Can be supported Static: "/redfish/v1/Systems/{device-guid}/FirmwareInventory" N/A (Static)
@odata.type ✅ Can be supported Static: "#SoftwareInventoryCollection.SoftwareInventoryCollection" N/A (Static)
Description ✅ Can be supported Static: "Collection of Firmware for this System" N/A (Static)
Members ✅ Can be supported Array of firmware component references devices.GetVersion()
Members.@odata.id ✅ Can be supported "/redfish/v1/Systems/{device-guid}/FirmwareInventory/{id}" devices.GetVersion()
Members@odata.count ✅ Can be supported CIM_SoftwareIdentity.Enumerate().Count devices.GetVersion()
Name ✅ Can be supported Static: "Firmware Inventory Collection" N/A (Static)

GET /redfish/v1/Systems/{device-guid}/FirmwareInventory/{firmwareId} - Individual Firmware Item

  • Description: Retrieves detailed information about a specific firmware component
  • Parameters:
    • device-guid (path): The unique identifier of the device/system
    • firmwareId (path): The unique identifier of the firmware component
  • Use Case: devices.GetVersion() and devices.GetHardwareInfo() - Specific firmware component details

Property Mapping

Property Name Status CIM Object Use Case Name
@odata.id ✅ Can be supported Static: "/redfish/v1/Systems/{device-guid}/FirmwareInventory/{id}" N/A (Static)
@odata.type ✅ Can be supported Static: "#SoftwareInventory.v1_1_0.SoftwareInventory" N/A (Static)
Description ✅ Can be supported CIM_SoftwareIdentity.Description devices.GetVersion()
Id ✅ Can be supported CIM_SoftwareIdentity.InstanceID devices.GetVersion()
LowestSupportedVersion ❌ Not applicable CIM_SoftwareIdentity.MinimumVersion devices.GetVersion()
Manufacturer ⚠️ AMT Limitation CIM_SoftwareIdentity.Manufacturer devices.GetHardwareInfo()
Name ✅ Can be supported CIM_SoftwareIdentity.ElementName devices.GetVersion()
ReleaseDate ⚠️ AMT Limitation CIM_SoftwareIdentity.ReleaseDate devices.GetVersion()
SoftwareId ✅ Can be supported CIM_SoftwareIdentity.SoftwareElementID devices.GetVersion()
Status.Health ✅ Can be supported CIM_SoftwareIdentity.OperationalStatus devices.GetVersion()
Status.State ✅ Can be supported CIM_SoftwareIdentity.HealthState devices.GetVersion()
UefiDevicePaths ❌ Not applicable CIM_SoftwareIdentity.DevicePath devices.GetHardwareInfo()
Updateable ✅ Can be supported CIM_SoftwareIdentity.IsEntity devices.GetVersion()
Version ✅ Can be supported CIM_SoftwareIdentity.VersionString devices.GetVersion()

GET /redfish/v1/Systems/{device-guid}/Bios - BIOS Configuration Endpoint

  • Description: Retrieves BIOS configuration and settings for the system
  • Parameters:
    • device-guid (path): The unique identifier of the device/system
  • Use Case: devices.GetBiosSettings() - BIOS configuration and settings retrieval

Property Mapping

Property Name Status CIM Object Use Case Name
@odata.id ✅ Can be supported Static: "/redfish/v1/Systems/{device-guid}/Bios" N/A (Static)
@odata.type ✅ Can be supported Static: "#Bios.v1_1_0.Bios" N/A (Static)
AttributeRegistry ✅ Can be supported Static: "BiosAttributeRegistry.v1_0_0" N/A (Static)
Attributes ✅ Can be supported CIM_BIOSElement.Characteristics devices.GetBiosSettings()
Description ✅ Can be supported Static: "BIOS Configuration Current Settings" N/A (Static)
Id ✅ Can be supported Static: "BIOS" N/A (Static)
Name ✅ Can be supported Static: "BIOS Configuration Current Settings" N/A (Static)

PATCH /redfish/v1/Systems/{device-guid}/Bios - BIOS Configuration Update

  • Description: Updates BIOS configuration and settings for the system
  • Parameters:
    • device-guid (path): The unique identifier of the device/system
    • Request body: JSON object containing BIOS attributes to update
  • Use Case: devices.UpdateBiosSettings() - BIOS configuration modification

Property Mapping

Property Name Status CIM Object Use Case Name
@Redfish.Settings ✅ Can be supported Static settings URI reference N/A (Static)
Attributes ✅ Can be supported CIM_BIOSElement.Characteristics devices.UpdateBiosSettings()

POST /redfish/v1/Systems/{SystemId}/Bios/Actions/Bios.ResetBios - BIOS Reset Action

  • Description: Resets BIOS configuration to factory defaults
  • Parameters:
    • SystemId (path): The unique identifier of the system
  • Use Case: devices.ResetBiosToDefaults() - BIOS factory reset operation

Property Mapping

Property Name Status CIM Object Use Case Name
Action ✅ Can be supported Static: "#Bios.ResetBios" N/A (Static)
target ✅ Can be supported Static: "/redfish/v1/Systems/{SystemId}/Bios/Actions/Bios.ResetBios" N/A (Static)

GET /redfish/v1/Systems/{device-guid}/Oem/Intel/PowerState - Intel OEM Power State

  • Description: Retrieves Intel-specific power state information for the system
  • Parameters:
    • device-guid (path): The unique identifier of the device/system
  • Use Case: devices.GetPowerState() - Intel OEM power state retrieval

Property Mapping

Property Name Status CIM Object Use Case Name
@odata.id ✅ Can be supported Static: "/redfish/v1/Systems/{device-guid}/Oem/Intel/PowerState" N/A (Static)
@odata.type ✅ Can be supported Static: "#Intel.v1_0_0.PowerState" N/A (Static)
Description ✅ Can be supported Static: "Intel-specific Power State Information" N/A (Static)
Id ✅ Can be supported Static: "PowerState" N/A (Static)
Name ✅ Can be supported Static: "Intel Power State" N/A (Static)
PowerChangeSequence ⚠️ AMT Limitation CIM_AssociatedPowerManagementService.PowerChangeCapabilities devices.GetPowerState()
PowerState ✅ Can be supported CIM_AssociatedPowerManagementService.PowerState devices.GetPowerState()
RequestedPowerState ✅ Can be supported CIM_PowerManagementService.RequestedPowerState devices.GetPowerState()

Intel OEM Extension: Intel-specific power state information

GET /redfish/v1/Systems/{device-guid}/Oem/Intel/PowerCapabilities - Intel OEM Power Capabilities

  • Description: Retrieves Intel-specific power management capabilities for the system
  • Parameters:
    • device-guid (path): The unique identifier of the device/system
  • Use Case: devices.GetPowerCapabilities() - Intel OEM power capabilities retrieval

Property Mapping

Property Name Status CIM Object Use Case Name
@odata.id ✅ Can be supported Static: "/redfish/v1/Systems/{device-guid}/Oem/Intel/PowerCapabilities" N/A (Static)
@odata.type ✅ Can be supported Static: "#Intel.v1_0_0.PowerCapabilities" N/A (Static)
Description ✅ Can be supported Static: "Intel-specific Power Management Capabilities" N/A (Static)
Id ✅ Can be supported Static: "PowerCapabilities" N/A (Static)
MaxPowerConsumptionWatts ⚠️ AMT Limitation CIM_PowerManagementService.PowerCapabilities devices.GetPowerCapabilities()
MinPowerConsumptionWatts ⚠️ AMT Limitation CIM_PowerManagementService.PowerCapabilities devices.GetPowerCapabilities()
Name ✅ Can be supported Static: "Intel Power Capabilities" N/A (Static)
PowerCapLimitWatts ⚠️ AMT Limitation CIM_PowerManagementService.PowerCapabilities devices.GetPowerCapabilities()
PowerLimitingEnabled ⚠️ AMT Limitation CIM_PowerManagementService.PowerManagementCapabilities devices.GetPowerCapabilities()

Intel OEM Extension: Intel-specific power management capabilities

URIs - Not Supported

This section lists the Redfish Systems URIs that are not currently supported but may be considered for future implementation.

URIs - To be Analysed

GET /redfish/v1/Systems/{device-guid}/Processors - Processors Collection Endpoint

  • Description: Retrieves the collection of processors in the system
  • WS-Man Operations:
    • CIM_Processor.Enumerate() - Processor enumeration
    • CIM_ProcessorCapabilities.Pull() - Processor capabilities
    • CIM_PhysicalProcessor.Pull() - Physical processor information
Property Name Category CIM Object
Description Collection Static: "Collection of Processors for this System"
Members.@odata.id Collection CIM_Processor.DeviceID
Members@odata.count Collection CIM_Processor.Enumerate().Count
Name Collection Static: "Processors Collection"

Redfish Specification: ProcessorCollection Schema

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

  • Description: Retrieves the collection of memory modules in the system
  • WS-Man Operations:
    • CIM_PhysicalMemory.Enumerate() - Memory module enumeration
    • CIM_MemoryCapacity.Pull() - Memory capacity information
    • CIM_SystemMemory.Pull() - System memory configuration
Property Name Category CIM Object
Description Collection Static: "Collection of Memory for this System"
Members.@odata.id Collection CIM_PhysicalMemory.Tag
Members@odata.count Collection CIM_PhysicalMemory.Enumerate().Count
Name Collection Static: "Memory Collection"

Redfish Specification: MemoryCollection Schema

GET /redfish/v1/Systems/{device-guid}/MemoryDomains - Memory Domains Collection Endpoint

  • Description: Retrieves the collection of memory domains for the system
  • WS-Man Operations:
    • CIM_MemoryPool.Enumerate() - Memory pool enumeration
    • CIM_SystemMemoryResources.Pull() - System memory resources
    • CIM_MemoryMappedIO.Pull() - Memory-mapped I/O configuration
Property Name Category CIM Object
Description Collection Static: "Collection of Memory Domains for this System"
Members.@odata.id Collection CIM_MemoryPool.PoolID
Members@odata.count Collection CIM_MemoryPool.Enumerate().Count
Name Collection Static: "Memory Domains Collection"

Redfish Specification: MemoryDomainCollection Schema

GET /redfish/v1/Systems/{device-guid}/Storage - Storage Collection Endpoint

  • Description: Retrieves the collection of storage subsystems in the system
  • WS-Man Operations:
    • CIM_StorageExtent.Enumerate() - Storage extent enumeration
    • CIM_DiskDrive.Enumerate() - Disk drive enumeration
    • CIM_StorageController.Pull() - Storage controller information
Property Name Category CIM Object
Description Collection Static: "Collection of Storage for this System"
Members.@odata.id Collection CIM_StorageExtent.ElementName
Members@odata.count Collection CIM_StorageExtent.Enumerate().Count
Name Collection Static: "Storage Collection"

Redfish Specification: StorageCollection Schema

GET /redfish/v1/Systems/{device-guid}/SimpleStorage - Simple Storage Collection Endpoint

  • Description: Retrieves the collection of simple storage controllers in the system
  • WS-Man Operations:
    • CIM_StorageController.Enumerate() - Storage controller enumeration
    • CIM_ControllerConfigurationService.Pull() - Controller configuration
    • CIM_MassStorageService.Pull() - Mass storage service information
Property Name Category CIM Object
Description Collection Static: "Collection of Simple Storage for this System"
Members.@odata.id Collection CIM_StorageController.ElementName
Members@odata.count Collection CIM_StorageController.Enumerate().Count
Name Collection Static: "Simple Storage Collection"

Redfish Specification: SimpleStorageCollection Schema

GET /redfish/v1/Systems/{device-guid}/EthernetInterfaces - Ethernet Interfaces Collection Endpoint

  • Description: Retrieves the collection of Ethernet interfaces for the system
  • WS-Man Operations:
    • CIM_EthernetPort.Enumerate() - Ethernet port enumeration
    • CIM_NetworkAdapter.Pull() - Network adapter information
    • AMT_EthernetPortSettings.Pull() - AMT-specific Ethernet settings
Property Name Category CIM Object
Description Collection Static: "Collection of Ethernet Interfaces for this System"
Members.@odata.id Collection CIM_EthernetPort.DeviceID
Members@odata.count Collection CIM_EthernetPort.Enumerate().Count
Name Collection Static: "Ethernet Interfaces Collection"

Redfish Specification: EthernetInterfaceCollection Schema

GET /redfish/v1/Systems/{device-guid}/NetworkInterfaces - Network Interfaces Collection Endpoint

  • Description: Retrieves the collection of network interfaces for the system
  • WS-Man Operations:
    • CIM_NetworkAdapter.Enumerate() - Network adapter enumeration
    • CIM_WiFiEndpoint.Pull() - WiFi endpoint information
    • CIM_NetworkPortConfigurationService.Pull() - Network port configuration
Property Name Category CIM Object
Description Collection Static: "Collection of Network Interfaces for this System"
Members.@odata.id Collection CIM_NetworkAdapter.DeviceID
Members@odata.count Collection CIM_NetworkAdapter.Enumerate().Count
Name Collection Static: "Network Interfaces Collection"

Redfish Specification: NetworkInterfaceCollection Schema

GET /redfish/v1/Systems/{device-guid}/SecureBoot - Secure Boot Configuration Endpoint

  • Description: Retrieves secure boot configuration and status for the system
  • WS-Man Operations:
    • CIM_CertificateAuthority.Pull() - Certificate authority information
    • AMT_PublicKeyManagementService.Get() - Public key management
    • CIM_UEFISecureBoot.Get() - UEFI secure boot status
Property Name Category CIM Object
SecureBootCurrentBoot SecureBoot CIM_UEFISecureBoot.SecureBootCurrentBoot
SecureBootDatabases SecureBoot CIM_CertificateAuthority.TrustedCertificates
SecureBootEnable SecureBoot CIM_UEFISecureBoot.SecureBootEnable
SecureBootMode SecureBoot CIM_UEFISecureBoot.SecureBootMode

Redfish Specification: SecureBoot Schema

GET /redfish/v1/Systems/{device-guid}/BootOptions - Boot Options Collection Endpoint

  • Description: Retrieves the collection of boot options for the system
  • WS-Man Operations:
    • AMT_BootSettingData.Enumerate() - Boot setting enumeration
    • CIM_BootConfigSetting.Pull() - Boot configuration settings
    • CIM_BootService.Pull() - Boot service information
Property Name Category CIM Object
Description Collection Static: "Collection of Boot Options for this System"
Members.@odata.id Collection AMT_BootSettingData.InstanceID
Members@odata.count Collection AMT_BootSettingData.Enumerate().Count
Name Collection Static: "Boot Options Collection"

Redfish Specification: BootOptionCollection Schema

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

  • Description: Retrieves the collection of log services for the system
  • WS-Man Operations:
    • AMT_MessageLog.Enumerate() - Message log enumeration
    • CIM_LogEntry.Pull() - Log entry information
    • AMT_AuditLog.Pull() - Audit log information
Property Name Category CIM Object
Description Collection Static: "Collection of Log Services for this System"
Members.@odata.id Collection AMT_MessageLog.InstanceID
Members@odata.count Collection AMT_MessageLog.Enumerate().Count
Name Collection Static: "Log Services Collection"

Redfish Specification: LogServiceCollection Schema

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

  • Description: Retrieves the collection of PCIe devices for the system
  • WS-Man Operations:
    • CIM_PCIDevice.Enumerate() - PCIe device enumeration
    • CIM_SystemDevice.Pull() - System device associations
    • CIM_PCIController.Pull() - PCI controller information
Property Name Category CIM Object
Description Collection Static: "Collection of PCIe Devices for this System"
Members.@odata.id Collection CIM_PCIDevice.DeviceID
Members@odata.count Collection CIM_PCIDevice.Enumerate().Count
Name Collection Static: "PCIe Devices Collection"

Redfish Specification: PCIeDeviceCollection Schema

GET /redfish/v1/Systems/{device-guid}/PCIeFunctions - PCIe Functions Collection Endpoint

  • Description: Retrieves the collection of PCIe functions for the system
  • WS-Man Operations:
    • CIM_PCIDevice.Pull() - PCIe device function information
    • CIM_DeviceSAPImplementation.Pull() - Device service access point implementation
    • CIM_PCIController.Pull() - PCI controller function mapping
Property Name Category CIM Object
Description Collection Static: "Collection of PCIe Functions for this System"
Members.@odata.id Collection CIM_PCIDevice.DeviceID + Function
Members@odata.count Collection CIM_PCIDevice.Pull().Functions.Count
Name Collection Static: "PCIe Functions Collection"

Redfish Specification: PCIeFunctionCollection Schema

GET /redfish/v1/Systems/{device-guid}/GraphicsControllers - Graphics Controllers Collection Endpoint

  • Description: Retrieves the collection of graphics controllers for the system
  • WS-Man Operations:
    • CIM_VideoController.Enumerate() - Video controller enumeration
    • CIM_DisplayController.Pull() - Display controller information
    • CIM_PCIDevice.Pull() - Graphics-specific PCI devices
Property Name Category CIM Object
Description Collection Static: "Collection of Graphics Controllers for this System"
Members.@odata.id Collection CIM_VideoController.DeviceID
Members@odata.count Collection CIM_VideoController.Enumerate().Count
Name Collection Static: "Graphics Controllers Collection"

Redfish Specification: GraphicsControllerCollection Schema

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

  • Description: Retrieves the collection of fabric adapters for the system
  • WS-Man Operations:
    • CIM_NetworkAdapter.Enumerate() - Network adapter enumeration with fabric filtering
    • CIM_FCPort.Pull() - Fibre Channel port information
    • CIM_InfiniBandPort.Pull() - InfiniBand port information
Property Name Category CIM Object
Description Collection Static: "Collection of Fabric Adapters for this System"
Members.@odata.id Collection CIM_NetworkAdapter.DeviceID (Fabric Type)
Members@odata.count Collection CIM_NetworkAdapter.Enumerate().FabricCount
Name Collection Static: "Fabric Adapters Collection"

Redfish Specification: FabricAdapterCollection Schema

Example Response Structure:

{
  "@odata.type": "#FabricAdapterCollection.FabricAdapterCollection",
  "@odata.id": "/redfish/v1/Systems/{device-guid}/FabricAdapters",
  "Name": "Fabric Adapters Collection",
  "Description": "Collection of Fabric Adapters for this System",
  "Members@odata.count": 1,
  "Members": [
    {
      "@odata.id": "/redfish/v1/Systems/{device-guid}/FabricAdapters/FabricAdapter0"
    }
  ]
}

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

  • Description: Retrieves the collection of certificates for device identity and attestation
  • WS-Man Operations:
    • AMT_PublicKeyCertificate.Enumerate() - Public key certificate enumeration
    • CIM_CertificateAuthority.Pull() - Certificate authority information
    • AMT_TLSCredentialContext.Pull() - TLS credential context
Property Name Category CIM Object
Description Collection Static: "Collection of Certificates for this System"
Members.@odata.id Collection AMT_PublicKeyCertificate.InstanceID
Members@odata.count Collection AMT_PublicKeyCertificate.Enumerate().Count
Name Collection Static: "Certificates Collection"

Redfish Specification: CertificateCollection Schema

Example Response Structure:

{
  "@odata.type": "#CertificateCollection.CertificateCollection",
  "@odata.id": "/redfish/v1/Systems/{device-guid}/Certificates",
  "Name": "Certificates Collection",
  "Description": "Collection of Certificates for this System",
  "Members@odata.count": 2,
  "Members": [
    {
      "@odata.id": "/redfish/v1/Systems/{device-guid}/Certificates/AMTCert"
    },
    {
      "@odata.id": "/redfish/v1/Systems/{device-guid}/Certificates/TPMCert"
    }
  ]
}

GET /redfish/v1/Systems/{device-guid}/OperatingSystem - Operating System Information Endpoint

  • Description: Retrieves operating system information for the system
  • WS-Man Operations:
    • CIM_OperatingSystem.Get() - Operating system information
    • CIM_ComputerSystem.Pull() - Host system information
    • AMT_EnvironmentDetectionSettingData.Get() - Host detection settings
Property Name Category CIM Object
Description OS CIM_OperatingSystem.Description
Id OS Static: "OperatingSystem"
Kernel.Name Kernel CIM_OperatingSystem.KernelInfo
Kernel.Version Kernel CIM_OperatingSystem.Version
Name OS CIM_OperatingSystem.Name
Type OS CIM_OperatingSystem.OSType
Version OS CIM_OperatingSystem.Version
VirtualMemoryInUse OS CIM_OperatingSystem.VirtualMemoryInUse

Redfish Specification: OperatingSystem Schema

Error Responses

Standard HTTP error responses are returned when operations fail:

  • 400 Bad Request - Invalid request parameters or malformed JSON
  • 401 Unauthorized - Authentication required or invalid credentials
  • 403 Forbidden - Insufficient privileges for the requested operation
  • 404 Not Found - Requested resource does not exist
  • 405 Method Not Allowed - HTTP method not supported for this resource
  • 500 Internal Server Error - Server-side error during processing
  • 503 Service Unavailable - Service temporarily unavailable

Example error response:

{
  "error": {
    "code": "Base.1.8.GeneralError",
    "message": "A general error has occurred. See ExtendedInfo for more information.",
    "@Message.ExtendedInfo": [
      {
        "MessageId": "Base.1.8.PropertyMissing",
        "Message": "The property ResetType is a required property and must be included in the request.",
        "Severity": "Warning",
        "Resolution": "Ensure that the property is in the request body and has a valid value."
      }
    ]
  }
}

Property Support Summary

This section provides a consolidated view of ComputerSystem properties that have implementation limitations or are not applicable in the Intel AMT environment.

Properties with AMT Limitations

The following properties have limited support due to Intel AMT capabilities or WS-Man CIM implementation constraints:

Base Path: /redfish/v1/Systems/{device-guid}

Property Use-case Limitation
BootProgress.LastBootTimeSeconds, BootProgress.LastState, BootProgress.LastStateTime The last boot progress state(of OS) and time since the last state would not be available. For ex: "OS Running", "OSBootStarted", "SystemHardwareInitializationComplete"
HostWatchdogTimer.* AMT_WatchdogService availability varies by AMT version
IdlePowerSaver.* Platform-specific power management not standardized
IndicatorLED Hardware-specific CIM classes not consistently available
LastResetCause AMT event logging may not capture all scenarios
LastResetTime Timestamp logging depends on AMT firmware capabilities
LocationIndicatorActive Platform-specific hardware support required
MemorySummary.MemoryMirroring Not exposed through standard AMT CIM classes
OperatingSystem.Type Limited to basic presence detection out-of-band
OperatingSystem.Version Requires in-band host agent communication
PowerCycleDelaySeconds Not exposed through standard power management CIM
PowerMode Not standardized across platform implementations
PowerOffDelaySeconds Platform-specific feature in CIM_PowerManagementService
PowerOnDelaySeconds Requires vendor-specific extensions
PowerRestorePolicy Managed by BIOS settings not accessible via AMT
SecureBoot.* UEFI CIM profile implementation varies by platform
TrustedModules CIM_TPM classes not consistently available

Properties Not Applicable for AMT

The following properties are not applicable for the kind of devices managed by the DMT console in Intel AMT environments:

Base Path: /redfish/v1/Systems/{device-guid}

Property CIM Object Non-Applicability Reason
/FabricAdapters N/A Enterprise features not present in AMT desktop/workstation
/GraphicsControllers N/A Requires PCI device discovery not in AMT CIM schema
HostingRoles N/A Software abstractions not relevant for hardware AMT
ManufacturingMode N/A Factory state not applicable to deployed AMT systems
Measurements N/A Requires advanced TPM 2.0 attestation not in basic AMT
/MemoryDomains N/A NUMA topology requires advanced CIM classes
/PCIeDevices N/A Requires PCI configuration space access not supported
/PCIeFunctions N/A Requires advanced PCI CIM classes not available
Redundancy N/A Enterprise server features not applicable to single systems
USBControllers N/A Requires detailed USB CIM classes not implemented
Links.Chassis CIM_SystemPackaging.Antecedent Chassis management not relevant for AMT system focus
/FirmwareInventory/{id}.LowestSupportedVersion CIM_SoftwareIdentity.MinimumVersion Downgrade protection not managed through AMT
/FirmwareInventory/{id}.UefiDevicePaths CIM_SoftwareIdentity.DevicePath Boot-time data not exposed via out-of-band AMT

Console Wiki

Clone this wiki locally