Vcenter Lcm Deployment MigrationUpgrade apply
Executes the migration based upgrade by applying the upgrade configuration(Vcenter Lcm Deployment MigrationUpgrade InitSpec) set via the PUT /vcenter/lcm/deployment/migration-upgrade. The apply can be called multiple times while the upgrade is ongoing. In that case, the apply will try to override the old spec with the newly given parameters and will fail with Vapi Std Errors InvalidArgument if that is not possible. The upgrade process executes several operations to reach the desired state of upgraded vCenter.
- The upgrade process runs prechecks to ensure that the source vCenter health and the information provide will allow successful upgrade.
- The upgrade process deploys the new vCenter and configures it to be part of the upgrade. The services of the source vCenter are operational at that time and there is no disruption to the operations.
- The upgrade process configures the source vCenter and replicates its data to the new vCenter, without stopping the source vCenter or preventing its use. The services of the source vCenter are operational at that time and there is no disruption to the operations.
- The upgrade process executes the switchover which stops the service on the source vCenter, transfers the identity (network, certificates and passwords) to the new vCenter and starts the services on the new vCenter. This is the only phase of the upgrade which causes downtime to the vCenter operations.
- The upgrade process checks that the new vCenter is healthy before continuing forward.
- Finally the upgrade process performs any requested post-upgrade actions. The services of the source vCenter are operational at that time and there is no disruption to the operations.
The Vcenter Lcm Deployment MigrationUpgrade ApplySpec allows the upgrade execution to be configured to stop before the switchover operation or to start the switchover phase of the upgrade at a specific time. The apply will verify the Vcenter Lcm Deployment MigrationUpgrade InitSpec provided and if it is unset or incorrect the operation will fail. The Vcenter Lcm Deployment MigrationUpgrade InitSpec can be validated before that using the POST /vcenter/lcm/deployment/migration-upgrade?action=check.
The upgrade 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.
The upgrade process can be manually cancelled by invoking the POST /vcenter/lcm/deployment/migration-upgrade?action=cancel or can be configured to automatically cancel on error by Vcenter Lcm Deployment MigrationUpgrade CancellationPolicy.automatic.
If the upgrade process fails and the upgrade does not use Vcenter Lcm Deployment MigrationUpgrade CancellationPolicy.automatic it can be resumed again after fixing the problem and calling the same POST /vcenter/lcm/deployment/migration-upgrade?action=apply. If the process cannot be fixed use POST /vcenter/lcm/deployment/migration-upgrade?action=cancel to cancel the upgrade and start from the beginning.
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.
Vcenter Lcm Deployment MigrationUpgrade ApplySpec allows the upgrade execution to be configured to stop before the switchover operation or to configure a switchover for a specific time window.
The upgrade will be started and executed immediately.
{
"pause": "string",
"start_switchover": "string"
}Allows the upgrade to be stopped at predefine points of the process. For more information about the available pause options check Vcenter Lcm Deployment MigrationUpgrade PausePolicy.
For more information see: Vcenter Lcm Deployment MigrationUpgrade PausePolicy.
This property was added in vSphere API 9.0.0.0.
If missing or null the upgrade process will complete without stopping.
Instructs the upgrade process to start the switchover operation after the given time. If the upgrade process is not ready for the switchover at the given time and end switchover is not provided the upgrade will wait for the preparation to complete to start the switchover thus resulting in the shortest possible switchover duration. The option cannot be set if Vcenter Lcm Deployment MigrationUpgrade ApplySpec.pause is set with value Vcenter Lcm Deployment MigrationUpgrade PausePolicy.BEFORE_SWITCHOVER, if such configuration is attempted will result in Vapi Std Errors InvalidArgument.
This property was added in vSphere API 9.0.0.0.
If missing or null the upgrade process will execute the switchover operation as soon as possible.
Success!
Vapi Std Errors InvalidArgument if passed arguments are invalid.
Vapi Std Errors NotAllowedInCurrentState if there is no upgrade set on the system or the upgrade process is running cancellation.
"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 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>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/vcenter/lcm/deployment/migration-upgrade?action=apply