This API has a deprecated equivalent from v7.0U1.
Update Backup Schedules
Updates a schedule
Request
URLURL
https://{api_host}/api/appliance/recovery/backup/schedules/{schedule}
Path Parameters
Path Parameters
string
schedule
Required
Identifier of the schedule The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
{
"backup_password": "string",
"enable": false,
"fast_backup": false,
"location": "string",
"location_password": "string",
"location_user": "string",
"parts": [
"string"
],
"recurrence_info": {
"days": "MONDAY",
"hour": 0,
"minute": 0
},
"retention_info": {
"max_count": 0
}
}
string
backup_password
Optional
Password for a backup piece. The backupPassword must adhere to the following password requirements: At least 8 characters, cannot be more than 20 characters in length. At least 1 uppercase letter. At least 1 lowercase letter. At least 1 numeric digit. At least 1 special character (i.e. any character not in [0-9,a-z,A-Z]). Only visible ASCII characters (for example, no space). If unset the value will not be changed.
boolean
enable
Optional
Enable or disable a schedule. If unset the value will not be changed.
boolean
fast_backup
Optional
Option to enable Postgres DB/ VCDB fast backup If unset backup will proceed at slow rate
string
location
Optional
URL of the backup location. If unset the value will not be changed.
string
location_password
Optional
Password for the given location. If unset the value will not be changed.
string
location_user
Optional
Username for the given location. If unset the value will not be changed.
array of
string
parts
Optional
List of optional parts. Use the Parts.list operation to get information about the supported parts. If unset the value will not be changed.
recurrence_info
Optional
Recurrence information for the schedule. If unset the infomration will not be changed. See Schedules.RecurrenceInfo
retention_info
Optional
Retention information for the schedule. If unset the information will not be changed. See Schedules.RetentionInfo
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if provided with invalid schedule specification.
500
com.vmware.vapi.std.errors.error : if any error occurs during the execution of the operation.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$RecoveryBackupSchedulesRecurrenceInfo = Initialize-RecoveryBackupSchedulesRecurrenceInfo -Minute 0 -Hour 0 -Days "MONDAY"
$RecoveryBackupSchedulesRetentionInfo = Initialize-RecoveryBackupSchedulesRetentionInfo -MaxCount 0
$RecoveryBackupSchedulesUpdateSpec = Initialize-RecoveryBackupSchedulesUpdateSpec -Parts "MyParts" -BackupPassword "MyBackupPassword" -Location "MyLocation" -LocationUser "MyLocationUser" -LocationPassword "MyLocationPassword" -Enable $false -RecurrenceInfo $RecoveryBackupSchedulesRecurrenceInfo -RetentionInfo $RecoveryBackupSchedulesRetentionInfo -FastBackup $false
Invoke-UpdateScheduleBackup -Schedule "MySchedule" -RecoveryBackupSchedulesUpdateSpec $RecoveryBackupSchedulesUpdateSpec
cURL Command
curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"backup_password":"string","enable":false,"fast_backup":false,"location":"string","location_password":"string","location_user":"string","parts":["string"],"recurrence_info":{"days":"MONDAY","hour":0,"minute":0},"retention_info":{"max_count":0}}' https://{api_host}/api/appliance/recovery/backup/schedules/{schedule}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: put
x-vmw-doc-deprecated-path: /rest/appliance/recovery/backup/schedules/update/{schedule}
x-vmw-doc-operation: update
Availability
Added in 7.0U2
On This Page
Backup Schedules Operations
patch
delete
post
