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
HTTP methods and privileges
Table 136. HTTP methods and privileges for the instance of Volume
HTTP method Required privilege
GET Login
PATCH Login + SystemControl
DELETE Login + SystemControl
Required parameters
Table 137. Required parameters
Parameter Description
Encrypted Whether the volume is encrypted.
@Redfish.SettingsApplyTime Defines when the settings are applied. This is supported on
the Settings URL. — Optional
Status codes
Table 138. Status codes
HTTP status code Extended information Error message code
200
202
400
● Base.1.0.PropertyValueTypeError
● Base.1.0.PropertyUnknown
403 Base.1.0.InsufficientPrivilege RAC0506
405 Base.1.0.GeneralError SYS402
500 Base.1.0.InternalError
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/<StorageController-Id>/Volumes/<Volume-Id>/
Actions/Volume.Initialize
HTTP methods and privileges
Table 139. HTTP methods and privileges for the action
HTTP method Required privilege
POST Login + SystemControl
106 Redfish resources