Vcenter Lcm Deployment MigrationUpgrade check$Task
Runs sanity checks using the provided InitSpec or against running upgrade.
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.
InitSpec parameters to run sanity check on.
If not provided will run sanity checks against the initialized upgrade process parameters. In that situation if there is no upgrade precheck will fail.
Show optional properties
{
"deployment": {},
"version": "string"
}{
"deployment": {
"source_container": {
"hostname": "string",
"username": "string",
"password": "string",
"https_port": 0,
"ssl_verify": false,
"certificate": "string"
},
"appliance": {
"name": "string",
"size": "string",
"thin_disk_mode": false,
"disk_size": "string",
"root_password": "string",
"network_settings": {
"ip_family": "string",
"mode": "string",
"ip": "string",
"dns_servers": [
"string"
],
"prefix": 0,
"gateway": "string",
"hostname": "string"
},
"ova_info": {
"location": "string",
"ssl_verify": false,
"ova_checksum": "string",
"ova_checksum_algorithm": "string",
"certificate": "string"
},
"ceip_enabled": false,
"cpu_allocation": {
"reservation": 0,
"allocate": "string"
},
"memory_allocation": {
"reservation": 0,
"allocate": "string"
}
},
"location": {
"esx": {
"connection": {
"hostname": "string",
"username": "string",
"password": "string",
"https_port": 0,
"ssl_verify": false,
"certificate": "string"
},
"placement_config": {
"datastore_name": "string",
"network_name": "string",
"resource_pool_path": "string"
}
},
"vcenter": {
"connection": {
"hostname": "string",
"username": "string",
"password": "string",
"https_port": 0,
"ssl_verify": false,
"certificate": "string"
},
"placement_config": {
"vm_folder_path": "string",
"resource_pool_path": "string",
"cluster_path": "string",
"host_path": "string",
"datastore_name": "string",
"datastore_cluster_name": "string",
"network_name": "string"
}
}
}
},
"version": "string",
"cancellation_policy": {
"automatic": false,
"method": [
"string"
],
"source_connection": {
"connection_type": "string"
}
},
"source_shutdown_policy": "string",
"repository": {
"address": "string",
"username": "string",
"password": "string"
},
"post_upgrade_configuration_policy": {
"rename_vm_policy": {
"preserve_original_vm_name": false,
"old_vcenter_name": "string"
},
"delete_vm_policy": {
"source_vc": false
}
},
"vcha_spec": {
"passive_node_container": {
"hostname": "string",
"username": "string",
"password": "string",
"https_port": 0,
"ssl_verify": false,
"certificate": "string"
},
"witness_node_container": {
"hostname": "string",
"username": "string",
"password": "string",
"https_port": 0,
"ssl_verify": false,
"certificate": "string"
}
}
}Specification to describe the new appliance deployment configuration.
This property was added in vSphere API 9.0.0.0.
Upgrade to vCSA version. The version is part of the metadata for each upgrade/update. It can be retrieved via the pending updates API.
This property was added in vSphere API 9.0.0.0.
Provides option to configure additional cancellation support and to enable automatic cancellation on error of the upgrade process.
This property was added in vSphere API 9.0.0.0.
cancellationPolicy If missing or null then the default support is provided - Vcenter Lcm Deployment MigrationUpgrade CancelType.CLEAN_UP and there is no automatic cancellation on error
Provides the ability to configure when the source vCenter should be shutdown during the upgrade.
For more information see: Vcenter Lcm Deployment MigrationUpgrade SourceShutdownPolicy.
This property was added in vSphere API 9.0.0.0.
If missing or null the source vCenter will be shutdown during the upgrade.
Provides a configuration for a repository containing vCenter deployment packages. Overrides the repository set with PUT /vcenter/lcm/deployment/repository only for the upgrade being initialized.
This property was added in vSphere API 9.0.0.0.
If missing or null the configured Vcenter Lcm Deployment Repository is used.
Provides post upgrade configuration options like source VM name preservation.
This property was added in vSphere API 9.0.0.0.
If missing or null no additional post upgrade configuration will be done
Provides VMware vCenter High Availability (VCHA) related upgrade configuration. Not needed for when VCHA is automatically configured. However, in the cases of VCHA with manual setup, vCenter containers connection information has to be provided in order to recreate Passive and Witness nodes in the same location as before upgrade.
This property was added in vSphere API 9.0.0.0.
If missing or null in manual VCHA setups, the upgrade process disables VCHA on the target machine. It is expected to manually recreate passive and witness nodes and enable back VCHA post-upgrade. In this case pre-upgrade nodes will remain powered off but not deleted; it is recommended to remove these to optimize storage usage. For auto VCHA setups this option will be ignored.
CheckInfo containing the check results.
Vapi Std Errors InvalidArgument if passed arguments are invalid.
Vapi Std Errors NotAllowedInCurrentState if there is no upgrade process initialized and there is no InitSpec passed as input or if the upgrade process is in switchover or cancellation phase.
"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 '{"deployment":"{}","version:"string"}' https://{api_host}/api/vcenter/lcm/deployment/migration-upgrade?action=check&vmw-task=true