pulumi-vsphere 4.10.0a1710245029__py3-none-any.whl → 4.10.2__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of pulumi-vsphere might be problematic. Click here for more details.

Files changed (64) hide show
  1. pulumi_vsphere/__init__.py +28 -0
  2. pulumi_vsphere/_inputs.py +566 -236
  3. pulumi_vsphere/_utilities.py +35 -0
  4. pulumi_vsphere/compute_cluster.py +747 -1477
  5. pulumi_vsphere/compute_cluster_vm_affinity_rule.py +28 -20
  6. pulumi_vsphere/datacenter.py +33 -40
  7. pulumi_vsphere/datastore_cluster.py +154 -364
  8. pulumi_vsphere/distributed_port_group.py +126 -182
  9. pulumi_vsphere/distributed_virtual_switch.py +301 -819
  10. pulumi_vsphere/entity_permissions.py +56 -35
  11. pulumi_vsphere/file.py +16 -24
  12. pulumi_vsphere/folder.py +7 -28
  13. pulumi_vsphere/get_compute_cluster.py +0 -4
  14. pulumi_vsphere/get_compute_cluster_host_group.py +20 -20
  15. pulumi_vsphere/get_content_library.py +10 -10
  16. pulumi_vsphere/get_content_library_item.py +12 -8
  17. pulumi_vsphere/get_custom_attribute.py +0 -4
  18. pulumi_vsphere/get_datacenter.py +0 -4
  19. pulumi_vsphere/get_datastore.py +9 -13
  20. pulumi_vsphere/get_datastore_cluster.py +0 -4
  21. pulumi_vsphere/get_datastore_stats.py +38 -44
  22. pulumi_vsphere/get_distributed_virtual_switch.py +2 -4
  23. pulumi_vsphere/get_dynamic.py +18 -20
  24. pulumi_vsphere/get_folder.py +10 -6
  25. pulumi_vsphere/get_guest_os_customization.py +8 -47
  26. pulumi_vsphere/get_host.py +0 -4
  27. pulumi_vsphere/get_host_base_images.py +97 -0
  28. pulumi_vsphere/get_host_pci_device.py +8 -14
  29. pulumi_vsphere/get_host_thumbprint.py +12 -16
  30. pulumi_vsphere/get_host_vgpu_profile.py +4 -10
  31. pulumi_vsphere/get_license.py +2 -5
  32. pulumi_vsphere/get_network.py +14 -18
  33. pulumi_vsphere/get_policy.py +0 -4
  34. pulumi_vsphere/get_resource_pool.py +14 -18
  35. pulumi_vsphere/get_role.py +4 -8
  36. pulumi_vsphere/get_tag.py +0 -4
  37. pulumi_vsphere/get_tag_category.py +0 -4
  38. pulumi_vsphere/get_vapp_container.py +0 -4
  39. pulumi_vsphere/get_virtual_machine.py +58 -41
  40. pulumi_vsphere/get_vmfs_disks.py +0 -4
  41. pulumi_vsphere/guest_os_customization.py +50 -0
  42. pulumi_vsphere/ha_vm_override.py +189 -378
  43. pulumi_vsphere/host.py +0 -20
  44. pulumi_vsphere/host_port_group.py +12 -24
  45. pulumi_vsphere/host_virtual_switch.py +140 -287
  46. pulumi_vsphere/license.py +0 -32
  47. pulumi_vsphere/nas_datastore.py +7 -7
  48. pulumi_vsphere/offline_software_depot.py +180 -0
  49. pulumi_vsphere/outputs.py +591 -270
  50. pulumi_vsphere/provider.py +2 -6
  51. pulumi_vsphere/pulumi-plugin.json +2 -1
  52. pulumi_vsphere/resource_pool.py +50 -24
  53. pulumi_vsphere/supervisor.py +962 -0
  54. pulumi_vsphere/virtual_disk.py +14 -20
  55. pulumi_vsphere/virtual_machine.py +580 -809
  56. pulumi_vsphere/virtual_machine_class.py +442 -0
  57. pulumi_vsphere/virtual_machine_snapshot.py +8 -12
  58. pulumi_vsphere/vm_storage_policy.py +74 -86
  59. pulumi_vsphere/vnic.py +61 -77
  60. {pulumi_vsphere-4.10.0a1710245029.dist-info → pulumi_vsphere-4.10.2.dist-info}/METADATA +1 -1
  61. pulumi_vsphere-4.10.2.dist-info/RECORD +86 -0
  62. {pulumi_vsphere-4.10.0a1710245029.dist-info → pulumi_vsphere-4.10.2.dist-info}/WHEEL +1 -1
  63. pulumi_vsphere-4.10.0a1710245029.dist-info/RECORD +0 -82
  64. {pulumi_vsphere-4.10.0a1710245029.dist-info → pulumi_vsphere-4.10.2.dist-info}/top_level.txt +0 -0
@@ -93,122 +93,93 @@ class VirtualMachineArgs:
93
93
  wait_for_guest_net_timeout: Optional[pulumi.Input[int]] = None):
94
94
  """
95
95
  The set of arguments for constructing a VirtualMachine resource.
96
- :param pulumi.Input[str] resource_pool_id: The managed object reference ID of the resource pool in which to place the virtual machine. See the Virtual Machine Migration section for more information on modifying this value.
97
-
98
- > **NOTE:** All clusters and standalone hosts have a default root resource pool. This resource argument does not directly accept the cluster or standalone host resource. For more information, see the section on specifying the Root Resource Pool in the `ResourcePool` data source documentation on using the root resource pool.
99
- :param pulumi.Input[str] alternate_guest_name: The guest name for the operating system when `guest_id` is `otherGuest` or `otherGuest64`.
100
- :param pulumi.Input[str] annotation: A user-provided description of the virtual machine.
101
- :param pulumi.Input[int] boot_delay: The number of milliseconds to wait before starting the boot sequence. The default is no delay.
102
- :param pulumi.Input[int] boot_retry_delay: The number of milliseconds to wait before retrying the boot sequence. This option is only valid if `boot_retry_enabled` is `true`. Default: `10000` (10 seconds).
103
- :param pulumi.Input[bool] boot_retry_enabled: If set to `true`, a virtual machine that fails to boot will try again after the delay defined in `boot_retry_delay`. Default: `false`.
104
- :param pulumi.Input[Sequence[pulumi.Input['VirtualMachineCdromArgs']]] cdroms: A specification for a CD-ROM device on the virtual machine. See CD-ROM options for more information.
105
- :param pulumi.Input['VirtualMachineCloneArgs'] clone: When specified, the virtual machine will be created as a clone of a specified template. Optional customization options can be submitted for the resource. See creating a virtual machine from a template for more information.
106
- :param pulumi.Input[bool] cpu_hot_add_enabled: Allow CPUs to be added to the virtual machine while it is powered on.
107
- :param pulumi.Input[bool] cpu_hot_remove_enabled: Allow CPUs to be removed to the virtual machine while it is powered on.
108
- :param pulumi.Input[int] cpu_limit: The maximum amount of CPU (in MHz) that the virtual machine can consume, regardless of available resources. The default is no limit.
109
- :param pulumi.Input[bool] cpu_performance_counters_enabled: Enable CPU performance counters on the virtual machine. Default: `false`.
110
- :param pulumi.Input[int] cpu_reservation: The amount of CPU (in MHz) that the virtual machine is guaranteed. The default is no reservation.
111
- :param pulumi.Input[int] cpu_share_count: The number of CPU shares allocated to the virtual machine when the `cpu_share_level` is `custom`.
112
- :param pulumi.Input[str] cpu_share_level: The allocation level for the virtual machine CPU resources. One of `high`, `low`, `normal`, or `custom`. Default: `custom`.
113
- :param pulumi.Input[Mapping[str, pulumi.Input[str]]] custom_attributes: Map of custom attribute ids to attribute value strings to set for virtual machine. Please refer to the `vsphere_custom_attributes` resource for more information on setting custom attributes.
114
-
115
- > **NOTE:** Custom attributes requires vCenter Server and is not supported on direct ESXi host connections.
116
- :param pulumi.Input[str] datacenter_id: The datacenter ID. Required only when deploying an OVF/OVA template.
117
- :param pulumi.Input[str] datastore_cluster_id: The managed object reference ID of the datastore cluster in which to place the virtual machine. This setting applies to entire virtual machine and implies that you wish to use vSphere Storage DRS with the virtual machine. See the section on virtual machine migration for more information on modifying this value.
118
-
119
- > **NOTE:** One of `datastore_id` or `datastore_cluster_id` must be specified.
120
-
121
- > **NOTE:** Use of `datastore_cluster_id` requires vSphere Storage DRS to be enabled on the specified datastore cluster.
122
-
123
- > **NOTE:** The `datastore_cluster_id` setting applies to the entire virtual machine resource. You cannot assign individual individual disks to datastore clusters. In addition, you cannot use the `attach` setting to attach external disks on virtual machines that are assigned to datastore clusters.
124
- :param pulumi.Input[str] datastore_id: The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with `client_device`.
125
- :param pulumi.Input[Sequence[pulumi.Input['VirtualMachineDiskArgs']]] disks: A specification for a virtual disk device on the virtual machine. See disk options for more information.
126
- :param pulumi.Input[bool] efi_secure_boot_enabled: Use this option to enable EFI secure boot when the `firmware` type is set to is `efi`. Default: `false`.
127
-
128
- > **NOTE:** EFI secure boot is only available on vSphere 6.5 and later.
129
- :param pulumi.Input[bool] enable_disk_uuid: Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest. Default: `false`.
130
- :param pulumi.Input[bool] enable_logging: Enable logging of virtual machine events to a log file stored in the virtual machine directory. Default: `false`.
131
- :param pulumi.Input[str] ept_rvi_mode: The EPT/RVI (hardware memory virtualization) setting for the virtual machine. One of `automatic`, `on`, or `off`. Default: `automatic`.
132
- :param pulumi.Input[Mapping[str, pulumi.Input[str]]] extra_config: Extra configuration data for the virtual machine. Can be used to supply advanced parameters not normally in configuration, such as instance metadata and userdata.
133
-
134
- > **NOTE:** Do not use `extra_config` when working with a template imported from OVF/OVA as your settings may be ignored. Use the `vapp` block `properties` section as described in Using vApp Properties for OVF/OVA Configuration.
135
- :param pulumi.Input[bool] extra_config_reboot_required: Allow the virtual machine to be rebooted when a change to `extra_config` occurs. Default: `true`.
136
- :param pulumi.Input[str] firmware: The firmware for the virtual machine. One of `bios` or `efi`.
137
- :param pulumi.Input[str] folder: The path to the virtual machine folder in which to place the virtual machine, relative to the datacenter path (`/<datacenter-name>/vm`). For example, `/dc-01/vm/foo`
138
- :param pulumi.Input[bool] force_power_off: If a guest shutdown failed or times out while updating or destroying (see `shutdown_wait_timeout`), force the power-off of the virtual machine. Default: `true`.
139
- :param pulumi.Input[str] guest_id: The guest ID for the operating system type. For a full list of possible values, see [here][vmware-docs-guest-ids]. Default: `otherGuest64`.
140
-
141
- [vmware-docs-guest-ids]: https://vdc-repo.vmware.com/vmwb-repository/dcr-public/184bb3ba-6fa8-4574-a767-d0c96e2a38f4/ba9422ef-405c-47dd-8553-e11b619185b2/SDK/vsphere-ws/docs/ReferenceGuide/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html
142
- :param pulumi.Input[int] hardware_version: The hardware version number. Valid range is from 4 to 21. The hardware version cannot be downgraded. See virtual machine hardware [versions][virtual-machine-hardware-versions] and [compatibility][virtual-machine-hardware-compatibility] for more information on supported settings.
143
-
144
- [virtual-machine-hardware-versions]: https://kb.vmware.com/s/article/1003746
145
- [virtual-machine-hardware-compatibility]: https://kb.vmware.com/s/article/2007240
146
- :param pulumi.Input[str] host_system_id: The managed object reference ID of a host on which to place the virtual machine. See the section on virtual machine migration for more information on modifying this value. When using a vSphere cluster, if a `host_system_id` is not supplied, vSphere will select a host in the cluster to place the virtual machine, according to any defaults or vSphere DRS placement policies.
147
- :param pulumi.Input[str] hv_mode: The hardware virtualization (non-nested) setting for the virtual machine. One of `hvAuto`, `hvOn`, or `hvOff`. Default: `hvAuto`.
148
- :param pulumi.Input[int] ide_controller_count: The number of IDE controllers that the virtual machine. This directly affects the number of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers. Default: `2`.
149
- :param pulumi.Input[Sequence[pulumi.Input[str]]] ignored_guest_ips: List of IP addresses and CIDR networks to ignore while waiting for an available IP address using either of the waiters. Any IP addresses in this list will be ignored so that the waiter will continue to wait for a valid IP address. Default: `[]`.
150
- :param pulumi.Input[str] latency_sensitivity: Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard devices. One of `low`, `normal`, `medium`, or `high`.
151
-
152
- > **NOTE:** On higher sensitivities, you may need to adjust the `memory_reservation` to the full amount of memory provisioned for the virtual machine.
153
- :param pulumi.Input[int] memory: The memory size to assign to the virtual machine, in MB. Default: `1024` (1 GB).
154
- :param pulumi.Input[bool] memory_hot_add_enabled: Allow memory to be added to the virtual machine while it is powered on.
155
-
156
- > **NOTE:** CPU and memory hot add options are not available on all guest operating systems. Please refer to the [VMware Guest OS Compatibility Guide][vmware-docs-compat-guide] to which settings are allow for your guest operating system. In addition, at least one `pulumi up` must be run before you are able to use CPU and memory hot add.
157
-
158
- [vmware-docs-compat-guide]: http://partnerweb.vmware.com/comp_guide2/pdf/VMware_GOS_Compatibility_Guide.pdf
159
-
160
- > **NOTE:** For Linux 64-bit guest operating systems with less than or equal to 3GB, the virtual machine must powered off to add memory beyond 3GB. Subsequent hot add of memory does not require the virtual machine to be powered-off to apply the plan. Please refer to [VMware KB 2008405][vmware-kb-2008405].
161
-
162
- [vmware-kb-2008405]: https://kb.vmware.com/s/article/2008405
163
- :param pulumi.Input[int] memory_limit: The maximum amount of memory (in MB) that th virtual machine can consume, regardless of available resources. The default is no limit.
164
- :param pulumi.Input[int] memory_reservation: The amount of memory (in MB) that the virtual machine is guaranteed. The default is no reservation.
96
+ :param pulumi.Input[str] resource_pool_id: The ID of a resource pool to put the virtual machine in.
97
+ :param pulumi.Input[str] alternate_guest_name: The guest name for the operating system when guest_id is otherGuest or otherGuest64.
98
+ :param pulumi.Input[str] annotation: User-provided description of the virtual machine.
99
+ :param pulumi.Input[int] boot_delay: The number of milliseconds to wait before starting the boot sequence.
100
+ :param pulumi.Input[int] boot_retry_delay: The number of milliseconds to wait before retrying the boot sequence. This only valid if boot_retry_enabled is true.
101
+ :param pulumi.Input[bool] boot_retry_enabled: If set to true, a virtual machine that fails to boot will try again after the delay defined in boot_retry_delay.
102
+ :param pulumi.Input[Sequence[pulumi.Input['VirtualMachineCdromArgs']]] cdroms: A specification for a CDROM device on this virtual machine.
103
+ :param pulumi.Input['VirtualMachineCloneArgs'] clone: A specification for cloning a virtual machine from template.
104
+ :param pulumi.Input[bool] cpu_hot_add_enabled: Allow CPUs to be added to this virtual machine while it is running.
105
+ :param pulumi.Input[bool] cpu_hot_remove_enabled: Allow CPUs to be added to this virtual machine while it is running.
106
+ :param pulumi.Input[int] cpu_limit: The maximum amount of memory (in MB) or CPU (in MHz) that this virtual machine can consume, regardless of available
107
+ resources.
108
+ :param pulumi.Input[bool] cpu_performance_counters_enabled: Enable CPU performance counters on this virtual machine.
109
+ :param pulumi.Input[int] cpu_reservation: The amount of memory (in MB) or CPU (in MHz) that this virtual machine is guaranteed.
110
+ :param pulumi.Input[int] cpu_share_count: The amount of shares to allocate to cpu for a custom share level.
111
+ :param pulumi.Input[str] cpu_share_level: The allocation level for cpu resources. Can be one of high, low, normal, or custom.
112
+ :param pulumi.Input[Mapping[str, pulumi.Input[str]]] custom_attributes: A list of custom attributes to set on this resource.
113
+ :param pulumi.Input[str] datacenter_id: The ID of the datacenter where the VM is to be created.
114
+ :param pulumi.Input[str] datastore_cluster_id: The ID of a datastore cluster to put the virtual machine in.
115
+ :param pulumi.Input[str] datastore_id: The ID of the virtual machine's datastore. The virtual machine configuration is placed here, along with any virtual
116
+ disks that are created without datastores.
117
+ :param pulumi.Input[Sequence[pulumi.Input['VirtualMachineDiskArgs']]] disks: A specification for a virtual disk device on this virtual machine.
118
+ :param pulumi.Input[bool] efi_secure_boot_enabled: When the boot type set in firmware is efi, this enables EFI secure boot.
119
+ :param pulumi.Input[bool] enable_disk_uuid: Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest.
120
+ :param pulumi.Input[bool] enable_logging: Enable logging on this virtual machine.
121
+ :param pulumi.Input[str] ept_rvi_mode: The EPT/RVI (hardware memory virtualization) setting for this virtual machine. Can be one of automatic, on, or off.
122
+ :param pulumi.Input[Mapping[str, pulumi.Input[str]]] extra_config: Extra configuration data for this virtual machine. Can be used to supply advanced parameters not normally in
123
+ configuration, such as instance metadata, or configuration data for OVF images.
124
+ :param pulumi.Input[bool] extra_config_reboot_required: Allow the virtual machine to be rebooted when a change to `extra_config` occurs.
125
+ :param pulumi.Input[str] firmware: The firmware interface to use on the virtual machine. Can be one of bios or efi.
126
+ :param pulumi.Input[str] folder: The name of the folder to locate the virtual machine in.
127
+ :param pulumi.Input[bool] force_power_off: Set to true to force power-off a virtual machine if a graceful guest shutdown failed for a necessary operation.
128
+ :param pulumi.Input[str] guest_id: The guest ID for the operating system.
129
+ :param pulumi.Input[int] hardware_version: The hardware version for the virtual machine.
130
+ :param pulumi.Input[str] host_system_id: The ID of an optional host system to pin the virtual machine to.
131
+ :param pulumi.Input[str] hv_mode: The (non-nested) hardware virtualization setting for this virtual machine. Can be one of hvAuto, hvOn, or hvOff.
132
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] ignored_guest_ips: List of IP addresses and CIDR networks to ignore while waiting for an IP
133
+ :param pulumi.Input[str] latency_sensitivity: Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower
134
+ latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard
135
+ devices. Can be one of low, normal, medium, or high.
136
+ :param pulumi.Input[int] memory: The size of the virtual machine's memory, in MB.
137
+ :param pulumi.Input[bool] memory_hot_add_enabled: Allow memory to be added to this virtual machine while it is running.
138
+ :param pulumi.Input[int] memory_limit: The maximum amount of memory (in MB) or CPU (in MHz) that this virtual machine can consume, regardless of available
139
+ resources.
140
+ :param pulumi.Input[int] memory_reservation: The amount of memory (in MB) or CPU (in MHz) that this virtual machine is guaranteed.
165
141
  :param pulumi.Input[bool] memory_reservation_locked_to_max: If set true, memory resource reservation for this virtual machine will always be equal to the virtual machine's memory
166
142
  size;increases in memory size will be rejected when a corresponding reservation increase is not possible. This feature
167
143
  may only be enabled if it is currently possible to reserve all of the virtual machine's memory.
168
- :param pulumi.Input[int] memory_share_count: The number of memory shares allocated to the virtual machine when the `memory_share_level` is `custom`.
169
- :param pulumi.Input[str] memory_share_level: The allocation level for the virtual machine memory resources. One of `high`, `low`, `normal`, or `custom`. Default: `custom`.
170
- :param pulumi.Input[int] migrate_wait_timeout: The amount of time, in minutes, to wait for a virtual machine migration to complete before failing. Default: `10` minutes. See the section on virtual machine migration for more information.
171
- :param pulumi.Input[str] name: The name of the virtual machine.
172
- :param pulumi.Input[bool] nested_hv_enabled: Enable nested hardware virtualization on the virtual machine, facilitating nested virtualization in the guest operating system. Default: `false`.
173
- :param pulumi.Input[Sequence[pulumi.Input['VirtualMachineNetworkInterfaceArgs']]] network_interfaces: A specification for a virtual NIC on the virtual machine. See network interface options for more information.
174
- :param pulumi.Input[int] num_cores_per_socket: The number of cores per socket in the virtual machine. The number of vCPUs on the virtual machine will be `num_cpus` divided by `num_cores_per_socket`. If specified, the value supplied to `num_cpus` must be evenly divisible by this value. Default: `1`.
175
- :param pulumi.Input[int] num_cpus: The total number of virtual processor cores to assign to the virtual machine. Default: `1`.
176
- :param pulumi.Input['VirtualMachineOvfDeployArgs'] ovf_deploy: When specified, the virtual machine will be deployed from the provided OVF/OVA template. See creating a virtual machine from an OVF/OVA template for more information.
177
- :param pulumi.Input[Sequence[pulumi.Input[str]]] pci_device_ids: List of host PCI device IDs in which to create PCI passthroughs.
178
-
179
- > **NOTE:** Cloning requires vCenter Server and is not supported on direct ESXi host connections.
144
+ :param pulumi.Input[int] memory_share_count: The amount of shares to allocate to memory for a custom share level.
145
+ :param pulumi.Input[str] memory_share_level: The allocation level for memory resources. Can be one of high, low, normal, or custom.
146
+ :param pulumi.Input[int] migrate_wait_timeout: The amount of time, in minutes, to wait for a vMotion operation to complete before failing.
147
+ :param pulumi.Input[str] name: The name of this virtual machine.
148
+ :param pulumi.Input[bool] nested_hv_enabled: Enable nested hardware virtualization on this virtual machine, facilitating nested virtualization in the guest.
149
+ :param pulumi.Input[Sequence[pulumi.Input['VirtualMachineNetworkInterfaceArgs']]] network_interfaces: A specification for a virtual NIC on this virtual machine.
150
+ :param pulumi.Input[int] num_cores_per_socket: The number of cores to distribute amongst the CPUs in this virtual machine. If specified, the value supplied to num_cpus
151
+ must be evenly divisible by this value.
152
+ :param pulumi.Input[int] num_cpus: The number of virtual processors to assign to this virtual machine.
153
+ :param pulumi.Input['VirtualMachineOvfDeployArgs'] ovf_deploy: A specification for deploying a virtual machine from ovf/ova template.
154
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] pci_device_ids: A list of PCI passthrough devices
180
155
  :param pulumi.Input[int] poweron_timeout: The amount of time, in seconds, that we will be trying to power on a VM
181
156
  :param pulumi.Input[str] replace_trigger: Triggers replacement of resource whenever it changes.
182
-
183
- For example, `replace_trigger = sha256(format("%!s(MISSING)-%!s(MISSING)",data.template_file.cloud_init_metadata.rendered,data.template_file.cloud_init_userdata.rendered))` will fingerprint the changes in cloud-init metadata and userdata templates. This will enable a replacement of the resource whenever the dependant template renders a new configuration. (Forces a replacement.)
184
- :param pulumi.Input[bool] run_tools_scripts_after_power_on: Enable post-power-on scripts to run when VMware Tools is installed. Default: `true`.
185
- :param pulumi.Input[bool] run_tools_scripts_after_resume: Enable ost-resume scripts to run when VMware Tools is installed. Default: `true`.
186
- :param pulumi.Input[bool] run_tools_scripts_before_guest_reboot: Enable pre-reboot scripts to run when VMware Tools is installed. Default: `false`.
187
- :param pulumi.Input[bool] run_tools_scripts_before_guest_shutdown: Enable pre-shutdown scripts to run when VMware Tools is installed. Default: `true`.
188
- :param pulumi.Input[bool] run_tools_scripts_before_guest_standby: Enable pre-standby scripts to run when VMware Tools is installed. Default: `true`.
189
- :param pulumi.Input[int] sata_controller_count: The number of SATA controllers that Terraform manages on this virtual machine. This directly affects the amount of disks
190
- you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove
191
- controllers.
192
- :param pulumi.Input[str] scsi_bus_sharing: The type of SCSI bus sharing for the virtual machine SCSI controller. One of `physicalSharing`, `virtualSharing`, and `noSharing`. Default: `noSharing`.
193
- :param pulumi.Input[int] scsi_controller_count: The number of SCSI controllers that Terraform manages on this virtual machine. This directly affects the amount of disks
194
- you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove
195
- controllers.
196
- :param pulumi.Input[str] scsi_type: The SCSI controller type for the virtual machine. One of `lsilogic` (LSI Logic Parallel), `lsilogic-sas` (LSI Logic SAS) or `pvscsi` (VMware Paravirtual). Default: `pvscsi`.
197
- :param pulumi.Input[int] shutdown_wait_timeout: The amount of time, in minutes, to wait for a graceful guest shutdown when making necessary updates to the virtual machine. If `force_power_off` is set to `true`, the virtual machine will be forced to power-off after the timeout, otherwise an error is returned. Default: `3` minutes.
198
- :param pulumi.Input[str] storage_policy_id: The UUID of the storage policy to assign to the virtual disk.
199
- :param pulumi.Input[str] swap_placement_policy: The swap file placement policy for the virtual machine. One of `inherit`, `hostLocal`, or `vmDirectory`. Default: `inherit`.
200
- :param pulumi.Input[bool] sync_time_with_host: Enable the guest operating system to synchronization its clock with the host when the virtual machine is powered on or resumed. Requires vSphere 7.0 Update 1 and later. Requires VMware Tools to be installed. Default: `true`.
201
- :param pulumi.Input[bool] sync_time_with_host_periodically: Enable the guest operating system to periodically synchronize its clock with the host. Requires vSphere 7.0 Update 1 and later. On previous versions, setting `sync_time_with_host` is will enable periodic synchronization. Requires VMware Tools to be installed. Default: `false`.
202
- :param pulumi.Input[Sequence[pulumi.Input[str]]] tags: The IDs of any tags to attach to this resource. Please refer to the `Tag` resource for more information on applying tags to virtual machine resources.
203
-
204
- > **NOTE:** Tagging support is unsupported on direct ESXi host connections and requires vCenter Server instance.
205
- :param pulumi.Input[str] tools_upgrade_policy: Enable automatic upgrade of the VMware Tools version when the virtual machine is rebooted. If necessary, VMware Tools is upgraded to the latest version supported by the host on which the virtual machine is running. Requires VMware Tools to be installed. One of `manual` or `upgradeAtPowerCycle`. Default: `manual`.
206
- :param pulumi.Input['VirtualMachineVappArgs'] vapp: Used for vApp configurations. The only sub-key available is `properties`, which is a key/value map of properties for virtual machines imported from and OVF/OVA. See Using vApp Properties for OVF/OVA Configuration for more information.
207
- :param pulumi.Input[bool] vbs_enabled: Enable Virtualization Based Security. Requires `firmware` to be `efi`. In addition, `vvtd_enabled`, `nested_hv_enabled`, and `efi_secure_boot_enabled` must all have a value of `true`. Supported on vSphere 6.7 and later. Default: `false`.
208
- :param pulumi.Input[bool] vvtd_enabled: Enable Intel Virtualization Technology for Directed I/O for the virtual machine (_I/O MMU_ in the vSphere Client). Supported on vSphere 6.7 and later. Default: `false`.
209
- :param pulumi.Input[int] wait_for_guest_ip_timeout: The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. This should only be used if the version VMware Tools does not allow the `wait_for_guest_net_timeout` waiter to be used. A value less than `1` disables the waiter. Default: `0`.
210
- :param pulumi.Input[bool] wait_for_guest_net_routable: Controls whether or not the guest network waiter waits for a routable address. When `false`, the waiter does not wait for a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria. This property is ignored if the `wait_for_guest_ip_timeout` waiter is used. Default: `true`.
211
- :param pulumi.Input[int] wait_for_guest_net_timeout: The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. Older versions of VMware Tools do not populate this property. In those cases, this waiter can be disabled and the `wait_for_guest_ip_timeout` waiter can be used instead. A value less than `1` disables the waiter. Default: `5` minutes.
157
+ :param pulumi.Input[bool] run_tools_scripts_after_power_on: Enable the run of scripts after virtual machine power-on when VMware Tools is installed.
158
+ :param pulumi.Input[bool] run_tools_scripts_after_resume: Enable the run of scripts after virtual machine resume when when VMware Tools is installed.
159
+ :param pulumi.Input[bool] run_tools_scripts_before_guest_reboot: Enable the run of scripts before guest operating system reboot when VMware Tools is installed.
160
+ :param pulumi.Input[bool] run_tools_scripts_before_guest_shutdown: Enable the run of scripts before guest operating system shutdown when VMware Tools is installed.
161
+ :param pulumi.Input[bool] run_tools_scripts_before_guest_standby: Enable the run of scripts before guest operating system standby when VMware Tools is installed.
162
+ :param pulumi.Input[str] scsi_bus_sharing: Mode for sharing the SCSI bus. The modes are physicalSharing, virtualSharing, and noSharing.
163
+ :param pulumi.Input[str] scsi_type: The type of SCSI bus this virtual machine will have. Can be one of lsilogic, lsilogic-sas or pvscsi.
164
+ :param pulumi.Input[int] shutdown_wait_timeout: The amount of time, in minutes, to wait for shutdown when making necessary updates to the virtual machine.
165
+ :param pulumi.Input[str] storage_policy_id: The ID of the storage policy to assign to the virtual machine home directory.
166
+ :param pulumi.Input[str] swap_placement_policy: The swap file placement policy for this virtual machine. Can be one of inherit, hostLocal, or vmDirectory.
167
+ :param pulumi.Input[bool] sync_time_with_host: Enable guest clock synchronization with the host. On vSphere 7.0 U1 and above, with only this setting the clock is
168
+ synchronized on startup and resume. Requires VMware Tools to be installed.
169
+ :param pulumi.Input[bool] sync_time_with_host_periodically: Enable periodic clock synchronization with the host. Supported only on vSphere 7.0 U1 and above. On prior versions
170
+ setting `sync_time_with_host` is enough for periodic synchronization. Requires VMware Tools to be installed.
171
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] tags: A list of tag IDs to apply to this object.
172
+ :param pulumi.Input[str] tools_upgrade_policy: Set the upgrade policy for VMware Tools. Can be one of `manual` or `upgradeAtPowerCycle`.
173
+ :param pulumi.Input['VirtualMachineVappArgs'] vapp: vApp configuration data for this virtual machine. Can be used to provide configuration data for OVF images.
174
+ :param pulumi.Input[bool] vbs_enabled: Flag to specify if Virtualization-based security is enabled for this virtual machine.
175
+ :param pulumi.Input[bool] vvtd_enabled: Flag to specify if I/O MMU virtualization, also called Intel Virtualization Technology for Directed I/O (VT-d) and AMD
176
+ I/O Virtualization (AMD-Vi or IOMMU), is enabled.
177
+ :param pulumi.Input[int] wait_for_guest_ip_timeout: The amount of time, in minutes, to wait for an available IP address on this virtual machine. A value less than 1
178
+ disables the waiter.
179
+ :param pulumi.Input[bool] wait_for_guest_net_routable: Controls whether or not the guest network waiter waits for a routable address. When false, the waiter does not wait for
180
+ a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria.
181
+ :param pulumi.Input[int] wait_for_guest_net_timeout: The amount of time, in minutes, to wait for an available IP address on this virtual machine. A value less than 1
182
+ disables the waiter.
212
183
  """
213
184
  pulumi.set(__self__, "resource_pool_id", resource_pool_id)
214
185
  if alternate_guest_name is not None:
