Ovf Manager Validate Host

Validate that the given OVF can be imported on the host.

More specifically, this means whether or not the host supports the virtual hardware required by the OVF descriptor.

Required privileges: System.View

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/OvfManager/{moId}/ValidateHost

COPY

Path Parameters

string

moId

Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case OvfManager/{moId}.

string

release

Required

The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.

Request Body

ValidateHostRequestType of type(s) application/json

Required

Show optional properties

{
    "ovfDescriptor": "string",
    "host": {},
    "vhp": {}
}

{
    "ovfDescriptor": "string",
    "host": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "vhp": {
        "_typeName": "string",
        "locale": "string",
        "deploymentOption": "string",
        "msgBundle": [
            {
                "_typeName": "string",
                "key": "string",
                "value": "string"
            }
        ],
        "importOption": [
            "string"
        ]
    }
}

string

ovfDescriptor

Required

The OVF descriptor to examine.

MoRefHostSystem

host

Required

Reference to an instance of the HostSystem managed object.

OvfValidateHostParams

vhp

Required

Additional parameters for validateHost, wrapped in a ValidateHostParams instance.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

A ValidateResult instance containing any warnings and/or errors from the validation.

Returns OvfValidateHostResult of type(s) application/json

This response body class contains all of the following: DataObject

{
    "_typeName": "string",
    "downloadSize": 0,
    "flatDeploymentSize": 0,
    "sparseDeploymentSize": 0,
    "error": [
        {
            "_typeName": "string",
            "faultCause": "MethodFault Object",
            "faultMessage": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "arg": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "value": {
                                "_typeName": "string"
                            }
                        }
                    ],
                    "message": "string"
                }
            ]
        }
    ],
    "warning": [
        {
            "_typeName": "string",
            "faultCause": "MethodFault Object",
            "faultMessage": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "arg": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "value": {
                                "_typeName": "string"
                            }
                        }
                    ],
                    "message": "string"
                }
            ]
        }
    ],
    "supportedDiskProvisioning": [
        "string"
    ]
}

integer As int64 As int64

downloadSize

Optional

The total amount of data that must be transferred to download the entity.

This may be inaccurate due to disk compression etc.

integer As int64 As int64

flatDeploymentSize

Optional

The total amount of space required to deploy the entity if using flat disks.

integer As int64 As int64

sparseDeploymentSize

Optional

The total amount of space required to deploy the entity using sparse disks, if known.

array of MethodFault

error

Optional

Errors that happened during validation.

The presence of faults in this list indicates that the validation failed.

array of MethodFault

warning

Optional

Non-fatal warnings from the validation.

array of string

supportedDiskProvisioning

Optional

An array of the disk provisioning type supported by the target host system.

500

TaskInProgress: if a required managed entity is busy.

ConcurrentAccess: if a concurrency issue prevents the operation from succeeding.

FileFault: if there is a generic file error

InvalidState: if the operation failed due to the current state of the system.

Returns VimFault of type(s) application/json

This response body class contains all of the following: MethodFault

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Virtual Infrastructure Operations

POST

Ovf Manager Create Descriptor