appliance recovery reconciliation job: create
Initiate reconciliation. This operation was added in vSphere API 6.7.
Request:
HTTP request
POST https://{server}/rest/appliance/recovery/reconciliation/job
Request Body Structure:
{
"spec" : {
"ignore_warnings" : true,
"sso_admin_user_name" : "string",
"sso_admin_user_password" : "secret string"
}
}
"spec" : {
"ignore_warnings" : true,
"sso_admin_user_name" : "string",
"sso_admin_user_password" : "secret string"
}
}
Request Body Parameters:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| spec | create_spec | CreateSpec Structure. |
| spec.sso_admin_user_name | string | Administrators username for SSO. This attribute was added in vSphere API 6.7. Optional. If unset SSO authentication will not be used. If the vCenter Server is a management node or an embedded node, authentication is required. |
| spec.sso_admin_user_password | secret | Password for SSO admin user. This attribute was added in vSphere API 6.7. Optional. If unset SSO authentication will not be used. If the vCenter Server is a management node or an embedded node, authentication is required. |
| spec.ignore_warnings | boolean | Flag indicating whether warnings should be ignored during reconciliation. This attribute was added in vSphere API 6.7. Optional. If unset, validation warnings will fail the reconciliation operation. |
Response:
HTTP Status Code: 200
Representation:
{
"value" : {
"parent" : "obj-103",
"start_time" : "2015-01-01T22:13:05.651Z",
"cancelable" : true,
"service" : "obj-103",
"end_time" : "2015-01-01T22:13:05.651Z",
"description" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
"messages" : [
{
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
{
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
],
"progress" : 1,
"error" : {},
"operation" : "string",
"target" : {
"id" : "obj-103",
"type" : "string"
},
"status" : "NONE"
}
}
"value" : {
"parent" : "obj-103",
"start_time" : "2015-01-01T22:13:05.651Z",
"cancelable" : true,
"service" : "obj-103",
"end_time" : "2015-01-01T22:13:05.651Z",
"description" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
"messages" : [
{
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
{
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
],
"progress" : 1,
"error" : {},
"operation" : "string",
"target" : {
"id" : "obj-103",
"type" : "string"
},
"status" : "NONE"
}
}
Response Type:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| value | info | Info Structure. |
| value.description | localizable_message | Description of the operation associated with the task. This attribute was added in vSphere API 6.7. |
| value.description.id | string | Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog. |
| value.description.default_message | string | The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog. |
| value.description.args | string[] | Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments. |
| value.description.params | list | Named arguments to be substituted into the message template. This attribute was added in vSphere API 7.0.0.0. Optional. Unset means that the message template requires no arguments or positional arguments are used. |
| value.description.localized | string | Localized string value as per request requirements. This attribute was added in vSphere API 7.0.0.0. Optional. when the client has not requested specific locale the implementation may not populate this field to conserve resources. |
| value.service | string | Name of the service containing the operation. This attribute was added in vSphere API 6.7. 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. |
| value.operation | string | Name of the operation associated with the task. This attribute was added in vSphere API 6.7. |
| value.parent | string | Parent of the current task. This attribute was added in vSphere API 6.7. Optional. 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. |
| value.target | dynamic_ID | Identifier of the target resource the operation modifies. This attribute was added in vSphere API 6.7. Optional. This field will be unset if the task has multiple targets or no target. |
| value.target.type | string | The type of resource being identified (for example com.acme.Person). Services that contain operations for creating and deleting resources typically contain a constant specifying the resource type for the resources being created and deleted. The API metamodel metadata services include a service that allows retrieving all the known resource types. |
| value.target.id | string | The identifier for a resource whose type is specified by vapi.std.dynamic_ID.type. When clients pass a value of this structure as a parameter, the field type must contain the actual resource type. When operations return a value of this structure as a result, the field type will contain the actual resource type. |
| value.status | string | Status of the operation associated with the task. This attribute was added in vSphere API 6.7. Defines the status values that can be reported for an operation. This enumeration was added in vSphere API 6.7. Value is one of: NONE: The operation is not running. This constant was added in vSphere API 6.7. RUNNING: The operation is in progress. This constant was added in vSphere API 6.7. SUCCEEDED: The operation completed successfully. This constant was added in vSphere API 6.7. FAILED: The operation failed. This constant was added in vSphere API 6.7. |
| value.cancelable | boolean | Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses. This attribute was added in vSphere API 6.7. Optional. If unset, the operation cannot be canceled. |
| value.error | exception | Description of the error if the operation status is "FAILED". This attribute was added in vSphere API 6.7. Optional. It is only relevant when status has value [FAILED]. If unset the description of why the operation failed will be included in the result of the operation (see Info#result). |
| value.start_time | date_time | Time when the operation is started. This attribute was added in vSphere API 6.7. Optional. It is only relevant when status has value [RUNNING, SUCCEEDED, FAILED]. This field is optional and it is only relevant when the value of status is one of RUNNING, SUCCEEDED, or FAILED. |
| value.end_time | date_time | Time when the operation is completed. This attribute was added in vSphere API 6.7. Optional. It is only relevant when status has value [SUCCEEDED, FAILED]. This field is optional and it is only relevant when the value of status is one of SUCCEEDED or FAILED. |
| value.messages | localizable_message[] | A list of localized messages. This attribute was added in vSphere API 6.7. |
| value.progress | long | The progress of the job as a percentage. This attribute was added in vSphere API 6.7. |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 400 | feature_in_use | A backup or restore is already in progress. |
| 400 | not_allowed_in_current_state | Reconciliation is allowed only after restore has finished successfully. |
| 400 | invalid_argument | |
| 500 | error | if any error occurs during the execution of the operation. |