@@ -364,9 +335,7 @@ class VirtualMachineArgs:
364
335
  @pulumi.getter(name="resourcePoolId")
365
336
  def resource_pool_id(self) -> pulumi.Input[str]:
366
337
  """
367
- The managed object reference ID of the resource pool in which to place the virtual machine. See the Virtual Machine Migration section for more information on modifying this value.
368
-
369
- > **NOTE:** All clusters and standalone hosts have a default root resource pool. This resource argument does not directly accept the cluster or standalone host resource. For more information, see the section on specifying the Root Resource Pool in the `ResourcePool` data source documentation on using the root resource pool.
338
+ The ID of a resource pool to put the virtual machine in.
370
339
  """
371
340
  return pulumi.get(self, "resource_pool_id")
372
341
 
@@ -378,7 +347,7 @@ class VirtualMachineArgs:
378
347
  @pulumi.getter(name="alternateGuestName")
379
348
  def alternate_guest_name(self) -> Optional[pulumi.Input[str]]:
380
349
  """
381
- The guest name for the operating system when `guest_id` is `otherGuest` or `otherGuest64`.
350
+ The guest name for the operating system when guest_id is otherGuest or otherGuest64.
382
351
  """
383
352
  return pulumi.get(self, "alternate_guest_name")
384
353
 
@@ -390,7 +359,7 @@ class VirtualMachineArgs:
390
359
  @pulumi.getter
391
360
  def annotation(self) -> Optional[pulumi.Input[str]]:
392
361
  """
393
- A user-provided description of the virtual machine.
362
+ User-provided description of the virtual machine.
394
363
  """
395
364
  return pulumi.get(self, "annotation")
396
365
 
@@ -402,7 +371,7 @@ class VirtualMachineArgs:
402
371
  @pulumi.getter(name="bootDelay")
403
372
  def boot_delay(self) -> Optional[pulumi.Input[int]]:
404
373
  """
405
- The number of milliseconds to wait before starting the boot sequence. The default is no delay.
374
+ The number of milliseconds to wait before starting the boot sequence.
406
375
  """
407
376
  return pulumi.get(self, "boot_delay")
408
377
 
@@ -414,7 +383,7 @@ class VirtualMachineArgs:
414
383
  @pulumi.getter(name="bootRetryDelay")
415
384
  def boot_retry_delay(self) -> Optional[pulumi.Input[int]]:
416
385
  """
417
- The number of milliseconds to wait before retrying the boot sequence. This option is only valid if `boot_retry_enabled` is `true`. Default: `10000` (10 seconds).
386
+ The number of milliseconds to wait before retrying the boot sequence. This only valid if boot_retry_enabled is true.
418
387
  """
419
388
  return pulumi.get(self, "boot_retry_delay")
420
389
 
@@ -426,7 +395,7 @@ class VirtualMachineArgs:
426
395
  @pulumi.getter(name="bootRetryEnabled")
427
396
  def boot_retry_enabled(self) -> Optional[pulumi.Input[bool]]:
428
397
  """
429
- If set to `true`, a virtual machine that fails to boot will try again after the delay defined in `boot_retry_delay`. Default: `false`.
398
+ If set to true, a virtual machine that fails to boot will try again after the delay defined in boot_retry_delay.
430
399
  """
431
400
  return pulumi.get(self, "boot_retry_enabled")
432
401
 
@@ -438,7 +407,7 @@ class VirtualMachineArgs:
438
407
  @pulumi.getter
439
408
  def cdroms(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['VirtualMachineCdromArgs']]]]:
440
409
  """
441
- A specification for a CD-ROM device on the virtual machine. See CD-ROM options for more information.
410
+ A specification for a CDROM device on this virtual machine.
442
411
  """
443
412
  return pulumi.get(self, "cdroms")
444
413
 
@@ -450,7 +419,7 @@ class VirtualMachineArgs:
450
419
  @pulumi.getter
451
420
  def clone(self) -> Optional[pulumi.Input['VirtualMachineCloneArgs']]:
452
421
  """
453
- When specified, the virtual machine will be created as a clone of a specified template. Optional customization options can be submitted for the resource. See creating a virtual machine from a template for more information.
422
+ A specification for cloning a virtual machine from template.
454
423
  """
455
424
  return pulumi.get(self, "clone")
456
425
 
@@ -462,7 +431,7 @@ class VirtualMachineArgs:
462
431
  @pulumi.getter(name="cpuHotAddEnabled")
463
432
  def cpu_hot_add_enabled(self) -> Optional[pulumi.Input[bool]]:
464
433
  """
465
- Allow CPUs to be added to the virtual machine while it is powered on.
434
+ Allow CPUs to be added to this virtual machine while it is running.
466
435
  """
467
436
  return pulumi.get(self, "cpu_hot_add_enabled")
468
437
 
@@ -474,7 +443,7 @@ class VirtualMachineArgs:
474
443
  @pulumi.getter(name="cpuHotRemoveEnabled")
475
444
  def cpu_hot_remove_enabled(self) -> Optional[pulumi.Input[bool]]:
476
445
  """
477
- Allow CPUs to be removed to the virtual machine while it is powered on.
446
+ Allow CPUs to be added to this virtual machine while it is running.
478
447
  """
479
448
  return pulumi.get(self, "cpu_hot_remove_enabled")
480
449
 
@@ -486,7 +455,8 @@ class VirtualMachineArgs:
486
455
  @pulumi.getter(name="cpuLimit")
487
456
  def cpu_limit(self) -> Optional[pulumi.Input[int]]:
488
457
  """
489
- The maximum amount of CPU (in MHz) that the virtual machine can consume, regardless of available resources. The default is no limit.
458
+ The maximum amount of memory (in MB) or CPU (in MHz) that this virtual machine can consume, regardless of available
459
+ resources.
490
460
  """
491
461
  return pulumi.get(self, "cpu_limit")
492
462
 
@@ -498,7 +468,7 @@ class VirtualMachineArgs:
498
468
  @pulumi.getter(name="cpuPerformanceCountersEnabled")
499
469
  def cpu_performance_counters_enabled(self) -> Optional[pulumi.Input[bool]]:
500
470
  """
501
- Enable CPU performance counters on the virtual machine. Default: `false`.
471
+ Enable CPU performance counters on this virtual machine.
502
472
  """
503
473
  return pulumi.get(self, "cpu_performance_counters_enabled")
504
474
 
@@ -510,7 +480,7 @@ class VirtualMachineArgs:
510
480
  @pulumi.getter(name="cpuReservation")
511
481
  def cpu_reservation(self) -> Optional[pulumi.Input[int]]:
512
482
  """
513
- The amount of CPU (in MHz) that the virtual machine is guaranteed. The default is no reservation.
483
+ The amount of memory (in MB) or CPU (in MHz) that this virtual machine is guaranteed.
514
484
  """
515
485
  return pulumi.get(self, "cpu_reservation")
516
486
 
@@ -522,7 +492,7 @@ class VirtualMachineArgs:
522
492
  @pulumi.getter(name="cpuShareCount")
523
493
  def cpu_share_count(self) -> Optional[pulumi.Input[int]]:
524
494
  """
525
- The number of CPU shares allocated to the virtual machine when the `cpu_share_level` is `custom`.
495
+ The amount of shares to allocate to cpu for a custom share level.
526
496
  """
527
497
  return pulumi.get(self, "cpu_share_count")
528
498
 
@@ -534,7 +504,7 @@ class VirtualMachineArgs:
534
504
  @pulumi.getter(name="cpuShareLevel")
535
505
  def cpu_share_level(self) -> Optional[pulumi.Input[str]]:
536
506
  """
537
- The allocation level for the virtual machine CPU resources. One of `high`, `low`, `normal`, or `custom`. Default: `custom`.
507
+ The allocation level for cpu resources. Can be one of high, low, normal, or custom.
538
508
  """
539
509
  return pulumi.get(self, "cpu_share_level")
540
510
 
@@ -546,9 +516,7 @@ class VirtualMachineArgs:
546
516
  @pulumi.getter(name="customAttributes")
547
517
  def custom_attributes(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]:
548
518
  """
549
- Map of custom attribute ids to attribute value strings to set for virtual machine. Please refer to the `vsphere_custom_attributes` resource for more information on setting custom attributes.
550
-
551
- > **NOTE:** Custom attributes requires vCenter Server and is not supported on direct ESXi host connections.
519
+ A list of custom attributes to set on this resource.
552
520
  """
553
521
  return pulumi.get(self, "custom_attributes")
554
522
 
@@ -560,7 +528,7 @@ class VirtualMachineArgs:
560
528
  @pulumi.getter(name="datacenterId")
561
529
  def datacenter_id(self) -> Optional[pulumi.Input[str]]:
562
530
  """
563
- The datacenter ID. Required only when deploying an OVF/OVA template.
531
+ The ID of the datacenter where the VM is to be created.
564
532
  """
565
533
  return pulumi.get(self, "datacenter_id")
566
534
 
@@ -572,13 +540,7 @@ class VirtualMachineArgs:
572
540
  @pulumi.getter(name="datastoreClusterId")
573
541
  def datastore_cluster_id(self) -> Optional[pulumi.Input[str]]:
574
542
  """
575
- The managed object reference ID of the datastore cluster in which to place the virtual machine. This setting applies to entire virtual machine and implies that you wish to use vSphere Storage DRS with the virtual machine. See the section on virtual machine migration for more information on modifying this value.
576
-
577
- > **NOTE:** One of `datastore_id` or `datastore_cluster_id` must be specified.
578
-
579
- > **NOTE:** Use of `datastore_cluster_id` requires vSphere Storage DRS to be enabled on the specified datastore cluster.
580
-
581
- > **NOTE:** The `datastore_cluster_id` setting applies to the entire virtual machine resource. You cannot assign individual individual disks to datastore clusters. In addition, you cannot use the `attach` setting to attach external disks on virtual machines that are assigned to datastore clusters.
543
+ The ID of a datastore cluster to put the virtual machine in.
582
544
  """
583
545
  return pulumi.get(self, "datastore_cluster_id")
584
546
 
@@ -590,7 +552,8 @@ class VirtualMachineArgs:
590
552
  @pulumi.getter(name="datastoreId")
591
553
  def datastore_id(self) -> Optional[pulumi.Input[str]]:
592
554
  """
593
- The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with `client_device`.
555
+ The ID of the virtual machine's datastore. The virtual machine configuration is placed here, along with any virtual
556
+ disks that are created without datastores.
594
557
  """
595
558
  return pulumi.get(self, "datastore_id")
596
559
 
@@ -602,7 +565,7 @@ class VirtualMachineArgs:
602
565
  @pulumi.getter
603
566
  def disks(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['VirtualMachineDiskArgs']]]]:
604
567
  """
605
- A specification for a virtual disk device on the virtual machine. See disk options for more information.
568
+ A specification for a virtual disk device on this virtual machine.
606
569
  """
607
570
  return pulumi.get(self, "disks")
608
571
 
@@ -614,9 +577,7 @@ class VirtualMachineArgs:
614
577
  @pulumi.getter(name="efiSecureBootEnabled")
615
578
  def efi_secure_boot_enabled(self) -> Optional[pulumi.Input[bool]]:
616
579
  """
617
- Use this option to enable EFI secure boot when the `firmware` type is set to is `efi`. Default: `false`.
618
-
619
- > **NOTE:** EFI secure boot is only available on vSphere 6.5 and later.
580
+ When the boot type set in firmware is efi, this enables EFI secure boot.
620
581
  """
621
582
  return pulumi.get(self, "efi_secure_boot_enabled")
622
583
 
@@ -628,7 +589,7 @@ class VirtualMachineArgs:
628
589
  @pulumi.getter(name="enableDiskUuid")
629
590
  def enable_disk_uuid(self) -> Optional[pulumi.Input[bool]]:
630
591
  """
631
- Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest. Default: `false`.
592
+ Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest.
632
593
  """
633
594
  return pulumi.get(self, "enable_disk_uuid")
634
595
 
@@ -640,7 +601,7 @@ class VirtualMachineArgs:
640
601
  @pulumi.getter(name="enableLogging")
641
602
  def enable_logging(self) -> Optional[pulumi.Input[bool]]:
642
603
  """
643
- Enable logging of virtual machine events to a log file stored in the virtual machine directory. Default: `false`.
604
+ Enable logging on this virtual machine.
644
605
  """
645
606
  return pulumi.get(self, "enable_logging")
646
607
 
@@ -652,7 +613,7 @@ class VirtualMachineArgs:
652
613
  @pulumi.getter(name="eptRviMode")
653
614
  def ept_rvi_mode(self) -> Optional[pulumi.Input[str]]:
654
615
  """
655
- The EPT/RVI (hardware memory virtualization) setting for the virtual machine. One of `automatic`, `on`, or `off`. Default: `automatic`.
616
+ The EPT/RVI (hardware memory virtualization) setting for this virtual machine. Can be one of automatic, on, or off.
656
617
  """
657
618
  return pulumi.get(self, "ept_rvi_mode")
658
619
 
@@ -664,9 +625,8 @@ class VirtualMachineArgs:
664
625
  @pulumi.getter(name="extraConfig")
665
626
  def extra_config(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]:
666
627
  """
667
- Extra configuration data for the virtual machine. Can be used to supply advanced parameters not normally in configuration, such as instance metadata and userdata.
668
-
669
- > **NOTE:** Do not use `extra_config` when working with a template imported from OVF/OVA as your settings may be ignored. Use the `vapp` block `properties` section as described in Using vApp Properties for OVF/OVA Configuration.
628
+ Extra configuration data for this virtual machine. Can be used to supply advanced parameters not normally in
629
+ configuration, such as instance metadata, or configuration data for OVF images.
670
630
  """
671
631
  return pulumi.get(self, "extra_config")
672
632
 
@@ -678,7 +638,7 @@ class VirtualMachineArgs:
678
638
  @pulumi.getter(name="extraConfigRebootRequired")
679
639
  def extra_config_reboot_required(self) -> Optional[pulumi.Input[bool]]:
680
640
  """
681
- Allow the virtual machine to be rebooted when a change to `extra_config` occurs. Default: `true`.
641
+ Allow the virtual machine to be rebooted when a change to `extra_config` occurs.
682
642
  """
683
643
  return pulumi.get(self, "extra_config_reboot_required")
684
644
 
@@ -690,7 +650,7 @@ class VirtualMachineArgs:
690
650
  @pulumi.getter
691
651
  def firmware(self) -> Optional[pulumi.Input[str]]:
692
652
  """
693
- The firmware for the virtual machine. One of `bios` or `efi`.
653
+ The firmware interface to use on the virtual machine. Can be one of bios or efi.
694
654
  """
695
655
  return pulumi.get(self, "firmware")
696
656
 
@@ -702,7 +662,7 @@ class VirtualMachineArgs:
702
662
  @pulumi.getter
703
663
  def folder(self) -> Optional[pulumi.Input[str]]:
704
664
  """
705
- The path to the virtual machine folder in which to place the virtual machine, relative to the datacenter path (`/<datacenter-name>/vm`). For example, `/dc-01/vm/foo`
665
+ The name of the folder to locate the virtual machine in.
706
666
  """
707
667
  return pulumi.get(self, "folder")
708
668
 
@@ -714,7 +674,7 @@ class VirtualMachineArgs:
714
674
  @pulumi.getter(name="forcePowerOff")
715
675
  def force_power_off(self) -> Optional[pulumi.Input[bool]]:
716
676
  """
717
- If a guest shutdown failed or times out while updating or destroying (see `shutdown_wait_timeout`), force the power-off of the virtual machine. Default: `true`.
677
+ Set to true to force power-off a virtual machine if a graceful guest shutdown failed for a necessary operation.
718
678
  """
719
679
  return pulumi.get(self, "force_power_off")
720
680
 
@@ -726,9 +686,7 @@ class VirtualMachineArgs:
726
686
  @pulumi.getter(name="guestId")
727
687
  def guest_id(self) -> Optional[pulumi.Input[str]]:
728
688
  """
729
- The guest ID for the operating system type. For a full list of possible values, see [here][vmware-docs-guest-ids]. Default: `otherGuest64`.
730
-
731
- [vmware-docs-guest-ids]: https://vdc-repo.vmware.com/vmwb-repository/dcr-public/184bb3ba-6fa8-4574-a767-d0c96e2a38f4/ba9422ef-405c-47dd-8553-e11b619185b2/SDK/vsphere-ws/docs/ReferenceGuide/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html
689
+ The guest ID for the operating system.
732
690
  """
733
691
  return pulumi.get(self, "guest_id")
734
692
 
@@ -740,10 +698,7 @@ class VirtualMachineArgs:
740
698
  @pulumi.getter(name="hardwareVersion")
741
699
  def hardware_version(self) -> Optional[pulumi.Input[int]]:
742
700
  """
743
- The hardware version number. Valid range is from 4 to 21. The hardware version cannot be downgraded. See virtual machine hardware [versions][virtual-machine-hardware-versions] and [compatibility][virtual-machine-hardware-compatibility] for more information on supported settings.
744
-
745
- [virtual-machine-hardware-versions]: https://kb.vmware.com/s/article/1003746
746
- [virtual-machine-hardware-compatibility]: https://kb.vmware.com/s/article/2007240
701
+ The hardware version for the virtual machine.
747
702
  """
748
703
  return pulumi.get(self, "hardware_version")
749
704
 
@@ -755,7 +710,7 @@ class VirtualMachineArgs:
755
710
  @pulumi.getter(name="hostSystemId")
756
711
  def host_system_id(self) -> Optional[pulumi.Input[str]]:
757
712
  """
758
- The managed object reference ID of a host on which to place the virtual machine. See the section on virtual machine migration for more information on modifying this value. When using a vSphere cluster, if a `host_system_id` is not supplied, vSphere will select a host in the cluster to place the virtual machine, according to any defaults or vSphere DRS placement policies.
713
+ The ID of an optional host system to pin the virtual machine to.
759
714
  """
760
715
  return pulumi.get(self, "host_system_id")
761
716
 
@@ -767,7 +722,7 @@ class VirtualMachineArgs:
767
722
  @pulumi.getter(name="hvMode")
768
723
  def hv_mode(self) -> Optional[pulumi.Input[str]]:
769
724
  """
770
- The hardware virtualization (non-nested) setting for the virtual machine. One of `hvAuto`, `hvOn`, or `hvOff`. Default: `hvAuto`.
725
+ The (non-nested) hardware virtualization setting for this virtual machine. Can be one of hvAuto, hvOn, or hvOff.
771
726
  """
772
727
  return pulumi.get(self, "hv_mode")
773
728
 
@@ -778,9 +733,6 @@ class VirtualMachineArgs:
778
733
  @property
779
734
  @pulumi.getter(name="ideControllerCount")
780
735
  def ide_controller_count(self) -> Optional[pulumi.Input[int]]:
781
- """
782
- The number of IDE controllers that the virtual machine. This directly affects the number of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers. Default: `2`.
783
- """
784
736
  return pulumi.get(self, "ide_controller_count")
785
737
 
786
738
  @ide_controller_count.setter
@@ -791,7 +743,7 @@ class VirtualMachineArgs:
791
743
  @pulumi.getter(name="ignoredGuestIps")
792
744
  def ignored_guest_ips(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
793
745
  """
794
- List of IP addresses and CIDR networks to ignore while waiting for an available IP address using either of the waiters. Any IP addresses in this list will be ignored so that the waiter will continue to wait for a valid IP address. Default: `[]`.
746
+ List of IP addresses and CIDR networks to ignore while waiting for an IP
795
747
  """
796
748
  return pulumi.get(self, "ignored_guest_ips")
797
749
 
@@ -803,9 +755,9 @@ class VirtualMachineArgs:
803
755
  @pulumi.getter(name="latencySensitivity")
804
756
  def latency_sensitivity(self) -> Optional[pulumi.Input[str]]:
805
757
  """
806
- Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard devices. One of `low`, `normal`, `medium`, or `high`.
807
-
808
- > **NOTE:** On higher sensitivities, you may need to adjust the `memory_reservation` to the full amount of memory provisioned for the virtual machine.
758
+ Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower
759
+ latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard
760
+ devices. Can be one of low, normal, medium, or high.
809
761
  """
810
762
  return pulumi.get(self, "latency_sensitivity")
811
763
 
@@ -817,7 +769,7 @@ class VirtualMachineArgs:
817
769
  @pulumi.getter
818
770
  def memory(self) -> Optional[pulumi.Input[int]]:
819
771
  """
820
- The memory size to assign to the virtual machine, in MB. Default: `1024` (1 GB).
772
+ The size of the virtual machine's memory, in MB.
821
773
  """
822
774
  return pulumi.get(self, "memory")
823
775
 
@@ -829,15 +781,7 @@ class VirtualMachineArgs:
829
781
  @pulumi.getter(name="memoryHotAddEnabled")
830
782
  def memory_hot_add_enabled(self) -> Optional[pulumi.Input[bool]]:
831
783
  """
832
- Allow memory to be added to the virtual machine while it is powered on.
833
-
834
- > **NOTE:** CPU and memory hot add options are not available on all guest operating systems. Please refer to the [VMware Guest OS Compatibility Guide][vmware-docs-compat-guide] to which settings are allow for your guest operating system. In addition, at least one `pulumi up` must be run before you are able to use CPU and memory hot add.
835
-
836
- [vmware-docs-compat-guide]: http://partnerweb.vmware.com/comp_guide2/pdf/VMware_GOS_Compatibility_Guide.pdf
837
-
838
- > **NOTE:** For Linux 64-bit guest operating systems with less than or equal to 3GB, the virtual machine must powered off to add memory beyond 3GB. Subsequent hot add of memory does not require the virtual machine to be powered-off to apply the plan. Please refer to [VMware KB 2008405][vmware-kb-2008405].
839
-
840
- [vmware-kb-2008405]: https://kb.vmware.com/s/article/2008405
784
+ Allow memory to be added to this virtual machine while it is running.
841
785
  """
842
786
  return pulumi.get(self, "memory_hot_add_enabled")
843
787
 
@@ -849,7 +793,8 @@ class VirtualMachineArgs:
849
793
  @pulumi.getter(name="memoryLimit")
850
794
  def memory_limit(self) -> Optional[pulumi.Input[int]]:
851
795
  """
852
- The maximum amount of memory (in MB) that th virtual machine can consume, regardless of available resources. The default is no limit.
796
+ The maximum amount of memory (in MB) or CPU (in MHz) that this virtual machine can consume, regardless of available
797
+ resources.
853
798
  """
854
799
  return pulumi.get(self, "memory_limit")
855
800
 
@@ -861,7 +806,7 @@ class VirtualMachineArgs:
861
806
  @pulumi.getter(name="memoryReservation")
862
807
  def memory_reservation(self) -> Optional[pulumi.Input[int]]:
863
808
  """
864
- The amount of memory (in MB) that the virtual machine is guaranteed. The default is no reservation.
809
+ The amount of memory (in MB) or CPU (in MHz) that this virtual machine is guaranteed.
865
810
  """
866
811
  return pulumi.get(self, "memory_reservation")
867
812
 
@@ -887,7 +832,7 @@ class VirtualMachineArgs:
887
832
  @pulumi.getter(name="memoryShareCount")
888
833
  def memory_share_count(self) -> Optional[pulumi.Input[int]]:
889
834
  """
890
- The number of memory shares allocated to the virtual machine when the `memory_share_level` is `custom`.
835
+ The amount of shares to allocate to memory for a custom share level.
891
836
  """
892
837
  return pulumi.get(self, "memory_share_count")
893
838
 
@@ -899,7 +844,7 @@ class VirtualMachineArgs:
899
844
  @pulumi.getter(name="memoryShareLevel")
900
845
  def memory_share_level(self) -> Optional[pulumi.Input[str]]:
901
846
  """
902
- The allocation level for the virtual machine memory resources. One of `high`, `low`, `normal`, or `custom`. Default: `custom`.
847
+ The allocation level for memory resources. Can be one of high, low, normal, or custom.
903
848
  """
904
849
  return pulumi.get(self, "memory_share_level")
905
850
 
@@ -911,7 +856,7 @@ class VirtualMachineArgs:
911
856
  @pulumi.getter(name="migrateWaitTimeout")
912
857
  def migrate_wait_timeout(self) -> Optional[pulumi.Input[int]]:
913
858
  """
914
- The amount of time, in minutes, to wait for a virtual machine migration to complete before failing. Default: `10` minutes. See the section on virtual machine migration for more information.
859
+ The amount of time, in minutes, to wait for a vMotion operation to complete before failing.
915
860
  """
916
861
  return pulumi.get(self, "migrate_wait_timeout")
917
862
 
@@ -923,7 +868,7 @@ class VirtualMachineArgs:
923
868
  @pulumi.getter
924
869
  def name(self) -> Optional[pulumi.Input[str]]:
925
870
  """
926
- The name of the virtual machine.
871
+ The name of this virtual machine.
927
872
  """
928
873
  return pulumi.get(self, "name")
929
874
 
@@ -935,7 +880,7 @@ class VirtualMachineArgs:
935
880
  @pulumi.getter(name="nestedHvEnabled")
936
881
  def nested_hv_enabled(self) -> Optional[pulumi.Input[bool]]:
937
882
  """
938
- Enable nested hardware virtualization on the virtual machine, facilitating nested virtualization in the guest operating system. Default: `false`.
883
+ Enable nested hardware virtualization on this virtual machine, facilitating nested virtualization in the guest.
939
884
  """
940
885
  return pulumi.get(self, "nested_hv_enabled")
941
886
 
@@ -947,7 +892,7 @@ class VirtualMachineArgs:
947
892
  @pulumi.getter(name="networkInterfaces")
948
893
  def network_interfaces(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['VirtualMachineNetworkInterfaceArgs']]]]:
949
894
  """
950
- A specification for a virtual NIC on the virtual machine. See network interface options for more information.
895
+ A specification for a virtual NIC on this virtual machine.
951
896
  """
952
897
  return pulumi.get(self, "network_interfaces")
953
898
 
@@ -959,7 +904,8 @@ class VirtualMachineArgs:
959
904
  @pulumi.getter(name="numCoresPerSocket")
960
905
  def num_cores_per_socket(self) -> Optional[pulumi.Input[int]]:
961
906
  """
962
- The number of cores per socket in the virtual machine. The number of vCPUs on the virtual machine will be `num_cpus` divided by `num_cores_per_socket`. If specified, the value supplied to `num_cpus` must be evenly divisible by this value. Default: `1`.
907
+ The number of cores to distribute amongst the CPUs in this virtual machine. If specified, the value supplied to num_cpus
908
+ must be evenly divisible by this value.
963
909
  """
964
910
  return pulumi.get(self, "num_cores_per_socket")
965
911
 
@@ -971,7 +917,7 @@ class VirtualMachineArgs:
971
917
  @pulumi.getter(name="numCpus")
972
918
  def num_cpus(self) -> Optional[pulumi.Input[int]]:
973
919
  """
974
- The total number of virtual processor cores to assign to the virtual machine. Default: `1`.
920
+ The number of virtual processors to assign to this virtual machine.
975
921
  """
976
922
  return pulumi.get(self, "num_cpus")
977
923
 
@@ -983,7 +929,7 @@ class VirtualMachineArgs:
983
929
  @pulumi.getter(name="ovfDeploy")
984
930
  def ovf_deploy(self) -> Optional[pulumi.Input['VirtualMachineOvfDeployArgs']]:
985
931
  """
986
- When specified, the virtual machine will be deployed from the provided OVF/OVA template. See creating a virtual machine from an OVF/OVA template for more information.
932
+ A specification for deploying a virtual machine from ovf/ova template.
987
933
  """
988
934
  return pulumi.get(self, "ovf_deploy")
989
935
 
@@ -995,9 +941,7 @@ class VirtualMachineArgs:
995
941
  @pulumi.getter(name="pciDeviceIds")
