Create Reconciliation Job
Initiate reconciliation.
Request
URLURL
https://{api_host}/api/appliance/recovery/reconciliation/job
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
{
"ignore_warnings": false,
"sso_admin_user_name": "string",
"sso_admin_user_password": "string"
}
boolean
ignore_warnings
Optional
Flag indicating whether warnings should be ignored during reconciliation. If unset, validation warnings will fail the reconciliation operation.
string
sso_admin_user_name
Optional
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.
string
sso_admin_user_password
Optional
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
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
201 Created returns
RecoveryReconciliationJobInfo of type application/json
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"
}
}
string
service
Required
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.
string
operation
Required
Name of the operation associated with the task.
integer
progress
Required
The progress of the job as a percentage.
status
Required
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
boolean
cancelable
Optional
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.
object
error
Optional
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).
string
parent
Optional
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.
string
end_time
Optional
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.
string
start_time
Optional
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.
target
Optional
Identifier of the target resource the operation modifies. This field will be unset if the task has multiple targets or no target.
Errors
400
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.
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
$RecoveryReconciliationJobCreateSpec = Initialize-RecoveryReconciliationJobCreateSpec -SsoAdminUserName "MySsoAdminUserName" -SsoAdminUserPassword "MySsoAdminUserPassword" -IgnoreWarnings $false
Invoke-CreateRecoveryReconciliationJob -RecoveryReconciliationJobCreateSpec $RecoveryReconciliationJobCreateSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"ignore_warnings":false,"sso_admin_user_name":"string","sso_admin_user_password":"string"}' https://{api_host}/api/appliance/recovery/reconciliation/job
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: create
Availability
Added in 6.7
