Vcenter NamespaceManagement Supervisors Recovery Backup Jobs create
Initiate a Supervisor Backup job. The Backup captures Supervisor Control plane state that includes a snapshot of etcd, required certificates and container images for infrastructure components. Once the job succeeds, corresponding Backup archive will be stored on vCenter Appliance file system. These Backup archives can be looked up and managed using operations provided by Vcenter NamespaceManagement Supervisors Recovery Backup Archives resource and can be used to restore the Supervisor using POST /vcenter/namespace-management/supervisors/{supervisor}/recovery/restore/jobs/{archive}.
This operation was added in vSphere API 8.0.3.0.
Returns an authorization error if you do not have all of the privileges described as follows:
- The resource
com.vmware.vcenter.namespace_management.supervisor.Supervisorreferenced by the parameter supervisor requiresNamespaces.Backup.
Identifier for the Supervisor.
The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.
Specifies input parameters for backup create job.
{
"comment": "string",
"ignore_health_check_failure": false
}Comment to help identify resulting Backup archive.
This property was added in vSphere API 8.0.3.0.
If missing or null comment will be empty.
Ignore Supervisor health check failure when taking Supervisor backup. Supervisor is considered unhealthy if either Vcenter NamespaceManagement Supervisors Summary Info.config_status or Vcenter NamespaceManagement Supervisors Summary Info.kubernetes_status value, as returned by GET /vcenter/namespace-management/supervisors/{supervisor}/summary operation is set to ERROR.
This property was added in vSphere API 8.0.3.0.
if missing or null or set to false, health check failure of Supervisor will not be ignored and will result in POST /vcenter/namespace-management/supervisors/{supervisor}/recovery/backup/jobs operation to report failure.
The task identifier for the backup job. On success, the task's result property will be set to
The response will be an identifier for the resource type: com.vmware.cis.task.
Vapi Std Errors AlreadyExists if a backup job is already pending for the Supervisor.
Vapi Std Errors NotAllowedInCurrentState if Supervisor is not healthy and {#member CreateSpec.ignoreHealthCheckFailure} is not set to true or if Supervisor is not fully enabled yet.
Vapi Std Errors Unsupported if version of the specified Supervisor does not support backup.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
if the user cannot be authenticated.
"Vapi Std Errors Unauthenticated Object"Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.
For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"
This property was added in vSphere API 7.0.0.0.
This property is optional because it was added in a newer version than its parent node.
if the user is missing the Namespaces.Backup privilege on the Supervisor.
"Vapi Std Errors Unauthorized Object"if the given Supervisor cannot be found.
"Vapi Std Errors NotFound Object"if the system reports an error while responding to the request.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/vcenter/namespace-management/supervisors/{supervisor}/recovery/backup/jobs