996
942
  def pci_device_ids(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
997
943
  """
998
- List of host PCI device IDs in which to create PCI passthroughs.
999
-
1000
- > **NOTE:** Cloning requires vCenter Server and is not supported on direct ESXi host connections.
944
+ A list of PCI passthrough devices
1001
945
  """
1002
946
  return pulumi.get(self, "pci_device_ids")
1003
947
 
@@ -1022,8 +966,6 @@ class VirtualMachineArgs:
1022
966
  def replace_trigger(self) -> Optional[pulumi.Input[str]]:
1023
967
  """
1024
968
  Triggers replacement of resource whenever it changes.
1025
-
1026
- For example, `replace_trigger = sha256(format("%!s(MISSING)-%!s(MISSING)",data.template_file.cloud_init_metadata.rendered,data.template_file.cloud_init_userdata.rendered))` will fingerprint the changes in cloud-init metadata and userdata templates. This will enable a replacement of the resource whenever the dependant template renders a new configuration. (Forces a replacement.)
1027
969
  """
1028
970
  return pulumi.get(self, "replace_trigger")
1029
971
 
@@ -1035,7 +977,7 @@ class VirtualMachineArgs:
1035
977
  @pulumi.getter(name="runToolsScriptsAfterPowerOn")
1036
978
  def run_tools_scripts_after_power_on(self) -> Optional[pulumi.Input[bool]]:
1037
979
  """
1038
- Enable post-power-on scripts to run when VMware Tools is installed. Default: `true`.
980
+ Enable the run of scripts after virtual machine power-on when VMware Tools is installed.
1039
981
  """
1040
982
  return pulumi.get(self, "run_tools_scripts_after_power_on")
1041
983
 
@@ -1047,7 +989,7 @@ class VirtualMachineArgs:
1047
989
  @pulumi.getter(name="runToolsScriptsAfterResume")
1048
990
  def run_tools_scripts_after_resume(self) -> Optional[pulumi.Input[bool]]:
1049
991
  """
1050
- Enable ost-resume scripts to run when VMware Tools is installed. Default: `true`.
992
+ Enable the run of scripts after virtual machine resume when when VMware Tools is installed.
1051
993
  """
1052
994
  return pulumi.get(self, "run_tools_scripts_after_resume")
1053
995
 
@@ -1059,7 +1001,7 @@ class VirtualMachineArgs:
1059
1001
  @pulumi.getter(name="runToolsScriptsBeforeGuestReboot")
1060
1002
  def run_tools_scripts_before_guest_reboot(self) -> Optional[pulumi.Input[bool]]:
1061
1003
  """
1062
- Enable pre-reboot scripts to run when VMware Tools is installed. Default: `false`.
1004
+ Enable the run of scripts before guest operating system reboot when VMware Tools is installed.
1063
1005
  """
1064
1006
  return pulumi.get(self, "run_tools_scripts_before_guest_reboot")
1065
1007
 
@@ -1071,7 +1013,7 @@ class VirtualMachineArgs:
1071
1013
  @pulumi.getter(name="runToolsScriptsBeforeGuestShutdown")
1072
1014
  def run_tools_scripts_before_guest_shutdown(self) -> Optional[pulumi.Input[bool]]:
1073
1015
  """
1074
- Enable pre-shutdown scripts to run when VMware Tools is installed. Default: `true`.
1016
+ Enable the run of scripts before guest operating system shutdown when VMware Tools is installed.
1075
1017
  """
1076
1018
  return pulumi.get(self, "run_tools_scripts_before_guest_shutdown")
1077
1019
 
@@ -1083,7 +1025,7 @@ class VirtualMachineArgs:
1083
1025
  @pulumi.getter(name="runToolsScriptsBeforeGuestStandby")
1084
1026
  def run_tools_scripts_before_guest_standby(self) -> Optional[pulumi.Input[bool]]:
1085
1027
  """
1086
- Enable pre-standby scripts to run when VMware Tools is installed. Default: `true`.
1028
+ Enable the run of scripts before guest operating system standby when VMware Tools is installed.
1087
1029
  """
1088
1030
  return pulumi.get(self, "run_tools_scripts_before_guest_standby")
1089
1031
 
@@ -1094,11 +1036,6 @@ class VirtualMachineArgs:
1094
1036
  @property
1095
1037
  @pulumi.getter(name="sataControllerCount")
1096
1038
  def sata_controller_count(self) -> Optional[pulumi.Input[int]]:
1097
- """
1098
- The number of SATA controllers that Terraform manages on this virtual machine. This directly affects the amount of disks
1099
- you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove
1100
- controllers.
1101
- """
1102
1039
  return pulumi.get(self, "sata_controller_count")
1103
1040
 
1104
1041
  @sata_controller_count.setter
@@ -1109,7 +1046,7 @@ class VirtualMachineArgs:
1109
1046
  @pulumi.getter(name="scsiBusSharing")
1110
1047
  def scsi_bus_sharing(self) -> Optional[pulumi.Input[str]]:
1111
1048
  """
1112
- The type of SCSI bus sharing for the virtual machine SCSI controller. One of `physicalSharing`, `virtualSharing`, and `noSharing`. Default: `noSharing`.
1049
+ Mode for sharing the SCSI bus. The modes are physicalSharing, virtualSharing, and noSharing.
1113
1050
  """
1114
1051
  return pulumi.get(self, "scsi_bus_sharing")
1115
1052
 
@@ -1120,11 +1057,6 @@ class VirtualMachineArgs:
1120
1057
  @property
1121
1058
  @pulumi.getter(name="scsiControllerCount")
1122
1059
  def scsi_controller_count(self) -> Optional[pulumi.Input[int]]:
1123
- """
1124
- The number of SCSI controllers that Terraform manages on this virtual machine. This directly affects the amount of disks
1125
- you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove
1126
- controllers.
1127
- """
1128
1060
  return pulumi.get(self, "scsi_controller_count")
1129
1061
 
1130
1062
  @scsi_controller_count.setter
@@ -1135,7 +1067,7 @@ class VirtualMachineArgs:
1135
1067
  @pulumi.getter(name="scsiType")
1136
1068
  def scsi_type(self) -> Optional[pulumi.Input[str]]:
1137
1069
  """
1138
- The SCSI controller type for the virtual machine. One of `lsilogic` (LSI Logic Parallel), `lsilogic-sas` (LSI Logic SAS) or `pvscsi` (VMware Paravirtual). Default: `pvscsi`.
1070
+ The type of SCSI bus this virtual machine will have. Can be one of lsilogic, lsilogic-sas or pvscsi.
1139
1071
  """
1140
1072
  return pulumi.get(self, "scsi_type")
1141
1073
 
@@ -1147,7 +1079,7 @@ class VirtualMachineArgs:
1147
1079
  @pulumi.getter(name="shutdownWaitTimeout")
1148
1080
  def shutdown_wait_timeout(self) -> Optional[pulumi.Input[int]]:
1149
1081
  """
1150
- The amount of time, in minutes, to wait for a graceful guest shutdown when making necessary updates to the virtual machine. If `force_power_off` is set to `true`, the virtual machine will be forced to power-off after the timeout, otherwise an error is returned. Default: `3` minutes.
1082
+ The amount of time, in minutes, to wait for shutdown when making necessary updates to the virtual machine.
1151
1083
  """
1152
1084
  return pulumi.get(self, "shutdown_wait_timeout")
1153
1085
 
@@ -1159,7 +1091,7 @@ class VirtualMachineArgs:
1159
1091
  @pulumi.getter(name="storagePolicyId")
1160
1092
  def storage_policy_id(self) -> Optional[pulumi.Input[str]]:
1161
1093
  """
1162
- The UUID of the storage policy to assign to the virtual disk.
1094
+ The ID of the storage policy to assign to the virtual machine home directory.
1163
1095
  """
1164
1096
  return pulumi.get(self, "storage_policy_id")
1165
1097
 
@@ -1171,7 +1103,7 @@ class VirtualMachineArgs:
1171
1103
  @pulumi.getter(name="swapPlacementPolicy")
1172
1104
  def swap_placement_policy(self) -> Optional[pulumi.Input[str]]:
1173
1105
  """
1174
- The swap file placement policy for the virtual machine. One of `inherit`, `hostLocal`, or `vmDirectory`. Default: `inherit`.
1106
+ The swap file placement policy for this virtual machine. Can be one of inherit, hostLocal, or vmDirectory.
1175
1107
  """
1176
1108
  return pulumi.get(self, "swap_placement_policy")
1177
1109
 
@@ -1183,7 +1115,8 @@ class VirtualMachineArgs:
1183
1115
  @pulumi.getter(name="syncTimeWithHost")
1184
1116
  def sync_time_with_host(self) -> Optional[pulumi.Input[bool]]:
1185
1117
  """
1186
- Enable the guest operating system to synchronization its clock with the host when the virtual machine is powered on or resumed. Requires vSphere 7.0 Update 1 and later. Requires VMware Tools to be installed. Default: `true`.
1118
+ Enable guest clock synchronization with the host. On vSphere 7.0 U1 and above, with only this setting the clock is
1119
+ synchronized on startup and resume. Requires VMware Tools to be installed.
1187
1120
  """
1188
1121
  return pulumi.get(self, "sync_time_with_host")
1189
1122
 
@@ -1195,7 +1128,8 @@ class VirtualMachineArgs:
1195
1128
  @pulumi.getter(name="syncTimeWithHostPeriodically")
1196
1129
  def sync_time_with_host_periodically(self) -> Optional[pulumi.Input[bool]]:
1197
1130
  """
1198
- Enable the guest operating system to periodically synchronize its clock with the host. Requires vSphere 7.0 Update 1 and later. On previous versions, setting `sync_time_with_host` is will enable periodic synchronization. Requires VMware Tools to be installed. Default: `false`.
1131
+ Enable periodic clock synchronization with the host. Supported only on vSphere 7.0 U1 and above. On prior versions
1132
+ setting `sync_time_with_host` is enough for periodic synchronization. Requires VMware Tools to be installed.
1199
1133
  """
1200
1134
  return pulumi.get(self, "sync_time_with_host_periodically")
1201
1135
 
@@ -1207,9 +1141,7 @@ class VirtualMachineArgs:
1207
1141
  @pulumi.getter
1208
1142
  def tags(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
1209
1143
  """
1210
- The IDs of any tags to attach to this resource. Please refer to the `Tag` resource for more information on applying tags to virtual machine resources.
1211
-
1212
- > **NOTE:** Tagging support is unsupported on direct ESXi host connections and requires vCenter Server instance.
1144
+ A list of tag IDs to apply to this object.
1213
1145
  """
1214
1146
  return pulumi.get(self, "tags")
1215
1147
 
@@ -1221,7 +1153,7 @@ class VirtualMachineArgs:
1221
1153
  @pulumi.getter(name="toolsUpgradePolicy")
1222
1154
  def tools_upgrade_policy(self) -> Optional[pulumi.Input[str]]:
1223
1155
  """
1224
- Enable automatic upgrade of the VMware Tools version when the virtual machine is rebooted. If necessary, VMware Tools is upgraded to the latest version supported by the host on which the virtual machine is running. Requires VMware Tools to be installed. One of `manual` or `upgradeAtPowerCycle`. Default: `manual`.
1156
+ Set the upgrade policy for VMware Tools. Can be one of `manual` or `upgradeAtPowerCycle`.
1225
1157
  """
1226
1158
  return pulumi.get(self, "tools_upgrade_policy")
1227
1159
 
@@ -1233,7 +1165,7 @@ class VirtualMachineArgs:
1233
1165
  @pulumi.getter
1234
1166
  def vapp(self) -> Optional[pulumi.Input['VirtualMachineVappArgs']]:
1235
1167
  """
1236
- Used for vApp configurations. The only sub-key available is `properties`, which is a key/value map of properties for virtual machines imported from and OVF/OVA. See Using vApp Properties for OVF/OVA Configuration for more information.
1168
+ vApp configuration data for this virtual machine. Can be used to provide configuration data for OVF images.
1237
1169
  """
1238
1170
  return pulumi.get(self, "vapp")
1239
1171
 
@@ -1245,7 +1177,7 @@ class VirtualMachineArgs:
1245
1177
  @pulumi.getter(name="vbsEnabled")
1246
1178
  def vbs_enabled(self) -> Optional[pulumi.Input[bool]]:
1247
1179
  """
1248
- Enable Virtualization Based Security. Requires `firmware` to be `efi`. In addition, `vvtd_enabled`, `nested_hv_enabled`, and `efi_secure_boot_enabled` must all have a value of `true`. Supported on vSphere 6.7 and later. Default: `false`.
1180
+ Flag to specify if Virtualization-based security is enabled for this virtual machine.
1249
1181
  """
1250
1182
  return pulumi.get(self, "vbs_enabled")
1251
1183
 
@@ -1257,7 +1189,8 @@ class VirtualMachineArgs:
1257
1189
  @pulumi.getter(name="vvtdEnabled")
1258
1190
  def vvtd_enabled(self) -> Optional[pulumi.Input[bool]]:
1259
1191
  """
1260
- Enable Intel Virtualization Technology for Directed I/O for the virtual machine (_I/O MMU_ in the vSphere Client). Supported on vSphere 6.7 and later. Default: `false`.
1192
+ Flag to specify if I/O MMU virtualization, also called Intel Virtualization Technology for Directed I/O (VT-d) and AMD
1193
+ I/O Virtualization (AMD-Vi or IOMMU), is enabled.
1261
1194
  """
1262
1195
  return pulumi.get(self, "vvtd_enabled")
1263
1196
 
@@ -1269,7 +1202,8 @@ class VirtualMachineArgs:
1269
1202
  @pulumi.getter(name="waitForGuestIpTimeout")
1270
1203
  def wait_for_guest_ip_timeout(self) -> Optional[pulumi.Input[int]]:
1271
1204
  """
1272
- The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. This should only be used if the version VMware Tools does not allow the `wait_for_guest_net_timeout` waiter to be used. A value less than `1` disables the waiter. Default: `0`.
1205
+ The amount of time, in minutes, to wait for an available IP address on this virtual machine. A value less than 1
1206
+ disables the waiter.
1273
1207
  """
1274
1208
  return pulumi.get(self, "wait_for_guest_ip_timeout")
1275
1209
 
@@ -1281,7 +1215,8 @@ class VirtualMachineArgs:
1281
1215
  @pulumi.getter(name="waitForGuestNetRoutable")
1282
1216
  def wait_for_guest_net_routable(self) -> Optional[pulumi.Input[bool]]:
1283
1217
  """
1284
- Controls whether or not the guest network waiter waits for a routable address. When `false`, the waiter does not wait for a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria. This property is ignored if the `wait_for_guest_ip_timeout` waiter is used. Default: `true`.
1218
+ Controls whether or not the guest network waiter waits for a routable address. When false, the waiter does not wait for
1219
+ a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria.
1285
1220
  """
1286
1221
  return pulumi.get(self, "wait_for_guest_net_routable")
1287
1222
 
@@ -1293,7 +1228,8 @@ class VirtualMachineArgs:
1293
1228
  @pulumi.getter(name="waitForGuestNetTimeout")
1294
1229
  def wait_for_guest_net_timeout(self) -> Optional[pulumi.Input[int]]:
1295
1230
  """
1296
- The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. Older versions of VMware Tools do not populate this property. In those cases, this waiter can be disabled and the `wait_for_guest_ip_timeout` waiter can be used instead. A value less than `1` disables the waiter. Default: `5` minutes.
1231
+ The amount of time, in minutes, to wait for an available IP address on this virtual machine. A value less than 1
1232
+ disables the waiter.
1297
1233
  """
1298
1234
  return pulumi.get(self, "wait_for_guest_net_timeout")
1299
1235
 
@@ -1393,133 +1329,103 @@ class _VirtualMachineState:
1393
1329
  wait_for_guest_net_timeout: Optional[pulumi.Input[int]] = None):
1394
1330
  """
1395
1331
  Input properties used for looking up and filtering VirtualMachine resources.
1396
- :param pulumi.Input[str] alternate_guest_name: The guest name for the operating system when `guest_id` is `otherGuest` or `otherGuest64`.
1397
- :param pulumi.Input[str] annotation: A user-provided description of the virtual machine.
1398
- :param pulumi.Input[int] boot_delay: The number of milliseconds to wait before starting the boot sequence. The default is no delay.
1399
- :param pulumi.Input[int] boot_retry_delay: The number of milliseconds to wait before retrying the boot sequence. This option is only valid if `boot_retry_enabled` is `true`. Default: `10000` (10 seconds).
1400
- :param pulumi.Input[bool] boot_retry_enabled: If set to `true`, a virtual machine that fails to boot will try again after the delay defined in `boot_retry_delay`. Default: `false`.
1401
- :param pulumi.Input[Sequence[pulumi.Input['VirtualMachineCdromArgs']]] cdroms: A specification for a CD-ROM device on the virtual machine. See CD-ROM options for more information.
1332
+ :param pulumi.Input[str] alternate_guest_name: The guest name for the operating system when guest_id is otherGuest or otherGuest64.
1333
+ :param pulumi.Input[str] annotation: User-provided description of the virtual machine.
1334
+ :param pulumi.Input[int] boot_delay: The number of milliseconds to wait before starting the boot sequence.
1335
+ :param pulumi.Input[int] boot_retry_delay: The number of milliseconds to wait before retrying the boot sequence. This only valid if boot_retry_enabled is true.
1336
+ :param pulumi.Input[bool] boot_retry_enabled: If set to true, a virtual machine that fails to boot will try again after the delay defined in boot_retry_delay.
1337
+ :param pulumi.Input[Sequence[pulumi.Input['VirtualMachineCdromArgs']]] cdroms: A specification for a CDROM device on this virtual machine.
1402
1338
  :param pulumi.Input[str] change_version: A unique identifier for a given version of the last configuration was applied.
1403
- :param pulumi.Input['VirtualMachineCloneArgs'] clone: When specified, the virtual machine will be created as a clone of a specified template. Optional customization options can be submitted for the resource. See creating a virtual machine from a template for more information.
1404
- :param pulumi.Input[bool] cpu_hot_add_enabled: Allow CPUs to be added to the virtual machine while it is powered on.
1405
- :param pulumi.Input[bool] cpu_hot_remove_enabled: Allow CPUs to be removed to the virtual machine while it is powered on.
1406
- :param pulumi.Input[int] cpu_limit: The maximum amount of CPU (in MHz) that the virtual machine can consume, regardless of available resources. The default is no limit.
1407
- :param pulumi.Input[bool] cpu_performance_counters_enabled: Enable CPU performance counters on the virtual machine. Default: `false`.
1408
- :param pulumi.Input[int] cpu_reservation: The amount of CPU (in MHz) that the virtual machine is guaranteed. The default is no reservation.
1409
- :param pulumi.Input[int] cpu_share_count: The number of CPU shares allocated to the virtual machine when the `cpu_share_level` is `custom`.
1410
- :param pulumi.Input[str] cpu_share_level: The allocation level for the virtual machine CPU resources. One of `high`, `low`, `normal`, or `custom`. Default: `custom`.
1411
- :param pulumi.Input[Mapping[str, pulumi.Input[str]]] custom_attributes: Map of custom attribute ids to attribute value strings to set for virtual machine. Please refer to the `vsphere_custom_attributes` resource for more information on setting custom attributes.
1412
-
1413
- > **NOTE:** Custom attributes requires vCenter Server and is not supported on direct ESXi host connections.
1414
- :param pulumi.Input[str] datacenter_id: The datacenter ID. Required only when deploying an OVF/OVA template.
1415
- :param pulumi.Input[str] datastore_cluster_id: The managed object reference ID of the datastore cluster in which to place the virtual machine. This setting applies to entire virtual machine and implies that you wish to use vSphere Storage DRS with the virtual machine. See the section on virtual machine migration for more information on modifying this value.
1416
-
1417
- > **NOTE:** One of `datastore_id` or `datastore_cluster_id` must be specified.
1418
-
1419
- > **NOTE:** Use of `datastore_cluster_id` requires vSphere Storage DRS to be enabled on the specified datastore cluster.
1420
-
1421
- > **NOTE:** The `datastore_cluster_id` setting applies to the entire virtual machine resource. You cannot assign individual individual disks to datastore clusters. In addition, you cannot use the `attach` setting to attach external disks on virtual machines that are assigned to datastore clusters.
1422
- :param pulumi.Input[str] datastore_id: The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with `client_device`.
1339
+ :param pulumi.Input['VirtualMachineCloneArgs'] clone: A specification for cloning a virtual machine from template.
1340
+ :param pulumi.Input[bool] cpu_hot_add_enabled: Allow CPUs to be added to this virtual machine while it is running.
1341
+ :param pulumi.Input[bool] cpu_hot_remove_enabled: Allow CPUs to be added to this virtual machine while it is running.
1342
+ :param pulumi.Input[int] cpu_limit: The maximum amount of memory (in MB) or CPU (in MHz) that this virtual machine can consume, regardless of available
1343
+ resources.
1344
+ :param pulumi.Input[bool] cpu_performance_counters_enabled: Enable CPU performance counters on this virtual machine.
1345
+ :param pulumi.Input[int] cpu_reservation: The amount of memory (in MB) or CPU (in MHz) that this virtual machine is guaranteed.
1346
+ :param pulumi.Input[int] cpu_share_count: The amount of shares to allocate to cpu for a custom share level.
1347
+ :param pulumi.Input[str] cpu_share_level: The allocation level for cpu resources. Can be one of high, low, normal, or custom.
1348
+ :param pulumi.Input[Mapping[str, pulumi.Input[str]]] custom_attributes: A list of custom attributes to set on this resource.
1349
+ :param pulumi.Input[str] datacenter_id: The ID of the datacenter where the VM is to be created.
1350
+ :param pulumi.Input[str] datastore_cluster_id: The ID of a datastore cluster to put the virtual machine in.
1351
+ :param pulumi.Input[str] datastore_id: The ID of the virtual machine's datastore. The virtual machine configuration is placed here, along with any virtual
1352
+ disks that are created without datastores.
1423
1353
  :param pulumi.Input[str] default_ip_address: The IP address selected by the provider to be used with any provisioners configured on this resource. When possible, this is the first IPv4 address that is reachable through the default gateway configured on the machine, then the first reachable IPv6 address, and then the first general discovered address if neither exists. If VMware Tools is not running on the virtual machine, or if the virtual machine is powered off, this value will be blank.
1424
- :param pulumi.Input[Sequence[pulumi.Input['VirtualMachineDiskArgs']]] disks: A specification for a virtual disk device on the virtual machine. See disk options for more information.
1425
- :param pulumi.Input[bool] efi_secure_boot_enabled: Use this option to enable EFI secure boot when the `firmware` type is set to is `efi`. Default: `false`.
1426
-
1427
- > **NOTE:** EFI secure boot is only available on vSphere 6.5 and later.
1428
- :param pulumi.Input[bool] enable_disk_uuid: Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest. Default: `false`.
1429
- :param pulumi.Input[bool] enable_logging: Enable logging of virtual machine events to a log file stored in the virtual machine directory. Default: `false`.
1430
- :param pulumi.Input[str] ept_rvi_mode: The EPT/RVI (hardware memory virtualization) setting for the virtual machine. One of `automatic`, `on`, or `off`. Default: `automatic`.
1431
- :param pulumi.Input[Mapping[str, pulumi.Input[str]]] extra_config: Extra configuration data for the virtual machine. Can be used to supply advanced parameters not normally in configuration, such as instance metadata and userdata.
1432
-
1433
- > **NOTE:** Do not use `extra_config` when working with a template imported from OVF/OVA as your settings may be ignored. Use the `vapp` block `properties` section as described in Using vApp Properties for OVF/OVA Configuration.
1434
- :param pulumi.Input[bool] extra_config_reboot_required: Allow the virtual machine to be rebooted when a change to `extra_config` occurs. Default: `true`.
1435
- :param pulumi.Input[str] firmware: The firmware for the virtual machine. One of `bios` or `efi`.
1436
- :param pulumi.Input[str] folder: The path to the virtual machine folder in which to place the virtual machine, relative to the datacenter path (`/<datacenter-name>/vm`). For example, `/dc-01/vm/foo`
1437
- :param pulumi.Input[bool] force_power_off: If a guest shutdown failed or times out while updating or destroying (see `shutdown_wait_timeout`), force the power-off of the virtual machine. Default: `true`.
1438
- :param pulumi.Input[str] guest_id: The guest ID for the operating system type. For a full list of possible values, see [here][vmware-docs-guest-ids]. Default: `otherGuest64`.
1439
-
1440
- [vmware-docs-guest-ids]: https://vdc-repo.vmware.com/vmwb-repository/dcr-public/184bb3ba-6fa8-4574-a767-d0c96e2a38f4/ba9422ef-405c-47dd-8553-e11b619185b2/SDK/vsphere-ws/docs/ReferenceGuide/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html
1354
+ :param pulumi.Input[Sequence[pulumi.Input['VirtualMachineDiskArgs']]] disks: A specification for a virtual disk device on this virtual machine.
1355
+ :param pulumi.Input[bool] efi_secure_boot_enabled: When the boot type set in firmware is efi, this enables EFI secure boot.
1356
+ :param pulumi.Input[bool] enable_disk_uuid: Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest.
1357
+ :param pulumi.Input[bool] enable_logging: Enable logging on this virtual machine.
1358
+ :param pulumi.Input[str] ept_rvi_mode: The EPT/RVI (hardware memory virtualization) setting for this virtual machine. Can be one of automatic, on, or off.
1359
+ :param pulumi.Input[Mapping[str, pulumi.Input[str]]] extra_config: Extra configuration data for this virtual machine. Can be used to supply advanced parameters not normally in
1360
+ configuration, such as instance metadata, or configuration data for OVF images.
1361
+ :param pulumi.Input[bool] extra_config_reboot_required: Allow the virtual machine to be rebooted when a change to `extra_config` occurs.
1362
+ :param pulumi.Input[str] firmware: The firmware interface to use on the virtual machine. Can be one of bios or efi.
1363
+ :param pulumi.Input[str] folder: The name of the folder to locate the virtual machine in.
1364
+ :param pulumi.Input[bool] force_power_off: Set to true to force power-off a virtual machine if a graceful guest shutdown failed for a necessary operation.
1365
+ :param pulumi.Input[str] guest_id: The guest ID for the operating system.
1441
1366
  :param pulumi.Input[Sequence[pulumi.Input[str]]] guest_ip_addresses: The current list of IP addresses on this machine, including the value of `default_ip_address`. If VMware Tools is not running on the virtual machine, or if the virtul machine is powered off, this list will be empty.
1442
- :param pulumi.Input[int] hardware_version: The hardware version number. Valid range is from 4 to 21. The hardware version cannot be downgraded. See virtual machine hardware [versions][virtual-machine-hardware-versions] and [compatibility][virtual-machine-hardware-compatibility] for more information on supported settings.
1443
-
1444
- [virtual-machine-hardware-versions]: https://kb.vmware.com/s/article/1003746
1445
- [virtual-machine-hardware-compatibility]: https://kb.vmware.com/s/article/2007240
1446
- :param pulumi.Input[str] host_system_id: The managed object reference ID of a host on which to place the virtual machine. See the section on virtual machine migration for more information on modifying this value. When using a vSphere cluster, if a `host_system_id` is not supplied, vSphere will select a host in the cluster to place the virtual machine, according to any defaults or vSphere DRS placement policies.
1447
- :param pulumi.Input[str] hv_mode: The hardware virtualization (non-nested) setting for the virtual machine. One of `hvAuto`, `hvOn`, or `hvOff`. Default: `hvAuto`.
1448
- :param pulumi.Input[int] ide_controller_count: The number of IDE controllers that the virtual machine. This directly affects the number of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers. Default: `2`.
1449
- :param pulumi.Input[Sequence[pulumi.Input[str]]] ignored_guest_ips: List of IP addresses and CIDR networks to ignore while waiting for an available IP address using either of the waiters. Any IP addresses in this list will be ignored so that the waiter will continue to wait for a valid IP address. Default: `[]`.
1367
+ :param pulumi.Input[int] hardware_version: The hardware version for the virtual machine.
1368
+ :param pulumi.Input[str] host_system_id: The ID of an optional host system to pin the virtual machine to.
1369
+ :param pulumi.Input[str] hv_mode: The (non-nested) hardware virtualization setting for this virtual machine. Can be one of hvAuto, hvOn, or hvOff.
1370
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] ignored_guest_ips: List of IP addresses and CIDR networks to ignore while waiting for an IP
1450
1371
  :param pulumi.Input[bool] imported: Indicates if the virtual machine resource has been imported, or if the state has been migrated from a previous version of the resource. It influences the behavior of the first post-import apply operation. See the section on importing below.
1451
- :param pulumi.Input[str] latency_sensitivity: Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard devices. One of `low`, `normal`, `medium`, or `high`.
1452
-
1453
- > **NOTE:** On higher sensitivities, you may need to adjust the `memory_reservation` to the full amount of memory provisioned for the virtual machine.
1454
- :param pulumi.Input[int] memory: The memory size to assign to the virtual machine, in MB. Default: `1024` (1 GB).
1455
- :param pulumi.Input[bool] memory_hot_add_enabled: Allow memory to be added to the virtual machine while it is powered on.
1456
-
1457
- > **NOTE:** CPU and memory hot add options are not available on all guest operating systems. Please refer to the [VMware Guest OS Compatibility Guide][vmware-docs-compat-guide] to which settings are allow for your guest operating system. In addition, at least one `pulumi up` must be run before you are able to use CPU and memory hot add.
1458
-
1459
- [vmware-docs-compat-guide]: http://partnerweb.vmware.com/comp_guide2/pdf/VMware_GOS_Compatibility_Guide.pdf
1460
-
1461
- > **NOTE:** For Linux 64-bit guest operating systems with less than or equal to 3GB, the virtual machine must powered off to add memory beyond 3GB. Subsequent hot add of memory does not require the virtual machine to be powered-off to apply the plan. Please refer to [VMware KB 2008405][vmware-kb-2008405].
1462
-
1463
- [vmware-kb-2008405]: https://kb.vmware.com/s/article/2008405
1464
- :param pulumi.Input[int] memory_limit: The maximum amount of memory (in MB) that th virtual machine can consume, regardless of available resources. The default is no limit.
1465
- :param pulumi.Input[int] memory_reservation: The amount of memory (in MB) that the virtual machine is guaranteed. The default is no reservation.
1372
+ :param pulumi.Input[str] latency_sensitivity: Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower
1373
+ latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard
1374
+ devices. Can be one of low, normal, medium, or high.
1375
+ :param pulumi.Input[int] memory: The size of the virtual machine's memory, in MB.
1376
+ :param pulumi.Input[bool] memory_hot_add_enabled: Allow memory to be added to this virtual machine while it is running.
1377
+ :param pulumi.Input[int] memory_limit: The maximum amount of memory (in MB) or CPU (in MHz) that this virtual machine can consume, regardless of available
1378
+ resources.
1379
+ :param pulumi.Input[int] memory_reservation: The amount of memory (in MB) or CPU (in MHz) that this virtual machine is guaranteed.
1466
1380
  :param pulumi.Input[bool] memory_reservation_locked_to_max: If set true, memory resource reservation for this virtual machine will always be equal to the virtual machine's memory
1467
1381
  size;increases in memory size will be rejected when a corresponding reservation increase is not possible. This feature
1468
1382
  may only be enabled if it is currently possible to reserve all of the virtual machine's memory.
1469
- :param pulumi.Input[int] memory_share_count: The number of memory shares allocated to the virtual machine when the `memory_share_level` is `custom`.
1470
- :param pulumi.Input[str] memory_share_level: The allocation level for the virtual machine memory resources. One of `high`, `low`, `normal`, or `custom`. Default: `custom`.
1471
- :param pulumi.Input[int] migrate_wait_timeout: The amount of time, in minutes, to wait for a virtual machine migration to complete before failing. Default: `10` minutes. See the section on virtual machine migration for more information.
1383
+ :param pulumi.Input[int] memory_share_count: The amount of shares to allocate to memory for a custom share level.
1384
+ :param pulumi.Input[str] memory_share_level: The allocation level for memory resources. Can be one of high, low, normal, or custom.
1385
+ :param pulumi.Input[int] migrate_wait_timeout: The amount of time, in minutes, to wait for a vMotion operation to complete before failing.
1472
1386
  :param pulumi.Input[str] moid: The managed object reference ID of the created virtual machine.
1473
- :param pulumi.Input[str] name: The name of the virtual machine.
1474
- :param pulumi.Input[bool] nested_hv_enabled: Enable nested hardware virtualization on the virtual machine, facilitating nested virtualization in the guest operating system. Default: `false`.
1475
- :param pulumi.Input[Sequence[pulumi.Input['VirtualMachineNetworkInterfaceArgs']]] network_interfaces: A specification for a virtual NIC on the virtual machine. See network interface options for more information.
1476
- :param pulumi.Input[int] num_cores_per_socket: The number of cores per socket in the virtual machine. The number of vCPUs on the virtual machine will be `num_cpus` divided by `num_cores_per_socket`. If specified, the value supplied to `num_cpus` must be evenly divisible by this value. Default: `1`.
1477
- :param pulumi.Input[int] num_cpus: The total number of virtual processor cores to assign to the virtual machine. Default: `1`.
1478
- :param pulumi.Input['VirtualMachineOvfDeployArgs'] ovf_deploy: When specified, the virtual machine will be deployed from the provided OVF/OVA template. See creating a virtual machine from an OVF/OVA template for more information.
1479
- :param pulumi.Input[Sequence[pulumi.Input[str]]] pci_device_ids: List of host PCI device IDs in which to create PCI passthroughs.
1480
-
1481
- > **NOTE:** Cloning requires vCenter Server and is not supported on direct ESXi host connections.
1387
+ :param pulumi.Input[str] name: The name of this virtual machine.
1388
+ :param pulumi.Input[bool] nested_hv_enabled: Enable nested hardware virtualization on this virtual machine, facilitating nested virtualization in the guest.
1389
+ :param pulumi.Input[Sequence[pulumi.Input['VirtualMachineNetworkInterfaceArgs']]] network_interfaces: A specification for a virtual NIC on this virtual machine.
1390
+ :param pulumi.Input[int] num_cores_per_socket: The number of cores to distribute amongst the CPUs in this virtual machine. If specified, the value supplied to num_cpus
1391
+ must be evenly divisible by this value.
1392
+ :param pulumi.Input[int] num_cpus: The number of virtual processors to assign to this virtual machine.
1393
+ :param pulumi.Input['VirtualMachineOvfDeployArgs'] ovf_deploy: A specification for deploying a virtual machine from ovf/ova template.
1394
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] pci_device_ids: A list of PCI passthrough devices
1482
1395
  :param pulumi.Input[str] power_state: A computed value for the current power state of the virtual machine. One of `on`, `off`, or `suspended`.
1483
1396
  :param pulumi.Input[int] poweron_timeout: The amount of time, in seconds, that we will be trying to power on a VM
1484
- :param pulumi.Input[bool] reboot_required: Value internal to Terraform used to determine if a configuration set change requires a reboot.
1485
1397
  :param pulumi.Input[str] replace_trigger: Triggers replacement of resource whenever it changes.
1486
-
1487
- For example, `replace_trigger = sha256(format("%!s(MISSING)-%!s(MISSING)",data.template_file.cloud_init_metadata.rendered,data.template_file.cloud_init_userdata.rendered))` will fingerprint the changes in cloud-init metadata and userdata templates. This will enable a replacement of the resource whenever the dependant template renders a new configuration. (Forces a replacement.)
1488
- :param pulumi.Input[str] resource_pool_id: The managed object reference ID of the resource pool in which to place the virtual machine. See the Virtual Machine Migration section for more information on modifying this value.
1489
-
1490
- > **NOTE:** All clusters and standalone hosts have a default root resource pool. This resource argument does not directly accept the cluster or standalone host resource. For more information, see the section on specifying the Root Resource Pool in the `ResourcePool` data source documentation on using the root resource pool.
1491
- :param pulumi.Input[bool] run_tools_scripts_after_power_on: Enable post-power-on scripts to run when VMware Tools is installed. Default: `true`.
1492
- :param pulumi.Input[bool] run_tools_scripts_after_resume: Enable ost-resume scripts to run when VMware Tools is installed. Default: `true`.
1493
- :param pulumi.Input[bool] run_tools_scripts_before_guest_reboot: Enable pre-reboot scripts to run when VMware Tools is installed. Default: `false`.
1494
- :param pulumi.Input[bool] run_tools_scripts_before_guest_shutdown: Enable pre-shutdown scripts to run when VMware Tools is installed. Default: `true`.
1495
- :param pulumi.Input[bool] run_tools_scripts_before_guest_standby: Enable pre-standby scripts to run when VMware Tools is installed. Default: `true`.
1496
- :param pulumi.Input[int] sata_controller_count: The number of SATA controllers that Terraform manages on this virtual machine. This directly affects the amount of disks
1497
- you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove
1498
- controllers.
1499
- :param pulumi.Input[str] scsi_bus_sharing: The type of SCSI bus sharing for the virtual machine SCSI controller. One of `physicalSharing`, `virtualSharing`, and `noSharing`. Default: `noSharing`.
1500
- :param pulumi.Input[int] scsi_controller_count: The number of SCSI controllers that Terraform manages on this virtual machine. This directly affects the amount of disks
1501
- you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove
1502
- controllers.
1503
- :param pulumi.Input[str] scsi_type: The SCSI controller type for the virtual machine. One of `lsilogic` (LSI Logic Parallel), `lsilogic-sas` (LSI Logic SAS) or `pvscsi` (VMware Paravirtual). Default: `pvscsi`.
1504
- :param pulumi.Input[int] shutdown_wait_timeout: The amount of time, in minutes, to wait for a graceful guest shutdown when making necessary updates to the virtual machine. If `force_power_off` is set to `true`, the virtual machine will be forced to power-off after the timeout, otherwise an error is returned. Default: `3` minutes.
1505
- :param pulumi.Input[str] storage_policy_id: The UUID of the storage policy to assign to the virtual disk.
1506
- :param pulumi.Input[str] swap_placement_policy: The swap file placement policy for the virtual machine. One of `inherit`, `hostLocal`, or `vmDirectory`. Default: `inherit`.
1507
- :param pulumi.Input[bool] sync_time_with_host: Enable the guest operating system to synchronization its clock with the host when the virtual machine is powered on or resumed. Requires vSphere 7.0 Update 1 and later. Requires VMware Tools to be installed. Default: `true`.
1508
- :param pulumi.Input[bool] sync_time_with_host_periodically: Enable the guest operating system to periodically synchronize its clock with the host. Requires vSphere 7.0 Update 1 and later. On previous versions, setting `sync_time_with_host` is will enable periodic synchronization. Requires VMware Tools to be installed. Default: `false`.
1509
- :param pulumi.Input[Sequence[pulumi.Input[str]]] tags: The IDs of any tags to attach to this resource. Please refer to the `Tag` resource for more information on applying tags to virtual machine resources.
1510
-
1511
- > **NOTE:** Tagging support is unsupported on direct ESXi host connections and requires vCenter Server instance.
1512
- :param pulumi.Input[str] tools_upgrade_policy: Enable automatic upgrade of the VMware Tools version when the virtual machine is rebooted. If necessary, VMware Tools is upgraded to the latest version supported by the host on which the virtual machine is running. Requires VMware Tools to be installed. One of `manual` or `upgradeAtPowerCycle`. Default: `manual`.
1513
- :param pulumi.Input[str] uuid: The UUID of the virtual disk VMDK file. This is used to track the virtual disk on the virtual machine.
1514
- :param pulumi.Input['VirtualMachineVappArgs'] vapp: Used for vApp configurations. The only sub-key available is `properties`, which is a key/value map of properties for virtual machines imported from and OVF/OVA. See Using vApp Properties for OVF/OVA Configuration for more information.
1398
+ :param pulumi.Input[str] resource_pool_id: The ID of a resource pool to put the virtual machine in.
1399
+ :param pulumi.Input[bool] run_tools_scripts_after_power_on: Enable the run of scripts after virtual machine power-on when VMware Tools is installed.
1400
+ :param pulumi.Input[bool] run_tools_scripts_after_resume: Enable the run of scripts after virtual machine resume when when VMware Tools is installed.
1401
+ :param pulumi.Input[bool] run_tools_scripts_before_guest_reboot: Enable the run of scripts before guest operating system reboot when VMware Tools is installed.
1402
+ :param pulumi.Input[bool] run_tools_scripts_before_guest_shutdown: Enable the run of scripts before guest operating system shutdown when VMware Tools is installed.
1403
+ :param pulumi.Input[bool] run_tools_scripts_before_guest_standby: Enable the run of scripts before guest operating system standby when VMware Tools is installed.
1404
+ :param pulumi.Input[str] scsi_bus_sharing: Mode for sharing the SCSI bus. The modes are physicalSharing, virtualSharing, and noSharing.
1405
+ :param pulumi.Input[str] scsi_type: The type of SCSI bus this virtual machine will have. Can be one of lsilogic, lsilogic-sas or pvscsi.
1406
+ :param pulumi.Input[int] shutdown_wait_timeout: The amount of time, in minutes, to wait for shutdown when making necessary updates to the virtual machine.
1407
+ :param pulumi.Input[str] storage_policy_id: The ID of the storage policy to assign to the virtual machine home directory.
1408
+ :param pulumi.Input[str] swap_placement_policy: The swap file placement policy for this virtual machine. Can be one of inherit, hostLocal, or vmDirectory.
1409
+ :param pulumi.Input[bool] sync_time_with_host: Enable guest clock synchronization with the host. On vSphere 7.0 U1 and above, with only this setting the clock is
1410
+ synchronized on startup and resume. Requires VMware Tools to be installed.
1411
+ :param pulumi.Input[bool] sync_time_with_host_periodically: Enable periodic clock synchronization with the host. Supported only on vSphere 7.0 U1 and above. On prior versions
1412
+ setting `sync_time_with_host` is enough for periodic synchronization. Requires VMware Tools to be installed.
1413
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] tags: A list of tag IDs to apply to this object.
1414
+ :param pulumi.Input[str] tools_upgrade_policy: Set the upgrade policy for VMware Tools. Can be one of `manual` or `upgradeAtPowerCycle`.
1415
+ :param pulumi.Input[str] uuid: The UUID of the virtual machine. Also exposed as the `id` of the resource.
1416
+ :param pulumi.Input['VirtualMachineVappArgs'] vapp: vApp configuration data for this virtual machine. Can be used to provide configuration data for OVF images.
1515
1417
  :param pulumi.Input[Sequence[pulumi.Input[str]]] vapp_transports: Computed value which is only valid for cloned virtual machines. A list of vApp transport methods supported by the source virtual machine or template.
1516
- :param pulumi.Input[bool] vbs_enabled: Enable Virtualization Based Security. Requires `firmware` to be `efi`. In addition, `vvtd_enabled`, `nested_hv_enabled`, and `efi_secure_boot_enabled` must all have a value of `true`. Supported on vSphere 6.7 and later. Default: `false`.
1418
+ :param pulumi.Input[bool] vbs_enabled: Flag to specify if Virtualization-based security is enabled for this virtual machine.
1517
1419
  :param pulumi.Input[str] vmware_tools_status: The state of VMware Tools in the guest. This will determine the proper course of action for some device operations.
1518
1420
  :param pulumi.Input[str] vmx_path: The path of the virtual machine configuration file on the datastore in which the virtual machine is placed.
1519
- :param pulumi.Input[bool] vvtd_enabled: Enable Intel Virtualization Technology for Directed I/O for the virtual machine (_I/O MMU_ in the vSphere Client). Supported on vSphere 6.7 and later. Default: `false`.
1520
- :param pulumi.Input[int] wait_for_guest_ip_timeout: The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. This should only be used if the version VMware Tools does not allow the `wait_for_guest_net_timeout` waiter to be used. A value less than `1` disables the waiter. Default: `0`.
1521
- :param pulumi.Input[bool] wait_for_guest_net_routable: Controls whether or not the guest network waiter waits for a routable address. When `false`, the waiter does not wait for a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria. This property is ignored if the `wait_for_guest_ip_timeout` waiter is used. Default: `true`.
1522
- :param pulumi.Input[int] wait_for_guest_net_timeout: The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. Older versions of VMware Tools do not populate this property. In those cases, this waiter can be disabled and the `wait_for_guest_ip_timeout` waiter can be used instead. A value less than `1` disables the waiter. Default: `5` minutes.
1421
+ :param pulumi.Input[bool] vvtd_enabled: Flag to specify if I/O MMU virtualization, also called Intel Virtualization Technology for Directed I/O (VT-d) and AMD
1422
+ I/O Virtualization (AMD-Vi or IOMMU), is enabled.
1423
+ :param pulumi.Input[int] wait_for_guest_ip_timeout: The amount of time, in minutes, to wait for an available IP address on this virtual machine. A value less than 1
1424
+ disables the waiter.
1425
+ :param pulumi.Input[bool] wait_for_guest_net_routable: Controls whether or not the guest network waiter waits for a routable address. When false, the waiter does not wait for
1426
+ a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria.
1427
+ :param pulumi.Input[int] wait_for_guest_net_timeout: The amount of time, in minutes, to wait for an available IP address on this virtual machine. A value less than 1
1428
+ disables the waiter.
1523
1429
  """
1524
1430
  if alternate_guest_name is not None:
1525
1431
  pulumi.set(__self__, "alternate_guest_name", alternate_guest_name)
@@ -1698,7 +1604,7 @@ class _VirtualMachineState:
1698
1604
  @pulumi.getter(name="alternateGuestName")
1699
1605
  def alternate_guest_name(self) -> Optional[pulumi.Input[str]]:
1700
1606
  """
1701
- The guest name for the operating system when `guest_id` is `otherGuest` or `otherGuest64`.
1607
+ The guest name for the operating system when guest_id is otherGuest or otherGuest64.
1702
1608
  """
1703
1609
  return pulumi.get(self, "alternate_guest_name")
1704
1610
 
@@ -1710,7 +1616,7 @@ class _VirtualMachineState:
1710
1616
  @pulumi.getter
1711
1617
  def annotation(self) -> Optional[pulumi.Input[str]]:
1712
1618
  """
1713
- A user-provided description of the virtual machine.
1619
+ User-provided description of the virtual machine.
1714
1620
  """
1715
1621
  return pulumi.get(self, "annotation")
1716
1622
 
@@ -1722,7 +1628,7 @@ class _VirtualMachineState:
1722
1628
  @pulumi.getter(name="bootDelay")
1723
1629
  def boot_delay(self) -> Optional[pulumi.Input[int]]:
1724
1630
  """
1725
- The number of milliseconds to wait before starting the boot sequence. The default is no delay.
1631
+ The number of milliseconds to wait before starting the boot sequence.
1726
1632
  """
1727
1633
  return pulumi.get(self, "boot_delay")
1728
1634
 
@@ -1734,7 +1640,7 @@ class _VirtualMachineState:
1734
1640
  @pulumi.getter(name="bootRetryDelay")
1735
1641
  def boot_retry_delay(self) -> Optional[pulumi.Input[int]]:
1736
1642
  """
1737
- The number of milliseconds to wait before retrying the boot sequence. This option is only valid if `boot_retry_enabled` is `true`. Default: `10000` (10 seconds).
1643
+ The number of milliseconds to wait before retrying the boot sequence. This only valid if boot_retry_enabled is true.
1738
1644
  """
1739
1645
  return pulumi.get(self, "boot_retry_delay")
1740
1646
 
@@ -1746,7 +1652,7 @@ class _VirtualMachineState:
1746
1652
  @pulumi.getter(name="bootRetryEnabled")
1747
1653
  def boot_retry_enabled(self) -> Optional[pulumi.Input[bool]]:
1748
1654
  """
1749
- If set to `true`, a virtual machine that fails to boot will try again after the delay defined in `boot_retry_delay`. Default: `false`.
1655
+ If set to true, a virtual machine that fails to boot will try again after the delay defined in boot_retry_delay.
1750
1656
  """
1751
1657
  return pulumi.get(self, "boot_retry_enabled")
1752
1658
 
@@ -1758,7 +1664,7 @@ class _VirtualMachineState:
1758
1664
  @pulumi.getter
1759
1665
  def cdroms(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['VirtualMachineCdromArgs']]]]:
