Esx.Settings.Clusters.Vms.Solutions.DeploymentInfo
The Esx.Settings.Clusters.Vms.Solutions.DeploymentInfo schema contains properties that describe the state of a single VM deployment of a solution.
This schema was added in vSphere API 9.0.0.0.
{
"status": "string",
"vm": "string",
"replacement_vm": "string",
"issues": [
{
"type": "string",
"notifications": {
"info": [
{
"type": "string",
"id": "string",
"time": "string",
"message": "Vapi.Std.LocalizableMessage Object",
"resolution": "Vapi.Std.LocalizableMessage Object",
"originator": "string",
"retriable": false
}
],
"warnings": [
{
"type": "string",
"id": "string",
"time": "string",
"message": "Vapi.Std.LocalizableMessage Object",
"resolution": "Vapi.Std.LocalizableMessage Object",
"originator": "string",
"retriable": false
}
],
"errors": [
{
"type": "string",
"id": "string",
"time": "string",
"message": "Vapi.Std.LocalizableMessage Object",
"resolution": "Vapi.Std.LocalizableMessage Object",
"originator": "string",
"retriable": false
}
]
}
}
],
"lifecycle_hook": {
"vm": "string",
"lifecycle_state": "string",
"configuration": {
"timeout": 0
},
"hook_activated": "string",
"dynamic_update_processed": false
},
"solution_info": {
"deployment_type": "string",
"display_name": "string",
"display_version": "string",
"vm_name_template": {
"prefix": "string",
"suffix": "string"
},
"host_solution_info": {
"prefer_host_configuration": false,
"vm_networks": [
"string"
],
"vm_datastores": [
"string"
]
},
"cluster_solution_info": {
"vm_count": 0,
"vm_placement_policies": [
"string"
],
"vm_networks": {
"vm_networks": "string"
},
"vm_datastores": [
"string"
],
"devices": {},
"remediation_policy": "string",
"alternative_vm_specs": [
{
"selection_criteria": {
"selection_type": "string",
"extra_config_value": "string"
},
"devices": {}
}
]
},
"hook_configurations": {
"hook_configurations": {
"timeout": 0
}
},
"ovf_resource": {
"location_type": "string",
"url": "string",
"ssl_certificate_validation": "string",
"certificate": "string",
"authentication_scheme": "string"
},
"ovf_descriptor_properties": {
"ovf_descriptor_properties": "string"
},
"vm_clone_config": "string",
"vm_storage_policy": "string",
"vm_storage_profiles": [
"string"
],
"vm_disk_type": "string",
"vm_resource_pool": "string",
"vm_folder": "string",
"vm_resource_spec": {
"ovf_deployment_option": "string"
},
"redeployment_policy": "string"
}
}Compliance status of the deployment.
Possible values:
- NOT_APPLIED: The desired specification of the solution has never been applied.
- IN_PROGRESS: The system is actively working to reach the desired specification.
- COMPLIANT: The deployment is in full compliance with the desired specification.
- ISSUE: The system has hit issues that do not allow the deployment to reach the desired specification. See Esx.Settings.Clusters.Vms.Solutions.DeploymentInfo.issues.
- IN_LIFECYCLE_HOOK: The system is waiting on an activated VM lifecycle hook to be processed by the solution in order to continue attempting to reach the desired specification. See Esx.Settings.Clusters.Vms.Solutions.DeploymentInfo.lifecycle_hook.
- BLOCKED: The system is blocked from reaching the desired specification. For example, this can occur if Esx.Settings.Clusters.Vms.RemediationPolicy.SEQUENTIAL is set and another deployment is in ISSUE status.
Warning: this constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
- OBSOLETE_SPEC: The current desired specification of the solution is newer than the applied.
This state should take precedence over: - IN_PROGRESS
- ISSUE
- IN_LIFECYCLE_HOOK
For more information see: Esx.Settings.Clusters.Vms.Solutions.DeploymentInfo.Status.
This property was added in vSphere API 9.0.0.0.
Identifier of the currently deployed VM. More information about the runtime state of the VM can be observed through the VIM API.
This property was added in vSphere API 9.0.0.0.
This field is missing or null if:
- The VM deployment is not started yet.
- There are issues specified by the issues that prevents the VM to be deployed.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: VirtualMachine. When operations return a value of this schema as a response, the property will be an identifier for the resource type: VirtualMachine.
Identifier of the VM that is going to replace the current deployed VM. More information about the runtime state of the VM can be observed through the VIM API.
This property was added in vSphere API 9.0.0.0.
This field is missing or null if there is no ongoing VM upgrade for the current VM deployment.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: VirtualMachine. When operations return a value of this schema as a response, the property will be an identifier for the resource type: VirtualMachine.
List of Esx.Settings.Clusters.Vms.Solutions.IssueInfo which do not allow the deployment to reach the desired specification specified by the solution_info. In order to remediate these issues an apply operation POST /esx/settings/clusters/{cluster}/vms/solutions?action=apply need to be initiated.
This property was added in vSphere API 9.0.0.0.
The activated VM lifecycle hook for the VM specified by the vm that the system is waiting to be processed by the solution in order to continue attempting to reach the desired specification.
This property was added in vSphere API 9.0.0.0.
This field is missing or null if there is no activated hook for the VM.
Describes the current desired solution specification of the deployment.
This property was added in vSphere API 9.0.0.0.
This property is optional and it is only relevant when the value of status is one of Esx.Settings.Clusters.Vms.Solutions.DeploymentInfo.Status.BLOCKED, Esx.Settings.Clusters.Vms.Solutions.DeploymentInfo.Status.IN_PROGRESS, Esx.Settings.Clusters.Vms.Solutions.DeploymentInfo.Status.COMPLIANT, Esx.Settings.Clusters.Vms.Solutions.DeploymentInfo.Status.ISSUE, Esx.Settings.Clusters.Vms.Solutions.DeploymentInfo.Status.IN_LIFECYCLE_HOOK, or Esx.Settings.Clusters.Vms.Solutions.DeploymentInfo.Status.OBSOLETE_SPEC.