Appliance Recovery Reconciliation Job create
Initiate reconciliation.
This operation was added in vSphere API 6.7.
CreateSpec Structure
{
"sso_admin_user_name": "string",
"sso_admin_user_password": "string",
"ignore_warnings": false
}Administrators username for SSO.
This property was added in vSphere API 6.7.
If missing or null SSO authentication will not be used. If the vCenter Server is a management node or an embedded node, authentication is required.
Password for SSO admin user.
This property was added in vSphere API 6.7.
If missing or null SSO authentication will not be used. If the vCenter Server is a management node or an embedded node, authentication is required.
Flag indicating whether warnings should be ignored during reconciliation.
This property was added in vSphere API 6.7.
If missing or null, validation warnings will fail the reconciliation operation.
Info Structure
"Appliance Recovery Reconciliation Job Info Object"Description of the operation associated with the task.
This property was added in vSphere API 6.7.
Name of the service containing the operation.
This property was added in vSphere API 6.7.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.appliance.recovery.reconciliation.job. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.appliance.recovery.reconciliation.job.
Name of the operation associated with the task.
This property was added in vSphere API 6.7.
Parent of the current task.
This property was added in vSphere API 6.7.
This property will be missing or null if the task has no parent.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.appliance.recovery.reconciliation.job. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.appliance.recovery.reconciliation.job.
Identifier of the target resource the operation modifies.
This property was added in vSphere API 6.7.
This property will be missing or null if the task has multiple targets or no target.
Status of the operation associated with the task.
For more information see: Appliance Recovery Reconciliation Job Status.
This property was added in vSphere API 6.7.
Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses.
This property was added in vSphere API 6.7.
If missing or null, the operation cannot be canceled.
Description of the error if the operation status is "FAILED".
This property was added in vSphere API 6.7.
If missing or null the description of why the operation failed will be included in the result of the operation (see Info#result).
Time when the operation is started.
This property was added in vSphere API 6.7.
This property is optional and it is only relevant when the value of status is one of Appliance Recovery Reconciliation Job Status.RUNNING, Appliance Recovery Reconciliation Job Status.SUCCEEDED, or Appliance Recovery Reconciliation Job Status.FAILED.
Time when the operation is completed.
This property was added in vSphere API 6.7.
This property is optional and it is only relevant when the value of status is one of Appliance Recovery Reconciliation Job Status.SUCCEEDED or Appliance Recovery Reconciliation Job Status.FAILED.
A list of localized messages.
This property was added in vSphere API 6.7.
The progress of the job as a percentage.
This property was added in vSphere API 6.7.
Vapi Std Errors FeatureInUse A backup or restore is already in progress.
Vapi Std Errors NotAllowedInCurrentState Reconciliation is allowed only after restore has finished successfully.
Vapi Std Errors InvalidArgument
"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 any error occurs during the execution of the operation.
"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/appliance/recovery/reconciliation/job