1760
1666
  """
1761
- A specification for a CD-ROM device on the virtual machine. See CD-ROM options for more information.
1667
+ A specification for a CDROM device on this virtual machine.
1762
1668
  """
1763
1669
  return pulumi.get(self, "cdroms")
1764
1670
 
@@ -1782,7 +1688,7 @@ class _VirtualMachineState:
1782
1688
  @pulumi.getter
1783
1689
  def clone(self) -> Optional[pulumi.Input['VirtualMachineCloneArgs']]:
1784
1690
  """
1785
- When specified, the virtual machine will be created as a clone of a specified template. Optional customization options can be submitted for the resource. See creating a virtual machine from a template for more information.
1691
+ A specification for cloning a virtual machine from template.
1786
1692
  """
1787
1693
  return pulumi.get(self, "clone")
1788
1694
 
@@ -1794,7 +1700,7 @@ class _VirtualMachineState:
1794
1700
  @pulumi.getter(name="cpuHotAddEnabled")
1795
1701
  def cpu_hot_add_enabled(self) -> Optional[pulumi.Input[bool]]:
1796
1702
  """
1797
- Allow CPUs to be added to the virtual machine while it is powered on.
1703
+ Allow CPUs to be added to this virtual machine while it is running.
1798
1704
  """
1799
1705
  return pulumi.get(self, "cpu_hot_add_enabled")
1800
1706
 
@@ -1806,7 +1712,7 @@ class _VirtualMachineState:
1806
1712
  @pulumi.getter(name="cpuHotRemoveEnabled")
1807
1713
  def cpu_hot_remove_enabled(self) -> Optional[pulumi.Input[bool]]:
1808
1714
  """
1809
- Allow CPUs to be removed to the virtual machine while it is powered on.
1715
+ Allow CPUs to be added to this virtual machine while it is running.
1810
1716
  """
1811
1717
  return pulumi.get(self, "cpu_hot_remove_enabled")
1812
1718
 
@@ -1818,7 +1724,8 @@ class _VirtualMachineState:
1818
1724
  @pulumi.getter(name="cpuLimit")
1819
1725
  def cpu_limit(self) -> Optional[pulumi.Input[int]]:
1820
1726
  """
1821
- The maximum amount of CPU (in MHz) that the virtual machine can consume, regardless of available resources. The default is no limit.
1727
+ The maximum amount of memory (in MB) or CPU (in MHz) that this virtual machine can consume, regardless of available
1728
+ resources.
1822
1729
  """
1823
1730
  return pulumi.get(self, "cpu_limit")
1824
1731
 
@@ -1830,7 +1737,7 @@ class _VirtualMachineState:
1830
1737
  @pulumi.getter(name="cpuPerformanceCountersEnabled")
1831
1738
  def cpu_performance_counters_enabled(self) -> Optional[pulumi.Input[bool]]:
1832
1739
  """
1833
- Enable CPU performance counters on the virtual machine. Default: `false`.
1740
+ Enable CPU performance counters on this virtual machine.
1834
1741
  """
1835
1742
  return pulumi.get(self, "cpu_performance_counters_enabled")
1836
1743
 
@@ -1842,7 +1749,7 @@ class _VirtualMachineState:
1842
1749
  @pulumi.getter(name="cpuReservation")
1843
1750
  def cpu_reservation(self) -> Optional[pulumi.Input[int]]:
1844
1751
  """
1845
- The amount of CPU (in MHz) that the virtual machine is guaranteed. The default is no reservation.
1752
+ The amount of memory (in MB) or CPU (in MHz) that this virtual machine is guaranteed.
1846
1753
  """
1847
1754
  return pulumi.get(self, "cpu_reservation")
1848
1755
 
@@ -1854,7 +1761,7 @@ class _VirtualMachineState:
1854
1761
  @pulumi.getter(name="cpuShareCount")
1855
1762
  def cpu_share_count(self) -> Optional[pulumi.Input[int]]:
1856
1763
  """
1857
- The number of CPU shares allocated to the virtual machine when the `cpu_share_level` is `custom`.
1764
+ The amount of shares to allocate to cpu for a custom share level.
1858
1765
  """
1859
1766
  return pulumi.get(self, "cpu_share_count")
1860
1767
 
@@ -1866,7 +1773,7 @@ class _VirtualMachineState:
1866
1773
  @pulumi.getter(name="cpuShareLevel")
1867
1774
  def cpu_share_level(self) -> Optional[pulumi.Input[str]]:
1868
1775
  """
1869
- The allocation level for the virtual machine CPU resources. One of `high`, `low`, `normal`, or `custom`. Default: `custom`.
1776
+ The allocation level for cpu resources. Can be one of high, low, normal, or custom.
1870
1777
  """
1871
1778
  return pulumi.get(self, "cpu_share_level")
1872
1779
 
@@ -1878,9 +1785,7 @@ class _VirtualMachineState:
1878
1785
  @pulumi.getter(name="customAttributes")
1879
1786
  def custom_attributes(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]:
1880
1787
  """
1881
- Map of custom attribute ids to attribute value strings to set for virtual machine. Please refer to the `vsphere_custom_attributes` resource for more information on setting custom attributes.
1882
-
1883
- > **NOTE:** Custom attributes requires vCenter Server and is not supported on direct ESXi host connections.
1788
+ A list of custom attributes to set on this resource.
1884
1789
  """
1885
1790
  return pulumi.get(self, "custom_attributes")
1886
1791
 
@@ -1892,7 +1797,7 @@ class _VirtualMachineState:
1892
1797
  @pulumi.getter(name="datacenterId")
1893
1798
  def datacenter_id(self) -> Optional[pulumi.Input[str]]:
1894
1799
  """
1895
- The datacenter ID. Required only when deploying an OVF/OVA template.
1800
+ The ID of the datacenter where the VM is to be created.
1896
1801
  """
1897
1802
  return pulumi.get(self, "datacenter_id")
1898
1803
 
@@ -1904,13 +1809,7 @@ class _VirtualMachineState:
1904
1809
  @pulumi.getter(name="datastoreClusterId")
1905
1810
  def datastore_cluster_id(self) -> Optional[pulumi.Input[str]]:
1906
1811
  """
1907
- The managed object reference ID of the datastore cluster in which to place the virtual machine. This setting applies to entire virtual machine and implies that you wish to use vSphere Storage DRS with the virtual machine. See the section on virtual machine migration for more information on modifying this value.
1908
-
1909
- > **NOTE:** One of `datastore_id` or `datastore_cluster_id` must be specified.
1910
-
1911
- > **NOTE:** Use of `datastore_cluster_id` requires vSphere Storage DRS to be enabled on the specified datastore cluster.
1912
-
1913
- > **NOTE:** The `datastore_cluster_id` setting applies to the entire virtual machine resource. You cannot assign individual individual disks to datastore clusters. In addition, you cannot use the `attach` setting to attach external disks on virtual machines that are assigned to datastore clusters.
1812
+ The ID of a datastore cluster to put the virtual machine in.
1914
1813
  """
1915
1814
  return pulumi.get(self, "datastore_cluster_id")
1916
1815
 
@@ -1922,7 +1821,8 @@ class _VirtualMachineState:
1922
1821
  @pulumi.getter(name="datastoreId")
1923
1822
  def datastore_id(self) -> Optional[pulumi.Input[str]]:
1924
1823
  """
1925
- The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with `client_device`.
1824
+ The ID of the virtual machine's datastore. The virtual machine configuration is placed here, along with any virtual
1825
+ disks that are created without datastores.
1926
1826
  """
1927
1827
  return pulumi.get(self, "datastore_id")
1928
1828
 
@@ -1946,7 +1846,7 @@ class _VirtualMachineState:
1946
1846
  @pulumi.getter
1947
1847
  def disks(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['VirtualMachineDiskArgs']]]]:
1948
1848
  """
1949
- A specification for a virtual disk device on the virtual machine. See disk options for more information.
1849
+ A specification for a virtual disk device on this virtual machine.
1950
1850
  """
1951
1851
  return pulumi.get(self, "disks")
1952
1852
 
@@ -1958,9 +1858,7 @@ class _VirtualMachineState:
1958
1858
  @pulumi.getter(name="efiSecureBootEnabled")
1959
1859
  def efi_secure_boot_enabled(self) -> Optional[pulumi.Input[bool]]:
1960
1860
  """
1961
- Use this option to enable EFI secure boot when the `firmware` type is set to is `efi`. Default: `false`.
1962
-
1963
- > **NOTE:** EFI secure boot is only available on vSphere 6.5 and later.
1861
+ When the boot type set in firmware is efi, this enables EFI secure boot.
1964
1862
  """
1965
1863
  return pulumi.get(self, "efi_secure_boot_enabled")
1966
1864
 
@@ -1972,7 +1870,7 @@ class _VirtualMachineState:
1972
1870
  @pulumi.getter(name="enableDiskUuid")
1973
1871
  def enable_disk_uuid(self) -> Optional[pulumi.Input[bool]]:
1974
1872
  """
1975
- Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest. Default: `false`.
1873
+ Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest.
1976
1874
  """
1977
1875
  return pulumi.get(self, "enable_disk_uuid")
1978
1876
 
@@ -1984,7 +1882,7 @@ class _VirtualMachineState:
1984
1882
  @pulumi.getter(name="enableLogging")
1985
1883
  def enable_logging(self) -> Optional[pulumi.Input[bool]]:
1986
1884
  """
1987
- Enable logging of virtual machine events to a log file stored in the virtual machine directory. Default: `false`.
1885
+ Enable logging on this virtual machine.
1988
1886
  """
1989
1887
  return pulumi.get(self, "enable_logging")
1990
1888
 
@@ -1996,7 +1894,7 @@ class _VirtualMachineState:
1996
1894
  @pulumi.getter(name="eptRviMode")
1997
1895
  def ept_rvi_mode(self) -> Optional[pulumi.Input[str]]:
1998
1896
  """
1999
- The EPT/RVI (hardware memory virtualization) setting for the virtual machine. One of `automatic`, `on`, or `off`. Default: `automatic`.
1897
+ The EPT/RVI (hardware memory virtualization) setting for this virtual machine. Can be one of automatic, on, or off.
2000
1898
  """
2001
1899
  return pulumi.get(self, "ept_rvi_mode")
2002
1900
 
@@ -2008,9 +1906,8 @@ class _VirtualMachineState:
2008
1906
  @pulumi.getter(name="extraConfig")
2009
1907
  def extra_config(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]:
2010
1908
  """
2011
- Extra configuration data for the virtual machine. Can be used to supply advanced parameters not normally in configuration, such as instance metadata and userdata.
2012
-
2013
- > **NOTE:** Do not use `extra_config` when working with a template imported from OVF/OVA as your settings may be ignored. Use the `vapp` block `properties` section as described in Using vApp Properties for OVF/OVA Configuration.
1909
+ Extra configuration data for this virtual machine. Can be used to supply advanced parameters not normally in
1910
+ configuration, such as instance metadata, or configuration data for OVF images.
2014
1911
  """
2015
1912
  return pulumi.get(self, "extra_config")
2016
1913
 
@@ -2022,7 +1919,7 @@ class _VirtualMachineState:
2022
1919
  @pulumi.getter(name="extraConfigRebootRequired")
2023
1920
  def extra_config_reboot_required(self) -> Optional[pulumi.Input[bool]]:
2024
1921
  """
2025
- Allow the virtual machine to be rebooted when a change to `extra_config` occurs. Default: `true`.
1922
+ Allow the virtual machine to be rebooted when a change to `extra_config` occurs.
2026
1923
  """
2027
1924
  return pulumi.get(self, "extra_config_reboot_required")
2028
1925
 
@@ -2034,7 +1931,7 @@ class _VirtualMachineState:
2034
1931
  @pulumi.getter
2035
1932
  def firmware(self) -> Optional[pulumi.Input[str]]:
2036
1933
  """
2037
- The firmware for the virtual machine. One of `bios` or `efi`.
1934
+ The firmware interface to use on the virtual machine. Can be one of bios or efi.
2038
1935
  """
2039
1936
  return pulumi.get(self, "firmware")
2040
1937
 
@@ -2046,7 +1943,7 @@ class _VirtualMachineState:
2046
1943
  @pulumi.getter
2047
1944
  def folder(self) -> Optional[pulumi.Input[str]]:
2048
1945
  """
2049
- The path to the virtual machine folder in which to place the virtual machine, relative to the datacenter path (`/<datacenter-name>/vm`). For example, `/dc-01/vm/foo`
1946
+ The name of the folder to locate the virtual machine in.
2050
1947
  """
2051
1948
  return pulumi.get(self, "folder")
2052
1949
 
@@ -2058,7 +1955,7 @@ class _VirtualMachineState:
2058
1955
  @pulumi.getter(name="forcePowerOff")
2059
1956
  def force_power_off(self) -> Optional[pulumi.Input[bool]]:
2060
1957
  """
2061
- If a guest shutdown failed or times out while updating or destroying (see `shutdown_wait_timeout`), force the power-off of the virtual machine. Default: `true`.
1958
+ Set to true to force power-off a virtual machine if a graceful guest shutdown failed for a necessary operation.
2062
1959
  """
2063
1960
  return pulumi.get(self, "force_power_off")
2064
1961
 
@@ -2070,9 +1967,7 @@ class _VirtualMachineState:
2070
1967
  @pulumi.getter(name="guestId")
2071
1968
  def guest_id(self) -> Optional[pulumi.Input[str]]:
2072
1969
  """
2073
- The guest ID for the operating system type. For a full list of possible values, see [here][vmware-docs-guest-ids]. Default: `otherGuest64`.
2074
-
2075
- [vmware-docs-guest-ids]: https://vdc-repo.vmware.com/vmwb-repository/dcr-public/184bb3ba-6fa8-4574-a767-d0c96e2a38f4/ba9422ef-405c-47dd-8553-e11b619185b2/SDK/vsphere-ws/docs/ReferenceGuide/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html
1970
+ The guest ID for the operating system.
2076
1971
  """
2077
1972
  return pulumi.get(self, "guest_id")
2078
1973
 
@@ -2096,10 +1991,7 @@ class _VirtualMachineState:
2096
1991
  @pulumi.getter(name="hardwareVersion")
2097
1992
  def hardware_version(self) -> Optional[pulumi.Input[int]]:
2098
1993
  """
2099
- The hardware version number. Valid range is from 4 to 21. The hardware version cannot be downgraded. See virtual machine hardware [versions][virtual-machine-hardware-versions] and [compatibility][virtual-machine-hardware-compatibility] for more information on supported settings.
2100
-
2101
- [virtual-machine-hardware-versions]: https://kb.vmware.com/s/article/1003746
2102
- [virtual-machine-hardware-compatibility]: https://kb.vmware.com/s/article/2007240
1994
+ The hardware version for the virtual machine.
2103
1995
  """
2104
1996
  return pulumi.get(self, "hardware_version")
2105
1997
 
@@ -2111,7 +2003,7 @@ class _VirtualMachineState:
2111
2003
  @pulumi.getter(name="hostSystemId")
2112
2004
  def host_system_id(self) -> Optional[pulumi.Input[str]]:
2113
2005
  """
2114
- The managed object reference ID of a host on which to place the virtual machine. See the section on virtual machine migration for more information on modifying this value. When using a vSphere cluster, if a `host_system_id` is not supplied, vSphere will select a host in the cluster to place the virtual machine, according to any defaults or vSphere DRS placement policies.
2006
+ The ID of an optional host system to pin the virtual machine to.
2115
2007
  """
2116
2008
  return pulumi.get(self, "host_system_id")
2117
2009
 
@@ -2123,7 +2015,7 @@ class _VirtualMachineState:
2123
2015
  @pulumi.getter(name="hvMode")
2124
2016
  def hv_mode(self) -> Optional[pulumi.Input[str]]:
2125
2017
  """
2126
- The hardware virtualization (non-nested) setting for the virtual machine. One of `hvAuto`, `hvOn`, or `hvOff`. Default: `hvAuto`.
2018
+ The (non-nested) hardware virtualization setting for this virtual machine. Can be one of hvAuto, hvOn, or hvOff.
2127
2019
  """
2128
2020
  return pulumi.get(self, "hv_mode")
2129
2021
 
@@ -2134,9 +2026,6 @@ class _VirtualMachineState:
2134
2026
  @property
2135
2027
  @pulumi.getter(name="ideControllerCount")
2136
2028
  def ide_controller_count(self) -> Optional[pulumi.Input[int]]:
2137
- """
2138
- The number of IDE controllers that the virtual machine. This directly affects the number of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers. Default: `2`.
2139
- """
2140
2029
  return pulumi.get(self, "ide_controller_count")
2141
2030
 
2142
2031
  @ide_controller_count.setter
@@ -2147,7 +2036,7 @@ class _VirtualMachineState:
2147
2036
  @pulumi.getter(name="ignoredGuestIps")
