Esx.Settings.Clusters.Vms.Solutions.IssueInfo

The Esx.Settings.Clusters.Vms.Solutions.IssueInfo schema contains properties that describe an issue that blocks the system to reach the desired specification of a given VM deployment.

This schema was added in vSphere API 9.0.0.0.

JSON Example

{
    "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
            }
        ]
    }
}

string

type

Required

Type of the issue.

Possible values:

VM_POWERED_ON: The System VM is expected to be powered-off, but it is powered-on. To remediate the deployment, re-invoke POST /esx/settings/clusters/{cluster}/vms/solutions?action=apply to have vLCM power-off the System VM.
VM_POWERED_OFF: The System VM is expected to be powered-on, but it is powered-off. To remediate the deployment, re-invoke POST /esx/settings/clusters/{cluster}/vms/solutions?action=apply to have vLCM power-on the System VM.
VM_SUSPENDED: The System VM is expected to be powered-on, but it is suspended. To remediate the deployment, re-invoke POST /esx/settings/clusters/{cluster}/vms/solutions?action=apply to have vLCM power-on the System VM.
VM_INACCESSIBLE: The System VM is expected to be connected, but it is inaccessible. To remediate the deployment, remove the VM and re-invoke POST /esx/settings/clusters/{cluster}/vms/solutions?action=apply to have vLCM redeploy the System VM or do the necessary changes to ensure that the connection state of the VM is (vim.ConnectionState#connected).

NOTE: When the HA is enabled on the cluster this may be transient state and automatically remediated.

VM_CORRUPTED: The System VM is corrupted. To remediate the deployment, re-invoke POST /esx/settings/clusters/{cluster}/vms/solutions?action=apply to have vLCM delete the System VM and redeploys it.
VM_NOT_DEPLOYED: The System VM has not been deployed because of an unexpected error. To remediate the deployment, re-invoke POST /esx/settings/clusters/{cluster}/vms/solutions?action=apply to have vLCM redeploy the System VM.
VM_NOT_REMOVED: The System VM has not been deployed because of an unexpected error. To remediate the deployment, manually remove the VM or re-invoke POST /esx/settings/clusters/{cluster}/vms/solutions?action=apply to have vLCM retry the System VM removal.
VM_DATASTORE_MISSING: The System VM has not been deployed because the configured datastore for it is missing on the host. To unblock the System VM deployment, provide a proper datastore in the Esx.Settings.Clusters.Vms.SolutionSpec. To remediate the deployment, re-invoke POST /esx/settings/clusters/{cluster}/vms/solutions?action=apply to have vLCM to redeploy the System VM.
VM_NETWORK_MISSING: The System VM has not been deployed because the configured network for it is missing on the host. To unblock the System VM deployment provide a proper network in the Esx.Settings.Clusters.Vms.SolutionSpec. To remediate the deployment, re-invoke POST /esx/settings/clusters/{cluster}/vms/solutions?action=apply to have vLCM redeploy the System VM.
OVF_INVALID_FORMAT: The System VM has not been deployed because the provided Esx.Settings.Clusters.Vms.OvfResource part of Esx.Settings.Clusters.Vms.SolutionSpec contains an invalid OVF. To unblock the System VM deployment provide a new Esx.Settings.Clusters.Vms.OvfResource with valid OVF. To remediate the deployment, re-invoke POST /esx/settings/clusters/{cluster}/vms/solutions?action=apply to have vLCM redeploy the System VM.
OVF_INVALID_PROPERTY: The System VM is expected to be deployed or reconfigured, but an OVF property is either missing or has an invalid value. To unblock the System VM deployment or reconfiguration, provide a new ovfDescriptorProperties in the Esx.Settings.Clusters.Vms.SolutionSpec. To remediate the deployment, re-invoke POST /esx/settings/clusters/{cluster}/vms/solutions?action=apply to have vLCM redeploy or reconfigure the System VM.
OVF_CANNOT_ACCESS: The System VM has not been deployed because vLCM is not able to access the OVF package. To unblock the System VM deployment, provide a proper accessible Esx.Settings.Clusters.Vms.OvfResource. To remediate the deployment, re-invoke POST /esx/settings/clusters/{cluster}/vms/solutions?action=apply to have vLCM redeploy the System VM.
OVF_CERTIFICATE_NOT_TRUSTED: The System VM has not been deployed because vLCM is not able to make successful SSL trust verification of the server certificate when establishing connection to the provided OVF package. To unblock the System VM deployment, provide a valid certificate or ensure the server certificate is signed by a CA trusted by the system. To remediate the deployment, re-invoke POST /esx/settings/clusters/{cluster}/vms/solutions?action=apply to have vLCM redeploy the System VM.
INSUFFICIENT_SPACE: The System VM has not been deployed because the configured System VM datastore does not have enough free space. To unblock the System VM deployment, make enough free space on the datastore or provide a new datastore in the Esx.Settings.Clusters.Vms.SolutionSpec. To remediate the deployment, re-invoke POST /esx/settings/clusters/{cluster}/vms/solutions?action=apply to have vLCM redeploy the System VM.
INSUFFICIENT_RESOURCES: The System VM has not been powered-on because the cluster does not have enough free CPU or memory resources. To unblock the System VM power-on, make enough CPU and memory resources available. To remediate the deployment, re-invoke POST /esx/settings/clusters/{cluster}/vms/solutions?action=apply to have vLCM power-on the System VM.
HOST_IN_MAINTENANCE_MODE: A System VM operation has not been initiated because the host is in maintenance mode. To unblock the System VM operation, move the host out of maintenance mode. To remediate the deployment, re-invoke POST /esx/settings/clusters/{cluster}/vms/solutions?action=apply to have vLCM retry the operation.
HOST_IN_PARTIAL_MAINTENANCE_MODE: A System VM operation has not been initiated because the host is in partial maintenance mode. To unblock the System VM operation, move the host out of partial maintenance mode. To remediate the deployment, re-invoke POST /esx/settings/clusters/{cluster}/vms/solutions?action=apply to have vLCM retry the operation.
HOST_IN_STAND_BY_MODE: A System VM operation has not been initiated because the host is in stand by mode. To unblock the System VM operation, move the host out of stand by mode. To remediate the deployment, re-invoke POST /esx/settings/clusters/{cluster}/vms/solutions?action=apply to have vLCM retry the operation.
HOST_NOT_REACHABLE: A System VM operation has not been initiated because the host is not reachable from vCenter Server. Any operation on the affected host is not possible. Typical reasons are disconnected or powered-off host. To unblock the System VM operation, reconnect and powered-on the host. To remediate the deployment, re-invoke POST /esx/settings/clusters/{cluster}/vms/solutions?action=apply to have vLCM retry the operation.
VM_INVALID_CONFIG: A System VM operation has not been initiated because the System VM has an invalid configuration. To unblock the System VM operation, inspect and correct the System VM configuration as necessary. To remediate the deployment, re-invoke POST /esx/settings/clusters/{cluster}/vms/solutions?action=apply to have vLCM retry the operation.
VMS_DISABLED: System VMs are disabled on the cluster via internal ESX Agent Manager (EAM) API (eam.EsxtAgentManager#disable). The present System VMs in the cluster are powered-off. No new System VMs are created. Modifications of the desired speification are not permitted.

This issue cannot be remediated via vLCM API. Remediation requires the System VMs to be enabled on the cluster via internal EAM API (eam.EsxAgentManager#enable). As result, the present System VMs are powered-on, Modifications of the desired specification are permitted.

Enabling and disabling the System VMs operations on the cluster is operated by vSAN Cluster Shutdown and Start-up workflows. Refer to vSAN Cluster Shutdown and Start-up documentation.

NOTE: In future versions of vLCM, Enabling and disabling the System VM operations will happen via internal vLCM APIs.

VM_LIFECYCLE_HOOK_TIMED_OUT: The System VM deployment is not completed because the System VM lifecycle hook has not been processed in the configured Esx.Settings.Clusters.Vms.LifecycleHookConfig.timeout. To remediate the deployment, re-invoke POST /esx/settings/clusters/{cluster}/vms/solutions?action=apply and process again the VM lifecycle hook.
VM_LIFECYCLE_HOOK_FAILED: The System VM deployment is not completed because the System VM lifecycle hook has been failed by the client. To remediate the deployment, re-invoke POST /esx/settings/clusters/{cluster}/vms/solutions?action=apply and process again the VM lifecycle hook.
VM_PROTECTED: The System VM deployment is not completed because the System VM is protected from modifications (example: VM is in a process of vSphere HA recovery). To remediate the deployment, re-invoke POST /esx/settings/clusters/{cluster}/vms/solutions?action=apply to have vLCM retry the operation.
VM_LIFECYCLE_HOOK_DYNAMIC_UPDATE_FAILED: The System VM deployment is not completed because the System VM lifecycle hook dynamic update has failed. To remediate the deployment, re-invoke POST /esx/settings/clusters/{cluster}/vms/solutions?action=apply to have vLCM retry the operation.

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.

CLUSTER_TRANSITION_FAILED: The System VM deployment is not completed because the System VM failed to transition to the target cluster. To remediate the deployment, re-invoke POST /esx/settings/clusters/{cluster}/vms/solutions?action=apply to have vLCM retry the operation.

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.

TRANSITION_FAILED: The System VM deployment is not completed because the Agent failed to transition to a System VM. To remediate the deployment, re-invoke POST /esx/settings/clusters/{cluster}/vms/solutions?action=apply to have vLCM retry the operation.

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.

For more information see: Esx.Settings.Clusters.Vms.Solutions.IssueInfo.IssueType.

This property was added in vSphere API 9.0.0.0.

notifications

Required

Provides additional information about the issue.

This property was added in vSphere API 9.0.0.0.

Property Of

Esx.Settings.Clusters.Vms.Solutions.DeploymentInfo

Node: apidepo-liferay-dxp-v1-be-w-1:8080: