OvfImportParams

OvfImportParams
OvfImportParams

Custom parameters used while deploying an OVF.

Since: vSphere API Release 9.0.0.0

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "locale": "string",
    "deploymentOption": "string",
    "msgBundle": [
        {
            "_typeName": "string",
            "key": "string",
            "value": "string"
        }
    ],
    "importOption": [
        "string"
    ],
    "entityName": "string",
    "hostSystem": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "networkMapping": [
        {
            "_typeName": "string",
            "name": "string",
            "network": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            }
        }
    ],
    "ipAllocationPolicy": "string",
    "ipProtocol": "string",
    "propertyMapping": [
        {
            "_typeName": "string",
            "key": "string",
            "value": "string"
        }
    ],
    "resourceMapping": [
        {
            "_typeName": "string",
            "source": "string",
            "parent": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            },
            "resourceSpec": {
                "_typeName": "string",
                "entity": {
                    "_typeName": "string",
                    "type": "string",
                    "value": "string"
                },
                "changeVersion": "string",
                "lastModified": "string",
                "cpuAllocation": {
                    "_typeName": "string",
                    "reservation": 0,
                    "expandableReservation": false,
                    "limit": 0,
                    "shares": {
                        "_typeName": "string",
                        "shares": 0,
                        "level": "string"
                    },
                    "overheadLimit": 0
                },
                "memoryAllocation": {
                    "_typeName": "string",
                    "reservation": 0,
                    "expandableReservation": false,
                    "limit": 0,
                    "shares": {
                        "_typeName": "string",
                        "shares": 0,
                        "level": "string"
                    },
                    "overheadLimit": 0
                },
                "scaleDescendantsShares": "string"
            },
            "datastore": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            }
        }
    ],
    "diskProvisioning": "string",
    "instantiationOst": {
        "_typeName": "string",
        "id": "string",
        "type": "string",
        "section": [
            {
                "_typeName": "string",
                "lineNumber": 0,
                "xml": "string"
            }
        ],
        "child": [
            "OvfConsumerOstNode Object"
        ],
        "entity": {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        }
    },
    "pushMode": false,
    "signatureRequired": false,
    "skipManifestCheck": false,
    "powerOn": false,
    "customHttpHeaders": [
        {
            "_typeName": "string",
            "key": "string",
            "value": "string"
        }
    ],
    "sourceCertificate": "string",
    "datastoreMappings": [
        {
            "_typeName": "string",
            "diskId": "string",
            "datastore": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            }
        }
    ],
    "vmProfile": "string",
    "diskProfiles": [
        {
            "_typeName": "string",
            "diskId": "string",
            "storageProfileId": "string"
        }
    ]
}
boolean
pushMode
Optional

Use Push mode for transferring VM files to ESX.

Push mode transfers files from client to ESXi, whereas in Pull mode ESX "pulls" the files directly from source. This flag only applies to vCenter as ESXi can only pull directly if DeployVm_Task is invoked on ESX itself. See (@link vim.HttpNfcLease#pullFromUrls) for more on Pull mode. The default/Default: false

boolean
signatureRequired
Optional

Require that the OVF package has a signed certificate and manifest and both match.

See also manifest validation. Default is false.

boolean
skipManifestCheck
Optional

If a manifest file is present in the OVF package the format is checked.

Also all file SHA entries are validated against SHA of read files. If value is true and manifest file is present a warning is generated. Default is false.

boolean
powerOn
Optional

Whether to power on the deployed entity.

Note for ESX and Virtual Machine deployment: In order to customize GuestOS on a deployed Virtual Machine we require that the powerOn flag must be true. GuestOS customization happens after VM is powered On and then reconfigured. vCenter does not require a powerOn and reconfigure to customize GuestOS as it stores all OVF properties as VApp properties and pushes them to GuestOS upon powerOn for consumption. Default is false.

array of KeyValue
customHttpHeaders
Optional

For the case when remote server requires authentication or any other type of custom HTTP headers be provided with the request.

string
sourceCertificate
Optional

Optionally used for source validation.

The source server certificate in PEM format.

datastoreMappings
Optional

The optional datastore mapping(s).

string
vmProfile
Optional

The optional Storage Profile Id for VM's home.

diskProfiles
Optional

The optional Storage Profile mapping(s).