Skip to main content
Sign Out

Welcome to Dell

My Account
  • Place orders quickly and easily
  • View orders and track your shipping status
  • Enjoy members-only rewards and discounts
  • Create and access a list of your products
  • Manage your Dell EMC sites, products, and product-level contacts using Company Administration.
Sign In Create an Account Dell Financial Services Premier Sign In Partner Program Sign In
Contact Us

Your Dell.com Carts

iDRAC9 Redfish API Guide Firmware version: 4.20.20.20

PDF

ComputerSystem

Description

The ComputerSystem schema represents a computer or system instance and the software-visible Resources, or items within the data plane, such as memory, CPU, and other devices that it can access. Details of those Resources or subsystems are also linked through this Resource.

URL

/redfish/v1/Systems/<ComputerSystem-Id>

Supported HTTP Method and Privileges

HTTP Method Required Privilege
POST ConfigureComponents, Login
GET Login
PATCH ConfigureComponents, Login
Table 1. Supported Properties
Property Type Read Only Description
AssetTag String No The user definable tag that can be used to track this computer system for inventory or other client purposes.
Bios Object Yes A reference to the BIOS settings associated with this system
BiosVersion String Yes The version of the system BIOS or primary system firmware
Boot Object Yes Information about the boot settings for this system
Boot.BootSourceOverrideEnabled String No The state of the boot source override feature. This is a sub property under Boot.
Boot.BootSourceOverrideMode String No The BIOS boot mode to use when the system boots from the BootSourceOverrideTarget boot source. This is a sub property under Boot.
Boot.BootSourceOverrideTarget String No The current boot source to use at the next boot instead of the normal boot device, if BootSourceOverrideEnabled is `true`. This is a sub property under Boot.
NOTE If the BootSourceOverrideTarget is set to a value other than None, then the BootSourceOverrideEnabled is automatically set to Once.
EthernetInterfaces Object Yes A reference to the collection of Ethernet interfaces associated with this system
HostName String No The DNS Host Name, without any domain information
HostWatchdogTimer Object Yes This object describes the Host Watchdog Timer functionality for this system. It also contains some updatable properties including FunctionEnabled and TimeoutAction.
HostWatchdogTimer.FunctionEnabled boolean No FunctionEnabled is a sub property for HostWatchdogTimer. It indicates if the Host Watchdog Timer functionality has been enabled. Additional host-based software is necessary to activate the timer function.
HostWatchdogTimer.TimeoutAction String No TimeoutAction is a sub property for HostWatchdogTimer. It indicates the action to perform when the Watchdog Timer reaches its timeout value. Following values are supported:
  • None
  • ResetSystem
  • PowerCycle
  • PowerDown
HostingRoles Array Yes The hosing roles that this computer system supports
IndicatorLED String No The state of the indicator LED, used to identify the system. Following values are supported:
  • Off
  • Blinking
Manufacturer String Yes The manufacturer or OEM of this system
Memory Object Yes A reference to the collection of Memory associated with this system
MemorySummary Object Yes This object describes the central memory of the system in general detail
Model String Yes The product name for this system, without the manufacturer name
NetworkInterfaces Object Yes A reference to the collection of Network Interfaces associated with this system
PCIeDevices Array Yes A reference to a collection of PCIe Devices used by this computer system
PCIeFunctions Array Yes A reference to a collection of PCIe Functions used by this computer system
PartNumber String Yes The part number for this system
PowerState String Yes This is the current power state of the system
ProcessorSummary Object Yes This object describes the central processors of the system in general detail
Processors Object Yes A reference to the collection of Processors associated with this system
SKU String Yes The manufacturer SKU for this system
SecureBoot Object Yes A reference to the UEFI SecureBoot resource associated with this system
SerialNumber String Yes The serial number for this system
SimpleStorage Object Yes A reference to the collection of storage devices associated with this system
Status Object Yes This property describes the status and health of the resource and its children
Storage Object Yes A reference to the collection of storage devices associated with this system
SystemType String Yes The type of computer system represented by this resource
TrustedModules Array Yes This object describes the Array of Trusted Modules in the system
UUID String Yes The universal unique identifier (UUID) for this system

Supported Status Codes

HTTP Status Code Extended Information Error Message Code
200 Base.1.0.success
400 Base.1.0.PropertyValueTypeError, Base.1.0.PropertyValueNotInList, Base.1.0.PropertyUnknown, Base.1.0.PropertyNotWritable, Base.1.0.PropertyValueFormatError SYS426
500 Base.1.0.InternalError SYS446
Supported Action — Reset

Rate this content

Accurate
Useful
Easy to understand
Was this article helpful?
0/3000 characters
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please select whether the article was helpful or not.
  Comments cannot contain these special characters: <>()\