API Guide
Table Of Contents
- iDRAC8 with Lifecycle Controller Version 2.70.70.70 Redfish API Guide
- Contents
- Overview
- Redfish-based systems management
- Redfish resources
- AccountService
- DellJobCollection
- AttributeRegistry
- BaseMessages
- AssemblyCollection
- Chassis
- ComputerSystem
- DellJob
- EventDestination
- Bios
- BIOS-Settings resource
- BootOption
- ChassisCollection
- ComputerSystemCollection
- LogEntry
- Manager
- ManagerAccount
- Memory collection
- DellBootSources
- Settings resource
- DellBootSourcesRegistry
- DellUpdateService
- DellManager
- Drive
- EthernetInterfaceCollection
- NetworkAdapter collection
- NetworkInterface collection
- EthernetInterfaces
- EventService
- FabricCollection
- PCIe
- HostInterfaceCollection
- JSONSchemas
- LogEntryCollection
- LogService
- LogServiceCollection
- ManagerCollection
- ManagerAccountCollection
- ManagerNetworkProtocol
- MemoryCollection
- MessageRegistryFile
- MessageRegistryFileCollection
- Messages
- NetworkAdapterCollection
- NetworkInterfaceCollection
- PCIeDevice
- PCIeFunction
- Processor
- Port
- PortCollection
- Power
- PrivilegeRegistry
- ProcessorCollection
- Role
- RoleCollection
- SecureBoot
- SerialInterfaceCollection
- ServiceRoot
- Session
- SessionService
- SimpleStorage
- SoftwareInventoryCollection
- SerialInterfaces
- StorageCollection
- Storage collection
- Subscriptions
- Switches
- TaskCollection
- TaskService
- Thermal
- UpdateService
- VirtualMedia
- VLanNetworkInterface
- VolumeCollection
- NetworkPort
- NetworkPortCollection
- NetworkDeviceFunctionCollection
- Redundancy
- Examples
Chapter 1: Overview...................................................................................................................... 7
New in this release.............................................................................................................................................................. 7
Benefits.................................................................................................................................................................................. 7
Key technologies..................................................................................................................................................................7
Other documents you may need......................................................................................................................................8
Chapter 2: Redfish-based systems management........................................................................... 9
URL support..........................................................................................................................................................................9
Redfish configuration........................................................................................................................................................10
Redfish schema.................................................................................................................................................................. 10
Redfish authentication and authorization.................................................................................................................... 10
Roles and privileges............................................................................................................................................................11
iDRAC licensing................................................................................................................................................................... 11
HTTP methods....................................................................................................................................................................12
HTTP headers..................................................................................................................................................................... 13
HTTP status codes and error messages...................................................................................................................... 13
SSL certificates of iDRAC................................................................................................................................................14
Eventing............................................................................................................................................................................... 14
Eventing operations.....................................................................................................................................................15
Updating firmware using SimpleUpdate....................................................................................................................... 15
Query Parameters..............................................................................................................................................................16
Chapter 3: Redfish resources.......................................................................................................17
AccountService.................................................................................................................................................................. 18
DellJobCollection................................................................................................................................................................19
AttributeRegistry...............................................................................................................................................................20
BaseMessages.................................................................................................................................................................... 21
AssemblyCollection............................................................................................................................................................21
Chassis................................................................................................................................................................................. 22
Supported action — Reset....................................................................................................................................... 24
URL................................................................................................................................................................................. 24
ComputerSystem...............................................................................................................................................................25
Supported action — Reset....................................................................................................................................... 27
DellJob..................................................................................................................................................................................27
EventDestination............................................................................................................................................................... 29
Bios....................................................................................................................................................................................... 30
Supported Action — ChangePassword..................................................................................................................31
Supported Action — ClearPending......................................................................................................................... 31
Supported Action — ResetBios...............................................................................................................................32
BIOS-Settings resource................................................................................................................................................... 32
BootOption..........................................................................................................................................................................33
ChassisCollection...............................................................................................................................................................34
Supported action — Reset....................................................................................................................................... 36
Contained resources...................................................................................................................................................36
Contents
Contents 3