2148
2037
  def ignored_guest_ips(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
2149
2038
  """
2150
- List of IP addresses and CIDR networks to ignore while waiting for an available IP address using either of the waiters. Any IP addresses in this list will be ignored so that the waiter will continue to wait for a valid IP address. Default: `[]`.
2039
+ List of IP addresses and CIDR networks to ignore while waiting for an IP
2151
2040
  """
2152
2041
  return pulumi.get(self, "ignored_guest_ips")
2153
2042
 
@@ -2171,9 +2060,9 @@ class _VirtualMachineState:
2171
2060
  @pulumi.getter(name="latencySensitivity")
2172
2061
  def latency_sensitivity(self) -> Optional[pulumi.Input[str]]:
2173
2062
  """
2174
- Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard devices. One of `low`, `normal`, `medium`, or `high`.
2175
-
2176
- > **NOTE:** On higher sensitivities, you may need to adjust the `memory_reservation` to the full amount of memory provisioned for the virtual machine.
2063
+ Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower
2064
+ latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard
2065
+ devices. Can be one of low, normal, medium, or high.
2177
2066
  """
2178
2067
  return pulumi.get(self, "latency_sensitivity")
2179
2068
 
@@ -2185,7 +2074,7 @@ class _VirtualMachineState:
2185
2074
  @pulumi.getter
2186
2075
  def memory(self) -> Optional[pulumi.Input[int]]:
2187
2076
  """
2188
- The memory size to assign to the virtual machine, in MB. Default: `1024` (1 GB).
2077
+ The size of the virtual machine's memory, in MB.
2189
2078
  """
2190
2079
  return pulumi.get(self, "memory")
2191
2080
 
@@ -2197,15 +2086,7 @@ class _VirtualMachineState:
2197
2086
  @pulumi.getter(name="memoryHotAddEnabled")
2198
2087
  def memory_hot_add_enabled(self) -> Optional[pulumi.Input[bool]]:
2199
2088
  """
2200
- Allow memory to be added to the virtual machine while it is powered on.
2201
-
2202
- > **NOTE:** CPU and memory hot add options are not available on all guest operating systems. Please refer to the [VMware Guest OS Compatibility Guide][vmware-docs-compat-guide] to which settings are allow for your guest operating system. In addition, at least one `pulumi up` must be run before you are able to use CPU and memory hot add.
2203
-
2204
- [vmware-docs-compat-guide]: http://partnerweb.vmware.com/comp_guide2/pdf/VMware_GOS_Compatibility_Guide.pdf
2205
-
2206
- > **NOTE:** For Linux 64-bit guest operating systems with less than or equal to 3GB, the virtual machine must powered off to add memory beyond 3GB. Subsequent hot add of memory does not require the virtual machine to be powered-off to apply the plan. Please refer to [VMware KB 2008405][vmware-kb-2008405].
2207
-
2208
- [vmware-kb-2008405]: https://kb.vmware.com/s/article/2008405
2089
+ Allow memory to be added to this virtual machine while it is running.
2209
2090
  """
2210
2091
  return pulumi.get(self, "memory_hot_add_enabled")
2211
2092
 
@@ -2217,7 +2098,8 @@ class _VirtualMachineState:
2217
2098
  @pulumi.getter(name="memoryLimit")
2218
2099
  def memory_limit(self) -> Optional[pulumi.Input[int]]:
2219
2100
  """
2220
- The maximum amount of memory (in MB) that th virtual machine can consume, regardless of available resources. The default is no limit.
2101
+ The maximum amount of memory (in MB) or CPU (in MHz) that this virtual machine can consume, regardless of available
2102
+ resources.
2221
2103
  """
2222
2104
  return pulumi.get(self, "memory_limit")
2223
2105
 
@@ -2229,7 +2111,7 @@ class _VirtualMachineState:
2229
2111
  @pulumi.getter(name="memoryReservation")
2230
2112
  def memory_reservation(self) -> Optional[pulumi.Input[int]]:
2231
2113
  """
2232
- The amount of memory (in MB) that the virtual machine is guaranteed. The default is no reservation.
2114
+ The amount of memory (in MB) or CPU (in MHz) that this virtual machine is guaranteed.
2233
2115
  """
2234
2116
  return pulumi.get(self, "memory_reservation")
2235
2117
 
@@ -2255,7 +2137,7 @@ class _VirtualMachineState:
2255
2137
  @pulumi.getter(name="memoryShareCount")
2256
2138
  def memory_share_count(self) -> Optional[pulumi.Input[int]]:
2257
2139
  """
2258
- The number of memory shares allocated to the virtual machine when the `memory_share_level` is `custom`.
2140
+ The amount of shares to allocate to memory for a custom share level.
2259
2141
  """
2260
2142
  return pulumi.get(self, "memory_share_count")
2261
2143
 
@@ -2267,7 +2149,7 @@ class _VirtualMachineState:
2267
2149
  @pulumi.getter(name="memoryShareLevel")
2268
2150
  def memory_share_level(self) -> Optional[pulumi.Input[str]]:
2269
2151
  """
2270
- The allocation level for the virtual machine memory resources. One of `high`, `low`, `normal`, or `custom`. Default: `custom`.
2152
+ The allocation level for memory resources. Can be one of high, low, normal, or custom.
2271
2153
  """
2272
2154
  return pulumi.get(self, "memory_share_level")
2273
2155
 
@@ -2279,7 +2161,7 @@ class _VirtualMachineState:
2279
2161
  @pulumi.getter(name="migrateWaitTimeout")
2280
2162
  def migrate_wait_timeout(self) -> Optional[pulumi.Input[int]]:
2281
2163
  """
2282
- The amount of time, in minutes, to wait for a virtual machine migration to complete before failing. Default: `10` minutes. See the section on virtual machine migration for more information.
2164
+ The amount of time, in minutes, to wait for a vMotion operation to complete before failing.
2283
2165
  """
2284
2166
  return pulumi.get(self, "migrate_wait_timeout")
2285
2167
 
@@ -2303,7 +2185,7 @@ class _VirtualMachineState:
2303
2185
  @pulumi.getter
2304
2186
  def name(self) -> Optional[pulumi.Input[str]]:
2305
2187
  """
2306
- The name of the virtual machine.
2188
+ The name of this virtual machine.
2307
2189
  """
2308
2190
  return pulumi.get(self, "name")
2309
2191
 
@@ -2315,7 +2197,7 @@ class _VirtualMachineState:
2315
2197
  @pulumi.getter(name="nestedHvEnabled")
2316
2198
  def nested_hv_enabled(self) -> Optional[pulumi.Input[bool]]:
2317
2199
  """
2318
- Enable nested hardware virtualization on the virtual machine, facilitating nested virtualization in the guest operating system. Default: `false`.
2200
+ Enable nested hardware virtualization on this virtual machine, facilitating nested virtualization in the guest.
2319
2201
  """
2320
2202
  return pulumi.get(self, "nested_hv_enabled")
2321
2203
 
@@ -2327,7 +2209,7 @@ class _VirtualMachineState:
2327
2209
  @pulumi.getter(name="networkInterfaces")
2328
2210
  def network_interfaces(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['VirtualMachineNetworkInterfaceArgs']]]]:
2329
2211
  """
2330
- A specification for a virtual NIC on the virtual machine. See network interface options for more information.
2212
+ A specification for a virtual NIC on this virtual machine.
2331
2213
  """
2332
2214
  return pulumi.get(self, "network_interfaces")
2333
2215
 
@@ -2339,7 +2221,8 @@ class _VirtualMachineState:
2339
2221
  @pulumi.getter(name="numCoresPerSocket")
2340
2222
  def num_cores_per_socket(self) -> Optional[pulumi.Input[int]]:
2341
2223
  """
2342
- The number of cores per socket in the virtual machine. The number of vCPUs on the virtual machine will be `num_cpus` divided by `num_cores_per_socket`. If specified, the value supplied to `num_cpus` must be evenly divisible by this value. Default: `1`.
2224
+ The number of cores to distribute amongst the CPUs in this virtual machine. If specified, the value supplied to num_cpus
2225
+ must be evenly divisible by this value.
2343
2226
  """
2344
2227
  return pulumi.get(self, "num_cores_per_socket")
2345
2228
 
@@ -2351,7 +2234,7 @@ class _VirtualMachineState:
2351
2234
  @pulumi.getter(name="numCpus")
2352
2235
  def num_cpus(self) -> Optional[pulumi.Input[int]]:
2353
2236
  """
2354
- The total number of virtual processor cores to assign to the virtual machine. Default: `1`.
2237
+ The number of virtual processors to assign to this virtual machine.
2355
2238
  """
2356
2239
  return pulumi.get(self, "num_cpus")
2357
2240
 
@@ -2363,7 +2246,7 @@ class _VirtualMachineState:
2363
2246
  @pulumi.getter(name="ovfDeploy")
2364
2247
  def ovf_deploy(self) -> Optional[pulumi.Input['VirtualMachineOvfDeployArgs']]:
2365
2248
  """
2366
- When specified, the virtual machine will be deployed from the provided OVF/OVA template. See creating a virtual machine from an OVF/OVA template for more information.
2249
+ A specification for deploying a virtual machine from ovf/ova template.
2367
2250
  """
2368
2251
  return pulumi.get(self, "ovf_deploy")
2369
2252
 
@@ -2375,9 +2258,7 @@ class _VirtualMachineState:
2375
2258
  @pulumi.getter(name="pciDeviceIds")
2376
2259
  def pci_device_ids(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
2377
2260
  """
2378
- List of host PCI device IDs in which to create PCI passthroughs.
2379
-
2380
- > **NOTE:** Cloning requires vCenter Server and is not supported on direct ESXi host connections.
2261
+ A list of PCI passthrough devices
2381
2262
  """
2382
2263
  return pulumi.get(self, "pci_device_ids")
2383
2264
 
@@ -2412,9 +2293,6 @@ class _VirtualMachineState:
2412
2293
  @property
2413
2294
  @pulumi.getter(name="rebootRequired")
2414
2295
  def reboot_required(self) -> Optional[pulumi.Input[bool]]:
2415
- """
2416
- Value internal to Terraform used to determine if a configuration set change requires a reboot.
2417
- """
2418
2296
  return pulumi.get(self, "reboot_required")
2419
2297
 
2420
2298
  @reboot_required.setter
@@ -2426,8 +2304,6 @@ class _VirtualMachineState:
2426
2304
  def replace_trigger(self) -> Optional[pulumi.Input[str]]:
2427
2305
  """
2428
2306
  Triggers replacement of resource whenever it changes.
2429
-
2430
- For example, `replace_trigger = sha256(format("%!s(MISSING)-%!s(MISSING)",data.template_file.cloud_init_metadata.rendered,data.template_file.cloud_init_userdata.rendered))` will fingerprint the changes in cloud-init metadata and userdata templates. This will enable a replacement of the resource whenever the dependant template renders a new configuration. (Forces a replacement.)
2431
2307
  """
2432
2308
  return pulumi.get(self, "replace_trigger")
2433
2309
 
@@ -2439,9 +2315,7 @@ class _VirtualMachineState:
2439
2315
  @pulumi.getter(name="resourcePoolId")
2440
2316
  def resource_pool_id(self) -> Optional[pulumi.Input[str]]:
2441
2317
  """
2442
- The managed object reference ID of the resource pool in which to place the virtual machine. See the Virtual Machine Migration section for more information on modifying this value.
2443
-
2444
- > **NOTE:** All clusters and standalone hosts have a default root resource pool. This resource argument does not directly accept the cluster or standalone host resource. For more information, see the section on specifying the Root Resource Pool in the `ResourcePool` data source documentation on using the root resource pool.
2318
+ The ID of a resource pool to put the virtual machine in.
2445
2319
  """
2446
2320
  return pulumi.get(self, "resource_pool_id")
2447
2321
 
@@ -2453,7 +2327,7 @@ class _VirtualMachineState:
2453
2327
  @pulumi.getter(name="runToolsScriptsAfterPowerOn")
2454
2328
  def run_tools_scripts_after_power_on(self) -> Optional[pulumi.Input[bool]]:
2455
2329
  """
2456
- Enable post-power-on scripts to run when VMware Tools is installed. Default: `true`.
2330
+ Enable the run of scripts after virtual machine power-on when VMware Tools is installed.
2457
2331
  """
2458
2332
  return pulumi.get(self, "run_tools_scripts_after_power_on")
2459
2333
 
@@ -2465,7 +2339,7 @@ class _VirtualMachineState:
2465
2339
  @pulumi.getter(name="runToolsScriptsAfterResume")
2466
2340
  def run_tools_scripts_after_resume(self) -> Optional[pulumi.Input[bool]]:
2467
2341
  """
2468
- Enable ost-resume scripts to run when VMware Tools is installed. Default: `true`.
2342
+ Enable the run of scripts after virtual machine resume when when VMware Tools is installed.
2469
2343
  """
2470
2344
  return pulumi.get(self, "run_tools_scripts_after_resume")
2471
2345
 
@@ -2477,7 +2351,7 @@ class _VirtualMachineState:
2477
2351
  @pulumi.getter(name="runToolsScriptsBeforeGuestReboot")
2478
2352
  def run_tools_scripts_before_guest_reboot(self) -> Optional[pulumi.Input[bool]]:
2479
2353
  """
2480
- Enable pre-reboot scripts to run when VMware Tools is installed. Default: `false`.
2354
+ Enable the run of scripts before guest operating system reboot when VMware Tools is installed.
2481
2355
  """
2482
2356
  return pulumi.get(self, "run_tools_scripts_before_guest_reboot")
2483
2357
 
@@ -2489,7 +2363,7 @@ class _VirtualMachineState:
2489
2363
  @pulumi.getter(name="runToolsScriptsBeforeGuestShutdown")
2490
2364
  def run_tools_scripts_before_guest_shutdown(self) -> Optional[pulumi.Input[bool]]:
2491
2365
  """
2492
- Enable pre-shutdown scripts to run when VMware Tools is installed. Default: `true`.
2366
+ Enable the run of scripts before guest operating system shutdown when VMware Tools is installed.
2493
2367
  """
2494
2368
  return pulumi.get(self, "run_tools_scripts_before_guest_shutdown")
2495
2369
 
@@ -2501,7 +2375,7 @@ class _VirtualMachineState:
2501
2375
  @pulumi.getter(name="runToolsScriptsBeforeGuestStandby")
2502
2376
  def run_tools_scripts_before_guest_standby(self) -> Optional[pulumi.Input[bool]]:
2503
2377
  """
2504
- Enable pre-standby scripts to run when VMware Tools is installed. Default: `true`.
2378
+ Enable the run of scripts before guest operating system standby when VMware Tools is installed.
2505
2379
  """
2506
2380
  return pulumi.get(self, "run_tools_scripts_before_guest_standby")
2507
2381
 
@@ -2512,11 +2386,6 @@ class _VirtualMachineState:
2512
2386
  @property
2513
2387
  @pulumi.getter(name="sataControllerCount")
2514
2388
  def sata_controller_count(self) -> Optional[pulumi.Input[int]]:
2515
- """
2516
- The number of SATA controllers that Terraform manages on this virtual machine. This directly affects the amount of disks
2517
- you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove
2518
- controllers.
2519
- """
2520
2389
  return pulumi.get(self, "sata_controller_count")
2521
2390
 
2522
2391
  @sata_controller_count.setter
@@ -2527,7 +2396,7 @@ class _VirtualMachineState:
2527
2396
  @pulumi.getter(name="scsiBusSharing")
2528
2397
  def scsi_bus_sharing(self) -> Optional[pulumi.Input[str]]:
2529
2398
  """
2530
- The type of SCSI bus sharing for the virtual machine SCSI controller. One of `physicalSharing`, `virtualSharing`, and `noSharing`. Default: `noSharing`.
2399
+ Mode for sharing the SCSI bus. The modes are physicalSharing, virtualSharing, and noSharing.
2531
2400
  """
2532
2401
  return pulumi.get(self, "scsi_bus_sharing")
2533
2402
 
@@ -2538,11 +2407,6 @@ class _VirtualMachineState:
2538
2407
  @property
2539
2408
  @pulumi.getter(name="scsiControllerCount")
2540
2409
  def scsi_controller_count(self) -> Optional[pulumi.Input[int]]:
2541
- """
2542
- The number of SCSI controllers that Terraform manages on this virtual machine. This directly affects the amount of disks
2543
- you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove
2544
- controllers.
2545
- """
2546
2410
  return pulumi.get(self, "scsi_controller_count")
2547
2411
 
2548
2412
  @scsi_controller_count.setter
@@ -2553,7 +2417,7 @@ class _VirtualMachineState:
2553
2417
  @pulumi.getter(name="scsiType")
2554
2418
  def scsi_type(self) -> Optional[pulumi.Input[str]]:
2555
2419
  """
2556
- The SCSI controller type for the virtual machine. One of `lsilogic` (LSI Logic Parallel), `lsilogic-sas` (LSI Logic SAS) or `pvscsi` (VMware Paravirtual). Default: `pvscsi`.
2420
+ The type of SCSI bus this virtual machine will have. Can be one of lsilogic, lsilogic-sas or pvscsi.
2557
2421
  """
2558
2422
  return pulumi.get(self, "scsi_type")
2559
2423
 
@@ -2565,7 +2429,7 @@ class _VirtualMachineState:
2565
2429
  @pulumi.getter(name="shutdownWaitTimeout")
2566
2430
  def shutdown_wait_timeout(self) -> Optional[pulumi.Input[int]]:
2567
2431
  """
2568
- The amount of time, in minutes, to wait for a graceful guest shutdown when making necessary updates to the virtual machine. If `force_power_off` is set to `true`, the virtual machine will be forced to power-off after the timeout, otherwise an error is returned. Default: `3` minutes.
2432
+ The amount of time, in minutes, to wait for shutdown when making necessary updates to the virtual machine.
2569
2433
  """
2570
2434
  return pulumi.get(self, "shutdown_wait_timeout")
2571
2435
 
@@ -2577,7 +2441,7 @@ class _VirtualMachineState:
2577
2441
  @pulumi.getter(name="storagePolicyId")
2578
2442
  def storage_policy_id(self) -> Optional[pulumi.Input[str]]:
2579
2443
  """
2580
- The UUID of the storage policy to assign to the virtual disk.
2444
+ The ID of the storage policy to assign to the virtual machine home directory.
2581
2445
  """
2582
2446
  return pulumi.get(self, "storage_policy_id")
2583
2447
 
@@ -2589,7 +2453,7 @@ class _VirtualMachineState:
2589
2453
  @pulumi.getter(name="swapPlacementPolicy")
2590
2454
  def swap_placement_policy(self) -> Optional[pulumi.Input[str]]:
2591
2455
  """
2592
- The swap file placement policy for the virtual machine. One of `inherit`, `hostLocal`, or `vmDirectory`. Default: `inherit`.
2456
+ The swap file placement policy for this virtual machine. Can be one of inherit, hostLocal, or vmDirectory.
2593
2457
  """
2594
2458
  return pulumi.get(self, "swap_placement_policy")
2595
2459
 
@@ -2601,7 +2465,8 @@ class _VirtualMachineState:
2601
2465
  @pulumi.getter(name="syncTimeWithHost")
2602
2466
  def sync_time_with_host(self) -> Optional[pulumi.Input[bool]]:
2603
2467
  """
2604
- Enable the guest operating system to synchronization its clock with the host when the virtual machine is powered on or resumed. Requires vSphere 7.0 Update 1 and later. Requires VMware Tools to be installed. Default: `true`.
2468
+ Enable guest clock synchronization with the host. On vSphere 7.0 U1 and above, with only this setting the clock is
2469
+ synchronized on startup and resume. Requires VMware Tools to be installed.
2605
2470
  """
2606
2471
  return pulumi.get(self, "sync_time_with_host")
2607
2472
 
@@ -2613,7 +2478,8 @@ class _VirtualMachineState:
2613
2478
  @pulumi.getter(name="syncTimeWithHostPeriodically")
2614
2479
  def sync_time_with_host_periodically(self) -> Optional[pulumi.Input[bool]]:
2615
2480
  """
2616
- Enable the guest operating system to periodically synchronize its clock with the host. Requires vSphere 7.0 Update 1 and later. On previous versions, setting `sync_time_with_host` is will enable periodic synchronization. Requires VMware Tools to be installed. Default: `false`.
2481
+ Enable periodic clock synchronization with the host. Supported only on vSphere 7.0 U1 and above. On prior versions
2482
+ setting `sync_time_with_host` is enough for periodic synchronization. Requires VMware Tools to be installed.
2617
2483
  """
2618
2484
  return pulumi.get(self, "sync_time_with_host_periodically")
2619
2485
 
@@ -2625,9 +2491,7 @@ class _VirtualMachineState:
2625
2491
  @pulumi.getter
2626
2492
  def tags(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
2627
2493
  """
2628
- The IDs of any tags to attach to this resource. Please refer to the `Tag` resource for more information on applying tags to virtual machine resources.
2629
-
2630
- > **NOTE:** Tagging support is unsupported on direct ESXi host connections and requires vCenter Server instance.
2494
+ A list of tag IDs to apply to this object.
2631
2495
  """
2632
2496
  return pulumi.get(self, "tags")
2633
2497
 
@@ -2639,7 +2503,7 @@ class _VirtualMachineState:
2639
2503
  @pulumi.getter(name="toolsUpgradePolicy")
2640
2504
  def tools_upgrade_policy(self) -> Optional[pulumi.Input[str]]:
2641
2505
  """
2642
- Enable automatic upgrade of the VMware Tools version when the virtual machine is rebooted. If necessary, VMware Tools is upgraded to the latest version supported by the host on which the virtual machine is running. Requires VMware Tools to be installed. One of `manual` or `upgradeAtPowerCycle`. Default: `manual`.
2506
+ Set the upgrade policy for VMware Tools. Can be one of `manual` or `upgradeAtPowerCycle`.
2643
2507
  """
2644
2508
  return pulumi.get(self, "tools_upgrade_policy")
2645
2509
 
@@ -2651,7 +2515,7 @@ class _VirtualMachineState:
2651
2515
  @pulumi.getter
2652
2516
  def uuid(self) -> Optional[pulumi.Input[str]]:
2653
2517
  """
2654
- The UUID of the virtual disk VMDK file. This is used to track the virtual disk on the virtual machine.
2518
+ The UUID of the virtual machine. Also exposed as the `id` of the resource.
2655
2519
  """
2656
2520
  return pulumi.get(self, "uuid")
2657
2521
 
@@ -2663,7 +2527,7 @@ class _VirtualMachineState:
2663
2527
  @pulumi.getter
2664
2528
  def vapp(self) -> Optional[pulumi.Input['VirtualMachineVappArgs']]:
2665
2529
  """
2666
- Used for vApp configurations. The only sub-key available is `properties`, which is a key/value map of properties for virtual machines imported from and OVF/OVA. See Using vApp Properties for OVF/OVA Configuration for more information.
2530
+ vApp configuration data for this virtual machine. Can be used to provide configuration data for OVF images.
2667
2531
  """
2668
2532
  return pulumi.get(self, "vapp")
2669
2533
 
@@ -2687,7 +2551,7 @@ class _VirtualMachineState:
2687
2551
  @pulumi.getter(name="vbsEnabled")
2688
2552
  def vbs_enabled(self) -> Optional[pulumi.Input[bool]]:
2689
2553
  """
2690
- Enable Virtualization Based Security. Requires `firmware` to be `efi`. In addition, `vvtd_enabled`, `nested_hv_enabled`, and `efi_secure_boot_enabled` must all have a value of `true`. Supported on vSphere 6.7 and later. Default: `false`.
2554
+ Flag to specify if Virtualization-based security is enabled for this virtual machine.
2691
2555
  """
2692
2556
  return pulumi.get(self, "vbs_enabled")
2693
2557
 
@@ -2723,7 +2587,8 @@ class _VirtualMachineState:
2723
2587
  @pulumi.getter(name="vvtdEnabled")
2724
2588
  def vvtd_enabled(self) -> Optional[pulumi.Input[bool]]:
2725
2589
  """
2726
- Enable Intel Virtualization Technology for Directed I/O for the virtual machine (_I/O MMU_ in the vSphere Client). Supported on vSphere 6.7 and later. Default: `false`.
2590
+ Flag to specify if I/O MMU virtualization, also called Intel Virtualization Technology for Directed I/O (VT-d) and AMD
2591
+ I/O Virtualization (AMD-Vi or IOMMU), is enabled.
2727
2592
  """
2728
2593
  return pulumi.get(self, "vvtd_enabled")
2729
2594
 
@@ -2735,7 +2600,8 @@ class _VirtualMachineState:
2735
2600
  @pulumi.getter(name="waitForGuestIpTimeout")
2736
2601
  def wait_for_guest_ip_timeout(self) -> Optional[pulumi.Input[int]]:
2737
2602
  """
2738
- The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. This should only be used if the version VMware Tools does not allow the `wait_for_guest_net_timeout` waiter to be used. A value less than `1` disables the waiter. Default: `0`.
2603
+ The amount of time, in minutes, to wait for an available IP address on this virtual machine. A value less than 1
2604
+ disables the waiter.
2739
2605
  """
2740
2606
  return pulumi.get(self, "wait_for_guest_ip_timeout")
2741
2607
 
@@ -2747,7 +2613,8 @@ class _VirtualMachineState:
2747
2613
  @pulumi.getter(name="waitForGuestNetRoutable")
2748
2614
  def wait_for_guest_net_routable(self) -> Optional[pulumi.Input[bool]]:
2749
2615
  """
2750
- Controls whether or not the guest network waiter waits for a routable address. When `false`, the waiter does not wait for a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria. This property is ignored if the `wait_for_guest_ip_timeout` waiter is used. Default: `true`.
2616
+ Controls whether or not the guest network waiter waits for a routable address. When false, the waiter does not wait for
2617
+ a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria.
2751
2618
  """
2752
2619
  return pulumi.get(self, "wait_for_guest_net_routable")
2753
2620
 
@@ -2759,7 +2626,8 @@ class _VirtualMachineState:
2759
2626
  @pulumi.getter(name="waitForGuestNetTimeout")
2760
2627
  def wait_for_guest_net_timeout(self) -> Optional[pulumi.Input[int]]:
2761
2628
  """
2762
- The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. Older versions of VMware Tools do not populate this property. In those cases, this waiter can be disabled and the `wait_for_guest_ip_timeout` waiter can be used instead. A value less than `1` disables the waiter. Default: `5` minutes.
2629
+ The amount of time, in minutes, to wait for an available IP address on this virtual machine. A value less than 1
2630
+ disables the waiter.
2763
2631
  """
2764
2632
  return pulumi.get(self, "wait_for_guest_net_timeout")
2765
2633
 
@@ -2853,122 +2721,93 @@ class VirtualMachine(pulumi.CustomResource):
2853
2721
  Create a VirtualMachine resource with the given unique name, props, and options.
2854
2722
  :param str resource_name: The name of the resource.
2855
2723
  :param pulumi.ResourceOptions opts: Options for the resource.
2856
- :param pulumi.Input[str] alternate_guest_name: The guest name for the operating system when `guest_id` is `otherGuest` or `otherGuest64`.
2857
- :param pulumi.Input[str] annotation: A user-provided description of the virtual machine.
2858
- :param pulumi.Input[int] boot_delay: The number of milliseconds to wait before starting the boot sequence. The default is no delay.
2859
- :param pulumi.Input[int] boot_retry_delay: The number of milliseconds to wait before retrying the boot sequence. This option is only valid if `boot_retry_enabled` is `true`. Default: `10000` (10 seconds).
2860
- :param pulumi.Input[bool] boot_retry_enabled: If set to `true`, a virtual machine that fails to boot will try again after the delay defined in `boot_retry_delay`. Default: `false`.
2861
- :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['VirtualMachineCdromArgs']]]] cdroms: A specification for a CD-ROM device on the virtual machine. See CD-ROM options for more information.
2862
- :param pulumi.Input[pulumi.InputType['VirtualMachineCloneArgs']] clone: When specified, the virtual machine will be created as a clone of a specified template. Optional customization options can be submitted for the resource. See creating a virtual machine from a template for more information.
2863
- :param pulumi.Input[bool] cpu_hot_add_enabled: Allow CPUs to be added to the virtual machine while it is powered on.
2864
- :param pulumi.Input[bool] cpu_hot_remove_enabled: Allow CPUs to be removed to the virtual machine while it is powered on.
2865
- :param pulumi.Input[int] cpu_limit: The maximum amount of CPU (in MHz) that the virtual machine can consume, regardless of available resources. The default is no limit.
2866
- :param pulumi.Input[bool] cpu_performance_counters_enabled: Enable CPU performance counters on the virtual machine. Default: `false`.
2867
- :param pulumi.Input[int] cpu_reservation: The amount of CPU (in MHz) that the virtual machine is guaranteed. The default is no reservation.
2868
- :param pulumi.Input[int] cpu_share_count: The number of CPU shares allocated to the virtual machine when the `cpu_share_level` is `custom`.
2869
- :param pulumi.Input[str] cpu_share_level: The allocation level for the virtual machine CPU resources. One of `high`, `low`, `normal`, or `custom`. Default: `custom`.
2870
- :param pulumi.Input[Mapping[str, pulumi.Input[str]]] custom_attributes: Map of custom attribute ids to attribute value strings to set for virtual machine. Please refer to the `vsphere_custom_attributes` resource for more information on setting custom attributes.
2871
-
2872
- > **NOTE:** Custom attributes requires vCenter Server and is not supported on direct ESXi host connections.
2873
- :param pulumi.Input[str] datacenter_id: The datacenter ID. Required only when deploying an OVF/OVA template.
2874
- :param pulumi.Input[str] datastore_cluster_id: The managed object reference ID of the datastore cluster in which to place the virtual machine. This setting applies to entire virtual machine and implies that you wish to use vSphere Storage DRS with the virtual machine. See the section on virtual machine migration for more information on modifying this value.
2875
-
2876
- > **NOTE:** One of `datastore_id` or `datastore_cluster_id` must be specified.
2877
-
2878
- > **NOTE:** Use of `datastore_cluster_id` requires vSphere Storage DRS to be enabled on the specified datastore cluster.
2879
-
2880
- > **NOTE:** The `datastore_cluster_id` setting applies to the entire virtual machine resource. You cannot assign individual individual disks to datastore clusters. In addition, you cannot use the `attach` setting to attach external disks on virtual machines that are assigned to datastore clusters.
2881
- :param pulumi.Input[str] datastore_id: The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with `client_device`.
2882
- :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['VirtualMachineDiskArgs']]]] disks: A specification for a virtual disk device on the virtual machine. See disk options for more information.
2883
- :param pulumi.Input[bool] efi_secure_boot_enabled: Use this option to enable EFI secure boot when the `firmware` type is set to is `efi`. Default: `false`.
2884
-
2885
- > **NOTE:** EFI secure boot is only available on vSphere 6.5 and later.
2886
- :param pulumi.Input[bool] enable_disk_uuid: Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest. Default: `false`.
2887
- :param pulumi.Input[bool] enable_logging: Enable logging of virtual machine events to a log file stored in the virtual machine directory. Default: `false`.
2888
- :param pulumi.Input[str] ept_rvi_mode: The EPT/RVI (hardware memory virtualization) setting for the virtual machine. One of `automatic`, `on`, or `off`. Default: `automatic`.
2889
- :param pulumi.Input[Mapping[str, pulumi.Input[str]]] extra_config: Extra configuration data for the virtual machine. Can be used to supply advanced parameters not normally in configuration, such as instance metadata and userdata.
2890
-
2891
- > **NOTE:** Do not use `extra_config` when working with a template imported from OVF/OVA as your settings may be ignored. Use the `vapp` block `properties` section as described in Using vApp Properties for OVF/OVA Configuration.
2892
- :param pulumi.Input[bool] extra_config_reboot_required: Allow the virtual machine to be rebooted when a change to `extra_config` occurs. Default: `true`.
2893
- :param pulumi.Input[str] firmware: The firmware for the virtual machine. One of `bios` or `efi`.
2894
- :param pulumi.Input[str] folder: The path to the virtual machine folder in which to place the virtual machine, relative to the datacenter path (`/<datacenter-name>/vm`). For example, `/dc-01/vm/foo`
2895
- :param pulumi.Input[bool] force_power_off: If a guest shutdown failed or times out while updating or destroying (see `shutdown_wait_timeout`), force the power-off of the virtual machine. Default: `true`.
2896
- :param pulumi.Input[str] guest_id: The guest ID for the operating system type. For a full list of possible values, see [here][vmware-docs-guest-ids]. Default: `otherGuest64`.
2897
-
2898
- [vmware-docs-guest-ids]: https://vdc-repo.vmware.com/vmwb-repository/dcr-public/184bb3ba-6fa8-4574-a767-d0c96e2a38f4/ba9422ef-405c-47dd-8553-e11b619185b2/SDK/vsphere-ws/docs/ReferenceGuide/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html
2899
- :param pulumi.Input[int] hardware_version: The hardware version number. Valid range is from 4 to 21. The hardware version cannot be downgraded. See virtual machine hardware [versions][virtual-machine-hardware-versions] and [compatibility][virtual-machine-hardware-compatibility] for more information on supported settings.
2900
-
2901
- [virtual-machine-hardware-versions]: https://kb.vmware.com/s/article/1003746
2902
- [virtual-machine-hardware-compatibility]: https://kb.vmware.com/s/article/2007240
2903
- :param pulumi.Input[str] host_system_id: The managed object reference ID of a host on which to place the virtual machine. See the section on virtual machine migration for more information on modifying this value. When using a vSphere cluster, if a `host_system_id` is not supplied, vSphere will select a host in the cluster to place the virtual machine, according to any defaults or vSphere DRS placement policies.
2904
- :param pulumi.Input[str] hv_mode: The hardware virtualization (non-nested) setting for the virtual machine. One of `hvAuto`, `hvOn`, or `hvOff`. Default: `hvAuto`.
2905
- :param pulumi.Input[int] ide_controller_count: The number of IDE controllers that the virtual machine. This directly affects the number of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers. Default: `2`.
2906
- :param pulumi.Input[Sequence[pulumi.Input[str]]] ignored_guest_ips: List of IP addresses and CIDR networks to ignore while waiting for an available IP address using either of the waiters. Any IP addresses in this list will be ignored so that the waiter will continue to wait for a valid IP address. Default: `[]`.
2907
- :param pulumi.Input[str] latency_sensitivity: Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard devices. One of `low`, `normal`, `medium`, or `high`.
2908
-
2909
- > **NOTE:** On higher sensitivities, you may need to adjust the `memory_reservation` to the full amount of memory provisioned for the virtual machine.
2910
- :param pulumi.Input[int] memory: The memory size to assign to the virtual machine, in MB. Default: `1024` (1 GB).
2911
- :param pulumi.Input[bool] memory_hot_add_enabled: Allow memory to be added to the virtual machine while it is powered on.
2912
-
2913
- > **NOTE:** CPU and memory hot add options are not available on all guest operating systems. Please refer to the [VMware Guest OS Compatibility Guide][vmware-docs-compat-guide] to which settings are allow for your guest operating system. In addition, at least one `pulumi up` must be run before you are able to use CPU and memory hot add.
2914
-
2915
- [vmware-docs-compat-guide]: http://partnerweb.vmware.com/comp_guide2/pdf/VMware_GOS_Compatibility_Guide.pdf
2916
-
2917
- > **NOTE:** For Linux 64-bit guest operating systems with less than or equal to 3GB, the virtual machine must powered off to add memory beyond 3GB. Subsequent hot add of memory does not require the virtual machine to be powered-off to apply the plan. Please refer to [VMware KB 2008405][vmware-kb-2008405].
2918
-
2919
- [vmware-kb-2008405]: https://kb.vmware.com/s/article/2008405
2920
- :param pulumi.Input[int] memory_limit: The maximum amount of memory (in MB) that th virtual machine can consume, regardless of available resources. The default is no limit.
2921
- :param pulumi.Input[int] memory_reservation: The amount of memory (in MB) that the virtual machine is guaranteed. The default is no reservation.
2724
+ :param pulumi.Input[str] alternate_guest_name: The guest name for the operating system when guest_id is otherGuest or otherGuest64.
2725
+ :param pulumi.Input[str] annotation: User-provided description of the virtual machine.
2726
+ :param pulumi.Input[int] boot_delay: The number of milliseconds to wait before starting the boot sequence.
2727
+ :param pulumi.Input[int] boot_retry_delay: The number of milliseconds to wait before retrying the boot sequence. This only valid if boot_retry_enabled is true.
2728
+ :param pulumi.Input[bool] boot_retry_enabled: If set to true, a virtual machine that fails to boot will try again after the delay defined in boot_retry_delay.
2729
+ :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['VirtualMachineCdromArgs']]]] cdroms: A specification for a CDROM device on this virtual machine.
2730
+ :param pulumi.Input[pulumi.InputType['VirtualMachineCloneArgs']] clone: A specification for cloning a virtual machine from template.
2731
+ :param pulumi.Input[bool] cpu_hot_add_enabled: Allow CPUs to be added to this virtual machine while it is running.
2732
+ :param pulumi.Input[bool] cpu_hot_remove_enabled: Allow CPUs to be added to this virtual machine while it is running.
2733
+ :param pulumi.Input[int] cpu_limit: The maximum amount of memory (in MB) or CPU (in MHz) that this virtual machine can consume, regardless of available
2734
+ resources.
2735
+ :param pulumi.Input[bool] cpu_performance_counters_enabled: Enable CPU performance counters on this virtual machine.
2736
+ :param pulumi.Input[int] cpu_reservation: The amount of memory (in MB) or CPU (in MHz) that this virtual machine is guaranteed.
2737
+ :param pulumi.Input[int] cpu_share_count: The amount of shares to allocate to cpu for a custom share level.
2738
+ :param pulumi.Input[str] cpu_share_level: The allocation level for cpu resources. Can be one of high, low, normal, or custom.
2739
+ :param pulumi.Input[Mapping[str, pulumi.Input[str]]] custom_attributes: A list of custom attributes to set on this resource.
2740
+ :param pulumi.Input[str] datacenter_id: The ID of the datacenter where the VM is to be created.
2741
+ :param pulumi.Input[str] datastore_cluster_id: The ID of a datastore cluster to put the virtual machine in.
2742
+ :param pulumi.Input[str] datastore_id: The ID of the virtual machine's datastore. The virtual machine configuration is placed here, along with any virtual
2743
+ disks that are created without datastores.
2744
+ :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['VirtualMachineDiskArgs']]]] disks: A specification for a virtual disk device on this virtual machine.
2745
+ :param pulumi.Input[bool] efi_secure_boot_enabled: When the boot type set in firmware is efi, this enables EFI secure boot.
2746
+ :param pulumi.Input[bool] enable_disk_uuid: Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest.
2747
+ :param pulumi.Input[bool] enable_logging: Enable logging on this virtual machine.
2748
+ :param pulumi.Input[str] ept_rvi_mode: The EPT/RVI (hardware memory virtualization) setting for this virtual machine. Can be one of automatic, on, or off.
2749
+ :param pulumi.Input[Mapping[str, pulumi.Input[str]]] extra_config: Extra configuration data for this virtual machine. Can be used to supply advanced parameters not normally in
2750
+ configuration, such as instance metadata, or configuration data for OVF images.
2751
+ :param pulumi.Input[bool] extra_config_reboot_required: Allow the virtual machine to be rebooted when a change to `extra_config` occurs.
2752
+ :param pulumi.Input[str] firmware: The firmware interface to use on the virtual machine. Can be one of bios or efi.
2753
+ :param pulumi.Input[str] folder: The name of the folder to locate the virtual machine in.
2754
+ :param pulumi.Input[bool] force_power_off: Set to true to force power-off a virtual machine if a graceful guest shutdown failed for a necessary operation.
2755
+ :param pulumi.Input[str] guest_id: The guest ID for the operating system.
2756
+ :param pulumi.Input[int] hardware_version: The hardware version for the virtual machine.
2757
+ :param pulumi.Input[str] host_system_id: The ID of an optional host system to pin the virtual machine to.
2758
+ :param pulumi.Input[str] hv_mode: The (non-nested) hardware virtualization setting for this virtual machine. Can be one of hvAuto, hvOn, or hvOff.
2759
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] ignored_guest_ips: List of IP addresses and CIDR networks to ignore while waiting for an IP
2760
+ :param pulumi.Input[str] latency_sensitivity: Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower
2761
+ latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard
2762
+ devices. Can be one of low, normal, medium, or high.
2763
+ :param pulumi.Input[int] memory: The size of the virtual machine's memory, in MB.
2764
+ :param pulumi.Input[bool] memory_hot_add_enabled: Allow memory to be added to this virtual machine while it is running.
2765
+ :param pulumi.Input[int] memory_limit: The maximum amount of memory (in MB) or CPU (in MHz) that this virtual machine can consume, regardless of available
2766
+ resources.
2767
+ :param pulumi.Input[int] memory_reservation: The amount of memory (in MB) or CPU (in MHz) that this virtual machine is guaranteed.
2922
2768
  :param pulumi.Input[bool] memory_reservation_locked_to_max: If set true, memory resource reservation for this virtual machine will always be equal to the virtual machine's memory
