OvfCreateImportSpecParams

Parameters for deploying an OVF.

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

string

entityName

Required

The name to set on the entity (more precisely, on the top-level vApp or VM of the entity) as it appears in VI.

If empty, the product name is obtained from the ProductSection of the descriptor. If that name is not specified, the ovf:id of the top-level entity is used.

hostSystem

Optional

The host to validate the OVF descriptor against, if it cannot be deduced from the resource pool.

The privilege System.Read is required on the host.

array of OvfNetworkMapping

networkMapping

Optional

The mapping of network identifiers from the descriptor to networks in the VI infrastructure.

The privilege Network.Assign is required on all networks in the list.

string

ipAllocationPolicy

Optional

The IP allocation policy chosen by the caller.

See VAppIPAssignmentInfo.

string

ipProtocol

Optional

The IP protocol chosen by the caller.

See VAppIPAssignmentInfo.

array of KeyValue

propertyMapping

Optional

The assignment of values to the properties found in the descriptor.

If no value is specified for an option, the default value from the descriptor is used.

array of OvfResourceMap

resourceMapping

Optional

Deprecated as of vSphere API 5.1.

The resource configuration for the created vApp.

This can be used to distribute a vApp across multiple resource pools (and create linked children).

string

diskProvisioning

Optional

An optional disk provisioning.

If set, all the disks in the deployed OVF will have get the same specified disk type (e.g., thin provisioned). The valide values for disk provisioning are: