iDRAC9 Redfish API Guide Firmware version: 4.20.20.20

PDF

Supported Action — BackupImage

Description

The BackupImage action is used for backing-up the firmware and configurations for Lifecycle Controller.

URL

/redfish/v1/Dell/Managers/<Manager-Id>/DellLCService/Actions/DellLCService.BackupImage

Supported HTTP Method and Privileges


HTTP Method	Required Privilege
POST	Login

Action Parameters


Parameter	Type	Value	Description
CheckBackupDestinationAvailability	String	Check, DoNotCheck	Check backup destination availability. Default is Check.
IPAddress	String		The IP address for the network share for the backup image. This is a required parameter when ShareType is specified as NFS or CIFS.
IgnoreCertWarning	String	Off, On	Specifies if certificate warning should be ignored when HTTPS is specified. Default is On.
ImageName	String
JobName	String		A name for the job. Default is 'Backup:Image'.
Passphrase	String		The passphrase for the backup image. This parameter is required if ShareType is NFS or CIFS.
Password	String		The password to access the network share.
ProxyPasswd	String		The password for the proxy server.
ProxyPort	String		Port for the proxy server. Default is set to 80.
ProxyServer	String		The IP address of the proxy server.
ProxySupport	String	DefaultProxy, Off, ParametersProxy	Specifies if proxy should be used. Default is Off.
ProxyType	String	HTTP, SOCKS	The proxy type of the proxy server. Default is HTTP.
ProxyUname	String		The user name for the proxy server.
ScheduledStartTime	String		The start time for the job execution in format: yyyymmddhhmmss. The String "TIME_NOW" means immediate.
ShareName	String		Share name for the network share such as “imageshare”. The parameter shall be required, if the ShareType parameter has value NFS, CIFS, or not specified. Sharename shall be considered as a path to a sub-folder in case of HTTP/HTTPS.
ShareType	String	CIFS, HTTP, HTTPS, Local, NFS, VFLASH	If ShareType is blank or null, it shall be considered as NFS type. The parameter shall be required, if the ShareType parameter has value NFS, CIFS, or not specified.
UntilTime	String		End time for the job execution in format: yyyymmddhhmmss. : If this parameter is not NULL, then ScheduledStartTime parameter shall also be specified.
UserName	String		The user name for the remote share
Workgroup	String		The Workgroup for the share.

Supported Status Codes


HTTP Status Code	Extended Information	Error Message Code
200
400	Maximum job limit reached, cannot create new jobs	JCP017
400	<null>	JCP018, JCP019, LC002, LC017, LC023, LC051, SUP017, SUP018