2923
2769
  size;increases in memory size will be rejected when a corresponding reservation increase is not possible. This feature
2924
2770
  may only be enabled if it is currently possible to reserve all of the virtual machine's memory.
2925
- :param pulumi.Input[int] memory_share_count: The number of memory shares allocated to the virtual machine when the `memory_share_level` is `custom`.
2926
- :param pulumi.Input[str] memory_share_level: The allocation level for the virtual machine memory resources. One of `high`, `low`, `normal`, or `custom`. Default: `custom`.
2927
- :param pulumi.Input[int] migrate_wait_timeout: The amount of time, in minutes, to wait for a virtual machine migration to complete before failing. Default: `10` minutes. See the section on virtual machine migration for more information.
2928
- :param pulumi.Input[str] name: The name of the virtual machine.
2929
- :param pulumi.Input[bool] nested_hv_enabled: Enable nested hardware virtualization on the virtual machine, facilitating nested virtualization in the guest operating system. Default: `false`.
2930
- :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['VirtualMachineNetworkInterfaceArgs']]]] network_interfaces: A specification for a virtual NIC on the virtual machine. See network interface options for more information.
2931
- :param pulumi.Input[int] num_cores_per_socket: The number of cores per socket in the virtual machine. The number of vCPUs on the virtual machine will be `num_cpus` divided by `num_cores_per_socket`. If specified, the value supplied to `num_cpus` must be evenly divisible by this value. Default: `1`.
2932
- :param pulumi.Input[int] num_cpus: The total number of virtual processor cores to assign to the virtual machine. Default: `1`.
2933
- :param pulumi.Input[pulumi.InputType['VirtualMachineOvfDeployArgs']] ovf_deploy: When specified, the virtual machine will be deployed from the provided OVF/OVA template. See creating a virtual machine from an OVF/OVA template for more information.
2934
- :param pulumi.Input[Sequence[pulumi.Input[str]]] pci_device_ids: List of host PCI device IDs in which to create PCI passthroughs.
2935
-
2936
- > **NOTE:** Cloning requires vCenter Server and is not supported on direct ESXi host connections.
2771
+ :param pulumi.Input[int] memory_share_count: The amount of shares to allocate to memory for a custom share level.
2772
+ :param pulumi.Input[str] memory_share_level: The allocation level for memory resources. Can be one of high, low, normal, or custom.
2773
+ :param pulumi.Input[int] migrate_wait_timeout: The amount of time, in minutes, to wait for a vMotion operation to complete before failing.
2774
+ :param pulumi.Input[str] name: The name of this virtual machine.
2775
+ :param pulumi.Input[bool] nested_hv_enabled: Enable nested hardware virtualization on this virtual machine, facilitating nested virtualization in the guest.
2776
+ :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['VirtualMachineNetworkInterfaceArgs']]]] network_interfaces: A specification for a virtual NIC on this virtual machine.
2777
+ :param pulumi.Input[int] num_cores_per_socket: The number of cores to distribute amongst the CPUs in this virtual machine. If specified, the value supplied to num_cpus
2778
+ must be evenly divisible by this value.
2779
+ :param pulumi.Input[int] num_cpus: The number of virtual processors to assign to this virtual machine.
2780
+ :param pulumi.Input[pulumi.InputType['VirtualMachineOvfDeployArgs']] ovf_deploy: A specification for deploying a virtual machine from ovf/ova template.
2781
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] pci_device_ids: A list of PCI passthrough devices
2937
2782
  :param pulumi.Input[int] poweron_timeout: The amount of time, in seconds, that we will be trying to power on a VM
2938
2783
  :param pulumi.Input[str] replace_trigger: Triggers replacement of resource whenever it changes.
2939
-
2940
- For example, `replace_trigger = sha256(format("%!s(MISSING)-%!s(MISSING)",data.template_file.cloud_init_metadata.rendered,data.template_file.cloud_init_userdata.rendered))` will fingerprint the changes in cloud-init metadata and userdata templates. This will enable a replacement of the resource whenever the dependant template renders a new configuration. (Forces a replacement.)
2941
- :param pulumi.Input[str] resource_pool_id: The managed object reference ID of the resource pool in which to place the virtual machine. See the Virtual Machine Migration section for more information on modifying this value.
2942
-
2943
- > **NOTE:** All clusters and standalone hosts have a default root resource pool. This resource argument does not directly accept the cluster or standalone host resource. For more information, see the section on specifying the Root Resource Pool in the `ResourcePool` data source documentation on using the root resource pool.
2944
- :param pulumi.Input[bool] run_tools_scripts_after_power_on: Enable post-power-on scripts to run when VMware Tools is installed. Default: `true`.
2945
- :param pulumi.Input[bool] run_tools_scripts_after_resume: Enable ost-resume scripts to run when VMware Tools is installed. Default: `true`.
2946
- :param pulumi.Input[bool] run_tools_scripts_before_guest_reboot: Enable pre-reboot scripts to run when VMware Tools is installed. Default: `false`.
2947
- :param pulumi.Input[bool] run_tools_scripts_before_guest_shutdown: Enable pre-shutdown scripts to run when VMware Tools is installed. Default: `true`.
2948
- :param pulumi.Input[bool] run_tools_scripts_before_guest_standby: Enable pre-standby scripts to run when VMware Tools is installed. Default: `true`.
2949
- :param pulumi.Input[int] sata_controller_count: The number of SATA controllers that Terraform manages on this virtual machine. This directly affects the amount of disks
2950
- you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove
2951
- controllers.
2952
- :param pulumi.Input[str] scsi_bus_sharing: The type of SCSI bus sharing for the virtual machine SCSI controller. One of `physicalSharing`, `virtualSharing`, and `noSharing`. Default: `noSharing`.
2953
- :param pulumi.Input[int] scsi_controller_count: The number of SCSI controllers that Terraform manages on this virtual machine. This directly affects the amount of disks
2954
- you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove
2955
- controllers.
2956
- :param pulumi.Input[str] scsi_type: The SCSI controller type for the virtual machine. One of `lsilogic` (LSI Logic Parallel), `lsilogic-sas` (LSI Logic SAS) or `pvscsi` (VMware Paravirtual). Default: `pvscsi`.
2957
- :param pulumi.Input[int] shutdown_wait_timeout: The amount of time, in minutes, to wait for a graceful guest shutdown when making necessary updates to the virtual machine. If `force_power_off` is set to `true`, the virtual machine will be forced to power-off after the timeout, otherwise an error is returned. Default: `3` minutes.
2958
- :param pulumi.Input[str] storage_policy_id: The UUID of the storage policy to assign to the virtual disk.
2959
- :param pulumi.Input[str] swap_placement_policy: The swap file placement policy for the virtual machine. One of `inherit`, `hostLocal`, or `vmDirectory`. Default: `inherit`.
2960
- :param pulumi.Input[bool] sync_time_with_host: Enable the guest operating system to synchronization its clock with the host when the virtual machine is powered on or resumed. Requires vSphere 7.0 Update 1 and later. Requires VMware Tools to be installed. Default: `true`.
2961
- :param pulumi.Input[bool] sync_time_with_host_periodically: Enable the guest operating system to periodically synchronize its clock with the host. Requires vSphere 7.0 Update 1 and later. On previous versions, setting `sync_time_with_host` is will enable periodic synchronization. Requires VMware Tools to be installed. Default: `false`.
2962
- :param pulumi.Input[Sequence[pulumi.Input[str]]] tags: The IDs of any tags to attach to this resource. Please refer to the `Tag` resource for more information on applying tags to virtual machine resources.
2963
-
2964
- > **NOTE:** Tagging support is unsupported on direct ESXi host connections and requires vCenter Server instance.
2965
- :param pulumi.Input[str] tools_upgrade_policy: Enable automatic upgrade of the VMware Tools version when the virtual machine is rebooted. If necessary, VMware Tools is upgraded to the latest version supported by the host on which the virtual machine is running. Requires VMware Tools to be installed. One of `manual` or `upgradeAtPowerCycle`. Default: `manual`.
2966
- :param pulumi.Input[pulumi.InputType['VirtualMachineVappArgs']] vapp: Used for vApp configurations. The only sub-key available is `properties`, which is a key/value map of properties for virtual machines imported from and OVF/OVA. See Using vApp Properties for OVF/OVA Configuration for more information.
2967
- :param pulumi.Input[bool] vbs_enabled: Enable Virtualization Based Security. Requires `firmware` to be `efi`. In addition, `vvtd_enabled`, `nested_hv_enabled`, and `efi_secure_boot_enabled` must all have a value of `true`. Supported on vSphere 6.7 and later. Default: `false`.
2968
- :param pulumi.Input[bool] vvtd_enabled: Enable Intel Virtualization Technology for Directed I/O for the virtual machine (_I/O MMU_ in the vSphere Client). Supported on vSphere 6.7 and later. Default: `false`.
2969
- :param pulumi.Input[int] wait_for_guest_ip_timeout: The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. This should only be used if the version VMware Tools does not allow the `wait_for_guest_net_timeout` waiter to be used. A value less than `1` disables the waiter. Default: `0`.
2970
- :param pulumi.Input[bool] wait_for_guest_net_routable: Controls whether or not the guest network waiter waits for a routable address. When `false`, the waiter does not wait for a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria. This property is ignored if the `wait_for_guest_ip_timeout` waiter is used. Default: `true`.
2971
- :param pulumi.Input[int] wait_for_guest_net_timeout: The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. Older versions of VMware Tools do not populate this property. In those cases, this waiter can be disabled and the `wait_for_guest_ip_timeout` waiter can be used instead. A value less than `1` disables the waiter. Default: `5` minutes.
2784
+ :param pulumi.Input[str] resource_pool_id: The ID of a resource pool to put the virtual machine in.
2785
+ :param pulumi.Input[bool] run_tools_scripts_after_power_on: Enable the run of scripts after virtual machine power-on when VMware Tools is installed.
2786
+ :param pulumi.Input[bool] run_tools_scripts_after_resume: Enable the run of scripts after virtual machine resume when when VMware Tools is installed.
2787
+ :param pulumi.Input[bool] run_tools_scripts_before_guest_reboot: Enable the run of scripts before guest operating system reboot when VMware Tools is installed.
2788
+ :param pulumi.Input[bool] run_tools_scripts_before_guest_shutdown: Enable the run of scripts before guest operating system shutdown when VMware Tools is installed.
2789
+ :param pulumi.Input[bool] run_tools_scripts_before_guest_standby: Enable the run of scripts before guest operating system standby when VMware Tools is installed.
2790
+ :param pulumi.Input[str] scsi_bus_sharing: Mode for sharing the SCSI bus. The modes are physicalSharing, virtualSharing, and noSharing.
2791
+ :param pulumi.Input[str] scsi_type: The type of SCSI bus this virtual machine will have. Can be one of lsilogic, lsilogic-sas or pvscsi.
2792
+ :param pulumi.Input[int] shutdown_wait_timeout: The amount of time, in minutes, to wait for shutdown when making necessary updates to the virtual machine.
2793
+ :param pulumi.Input[str] storage_policy_id: The ID of the storage policy to assign to the virtual machine home directory.
2794
+ :param pulumi.Input[str] swap_placement_policy: The swap file placement policy for this virtual machine. Can be one of inherit, hostLocal, or vmDirectory.
2795
+ :param pulumi.Input[bool] sync_time_with_host: Enable guest clock synchronization with the host. On vSphere 7.0 U1 and above, with only this setting the clock is
2796
+ synchronized on startup and resume. Requires VMware Tools to be installed.
2797
+ :param pulumi.Input[bool] sync_time_with_host_periodically: Enable periodic clock synchronization with the host. Supported only on vSphere 7.0 U1 and above. On prior versions
2798
+ setting `sync_time_with_host` is enough for periodic synchronization. Requires VMware Tools to be installed.
2799
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] tags: A list of tag IDs to apply to this object.
2800
+ :param pulumi.Input[str] tools_upgrade_policy: Set the upgrade policy for VMware Tools. Can be one of `manual` or `upgradeAtPowerCycle`.
2801
+ :param pulumi.Input[pulumi.InputType['VirtualMachineVappArgs']] vapp: vApp configuration data for this virtual machine. Can be used to provide configuration data for OVF images.
2802
+ :param pulumi.Input[bool] vbs_enabled: Flag to specify if Virtualization-based security is enabled for this virtual machine.
2803
+ :param pulumi.Input[bool] vvtd_enabled: Flag to specify if I/O MMU virtualization, also called Intel Virtualization Technology for Directed I/O (VT-d) and AMD
2804
+ I/O Virtualization (AMD-Vi or IOMMU), is enabled.
2805
+ :param pulumi.Input[int] wait_for_guest_ip_timeout: The amount of time, in minutes, to wait for an available IP address on this virtual machine. A value less than 1
2806
+ disables the waiter.
2807
+ :param pulumi.Input[bool] wait_for_guest_net_routable: Controls whether or not the guest network waiter waits for a routable address. When false, the waiter does not wait for
2808
+ a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria.
2809
+ :param pulumi.Input[int] wait_for_guest_net_timeout: The amount of time, in minutes, to wait for an available IP address on this virtual machine. A value less than 1
2810
+ disables the waiter.
2972
2811
  """
2973
2812
  ...
2974
2813
  @overload
@@ -3268,133 +3107,103 @@ class VirtualMachine(pulumi.CustomResource):
3268
3107
  :param str resource_name: The unique name of the resulting resource.
3269
3108
  :param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
3270
3109
  :param pulumi.ResourceOptions opts: Options for the resource.
3271
- :param pulumi.Input[str] alternate_guest_name: The guest name for the operating system when `guest_id` is `otherGuest` or `otherGuest64`.
3272
- :param pulumi.Input[str] annotation: A user-provided description of the virtual machine.
3273
- :param pulumi.Input[int] boot_delay: The number of milliseconds to wait before starting the boot sequence. The default is no delay.
3274
- :param pulumi.Input[int] boot_retry_delay: The number of milliseconds to wait before retrying the boot sequence. This option is only valid if `boot_retry_enabled` is `true`. Default: `10000` (10 seconds).
3275
- :param pulumi.Input[bool] boot_retry_enabled: If set to `true`, a virtual machine that fails to boot will try again after the delay defined in `boot_retry_delay`. Default: `false`.
3276
- :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['VirtualMachineCdromArgs']]]] cdroms: A specification for a CD-ROM device on the virtual machine. See CD-ROM options for more information.
3110
+ :param pulumi.Input[str] alternate_guest_name: The guest name for the operating system when guest_id is otherGuest or otherGuest64.
3111
+ :param pulumi.Input[str] annotation: User-provided description of the virtual machine.
3112
+ :param pulumi.Input[int] boot_delay: The number of milliseconds to wait before starting the boot sequence.
3113
+ :param pulumi.Input[int] boot_retry_delay: The number of milliseconds to wait before retrying the boot sequence. This only valid if boot_retry_enabled is true.
3114
+ :param pulumi.Input[bool] boot_retry_enabled: If set to true, a virtual machine that fails to boot will try again after the delay defined in boot_retry_delay.
3115
+ :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['VirtualMachineCdromArgs']]]] cdroms: A specification for a CDROM device on this virtual machine.
3277
3116
  :param pulumi.Input[str] change_version: A unique identifier for a given version of the last configuration was applied.
3278
- :param pulumi.Input[pulumi.InputType['VirtualMachineCloneArgs']] clone: When specified, the virtual machine will be created as a clone of a specified template. Optional customization options can be submitted for the resource. See creating a virtual machine from a template for more information.
3279
- :param pulumi.Input[bool] cpu_hot_add_enabled: Allow CPUs to be added to the virtual machine while it is powered on.
3280
- :param pulumi.Input[bool] cpu_hot_remove_enabled: Allow CPUs to be removed to the virtual machine while it is powered on.
3281
- :param pulumi.Input[int] cpu_limit: The maximum amount of CPU (in MHz) that the virtual machine can consume, regardless of available resources. The default is no limit.
3282
- :param pulumi.Input[bool] cpu_performance_counters_enabled: Enable CPU performance counters on the virtual machine. Default: `false`.
3283
- :param pulumi.Input[int] cpu_reservation: The amount of CPU (in MHz) that the virtual machine is guaranteed. The default is no reservation.
3284
- :param pulumi.Input[int] cpu_share_count: The number of CPU shares allocated to the virtual machine when the `cpu_share_level` is `custom`.
3285
- :param pulumi.Input[str] cpu_share_level: The allocation level for the virtual machine CPU resources. One of `high`, `low`, `normal`, or `custom`. Default: `custom`.
3286
- :param pulumi.Input[Mapping[str, pulumi.Input[str]]] custom_attributes: Map of custom attribute ids to attribute value strings to set for virtual machine. Please refer to the `vsphere_custom_attributes` resource for more information on setting custom attributes.
3287
-
3288
- > **NOTE:** Custom attributes requires vCenter Server and is not supported on direct ESXi host connections.
3289
- :param pulumi.Input[str] datacenter_id: The datacenter ID. Required only when deploying an OVF/OVA template.
3290
- :param pulumi.Input[str] datastore_cluster_id: The managed object reference ID of the datastore cluster in which to place the virtual machine. This setting applies to entire virtual machine and implies that you wish to use vSphere Storage DRS with the virtual machine. See the section on virtual machine migration for more information on modifying this value.
3291
-
3292
- > **NOTE:** One of `datastore_id` or `datastore_cluster_id` must be specified.
3293
-
3294
- > **NOTE:** Use of `datastore_cluster_id` requires vSphere Storage DRS to be enabled on the specified datastore cluster.
3295
-
3296
- > **NOTE:** The `datastore_cluster_id` setting applies to the entire virtual machine resource. You cannot assign individual individual disks to datastore clusters. In addition, you cannot use the `attach` setting to attach external disks on virtual machines that are assigned to datastore clusters.
3297
- :param pulumi.Input[str] datastore_id: The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with `client_device`.
3117
+ :param pulumi.Input[pulumi.InputType['VirtualMachineCloneArgs']] clone: A specification for cloning a virtual machine from template.
3118
+ :param pulumi.Input[bool] cpu_hot_add_enabled: Allow CPUs to be added to this virtual machine while it is running.
3119
+ :param pulumi.Input[bool] cpu_hot_remove_enabled: Allow CPUs to be added to this virtual machine while it is running.
3120
+ :param pulumi.Input[int] cpu_limit: The maximum amount of memory (in MB) or CPU (in MHz) that this virtual machine can consume, regardless of available
3121
+ resources.
3122
+ :param pulumi.Input[bool] cpu_performance_counters_enabled: Enable CPU performance counters on this virtual machine.
3123
+ :param pulumi.Input[int] cpu_reservation: The amount of memory (in MB) or CPU (in MHz) that this virtual machine is guaranteed.
3124
+ :param pulumi.Input[int] cpu_share_count: The amount of shares to allocate to cpu for a custom share level.
3125
+ :param pulumi.Input[str] cpu_share_level: The allocation level for cpu resources. Can be one of high, low, normal, or custom.
3126
+ :param pulumi.Input[Mapping[str, pulumi.Input[str]]] custom_attributes: A list of custom attributes to set on this resource.
3127
+ :param pulumi.Input[str] datacenter_id: The ID of the datacenter where the VM is to be created.
3128
+ :param pulumi.Input[str] datastore_cluster_id: The ID of a datastore cluster to put the virtual machine in.
3129
+ :param pulumi.Input[str] datastore_id: The ID of the virtual machine's datastore. The virtual machine configuration is placed here, along with any virtual
3130
+ disks that are created without datastores.
3298
3131
  :param pulumi.Input[str] default_ip_address: The IP address selected by the provider to be used with any provisioners configured on this resource. When possible, this is the first IPv4 address that is reachable through the default gateway configured on the machine, then the first reachable IPv6 address, and then the first general discovered address if neither exists. If VMware Tools is not running on the virtual machine, or if the virtual machine is powered off, this value will be blank.
3299
- :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['VirtualMachineDiskArgs']]]] disks: A specification for a virtual disk device on the virtual machine. See disk options for more information.
3300
- :param pulumi.Input[bool] efi_secure_boot_enabled: Use this option to enable EFI secure boot when the `firmware` type is set to is `efi`. Default: `false`.
3301
-
3302
- > **NOTE:** EFI secure boot is only available on vSphere 6.5 and later.
3303
- :param pulumi.Input[bool] enable_disk_uuid: Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest. Default: `false`.
3304
- :param pulumi.Input[bool] enable_logging: Enable logging of virtual machine events to a log file stored in the virtual machine directory. Default: `false`.
3305
- :param pulumi.Input[str] ept_rvi_mode: The EPT/RVI (hardware memory virtualization) setting for the virtual machine. One of `automatic`, `on`, or `off`. Default: `automatic`.
3306
- :param pulumi.Input[Mapping[str, pulumi.Input[str]]] extra_config: Extra configuration data for the virtual machine. Can be used to supply advanced parameters not normally in configuration, such as instance metadata and userdata.
3307
-
3308
- > **NOTE:** Do not use `extra_config` when working with a template imported from OVF/OVA as your settings may be ignored. Use the `vapp` block `properties` section as described in Using vApp Properties for OVF/OVA Configuration.
3309
- :param pulumi.Input[bool] extra_config_reboot_required: Allow the virtual machine to be rebooted when a change to `extra_config` occurs. Default: `true`.
3310
- :param pulumi.Input[str] firmware: The firmware for the virtual machine. One of `bios` or `efi`.
3311
- :param pulumi.Input[str] folder: The path to the virtual machine folder in which to place the virtual machine, relative to the datacenter path (`/<datacenter-name>/vm`). For example, `/dc-01/vm/foo`
3312
- :param pulumi.Input[bool] force_power_off: If a guest shutdown failed or times out while updating or destroying (see `shutdown_wait_timeout`), force the power-off of the virtual machine. Default: `true`.
3313
- :param pulumi.Input[str] guest_id: The guest ID for the operating system type. For a full list of possible values, see [here][vmware-docs-guest-ids]. Default: `otherGuest64`.
3314
-
3315
- [vmware-docs-guest-ids]: https://vdc-repo.vmware.com/vmwb-repository/dcr-public/184bb3ba-6fa8-4574-a767-d0c96e2a38f4/ba9422ef-405c-47dd-8553-e11b619185b2/SDK/vsphere-ws/docs/ReferenceGuide/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html
3132
+ :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['VirtualMachineDiskArgs']]]] disks: A specification for a virtual disk device on this virtual machine.
3133
+ :param pulumi.Input[bool] efi_secure_boot_enabled: When the boot type set in firmware is efi, this enables EFI secure boot.
3134
+ :param pulumi.Input[bool] enable_disk_uuid: Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest.
3135
+ :param pulumi.Input[bool] enable_logging: Enable logging on this virtual machine.
3136
+ :param pulumi.Input[str] ept_rvi_mode: The EPT/RVI (hardware memory virtualization) setting for this virtual machine. Can be one of automatic, on, or off.
3137
+ :param pulumi.Input[Mapping[str, pulumi.Input[str]]] extra_config: Extra configuration data for this virtual machine. Can be used to supply advanced parameters not normally in
3138
+ configuration, such as instance metadata, or configuration data for OVF images.
3139
+ :param pulumi.Input[bool] extra_config_reboot_required: Allow the virtual machine to be rebooted when a change to `extra_config` occurs.
3140
+ :param pulumi.Input[str] firmware: The firmware interface to use on the virtual machine. Can be one of bios or efi.
3141
+ :param pulumi.Input[str] folder: The name of the folder to locate the virtual machine in.
3142
+ :param pulumi.Input[bool] force_power_off: Set to true to force power-off a virtual machine if a graceful guest shutdown failed for a necessary operation.
3143
+ :param pulumi.Input[str] guest_id: The guest ID for the operating system.
3316
3144
  :param pulumi.Input[Sequence[pulumi.Input[str]]] guest_ip_addresses: The current list of IP addresses on this machine, including the value of `default_ip_address`. If VMware Tools is not running on the virtual machine, or if the virtul machine is powered off, this list will be empty.
3317
- :param pulumi.Input[int] hardware_version: The hardware version number. Valid range is from 4 to 21. The hardware version cannot be downgraded. See virtual machine hardware [versions][virtual-machine-hardware-versions] and [compatibility][virtual-machine-hardware-compatibility] for more information on supported settings.
3318
-
3319
- [virtual-machine-hardware-versions]: https://kb.vmware.com/s/article/1003746
3320
- [virtual-machine-hardware-compatibility]: https://kb.vmware.com/s/article/2007240
3321
- :param pulumi.Input[str] host_system_id: The managed object reference ID of a host on which to place the virtual machine. See the section on virtual machine migration for more information on modifying this value. When using a vSphere cluster, if a `host_system_id` is not supplied, vSphere will select a host in the cluster to place the virtual machine, according to any defaults or vSphere DRS placement policies.
3322
- :param pulumi.Input[str] hv_mode: The hardware virtualization (non-nested) setting for the virtual machine. One of `hvAuto`, `hvOn`, or `hvOff`. Default: `hvAuto`.
3323
- :param pulumi.Input[int] ide_controller_count: The number of IDE controllers that the virtual machine. This directly affects the number of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers. Default: `2`.
3324
- :param pulumi.Input[Sequence[pulumi.Input[str]]] ignored_guest_ips: List of IP addresses and CIDR networks to ignore while waiting for an available IP address using either of the waiters. Any IP addresses in this list will be ignored so that the waiter will continue to wait for a valid IP address. Default: `[]`.
3145
+ :param pulumi.Input[int] hardware_version: The hardware version for the virtual machine.
3146
+ :param pulumi.Input[str] host_system_id: The ID of an optional host system to pin the virtual machine to.
3147
+ :param pulumi.Input[str] hv_mode: The (non-nested) hardware virtualization setting for this virtual machine. Can be one of hvAuto, hvOn, or hvOff.
3148
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] ignored_guest_ips: List of IP addresses and CIDR networks to ignore while waiting for an IP
3325
3149
  :param pulumi.Input[bool] imported: Indicates if the virtual machine resource has been imported, or if the state has been migrated from a previous version of the resource. It influences the behavior of the first post-import apply operation. See the section on importing below.
3326
- :param pulumi.Input[str] latency_sensitivity: Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard devices. One of `low`, `normal`, `medium`, or `high`.
3327
-
3328
- > **NOTE:** On higher sensitivities, you may need to adjust the `memory_reservation` to the full amount of memory provisioned for the virtual machine.
3329
- :param pulumi.Input[int] memory: The memory size to assign to the virtual machine, in MB. Default: `1024` (1 GB).
3330
- :param pulumi.Input[bool] memory_hot_add_enabled: Allow memory to be added to the virtual machine while it is powered on.
3331
-
3332
- > **NOTE:** CPU and memory hot add options are not available on all guest operating systems. Please refer to the [VMware Guest OS Compatibility Guide][vmware-docs-compat-guide] to which settings are allow for your guest operating system. In addition, at least one `pulumi up` must be run before you are able to use CPU and memory hot add.
3333
-
3334
- [vmware-docs-compat-guide]: http://partnerweb.vmware.com/comp_guide2/pdf/VMware_GOS_Compatibility_Guide.pdf
3335
-
3336
- > **NOTE:** For Linux 64-bit guest operating systems with less than or equal to 3GB, the virtual machine must powered off to add memory beyond 3GB. Subsequent hot add of memory does not require the virtual machine to be powered-off to apply the plan. Please refer to [VMware KB 2008405][vmware-kb-2008405].
3337
-
3338
- [vmware-kb-2008405]: https://kb.vmware.com/s/article/2008405
3339
- :param pulumi.Input[int] memory_limit: The maximum amount of memory (in MB) that th virtual machine can consume, regardless of available resources. The default is no limit.
3340
- :param pulumi.Input[int] memory_reservation: The amount of memory (in MB) that the virtual machine is guaranteed. The default is no reservation.
3150
+ :param pulumi.Input[str] latency_sensitivity: Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower
3151
+ latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard
3152
+ devices. Can be one of low, normal, medium, or high.
3153
+ :param pulumi.Input[int] memory: The size of the virtual machine's memory, in MB.
3154
+ :param pulumi.Input[bool] memory_hot_add_enabled: Allow memory to be added to this virtual machine while it is running.
3155
+ :param pulumi.Input[int] memory_limit: The maximum amount of memory (in MB) or CPU (in MHz) that this virtual machine can consume, regardless of available
3156
+ resources.
3157
+ :param pulumi.Input[int] memory_reservation: The amount of memory (in MB) or CPU (in MHz) that this virtual machine is guaranteed.
3341
3158
  :param pulumi.Input[bool] memory_reservation_locked_to_max: If set true, memory resource reservation for this virtual machine will always be equal to the virtual machine's memory
3342
3159
  size;increases in memory size will be rejected when a corresponding reservation increase is not possible. This feature
3343
3160
  may only be enabled if it is currently possible to reserve all of the virtual machine's memory.
3344
- :param pulumi.Input[int] memory_share_count: The number of memory shares allocated to the virtual machine when the `memory_share_level` is `custom`.
3345
- :param pulumi.Input[str] memory_share_level: The allocation level for the virtual machine memory resources. One of `high`, `low`, `normal`, or `custom`. Default: `custom`.
3346
- :param pulumi.Input[int] migrate_wait_timeout: The amount of time, in minutes, to wait for a virtual machine migration to complete before failing. Default: `10` minutes. See the section on virtual machine migration for more information.
3161
+ :param pulumi.Input[int] memory_share_count: The amount of shares to allocate to memory for a custom share level.
3162
+ :param pulumi.Input[str] memory_share_level: The allocation level for memory resources. Can be one of high, low, normal, or custom.
3163
+ :param pulumi.Input[int] migrate_wait_timeout: The amount of time, in minutes, to wait for a vMotion operation to complete before failing.
3347
3164
  :param pulumi.Input[str] moid: The managed object reference ID of the created virtual machine.
3348
- :param pulumi.Input[str] name: The name of the virtual machine.
3349
- :param pulumi.Input[bool] nested_hv_enabled: Enable nested hardware virtualization on the virtual machine, facilitating nested virtualization in the guest operating system. Default: `false`.
3350
- :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['VirtualMachineNetworkInterfaceArgs']]]] network_interfaces: A specification for a virtual NIC on the virtual machine. See network interface options for more information.
3351
- :param pulumi.Input[int] num_cores_per_socket: The number of cores per socket in the virtual machine. The number of vCPUs on the virtual machine will be `num_cpus` divided by `num_cores_per_socket`. If specified, the value supplied to `num_cpus` must be evenly divisible by this value. Default: `1`.
3352
- :param pulumi.Input[int] num_cpus: The total number of virtual processor cores to assign to the virtual machine. Default: `1`.
3353
- :param pulumi.Input[pulumi.InputType['VirtualMachineOvfDeployArgs']] ovf_deploy: When specified, the virtual machine will be deployed from the provided OVF/OVA template. See creating a virtual machine from an OVF/OVA template for more information.
3354
- :param pulumi.Input[Sequence[pulumi.Input[str]]] pci_device_ids: List of host PCI device IDs in which to create PCI passthroughs.
3355
-
3356
- > **NOTE:** Cloning requires vCenter Server and is not supported on direct ESXi host connections.
3165
+ :param pulumi.Input[str] name: The name of this virtual machine.
3166
+ :param pulumi.Input[bool] nested_hv_enabled: Enable nested hardware virtualization on this virtual machine, facilitating nested virtualization in the guest.
3167
+ :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['VirtualMachineNetworkInterfaceArgs']]]] network_interfaces: A specification for a virtual NIC on this virtual machine.
3168
+ :param pulumi.Input[int] num_cores_per_socket: The number of cores to distribute amongst the CPUs in this virtual machine. If specified, the value supplied to num_cpus
3169
+ must be evenly divisible by this value.
3170
+ :param pulumi.Input[int] num_cpus: The number of virtual processors to assign to this virtual machine.
3171
+ :param pulumi.Input[pulumi.InputType['VirtualMachineOvfDeployArgs']] ovf_deploy: A specification for deploying a virtual machine from ovf/ova template.
3172
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] pci_device_ids: A list of PCI passthrough devices
3357
3173
  :param pulumi.Input[str] power_state: A computed value for the current power state of the virtual machine. One of `on`, `off`, or `suspended`.
3358
3174
  :param pulumi.Input[int] poweron_timeout: The amount of time, in seconds, that we will be trying to power on a VM
3359
- :param pulumi.Input[bool] reboot_required: Value internal to Terraform used to determine if a configuration set change requires a reboot.
3360
3175
  :param pulumi.Input[str] replace_trigger: Triggers replacement of resource whenever it changes.
3361
-
3362
- For example, `replace_trigger = sha256(format("%!s(MISSING)-%!s(MISSING)",data.template_file.cloud_init_metadata.rendered,data.template_file.cloud_init_userdata.rendered))` will fingerprint the changes in cloud-init metadata and userdata templates. This will enable a replacement of the resource whenever the dependant template renders a new configuration. (Forces a replacement.)
3363
- :param pulumi.Input[str] resource_pool_id: The managed object reference ID of the resource pool in which to place the virtual machine. See the Virtual Machine Migration section for more information on modifying this value.
3364
-
3365
- > **NOTE:** All clusters and standalone hosts have a default root resource pool. This resource argument does not directly accept the cluster or standalone host resource. For more information, see the section on specifying the Root Resource Pool in the `ResourcePool` data source documentation on using the root resource pool.
3366
- :param pulumi.Input[bool] run_tools_scripts_after_power_on: Enable post-power-on scripts to run when VMware Tools is installed. Default: `true`.
3367
- :param pulumi.Input[bool] run_tools_scripts_after_resume: Enable ost-resume scripts to run when VMware Tools is installed. Default: `true`.
3368
- :param pulumi.Input[bool] run_tools_scripts_before_guest_reboot: Enable pre-reboot scripts to run when VMware Tools is installed. Default: `false`.
3369
- :param pulumi.Input[bool] run_tools_scripts_before_guest_shutdown: Enable pre-shutdown scripts to run when VMware Tools is installed. Default: `true`.
3370
- :param pulumi.Input[bool] run_tools_scripts_before_guest_standby: Enable pre-standby scripts to run when VMware Tools is installed. Default: `true`.
3371
- :param pulumi.Input[int] sata_controller_count: The number of SATA controllers that Terraform manages on this virtual machine. This directly affects the amount of disks
3372
- you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove
3373
- controllers.
3374
- :param pulumi.Input[str] scsi_bus_sharing: The type of SCSI bus sharing for the virtual machine SCSI controller. One of `physicalSharing`, `virtualSharing`, and `noSharing`. Default: `noSharing`.
3375
- :param pulumi.Input[int] scsi_controller_count: The number of SCSI controllers that Terraform manages on this virtual machine. This directly affects the amount of disks
3376
- you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove
3377
- controllers.
3378
- :param pulumi.Input[str] scsi_type: The SCSI controller type for the virtual machine. One of `lsilogic` (LSI Logic Parallel), `lsilogic-sas` (LSI Logic SAS) or `pvscsi` (VMware Paravirtual). Default: `pvscsi`.
3379
- :param pulumi.Input[int] shutdown_wait_timeout: The amount of time, in minutes, to wait for a graceful guest shutdown when making necessary updates to the virtual machine. If `force_power_off` is set to `true`, the virtual machine will be forced to power-off after the timeout, otherwise an error is returned. Default: `3` minutes.
3380
- :param pulumi.Input[str] storage_policy_id: The UUID of the storage policy to assign to the virtual disk.
3381
- :param pulumi.Input[str] swap_placement_policy: The swap file placement policy for the virtual machine. One of `inherit`, `hostLocal`, or `vmDirectory`. Default: `inherit`.
3382
- :param pulumi.Input[bool] sync_time_with_host: Enable the guest operating system to synchronization its clock with the host when the virtual machine is powered on or resumed. Requires vSphere 7.0 Update 1 and later. Requires VMware Tools to be installed. Default: `true`.
3383
- :param pulumi.Input[bool] sync_time_with_host_periodically: Enable the guest operating system to periodically synchronize its clock with the host. Requires vSphere 7.0 Update 1 and later. On previous versions, setting `sync_time_with_host` is will enable periodic synchronization. Requires VMware Tools to be installed. Default: `false`.
3384
- :param pulumi.Input[Sequence[pulumi.Input[str]]] tags: The IDs of any tags to attach to this resource. Please refer to the `Tag` resource for more information on applying tags to virtual machine resources.
3385
-
3386
- > **NOTE:** Tagging support is unsupported on direct ESXi host connections and requires vCenter Server instance.
3387
- :param pulumi.Input[str] tools_upgrade_policy: Enable automatic upgrade of the VMware Tools version when the virtual machine is rebooted. If necessary, VMware Tools is upgraded to the latest version supported by the host on which the virtual machine is running. Requires VMware Tools to be installed. One of `manual` or `upgradeAtPowerCycle`. Default: `manual`.
3388
- :param pulumi.Input[str] uuid: The UUID of the virtual disk VMDK file. This is used to track the virtual disk on the virtual machine.
3389
- :param pulumi.Input[pulumi.InputType['VirtualMachineVappArgs']] vapp: Used for vApp configurations. The only sub-key available is `properties`, which is a key/value map of properties for virtual machines imported from and OVF/OVA. See Using vApp Properties for OVF/OVA Configuration for more information.
3176
+ :param pulumi.Input[str] resource_pool_id: The ID of a resource pool to put the virtual machine in.
3177
+ :param pulumi.Input[bool] run_tools_scripts_after_power_on: Enable the run of scripts after virtual machine power-on when VMware Tools is installed.
3178
+ :param pulumi.Input[bool] run_tools_scripts_after_resume: Enable the run of scripts after virtual machine resume when when VMware Tools is installed.
3179
+ :param pulumi.Input[bool] run_tools_scripts_before_guest_reboot: Enable the run of scripts before guest operating system reboot when VMware Tools is installed.
3180
+ :param pulumi.Input[bool] run_tools_scripts_before_guest_shutdown: Enable the run of scripts before guest operating system shutdown when VMware Tools is installed.
3181
+ :param pulumi.Input[bool] run_tools_scripts_before_guest_standby: Enable the run of scripts before guest operating system standby when VMware Tools is installed.
3182
+ :param pulumi.Input[str] scsi_bus_sharing: Mode for sharing the SCSI bus. The modes are physicalSharing, virtualSharing, and noSharing.
3183
+ :param pulumi.Input[str] scsi_type: The type of SCSI bus this virtual machine will have. Can be one of lsilogic, lsilogic-sas or pvscsi.
3184
+ :param pulumi.Input[int] shutdown_wait_timeout: The amount of time, in minutes, to wait for shutdown when making necessary updates to the virtual machine.
3185
+ :param pulumi.Input[str] storage_policy_id: The ID of the storage policy to assign to the virtual machine home directory.
3186
+ :param pulumi.Input[str] swap_placement_policy: The swap file placement policy for this virtual machine. Can be one of inherit, hostLocal, or vmDirectory.
3187
+ :param pulumi.Input[bool] sync_time_with_host: Enable guest clock synchronization with the host. On vSphere 7.0 U1 and above, with only this setting the clock is
3188
+ synchronized on startup and resume. Requires VMware Tools to be installed.
3189
+ :param pulumi.Input[bool] sync_time_with_host_periodically: Enable periodic clock synchronization with the host. Supported only on vSphere 7.0 U1 and above. On prior versions
3190
+ setting `sync_time_with_host` is enough for periodic synchronization. Requires VMware Tools to be installed.
3191
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] tags: A list of tag IDs to apply to this object.
3192
+ :param pulumi.Input[str] tools_upgrade_policy: Set the upgrade policy for VMware Tools. Can be one of `manual` or `upgradeAtPowerCycle`.
3193
+ :param pulumi.Input[str] uuid: The UUID of the virtual machine. Also exposed as the `id` of the resource.
3194
+ :param pulumi.Input[pulumi.InputType['VirtualMachineVappArgs']] vapp: vApp configuration data for this virtual machine. Can be used to provide configuration data for OVF images.
3390
3195
  :param pulumi.Input[Sequence[pulumi.Input[str]]] vapp_transports: Computed value which is only valid for cloned virtual machines. A list of vApp transport methods supported by the source virtual machine or template.
3391
- :param pulumi.Input[bool] vbs_enabled: Enable Virtualization Based Security. Requires `firmware` to be `efi`. In addition, `vvtd_enabled`, `nested_hv_enabled`, and `efi_secure_boot_enabled` must all have a value of `true`. Supported on vSphere 6.7 and later. Default: `false`.
3196
+ :param pulumi.Input[bool] vbs_enabled: Flag to specify if Virtualization-based security is enabled for this virtual machine.
3392
3197
  :param pulumi.Input[str] vmware_tools_status: The state of VMware Tools in the guest. This will determine the proper course of action for some device operations.
3393
3198
  :param pulumi.Input[str] vmx_path: The path of the virtual machine configuration file on the datastore in which the virtual machine is placed.
3394
- :param pulumi.Input[bool] vvtd_enabled: Enable Intel Virtualization Technology for Directed I/O for the virtual machine (_I/O MMU_ in the vSphere Client). Supported on vSphere 6.7 and later. Default: `false`.
3395
- :param pulumi.Input[int] wait_for_guest_ip_timeout: The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. This should only be used if the version VMware Tools does not allow the `wait_for_guest_net_timeout` waiter to be used. A value less than `1` disables the waiter. Default: `0`.
3396
- :param pulumi.Input[bool] wait_for_guest_net_routable: Controls whether or not the guest network waiter waits for a routable address. When `false`, the waiter does not wait for a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria. This property is ignored if the `wait_for_guest_ip_timeout` waiter is used. Default: `true`.
3397
- :param pulumi.Input[int] wait_for_guest_net_timeout: The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. Older versions of VMware Tools do not populate this property. In those cases, this waiter can be disabled and the `wait_for_guest_ip_timeout` waiter can be used instead. A value less than `1` disables the waiter. Default: `5` minutes.
3199
+ :param pulumi.Input[bool] vvtd_enabled: Flag to specify if I/O MMU virtualization, also called Intel Virtualization Technology for Directed I/O (VT-d) and AMD
3200
+ I/O Virtualization (AMD-Vi or IOMMU), is enabled.
3201
+ :param pulumi.Input[int] wait_for_guest_ip_timeout: The amount of time, in minutes, to wait for an available IP address on this virtual machine. A value less than 1
3202
+ disables the waiter.
3203
+ :param pulumi.Input[bool] wait_for_guest_net_routable: Controls whether or not the guest network waiter waits for a routable address. When false, the waiter does not wait for
3204
+ a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria.
3205
+ :param pulumi.Input[int] wait_for_guest_net_timeout: The amount of time, in minutes, to wait for an available IP address on this virtual machine. A value less than 1
3206
+ disables the waiter.
3398
3207
  """
