VmTemplateLibraryItemsDeploySpec

The LibraryItems.DeploySpec structure defines the deployment parameters that can be specified for the LibraryItems.deploy operation.

Properties

VmTemplateLibraryItemsDeployPlacementSpec

placement Required

Information used to place the deployed virtual machine. This field is currently required. In the future, if this field is unset, the system will use the values from the source virtual machine template contained in the library item. If specified, each field will be used for placement. If the fields result in disjoint placement, the operation will fail. If the fields along with the placement values of the source virtual machine template result in disjoint placement, the operation will fail.

string

name Required

Name of the deployed virtual machine.

VmTemplateLibraryItemsDeploySpecDiskStorage

disk_storage Optional

Storage specification for the deployed virtual machine’s disks. If both LibraryItems.DeploySpec.disk-storage-overrides and LibraryItems.DeploySpec.disk-storage are unset, the deployed virtual machine’s disks are created with the same storage spec as the corresponding disks in the source virtual machine template contained in the library item. If LibraryItems.DeploySpec.disk-storage-overrides is unset and LibraryItems.DeploySpec.disk-storage is specified, all of the deployed virtual machine’s disks are created with the storage spec specified by LibraryItems.DeploySpec.disk-storage.

If LibraryItems.DeploySpec.disk-storage-overrides is specified and LibraryItems.DeploySpec.disk-storage is unset, disks with identifiers that are not in LibraryItems.DeploySpec.disk-storage-overrides are created with the same storage spec as the corresponding disks in the source virtual machine template contained in the library item.

If both LibraryItems.DeploySpec.disk-storage-overrides and LibraryItems.DeploySpec.disk-storage are specified, disks with identifiers that are not in LibraryItems.DeploySpec.disk-storage-overrides are created with the storage spec specified by LibraryItems.DeploySpec.disk-storage.

map of VmTemplateLibraryItemsDeploySpecDiskStorage

disk_storage_overrides Optional

Storage specification for individual disks in the deployed virtual machine. This is specified as a mapping between disk identifiers in the source virtual machine template contained in the library item and their storage specifications. If both LibraryItems.DeploySpec.disk-storage-overrides and LibraryItems.DeploySpec.disk-storage are unset, the deployed virtual machine’s disks are created with the same storage spec as the corresponding disks in the source virtual machine template contained in the library item. If LibraryItems.DeploySpec.disk-storage-overrides is unset and LibraryItems.DeploySpec.disk-storage is specified, all of the deployed virtual machine’s disks are created with the storage spec specified by LibraryItems.DeploySpec.disk-storage.

When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

VmTemplateLibraryItemsGuestCustomizationSpec

guest_customization Optional

Guest customization spec to apply to the deployed virtual machine. If unset, the guest operating system is not customized after deployment.

VmTemplateLibraryItemsHardwareCustomizationSpec

hardware_customization Optional

Hardware customization spec which specifies updates to the deployed virtual machine. If unset, the deployed virtual machine has the same hardware configuration as the source virtual machine template contained in the library item.

string

description Optional

Description of the deployed virtual machine. If unset, the deployed virtual machine has the same description as the source library item.

boolean

powered_on Optional

Specifies whether the deployed virtual machine should be powered on after deployment. If unset, the virtual machine will not be powered on after deployment.

VmTemplateLibraryItemsDeploySpecVmHomeStorage

vm_home_storage Optional

Storage location for the deployed virtual machine’s configuration and log files. If unset, the deployed virtual machine’s configuration and log files are created with the same storage spec as the source virtual machine template’s configuration and log files.

JSON Example

Show optional properties

{
	"name": "string",
	"placement": {
		"folder": "string"
	}
}

{
	"description": "string",
	"disk_storage": {
		"datastore": "string",
		"storage_policy": {
			"policy": "string",
			"type": "USE_SPECIFIED_POLICY"
		}
	},
	"disk_storage_overrides": {
		"key": {
			"datastore": "string",
			"storage_policy": {
				"policy": "string",
				"type": "USE_SPECIFIED_POLICY"
			}
		}
	},
	"guest_customization": {
		"name": "string"
	},
	"hardware_customization": {
		"cpu_update": {
			"num_cores_per_socket": 0,
			"num_cpus": 0
		},
		"disks_to_remove": [
			"string"
		],
		"disks_to_update": {
			"key": {
				"capacity": 0
			}
		},
		"memory_update": {
			"memory": 0
		},
		"nics": {
			"key": {
				"network": "string"
			}
		}
	},
	"name": "string",
	"placement": {
		"cluster": "string",
		"folder": "string",
		"host": "string",
		"resource_pool": "string"
	},
	"powered_on": false,
	"vm_home_storage": {
		"datastore": "string",
		"storage_policy": {
			"policy": "string",
			"type": "USE_SPECIFIED_POLICY"
		}
	}
}

Parameter To

Deploy Library Items

VmTemplateLibraryItemsDeploySpec

Properties

JSON Example

Parameter To

Was this page helpful?