HP Insight Control Server Provisioning 7.2 Administrator Guide

3. Calls backup-appliance() to issue a REST request to start a backup.
4. Calls waitFor-completion() to issue REST requests to poll for backup status until the
backup completes.
5. Calls get-backupResource() to issue a REST request to get the download URI.
6. Calls download-backup() to issue a REST request to download the backup.
The following table provides an overview of the functions in the sample script.
OutputParametersDescriptionFunction
A Json-formatted object that
contains the values needed
to login.
N.A.Gathers information from
user if in manual entry mode
(script ran with zero
queryfor-credentials
arguments) or runs silently
and gathers info from
specified path (script ran
with argument).
A hash table containing the
sessionID
'username': The username
to log into the remote
appliance.
Sends a web request to the
appliance to obtain a
authorized sessionID.
login-appliance
'password': the password
associated with the
username.
'hostname': the appliance to
log in to.
Outputs a hash table
containing the response
'authValue': The authorized
sessionID given by
login-appliance.
Sends a request to start a
backup.
backup-appliance
body from the backup
request.
'hostname': The appliance
address to connect to.
Outputs a hash table
containing the task resource
'taskManager': The response
body from the
backup-appliance function.
Checks the status of the
backup every five seconds
and stops when status
waitFor-completion
which contains the backup
'authValue': The authorized
session ID from
login-appliance.
changes from running to a
different status.
status and a URI to get
detailed information about
the backup.
'hostname': The appliance
to send the request to.
Outputs a hash table
containing the backup
'taskResource': The task
resource that contains the
backup resource URI.
Gets the backup resource
which contains detailed
information about the
get-backupResource
resource which contains the
'authValue': The authorized
session ID.
backup including the URI to
download the backup.
URI to download the backup
file.
'hostname': the appliance to
send the request to.
Outputs a string containing
the absolute path of the
'backupResource': the
backup resource that
Downloads the backup file
from the appliance to the
local system.
download-backup
backup file on the local
system.
contains the URI to
download the backup.
'authValue': The authorized
session ID.
'hostname': The appliance
to send the request to.
16 Backing up and restoring your appliance