3399
3208
  opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
3400
3209
 
@@ -3492,7 +3301,7 @@ class VirtualMachine(pulumi.CustomResource):
3492
3301
  @pulumi.getter(name="alternateGuestName")
3493
3302
  def alternate_guest_name(self) -> pulumi.Output[Optional[str]]:
3494
3303
  """
3495
- The guest name for the operating system when `guest_id` is `otherGuest` or `otherGuest64`.
3304
+ The guest name for the operating system when guest_id is otherGuest or otherGuest64.
3496
3305
  """
3497
3306
  return pulumi.get(self, "alternate_guest_name")
3498
3307
 
@@ -3500,7 +3309,7 @@ class VirtualMachine(pulumi.CustomResource):
3500
3309
  @pulumi.getter
3501
3310
  def annotation(self) -> pulumi.Output[str]:
3502
3311
  """
3503
- A user-provided description of the virtual machine.
3312
+ User-provided description of the virtual machine.
3504
3313
  """
3505
3314
  return pulumi.get(self, "annotation")
3506
3315
 
@@ -3508,7 +3317,7 @@ class VirtualMachine(pulumi.CustomResource):
3508
3317
  @pulumi.getter(name="bootDelay")
3509
3318
  def boot_delay(self) -> pulumi.Output[Optional[int]]:
3510
3319
  """
3511
- The number of milliseconds to wait before starting the boot sequence. The default is no delay.
3320
+ The number of milliseconds to wait before starting the boot sequence.
3512
3321
  """
3513
3322
  return pulumi.get(self, "boot_delay")
3514
3323
 
@@ -3516,7 +3325,7 @@ class VirtualMachine(pulumi.CustomResource):
3516
3325
  @pulumi.getter(name="bootRetryDelay")
3517
3326
  def boot_retry_delay(self) -> pulumi.Output[Optional[int]]:
3518
3327
  """
3519
- The number of milliseconds to wait before retrying the boot sequence. This option is only valid if `boot_retry_enabled` is `true`. Default: `10000` (10 seconds).
3328
+ The number of milliseconds to wait before retrying the boot sequence. This only valid if boot_retry_enabled is true.
3520
3329
  """
3521
3330
  return pulumi.get(self, "boot_retry_delay")
3522
3331
 
@@ -3524,7 +3333,7 @@ class VirtualMachine(pulumi.CustomResource):
3524
3333
  @pulumi.getter(name="bootRetryEnabled")
3525
3334
  def boot_retry_enabled(self) -> pulumi.Output[Optional[bool]]:
3526
3335
  """
3527
- If set to `true`, a virtual machine that fails to boot will try again after the delay defined in `boot_retry_delay`. Default: `false`.
3336
+ If set to true, a virtual machine that fails to boot will try again after the delay defined in boot_retry_delay.
3528
3337
  """
3529
3338
  return pulumi.get(self, "boot_retry_enabled")
3530
3339
 
@@ -3532,7 +3341,7 @@ class VirtualMachine(pulumi.CustomResource):
3532
3341
  @pulumi.getter
3533
3342
  def cdroms(self) -> pulumi.Output[Optional[Sequence['outputs.VirtualMachineCdrom']]]:
3534
3343
  """
3535
- A specification for a CD-ROM device on the virtual machine. See CD-ROM options for more information.
3344
+ A specification for a CDROM device on this virtual machine.
3536
3345
  """
3537
3346
  return pulumi.get(self, "cdroms")
3538
3347
 
@@ -3548,7 +3357,7 @@ class VirtualMachine(pulumi.CustomResource):
3548
3357
  @pulumi.getter
3549
3358
  def clone(self) -> pulumi.Output[Optional['outputs.VirtualMachineClone']]:
3550
3359
  """
3551
- When specified, the virtual machine will be created as a clone of a specified template. Optional customization options can be submitted for the resource. See creating a virtual machine from a template for more information.
3360
+ A specification for cloning a virtual machine from template.
3552
3361
  """
3553
3362
  return pulumi.get(self, "clone")
3554
3363
 
@@ -3556,7 +3365,7 @@ class VirtualMachine(pulumi.CustomResource):
3556
3365
  @pulumi.getter(name="cpuHotAddEnabled")
3557
3366
  def cpu_hot_add_enabled(self) -> pulumi.Output[Optional[bool]]:
3558
3367
  """
3559
- Allow CPUs to be added to the virtual machine while it is powered on.
3368
+ Allow CPUs to be added to this virtual machine while it is running.
3560
3369
  """
3561
3370
  return pulumi.get(self, "cpu_hot_add_enabled")
3562
3371
 
@@ -3564,7 +3373,7 @@ class VirtualMachine(pulumi.CustomResource):
3564
3373
  @pulumi.getter(name="cpuHotRemoveEnabled")
3565
3374
  def cpu_hot_remove_enabled(self) -> pulumi.Output[Optional[bool]]:
3566
3375
  """
3567
- Allow CPUs to be removed to the virtual machine while it is powered on.
3376
+ Allow CPUs to be added to this virtual machine while it is running.
3568
3377
  """
3569
3378
  return pulumi.get(self, "cpu_hot_remove_enabled")
3570
3379
 
@@ -3572,7 +3381,8 @@ class VirtualMachine(pulumi.CustomResource):
3572
3381
  @pulumi.getter(name="cpuLimit")
3573
3382
  def cpu_limit(self) -> pulumi.Output[Optional[int]]:
3574
3383
  """
3575
- The maximum amount of CPU (in MHz) that the virtual machine can consume, regardless of available resources. The default is no limit.
3384
+ The maximum amount of memory (in MB) or CPU (in MHz) that this virtual machine can consume, regardless of available
3385
+ resources.
3576
3386
  """
3577
3387
  return pulumi.get(self, "cpu_limit")
3578
3388
 
@@ -3580,7 +3390,7 @@ class VirtualMachine(pulumi.CustomResource):
3580
3390
  @pulumi.getter(name="cpuPerformanceCountersEnabled")
3581
3391
  def cpu_performance_counters_enabled(self) -> pulumi.Output[Optional[bool]]:
3582
3392
  """
3583
- Enable CPU performance counters on the virtual machine. Default: `false`.
3393
+ Enable CPU performance counters on this virtual machine.
3584
3394
  """
3585
3395
  return pulumi.get(self, "cpu_performance_counters_enabled")
3586
3396
 
@@ -3588,7 +3398,7 @@ class VirtualMachine(pulumi.CustomResource):
3588
3398
  @pulumi.getter(name="cpuReservation")
3589
3399
  def cpu_reservation(self) -> pulumi.Output[Optional[int]]:
3590
3400
  """
3591
- The amount of CPU (in MHz) that the virtual machine is guaranteed. The default is no reservation.
3401
+ The amount of memory (in MB) or CPU (in MHz) that this virtual machine is guaranteed.
3592
3402
  """
3593
3403
  return pulumi.get(self, "cpu_reservation")
3594
3404
 
@@ -3596,7 +3406,7 @@ class VirtualMachine(pulumi.CustomResource):
3596
3406
  @pulumi.getter(name="cpuShareCount")
3597
3407
  def cpu_share_count(self) -> pulumi.Output[int]:
3598
3408
  """
3599
- The number of CPU shares allocated to the virtual machine when the `cpu_share_level` is `custom`.
3409
+ The amount of shares to allocate to cpu for a custom share level.
3600
3410
  """
3601
3411
  return pulumi.get(self, "cpu_share_count")
3602
3412
 
@@ -3604,7 +3414,7 @@ class VirtualMachine(pulumi.CustomResource):
3604
3414
  @pulumi.getter(name="cpuShareLevel")
3605
3415
  def cpu_share_level(self) -> pulumi.Output[Optional[str]]:
3606
3416
  """
3607
- The allocation level for the virtual machine CPU resources. One of `high`, `low`, `normal`, or `custom`. Default: `custom`.
3417
+ The allocation level for cpu resources. Can be one of high, low, normal, or custom.
3608
3418
  """
3609
3419
  return pulumi.get(self, "cpu_share_level")
3610
3420
 
@@ -3612,9 +3422,7 @@ class VirtualMachine(pulumi.CustomResource):
3612
3422
  @pulumi.getter(name="customAttributes")
3613
3423
  def custom_attributes(self) -> pulumi.Output[Optional[Mapping[str, str]]]:
3614
3424
  """
3615
- Map of custom attribute ids to attribute value strings to set for virtual machine. Please refer to the `vsphere_custom_attributes` resource for more information on setting custom attributes.
3616
-
3617
- > **NOTE:** Custom attributes requires vCenter Server and is not supported on direct ESXi host connections.
3425
+ A list of custom attributes to set on this resource.
3618
3426
  """
3619
3427
  return pulumi.get(self, "custom_attributes")
3620
3428
 
@@ -3622,7 +3430,7 @@ class VirtualMachine(pulumi.CustomResource):
3622
3430
  @pulumi.getter(name="datacenterId")
3623
3431
  def datacenter_id(self) -> pulumi.Output[Optional[str]]:
3624
3432
  """
3625
- The datacenter ID. Required only when deploying an OVF/OVA template.
3433
+ The ID of the datacenter where the VM is to be created.
3626
3434
  """
3627
3435
  return pulumi.get(self, "datacenter_id")
3628
3436
 
@@ -3630,13 +3438,7 @@ class VirtualMachine(pulumi.CustomResource):
3630
3438
  @pulumi.getter(name="datastoreClusterId")
3631
3439
  def datastore_cluster_id(self) -> pulumi.Output[Optional[str]]:
3632
3440
  """
3633
- The managed object reference ID of the datastore cluster in which to place the virtual machine. This setting applies to entire virtual machine and implies that you wish to use vSphere Storage DRS with the virtual machine. See the section on virtual machine migration for more information on modifying this value.
3634
-
3635
- > **NOTE:** One of `datastore_id` or `datastore_cluster_id` must be specified.
3636
-
3637
- > **NOTE:** Use of `datastore_cluster_id` requires vSphere Storage DRS to be enabled on the specified datastore cluster.
3638
-
3639
- > **NOTE:** The `datastore_cluster_id` setting applies to the entire virtual machine resource. You cannot assign individual individual disks to datastore clusters. In addition, you cannot use the `attach` setting to attach external disks on virtual machines that are assigned to datastore clusters.
3441
+ The ID of a datastore cluster to put the virtual machine in.
3640
3442
  """
3641
3443
  return pulumi.get(self, "datastore_cluster_id")
3642
3444
 
@@ -3644,7 +3446,8 @@ class VirtualMachine(pulumi.CustomResource):
3644
3446
  @pulumi.getter(name="datastoreId")
3645
3447
  def datastore_id(self) -> pulumi.Output[str]:
3646
3448
  """
3647
- The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with `client_device`.
3449
+ The ID of the virtual machine's datastore. The virtual machine configuration is placed here, along with any virtual
3450
+ disks that are created without datastores.
3648
3451
  """
3649
3452
  return pulumi.get(self, "datastore_id")
3650
3453
 
@@ -3660,7 +3463,7 @@ class VirtualMachine(pulumi.CustomResource):
3660
3463
  @pulumi.getter
3661
3464
  def disks(self) -> pulumi.Output[Sequence['outputs.VirtualMachineDisk']]:
3662
3465
  """
3663
- A specification for a virtual disk device on the virtual machine. See disk options for more information.
3466
+ A specification for a virtual disk device on this virtual machine.
3664
3467
  """
3665
3468
  return pulumi.get(self, "disks")
3666
3469
 
@@ -3668,9 +3471,7 @@ class VirtualMachine(pulumi.CustomResource):
3668
3471
  @pulumi.getter(name="efiSecureBootEnabled")
3669
3472
  def efi_secure_boot_enabled(self) -> pulumi.Output[Optional[bool]]:
3670
3473
  """
3671
- Use this option to enable EFI secure boot when the `firmware` type is set to is `efi`. Default: `false`.
3672
-
3673
- > **NOTE:** EFI secure boot is only available on vSphere 6.5 and later.
3474
+ When the boot type set in firmware is efi, this enables EFI secure boot.
3674
3475
  """
3675
3476
  return pulumi.get(self, "efi_secure_boot_enabled")
3676
3477
 
@@ -3678,7 +3479,7 @@ class VirtualMachine(pulumi.CustomResource):
3678
3479
  @pulumi.getter(name="enableDiskUuid")
3679
3480
  def enable_disk_uuid(self) -> pulumi.Output[Optional[bool]]:
3680
3481
  """
3681
- Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest. Default: `false`.
3482
+ Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest.
3682
3483
  """
3683
3484
  return pulumi.get(self, "enable_disk_uuid")
3684
3485
 
@@ -3686,15 +3487,15 @@ class VirtualMachine(pulumi.CustomResource):
3686
3487
  @pulumi.getter(name="enableLogging")
3687
3488
  def enable_logging(self) -> pulumi.Output[Optional[bool]]:
3688
3489
  """
3689
- Enable logging of virtual machine events to a log file stored in the virtual machine directory. Default: `false`.
3490
+ Enable logging on this virtual machine.
3690
3491
  """
3691
3492
  return pulumi.get(self, "enable_logging")
3692
3493
 
3693
3494
  @property
3694
3495
  @pulumi.getter(name="eptRviMode")
3695
- def ept_rvi_mode(self) -> pulumi.Output[Optional[str]]:
3496
+ def ept_rvi_mode(self) -> pulumi.Output[str]:
3696
3497
  """
3697
- The EPT/RVI (hardware memory virtualization) setting for the virtual machine. One of `automatic`, `on`, or `off`. Default: `automatic`.
3498
+ The EPT/RVI (hardware memory virtualization) setting for this virtual machine. Can be one of automatic, on, or off.
3698
3499
  """
3699
3500
  return pulumi.get(self, "ept_rvi_mode")
3700
3501
 
@@ -3702,9 +3503,8 @@ class VirtualMachine(pulumi.CustomResource):
3702
3503
  @pulumi.getter(name="extraConfig")
3703
3504
  def extra_config(self) -> pulumi.Output[Optional[Mapping[str, str]]]:
3704
3505
  """
3705
- Extra configuration data for the virtual machine. Can be used to supply advanced parameters not normally in configuration, such as instance metadata and userdata.
3706
-
3707
- > **NOTE:** Do not use `extra_config` when working with a template imported from OVF/OVA as your settings may be ignored. Use the `vapp` block `properties` section as described in Using vApp Properties for OVF/OVA Configuration.
3506
+ Extra configuration data for this virtual machine. Can be used to supply advanced parameters not normally in
3507
+ configuration, such as instance metadata, or configuration data for OVF images.
3708
3508
  """
3709
3509
  return pulumi.get(self, "extra_config")
3710
3510
 
@@ -3712,7 +3512,7 @@ class VirtualMachine(pulumi.CustomResource):
3712
3512
  @pulumi.getter(name="extraConfigRebootRequired")
3713
3513
  def extra_config_reboot_required(self) -> pulumi.Output[Optional[bool]]:
3714
3514
  """
3715
- Allow the virtual machine to be rebooted when a change to `extra_config` occurs. Default: `true`.
3515
+ Allow the virtual machine to be rebooted when a change to `extra_config` occurs.
3716
3516
  """
3717
3517
  return pulumi.get(self, "extra_config_reboot_required")
3718
3518
 
@@ -3720,7 +3520,7 @@ class VirtualMachine(pulumi.CustomResource):
3720
3520
  @pulumi.getter
3721
3521
  def firmware(self) -> pulumi.Output[Optional[str]]:
3722
3522
  """
3723
- The firmware for the virtual machine. One of `bios` or `efi`.
3523
+ The firmware interface to use on the virtual machine. Can be one of bios or efi.
3724
3524
  """
