Validate Backup Configurations Operations
Validation API for backup configuration for SDDC Manager and NSX Manager
{
"encryption": {
"passphrase": "string"
},
"backupLocations": [
{
"server": "string",
"port": 0,
"protocol": "SFTP",
"username": "string",
"password": "string",
"directoryPath": "string",
"sshFingerprint": "string"
}
],
"backupSchedules": [
{
"resourceType": "SDDC_MANAGER",
"takeScheduledBackups": true,
"frequency": "One among: WEEKLY, HOURLY",
"daysOfWeek": [
"One among: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY"
],
"hourOfDay": 0,
"minuteOfHour": 0,
"takeBackupOnStateChange": true,
"retentionPolicy": {
"numberOfMostRecentBackups": 15,
"numberOfDaysOfHourlyBackups": 10,
"numberOfDaysOfDailyBackups": 20
}
}
]
}
Accepted
{
"id": "string",
"name": "string",
"localizableDescriptionPack": {
"component": "string",
"messageKey": "string",
"arguments": [
"string"
],
"message": "string",
"bundle": "string"
},
"type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION",
"status": "One among: PENDING, IN_PROGRESS, In Progress, SUCCESSFUL, Successful, FAILED, Failed, CANCELLED, Cancelled, COMPLETED_WITH_WARNING, SKIPPED",
"creationTimestamp": "string",
"completionTimestamp": "string",
"subTasks": [
{
"name": "string",
"type": "string",
"description": "string",
"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, NOT_APPLICABLE",
"creationTimestamp": "string",
"completionTimestamp": "string",
"stages": [
{
"name": "string",
"type": "string",
"description": "string",
"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"creationTimestamp": "string",
"completionTimestamp": "string",
"errors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string"
}
]
}
],
"errors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string"
}
],
"resources": [
{
"resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
"fqdn": "sfo-vc01.rainpole.io",
"type": "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER, NSX_ALB, ESXI",
"name": "string",
"sans": [
"sfo-vc01.rainpole.io"
]
}
],
"subTasks": [
"SubTask Object"
]
}
],
"errors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string"
}
],
"resources": [
{
"resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
"fqdn": "sfo-vc01.rainpole.io",
"type": "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER, NSX_ALB, ESXI",
"name": "string",
"sans": [
"sfo-vc01.rainpole.io"
]
}
],
"resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
"isCancellable": false,
"isRetryable": false
}
Task ID
Task name
A message pack representing a localizable message and suitable for machine processing. Contains a message key unique in the scope of the specified component, as well as the arguments needed to generate the localized message.
Operation that is represented by the Task in machine readable format. The value is controlled by the owners/producers of the Task. The convention is
Task status
Task creation timestamp
Task completion timestamp
Resolution state
Represents task can be cancellable or not.
Indicates whether a task is eligible for retry or not.
Bad Request
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string"
}
The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
The localized error message
The localized remediation error message
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
Internal server error
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string"
}
The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
The localized error message
The localized remediation error message
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.