iDRAC9 with Lifecycle Controller Version 3.31.31.
Notes, cautions, and warnings NOTE: A NOTE indicates important information that helps you make better use of your product. CAUTION: A CAUTION indicates either potential damage to hardware or loss of data and tells you how to avoid the problem. WARNING: A WARNING indicates a potential for property damage, personal injury, or death. © 2018 - 2019 Dell Inc. or its subsidiaries. All rights reserved. Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries.
Contents 1 Overview..................................................................................................................................... 9 New in this release................................................................................................................................................................ 9 Benefits.......................................................................................................................................................................
DellCertificates.....................................................................................................................................................................36 URL..................................................................................................................................................................................37 DellController..................................................................................................................................
Supported Action — ExportLicense........................................................................................................................... 84 Supported Action — ExportLicenseByDeviceToNetworkShare.............................................................................85 DellManager......................................................................................................................................................................... 85 Supported Action — ResetToDefaults.
Supported Action — BlinkTarget.............................................................................................................................. 169 Supported Action — CheckVDValues.......................................................................................................................173 Supported Action — ClearForeignConfig.................................................................................................................178 Supported Action — ConvertToRAID..........
Memory.............................................................................................................................................................................. 289 Supported Action — MemoryMetrics......................................................................................................................294 MessageRegistryFile.........................................................................................................................................................
Example for PATCH..........................................................................................................................................................349 Example for POST............................................................................................................................................................ 350 Example for DELETE..............................................................................................................................................
1 Overview The Redfish Scalable Platforms Management API is a standard defined by the Distributed Management Task Force (DMTF). Redfish is a next-generation systems management interface standard, which enables scalable, secure, and open server management. It is a new interface that uses RESTful interface semantics to access data that is defined in model format to perform out-of-band systems management.
Other documents you may need For more information about Redfish, see the DMTF website https://www.dmtf.org/standards/redfish. This website provides access to schema files, white papers, technical notes, and so on. To download or access a file, go to https://www.dmtf.org/standards/redfish, locate the desired section, and click the link to open or download the files. You can download the OEM schemas from the Dell website at https://downloads.dell.com/redfish/bmc/schemas/.
2 Redfish-based systems management This section provides an overview of the Redfish service implemented in the iDRAC firmware. It includes information about the Redfish API, schema, configuration, authentication, authorization, and so on.
NOTE: You do not need to restart the web server when enabling or disabling Redfish attribute. Configuring Redfish service using iDRAC web interface To enable or disable the Redfish service on iDRAC, perform the following tasks: 1. In the iDRAC web interface, navigate to the following screen: • 13th generation of PowerEdge servers: Overview > iDRAC Settings > Network > Services • 14th generation of PowerEdge servers: iDRAC Settings > Services > Redfish 2.
• Session-based authentication: This method is used while issuing multiple Redfish operation requests. • • Session login is initiated by accessing the Create session URI. The response for this request includes an X-Auth-Token header with a session token. Authentication for subsequent requests is made using the X-Auth-Token header. Session logout is performed by issuing a DELETE of the Session resource provided by the Login operation including the X-AuthToken header.
The HTTP GET method is used to retrieve a resource. The service ignores the content of the body on a GET. The GET operation is unchanged in the absence of external changes to the resource. HEAD All URLs support the HEAD method. This method returns the response headers. POST Use the POST method to invoke actions and create a resource. The POST request is submitted to the resource collection to which the new resource belongs.
Header Description Cache-Control Returned on all responses. Metadata URIs support cached responses. Instrumentation resources cannot be cached. X-Auth-Token Used for authentication of user sessions. See “Session-based authentication” under Redfish authentication and authorization. HTTP status codes and error messages HTTP defines the status codes that are returned in response messages.
If an event delivery fails, the event service of iDRAC retries delivering the failed event. The number of retries and delivery intervals can be configured using the following attributes: • • iDRAC.RedfishEventing.DeliveryRetryAttempts iDRAC.RedfishEventing.DeliveryRetryIntervalInSeconds Event delivery retry settings in RACADM iDRAC.RedfishEventing.DeliveryRetryAttempts (Read or Write) iDRAC.RedfishEventing.
NOTE: The name of the component being updated is not displayed in the JOB ID, instead it is displayed as a Firmware update. NOTE: While the firmware update job is in process, the JobState displays the status as scheduled, check the PercentComplete function to get status of the job. 4. Reboot the system to apply the update by executing POST on URL Reset (/redfish/v1/Managers/iDRAC.Embedded.1/Actions/ Manager.Reset).
3 Redfish resources This section describes the resource URIs and related operations that are available in the iDRAC implementation of a Redfish service API.
• • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • DellPowerSupplyViewCollection DellPCIeSSDExtender DellPCIeSSDExtenderCollection DellPCIeSSD DellPCIeSSDCollection DellPCIeSSDBackPlane DellPCIeSSDBackPlaneCollection DellPCIeFunction DellPersistentStorageService DellPhysicalDisk DellPresenceAndStatusSensor DellPresenceAndStatusSensorCollection DellPowerSupply DellPowerSupplyView DellProcessor DellRaidService DellSensorCollection DellServiceRoot
• • • • • • • • • • • • • • • • • • • • • SerialInterface ServiceRoot Session SessionService SimpleStorage SoftwareInventoryCollection Storage StorageController Subscriptions Switches TaskCollection TaskService Thermal UpdateService VirtualMedia VLanNetworkInterface Volume NetworkPort NetworkPortCollection NetworkDeviceFunctionCollection Redundancy AccountService Description The AccountService schema contains properties for managing user accounts.
Methods and privileges Table 4. Methods and privileges for AttributeRegistry HTTP method Required privilege GET Login Status codes Table 5. Status codes for AttributeRegistry HTTP status code Extended information 200 Base.1.0.Success 500 Base.1.0.InternalError Assembly Description This is the schema definition for the Assembly properties. URL /redfish/v1/Chassis/System.Embedded.
URL /redfish/v1/Registries/BaseMessages HTTP methods and privileges Table 6. HTTP methods and privileges for BaseMessages HTTP method Required privilege GET Login Status codes Table 7. Status codes for BaseMessages HTTP status code 200 400 500 Bios Description The Bios schema contains properties related to the BIOS Attribute Registry. The Attribute Registry describes the system-specific BIOS attributes and Actions for changing to BIOS settings.
Supported Action — ChangePassword Description This action is used to change the BIOS passwords. URL /redfish/v1/Systems/System.Embedded.1/Bios/Actions/Bios.ChangePassword Supported HTTP Method and Privileges HTTP Method Required Privilege POST ConfigureComponents, Login Supported Status Codes HTTP Status Code Extended Information Error Message Code 400 Base.1.2.GeneralError IDRAC.1.6.RAC1035 Supported Action — ClearPending Description This action is used to clear all the pending values.
Settings resource Description This resource is used for representing the BIOS pending configuration and related resources to clear pending and navigation to Jobs resource. URL /redfish/v1/Systems//Bios/Settings HTTP methods and privileges Table 8. HTTP methods and privileges for the Settings resource HTTP method Required privilege GET Login Updatable properties Table 9.
Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login Navigation URL /redfish/v1/Systems/System.Embedded.
H R T e T q P u M i er te h d oP d r i v i l e g e n t s , L o g i n Chassis Description A Collection of Chassis resource instances.
Supported Parameters P V a rl au m e e t e r IN no tr rm ua sl i, oH na S r ed nw sa or re I n t r u s i o n , n u l l IM na tn ru ua sl i, on nu S l el n s o r R e A r m C R ha ac Redfish resources 27
P V a rl au m e e t e r sk s, iB sl Ta yd pe e, E n c l o s u r e , S t a n d A l o n e , S l e d , O t h e r O P on w , eO rf S f t a t e IB nl di in ck ai 28 Redfish resources
P V a rl au m e e t e r tn og r, LO Ef D f Supported Status Codes HTTP Status Code Extended Information Error Message Code 204 Supported action — Reset Supported action — Reset Description This action is used to reset the chassis. This action resets the chassis, not Systems or other contained resources, although side effects may occur which affect those resources. URL /redfish/v1/Chassis/System.Embedded.1/Actions/Chassis.
Contained resources Power Thermal ComputerSystem Description A Collection of ComputerSystem resource instances.
P V a rl au m e e t e r eP TM y2 p_ e0 , T P M 1 _ 2 B O on oc te S C o un rt ci en O u vo eu rs rD i ds ea Eb nl ae bd l e d S P yh sy ts ei m c Ta yl p e M N eo m n oe r, yS M y Redfish resources 31
P V a rl au m e e t e r is rt re om r i n g P O on w , en ru S l tl a t e B U oE oF tI S , oL ue rg ca ec O y v e r r i d e M o d e IB nl di in ck ai tn og rO Lf Ef D 32 Redfish resources
Supported Status Codes HTTP Status Code Extended Information Error Message Code 204 Supported Action — Reset Supported Action — Reset Description This action is used to reset the system. URL /redfish/v1/Systems/System.Embedded.1/Actions/ComputerSystem.
Supported action —ClearPending Description This action is used to clear all the pending values. URL /redfish/v1/Managers/System.Embedded.1/Attributes/Settings/Actions/Oem/ DellManager.ClearPending DellBootSources Description This resource is used to represent the Dell Boot Sources Configuration and the related resources to the settings resource. URL /redfish/v1/Systems//BootSources HTTP methods and privileges Table 11.
HTTP methods and privileges Table 13. HTTP methods and privileges for ClearPending HTTP method Required privilege POST SystemControl Status codes Table 14. Status codes for ClearPending HTTP status code Extended information 200 Base.1.0.Success 400 • • 403 Base.1.0.InsufficientPrivilege 404 Base.1.0.ResourceMissingAtURI 500 Base.1.0.InternalError Base.1.0.PropertyValueTypeError Base.1.0.
Status codes Table 17. Status codes for the Settings resource HTTP status code Extended information 200 Base.1.0.Success 400 • • 403 Base.1.0. InsufficientPrivilege 404 Base.1.0.ResourceMissingAtURI 500 Base.1.0.InternalError Base.1.0.PropertyValueTypeError Base.1.0.PropertyValueNotInList DellBootSourcesRegistry Description A Boot Sources Registry is a set of key-value pairs that are specific to a particular implementation or product.
HTTP methods and privileges Table 20. HTTP methods and privileges for DellCertificates HTTP method Required privilege GET Login Status codes Table 21. Status codes for DellCertificates HTTP status code Extended information 200 Base.1.0.Success 500 Base.1.0.InternalError URL /redfish/v1/Systems//SecureBoot/Certificates/ HTTP methods and privileges Table 22.
HTTP methods and privileges Table 25. HTTP methods and privileges for instance of Certificate HTTP method Required privilege GET Login DELETE SystemControl NOTE: By default, GET requests on the Certificate member resource generate an output of application/json. Use GET request with Accept header application/pkix-cert to download certificate and use application/octetstream to download the Hash files. Status codes Table 26.
Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e G L Eo Tg i n Supported Parameters P V a rl au m e e t e r ED ne cl rl yK pe ty iM oa n C a ag pe am be in lt iC ta yp a b l e , L o c Redfish resources 39
P V a rl au m e e t e r a l K e y M a n a g e m e n t A n d D e l l K e y M a n a g e m e n t C a p a b l e , L o c a l K e y M a n a g 40 Redfish resources
P V a rl au m e e t e r e m e n t C a p a b l e , N o n e S N lo it cS eu dp V p D o C r at pe ad b, iS lu ip tp yo r t e d S E en c ur ry ip t yi S o tn aC ta up sa b l Redfish resources 41
P V a rl au m e e t e r e , E n c r y p t i o n N o t C a p a b l e , S e c u r i t y K e y A s s i g n e d R P au tn rn oi ln R g e, aS dt S o tp ap 42 Redfish resources
P V a rl au m e e t e r te ed , U n k n o w n R D oe lg lr ua pd S e td a, tE ur sr o r , O K , U n k n o w n N C ao ct hS eu cp ap do er C t ae pd a, bS iu lp ip to yr t Redfish resources 43
P V a rl au m e e t e r e d ED ne cl rl yK pe ty iM oa n M a og de em e n t , L o c a l K e y M a n a g e m e n t , N o n e , P e n d i n g D e l l 44 Redfish resources
P V a rl au m e e t e r K e y M a n a g e m e n t C a p a b l e , U n s u p p o r t e d DelliDRACCard Description An instance of DelliDRACCard will have data specific to the Integrated Dell Remote Access Controller (iDRAC) in the managed system. URL /redfish/v1/Dell/Managers/iDRAC.Embedded.
Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e G L Eo Tg i n DelliDRACCardService Description The DelliDRACCardService resource provides some actions to support iDRAC configurations. URL /redfish/v1/Dell/Managers/iDRAC.Embedded.
H R T e T q P u M i er te h d oP d r i v i l e g e r e M a n a g e r , L o g i n G L Eo Tg i n Supported Parameters P V a rl au m e e t e r C eA r, tC iS fC i, cC al ti e Tn yt pT er u Redfish resources 47
P V a rl au m e e t e r s t C e r t i f i c a t e , S e r v e r F o r c e , G r a c e f u l S C S A L, C eS rC t, TC yl pi e n t T r u s t C e r 48 Redfish resources
P V a rl au m e e t e r t i f i c a t e , S e r v e r P A rl el s, eD re vf ea u l t , R e s e t A l l W i t h R o o t D e f a u l t s Redfish resources 49
Supported Status Codes HTTP Status Code Extended Information Error Message Code 200 Base.1.0.Success RAC066 Supported Action — ExportSSLCertificate Supported Action — iDRACReset Supported Action — ImportSSLCertificate Supported Action — iDRACResetCfg Supported Action — ExportSSLCertificate Description This method is used to export the ssl certificate from the idrac, based on input parameter Type. ExportSSLCertificate returns the certificate. URL /redfish/v1/Dell/Managers/iDRAC.Embedded.
URL /redfish/v1/Dell/Managers/iDRAC.Embedded.1/DelliDRACCardService/Actions/ DelliDRACCardService.iDRACReset Supported HTTP Method and Privileges HTTP Method Required Privilege POST ConfigureManager, Login Supported Parameters Parameter Qualifier Type Value Force Input String Force, Graceful Message Output String MessageArgs Output String MessageID Output String Supported Status Codes HTTP Status Code Extended Information Error Message Code 200 Base.1.0.
Parameter Qualifier Type MessageID Output String Value Description The message ID for Supported Status Codes HTTP Status Code Extended Information Error Message Code 200 Base.1.0.Success RAC066 Supported Action — ImportSSLCertificate Description This method is used to import the ssl certificate to iDRAC, on the basis of input parameter Type. After importing the certificate, the iDRAC will automatically restart. URL /redfish/v1/Dell/Managers/iDRAC.Embedded.
URL redfish/v1/Dell/Managers/iDRAC.Embedded.1/DelliDRACCardService/Actions/ DelliDRACCardService.
URL redfish/v1/Dell/Managers/iDRAC.Embedded.1/DelliDRACCardService/Actions/ DelliDRACCardService.
DellEnclosure Description An instance of DellEnclosure will have storage enclosure specific data. URL /redfish/v1/Dell/Chassis/System.Embedded.1/DellEnclosure/Enclosure.Internal.0-1:RAID.Slot.5-1 Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e G L Eo Tg i n DellEnclosureCollection Description A collection of DellEnclosure resource. URL /redfish/v1/Dell/Chassis/System.Embedded.
DellEnclosureEMM Description An instance of DellEnclosureEMM will have Enclosure Management Module specific data. URL /redfish/v1/Dell/Chassis/System.Embedded.1/DellEnclosureEMM/ EMM.Slot.1:Enclosure.External.0-0:RAID.Slot.
P V a rl au m e e t e r uo sr , O K , U n k n o w n DellEnclosureEMMCollection Description A collection of DellEnclosureEMM resource. URL /redfish/v1/Dell/Chassis/System.Embedded.1/DellEnclosureEMMCollection Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login DellEnclosureFanSensor Description An instance of DellEnclosureFanSensor will have Storage Enclosure fan sensor specific data. URL /redfish/v1/Dell/Chassis/System.Emdedded.
Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login DellEnclosureFanSensorCollection Description A collection of DellEnclosureFanSensor resource. URL /redfish/v1/Dell/Chassis/System.Embedded.1/DellEnclosureFanSensorCollection Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login DellEnclosurePowerSupply Description An instance of DellEnclosurePowerSupply will have Storage Enclosure power supply unit specific data.
Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e G L Eo Tg i n Supported Parameters P V a rl au m e e t e r P D re ig m r a rd ye S d t, aE tr ur so r , O K , U n k n o w n Redfish resources 59
DellEnclosurePowerSupplyCollection Description A collection of DellEnclosurePowerSupply resource. URL /redfish/v1/Dell/Chassis/System.Embedded.1/DellEnclosurePowerSupplyCollection Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login DellEnclosureTemperatureSensor Description An instance of DellEnclosureTemperatureSensor will have Storage Enclosure temperature sensor specific data. URL /redfish/v1/Dell/Chassis/System.Embedded.
Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login DellFC Description An instance of DellFC will have Fiber Channel device specific data. URL /redfish/v1/Dell/Chassis/System.Embedded.1/NetworkAdapters/DellFC Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login Supported Parameters Parameter Value DCIM_FCView InstanceID DellFCCollection Description A collection of DellFC resource. URL /redfish/v1/Dell/Chassis/System.Embedded.
DellFCStatistics Description An instance of DellFCStatistics will have the statistics of the Fiber Channel HBA port. URL /redfish/v1/Dell/Chassis/System.Embedded.1/NetworkPorts/DellFCStatistics Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login Supported Parameters Parameter Value DCIM_FCStatistics InstanceID PortStatus Down, Up, Unknown DellFCStatisticsCollection Description A collection of DellFCStatistics resource. URL /redfish/v1/Dell/Chassis/System.Embedded.
URL /redfish/v1/Managers/iDRAC.Embedded.1/Jobs Supported HTTP Method and Privileges HTTP Method Required Privilege POST ConfigureComponents, Login GET Login Navigation URL /redfish/v1/Managers/iDRAC.Embedded.
URL /redfish/v1/Managers//Jobs HTTP methods and privileges Table 27. HTTP methods and privileges for DellJob HTTP method Required privilege GET Login POST SystemControl Properties required for job creation Table 28. Properties required for job creation for DellJob Parameter Description TargetSettingsURI Settings object resource URI StartTime Scheduled start time EndTime Scheduled end time Status codes Table 29. Status codes for DellJob HTTP status code Extended information 200 Base.1.
Status codes Table 31. Status codes for the instance of the resource HTTP status code Extended information 200 Base.1.0.Success 400 • • 403 Base.1.0. InsufficientPrivilege 404 Base.1.0.ResourceMissingAtURI 500 Base.1.0.InternalError Base.1.0.PropertyValueTypeError Base.1.0.
Supported Action — SetupJobQueue Description This method is used for creating a job queue that shall contain one or more DellJobs with a specified order of execution within the queue. URL /redfish/v1/Dell/Managers/iDRAC.Embedded.1/DellJobService/Actions/DellJobService.
Supported Status Codes HTTP Status Code Extended Information Error Message Code 400 Maximum job limit reached, cannot create new jobs JCP017 Supported Action — ExportFactoryConfiguration Supported Action — BackupImage Supported Action — ClearProvisioningServer Supported Action — GetRSStatus Supported Action — ExportLCLog Supported Action — GetRemoteServicesAPIStatus Supported Action — ExportTechSupportReport Supported Action — ExportHWInventory Supported Action — LCWipe Supported Action — ReInitiateDH
Parameter Qualifier Type ProxyPasswd Input String ProxyPort Input String ProxyServer Input String ProxyUname Input String ScheduledStartTime Input String ShareName Input String UntilTime Input String UserName Input String Workgroup Input String UntilTime Input String Job Output String Message Output String MessageArgs Output String MessageID Output String Value Supported Status Codes HTTP Status Code Extended Information Error Message Code 400 Maximum job li
Parameter Qualifier Type Value Description MessageArgs Output String Substitution variable MessageID Output String The message ID for Supported Status Codes HTTP Status Code Extended Information Error Message Code 400 Maximum job limit reached, cannot create new jobs JCP017 Supported Action — ExportFactoryConfiguration Description The ExportFactoryConfiguration() method is used for exporting the factory configuration from Lifecycle Controller to a remote share.
Parameter Qualifier Type MessageID Output String Value Des The Supported Status Codes HTTP Status Code Extended Information Error Message Code 400 Maximum job limit reached, cannot create new jobs JCP017 Supported Action — ExportLCLog Description The ExportLCLog() method is used for exporting the log from the Lifecycle Controller to a remote share. URL /redfish/v1/Dell/Managers/iDRAC.Embedded.1/DellLCService/Actions/DellLCService.
Supported Status Codes HTTP Status Code Extended Information Error Message Code 400 Maximum job limit reached, cannot create new jobs JCP017 Supported Action — ExportHWInventory Description The ExportHWInventory() method is used for exporting the hardware inventory from the Lifecycle Controller to a remote share. URL /redfish/v1/Dell/Managers/iDRAC.Embedded.1/DellLCService/Actions/ DellLCService.
Supported Status Codes HTTP Status Code Extended Information Error Message Code 400 Maximum job limit reached, cannot create new jobs JCP017 Supported Action — ExportTechSupportReport Description This method is used to collect the TSR that incudes hardware, OS, and application data. The data is compressed into a zip file and saved on the remote share (CIFS/NFS ). URL /redfish/v1/Dell/Managers/iDRAC.Embedded.1/DellLCService/Actions/ DellLCService.
Supported Action — GetRemoteServicesAPIStatus Description The GetRemoteServicesAPIStatus() method is used for obtaining the overall remote services API status that includes host system status, the remote services (Data Manager) status, and real-time status. The overall rolled up status is reflected in the Status output parameter. Note: The LCStatus output parameter value includes the status reported by the DMStatus output parameter in the GetRSStatus() method and the Lifecycle Controller status.
Supported HTTP Method and Privileges HTTP Method Required Privilege POST Login Supported Parameters Parameter Qualifier Type Value Description Message Output String Error or information message correspon MessageArguments Output String Substitution variables for dynamic error MessageID Output String The message ID for the output message Status Output String The status for the Data Manager—Rea Supported Status Codes HTTP Status Code Extended Information Error Message Code 400 Maxi
Supported Action — ReInitiateDHS Description The ReInitiateDHS() method is used for reinitiating the provisioning server discovery and handshake. URL /redfish/v1/Dell/Managers/iDRAC.Embedded.1/DellLCService/Actions/DellLCService.
Supported HTTP Method and Privileges HTTP Method Required Privilege POST Login Supported Parameters Parameter Qualifier Type Value Des IgnoreCertWarning Input String Off, On Spe PreserveVDConfig Input String False, True Spe ProxySupport Input String DefaultProxy, Off, ParametersProxy Spe ProxyType Input String HTTP, SOCKS The ShareType Input String CIFS, HTTP, HTTPS, Local, NFS, VFLASH Typ ImageName Input String Nam IPAddress Input String IP a Password Input Strin
URL /redfish/v1/Dell/Managers/iDRAC.Embedded.1/DellLicenseCollection Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e G L Eo Tg i n DellLicenseManagementService Description The DellLicenseManagementService resource provides some actions to support License Management functionality. URL /redfish/v1/Dell/Managers/iDRAC.Embedded.
Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e P L O o S g Ti n G L Eo Tg i n Supported Parameters P V a rl au m e e t e r IO gf nf o, rO en C e r t W a r n i n g P D re of xa yu 78 Redfish resources
P V a rl au m e e t e r S l ut pP pr o rx ty , O f f , P a r a m e t e r s P r o x y A D el l e, tF eo O r pc te i, oN no sO p t i o n P H rT oT xP y, TS yO pC eK S Redfish resources 79
P V a rl au m e e t e r IA m l pl o, rF to O r pc te i, oN no sO p t i o n S C hI aF rS e, TH yT pT eP , H T T P S , N F S Supported Action — ExportLicenseToNetworkShare Supported Action — ImportLicenseFromNetworkShare Supported Action — ImportLicense Supported Action — ShowLicenseBitsSupported Action —DeleteLicenseSupported Action — ExportLicenseSupported Action — ExportLicenseByDeviceToNetworkShare Supported Action — ExportLicenseToNetworkShare Description ExportLicenseToNetworkShare is a method used to
URL /redfish/v1/Dell/Managers/iDRAC.Embedded.1/DellLicenseManagementService/Actions/ DellLicenseManagementService.
Supported HTTP Method and Privileges HTTP Method Required Privilege POST Login Supported Parameters Parameter Qualifier Type Value FQDD Input String FQD IPAddress Input String IP a IgnoreCertWarning Input String Off, On Spe ImportOptions Input String NoOption, Force, All Flag LicenseName Input String The Password Input String Pas ProxyPasswd Input String The ProxyPort Input String Por ProxyServer Input String The ProxySupport Input String Off, DefaultProxy, P
Supported Parameters Parameter Qualifier Type Value Des FQDD Input String FQD ImportOptions Input String Flag LicenseFile Input String Ab Message Output String Erro MessageArgs Output String Sub MessageID Output String The Supported Action — ShowLicenseBits Description The ShowLicenseBits() method is used to retrieve the iDRAC feature license bit string for the Licenses in iDRAC in a hexadecimal representation of a 256 bit-string.
Supported HTTP Method and Privileges HTTP Method Required Privilege POST Login Supported Parameters Parameter Qualifier Type Value Des FQDD Input String DeleteOptions Input String EntitlementID Input String Ent Message Output String Erro MessageArgs Output String Sub MessageID Output String The FQD NoOption, Force, All Flag Supported Action — ExportLicense Description ExportLicense is a method used to export License files from the iDRAC.
Supported Action — ExportLicenseByDeviceToNetworkShare Description ExportLicenseByDeviceToNetworkShare is a method used to export License files from the IDRAC. The ExportLicenseByDeviceToNetworkShare method exports all licenses from a device, specified by FQDD, to a user defined location. The following tables specify ExportLicenseByDeviceToNetworkShare return values and parameters. URL /redfish/v1/Dell/Managers/iDRAC.Embedded.1/DellLicenseManagementService/Actions/ DellLicenseManagementService.
Redfish SCP is an OEM action and requires OEM privileges ALL and role as ADMIN. Redfish privileges are not applicable for SCP. For more information about this schema, the location header, and other details, see the RESTful Server Configuration with iDRAC REST API white paper at dell.com/support. Supported Action — ResetToDefaults Description This defines the name of the OEM action supported when used in conjunction with a POST operation to this resource.
HTTP method Feature POST Preview configuration Export resource URL and response details URL redfish/v1/Managers//Actions/Oem/EID_674_Manager.ExportSystemConfiguration Status codes Table 36. Status codes for the action HTTP status code Extended information Error Message Code 202 400 • • • Base.1.2.PropertyMissing Base.1.2.PropertyValueTypeError Base.1.2.PropertyValueNotInList 400 500 • • • • Base.1.2.
Properties and values Table 39. Properties and values for the action Property Values ImportBuffer Buffer content to perform import. Required only for LOCAL and not required for CIFS, NFS, HTTP, or HTTPS. ShutdownType Graceful, Forced, NoReboot HostPowerState On, Off TimeToWait The time to wait for the host to shut down. Default and minimum value is 300 seconds. Maximum value is 3600 seconds. ShareParameters See Share parameters and values.
DellMemory Description An instance of DellMemory will have Memory Device specific data. URL /redfish/v1/Dell/Systems/System.Embedded.1/Memory/DellMemory/ Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e G L Eo Tg i n DellNIC Description An instance of DellNIC will have NIC device specific data. URL /redfish/v1/Dell/Systems/System.Embedded.
Supported Parameters Parameter Value DCIM_NICView BusNumber, MediaType, ProductName, NicMod PermanentiSCSIMACAddress NicMode Unknown, Enabled, Disabled DellNICCapabilitiesCollection Description A collection of DellNIC resource. URL /redfish/v1/Dell/Systems/System.Embedded.
DellNICCapabilitiesCollection Description A collection of DellNICCapabilities resource. URL /redfish/v1/Dell/Systems/System.Embedded.1/NetworkDeviceFunctions/ DellNICCapabilitiesCollection Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login DellNICStatistics Description An instance of DellNICStatistics will have the statistics of the NIC, NIC port or partition. URL /redfish/v1/Dell/Systems/System.Embedded.
URL /redfish/v1/Dell/Systems/System.Embedded.1/NetworkAdapters/NetworkDeviceFunctions/ DellNICStatisticsCollection Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login DellNumericSensor Description An instance of DellNumericSensor will have data specific to sensor devices that returns only numeric readings and optionally supports thresholds settings. URL /redfish/v1/Dell/Systems/System.Embedded.
Supported Parameters P V a rl au m e e t e r S A ei nr sF ol ro Tw y, pC eo u n t e r , C u r r e n t , H u m i d i t y , I n t r u s i o n , L o c k , O t h e r Redfish resources 93
P V a rl au m e e t e r , P o w e r C o n s u m p t i o n , P o w e r P r o d u c t i o n , P r e s e n c e , P r e s s u r e , S m o k 94 Redfish resources
P V a rl au m e e t e r e D e t e c t i o n , S w i t c h , T a c h o m e t e r , T e m p e r a t u r e , U n k n o w n , V o l t a g e Redfish resources 95
P V a rl au m e e t e r ED ne af be lr er de S d t, aD ti es a b l e d , E n a b l e d , E n a b l e d B u t O f f l i n e , I n T e s t , N o t A p 96 Redfish resources
P V a rl au m e e t e r p l i c a b l e , O t h e r , Q u i e s c e , S h u t t i n g D o w n , S t a r t i n g , U n k n o w n H C er ai Redfish resources 97
P V a rl au m e e t e r lt ti hc S a tl aF ta ei l u r e , D e g r a d e d / W a r n i n g , M a j o r F a i l u r e , M i n o r F a i l u r e , 98 Redfish resources
P V a rl au m e e t e r N o n R e c o v e r a b l e E r r o r , O K , U n k n o w n DellNumericSensorCollection Description A collection of DellNumericSensor resource URL /redfish/v1/Dell/Systems/System.Embedded.
Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e G L Eo Tg i n DellOSDeploymentService Description The DellOSDeploymentService resource provides some actions to support OS deployment configurations. URL /redfish/v1/Dell/Systems/System.Embedded.
H R T e T q P u M i er te h d oP d r i v i l e g e G L Eo Tg i n Supported Parameters P V a rl au m e e t e r H M aD s5 h, TS yH pA e1 R C eo sl ed tR Te ys pe et , N o R e s e t , W a r m R Redfish resources 101
P V a rl au m e e t e r e s e t S C hI aF rS e, TN yF pS e, T F T P Supported Status Codes HTTP Status Code Extended Information Error Message Code 200 Base.1.0.
URL /redfish/v1/Dell/Systems/System.Embedded.1/DellOSDeploymentService/Actions/ DellOSDeploymentService.
P V a rl au m e e t e r TN yF pS e, T F T P Supported Status Codes HTTP Status Code Extended Information Error Message Code 200 Base.1.0.Success OSD1 Supported Action — BootToISOFromVFlash Description The BootToISOFromVFlash() method is used to boot to the downloaded pre-operating system image on the vFlash SD card. The following table lists the return values for BootToISOFromVFlash() method, where the method-execution behavior matches the return-code description.
P V a rl au m e e t e r pA e1 R C eo sl ed tR Te ys pe et , N o R e s e t , W a r m R e s e t C S hI aF rS e, TN yF pS e, T F T P Supported Status Codes HTTP Status Code Extended Information Error Message Code 200 Base.1.0.
Supported Action — BootToNetworkISO Description The BootToNetworkISO() method is used to boot to the iDRAC pre-operating system image that was already downloaded. The following table lists the return values for BootToNetworkISO() method, where the method-execution behavior matches the return-code description. URL /redfish/v1/Dell/Systems/System.Embedded.1/DellOSDeploymentService/Actions/ DellOSDeploymentService.
P V a rl au m e e t e r e s e t S C hI aF rS e, TN yF pS e, T F T P Supported Status Codes HTTP Status Code Extended Information Error Message Code 200 Base.1.0.Success OSD1 Supported Action — ConfigurableBootToNetworkISO Description The ConfigurableBootToNetworkISO() method exposes an ISO Image present on a network share as a CDROM device to the host server for a specified exposure duration interval or by default for 18 hrs.
Supported Parameters P V a rl au m e e t e r H M aD s5 h, TS yH pA e1 R C eo sl ed tR Te ys pe et , N o R e s e t , W a r m R e s e t C S hI aF rS e, TN yF pS e, T F T P 108 Redfish resources
Supported Status Codes HTTP Status Code Extended Information Error Message Code 200 Base.1.0.Success OSD1 Supported Action — ConnectNetworkISOImage Description The ConnectNetworkISOImage() method is used to connect to the ISO present on the network share and expose the ISO as a local USB CD-ROM device to the host system. This method will connect to the ISO located on an NFS/CIFS share and expose it as a virtual CDROM device to the host server.
P V a rl au m e e t e r o R e s e t , W a r m R e s e t S C hI aF rS e, TN yF pS e, T F T P Supported Status Codes HTTP Status Code Extended Information Error Message Code 200 Base.1.0.Success OSD1 Supported Action — DeleteISOFromVFlash Description The DeleteISOFromVFlash() method is used to delete the ISO Image from vFlash SD card.The following table lists the return values for the DeleteISOFromVFlash() method, where the method- execution behavior matches the return-code description.
Supported HTTP Method and Privileges HTTP Method Required Privilege POST Login Supported Parameters P V a rl au m e e t e r H M aD s5 h, TS yH pA e1 R C eo sl ed tR Te ys pe et , N o R e s e t , W a r m R e s e t C S hI aF rS e, TN yF pS e, T F Redfish resources 111
P V a rl au m e e t e r T P Supported Status Codes HTTP Status Code Extended Information Error Message Code 200 Base.1.0.Success OSD1 Supported Action — DetachISOFromVFlash Description The DetachISOFromVFlash() method is used to detach the ISO Image (on a vFlash SD card) from the host system. URL /redfish/v1/Dell/Systems/System.Embedded.1/DellOSDeploymentService/Actions/ DellOSDeploymentService.
P V a rl au m e e t e r ys pe et , N o R e s e t , W a r m R e s e t S C hI aF rS e, TN yF pS e, T F T P Supported Status Codes HTTP Status Code Extended Information Error Message Code 200 Base.1.0.Success OSD1 Supported Action — DetachDrivers Description This OSDeploymentService.DetachDrivers() method is used to detach the USB device containing the drivers from the host server.
URL /redfish/v1/Dell/Systems/System.Embedded.1/DellOSDeploymentService/Actions/ DellOSDeploymentService.
P V a rl au m e e t e r TN yF pS e, T F T P Supported Status Codes HTTP Status Code Extended Information Error Message Code 200 Base.1.0.Success OSD1 Supported Action — DetachISOImage Description The DetachISOImage() method is used to detach the ISO Image from the host server. The following table lists the return values for DetachISOImage() method, where the method-execution behavior matches the return-code description.
P V a rl au m e e t e r pA e1 R C eo sl ed tR Te ys pe et , N o R e s e t , W a r m R e s e t C S hI aF rS e, TN yF pS e, T F T P Supported Status Codes HTTP Status Code Extended Information Error Message Code 200 Base.1.0.
Supported Action — DisconnectNetworkISOImage Description The DisconnectNetworkISOImage() method is used to disconnect and detach the ISO Image from the host system. The following table lists the return values for the DisconnectNetworkISOImage() method, where the method-execution behavior matches the return-code description. URL /redfish/v1/Dell/Systems/System.Embedded.1/DellOSDeploymentService/Actions/ DellOSDeploymentService.
P V a rl au m e e t e r e s e t S C hI aF rS e, TN yF pS e, T F T P Supported Status Codes HTTP Status Code Extended Information Error Message Code 200 Base.1.0.Success OSD1 Supported Action — DownloadISOToVFlash Description The DownloadISOToVFlash() method is used to download the pre-operating system ISO Image to the vFlash SD card. The following table lists the return values for DownloadISOToVFlash() method, where the method-execution behavior matches the return-code description.
Supported Parameters P V a rl au m e e t e r H M aD s5 h, TS yH pA e1 R C eo sl ed tR Te ys pe et , N o R e s e t , W a r m R e s e t C S hI aF rS e, TN yF pS e, T F T P Redfish resources 119
Supported Status Codes HTTP Status Code Extended Information Error Message Code 200 Base.1.0.Success OSD1 Supported Action — GetAttachStatus Description The GetAttachStatus() method will give the status of the Drivers and ISO Image that has been exposed to host. URL /redfish/v1/Dell/Systems/System.Embedded.1/DellOSDeploymentService/Actions/ DellOSDeploymentService.
P V a rl au m e e t e r W a r m R e s e t S C hI aF rS e, TN yF pS e, T F T P Supported Status Codes HTTP Status Code Extended Information Error Message Code 200 Base.1.0.Success OSD1 Supported Action — GetDriverPackInfo Description The GetDriverPackInfo() method is used get the list of operating systems that can be installed on the host system using the embedded device drivers present in the Lifecycle Controller. URL /redfish/v1/Dell/Systems/System.Embedded.
Supported Parameters P V a rl au m e e t e r H M aD s5 h, TS yH pA e1 R C eo sl ed tR Te ys pe et , N o R e s e t , W a r m R e s e t C S hI aF rS e, TN yF pS e, T F T P 122 Redfish resources
Supported Status Codes HTTP Status Code Extended Information Error Message Code 200 Base.1.0.Success OSD1 Supported Action — GetNetworkISOImageConnectionInfo Description The GetNetworkISOImageConnectionInfo() method is used to give the status of the ISO Image that has been exposed to the host system. The following table lists the return values for GetNetworkISOImageConnectionInfo(), where the method-execution behavior matches the return-code description. URL /redfish/v1/Dell/Systems/System.Embedded.
P V a rl au m e e t e r t , W a r m R e s e t S C hI aF rS e, TN yF pS e, T F T P Supported Status Codes HTTP Status Code Extended Information Error Message Code 200 Base.1.0.Success OSD1 Supported Action — UnpackAndAttach Description The UnpackAndAttach() method is used to extract the drivers for the selected operating system to a USB device that is attached locally to the server for the specified time interval.
Supported Parameters P V a rl au m e e t e r H M aD s5 h, TS yH pA e1 R C eo sl ed tR Te ys pe et , N o R e s e t , W a r m R e s e t C S hI aF rS e, TN yF pS e, T F T P Redfish resources 125
Supported Status Codes HTTP Status Code Extended Information Error Message Code 200 Base.1.0.Success OSD1 Supported Action — UnpackAndShare Description The UnpackAndShare() method is used to extract the drivers for the selected operating system, and copy them to the specified network share. The following table lists the return values for UnpackAndShare(), where the method-execution behavior matches the return-code description. URL /redfish/v1/Dell/Systems/System.Embedded.
P V a rl au m e e t e r t , W a r m R e s e t S C hI aF rS e, TN yF pS e, T F T P Supported Status Codes HTTP Status Code Extended Information Error Message Code 200 Base.1.0.Success OSD1 DellPowerSupplyCollection Description A collection of DellPowerSupply resource. URL /redfish/v1/Dell/Chassis/System.Embedded.
DellPowerSupplyViewCollection Description A collection of DellPowerSupplyView resource. URL /redfish/v1/Dell/Chassis/System.Embedded.1/Power/PowerSupplies/DellPowerSupplyViewCollection Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login DellPCIeSSDExtender Description An instance of DellPCIeSSDExtender will have data specific to the PCIeSSD extender in the managed system. URL /redfish/v1/Dell/Systems/System.Embedded.
URL /redfish/v1/Dell/Systems/System.Embedded.1/Storage/DellPCIeSSDExtenderCollection Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login DellPCIeSSD Description An instance of DellPCIeSSD will have PCIe Solid State Drive specific data. URL /redfish/v1/Dell/Systems/System.Embedded.1/Storage/DellPCIeSSD Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login Supported Parameters Parameter Value DriveFormFactor Unknown, 1.8Inch, 2.5Inch, 3.
DellPCIeSSDBackPlane Description An instance of DellPCIeSSDBackPlane will have PCIeSSD back plane specific data. URL /redfish/v1/Dell/Systems/System.Embedded.1/Storage/DellPCIeSSDBackPlane Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login DellPCIeSSDBackPlaneCollection Description A collection of DellPCIeSSDBackPlane resource. URL /redfish/v1/Dell/Systems/System.Embedded.
Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e G L Eo Tg i n Supported Parameters P V a rl au m e e t e r D 1 a2 t8 aB B i ut s, W 1 i2 dX tO hr X 1 2 , 1 6 B i t , 1 6 X O r X Redfish resources 131
P V a rl au m e e t e r 1 6 , 1 X O r X 1 , 2 X O r X 2 , 3 2 B i t , 3 2 X O r X 3 2 , 4 X O r X 4 , 6 4 B i t , 8 B i t , 8 X O r X 8 132 Redfish resources
P V a rl au m e e t e r , O t h e r , U n k n o w n S A lG oP t, TA yG pP e2 X , A G P 4 X , A G P 8 X , E I S A , I / O R i s e r C a r d S l Redfish resources 133
P V a rl au m e e t e r o t , I S A , M C A , N u B u s , O t h e r , P C 9 8 / C 2 0 , P C 9 8 / C 2 4 , P C 9 8 / C a r d , P C 134 3
P V a rl au m e e t e r 9 8 / E , P C 9 8 / L o c a l B u s , P C C a r d( P C M C I A ) , P C I , P C I 6 6 M H z C a p a b l e , 3 135
P V a rl au m e e t e r P C I X , P C I E x p r e s s , P C I E x p r e s s G e n 2 , P C I E x p r e s s G e n 2 S F F 8 6 3 9 , P 136 3
P V a rl au m e e t e r C I E x p r e s s G e n 2 X 1 , P C I E x p r e s s G e n 2 X 1 6 , P C I E x p r e s s G e n 2 X 2 , P C I E x 3 137
P V a rl au m e e t e r p r e s s G e n 2 X 4 , P C I E x p r e s s G e n 2 X 8 , P C I E x p r e s s G e n 3 , P C I E x p r e s s G e 138 3
P V a rl au m e e t e r n 3 S F F 8 6 3 9 , P C I E x p r e s s G e n 3 X 1 , P C I E x p r e s s G e n 3 X 1 6 , P C I E x p r e s s 3 139
P V a rl au m e e t e r G e n 3 X 2 , P C I E x p r e s s G e n 3 X 4 , P C I E x p r e s s G e n 3 X 8 , P C I E x p r e s s X 1 , P C 140 3
P V a rl au m e e t e r I E x p r e s s X 1 6 , P C I E x p r e s s X 2 , P C I E x p r e s s X 4 , P C I E x p r e s s X 8 , P r o c e 3 141
P V a rl au m e e t e r s s o r C a r d S l o t , P r o p r i e t a r y , P r o p r i e t a r y M e m o r y C a r d S l o t , U n k n o 142 Redfish resources
P V a rl au m e e t e r w n , V L V E S A DellPersistentStorageService Description The DellPersistentStorageService resource provides some actions to support VFlash functionality. URL /redfish/v1/Dell/Managers/iDRAC.Embedded.
H R T e T q P u M i er te h d oP d r i v i l e g e a l M e d i a , L o g i n G L Eo Tg i n Supported Parameters P V a rl au m e e t e r FE oX rT m 2 a, tE TX yT p3 e, F A T 1 6 , F A 144 Redfish resources
P V a rl au m e e t e r T 3 2 Supported Status Codes HTTP Status Code Extended Information 400 JCP017 Error Message Code Supported Action — FormatPartition Supported Action — FormatPartition Description The FormatPartition Action is used for formatting a partition on a vFlash. URL /redfish/v1/Dell/Managers/iDRAC.Embedded.1/DellPersistentStorageService/Actions/ DellPersistentStorageService.
P V a rl au m e e t e r A T 1 6 , F A T 3 2 Supported Status Codes HTTP Status Code Extended Information 400 JCP017 Error Message Code DellPhysicalDisk Description An instance of DellPhysicalDisk will have Physical Disk specific data. URL /redfish/v1/Dell/Systems/System.Embedded.
Supported Parameters P V a rl au m e e t e r D 1 r. i8 vI en Fc oh r, m 2 F. a5 cI tn oc rh , 3 . 5 I n c h , A d d I n C a r d , M .
P V a rl au m e e t e r ie vr et FA ab is le un rt e, S tm a tr et A l e r t P r e s e n t B R al io dc S k te ad t, uD se g r a d e d , F a i l e d , F o r e 148 Redfish resources
P V a rl au m e e t e r i g n , M i s s i n g , N o n R A I D , O f f l i n e , O n l i n e , R e a d y , U n k n o w n Redfish resources 149
DellPresenceAndStatusSensor Description An instance of DellPresenceAndStatusSensor will have presence and status sensor specific data. URL /redfish/v1/Dell/Systems/System.Embedded.
P V a rl au m e e t e r e r , C u r r e n t , H u m i d i t y , I n t r u s i o n , L o c k , O t h e r , P o w e r C o n s u m p t i o 3 151
P V a rl au m e e t e r n , P o w e r P r o d u c t i o n , P r e s e n c e , P r e s s u r e , S m o k e D e t e c t i o n , S w i t c 152 Redfish resources
P V a rl au m e e t e r h , T a c h o m e t e r , T e m p e r a t u r e , U n k n o w n , V o l t a g e DellPresenceAndStatusSensorCollection Description A collection of DellPresenceAndStatusSensor resource URL /redfish/v1/Dell/Systems/System.Embedded.
Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e G L Eo Tg i n DellPowerSupply Description An instance of DellPowerSupply will have data specific to the Power Supply devices in the managed system. URL /redfish/v1/Dell/Chassis/System.Embedded.1/Power/PowerSupplies/DellPowerSupply/PSU.Slot.
DellPowerSupplyView Description An instance of DellPowerSupplyView will have data specific to the Power Supply devices in the managed system. URL /redfish/v1/Dell/Chassis/System.Embedded.1/Power/PowerSupplies/DellPowerSupplyView/PSU.Slot.2 Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e G L Eo Tg i n DellProcessor Description An instance of DellProcessor will have CPU specific data. URL /redfish/v1/Dell/Systems/System.Emdedded.
Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e G L Eo Tg i n Supported Parameters P V a rl au m e e t e r H N yo p, eY re Ts h r e a d i n g E n a b l e d TN uo r, bY oe M s o 156 Redfish resources
P V a rl au m e e t e r d e C a p a b l e TN uo r, bY oe M s o d e E n a b l e d V N io r, tY ue as l i z a t i o n T e c h n o l o g y C a p a b Redfish resources 157
P V a rl au m e e t e r l e V N io r, tY ue as l i z a t i o n T e c h n o l o g y E n a b l e d H N yo p, eY re Ts h r e a d i n g C a p a b l e 158 Redfish resources
DellRaidService Description The DellRaidService resource provides some actions to support RAID functionality. URL /redfish/v1/Dell/Systems/System.Embedded.
P V a rl au m e e t e r p, eS S D FA ol rl m , FM a.
P V a rl au m e e t e r I D 6 , R A I D 6 0 D A il sl kP pr ro ot to oc co ol ls , N V M e , S A S , S A T A D M oK dM e, L K M V R D A P I rD oL pe N v ae m l e, A S Redfish resources 161
P V a rl au m e e t e r ri rz ae y, IS np a n D e p t h , S p a n L e n g t h , S t a r t i n g L B A , T 1 0 P I S t a t u s 4 B l0 o9 c6 k, S 5 i1 162 Redfish resources
P V a rl au m e e t e r z2 e, IA nl B l y t e s TA 1l 0l P , IT S 1 t0 aP tI uC sa p a b l e , T 1 0 P I I n c a p a b l e A D il sl k, EF nD cE r, yN po tn F D E Redfish resources 163
Supported Status Codes HTTP Status Code Extended Information 400 STOR003 Error Message Code Supported Action — AssignSpare Supported Action — BlinkTarget Supported Action — CheckVDValues Supported Action — ClearForeignConfig Supported Action — ConvertToRAID Supported Action — ConvertToNonRAID Supported Action — GetDHSDisks Supported Action — LockVirtualDisk Supported Action — GetRAIDLevels Supported Action — SetControllerKey Supported Action — RemoveControllerKey Supported Action — UnBlinkTarget Suppor
P V a rl au m e e t e r S D FA ol rl m , FM a.
P V a rl au m e e t e r 6 , R A I D 6 0 D A il sl kP pr ro ot to oc co ol ls , N V M e , S A S , S A T A D M oK dM e, L K M V R D A P I rD oL pe N v ae m l e, A S ri rz 166 Redfish resources
P V a rl au m e e t e r ae y, IS np a n D e p t h , S p a n L e n g t h , S t a r t i n g L B A , T 1 0 P I S t a t u s 4 B l0 o9 c6 k, S 5 i1 z2 e, Redfish resources 167
P V a rl au m e e t e r IA nl B l y t e s TA 1l 0l P , IT S 1 t0 aP tI uC sa p a b l e , T 1 0 P I I n c a p a b l e A D il sl k, EF nD cE r, yN po tn F D E 168 Redfish resources
Supported Status Codes HTTP Status Code Extended Information 400 STOR003 Error Message Code Supported Action — BlinkTarget Description The BlinkTarget() method is used to Identify a single physical disk by blinking the disk slot LED for the physical disk / Virtual disk. The successful execution of this method results in setting the LED to blink the identify pattern or turns off the blinking of the identify pattern. The method is real time, blink cannot be scheduled as part of a job.
P V a rl au m e e t e r dA LI eD v, eR lA I D 0 , R A I D 1 , R A I D 1 0 , R A I D 5 , R A I D 5 0 , R A I D 6 , R A I D 6 0 A D il sl kP pr ro ot 170 Redfish resources
P V a rl au m e e t e r to oc co ol ls , N V M e , S A S , S A T A M D oK dM e, L K M V R D A P I rD oL pe N v ae m l e, A S ri rz ae y, IS np a n D e p t h , S p a n Redfish resources 171
P V a rl au m e e t e r L e n g t h , S t a r t i n g L B A , T 1 0 P I S t a t u s 4 B l0 o9 c6 k, S 5 i1 z2 e, IA nl B l y t e s TA 1l 0l P , IT S 1 t0 aP tI 172 Redfish resources
P V a rl au m e e t e r uC sa p a b l e , T 1 0 P I I n c a p a b l e D A il sl k, EF nD cE r, yN po tn F D E Supported Status Codes HTTP Status Code Extended Information 400 STOR003 Error Message Code Supported Action — CheckVDValues Description The CheckVDValues() method is used to determine the possible sizes of Virtual disks and the default settings, proviced a RAID level and set of physical disks.
URL /redfish/v1/Dell/Systems/System.Embedded.1/DellRaidService/Actions/ DellRaidService.CheckVDValues Supported HTTP Method and Privileges HTTP Method Required Privilege POST Login Supported Parameters P V a rl au m e e t e r D A il sl k, TH yD pD e, S S D FA ol rl m , FM a.
P V a rl au m e e t e r R A I D 1 0 , R A I D 5 , R A I D 5 0 , R A I D 6 , R A I D 6 0 A D il sl kP pr ro ot to oc co ol ls , N V M e , S A S , S Redfish resources 175
P V a rl au m e e t e r A T A M D oK dM e, L K M V R D A P I rD oL pe N v ae m l e, A S ri rz ae y, IS np a n D e p t h , S p a n L e n g t h , S t a r t i n g L 176 Redfish resources
P V a rl au m e e t e r B A , T 1 0 P I S t a t u s B 4 l0 o9 c6 k, S 5 i1 z2 e, IA nl B l y t e s TA 1l 0l P , IT S 1 t0 aP tI uC sa p a b l e , T 1 0 P I I n c Redfish resources 177
P V a rl au m e e t e r a p a b l e D A il sl k, EF nD cE r, yN po tn F D E Supported Status Codes HTTP Status Code Extended Information 400 STOR003 Error Message Code Supported Action — ClearForeignConfig Description The ClearForeignConfig() method is used to prepare any foreign physical disks for inclusion in the local configuration. URL /redfish/v1/Dell/Systems/System.Embedded.1/DellRaidService/Actions/ DellRaidService.
Supported Parameters P V a rl au m e e t e r D A il sl k, TH yD pD e, S S D FA ol rl m , FM a.
P V a rl au m e e t e r , R A I D 5 0 , R A I D 6 , R A I D 6 0 D A il sl kP pr ro ot to oc co ol ls , N V M e , S A S , S A T A D M oK dM e, L K M 180 Redfish resources
P V a rl au m e e t e r V R D A P I rD oL pe N v ae m l e, A S ri rz ae y, IS np a n D e p t h , S p a n L e n g t h , S t a r t i n g L B A , T 1 0 P I S t a Redfish resources 181
P V a rl au m e e t e r t u s B 4 l0 o9 c6 k, S 5 i1 z2 e, IA nl B l y t e s TA 1l 0l P , IT S 1 t0 aP tI uC sa p a b l e , T 1 0 P I I n c a p a b l e A D il sl k, 182 Redfish resources
P V a rl au m e e t e r EF nD cE r, yN po tn F D E Supported Status Codes HTTP Status Code Extended Information 400 STOR003 Error Message Code Supported Action — ConvertToRAID Description The ConvertToRAID() method is used to convert a physical disks in Non-RAID state to a state usable for RAID. After the method is successfully executed the DCIM_PhysicalDiskView.RAIDStatus property of that physical disk should reflect the new state. URL /redfish/v1/Dell/Systems/System.Embedded.
P V a rl au m e e t e r pD e, S S D FA ol rl m , FM a.
P V a rl au m e e t e r A I D 6 , R A I D 6 0 D A il sl kP pr ro ot to oc co ol ls , N V M e , S A S , S A T A D M oK dM e, L K M V R D A P I rD oL pe N v ae m l e, Redfish resources 185
P V a rl au m e e t e r A S ri rz ae y, IS np a n D e p t h , S p a n L e n g t h , S t a r t i n g L B A , T 1 0 P I S t a t u s B 4 l0 o9 c6 k, S 5 186 Redfish resources
P V a rl au m e e t e r i1 z2 e, IA nl B l y t e s TA 1l 0l P , IT S 1 t0 aP tI uC sa p a b l e , T 1 0 P I I n c a p a b l e A D il sl k, EF nD cE r, yN po tn F D E Redfish resources 187
Supported Status Codes HTTP Status Code Extended Information 400 STOR003 Error Message Code Supported Action — ConvertToNonRAID Description The ConvertToNonRAID() method is used to convert a physical disks in RAID state of "Ready" to a Non-RAID state. After the method is successfully executed, the DCIM_PhysicalDiskView.RAIDStatus property of that physical disk should reflect the new state. URL /redfish/v1/Dell/Systems/System.Embedded.1/DellRaidService/Actions/ DellRaidService.
P V a rl au m e e t e r dA LI eD v, eR lA I D 0 , R A I D 1 , R A I D 1 0 , R A I D 5 , R A I D 5 0 , R A I D 6 , R A I D 6 0 A D il sl kP pr ro ot Redfish resources 189
P V a rl au m e e t e r to oc co ol ls , N V M e , S A S , S A T A M D oK dM e, L K M V R D A P I rD oL pe N v ae m l e, A S ri rz ae y, IS np a n D e p t h , S p a n 190 Redfish resources
P V a rl au m e e t e r L e n g t h , S t a r t i n g L B A , T 1 0 P I S t a t u s 4 B l0 o9 c6 k, S 5 i1 z2 e, IA nl B l y t e s TA 1l 0l P , IT S 1 t0 aP tI Redfish resources 191
P V a rl au m e e t e r uC sa p a b l e , T 1 0 P I I n c a p a b l e D A il sl k, EF nD cE r, yN po tn F D E Supported Status Codes HTTP Status Code Extended Information 400 STOR003 Error Message Code Supported Action — EnableControllerEncryption Description The EnableControllerEncryption() method sets either Local Key Management (LKM) or Dell Key Management (DKM) on controllers that support encryption of the drives.
URL /redfish/v1/Dell/Systems/System.Embedded.1/DellRaidService/Actions/ DellRaidService.EnableControllerEncryption Supported HTTP Method and Privileges HTTP Method Required Privilege POST Login Supported Parameters P V a rl au m e e t e r D A il sl k, TH yD pD e, S S D FA ol rl m , FM a.
P V a rl au m e e t e r R A I D 1 0 , R A I D 5 , R A I D 5 0 , R A I D 6 , R A I D 6 0 A D il sl kP pr ro ot to oc co ol ls , N V M e , S A S , S 194 Redfish resources
P V a rl au m e e t e r A T A M D oK dM e, L K M V R D A P I rD oL pe N v ae m l e, A S ri rz ae y, IS np a n D e p t h , S p a n L e n g t h , S t a r t i n g L Redfish resources 195
P V a rl au m e e t e r B A , T 1 0 P I S t a t u s B 4 l0 o9 c6 k, S 5 i1 z2 e, IA nl B l y t e s TA 1l 0l P , IT S 1 t0 aP tI uC sa p a b l e , T 1 0 P I I n c 196 Redfish resources
P V a rl au m e e t e r a p a b l e D A il sl k, EF nD cE r, yN po tn F D E Supported Status Codes HTTP Status Code Extended Information 400 STOR003 Error Message Code Supported Action — GetAvailableDisks Description The GetAvailableDisks () method is used to determine minimum number of drives required to create virtual disks. URL /redfish/v1/Dell/Systems/System.Embedded.1/DellRaidService/Actions/ DellRaidService.
Supported Parameters P V a rl au m e e t e r D A il sl k, TH yD pD e, S S D FA ol rl m , FM a.
P V a rl au m e e t e r , R A I D 5 0 , R A I D 6 , R A I D 6 0 D A il sl kP pr ro ot to oc co ol ls , N V M e , S A S , S A T A D M oK dM e, L K M Redfish resources 199
P V a rl au m e e t e r V R D A P I rD oL pe N v ae m l e, A S ri rz ae y, IS np a n D e p t h , S p a n L e n g t h , S t a r t i n g L B A , T 1 0 P I S t a 200 Redfish resources
P V a rl au m e e t e r t u s B 4 l0 o9 c6 k, S 5 i1 z2 e, IA nl B l y t e s TA 1l 0l P , IT S 1 t0 aP tI uC sa p a b l e , T 1 0 P I I n c a p a b l e A D il sl k, Redfish resources 201
P V a rl au m e e t e r EF nD cE r, yN po tn F D E Supported Status Codes HTTP Status Code Extended Information 400 STOR003 Error Message Code Supported Action — GetDHSDisks Description The GetDHSDisks() method is used to determine possible choices of physical drives that can used to set a dedicated hotspare for the identified virtual disk.
P V a rl au m e e t e r pD e, S S D FA ol rl m , FM a.
P V a rl au m e e t e r A I D 6 , R A I D 6 0 D A il sl kP pr ro ot to oc co ol ls , N V M e , S A S , S A T A D M oK dM e, L K M V R D A P I rD oL pe N v ae m l e, 204 Redfish resources
P V a rl au m e e t e r A S ri rz ae y, IS np a n D e p t h , S p a n L e n g t h , S t a r t i n g L B A , T 1 0 P I S t a t u s B 4 l0 o9 c6 k, S 5 Redfish resources 205
P V a rl au m e e t e r i1 z2 e, IA nl B l y t e s TA 1l 0l P , IT S 1 t0 aP tI uC sa p a b l e , T 1 0 P I I n c a p a b l e A D il sl k, EF nD cE r, yN po tn F D E 206 Redfish resources
Supported Status Codes HTTP Status Code Extended Information 400 STOR003 Error Message Code Supported Action — GetRAIDLevels Description The GetRAIDLevels() method is used to determine the possible choices of RAID Levels to create virtual disks. If the list of physical disks is not provided, this method accesses information for all the connected disks. URL /redfish/v1/Dell/Systems/System.Embedded.1/DellRaidService/Actions/ DellRaidService.
P V a rl au m e e t e r dA LI eD v, eR lA I D 0 , R A I D 1 , R A I D 1 0 , R A I D 5 , R A I D 5 0 , R A I D 6 , R A I D 6 0 A D il sl kP pr ro ot 208 Redfish resources
P V a rl au m e e t e r to oc co ol ls , N V M e , S A S , S A T A M D oK dM e, L K M V R D A P I rD oL pe N v ae m l e, A S ri rz ae y, IS np a n D e p t h , S p a n Redfish resources 209
P V a rl au m e e t e r L e n g t h , S t a r t i n g L B A , T 1 0 P I S t a t u s 4 B l0 o9 c6 k, S 5 i1 z2 e, IA nl B l y t e s TA 1l 0l P , IT S 1 t0 aP tI 210 Redfish resources
P V a rl au m e e t e r uC sa p a b l e , T 1 0 P I I n c a p a b l e D A il sl k, EF nD cE r, yN po tn F D E Supported Status Codes HTTP Status Code Extended Information 400 STOR003 Error Message Code Supported Action — LockVirtualDisk Description The LockVirtualDisk() method encrypts the virtual disk.
URL /redfish/v1/Dell/Systems/System.Embedded.1/DellRaidService/Actions/ DellRaidService.LockVirtualDisk Supported HTTP Method and Privileges HTTP Method Required Privilege POST Login Supported Parameters P V a rl au m e e t e r D A il sl k, TH yD pD e, S S D FA ol rl m , FM a.
P V a rl au m e e t e r R A I D 1 0 , R A I D 5 , R A I D 5 0 , R A I D 6 , R A I D 6 0 A D il sl kP pr ro ot to oc co ol ls , N V M e , S A S , S Redfish resources 213
P V a rl au m e e t e r A T A M D oK dM e, L K M V R D A P I rD oL pe N v ae m l e, A S ri rz ae y, IS np a n D e p t h , S p a n L e n g t h , S t a r t i n g L 214 Redfish resources
P V a rl au m e e t e r B A , T 1 0 P I S t a t u s B 4 l0 o9 c6 k, S 5 i1 z2 e, IA nl B l y t e s TA 1l 0l P , IT S 1 t0 aP tI uC sa p a b l e , T 1 0 P I I n c Redfish resources 215
P V a rl au m e e t e r a p a b l e D A il sl k, EF nD cE r, yN po tn F D E Supported Status Codes HTTP Status Code Extended Information 400 STOR003 Error Message Code Supported Action — ReKey Description The ReKey () method resets the key on the controller that support encryption of the of drives. This method switches the controller mode. URL /redfish/v1/Dell/Systems/System.Embedded.1/DellRaidService/Actions/DellRaidService.
Supported Parameters P V a rl au m e e t e r D A il sl k, TH yD pD e, S S D FA ol rl m , FM a.
P V a rl au m e e t e r , R A I D 5 0 , R A I D 6 , R A I D 6 0 D A il sl kP pr ro ot to oc co ol ls , N V M e , S A S , S A T A D M oK dM e, L K M 218 Redfish resources
P V a rl au m e e t e r V R D A P I rD oL pe N v ae m l e, A S ri rz ae y, IS np a n D e p t h , S p a n L e n g t h , S t a r t i n g L B A , T 1 0 P I S t a Redfish resources 219
P V a rl au m e e t e r t u s B 4 l0 o9 c6 k, S 5 i1 z2 e, IA nl B l y t e s TA 1l 0l P , IT S 1 t0 aP tI uC sa p a b l e , T 1 0 P I I n c a p a b l e A D il sl k, 220 Redfish resources
P V a rl au m e e t e r EF nD cE r, yN po tn F D E Supported Status Codes HTTP Status Code Extended Information 400 STOR003 Error Message Code Supported Action — RemoveControllerKey Description The RemoveControllerKey() method erases the encryption key on controller. CAUTION: All encrypted drives shall be erased. URL /redfish/v1/Dell/Systems/System.Embedded.1/DellRaidService/Actions/ DellRaidService.
P V a rl au m e e t e r p, eS S D FA ol rl m , FM a.
P V a rl au m e e t e r I D 6 , R A I D 6 0 D A il sl kP pr ro ot to oc co ol ls , N V M e , S A S , S A T A D M oK dM e, L K M V R D A P I rD oL pe N v ae m l e, A S Redfish resources 223
P V a rl au m e e t e r ri rz ae y, IS np a n D e p t h , S p a n L e n g t h , S t a r t i n g L B A , T 1 0 P I S t a t u s 4 B l0 o9 c6 k, S 5 i1 224 Redfish resources
P V a rl au m e e t e r z2 e, IA nl B l y t e s TA 1l 0l P , IT S 1 t0 aP tI uC sa p a b l e , T 1 0 P I I n c a p a b l e A D il sl k, EF nD cE r, yN po tn F D E Redfish resources 225
Supported Status Codes HTTP Status Code Extended Information 400 STOR003 Error Message Code Supported Action — ResetConfig Description The ResetConfig() method is used to delete all the virtual disks and unassign all hot spare physical disks. CAUTION: All data on the existing virtual disks will be lost. URL /redfish/v1/Dell/Systems/System.Embedded.1/DellRaidService/Actions/DellRaidService.
P V a rl au m e e t e r LI eD v, eR lA I D 0 , R A I D 1 , R A I D 1 0 , R A I D 5 , R A I D 5 0 , R A I D 6 , R A I D 6 0 A D il sl kP pr ro ot to Redfish resources 227
P V a rl au m e e t e r oc co ol ls , N V M e , S A S , S A T A M D oK dM e, L K M V R D A P I rD oL pe N v ae m l e, A S ri rz ae y, IS np a n D e p t h , S p a n L 228 Redfish resources
P V a rl au m e e t e r e n g t h , S t a r t i n g L B A , T 1 0 P I S t a t u s 4 B l0 o9 c6 k, S 5 i1 z2 e, IA nl B l y t e s TA 1l 0l P , IT S 1 t0 aP tI C Redfish resources 229
P V a rl au m e e t e r ua sp a b l e , T 1 0 P I I n c a p a b l e D A il sl k, EF nD cE r, yN po tn F D E Supported Status Codes HTTP Status Code Extended Information 400 STOR003 Error Message Code Supported Action — SetControllerKey Description The SetControllerKey() method is used to set the key on controllers and set the controller in Local key Management (LKM) to encrypt the drives.
URL /redfish/v1/Dell/Systems/System.Embedded.1/DellRaidService/Actions/ DellRaidService.SetControllerKey Supported HTTP Method and Privileges HTTP Method Required Privilege POST Login Supported Parameters P V a rl au m e e t e r D A il sl k, TH yD pD e, S S D FA ol rl m , FM a.
P V a rl au m e e t e r R A I D 1 0 , R A I D 5 , R A I D 5 0 , R A I D 6 , R A I D 6 0 A D il sl kP pr ro ot to oc co ol ls , N V M e , S A S , S 232 Redfish resources
P V a rl au m e e t e r A T A M D oK dM e, L K M V R D A P I rD oL pe N v ae m l e, A S ri rz ae y, IS np a n D e p t h , S p a n L e n g t h , S t a r t i n g L Redfish resources 233
P V a rl au m e e t e r B A , T 1 0 P I S t a t u s B 4 l0 o9 c6 k, S 5 i1 z2 e, IA nl B l y t e s TA 1l 0l P , IT S 1 t0 aP tI uC sa p a b l e , T 1 0 P I I n c 234 Redfish resources
P V a rl au m e e t e r a p a b l e D A il sl k, EF nD cE r, yN po tn F D E Supported Status Codes HTTP Status Code Extended Information 400 STOR003 Error Message Code Supported Action — UnBlinkTarget Description The UnblinkTarget () method is used to stop blinking the light present on the physical disk represented by the Target FQDD. The method is real time, unblink cannot be scheduled as part of a job. URL /redfish/v1/Dell/Systems/System.Embedded.1/DellRaidService/Actions/ DellRaidService.
Supported Parameters P V a rl au m e e t e r D A il sl k, TH yD pD e, S S D FA ol rl m , FM a.
P V a rl au m e e t e r , R A I D 5 0 , R A I D 6 , R A I D 6 0 D A il sl kP pr ro ot to oc co ol ls , N V M e , S A S , S A T A D M oK dM e, L K M Redfish resources 237
P V a rl au m e e t e r V R D A P I rD oL pe N v ae m l e, A S ri rz ae y, IS np a n D e p t h , S p a n L e n g t h , S t a r t i n g L B A , T 1 0 P I S t a 238 Redfish resources
P V a rl au m e e t e r t u s B 4 l0 o9 c6 k, S 5 i1 z2 e, IA nl B l y t e s TA 1l 0l P , IT S 1 t0 aP tI uC sa p a b l e , T 1 0 P I I n c a p a b l e A D il sl k, Redfish resources 239
P V a rl au m e e t e r EF nD cE r, yN po tn F D E Supported Status Codes HTTP Status Code Extended Information 400 STOR003 Error Message Code DellSensorCollection Description A collection of DellSensor resource URL /redfish/v1/Dell/Systems/System.Embedded.1/DellSensorCollection Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login Navigation URL /redfish/v1/Dell/Systems/System.Embedded.
Supported HTTP Method and Privileges H Required Privilege T T P M e t h o d G Login E T Supported Parameters Parameter Value SensorType AirFlow, Counter, Current, Humidity, Intrusion, Lock, Other, PowerConsumption, Pow SmokeDetection, Switch, Tachometer, Temperature, Unknown, Voltage EnabledState Deferred, Disabled, Enabled, EnabledButOffline, InTest, NotApplicable, Other, Quiesce HealthState CriticalFailure, Degraded/Warning, MajorFailure, MinorFailure, NonRecoverableError, DellServiceRoot Descrip
DellSoftwareInstallationService Description The DellSoftwareInstallationService resource provides some actions to support software installation functionality. URL /redfish/v1/Dell/Systems/System.Embedded.
Supported Parameters P V a rl au m e e t e r IO gf nf o, rO en C e r t W a r n i n g P D re of xa yu S l ut pP pr o rx ty , O f f , P a r a m e t e r s P r o x y H P rT oT Redfish resources 243
P V a rl au m e e t e r xP y, TS yO pC eK S A F pa pl ls ye U , pT dr au te e S C hI aF rS e, TF yT pP e, H T T P , H T T P S , N F S , T F T P Supported Status Codes HTTP Status Code Extended Information 400 SUP001 244 Redfish resources Error Message Code
Supported Action — GetRepoBasedUpdateList Supported Action — InstallFromRepository Supported Action — InstallFromURI Supported Action — GetRepoBasedUpdateList Description This method is used for getting the list of packages and a list of devices that will be updated when a particular repository is used. You must run InstallFromRespository command before running GetRepoBasedUpdateList(). If Applyupdate is False, no updates are applied or scheduled.
P V a rl au m e e t e r o rx ty , O f f , P a r a m e t e r s P r o x y P H rT oT xP y, TS yO pC eK S A F pa pl ls ye U , pT dr au te e S C hI aF rS e, TF yT pP e, H 246 Redfish resources
P V a rl au m e e t e r T T P , H T T P S , N F S , T F T P Supported Status Codes HTTP Status Code Extended Information 400 SUP001 Error Message Code Supported Action — InstallFromRepository Description This method creates the list of the updates contained in the repository that are supported by LC and are applicable to the system and installed hardware. The successful execution of this method creates a job.
Supported Parameters P V a rl au m e e t e r IO gf nf o, rO en C e r t W a r n i n g P D re of xa yu S l ut pP pr o rx ty , O f f , P a r a m e t e r s P r o x y H P rT oT 248 Redfish resources
P V a rl au m e e t e r xP y, TS yO pC eK S A F pa pl ls ye U , pT dr au te e S C hI aF rS e, TF yT pP e, H T T P , H T T P S , N F S , T F T P Supported Status Codes HTTP Status Code Extended Information 400 SUP001 Error Message Code Redfish resources 249
Supported Action — InstallFromURI Description InstallFromURI method is used for creating a job for update service. The successful execution of this method creates a job. URL /redfish/v1/Dell/Systems/System.Embedded.1/DellSoftwareInstallationService/Actions/ DellSoftwareInstallationService.
P V a rl au m e e t e r , P a r a m e t e r s P r o x y P H rT oT xP y, TS yO pC eK S A F pa pl ls ye U , pT dr au te e S C hI aF rS e, TF yT pP e, H T T P , H T T Redfish resources 251
P V a rl au m e e t e r P S , N F S , T F T P Supported Status Codes HTTP Status Code Extended Information 400 SUP001 Error Message Code DellSwitchConnection Description An instance of DellSwitchConnection will have the switch connection view information of all the ports. URL /redfish/v1/Dell/Systems/System.Embedded.
H R T e T q P u M i er te h d oP d r i v i l e g e i n DellSwitchConnectionCollection Description A collection of DellSwitchConnection resource URL /redfish/v1/Dell/Systems/System.Embedded.
DellSystem Description An instance of DellSystem will have data representing the overall system devices in the managed system. URL /redfish/v1/Dell/Systems/System.Embedded.
P V a rl au m e e t e r ur p, S O tK a, tU un sk n o w n S D te og r a gd e R d o, lE lr ur po S r t, aO tK u, sU n k n o w n D P S e R g or la ld ue pd S , tE ar tr uo sr , O K , Redfish resources 255
P V a rl au m e e t e r U n k n o w n FD ae ng R r oa ld le ud p, S E tr ar to ur s, O K , U n k n o w n LD ie cg er na sd ie nd g, R E or lr lo ur p, S O tK a, tU un sk n o 256 Redfish resources
P V a rl au m e e t e r w n C D P e U g R r oa ld le ud p, S E tr ar to ur s, O K , U n k n o w n D P oi w s ea rb C l ae pd E, nE an ba lb el de S d t a t e TD e m g pr R a od le Redfish resources 257
P V a rl au m e e t e r ld u, pE S r tr ao tr u, sO K , U n k n o w n S D ye sg M r ea m d P e rd i, m E ar r yo S r t, aO tK u, sU n k n o w n 1 B lU aF du el G l eW oi m d et th , 258 Redfish resources
P V a rl au m e e t e r r1 yU H a l f W i d t h , 1 U Q u a r t e r W i d t h , D u a l W i d t h , F u l l H e i g h t , D u a l W i d t Redfish resources 259
P V a rl au m e e t e r h , H a l f H e i g h t , N o t A p p l i c a b l e , S i n g l e W i d t h , F u l l H e i g h t , S i n g l e 260 Redfish resources
P V a rl au m e e t e r W i d t h , H a l f H e i g h t , S i n g l e W i d t h , Q u a r t e r H e i g h t D B ae tg tr ea rd ye R d o, lE lr ur po Redfish resources 261
P V a rl au m e e t e r S r t, aO tK u, sU n k n o w n V D oe lg tr R a od le ld u, pE S r tr ao tr u, sO K , U n k n o w n DellUpdateService Description This action is used to perform firmware updates. Supported action — Install Description This resource is used to represent extension of the Update Service schema of Redfish.
Starting from the iDRAC version 3.15.15.15 release, you can use this action to update only one component at a time. Although the SoftwareIdentityURIs parameter of the Install OEM action is of the type Collection, only one relative URI of the firmware inventory to be installed is allowed. If you attempt to update multiple components at once, error SYS442 is returned. To update multiple components, perform the updates one at a time. URL /redfish/v1/UpdateService/Actions/Oem/DellUpdateService.
DellvFlashCollection Description A collection of DellvFlash resource URL /redfish/v1/Dell/Managers/iDRAC.Embedded.1/DellvFlashCollection Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e G L Eo Tg i n DellVirtualDisk Description An instance of DellVirtualDisk will have data specific to the Virtual Disks in the system. URL /redfish/v1/Dell/Systems/System.Embedded.1/Storage/Volumes/DellVirtualDisk/ Disk.Virtual.0:RAID.Slot.
Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e G L Eo Tg i n Supported Parameters P V a rl au m e e t e r B F uI sB P R rE o, tP oA cT oA l, S A S , S A T A , S C S I , U S B Redfish resources 265
P V a rl au m e e t e r , U n k n o w n D ie sf ka C u al ct h, eD P i os la ib cl ye d , E n a b l e d , U n k n o w n A R ed a dp C t ai cv he eR P e oa ld iA ch ye 266 Redfish resources
P V a rl au m e e t e r a d , N o R e a d A h e a d , R e a d A h e a d , U n k n o w n L o c k S e td a, tU un sl o c k e d C a c h e c a d Redfish resources 267
P V a rl au m e e t e r de eV D , N o n C a c h e c a d e V D M H ea dr id aD Ti ys pk eD r i v e , S o l i d S t a t e D r i v e , U n k n o w n 268 Redfish resources
P V a rl au m e e t e r W U rn ik tn eo C w an c, hW er P i ot le iB ca yc k , W r i t e B a c k F o r c e , W r i t e T h r o u g h DellVirtualDiskCollection Description A collection of DellVirtualDisk resource.
URL /redfish/v1/Dell/Systems/System.Embedded.1/Storage/Volumes/DellVirtualDiskCollection Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login Drive Description The Drive schema represents a single physical disk drive for a system, including links to associated Volumes. URL /redfish/v1/Systems/System.Embedded.
H R T e T q P u M i er te h d oP d r i v i l e g e s , L o g i n G L Eo Tg i n P C A o Tn C f H i g u r e C o m p o n e n t s , L o g i n Redfish resources 271
Supported Parameters P V a rl au m e e t e r H N o tn se p, aG rl eo Tb ya pl e, D e d i c a t e d , EU n ce rn yc pr ty ip ot ne S d t, aU tn ul so c k e d , L o c k e d , F o 272 Redfish resources
P V a rl au m e e t e r r e g i n , EN no cn re y, pS te il of nE A n bc ir ly ip t yi n g D r i v e , H M eD dD i, aS TS yD p e Supported Status Codes HTTP Status Code Extended Information Error Message Code 202 Redfish resources 273
EthernetInterfaces Description This resource is used to represent NIC resources as part of the Redfish specification. It also updates the properties of Manager Ethernet Interface. NOTE: Only device FQDDs that are associated with physical network controllers are displayed. If iSM is installed and running, and there are only software Ethernet interfaces available on the system, a response code of 200 and an empty collection is returned.
Status codes and error message codes Table 50. Status codes and error message codes for EthernetInterfaces HTTP status code Extended information 200 Base.1.0.success 400 • • • • • 500 Base.1.0.InternalError Base.1.0.PropertyValueTypeError Base.1.0.PropertyValueNotInList Base.1.0.PropertyUnknown Base.1.0.PropertyNotWritable Base.1.0.
URL /redfish/v1/Systems/System.Embedded.1/EthernetInterfaces Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e G L Eo Tg i n EventService Description The Event Service resource contains properties for managing event subcriptions and generates the events sent to subscribers. The resource has links to the actual collection of subscriptions (called Event Destinations). NOTE: You can use the IgnoreCertificateErrors attribute in OEMAttributes to ignore certificate errors.
Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e P C O o S n Tf i g u r e M a n a g e r , L o g i n G L Eo Tg i n P C A o Tn C f H i g u r e M a n a g e r , L Redfish resources 277
H R T e T q P u M i er te h d oP d r i v i l e g e o g i n Supported Action — SubmitTestEvent Contained Resource Subscriptions Supported Action — SubmitTestEvent Description This action is used to generate a test event. URL /redfish/v1/EventService/Actions/EventService.SubmitTestEvent Supported HTTP Method and Privileges HTTP Method Required Privilege POST ConfigureManager, Login FabricCollection Description A Collection of Fabric resource instances.
Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e G L Eo Tg i n Contained resources PCIe PCIe Description The Fabric schema represents a simple fabric consisting of one or more switches, zero or more endpoints, and zero or more zones. URL /redfish/v1/Fabrics/PCIe Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login Contained resources Switches HostInterfaceCollection Description A Collection of HostInterface resource instances.
URL /redfish/v1/Managers/iDRAC.Embedded.1/HostInterfaces Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e G L Eo Tg i n Navigation URL /redfish/v1/Managers/iDRAC.Embedded.
H R T e T q P u M i er te h d oP d r i v i l e g e P A T C H JSONSchemas Description This resource is used for representing the Schema File locator resource for a Redfish implementation. URL /redfish/v1/JSONSchemas HTTP methods and privileges Table 53. HTTP methods and privileges for JSONSchemas HTTP method Required privilege GET Login Status codes Table 54. Status codes for JSONSchemas HTTP status code 200 400 500 LogEntryCollection Description A Collection of LogEntry resource instances.
URL /redfish/v1/Managers/iDRAC.Embedded.1/Logs/FaultList Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e G L Eo Tg i n LogService Description This resource represents the log service for the resource or service to which it is associated. URL /redfish/v1/Managers/iDRAC.Embedded.
Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e P C O l S e Ta r L o g s , L o g i n G L Eo Tg i n P C A o Tn C f H i g u r e M a n a g e r , L o g i n Redfish resources 283
Supported Parameters P V a rl au m e e t e r O W vr ea rp W s rW ih te en P F ou l il c y Supported Status Codes HTTP Status Code Extended Information 204 LogServiceCollection Description A Collection of LogService resource instances. URL /redfish/v1/Managers/iDRAC.Embedded.
Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e G L Eo Tg i n Supported Action — ClearLog Supported Action — ClearLog Description This action is used to clear the log for this Log Service. URL /redfish/v1/Managers/iDRAC.Embedded.1/LogServices/Sel/Actions/LogService.
P V a rl au m e e t e r en P F ou l il c y Supported Status Codes HTTP Status Code Extended Information Error Message Code 204 Manager Description A Collection of Manager resource instances.
Supported Parameters Parameter Value ManagerType BMC Supported Status Codes HTTP Status Code Extended Information Error Message Code 400 MalformedJSON SYS405 400 Base.1.2.PropertyValueNotInList SYS426 204 400 SYS406 400 PropertyValueTypeError 403 InsufficientPrivilege 403 RAC0506 LIC501 404 Base.1.2.ResourceMissingAtURI SYS403 500 Base.1.2.
HTTP Status Code Extended Information 400 PropertyValueTypeError 403 InsufficientPrivilege Error Message Code RAC0506 403 LIC501 404 Base.1.2.ResourceMissingAtURI SYS403 500 Base.1.2.InternalError SYS446 ManagerAccountCollection Description This resource represents the BMC user accounts collection for a Redfish implementation. URL /redfish/v1/Managers//Accounts HTTP methods and privileges Table 55.
Status codes Table 58. Status codes for the instance of the resource HTTP status code Error message code 200 400 • • RAC0288 RAC0291 404 500 Role ManagerNetworkProtocol Description This resource is used to obtain or modify the network services managed by a given manager. URL /redfish/v1/Managers/iDRAC.Embedded.
Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e G L Eo Tg i n Navigation URL /redfish/v1/Systems/System.Embedded.
H R T e T q P u M i er te h d oP d r i v i l e g e C o m p o n e n t s G L Eo Tg i n Supported Parameters P V a rl au m e e t e r EN ro rE oC rC C S oi rn rg el ce tB i ot nE C C M u l t Redfish resources 291
P V a rl au m e e t e r i B i t E C C A d d r e s s P a r i t y M R eO m M oS rD yR D A eM vD iD cR eD TD yR p2 eD D R 3 D D R 4 M n eu m l ol r y M e d i a 292 Redfish resources
P V a rl au m e e t e r O N pu el rl a t i n g M e m o r y M o d e s B N au sl el M o d u l e T y p e M n eu m l ol r y T y p e Supported Status Codes HTTP Status Code Extended Information Error Message Code 405 Base.1.2.GeneralError IDRAC.1.6.
Supported Action — MemoryMetrics Description MemoryMetrics contains usage and health statistics for a single Memory module or device instance. URL /redfish/v1/Systems/System.Embedded.1/Memory/iDRAC.Embedded.1%23DIMMSLOTA1/Metrics Supported HTTP Method and Privileges HTTP Method Required Privilege POST Login, ConfigureComponents Supported Status Codes HTTP Status Code Extended Information Error Message Code 405 Base.1.2.GeneralError IDRAC.1.6.
Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e G E T Messages Description This resource is used to represent a Event and Error message registry for a Redfish implementation. URL /redfish/v1/Registries/Messages HTTP methods and privileges Table 59. HTTP methods and privileges for Messages HTTP method Required privilege GET Login Status codes Table 60.
NetworkAdapterCollection Description A Collection of NetworkAdapter resource instances. NOTE: The Manufacturer, Model, Serial Number, and Part Number attributes are not applicable for embedded NICs. URL /redfish/v1/Systems/System.Embedded.1/NetworkAdapters Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login NetworkDeviceFunctions Description This resource is used to represent the collection of NetworkDeviceFunction. URL /redfish/v1/Systems/System.Embedded.
NetworkDeviceFunctions — Instance Description This resource is used to represent a logical interface exposed by the network adapter. URL /redfish/v1/Systems/System.Embedded.1/NetworkAdapters/ HTTP methods and privileges Table 64. HTTP methods and privileges for the instance of NetworkDeviceFunctions HTTP method Required privilege GET Login Status codes Table 65.
Parameter Type Description NOTE: The values of NetDevFuncCapabilities are determined by the port that the partition belongs to. The values of NetDevFuncCapabilities for all the partitions belonging to a particular port are the same. NetDevFuncType NetworkDeviceFunction.v1_0_0.NetworkDe The configured capability of this network viceTechology device function. FibreChannel WWPN String The effective current World-Wide Port Name (WWPN) of this network device function (physical function).
Parameter Type Description the OS driver when booting. The value only takes effect on boot. iSCSIBoot IPAddressType NetworkDeviceFunction.v1_0_0.IPAddressT The type of IP address (IPv6 or IPv4) being ype populated in the iSCSIBoot IP address fields. Mixing of IPv6 and IPv4 addresses on the same network device function shall not be permissible. InitiatorIPAddress String The IPv6 or IPv4 address of the iSCSI boot initiator. InitiatorName String The iSCSI boot initiator name.
Parameter Type Description IPMaskDNSViaDHCP Boolean A boolean indicating whether the iSCSI boot initiator uses DHCP to obtain the iniator name, IP address, and netmask. AuthenticationMethod NetworkDeviceFunction.v1_0_0.Authentica The iSCSI boot authentication method for tionMethod this network device function. CHAPUsername String The username for CHAP authentication. CHAPSecret String The shared secret for CHAP authentication. Extended information Error message code Status codes Table 68.
Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e G L Eo Tg i n PCIeDevice Description This is the schema definition for the PCIeDevice resource. It represents the properties of a PCIeDevice attached to a System. URL /redfish/v1/Systems/System.Embedded.1/PCIeDevice/ NOTE: Response for a Get operation for PCIe device will not report Part number or Model for any entry.
URL /redfish/v1/Systems/System.Embedded.1/PCIeFunction/ NOTE: If you execute Get on the above URL, the properties Bus /Device/ Function are not displayed. However, their value is displayed in the format for property id (for example <24-0-1>). Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login Port Description Port contains properties describing a port of a PCIE switch.
Power Description This is the schema definition for the Power Metrics. It represents the properties for Power Consumption and Power Limiting. URL /redfish/v1/Chassis/System.Embedded.1/Power Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login Reference Properties PowerControl Voltage PowerControl Description This is the base type for addressable members of an array. URL /redfish/v1/Chassis/System.Embedded.
Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e P C O o S n Tf i g u r e M a n a g e r , L o g i n G L Eo Tg i n P C A o Tn C f H i g u r e M a n a g e r , L o 304 Redfish resources
H R T e T q P u M i er te h d oP d r i v i l e g e g i n PrivilegeRegistry Description This is the schema definition for Operation to Privilege mapping. The Privileges displayed for each entity are in accordance to the capabilities furnished in the corresponding schema and does not mandatorily imply support for that operation in the implementation. URL /redfish/v1/Managers/iDRAC.Embedded.
Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e G L Eo Tg i n Navigation URL /redfish/v1/Systems/System.Embedded.
Role Description This resource defines a user role to be used in conjunction with a Manager Account. URL /redfish/v1/Managers/iDRAC.Embedded.1/Roles/None Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login RoleCollection Description A Collection of Role resource instances. URL /redfish/v1/Managers/iDRAC.Embedded.
SecureBoot Description This resource contains UEFI Secure Boot information. It represents properties for managing the UEFI Secure Boot functionality of a system. URL /redfish/v1/Systems/System.Embedded.1/SecureBoot Supported HTTP Method and Privileges HTTP Method Required Privilege POST ConfigureComponents, Login GET Login PATCH ConfigureComponents, Login Supported Status Codes HTTP Status Code Extended Information 200 Base.1.0.Success 400 Base.1.0.
Supported Status Codes HTTP Status Code Extended Information 200 Base.1.0.Success 400 Base.1.0.PropertyValueTypeError Error Message Code Base.1.0.PropertyValueNotInList 403 Base.1.0. InsufficientPrivilege 404 Base.1.0.ResourceMissingAtURI 500 Base.1.0.InternalError SecureErase Description This action is used to securely erase the contents of the drive. URL /redfish/v1/Systems/System.Embedded.1/Storage/Drives/Disk.Direct.0-0:AHCI.Embedded.2-1/ Actions/Drive.
H R T e T q P u M i er te h d oP d r i v i l e g e e n t s , L o g i n G L Eo Tg i n P C A o Tn C f H i g u r e C o m p o n e n t s , L o g i n 310 Redfish resources
Supported Parameters P V a rl au m e e t e r H N o tn se p, aG rl eo Tb ya pl e, D e d i c a t e d , EU n ce rn yc pr ty ip ot ne S d t, aU tn ul so c k e d , L o c k e d , F o Redfish resources 311
P V a rl au m e e t e r r e g i n , EN no cn re y, pS te il of nE A n bc ir ly ip t yi n g D r i v e , H M eD dD i, aS TS yD p e Supported Status Codes HTTP Status Code 202 312 Redfish resources Extended Information Error Message Code
SerialInterface Description A Collection of SerialInterface resource instances. URL /redfish/v1/Managers/iDRAC.Embedded.1/SerialInterfaces Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e G L Eo Tg i n Navigation URL /redfish/v1/Managers/iDRAC.Embedded.
Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e P C O o S n Tf i g u r e M a n a g e r , L o g i n G L Eo Tg i n P C A o Tn C f H i g u r e M a n a g e r , L 314 Redfish resources
H R T e T q P u M i er te h d oP d r i v i l e g e o g i n Supported Parameters P V a rl au m e e t e r FH la or w d C w oa nr te r o l S R is g2 n3 a2 l T y p e P C i ns O c uo t P N ao r Redfish resources 315
P V a rl au m e e t e r in te y ServiceRoot Description This object represents the root Redfish service. URL /redfish/ Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e G E T Session URL /redfish/v1/Sessions Description This resource is used to represent a session for a Redfish implementation.
HTTP methods and privileges Table 69. HTTP methods and privileges for Session HTTP method Required privilege GET Login POST ConfigureManager Updatable properties Table 70. Properties and values for Session Parameter Description UserName Username Password Password Status codes Table 71. Status codes for Session HTTP status code Extended information 200 201 400 • • • • • 500 Base.1.0.InternalError Base.1.0.PropertyValueTypeError Base.1.0.PropertyValueNotInList Base.1.0.PropertyUnknown Base.
Status codes Table 73. Status codes for Delete HTTP status code 200 400 500 SessionService Description This is the schema definition for the Session Service. It represents the properties for the service itself and has links to the actual list of sessions.
Status codes Table 75. Status codes for SimpleStorage HTTP status code Extended information 200 400 403 Insufficient privileges. 500 SoftwareInventoryCollection Description Collection of Firmware Inventory. URL /redfish/v1/UpdateService/FirmwareInventory Supported HTTP Method and Privileges HTTP Method Required Privilege POST ConfigureComponents, Login GET Login Status codes Table 76.
HTTP status code Extended information Error message code 503 SUP0108 Navigation URL /redfish/v1/UpdateService/FirmwareInventory/ Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login Status codes Table 77. Status codes for the action HTTP status code Extended information Error message code 200 400 • • • SYS406 OSD35 RAC0604 400 Base.1.2.InternalError SYS446 403 InsufficientPrivilege RAC0506 404 Base.1.2.
Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e G L Eo Tg i n Navigation URL /redfish/v1/Systems/System.Embedded.1/Storage/ Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login StorageController Description This schema defines a storage controller and its respective properties. A storage controller represents a storage device (physical or virtual) that produces Volumes. URL /redfish/v1/Systems/System.Embedded.
Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e P C O o S n Tf i g u r e C o m p o n e n t s , L o g i n L G Eo Tg i n P C A o Tn C f H i g u r e C o m p o n 322 Redfish resources
H R T e T q P u M i er te h d oP d r i v i l e g e e n t s , L o g i n Subscriptions Description This property contains a URL to the destination where the events are sent. URL /redfish/v1/EventService/Subscriptions HTTP methods and privileges Table 78. HTTP methods and privileges for EventDestination HTTP method Required privilege GET Login POST ConfigureManager Properties Table 79.
Status codes Table 80. Status codes for EventDestination HTTP status code Extended information 200 201 400 • • • • • 404 Base.1.0.ResourceMissingAtURI 500 Base.1.0.InternalError Base.1.0.PropertyValueTypeError Base.1.0.PropertyValueNotInList Base.1.0.PropertyUnknown Base.1.0.PropertyNotWritable Base.1.0.PropertyValueFormatError 503 Switches Description A Collection of Switch resource instances.
TaskCollection Description A Collection of Task resource instances. URL /redfish/v1/TaskService/Tasks Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e G L Eo Tg i n TaskService Description This is the schema definition for the Task Service. It represents the properties for the service itself and has links to the actual list of tasks.
Thermal Description This is the schema definition for the Thermal properties. It represents the properties for Temperature and Cooling. URL /redfish/v1/Chassis/Chassis.Embedded.
H R T e T q P u M i er te h d oP d r i v i l e g e C f H i g u r e M a n a g e r , L o g i n Supported Parameters P V a rl au m e e t e r R eP aM d i n g U n i t s Reference Properties Temperature Redfish resources 327
Temperature Description Above normal range. URL /redfish/v1/Chassis/System.Embedded.
H R T e T q P u M i er te h d oP d r i v i l e g e e M a n a g e r , L o g i n Supported Parameters P V a rl au m e e t e r R eP aM d i n g U n i t s UpdateService Description This is the schema definition for the Update Service. It represents the properties for the service itself and has links to collections of firmware and software inventory.
URL /redfish/v1/UpdateService Supported HTTP Method and Privileges HTTP Method Required Privilege GET Login POST ConfigureComponents, Login Supported Status Codes HTTP Status Code Extended Information Error Message Code 200 Supported action — SimpleUpdate Description This resource is used to represent extension of the UpdateService schema of Redfish. You can use the this action to update only one component at a time. If you attempt to update multiple components at once, error SYS442 is returned.
HTTP status code Extended information Error Message Code • • SUP024 SYS442 400 • • • • 400 Base.1.2.MalformedJSON SYS405 403 InsufficientPrivilege RAC0506 Base.1.2.InternalError Base.1.2.PropertyMissing Base.1.2.PropertyValueTypeError Base.1.2.PropertyValueNotInList 403 404 LIC501 Base.1.2. ResourceMissingAtURI 405 500 SYS446 SYS403 SYS402 Base.1.2.
HTTP status code Extended information 500 Properties and values Table 85. Properties and values for VirtualMedia Property Values MediaTypes • • • CD DVD USBStick ConnectedVia • • NotConnected Applet VLanNetworkInterface Description The value of this property indicates if VLAN is enabled for this interface. URL /redfish/v1/Systems//EthernetInterfaces//Vlans HTTP methods and response content type Table 86.
URL /redfish/v1/Systems/System.Embedded.1/Storage/AHCI.Embedded.2-1/Volumes Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e P C O o S n Tf i g u r e C o m p o n e n t s , L o g i n L G Eo Tg i n Navigation URL /redfish/v1/Systems/System.Embedded.
Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e D C Eo Ln Ef Ti Eg u r e C o m p o n e n t s , L o g i n C P O o S n Tf i g u r e C o m p o n e n t s , L 334 Redfish resources
H R T e T q P u M i er te h d oP d r i v i l e g e o g i n G L Eo Tg i n P C A o Tn C f H i g u r e C o m p o n e n t s , L o g i n Redfish resources 335
Supported Parameters P V a rl au m e e t e r V R oa lw uD m e ev Ti yc pe e, N o n R e d u n d a n t , M i r r o r e d , S t r i p e d W i t h P a r i t y , S p a 336 Redfish resources
P V a rl au m e e t e r n n e d M i r r o r s , S p a n n e d S t r i p e s W i t h P a r i t y EN na ct ri yv pe tD ir oi nv Te yE pn ec sr y p t i Redfish resources 337
P V a rl au m e e t e r o n , C o n t r o l l e r A s s i s t e d , S o f t w a r e A s s i s t e d Supported Status Codes HTTP Status Code Extended Information 200 200 Base.1.0.
Supported Action — CheckConsistency Description URL /redfish/v1/Systems/System.Embedded.1/Storage/Volumes/Disk.Direct.0-0:AHCI.Embedded.2-1/ Actions/Volume.
Parameter V a l u e d W i t h P a r i t y , S p a n n e d M i r r o r s , S p a n n e d S t r i p e s W i t h P a r i t y EncryptionTypes 340 Redfish resources N a t i v e D r
Parameter V a l u e i v e E n c r y p t i o n , C o n t r o l l e r A s s i s t e d , S o f t w a r e A s s i s t e d Supported Status Codes HTTP Status Code Extended Information 200 Base.1.0.
Supported Action — Initialize Description This action is used to prepare the contents of the volume for use by the system. URL /redfish/v1/Systems/System.Embedded.1/Storage/Volumes/Disk.Direct.0-0:AHCI.Embedded.2-1/ Actions/Volume.
P V a rl au m e e t e r t r i p e d W i t h P a r i t y , S p a n n e d M i r r o r s , S p a n n e d S t r i p e s W i t h P a r i t y Redfish resources 343
P V a rl au m e e t e r EN na ct ri yv pe tD ir oi nv Te yE pn ec sr y p t i o n , C o n t r o l l e r A s s i s t e d , S o f t w a r e A s s i s t 344 Redfish resources
P V a rl au m e e t e r e d Supported Status Codes HTTP Status Code Extended Information Error Message Code 200 200 Base.1.0.Success NetworkPort Description A Network Port represents a discrete physical port capable of connecting to a network. URL /redfish/v1/Systems/System.Embedded.1/NetworkAdapters/NIC.Embedded.2/NetworkPorts/ NIC.Embedded.
H R T e T q P u M i er te h d oP d r i v i l e g e P A T C H Supported Parameters P V a rl au m e e t e r LD io nw kn S , tU ap t u s S W ua pk pe oO rn tL eA dN E, tE hE eE r n e t C a p a 346 Redfish resources
P V a rl au m e e t e r b i l i t i e s NetworkPortCollection Description A Collection of NetworkPort resource instances. URL /redfish/v1/Systems/System.Embedded.1/NetworkAdapters/NIC.Embedded.1/NetworkPorts Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e G L Eo Tg i n NetworkDeviceFunctionCollection Description A Collection of NetworkDeviceFunction resource instances.
URL /redfish/v1/Systems/System.Embedded.1/NetworkAdapters/NIC.Embedded.1/NetworkDeviceFunctions Supported HTTP Method and Privileges H R T e T q P u M i er te h d oP d r i v i l e g e G L Eo Tg i n Redundancy Description This is the redundancy definition to be used in other resource schemas. URL /redfish/v1/Chassis/System.Embedded.1/Thermal/Redundancy/ iDRAC.Embedded.
4 Examples NOTE: For more information about Redfish and detailed examples, see the white papers available at https:// www.dmtf.org/standards/redfish. The following table provides usage examples for the HTTP supported methods such as GET, POST, PATCH, and DELETE: Topics: • • • • • • • • Example for GET Example for PATCH Example for POST Example for DELETE Example of Job Creation Examples for $expand Examples for $select Examples for $filter Example for GET URL Output /redfish/v1/Managers/iDRAC.Embedded.
} } Example for POST URL /redfish/v1/Systems/System.Embedded.1/Actions/ComputerSystem.Reset Input {"ResetType":"ForceRestart"} Output 204: No Content Example for DELETE URL /redfish/v1/EventService/Subscriptions/ Output 200 Ok { "INFO": " subscription deleted successfully" } Example of Job Creation Request Method POST URI https://100.101.18.90/redfish/v1/Managers/iDRAC.Embedded.
Headers OData-Version: 4.0 Keep-Alive: timeout=60, max=199 Content-Type: application/json;odata.metadata=minimal;charset=utf-8 Server: Appweb/4.5.4 Location: /redfish/v1/Managers/iDRAC.Embedded.1/Jobs/JID_471269252011 Date: Thu, 06 Jan 2000 02:48:49 GMT Cache-Control: no-cache Content-Length: 501 Connection: Keep-Alive Access-Control-Allow-Origin: * Accept-Ranges: bytes BODY { } "@Message.ExtendedInfo": [ { "Message": "Successfully Completed Request", "MessageArgs": [], "MessageArgs@odata.
Resource Type Example • https:///redfish/v1/Chassis/System.Embedded.1?$select=Assembly • https:///redfish/v1/Chassis/System.Embedded.1?$select=Links/ ComputerSystems • https:///redfish/v1/Chassis/System.Embedded.1?$select=Links/Oem/ Dell/DellEnclosureEMMCollection • https:///redfish/v1/Chassis/System.Embedded.1?$select=Location/ Placement • https:///redfish/v1/Chassis/System.Embedded.1?$select=Location/ Placement/Rack • https:///redfish/v1/Chassis/System.Embedded.
