Esx.Settings.Clusters.Vms.Solutions.DeploymentCompliance

Esx.Settings.Clusters.Vms.Solutions.DeploymentCompliance
Esx.Settings.Clusters.Vms.Solutions.DeploymentCompliance

The Esx.Settings.Clusters.Vms.Solutions.DeploymentCompliance schema contains properties that describe the compliance of a given VM deployment. See Esx.Settings.Clusters.Vms.Solutions.DeploymentInfo

This schema was added in vSphere API 9.0.0.0.

JSON Example
{
    "status": "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
            }
        ]
    },
    "deployment": {
        "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"
        }
    }
}
string
status
Required

Compliance status of the deployment.

Possible values:

  • COMPLIANT: The status is compliant with the desired solution specification.
  • NON_COMPLIANT: The status is non-compliant with the desired solution specification.
  • INCOMPATIBLE: Target state is incompatible with the system.

For more information see: Esx.Settings.Clusters.Vms.Solutions.ComplianceStatus.

This property was added in vSphere API 9.0.0.0.

notifications
Required

Notifications describing the compliance result.

This property was added in vSphere API 9.0.0.0.

deployment
Required

The current VM deployment.

This property was added in vSphere API 9.0.0.0.