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
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
/redfish/v1/Managers/iDRAC.Embedded.1/SerialInterfaces
Output
{
"@odata.context": "/redfish/v1/$metadata#Managers/Members/
iDRAC.Embedded.1/SerialInterfaces/$entity",
"@odata.count": 1,
"@odata.id": "/redfish/v1/Managers/iDRAC.Embedded.1/SerialInterfaces",
"@odata.type": "#SerialInterface.1.0.0.SerialInterfaceCollection",
"Description": "Collection of Serial Interfaces for this System",
"Members": [
{
"@odata.id": "/redfish/v1/Managers/iDRAC.Embedded.1/
SerialInterfaces/iDRAC.Embedded.1#Serial.1"
}
],
"Name": "Serial Interface Collection"
}
Example for PATCH
URL
/redfish/v1/Managers/iDRAC.Embedded.1/Accounts/<Account-id>
Input
{"Password": "123","UserName": "reader"}
Output
{
"Success": {
"Message": "Successfully Completed Request",
"MessageId": "Base.1.0.Success",
"Resolution": "None",
"Severity": "Ok"
4
122 Examples