VmTemplate_LibraryItems_DeploySpec
The LibraryItems.DeploySpec structure defines the deployment parameters that can be specified for the LibraryItems.deploy operation.
{
"name": "string",
"description": "string",
"vm_home_storage": {
"datastore": "string",
"storage_policy": {
"type": "string",
"policy": "string"
}
},
"disk_storage": {
"datastore": "string",
"storage_policy": {
"type": "string",
"policy": "string"
}
},
"placement": {
"folder": "string",
"resource_pool": "string",
"host": "string",
"cluster": "string"
},
"powered_on": false,
"guest_customization": {
"name": "string"
},
"hardware_customization": {
"disks_to_remove": [
"string"
],
"cpu_update": {
"num_cpus": 0,
"num_cores_per_socket": 0
},
"memory_update": {
"memory": 0
}
}
}Name of the deployed virtual machine.
Description of the deployed virtual machine. If unset, the deployed virtual machine has the same description as the source library item.
The LibraryItems.DeploySpecVmHomeStorage structure defines the storage specification for a deployed virtual machine's configuration and log files.
The LibraryItems.DeploySpecDiskStorage structure contains the storage specification for disks in the virtual machine.
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.
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.
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.
The LibraryItems.DeployPlacementSpec structure contains information used to place a virtual machine onto resources within the vCenter inventory.
Specifies whether the deployed virtual machine should be powered on after deployment. If unset, the virtual machine will not be powered on after deployment.
The LibraryItems.GuestCustomizationSpec structure contains information required to customize the deployed virtual machine.
The LibraryItems.HardwareCustomizationSpec structure defines the hardware customization options that are applied to the deployed virtual machine.