3725
3525
  return pulumi.get(self, "firmware")
3726
3526
 
@@ -3728,7 +3528,7 @@ class VirtualMachine(pulumi.CustomResource):
3728
3528
  @pulumi.getter
3729
3529
  def folder(self) -> pulumi.Output[Optional[str]]:
3730
3530
  """
3731
- The path to the virtual machine folder in which to place the virtual machine, relative to the datacenter path (`/<datacenter-name>/vm`). For example, `/dc-01/vm/foo`
3531
+ The name of the folder to locate the virtual machine in.
3732
3532
  """
3733
3533
  return pulumi.get(self, "folder")
3734
3534
 
@@ -3736,7 +3536,7 @@ class VirtualMachine(pulumi.CustomResource):
3736
3536
  @pulumi.getter(name="forcePowerOff")
3737
3537
  def force_power_off(self) -> pulumi.Output[Optional[bool]]:
3738
3538
  """
3739
- If a guest shutdown failed or times out while updating or destroying (see `shutdown_wait_timeout`), force the power-off of the virtual machine. Default: `true`.
3539
+ Set to true to force power-off a virtual machine if a graceful guest shutdown failed for a necessary operation.
3740
3540
  """
3741
3541
  return pulumi.get(self, "force_power_off")
3742
3542
 
@@ -3744,9 +3544,7 @@ class VirtualMachine(pulumi.CustomResource):
3744
3544
  @pulumi.getter(name="guestId")
3745
3545
  def guest_id(self) -> pulumi.Output[str]:
3746
3546
  """
3747
- The guest ID for the operating system type. For a full list of possible values, see [here][vmware-docs-guest-ids]. Default: `otherGuest64`.
3748
-
3749
- [vmware-docs-guest-ids]: https://vdc-repo.vmware.com/vmwb-repository/dcr-public/184bb3ba-6fa8-4574-a767-d0c96e2a38f4/ba9422ef-405c-47dd-8553-e11b619185b2/SDK/vsphere-ws/docs/ReferenceGuide/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html
3547
+ The guest ID for the operating system.
3750
3548
  """
3751
3549
  return pulumi.get(self, "guest_id")
3752
3550
 
@@ -3762,10 +3560,7 @@ class VirtualMachine(pulumi.CustomResource):
3762
3560
  @pulumi.getter(name="hardwareVersion")
3763
3561
  def hardware_version(self) -> pulumi.Output[int]:
3764
3562
  """
3765
- The hardware version number. Valid range is from 4 to 21. The hardware version cannot be downgraded. See virtual machine hardware [versions][virtual-machine-hardware-versions] and [compatibility][virtual-machine-hardware-compatibility] for more information on supported settings.
3766
-
3767
- [virtual-machine-hardware-versions]: https://kb.vmware.com/s/article/1003746
3768
- [virtual-machine-hardware-compatibility]: https://kb.vmware.com/s/article/2007240
3563
+ The hardware version for the virtual machine.
3769
3564
  """
3770
3565
  return pulumi.get(self, "hardware_version")
3771
3566
 
@@ -3773,31 +3568,28 @@ class VirtualMachine(pulumi.CustomResource):
3773
3568
  @pulumi.getter(name="hostSystemId")
3774
3569
  def host_system_id(self) -> pulumi.Output[str]:
3775
3570
  """
3776
- The managed object reference ID of a host on which to place the virtual machine. See the section on virtual machine migration for more information on modifying this value. When using a vSphere cluster, if a `host_system_id` is not supplied, vSphere will select a host in the cluster to place the virtual machine, according to any defaults or vSphere DRS placement policies.
3571
+ The ID of an optional host system to pin the virtual machine to.
3777
3572
  """
3778
3573
  return pulumi.get(self, "host_system_id")
3779
3574
 
3780
3575
  @property
3781
3576
  @pulumi.getter(name="hvMode")
3782
- def hv_mode(self) -> pulumi.Output[Optional[str]]:
3577
+ def hv_mode(self) -> pulumi.Output[str]:
3783
3578
  """
3784
- The hardware virtualization (non-nested) setting for the virtual machine. One of `hvAuto`, `hvOn`, or `hvOff`. Default: `hvAuto`.
3579
+ The (non-nested) hardware virtualization setting for this virtual machine. Can be one of hvAuto, hvOn, or hvOff.
3785
3580
  """
3786
3581
  return pulumi.get(self, "hv_mode")
3787
3582
 
3788
3583
  @property
3789
3584
  @pulumi.getter(name="ideControllerCount")
3790
3585
  def ide_controller_count(self) -> pulumi.Output[Optional[int]]:
3791
- """
3792
- The number of IDE controllers that the virtual machine. This directly affects the number of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers. Default: `2`.
3793
- """
3794
3586
  return pulumi.get(self, "ide_controller_count")
3795
3587
 
3796
3588
  @property
3797
3589
  @pulumi.getter(name="ignoredGuestIps")
3798
3590
  def ignored_guest_ips(self) -> pulumi.Output[Optional[Sequence[str]]]:
3799
3591
  """
3800
- List of IP addresses and CIDR networks to ignore while waiting for an available IP address using either of the waiters. Any IP addresses in this list will be ignored so that the waiter will continue to wait for a valid IP address. Default: `[]`.
3592
+ List of IP addresses and CIDR networks to ignore while waiting for an IP
3801
3593
  """
3802
3594
  return pulumi.get(self, "ignored_guest_ips")
3803
3595
 
@@ -3813,9 +3605,9 @@ class VirtualMachine(pulumi.CustomResource):
3813
3605
  @pulumi.getter(name="latencySensitivity")
3814
3606
  def latency_sensitivity(self) -> pulumi.Output[Optional[str]]:
3815
3607
  """
3816
- Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard devices. One of `low`, `normal`, `medium`, or `high`.
3817
-
3818
- > **NOTE:** On higher sensitivities, you may need to adjust the `memory_reservation` to the full amount of memory provisioned for the virtual machine.
3608
+ Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower
3609
+ latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard
3610
+ devices. Can be one of low, normal, medium, or high.
3819
3611
  """
3820
3612
  return pulumi.get(self, "latency_sensitivity")
3821
3613
 
@@ -3823,7 +3615,7 @@ class VirtualMachine(pulumi.CustomResource):
3823
3615
  @pulumi.getter
3824
3616
  def memory(self) -> pulumi.Output[Optional[int]]:
3825
3617
  """
3826
- The memory size to assign to the virtual machine, in MB. Default: `1024` (1 GB).
3618
+ The size of the virtual machine's memory, in MB.
3827
3619
  """
3828
3620
  return pulumi.get(self, "memory")
3829
3621
 
@@ -3831,15 +3623,7 @@ class VirtualMachine(pulumi.CustomResource):
3831
3623
  @pulumi.getter(name="memoryHotAddEnabled")
3832
3624
  def memory_hot_add_enabled(self) -> pulumi.Output[Optional[bool]]:
3833
3625
  """
3834
- Allow memory to be added to the virtual machine while it is powered on.
3835
-
3836
- > **NOTE:** CPU and memory hot add options are not available on all guest operating systems. Please refer to the [VMware Guest OS Compatibility Guide][vmware-docs-compat-guide] to which settings are allow for your guest operating system. In addition, at least one `pulumi up` must be run before you are able to use CPU and memory hot add.
3837
-
3838
- [vmware-docs-compat-guide]: http://partnerweb.vmware.com/comp_guide2/pdf/VMware_GOS_Compatibility_Guide.pdf
3839
-
3840
- > **NOTE:** For Linux 64-bit guest operating systems with less than or equal to 3GB, the virtual machine must powered off to add memory beyond 3GB. Subsequent hot add of memory does not require the virtual machine to be powered-off to apply the plan. Please refer to [VMware KB 2008405][vmware-kb-2008405].
3841
-
3842
- [vmware-kb-2008405]: https://kb.vmware.com/s/article/2008405
3626
+ Allow memory to be added to this virtual machine while it is running.
3843
3627
  """
3844
3628
  return pulumi.get(self, "memory_hot_add_enabled")
3845
3629
 
@@ -3847,7 +3631,8 @@ class VirtualMachine(pulumi.CustomResource):
3847
3631
  @pulumi.getter(name="memoryLimit")
3848
3632
  def memory_limit(self) -> pulumi.Output[Optional[int]]:
3849
3633
  """
3850
- The maximum amount of memory (in MB) that th virtual machine can consume, regardless of available resources. The default is no limit.
3634
+ The maximum amount of memory (in MB) or CPU (in MHz) that this virtual machine can consume, regardless of available
3635
+ resources.
3851
3636
  """
3852
3637
  return pulumi.get(self, "memory_limit")
3853
3638
 
@@ -3855,7 +3640,7 @@ class VirtualMachine(pulumi.CustomResource):
3855
3640
  @pulumi.getter(name="memoryReservation")
3856
3641
  def memory_reservation(self) -> pulumi.Output[Optional[int]]:
3857
3642
  """
3858
- The amount of memory (in MB) that the virtual machine is guaranteed. The default is no reservation.
3643
+ The amount of memory (in MB) or CPU (in MHz) that this virtual machine is guaranteed.
3859
3644
  """
3860
3645
  return pulumi.get(self, "memory_reservation")
3861
3646
 
@@ -3873,7 +3658,7 @@ class VirtualMachine(pulumi.CustomResource):
3873
3658
  @pulumi.getter(name="memoryShareCount")
3874
3659
  def memory_share_count(self) -> pulumi.Output[int]:
3875
3660
  """
3876
- The number of memory shares allocated to the virtual machine when the `memory_share_level` is `custom`.
3661
+ The amount of shares to allocate to memory for a custom share level.
3877
3662
  """
3878
3663
  return pulumi.get(self, "memory_share_count")
3879
3664
 
@@ -3881,7 +3666,7 @@ class VirtualMachine(pulumi.CustomResource):
3881
3666
  @pulumi.getter(name="memoryShareLevel")
3882
3667
  def memory_share_level(self) -> pulumi.Output[Optional[str]]:
3883
3668
  """
3884
- The allocation level for the virtual machine memory resources. One of `high`, `low`, `normal`, or `custom`. Default: `custom`.
3669
+ The allocation level for memory resources. Can be one of high, low, normal, or custom.
3885
3670
  """
3886
3671
  return pulumi.get(self, "memory_share_level")
3887
3672
 
@@ -3889,7 +3674,7 @@ class VirtualMachine(pulumi.CustomResource):
3889
3674
  @pulumi.getter(name="migrateWaitTimeout")
3890
3675
  def migrate_wait_timeout(self) -> pulumi.Output[Optional[int]]:
3891
3676
  """
3892
- The amount of time, in minutes, to wait for a virtual machine migration to complete before failing. Default: `10` minutes. See the section on virtual machine migration for more information.
3677
+ The amount of time, in minutes, to wait for a vMotion operation to complete before failing.
3893
3678
  """
3894
3679
  return pulumi.get(self, "migrate_wait_timeout")
3895
3680
 
@@ -3905,7 +3690,7 @@ class VirtualMachine(pulumi.CustomResource):
3905
3690
  @pulumi.getter
3906
3691
  def name(self) -> pulumi.Output[str]:
3907
3692
  """
3908
- The name of the virtual machine.
3693
+ The name of this virtual machine.
3909
3694
  """
3910
3695
  return pulumi.get(self, "name")
3911
3696
 
@@ -3913,7 +3698,7 @@ class VirtualMachine(pulumi.CustomResource):
3913
3698
  @pulumi.getter(name="nestedHvEnabled")
3914
3699
  def nested_hv_enabled(self) -> pulumi.Output[Optional[bool]]:
3915
3700
  """
3916
- Enable nested hardware virtualization on the virtual machine, facilitating nested virtualization in the guest operating system. Default: `false`.
3701
+ Enable nested hardware virtualization on this virtual machine, facilitating nested virtualization in the guest.
3917
3702
  """
3918
3703
  return pulumi.get(self, "nested_hv_enabled")
3919
3704
 
@@ -3921,7 +3706,7 @@ class VirtualMachine(pulumi.CustomResource):
3921
3706
  @pulumi.getter(name="networkInterfaces")
3922
3707
  def network_interfaces(self) -> pulumi.Output[Optional[Sequence['outputs.VirtualMachineNetworkInterface']]]:
3923
3708
  """
3924
- A specification for a virtual NIC on the virtual machine. See network interface options for more information.
3709
+ A specification for a virtual NIC on this virtual machine.
3925
3710
  """
3926
3711
  return pulumi.get(self, "network_interfaces")
3927
3712
 
@@ -3929,7 +3714,8 @@ class VirtualMachine(pulumi.CustomResource):
3929
3714
  @pulumi.getter(name="numCoresPerSocket")
3930
3715
  def num_cores_per_socket(self) -> pulumi.Output[Optional[int]]:
3931
3716
  """
3932
- The number of cores per socket in the virtual machine. The number of vCPUs on the virtual machine will be `num_cpus` divided by `num_cores_per_socket`. If specified, the value supplied to `num_cpus` must be evenly divisible by this value. Default: `1`.
3717
+ The number of cores to distribute amongst the CPUs in this virtual machine. If specified, the value supplied to num_cpus
3718
+ must be evenly divisible by this value.
3933
3719
  """
3934
3720
  return pulumi.get(self, "num_cores_per_socket")
3935
3721
 
@@ -3937,7 +3723,7 @@ class VirtualMachine(pulumi.CustomResource):
3937
3723
  @pulumi.getter(name="numCpus")
3938
3724
  def num_cpus(self) -> pulumi.Output[Optional[int]]:
3939
3725
  """
3940
- The total number of virtual processor cores to assign to the virtual machine. Default: `1`.
3726
+ The number of virtual processors to assign to this virtual machine.
3941
3727
  """
3942
3728
  return pulumi.get(self, "num_cpus")
3943
3729
 
@@ -3945,7 +3731,7 @@ class VirtualMachine(pulumi.CustomResource):
3945
3731
  @pulumi.getter(name="ovfDeploy")
3946
3732
  def ovf_deploy(self) -> pulumi.Output[Optional['outputs.VirtualMachineOvfDeploy']]:
3947
3733
  """
3948
- When specified, the virtual machine will be deployed from the provided OVF/OVA template. See creating a virtual machine from an OVF/OVA template for more information.
3734
+ A specification for deploying a virtual machine from ovf/ova template.
3949
3735
  """
3950
3736
  return pulumi.get(self, "ovf_deploy")
3951
3737
 
@@ -3953,9 +3739,7 @@ class VirtualMachine(pulumi.CustomResource):
3953
3739
  @pulumi.getter(name="pciDeviceIds")
3954
3740
  def pci_device_ids(self) -> pulumi.Output[Optional[Sequence[str]]]:
3955
3741
  """
3956
- List of host PCI device IDs in which to create PCI passthroughs.
3957
-
3958
- > **NOTE:** Cloning requires vCenter Server and is not supported on direct ESXi host connections.
3742
+ A list of PCI passthrough devices
3959
3743
  """
3960
3744
  return pulumi.get(self, "pci_device_ids")
3961
3745
 
@@ -3978,9 +3762,6 @@ class VirtualMachine(pulumi.CustomResource):
3978
3762
  @property
3979
3763
  @pulumi.getter(name="rebootRequired")
3980
3764
  def reboot_required(self) -> pulumi.Output[bool]:
3981
- """
3982
- Value internal to Terraform used to determine if a configuration set change requires a reboot.
3983
- """
3984
3765
  return pulumi.get(self, "reboot_required")
3985
3766
 
3986
3767
  @property
@@ -3988,8 +3769,6 @@ class VirtualMachine(pulumi.CustomResource):
3988
3769
  def replace_trigger(self) -> pulumi.Output[Optional[str]]:
3989
3770
  """
3990
3771
  Triggers replacement of resource whenever it changes.
3991
-
3992
- For example, `replace_trigger = sha256(format("%!s(MISSING)-%!s(MISSING)",data.template_file.cloud_init_metadata.rendered,data.template_file.cloud_init_userdata.rendered))` will fingerprint the changes in cloud-init metadata and userdata templates. This will enable a replacement of the resource whenever the dependant template renders a new configuration. (Forces a replacement.)
3993
3772
  """
3994
3773
  return pulumi.get(self, "replace_trigger")
3995
3774
 
@@ -3997,9 +3776,7 @@ class VirtualMachine(pulumi.CustomResource):
3997
3776
  @pulumi.getter(name="resourcePoolId")
3998
3777
  def resource_pool_id(self) -> pulumi.Output[str]:
3999
3778
  """
4000
- The managed object reference ID of the resource pool in which to place the virtual machine. See the Virtual Machine Migration section for more information on modifying this value.
4001
-
4002
- > **NOTE:** All clusters and standalone hosts have a default root resource pool. This resource argument does not directly accept the cluster or standalone host resource. For more information, see the section on specifying the Root Resource Pool in the `ResourcePool` data source documentation on using the root resource pool.
3779
+ The ID of a resource pool to put the virtual machine in.
4003
3780
  """
4004
3781
  return pulumi.get(self, "resource_pool_id")
4005
3782
 
@@ -4007,7 +3784,7 @@ class VirtualMachine(pulumi.CustomResource):
4007
3784
  @pulumi.getter(name="runToolsScriptsAfterPowerOn")
4008
3785
  def run_tools_scripts_after_power_on(self) -> pulumi.Output[Optional[bool]]:
4009
3786
  """
4010
- Enable post-power-on scripts to run when VMware Tools is installed. Default: `true`.
3787
+ Enable the run of scripts after virtual machine power-on when VMware Tools is installed.
4011
3788
  """
4012
3789
  return pulumi.get(self, "run_tools_scripts_after_power_on")
4013
3790
 
@@ -4015,7 +3792,7 @@ class VirtualMachine(pulumi.CustomResource):
4015
3792
  @pulumi.getter(name="runToolsScriptsAfterResume")
4016
3793
  def run_tools_scripts_after_resume(self) -> pulumi.Output[Optional[bool]]:
4017
3794
  """
4018
- Enable ost-resume scripts to run when VMware Tools is installed. Default: `true`.
3795
+ Enable the run of scripts after virtual machine resume when when VMware Tools is installed.
4019
3796
  """
4020
3797
  return pulumi.get(self, "run_tools_scripts_after_resume")
4021
3798
 
@@ -4023,7 +3800,7 @@ class VirtualMachine(pulumi.CustomResource):
4023
3800
  @pulumi.getter(name="runToolsScriptsBeforeGuestReboot")
4024
3801
  def run_tools_scripts_before_guest_reboot(self) -> pulumi.Output[Optional[bool]]:
4025
3802
  """
4026
- Enable pre-reboot scripts to run when VMware Tools is installed. Default: `false`.
3803
+ Enable the run of scripts before guest operating system reboot when VMware Tools is installed.
4027
3804
  """
4028
3805
  return pulumi.get(self, "run_tools_scripts_before_guest_reboot")
4029
3806
 
@@ -4031,7 +3808,7 @@ class VirtualMachine(pulumi.CustomResource):
4031
3808
  @pulumi.getter(name="runToolsScriptsBeforeGuestShutdown")
4032
3809
  def run_tools_scripts_before_guest_shutdown(self) -> pulumi.Output[Optional[bool]]:
4033
3810
  """
4034
- Enable pre-shutdown scripts to run when VMware Tools is installed. Default: `true`.
3811
+ Enable the run of scripts before guest operating system shutdown when VMware Tools is installed.
4035
3812
  """
4036
3813
  return pulumi.get(self, "run_tools_scripts_before_guest_shutdown")
4037
3814
 
@@ -4039,43 +3816,33 @@ class VirtualMachine(pulumi.CustomResource):
4039
3816
  @pulumi.getter(name="runToolsScriptsBeforeGuestStandby")
4040
3817
  def run_tools_scripts_before_guest_standby(self) -> pulumi.Output[Optional[bool]]:
4041
3818
  """
4042
- Enable pre-standby scripts to run when VMware Tools is installed. Default: `true`.
3819
+ Enable the run of scripts before guest operating system standby when VMware Tools is installed.
4043
3820
  """
4044
3821
  return pulumi.get(self, "run_tools_scripts_before_guest_standby")
4045
3822
 
4046
3823
  @property
4047
3824
  @pulumi.getter(name="sataControllerCount")
4048
3825
  def sata_controller_count(self) -> pulumi.Output[Optional[int]]:
4049
- """
4050
- The number of SATA controllers that Terraform manages on this virtual machine. This directly affects the amount of disks
4051
- you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove
4052
- controllers.
4053
- """
4054
3826
  return pulumi.get(self, "sata_controller_count")
4055
3827
 
4056
3828
  @property
4057
3829
  @pulumi.getter(name="scsiBusSharing")
4058
3830
  def scsi_bus_sharing(self) -> pulumi.Output[Optional[str]]:
4059
3831
  """
4060
- The type of SCSI bus sharing for the virtual machine SCSI controller. One of `physicalSharing`, `virtualSharing`, and `noSharing`. Default: `noSharing`.
3832
+ Mode for sharing the SCSI bus. The modes are physicalSharing, virtualSharing, and noSharing.
4061
3833
  """
4062
3834
  return pulumi.get(self, "scsi_bus_sharing")
4063
3835
 
4064
3836
  @property
4065
3837
  @pulumi.getter(name="scsiControllerCount")
4066
3838
  def scsi_controller_count(self) -> pulumi.Output[Optional[int]]:
4067
- """
4068
- The number of SCSI controllers that Terraform manages on this virtual machine. This directly affects the amount of disks
4069
- you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove
4070
- controllers.
4071
- """
4072
3839
  return pulumi.get(self, "scsi_controller_count")
4073
3840
 
4074
3841
  @property
4075
3842
  @pulumi.getter(name="scsiType")
4076
3843
  def scsi_type(self) -> pulumi.Output[Optional[str]]:
4077
3844
  """
4078
- The SCSI controller type for the virtual machine. One of `lsilogic` (LSI Logic Parallel), `lsilogic-sas` (LSI Logic SAS) or `pvscsi` (VMware Paravirtual). Default: `pvscsi`.
3845
+ The type of SCSI bus this virtual machine will have. Can be one of lsilogic, lsilogic-sas or pvscsi.
4079
3846
  """
4080
3847
  return pulumi.get(self, "scsi_type")
4081
3848
 
@@ -4083,7 +3850,7 @@ class VirtualMachine(pulumi.CustomResource):
4083
3850
  @pulumi.getter(name="shutdownWaitTimeout")
4084
3851
  def shutdown_wait_timeout(self) -> pulumi.Output[Optional[int]]:
4085
3852
  """
4086
- The amount of time, in minutes, to wait for a graceful guest shutdown when making necessary updates to the virtual machine. If `force_power_off` is set to `true`, the virtual machine will be forced to power-off after the timeout, otherwise an error is returned. Default: `3` minutes.
3853
+ The amount of time, in minutes, to wait for shutdown when making necessary updates to the virtual machine.
4087
3854
  """
4088
3855
  return pulumi.get(self, "shutdown_wait_timeout")
4089
3856
 
@@ -4091,7 +3858,7 @@ class VirtualMachine(pulumi.CustomResource):
4091
3858
  @pulumi.getter(name="storagePolicyId")
4092
3859
  def storage_policy_id(self) -> pulumi.Output[str]:
4093
3860
  """
4094
- The UUID of the storage policy to assign to the virtual disk.
3861
+ The ID of the storage policy to assign to the virtual machine home directory.
4095
3862
  """
4096
3863
  return pulumi.get(self, "storage_policy_id")
4097
3864
 
@@ -4099,7 +3866,7 @@ class VirtualMachine(pulumi.CustomResource):
4099
3866
  @pulumi.getter(name="swapPlacementPolicy")
4100
3867
  def swap_placement_policy(self) -> pulumi.Output[Optional[str]]:
4101
3868
  """
4102
- The swap file placement policy for the virtual machine. One of `inherit`, `hostLocal`, or `vmDirectory`. Default: `inherit`.
3869
+ The swap file placement policy for this virtual machine. Can be one of inherit, hostLocal, or vmDirectory.
4103
3870
  """
4104
3871
  return pulumi.get(self, "swap_placement_policy")
4105
3872
 
@@ -4107,7 +3874,8 @@ class VirtualMachine(pulumi.CustomResource):
4107
3874
  @pulumi.getter(name="syncTimeWithHost")
4108
3875
  def sync_time_with_host(self) -> pulumi.Output[Optional[bool]]:
4109
3876
  """
4110
- Enable the guest operating system to synchronization its clock with the host when the virtual machine is powered on or resumed. Requires vSphere 7.0 Update 1 and later. Requires VMware Tools to be installed. Default: `true`.
3877
+ Enable guest clock synchronization with the host. On vSphere 7.0 U1 and above, with only this setting the clock is
3878
+ synchronized on startup and resume. Requires VMware Tools to be installed.
4111
3879
  """
4112
3880
  return pulumi.get(self, "sync_time_with_host")
4113
3881
 
@@ -4115,7 +3883,8 @@ class VirtualMachine(pulumi.CustomResource):
4115
3883
  @pulumi.getter(name="syncTimeWithHostPeriodically")
4116
3884
  def sync_time_with_host_periodically(self) -> pulumi.Output[Optional[bool]]:
4117
3885
  """
4118
- Enable the guest operating system to periodically synchronize its clock with the host. Requires vSphere 7.0 Update 1 and later. On previous versions, setting `sync_time_with_host` is will enable periodic synchronization. Requires VMware Tools to be installed. Default: `false`.
3886
+ Enable periodic clock synchronization with the host. Supported only on vSphere 7.0 U1 and above. On prior versions
3887
+ setting `sync_time_with_host` is enough for periodic synchronization. Requires VMware Tools to be installed.
4119
3888
  """
4120
3889
  return pulumi.get(self, "sync_time_with_host_periodically")
4121
3890
 
@@ -4123,9 +3892,7 @@ class VirtualMachine(pulumi.CustomResource):
4123
3892
  @pulumi.getter
4124
3893
  def tags(self) -> pulumi.Output[Optional[Sequence[str]]]:
4125
3894
  """
4126
- The IDs of any tags to attach to this resource. Please refer to the `Tag` resource for more information on applying tags to virtual machine resources.
4127
-
4128
- > **NOTE:** Tagging support is unsupported on direct ESXi host connections and requires vCenter Server instance.
3895
+ A list of tag IDs to apply to this object.
4129
3896
  """
4130
3897
  return pulumi.get(self, "tags")
4131
3898
 
@@ -4133,7 +3900,7 @@ class VirtualMachine(pulumi.CustomResource):
4133
3900
  @pulumi.getter(name="toolsUpgradePolicy")
4134
3901
  def tools_upgrade_policy(self) -> pulumi.Output[Optional[str]]:
4135
3902
  """
4136
- Enable automatic upgrade of the VMware Tools version when the virtual machine is rebooted. If necessary, VMware Tools is upgraded to the latest version supported by the host on which the virtual machine is running. Requires VMware Tools to be installed. One of `manual` or `upgradeAtPowerCycle`. Default: `manual`.
3903
+ Set the upgrade policy for VMware Tools. Can be one of `manual` or `upgradeAtPowerCycle`.
4137
3904
  """
4138
3905
  return pulumi.get(self, "tools_upgrade_policy")
4139
3906
 
@@ -4141,7 +3908,7 @@ class VirtualMachine(pulumi.CustomResource):
4141
3908
  @pulumi.getter
4142
3909
  def uuid(self) -> pulumi.Output[str]:
4143
3910
  """
4144
- The UUID of the virtual disk VMDK file. This is used to track the virtual disk on the virtual machine.
3911
+ The UUID of the virtual machine. Also exposed as the `id` of the resource.
4145
3912
  """
4146
3913
  return pulumi.get(self, "uuid")
4147
3914
 
@@ -4149,7 +3916,7 @@ class VirtualMachine(pulumi.CustomResource):
4149
3916
  @pulumi.getter
4150
3917
  def vapp(self) -> pulumi.Output[Optional['outputs.VirtualMachineVapp']]:
4151
3918
  """
4152
- Used for vApp configurations. The only sub-key available is `properties`, which is a key/value map of properties for virtual machines imported from and OVF/OVA. See Using vApp Properties for OVF/OVA Configuration for more information.
3919
+ vApp configuration data for this virtual machine. Can be used to provide configuration data for OVF images.
4153
3920
  """
4154
3921
  return pulumi.get(self, "vapp")
4155
3922
 
@@ -4165,7 +3932,7 @@ class VirtualMachine(pulumi.CustomResource):
4165
3932
  @pulumi.getter(name="vbsEnabled")
4166
3933
  def vbs_enabled(self) -> pulumi.Output[Optional[bool]]:
4167
3934
  """
4168
- Enable Virtualization Based Security. Requires `firmware` to be `efi`. In addition, `vvtd_enabled`, `nested_hv_enabled`, and `efi_secure_boot_enabled` must all have a value of `true`. Supported on vSphere 6.7 and later. Default: `false`.
3935
+ Flag to specify if Virtualization-based security is enabled for this virtual machine.
4169
3936
  """
4170
3937
  return pulumi.get(self, "vbs_enabled")
4171
3938
 
@@ -4189,7 +3956,8 @@ class VirtualMachine(pulumi.CustomResource):
4189
3956
  @pulumi.getter(name="vvtdEnabled")
4190
3957
  def vvtd_enabled(self) -> pulumi.Output[Optional[bool]]:
4191
3958
  """
4192
- Enable Intel Virtualization Technology for Directed I/O for the virtual machine (_I/O MMU_ in the vSphere Client). Supported on vSphere 6.7 and later. Default: `false`.
3959
+ Flag to specify if I/O MMU virtualization, also called Intel Virtualization Technology for Directed I/O (VT-d) and AMD
3960
+ I/O Virtualization (AMD-Vi or IOMMU), is enabled.
4193
3961
  """
4194
3962
  return pulumi.get(self, "vvtd_enabled")
4195
3963
 
@@ -4197,7 +3965,8 @@ class VirtualMachine(pulumi.CustomResource):
4197
3965
  @pulumi.getter(name="waitForGuestIpTimeout")
4198
3966
  def wait_for_guest_ip_timeout(self) -> pulumi.Output[Optional[int]]:
4199
3967
  """
4200
- The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. This should only be used if the version VMware Tools does not allow the `wait_for_guest_net_timeout` waiter to be used. A value less than `1` disables the waiter. Default: `0`.
3968
+ The amount of time, in minutes, to wait for an available IP address on this virtual machine. A value less than 1
3969
+ disables the waiter.
4201
3970
  """
4202
3971
  return pulumi.get(self, "wait_for_guest_ip_timeout")
4203
3972
 
@@ -4205,7 +3974,8 @@ class VirtualMachine(pulumi.CustomResource):
4205
3974
  @pulumi.getter(name="waitForGuestNetRoutable")
4206
3975
  def wait_for_guest_net_routable(self) -> pulumi.Output[Optional[bool]]:
4207
3976
  """
4208
- Controls whether or not the guest network waiter waits for a routable address. When `false`, the waiter does not wait for a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria. This property is ignored if the `wait_for_guest_ip_timeout` waiter is used. Default: `true`.
3977
+ Controls whether or not the guest network waiter waits for a routable address. When false, the waiter does not wait for
3978
+ a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria.
4209
3979
  """
4210
3980
  return pulumi.get(self, "wait_for_guest_net_routable")
4211
3981
 
@@ -4213,7 +3983,8 @@ class VirtualMachine(pulumi.CustomResource):
4213
3983
  @pulumi.getter(name="waitForGuestNetTimeout")
4214
3984
  def wait_for_guest_net_timeout(self) -> pulumi.Output[Optional[int]]:
4215
3985
  """
4216
- The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. Older versions of VMware Tools do not populate this property. In those cases, this waiter can be disabled and the `wait_for_guest_ip_timeout` waiter can be used instead. A value less than `1` disables the waiter. Default: `5` minutes.
3986
+ The amount of time, in minutes, to wait for an available IP address on this virtual machine. A value less than 1
3987
+ disables the waiter.
4217
3988
  """
4218
3989
  return pulumi.get(self, "wait_for_guest_net_timeout")
4219
3990