Create Reconciliation Job
Initiate reconciliation.
Request
URLURL
Header Parameters
Header Parameters
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
{
"ignore_warnings": false,
"sso_admin_user_name": "string",
"sso_admin_user_password": "string"
}
Flag indicating whether warnings should be ignored during reconciliation. If unset, validation warnings will fail the reconciliation operation.
Administrators username for SSO. If unset 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. If unset SSO authentication will not be used. If the vCenter Server is a management node or an embedded node, authentication is required.
Authentication
Response
Response BodyResponse Body
Info Structure
{
"cancelable": false,
"description": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"end_time": "string",
"error": {},
"messages": [
{
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
}
],
"operation": "string",
"parent": "string",
"progress": 0,
"service": "string",
"start_time": "string",
"status": "NONE",
"target": {
"id": "string",
"type": "string"
}
}
Name of the service containing the operation. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.appliance.recovery.reconciliation.job. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.appliance.recovery.reconciliation.job.
Name of the operation associated with the task.
The progress of the job as a percentage.
The Job.Status enumerated type defines the status values that can be reported for an operation.
NONE : The operation is not running.
RUNNING : The operation is in progress.
SUCCEEDED : The operation completed successfully.
FAILED : The operation failed.
Possible values are: NONE , RUNNING , SUCCEEDED , FAILED
Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses. If unset, the operation cannot be canceled.
Description of the error if the operation status is “FAILED”. If unset the description of why the operation failed will be included in the result of the operation (see Info#result).
Parent of the current task. This field will be unset if the task has no parent. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.appliance.recovery.reconciliation.job. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.appliance.recovery.reconciliation.job.
Time when the operation is completed. This field is optional and it is only relevant when the value of Job.Info.status is one of SUCCEEDED or FAILED.
Time when the operation is started. This field is optional and it is only relevant when the value of Job.Info.status is one of RUNNING, SUCCEEDED, or FAILED.
Identifier of the target resource the operation modifies. This field will be unset if the task has multiple targets or no target.
Errors
com.vmware.vapi.std.errors.feature_in_use : A backup or restore is already in progress. | com.vmware.vapi.std.errors.not_allowed_in_current_state : Reconciliation is allowed only after restore has finished successfully. | com.vmware.vapi.std.errors.invalid_argument : The request cannot be fulfilled due to bad syntax.
com.vmware.vapi.std.errors.error : if any error occurs during the execution of the operation.
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
cURL Command
Vendor Extensions
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/appliance/recovery/reconciliation/job
x-vmw-doc-operation: create