Vcenter Lcm Deployment MigrationUpgrade cancel
Cancels running vCenter upgrade. The cancellation cleans any actions done by the upgrade on the source vCenter without removing any production data generated during the upgrade. A new upgrade can be started after successful cancellation. The upgrade can be canceled explicitly at all points except in post-upgrade actions using this API.
The cancellation process described above requires the Vcenter Lcm Deployment MigrationUpgrade CancellationPolicy.source_connection to complete successfully, depending when it is called. However, if the upgrade's cancellation policy cannot be used due to resource constraints, KB Article needs to be followed to ensure the vCenter is reverted to previous stable and consistent state.
If the vCenter being canceled is part of the Enhanced Linked Mode (ELM) environment, ensure the ELM is healthy after the cancellation. If not, take the necessary actions to restore the environment to its correct state following KB Article.
The cancellation progress can be monitored via GET /vcenter/lcm/deployment/migration-upgrade/status. More information about the progress of the upgrade can be found in Vcenter Lcm Deployment MigrationUpgrade Status Info.upgrade_info and Vcenter Lcm Deployment MigrationUpgrade Status Info.subtasks.
If the cancellation process fails, check what the problem is and fix it. After that, call the API again to ensure the removal of any information generated by the upgrade process and future upgradability of the vCenter.
This operation was added in vSphere API 9.0.0.0.
Returns an authorization error if you do not have all of the privileges described as follows:
- Operation execution requires
VcLifecycle.Upgrade.
Success!
if there is no upgrade process running or the upgrade is in post-upgrade actions.
{
"messages": [
{
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
],
"data": {},
"error_type": "string"
}if the caller is not 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 caller is not authorized.
"Vapi Std Errors Unauthorized Object"If there is other error raised as part of the upgrade process. The accompanying error message will give more details about the failure.
"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>' https://{api_host}/api/vcenter/lcm/deployment/migration-upgrade?action=cancel