pulumi-vsphere 4.11.0a1713561492__py3-none-any.whl → 4.11.0a1713905355__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 (50) hide show
  1. pulumi_vsphere/_inputs.py +96 -232
  2. pulumi_vsphere/compute_cluster.py +700 -1477
  3. pulumi_vsphere/compute_cluster_vm_affinity_rule.py +0 -8
  4. pulumi_vsphere/datacenter.py +0 -8
  5. pulumi_vsphere/datastore_cluster.py +154 -350
  6. pulumi_vsphere/distributed_port_group.py +70 -175
  7. pulumi_vsphere/distributed_virtual_switch.py +308 -798
  8. pulumi_vsphere/file.py +0 -8
  9. pulumi_vsphere/get_compute_cluster.py +0 -4
  10. pulumi_vsphere/get_compute_cluster_host_group.py +0 -4
  11. pulumi_vsphere/get_content_library.py +0 -4
  12. pulumi_vsphere/get_custom_attribute.py +0 -4
  13. pulumi_vsphere/get_datacenter.py +0 -4
  14. pulumi_vsphere/get_datastore.py +0 -4
  15. pulumi_vsphere/get_datastore_cluster.py +0 -4
  16. pulumi_vsphere/get_datastore_stats.py +0 -8
  17. pulumi_vsphere/get_distributed_virtual_switch.py +0 -4
  18. pulumi_vsphere/get_dynamic.py +0 -4
  19. pulumi_vsphere/get_folder.py +0 -4
  20. pulumi_vsphere/get_guest_os_customization.py +0 -4
  21. pulumi_vsphere/get_host.py +0 -4
  22. pulumi_vsphere/get_host_pci_device.py +4 -12
  23. pulumi_vsphere/get_host_thumbprint.py +0 -4
  24. pulumi_vsphere/get_host_vgpu_profile.py +0 -8
  25. pulumi_vsphere/get_license.py +0 -4
  26. pulumi_vsphere/get_network.py +0 -4
  27. pulumi_vsphere/get_policy.py +0 -4
  28. pulumi_vsphere/get_resource_pool.py +0 -8
  29. pulumi_vsphere/get_role.py +0 -4
  30. pulumi_vsphere/get_tag.py +0 -4
  31. pulumi_vsphere/get_tag_category.py +0 -4
  32. pulumi_vsphere/get_vapp_container.py +0 -4
  33. pulumi_vsphere/get_virtual_machine.py +0 -8
  34. pulumi_vsphere/get_vmfs_disks.py +0 -4
  35. pulumi_vsphere/guest_os_customization.py +0 -4
  36. pulumi_vsphere/ha_vm_override.py +189 -378
  37. pulumi_vsphere/host.py +0 -8
  38. pulumi_vsphere/host_port_group.py +0 -8
  39. pulumi_vsphere/host_virtual_switch.py +140 -287
  40. pulumi_vsphere/outputs.py +96 -232
  41. pulumi_vsphere/resource_pool.py +0 -12
  42. pulumi_vsphere/virtual_machine.py +599 -739
  43. pulumi_vsphere/virtual_machine_snapshot.py +0 -4
  44. pulumi_vsphere/vm_storage_policy.py +0 -12
  45. pulumi_vsphere/vnic.py +0 -8
  46. {pulumi_vsphere-4.11.0a1713561492.dist-info → pulumi_vsphere-4.11.0a1713905355.dist-info}/METADATA +1 -1
  47. pulumi_vsphere-4.11.0a1713905355.dist-info/RECORD +82 -0
  48. pulumi_vsphere-4.11.0a1713561492.dist-info/RECORD +0 -82
  49. {pulumi_vsphere-4.11.0a1713561492.dist-info → pulumi_vsphere-4.11.0a1713905355.dist-info}/WHEEL +0 -0
  50. {pulumi_vsphere-4.11.0a1713561492.dist-info → pulumi_vsphere-4.11.0a1713905355.dist-info}/top_level.txt +0 -0
@@ -93,122 +93,102 @@ 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[int] ide_controller_count: The number of IDE controllers that Terraform manages on this virtual machine. This directly affects the amount of disks
133
+ you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove
134
+ controllers.
135
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] ignored_guest_ips: List of IP addresses and CIDR networks to ignore while waiting for an IP
136
+ :param pulumi.Input[str] latency_sensitivity: Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower
137
+ latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard
138
+ devices. Can be one of low, normal, medium, or high.
139
+ :param pulumi.Input[int] memory: The size of the virtual machine's memory, in MB.
140
+ :param pulumi.Input[bool] memory_hot_add_enabled: Allow memory to be added to this virtual machine while it is running.
141
+ :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
142
+ resources.
143
+ :param pulumi.Input[int] memory_reservation: The amount of memory (in MB) or CPU (in MHz) that this virtual machine is guaranteed.
165
144
  :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
145
  size;increases in memory size will be rejected when a corresponding reservation increase is not possible. This feature
167
146
  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.
147
+ :param pulumi.Input[int] memory_share_count: The amount of shares to allocate to memory for a custom share level.
148
+ :param pulumi.Input[str] memory_share_level: The allocation level for memory resources. Can be one of high, low, normal, or custom.
149
+ :param pulumi.Input[int] migrate_wait_timeout: The amount of time, in minutes, to wait for a vMotion operation to complete before failing.
150
+ :param pulumi.Input[str] name: The name of this virtual machine.
151
+ :param pulumi.Input[bool] nested_hv_enabled: Enable nested hardware virtualization on this virtual machine, facilitating nested virtualization in the guest.
152
+ :param pulumi.Input[Sequence[pulumi.Input['VirtualMachineNetworkInterfaceArgs']]] network_interfaces: A specification for a virtual NIC on this virtual machine.
153
+ :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
154
+ must be evenly divisible by this value.
155
+ :param pulumi.Input[int] num_cpus: The number of virtual processors to assign to this virtual machine.
156
+ :param pulumi.Input['VirtualMachineOvfDeployArgs'] ovf_deploy: A specification for deploying a virtual machine from ovf/ova template.
157
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] pci_device_ids: A list of PCI passthrough devices
180
158
  :param pulumi.Input[int] poweron_timeout: The amount of time, in seconds, that we will be trying to power on a VM
181
159
  :param pulumi.Input[str] replace_trigger: Triggers replacement of resource whenever it changes.
182
-
183
- For example, `replace_trigger = sha256(format("%s-%s",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`.
160
+ :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.
161
+ :param pulumi.Input[bool] run_tools_scripts_after_resume: Enable the run of scripts after virtual machine resume when when VMware Tools is installed.
162
+ :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.
163
+ :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.
164
+ :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.
189
165
  :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
166
  you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove
191
167
  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`.
168
+ :param pulumi.Input[str] scsi_bus_sharing: Mode for sharing the SCSI bus. The modes are physicalSharing, virtualSharing, and noSharing.
193
169
  :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
170
  you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove
195
171
  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.
172
+ :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.
173
+ :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.
174
+ :param pulumi.Input[str] storage_policy_id: The ID of the storage policy to assign to the virtual machine home directory.
175
+ :param pulumi.Input[str] swap_placement_policy: The swap file placement policy for this virtual machine. Can be one of inherit, hostLocal, or vmDirectory.
176
+ :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
177
+ synchronized on startup and resume. Requires VMware Tools to be installed.
178
+ :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
179
+ setting `sync_time_with_host` is enough for periodic synchronization. Requires VMware Tools to be installed.
180
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] tags: A list of tag IDs to apply to this object.
181
+ :param pulumi.Input[str] tools_upgrade_policy: Set the upgrade policy for VMware Tools. Can be one of `manual` or `upgradeAtPowerCycle`.
182
+ :param pulumi.Input['VirtualMachineVappArgs'] vapp: vApp configuration data for this virtual machine. Can be used to provide configuration data for OVF images.
183
+ :param pulumi.Input[bool] vbs_enabled: Flag to specify if Virtualization-based security is enabled for this virtual machine.
184
+ :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
185
+ I/O Virtualization (AMD-Vi or IOMMU), is enabled.
186
+ :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
187
+ disables the waiter.
188
+ :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
189
+ a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria.
190
+ :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
191
+ disables the waiter.
212
192
  """
213
193
  pulumi.set(__self__, "resource_pool_id", resource_pool_id)
214
194
  if alternate_guest_name is not None:
@@ -364,9 +344,7 @@ class VirtualMachineArgs:
364
344
  @pulumi.getter(name="resourcePoolId")
365
345
  def resource_pool_id(self) -> pulumi.Input[str]:
366
346
  """
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.
347
+ The ID of a resource pool to put the virtual machine in.
370
348
  """
371
349
  return pulumi.get(self, "resource_pool_id")
372
350
 
@@ -378,7 +356,7 @@ class VirtualMachineArgs:
378
356
  @pulumi.getter(name="alternateGuestName")
379
357
  def alternate_guest_name(self) -> Optional[pulumi.Input[str]]:
380
358
  """
381
- The guest name for the operating system when `guest_id` is `otherGuest` or `otherGuest64`.
359
+ The guest name for the operating system when guest_id is otherGuest or otherGuest64.
382
360
  """
383
361
  return pulumi.get(self, "alternate_guest_name")
384
362
 
@@ -390,7 +368,7 @@ class VirtualMachineArgs:
390
368
  @pulumi.getter
391
369
  def annotation(self) -> Optional[pulumi.Input[str]]:
392
370
  """
393
- A user-provided description of the virtual machine.
371
+ User-provided description of the virtual machine.
394
372
  """
395
373
  return pulumi.get(self, "annotation")
396
374
 
@@ -402,7 +380,7 @@ class VirtualMachineArgs:
402
380
  @pulumi.getter(name="bootDelay")
403
381
  def boot_delay(self) -> Optional[pulumi.Input[int]]:
404
382
  """
405
- The number of milliseconds to wait before starting the boot sequence. The default is no delay.
383
+ The number of milliseconds to wait before starting the boot sequence.
406
384
  """
407
385
  return pulumi.get(self, "boot_delay")
408
386
 
@@ -414,7 +392,7 @@ class VirtualMachineArgs:
414
392
  @pulumi.getter(name="bootRetryDelay")
415
393
  def boot_retry_delay(self) -> Optional[pulumi.Input[int]]:
416
394
  """
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).
395
+ The number of milliseconds to wait before retrying the boot sequence. This only valid if boot_retry_enabled is true.
418
396
  """
419
397
  return pulumi.get(self, "boot_retry_delay")
420
398
 
@@ -426,7 +404,7 @@ class VirtualMachineArgs:
426
404
  @pulumi.getter(name="bootRetryEnabled")
427
405
  def boot_retry_enabled(self) -> Optional[pulumi.Input[bool]]:
428
406
  """
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`.
407
+ If set to true, a virtual machine that fails to boot will try again after the delay defined in boot_retry_delay.
430
408
  """
431
409
  return pulumi.get(self, "boot_retry_enabled")
432
410
 
@@ -438,7 +416,7 @@ class VirtualMachineArgs:
438
416
  @pulumi.getter
439
417
  def cdroms(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['VirtualMachineCdromArgs']]]]:
440
418
  """
441
- A specification for a CD-ROM device on the virtual machine. See CD-ROM options for more information.
419
+ A specification for a CDROM device on this virtual machine.
442
420
  """
443
421
  return pulumi.get(self, "cdroms")
444
422
 
@@ -450,7 +428,7 @@ class VirtualMachineArgs:
450
428
  @pulumi.getter
451
429
  def clone(self) -> Optional[pulumi.Input['VirtualMachineCloneArgs']]:
452
430
  """
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.
431
+ A specification for cloning a virtual machine from template.
454
432
  """
455
433
  return pulumi.get(self, "clone")
456
434
 
@@ -462,7 +440,7 @@ class VirtualMachineArgs:
462
440
  @pulumi.getter(name="cpuHotAddEnabled")
463
441
  def cpu_hot_add_enabled(self) -> Optional[pulumi.Input[bool]]:
464
442
  """
465
- Allow CPUs to be added to the virtual machine while it is powered on.
443
+ Allow CPUs to be added to this virtual machine while it is running.
466
444
  """
467
445
  return pulumi.get(self, "cpu_hot_add_enabled")
468
446
 
@@ -474,7 +452,7 @@ class VirtualMachineArgs:
474
452
  @pulumi.getter(name="cpuHotRemoveEnabled")
475
453
  def cpu_hot_remove_enabled(self) -> Optional[pulumi.Input[bool]]:
476
454
  """
477
- Allow CPUs to be removed to the virtual machine while it is powered on.
455
+ Allow CPUs to be added to this virtual machine while it is running.
478
456
  """
479
457
  return pulumi.get(self, "cpu_hot_remove_enabled")
480
458
 
@@ -486,7 +464,8 @@ class VirtualMachineArgs:
486
464
  @pulumi.getter(name="cpuLimit")
487
465
  def cpu_limit(self) -> Optional[pulumi.Input[int]]:
488
466
  """
489
- The maximum amount of CPU (in MHz) that the virtual machine can consume, regardless of available resources. The default is no limit.
467
+ The maximum amount of memory (in MB) or CPU (in MHz) that this virtual machine can consume, regardless of available
468
+ resources.
490
469
  """
491
470
  return pulumi.get(self, "cpu_limit")
492
471
 
@@ -498,7 +477,7 @@ class VirtualMachineArgs:
498
477
  @pulumi.getter(name="cpuPerformanceCountersEnabled")
499
478
  def cpu_performance_counters_enabled(self) -> Optional[pulumi.Input[bool]]:
500
479
  """
501
- Enable CPU performance counters on the virtual machine. Default: `false`.
480
+ Enable CPU performance counters on this virtual machine.
502
481
  """
503
482
  return pulumi.get(self, "cpu_performance_counters_enabled")
504
483
 
@@ -510,7 +489,7 @@ class VirtualMachineArgs:
510
489
  @pulumi.getter(name="cpuReservation")
511
490
  def cpu_reservation(self) -> Optional[pulumi.Input[int]]:
512
491
  """
513
- The amount of CPU (in MHz) that the virtual machine is guaranteed. The default is no reservation.
492
+ The amount of memory (in MB) or CPU (in MHz) that this virtual machine is guaranteed.
514
493
  """
515
494
  return pulumi.get(self, "cpu_reservation")
516
495
 
@@ -522,7 +501,7 @@ class VirtualMachineArgs:
522
501
  @pulumi.getter(name="cpuShareCount")
523
502
  def cpu_share_count(self) -> Optional[pulumi.Input[int]]:
524
503
  """
525
- The number of CPU shares allocated to the virtual machine when the `cpu_share_level` is `custom`.
504
+ The amount of shares to allocate to cpu for a custom share level.
526
505
  """
527
506
  return pulumi.get(self, "cpu_share_count")
528
507
 
@@ -534,7 +513,7 @@ class VirtualMachineArgs:
534
513
  @pulumi.getter(name="cpuShareLevel")
535
514
  def cpu_share_level(self) -> Optional[pulumi.Input[str]]:
536
515
  """
537
- The allocation level for the virtual machine CPU resources. One of `high`, `low`, `normal`, or `custom`. Default: `custom`.
516
+ The allocation level for cpu resources. Can be one of high, low, normal, or custom.
538
517
  """
539
518
  return pulumi.get(self, "cpu_share_level")
540
519
 
@@ -546,9 +525,7 @@ class VirtualMachineArgs:
546
525
  @pulumi.getter(name="customAttributes")
547
526
  def custom_attributes(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]:
548
527
  """
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.
528
+ A list of custom attributes to set on this resource.
552
529
  """
553
530
  return pulumi.get(self, "custom_attributes")
554
531
 
@@ -560,7 +537,7 @@ class VirtualMachineArgs:
560
537
  @pulumi.getter(name="datacenterId")
561
538
  def datacenter_id(self) -> Optional[pulumi.Input[str]]:
562
539
  """
563
- The datacenter ID. Required only when deploying an OVF/OVA template.
540
+ The ID of the datacenter where the VM is to be created.
564
541
  """
565
542
  return pulumi.get(self, "datacenter_id")
566
543
 
@@ -572,13 +549,7 @@ class VirtualMachineArgs:
572
549
  @pulumi.getter(name="datastoreClusterId")
573
550
  def datastore_cluster_id(self) -> Optional[pulumi.Input[str]]:
574
551
  """
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.
552
+ The ID of a datastore cluster to put the virtual machine in.
582
553
  """
583
554
  return pulumi.get(self, "datastore_cluster_id")
584
555
 
@@ -590,7 +561,8 @@ class VirtualMachineArgs:
590
561
  @pulumi.getter(name="datastoreId")
591
562
  def datastore_id(self) -> Optional[pulumi.Input[str]]:
592
563
  """
593
- The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with `client_device`.
564
+ The ID of the virtual machine's datastore. The virtual machine configuration is placed here, along with any virtual
565
+ disks that are created without datastores.
594
566
  """
595
567
  return pulumi.get(self, "datastore_id")
596
568
 
@@ -602,7 +574,7 @@ class VirtualMachineArgs:
602
574
  @pulumi.getter
603
575
  def disks(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['VirtualMachineDiskArgs']]]]:
604
576
  """
605
- A specification for a virtual disk device on the virtual machine. See disk options for more information.
577
+ A specification for a virtual disk device on this virtual machine.
606
578
  """
607
579
  return pulumi.get(self, "disks")
608
580
 
@@ -614,9 +586,7 @@ class VirtualMachineArgs:
614
586
  @pulumi.getter(name="efiSecureBootEnabled")
615
587
  def efi_secure_boot_enabled(self) -> Optional[pulumi.Input[bool]]:
616
588
  """
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.
589
+ When the boot type set in firmware is efi, this enables EFI secure boot.
620
590
  """
621
591
  return pulumi.get(self, "efi_secure_boot_enabled")
622
592
 
@@ -628,7 +598,7 @@ class VirtualMachineArgs:
628
598
  @pulumi.getter(name="enableDiskUuid")
629
599
  def enable_disk_uuid(self) -> Optional[pulumi.Input[bool]]:
630
600
  """
631
- Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest. Default: `false`.
601
+ Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest.
632
602
  """
633
603
  return pulumi.get(self, "enable_disk_uuid")
634
604
 
@@ -640,7 +610,7 @@ class VirtualMachineArgs:
640
610
  @pulumi.getter(name="enableLogging")
641
611
  def enable_logging(self) -> Optional[pulumi.Input[bool]]:
642
612
  """
643
- Enable logging of virtual machine events to a log file stored in the virtual machine directory. Default: `false`.
613
+ Enable logging on this virtual machine.
644
614
  """
645
615
  return pulumi.get(self, "enable_logging")
646
616
 
@@ -652,7 +622,7 @@ class VirtualMachineArgs:
652
622
  @pulumi.getter(name="eptRviMode")
653
623
  def ept_rvi_mode(self) -> Optional[pulumi.Input[str]]:
654
624
  """
655
- The EPT/RVI (hardware memory virtualization) setting for the virtual machine. One of `automatic`, `on`, or `off`. Default: `automatic`.
625
+ The EPT/RVI (hardware memory virtualization) setting for this virtual machine. Can be one of automatic, on, or off.
656
626
  """
657
627
  return pulumi.get(self, "ept_rvi_mode")
658
628
 
@@ -664,9 +634,8 @@ class VirtualMachineArgs:
664
634
  @pulumi.getter(name="extraConfig")
665
635
  def extra_config(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]:
666
636
  """
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.
637
+ Extra configuration data for this virtual machine. Can be used to supply advanced parameters not normally in
638
+ configuration, such as instance metadata, or configuration data for OVF images.
670
639
  """
671
640
  return pulumi.get(self, "extra_config")
672
641
 
@@ -678,7 +647,7 @@ class VirtualMachineArgs:
678
647
  @pulumi.getter(name="extraConfigRebootRequired")
679
648
  def extra_config_reboot_required(self) -> Optional[pulumi.Input[bool]]:
680
649
  """
681
- Allow the virtual machine to be rebooted when a change to `extra_config` occurs. Default: `true`.
650
+ Allow the virtual machine to be rebooted when a change to `extra_config` occurs.
682
651
  """
683
652
  return pulumi.get(self, "extra_config_reboot_required")
684
653
 
@@ -690,7 +659,7 @@ class VirtualMachineArgs:
690
659
  @pulumi.getter
691
660
  def firmware(self) -> Optional[pulumi.Input[str]]:
692
661
  """
693
- The firmware for the virtual machine. One of `bios` or `efi`.
662
+ The firmware interface to use on the virtual machine. Can be one of bios or efi.
694
663
  """
695
664
  return pulumi.get(self, "firmware")
696
665
 
@@ -702,7 +671,7 @@ class VirtualMachineArgs:
702
671
  @pulumi.getter
703
672
  def folder(self) -> Optional[pulumi.Input[str]]:
704
673
  """
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`
674
+ The name of the folder to locate the virtual machine in.
706
675
  """
707
676
  return pulumi.get(self, "folder")
708
677
 
@@ -714,7 +683,7 @@ class VirtualMachineArgs:
714
683
  @pulumi.getter(name="forcePowerOff")
715
684
  def force_power_off(self) -> Optional[pulumi.Input[bool]]:
716
685
  """
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`.
686
+ Set to true to force power-off a virtual machine if a graceful guest shutdown failed for a necessary operation.
718
687
  """
719
688
  return pulumi.get(self, "force_power_off")
720
689
 
@@ -726,9 +695,7 @@ class VirtualMachineArgs:
726
695
  @pulumi.getter(name="guestId")
727
696
  def guest_id(self) -> Optional[pulumi.Input[str]]:
728
697
  """
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
698
+ The guest ID for the operating system.
732
699
  """
733
700
  return pulumi.get(self, "guest_id")
734
701
 
@@ -740,10 +707,7 @@ class VirtualMachineArgs:
740
707
  @pulumi.getter(name="hardwareVersion")
741
708
  def hardware_version(self) -> Optional[pulumi.Input[int]]:
742
709
  """
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
710
+ The hardware version for the virtual machine.
747
711
  """
748
712
  return pulumi.get(self, "hardware_version")
749
713
 
@@ -755,7 +719,7 @@ class VirtualMachineArgs:
755
719
  @pulumi.getter(name="hostSystemId")
756
720
  def host_system_id(self) -> Optional[pulumi.Input[str]]:
757
721
  """
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.
722
+ The ID of an optional host system to pin the virtual machine to.
759
723
  """
760
724
  return pulumi.get(self, "host_system_id")
761
725
 
@@ -767,7 +731,7 @@ class VirtualMachineArgs:
767
731
  @pulumi.getter(name="hvMode")
768
732
  def hv_mode(self) -> Optional[pulumi.Input[str]]:
769
733
  """
770
- The hardware virtualization (non-nested) setting for the virtual machine. One of `hvAuto`, `hvOn`, or `hvOff`. Default: `hvAuto`.
734
+ The (non-nested) hardware virtualization setting for this virtual machine. Can be one of hvAuto, hvOn, or hvOff.
771
735
  """
772
736
  return pulumi.get(self, "hv_mode")
773
737
 
@@ -779,7 +743,9 @@ class VirtualMachineArgs:
779
743
  @pulumi.getter(name="ideControllerCount")
780
744
  def ide_controller_count(self) -> Optional[pulumi.Input[int]]:
781
745
  """
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`.
746
+ The number of IDE controllers that Terraform manages on this virtual machine. This directly affects the amount of disks
747
+ you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove
748
+ controllers.
783
749
  """
784
750
  return pulumi.get(self, "ide_controller_count")
785
751
 
@@ -791,7 +757,7 @@ class VirtualMachineArgs:
791
757
  @pulumi.getter(name="ignoredGuestIps")
792
758
  def ignored_guest_ips(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
793
759
  """
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: `[]`.
760
+ List of IP addresses and CIDR networks to ignore while waiting for an IP
795
761
  """
796
762
  return pulumi.get(self, "ignored_guest_ips")
797
763
 
@@ -803,9 +769,9 @@ class VirtualMachineArgs:
803
769
  @pulumi.getter(name="latencySensitivity")
804
770
  def latency_sensitivity(self) -> Optional[pulumi.Input[str]]:
805
771
  """
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.
772
+ Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower
773
+ latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard
774
+ devices. Can be one of low, normal, medium, or high.
809
775
  """
810
776
  return pulumi.get(self, "latency_sensitivity")
811
777
 
@@ -817,7 +783,7 @@ class VirtualMachineArgs:
817
783
  @pulumi.getter
818
784
  def memory(self) -> Optional[pulumi.Input[int]]:
819
785
  """
820
- The memory size to assign to the virtual machine, in MB. Default: `1024` (1 GB).
786
+ The size of the virtual machine's memory, in MB.
821
787
  """
822
788
  return pulumi.get(self, "memory")
823
789
 
@@ -829,15 +795,7 @@ class VirtualMachineArgs:
829
795
  @pulumi.getter(name="memoryHotAddEnabled")
830
796
  def memory_hot_add_enabled(self) -> Optional[pulumi.Input[bool]]:
831
797
  """
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
798
+ Allow memory to be added to this virtual machine while it is running.
841
799
  """
842
800
  return pulumi.get(self, "memory_hot_add_enabled")
843
801
 
@@ -849,7 +807,8 @@ class VirtualMachineArgs:
849
807
  @pulumi.getter(name="memoryLimit")
850
808
  def memory_limit(self) -> Optional[pulumi.Input[int]]:
851
809
  """
852
- The maximum amount of memory (in MB) that th virtual machine can consume, regardless of available resources. The default is no limit.
810
+ The maximum amount of memory (in MB) or CPU (in MHz) that this virtual machine can consume, regardless of available
811
+ resources.
853
812
  """
854
813
  return pulumi.get(self, "memory_limit")
855
814
 
@@ -861,7 +820,7 @@ class VirtualMachineArgs:
861
820
  @pulumi.getter(name="memoryReservation")
862
821
  def memory_reservation(self) -> Optional[pulumi.Input[int]]:
863
822
  """
864
- The amount of memory (in MB) that the virtual machine is guaranteed. The default is no reservation.
823
+ The amount of memory (in MB) or CPU (in MHz) that this virtual machine is guaranteed.
865
824
  """
866
825
  return pulumi.get(self, "memory_reservation")
867
826
 
@@ -887,7 +846,7 @@ class VirtualMachineArgs:
887
846
  @pulumi.getter(name="memoryShareCount")
888
847
  def memory_share_count(self) -> Optional[pulumi.Input[int]]:
889
848
  """
890
- The number of memory shares allocated to the virtual machine when the `memory_share_level` is `custom`.
849
+ The amount of shares to allocate to memory for a custom share level.
891
850
  """
892
851
  return pulumi.get(self, "memory_share_count")
893
852
 
@@ -899,7 +858,7 @@ class VirtualMachineArgs:
899
858
  @pulumi.getter(name="memoryShareLevel")
900
859
  def memory_share_level(self) -> Optional[pulumi.Input[str]]:
901
860
  """
902
- The allocation level for the virtual machine memory resources. One of `high`, `low`, `normal`, or `custom`. Default: `custom`.
861
+ The allocation level for memory resources. Can be one of high, low, normal, or custom.
903
862
  """
904
863
  return pulumi.get(self, "memory_share_level")
905
864
 
@@ -911,7 +870,7 @@ class VirtualMachineArgs:
911
870
  @pulumi.getter(name="migrateWaitTimeout")
912
871
  def migrate_wait_timeout(self) -> Optional[pulumi.Input[int]]:
913
872
  """
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.
873
+ The amount of time, in minutes, to wait for a vMotion operation to complete before failing.
915
874
  """
916
875
  return pulumi.get(self, "migrate_wait_timeout")
917
876
 
@@ -923,7 +882,7 @@ class VirtualMachineArgs:
923
882
  @pulumi.getter
924
883
  def name(self) -> Optional[pulumi.Input[str]]:
925
884
  """
926
- The name of the virtual machine.
885
+ The name of this virtual machine.
927
886
  """
928
887
  return pulumi.get(self, "name")
929
888
 
@@ -935,7 +894,7 @@ class VirtualMachineArgs:
935
894
  @pulumi.getter(name="nestedHvEnabled")
936
895
  def nested_hv_enabled(self) -> Optional[pulumi.Input[bool]]:
937
896
  """
938
- Enable nested hardware virtualization on the virtual machine, facilitating nested virtualization in the guest operating system. Default: `false`.
897
+ Enable nested hardware virtualization on this virtual machine, facilitating nested virtualization in the guest.
939
898
  """
940
899
  return pulumi.get(self, "nested_hv_enabled")
941
900
 
@@ -947,7 +906,7 @@ class VirtualMachineArgs:
947
906
  @pulumi.getter(name="networkInterfaces")
948
907
  def network_interfaces(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['VirtualMachineNetworkInterfaceArgs']]]]:
949
908
  """
950
- A specification for a virtual NIC on the virtual machine. See network interface options for more information.
909
+ A specification for a virtual NIC on this virtual machine.
951
910
  """
952
911
  return pulumi.get(self, "network_interfaces")
953
912
 
@@ -959,7 +918,8 @@ class VirtualMachineArgs:
959
918
  @pulumi.getter(name="numCoresPerSocket")
960
919
  def num_cores_per_socket(self) -> Optional[pulumi.Input[int]]:
961
920
  """
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`.
921
+ The number of cores to distribute amongst the CPUs in this virtual machine. If specified, the value supplied to num_cpus
922
+ must be evenly divisible by this value.
963
923
  """
964
924
  return pulumi.get(self, "num_cores_per_socket")
965
925
 
@@ -971,7 +931,7 @@ class VirtualMachineArgs:
971
931
  @pulumi.getter(name="numCpus")
972
932
  def num_cpus(self) -> Optional[pulumi.Input[int]]:
973
933
  """
974
- The total number of virtual processor cores to assign to the virtual machine. Default: `1`.
934
+ The number of virtual processors to assign to this virtual machine.
975
935
  """
976
936
  return pulumi.get(self, "num_cpus")
977
937
 
@@ -983,7 +943,7 @@ class VirtualMachineArgs:
983
943
  @pulumi.getter(name="ovfDeploy")
984
944
  def ovf_deploy(self) -> Optional[pulumi.Input['VirtualMachineOvfDeployArgs']]:
985
945
  """
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.
946
+ A specification for deploying a virtual machine from ovf/ova template.
987
947
  """
988
948
  return pulumi.get(self, "ovf_deploy")
989
949
 
@@ -995,9 +955,7 @@ class VirtualMachineArgs:
995
955
  @pulumi.getter(name="pciDeviceIds")
996
956
  def pci_device_ids(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
997
957
  """
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.
958
+ A list of PCI passthrough devices
1001
959
  """
1002
960
  return pulumi.get(self, "pci_device_ids")
1003
961
 
@@ -1022,8 +980,6 @@ class VirtualMachineArgs:
1022
980
  def replace_trigger(self) -> Optional[pulumi.Input[str]]:
1023
981
  """
1024
982
  Triggers replacement of resource whenever it changes.
1025
-
1026
- For example, `replace_trigger = sha256(format("%s-%s",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
983
  """
1028
984
  return pulumi.get(self, "replace_trigger")
1029
985
 
@@ -1035,7 +991,7 @@ class VirtualMachineArgs:
1035
991
  @pulumi.getter(name="runToolsScriptsAfterPowerOn")
1036
992
  def run_tools_scripts_after_power_on(self) -> Optional[pulumi.Input[bool]]:
1037
993
  """
1038
- Enable post-power-on scripts to run when VMware Tools is installed. Default: `true`.
994
+ Enable the run of scripts after virtual machine power-on when VMware Tools is installed.
1039
995
  """
1040
996
  return pulumi.get(self, "run_tools_scripts_after_power_on")
1041
997
 
@@ -1047,7 +1003,7 @@ class VirtualMachineArgs:
1047
1003
  @pulumi.getter(name="runToolsScriptsAfterResume")
1048
1004
  def run_tools_scripts_after_resume(self) -> Optional[pulumi.Input[bool]]:
1049
1005
  """
1050
- Enable ost-resume scripts to run when VMware Tools is installed. Default: `true`.
1006
+ Enable the run of scripts after virtual machine resume when when VMware Tools is installed.
1051
1007
  """
1052
1008
  return pulumi.get(self, "run_tools_scripts_after_resume")
1053
1009
 
@@ -1059,7 +1015,7 @@ class VirtualMachineArgs:
1059
1015
  @pulumi.getter(name="runToolsScriptsBeforeGuestReboot")
1060
1016
  def run_tools_scripts_before_guest_reboot(self) -> Optional[pulumi.Input[bool]]:
1061
1017
  """
1062
- Enable pre-reboot scripts to run when VMware Tools is installed. Default: `false`.
1018
+ Enable the run of scripts before guest operating system reboot when VMware Tools is installed.
1063
1019
  """
1064
1020
  return pulumi.get(self, "run_tools_scripts_before_guest_reboot")
1065
1021
 
@@ -1071,7 +1027,7 @@ class VirtualMachineArgs:
1071
1027
  @pulumi.getter(name="runToolsScriptsBeforeGuestShutdown")
1072
1028
  def run_tools_scripts_before_guest_shutdown(self) -> Optional[pulumi.Input[bool]]:
1073
1029
  """
1074
- Enable pre-shutdown scripts to run when VMware Tools is installed. Default: `true`.
1030
+ Enable the run of scripts before guest operating system shutdown when VMware Tools is installed.
1075
1031
  """
1076
1032
  return pulumi.get(self, "run_tools_scripts_before_guest_shutdown")
1077
1033
 
@@ -1083,7 +1039,7 @@ class VirtualMachineArgs:
1083
1039
  @pulumi.getter(name="runToolsScriptsBeforeGuestStandby")
1084
1040
  def run_tools_scripts_before_guest_standby(self) -> Optional[pulumi.Input[bool]]:
1085
1041
  """
1086
- Enable pre-standby scripts to run when VMware Tools is installed. Default: `true`.
1042
+ Enable the run of scripts before guest operating system standby when VMware Tools is installed.
1087
1043
  """
1088
1044
  return pulumi.get(self, "run_tools_scripts_before_guest_standby")
1089
1045
 
@@ -1109,7 +1065,7 @@ class VirtualMachineArgs:
1109
1065
  @pulumi.getter(name="scsiBusSharing")
1110
1066
  def scsi_bus_sharing(self) -> Optional[pulumi.Input[str]]:
1111
1067
  """
1112
- The type of SCSI bus sharing for the virtual machine SCSI controller. One of `physicalSharing`, `virtualSharing`, and `noSharing`. Default: `noSharing`.
1068
+ Mode for sharing the SCSI bus. The modes are physicalSharing, virtualSharing, and noSharing.
1113
1069
  """
1114
1070
  return pulumi.get(self, "scsi_bus_sharing")
1115
1071
 
@@ -1135,7 +1091,7 @@ class VirtualMachineArgs:
1135
1091
  @pulumi.getter(name="scsiType")
1136
1092
  def scsi_type(self) -> Optional[pulumi.Input[str]]:
1137
1093
  """
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`.
1094
+ The type of SCSI bus this virtual machine will have. Can be one of lsilogic, lsilogic-sas or pvscsi.
1139
1095
  """
1140
1096
  return pulumi.get(self, "scsi_type")
1141
1097
 
@@ -1147,7 +1103,7 @@ class VirtualMachineArgs:
1147
1103
  @pulumi.getter(name="shutdownWaitTimeout")
1148
1104
  def shutdown_wait_timeout(self) -> Optional[pulumi.Input[int]]:
1149
1105
  """
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.
1106
+ The amount of time, in minutes, to wait for shutdown when making necessary updates to the virtual machine.
1151
1107
  """
1152
1108
  return pulumi.get(self, "shutdown_wait_timeout")
1153
1109
 
@@ -1159,7 +1115,7 @@ class VirtualMachineArgs:
1159
1115
  @pulumi.getter(name="storagePolicyId")
1160
1116
  def storage_policy_id(self) -> Optional[pulumi.Input[str]]:
1161
1117
  """
1162
- The UUID of the storage policy to assign to the virtual disk.
1118
+ The ID of the storage policy to assign to the virtual machine home directory.
1163
1119
  """
1164
1120
  return pulumi.get(self, "storage_policy_id")
1165
1121
 
@@ -1171,7 +1127,7 @@ class VirtualMachineArgs:
1171
1127
  @pulumi.getter(name="swapPlacementPolicy")
1172
1128
  def swap_placement_policy(self) -> Optional[pulumi.Input[str]]:
1173
1129
  """
1174
- The swap file placement policy for the virtual machine. One of `inherit`, `hostLocal`, or `vmDirectory`. Default: `inherit`.
1130
+ The swap file placement policy for this virtual machine. Can be one of inherit, hostLocal, or vmDirectory.
1175
1131
  """
1176
1132
  return pulumi.get(self, "swap_placement_policy")
1177
1133
 
@@ -1183,7 +1139,8 @@ class VirtualMachineArgs:
1183
1139
  @pulumi.getter(name="syncTimeWithHost")
1184
1140
  def sync_time_with_host(self) -> Optional[pulumi.Input[bool]]:
1185
1141
  """
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`.
1142
+ Enable guest clock synchronization with the host. On vSphere 7.0 U1 and above, with only this setting the clock is
1143
+ synchronized on startup and resume. Requires VMware Tools to be installed.
1187
1144
  """
1188
1145
  return pulumi.get(self, "sync_time_with_host")
1189
1146
 
@@ -1195,7 +1152,8 @@ class VirtualMachineArgs:
1195
1152
  @pulumi.getter(name="syncTimeWithHostPeriodically")
1196
1153
  def sync_time_with_host_periodically(self) -> Optional[pulumi.Input[bool]]:
1197
1154
  """
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`.
1155
+ Enable periodic clock synchronization with the host. Supported only on vSphere 7.0 U1 and above. On prior versions
1156
+ setting `sync_time_with_host` is enough for periodic synchronization. Requires VMware Tools to be installed.
1199
1157
  """
1200
1158
  return pulumi.get(self, "sync_time_with_host_periodically")
1201
1159
 
@@ -1207,9 +1165,7 @@ class VirtualMachineArgs:
1207
1165
  @pulumi.getter
1208
1166
  def tags(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
1209
1167
  """
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.
1168
+ A list of tag IDs to apply to this object.
1213
1169
  """
1214
1170
  return pulumi.get(self, "tags")
1215
1171
 
@@ -1221,7 +1177,7 @@ class VirtualMachineArgs:
1221
1177
  @pulumi.getter(name="toolsUpgradePolicy")
1222
1178
  def tools_upgrade_policy(self) -> Optional[pulumi.Input[str]]:
1223
1179
  """
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`.
1180
+ Set the upgrade policy for VMware Tools. Can be one of `manual` or `upgradeAtPowerCycle`.
1225
1181
  """
1226
1182
  return pulumi.get(self, "tools_upgrade_policy")
1227
1183
 
@@ -1233,7 +1189,7 @@ class VirtualMachineArgs:
1233
1189
  @pulumi.getter
1234
1190
  def vapp(self) -> Optional[pulumi.Input['VirtualMachineVappArgs']]:
1235
1191
  """
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.
1192
+ vApp configuration data for this virtual machine. Can be used to provide configuration data for OVF images.
1237
1193
  """
1238
1194
  return pulumi.get(self, "vapp")
1239
1195
 
@@ -1245,7 +1201,7 @@ class VirtualMachineArgs:
1245
1201
  @pulumi.getter(name="vbsEnabled")
1246
1202
  def vbs_enabled(self) -> Optional[pulumi.Input[bool]]:
1247
1203
  """
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`.
1204
+ Flag to specify if Virtualization-based security is enabled for this virtual machine.
1249
1205
  """
1250
1206
  return pulumi.get(self, "vbs_enabled")
1251
1207
 
@@ -1257,7 +1213,8 @@ class VirtualMachineArgs:
1257
1213
  @pulumi.getter(name="vvtdEnabled")
1258
1214
  def vvtd_enabled(self) -> Optional[pulumi.Input[bool]]:
1259
1215
  """
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`.
1216
+ Flag to specify if I/O MMU virtualization, also called Intel Virtualization Technology for Directed I/O (VT-d) and AMD
1217
+ I/O Virtualization (AMD-Vi or IOMMU), is enabled.
1261
1218
  """
1262
1219
  return pulumi.get(self, "vvtd_enabled")
1263
1220
 
@@ -1269,7 +1226,8 @@ class VirtualMachineArgs:
1269
1226
  @pulumi.getter(name="waitForGuestIpTimeout")
1270
1227
  def wait_for_guest_ip_timeout(self) -> Optional[pulumi.Input[int]]:
1271
1228
  """
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`.
1229
+ The amount of time, in minutes, to wait for an available IP address on this virtual machine. A value less than 1
1230
+ disables the waiter.
1273
1231
  """
1274
1232
  return pulumi.get(self, "wait_for_guest_ip_timeout")
1275
1233
 
@@ -1281,7 +1239,8 @@ class VirtualMachineArgs:
1281
1239
  @pulumi.getter(name="waitForGuestNetRoutable")
1282
1240
  def wait_for_guest_net_routable(self) -> Optional[pulumi.Input[bool]]:
1283
1241
  """
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`.
1242
+ Controls whether or not the guest network waiter waits for a routable address. When false, the waiter does not wait for
1243
+ a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria.
1285
1244
  """
1286
1245
  return pulumi.get(self, "wait_for_guest_net_routable")
1287
1246
 
@@ -1293,7 +1252,8 @@ class VirtualMachineArgs:
1293
1252
  @pulumi.getter(name="waitForGuestNetTimeout")
1294
1253
  def wait_for_guest_net_timeout(self) -> Optional[pulumi.Input[int]]:
1295
1254
  """
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.
1255
+ The amount of time, in minutes, to wait for an available IP address on this virtual machine. A value less than 1
1256
+ disables the waiter.
1297
1257
  """
1298
1258
  return pulumi.get(self, "wait_for_guest_net_timeout")
1299
1259
 
@@ -1393,133 +1353,113 @@ class _VirtualMachineState:
1393
1353
  wait_for_guest_net_timeout: Optional[pulumi.Input[int]] = None):
1394
1354
  """
1395
1355
  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.
1356
+ :param pulumi.Input[str] alternate_guest_name: The guest name for the operating system when guest_id is otherGuest or otherGuest64.
1357
+ :param pulumi.Input[str] annotation: User-provided description of the virtual machine.
1358
+ :param pulumi.Input[int] boot_delay: The number of milliseconds to wait before starting the boot sequence.
1359
+ :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.
1360
+ :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.
1361
+ :param pulumi.Input[Sequence[pulumi.Input['VirtualMachineCdromArgs']]] cdroms: A specification for a CDROM device on this virtual machine.
1402
1362
  :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`.
1363
+ :param pulumi.Input['VirtualMachineCloneArgs'] clone: A specification for cloning a virtual machine from template.
1364
+ :param pulumi.Input[bool] cpu_hot_add_enabled: Allow CPUs to be added to this virtual machine while it is running.
1365
+ :param pulumi.Input[bool] cpu_hot_remove_enabled: Allow CPUs to be added to this virtual machine while it is running.
1366
+ :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
1367
+ resources.
1368
+ :param pulumi.Input[bool] cpu_performance_counters_enabled: Enable CPU performance counters on this virtual machine.
1369
+ :param pulumi.Input[int] cpu_reservation: The amount of memory (in MB) or CPU (in MHz) that this virtual machine is guaranteed.
1370
+ :param pulumi.Input[int] cpu_share_count: The amount of shares to allocate to cpu for a custom share level.
1371
+ :param pulumi.Input[str] cpu_share_level: The allocation level for cpu resources. Can be one of high, low, normal, or custom.
1372
+ :param pulumi.Input[Mapping[str, pulumi.Input[str]]] custom_attributes: A list of custom attributes to set on this resource.
1373
+ :param pulumi.Input[str] datacenter_id: The ID of the datacenter where the VM is to be created.
1374
+ :param pulumi.Input[str] datastore_cluster_id: The ID of a datastore cluster to put the virtual machine in.
1375
+ :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
1376
+ disks that are created without datastores.
1423
1377
  :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
1378
+ :param pulumi.Input[Sequence[pulumi.Input['VirtualMachineDiskArgs']]] disks: A specification for a virtual disk device on this virtual machine.
1379
+ :param pulumi.Input[bool] efi_secure_boot_enabled: When the boot type set in firmware is efi, this enables EFI secure boot.
1380
+ :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.
1381
+ :param pulumi.Input[bool] enable_logging: Enable logging on this virtual machine.
1382
+ :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.
1383
+ :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
1384
+ configuration, such as instance metadata, or configuration data for OVF images.
1385
+ :param pulumi.Input[bool] extra_config_reboot_required: Allow the virtual machine to be rebooted when a change to `extra_config` occurs.
1386
+ :param pulumi.Input[str] firmware: The firmware interface to use on the virtual machine. Can be one of bios or efi.
1387
+ :param pulumi.Input[str] folder: The name of the folder to locate the virtual machine in.
1388
+ :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.
1389
+ :param pulumi.Input[str] guest_id: The guest ID for the operating system.
1441
1390
  :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: `[]`.
1391
+ :param pulumi.Input[int] hardware_version: The hardware version for the virtual machine.
1392
+ :param pulumi.Input[str] host_system_id: The ID of an optional host system to pin the virtual machine to.
1393
+ :param pulumi.Input[str] hv_mode: The (non-nested) hardware virtualization setting for this virtual machine. Can be one of hvAuto, hvOn, or hvOff.
1394
+ :param pulumi.Input[int] ide_controller_count: The number of IDE controllers that Terraform manages on this virtual machine. This directly affects the amount of disks
1395
+ you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove
1396
+ controllers.
1397
+ :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
1398
  :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.
1399
+ :param pulumi.Input[str] latency_sensitivity: Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower
1400
+ latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard
1401
+ devices. Can be one of low, normal, medium, or high.
1402
+ :param pulumi.Input[int] memory: The size of the virtual machine's memory, in MB.
1403
+ :param pulumi.Input[bool] memory_hot_add_enabled: Allow memory to be added to this virtual machine while it is running.
1404
+ :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
1405
+ resources.
1406
+ :param pulumi.Input[int] memory_reservation: The amount of memory (in MB) or CPU (in MHz) that this virtual machine is guaranteed.
1466
1407
  :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
1408
  size;increases in memory size will be rejected when a corresponding reservation increase is not possible. This feature
1468
1409
  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.
1410
+ :param pulumi.Input[int] memory_share_count: The amount of shares to allocate to memory for a custom share level.
1411
+ :param pulumi.Input[str] memory_share_level: The allocation level for memory resources. Can be one of high, low, normal, or custom.
1412
+ :param pulumi.Input[int] migrate_wait_timeout: The amount of time, in minutes, to wait for a vMotion operation to complete before failing.
1472
1413
  :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.
1414
+ :param pulumi.Input[str] name: The name of this virtual machine.
1415
+ :param pulumi.Input[bool] nested_hv_enabled: Enable nested hardware virtualization on this virtual machine, facilitating nested virtualization in the guest.
1416
+ :param pulumi.Input[Sequence[pulumi.Input['VirtualMachineNetworkInterfaceArgs']]] network_interfaces: A specification for a virtual NIC on this virtual machine.
1417
+ :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
1418
+ must be evenly divisible by this value.
1419
+ :param pulumi.Input[int] num_cpus: The number of virtual processors to assign to this virtual machine.
1420
+ :param pulumi.Input['VirtualMachineOvfDeployArgs'] ovf_deploy: A specification for deploying a virtual machine from ovf/ova template.
1421
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] pci_device_ids: A list of PCI passthrough devices
1482
1422
  :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
1423
  :param pulumi.Input[int] poweron_timeout: The amount of time, in seconds, that we will be trying to power on a VM
1484
1424
  :param pulumi.Input[bool] reboot_required: Value internal to Terraform used to determine if a configuration set change requires a reboot.
1485
1425
  :param pulumi.Input[str] replace_trigger: Triggers replacement of resource whenever it changes.
1486
-
1487
- For example, `replace_trigger = sha256(format("%s-%s",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`.
1426
+ :param pulumi.Input[str] resource_pool_id: The ID of a resource pool to put the virtual machine in.
1427
+ :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.
1428
+ :param pulumi.Input[bool] run_tools_scripts_after_resume: Enable the run of scripts after virtual machine resume when when VMware Tools is installed.
1429
+ :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.
1430
+ :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.
1431
+ :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.
1496
1432
  :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
1433
  you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove
1498
1434
  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`.
1435
+ :param pulumi.Input[str] scsi_bus_sharing: Mode for sharing the SCSI bus. The modes are physicalSharing, virtualSharing, and noSharing.
1500
1436
  :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
1437
  you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove
1502
1438
  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.
1439
+ :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.
1440
+ :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.
1441
+ :param pulumi.Input[str] storage_policy_id: The ID of the storage policy to assign to the virtual machine home directory.
1442
+ :param pulumi.Input[str] swap_placement_policy: The swap file placement policy for this virtual machine. Can be one of inherit, hostLocal, or vmDirectory.
1443
+ :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
1444
+ synchronized on startup and resume. Requires VMware Tools to be installed.
1445
+ :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
1446
+ setting `sync_time_with_host` is enough for periodic synchronization. Requires VMware Tools to be installed.
1447
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] tags: A list of tag IDs to apply to this object.
1448
+ :param pulumi.Input[str] tools_upgrade_policy: Set the upgrade policy for VMware Tools. Can be one of `manual` or `upgradeAtPowerCycle`.
1449
+ :param pulumi.Input[str] uuid: The UUID of the virtual machine. Also exposed as the `id` of the resource.
1450
+ :param pulumi.Input['VirtualMachineVappArgs'] vapp: vApp configuration data for this virtual machine. Can be used to provide configuration data for OVF images.
1515
1451
  :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`.
1452
+ :param pulumi.Input[bool] vbs_enabled: Flag to specify if Virtualization-based security is enabled for this virtual machine.
1517
1453
  :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
1454
  :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.
1455
+ :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
1456
+ I/O Virtualization (AMD-Vi or IOMMU), is enabled.
1457
+ :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
1458
+ disables the waiter.
1459
+ :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
1460
+ a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria.
1461
+ :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
1462
+ disables the waiter.
1523
1463
  """
1524
1464
  if alternate_guest_name is not None:
1525
1465
  pulumi.set(__self__, "alternate_guest_name", alternate_guest_name)
@@ -1698,7 +1638,7 @@ class _VirtualMachineState:
1698
1638
  @pulumi.getter(name="alternateGuestName")
1699
1639
  def alternate_guest_name(self) -> Optional[pulumi.Input[str]]:
1700
1640
  """
1701
- The guest name for the operating system when `guest_id` is `otherGuest` or `otherGuest64`.
1641
+ The guest name for the operating system when guest_id is otherGuest or otherGuest64.
1702
1642
  """
1703
1643
  return pulumi.get(self, "alternate_guest_name")
1704
1644
 
@@ -1710,7 +1650,7 @@ class _VirtualMachineState:
1710
1650
  @pulumi.getter
1711
1651
  def annotation(self) -> Optional[pulumi.Input[str]]:
1712
1652
  """
1713
- A user-provided description of the virtual machine.
1653
+ User-provided description of the virtual machine.
1714
1654
  """
1715
1655
  return pulumi.get(self, "annotation")
1716
1656
 
@@ -1722,7 +1662,7 @@ class _VirtualMachineState:
1722
1662
  @pulumi.getter(name="bootDelay")
1723
1663
  def boot_delay(self) -> Optional[pulumi.Input[int]]:
1724
1664
  """
1725
- The number of milliseconds to wait before starting the boot sequence. The default is no delay.
1665
+ The number of milliseconds to wait before starting the boot sequence.
1726
1666
  """
1727
1667
  return pulumi.get(self, "boot_delay")
1728
1668
 
@@ -1734,7 +1674,7 @@ class _VirtualMachineState:
1734
1674
  @pulumi.getter(name="bootRetryDelay")
1735
1675
  def boot_retry_delay(self) -> Optional[pulumi.Input[int]]:
1736
1676
  """
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).
1677
+ The number of milliseconds to wait before retrying the boot sequence. This only valid if boot_retry_enabled is true.
1738
1678
  """
1739
1679
  return pulumi.get(self, "boot_retry_delay")
1740
1680
 
@@ -1746,7 +1686,7 @@ class _VirtualMachineState:
1746
1686
  @pulumi.getter(name="bootRetryEnabled")
1747
1687
  def boot_retry_enabled(self) -> Optional[pulumi.Input[bool]]:
1748
1688
  """
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`.
1689
+ If set to true, a virtual machine that fails to boot will try again after the delay defined in boot_retry_delay.
1750
1690
  """
1751
1691
  return pulumi.get(self, "boot_retry_enabled")
1752
1692
 
@@ -1758,7 +1698,7 @@ class _VirtualMachineState:
1758
1698
  @pulumi.getter
1759
1699
  def cdroms(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['VirtualMachineCdromArgs']]]]:
1760
1700
  """
1761
- A specification for a CD-ROM device on the virtual machine. See CD-ROM options for more information.
1701
+ A specification for a CDROM device on this virtual machine.
1762
1702
  """
1763
1703
  return pulumi.get(self, "cdroms")
1764
1704
 
@@ -1782,7 +1722,7 @@ class _VirtualMachineState:
1782
1722
  @pulumi.getter
1783
1723
  def clone(self) -> Optional[pulumi.Input['VirtualMachineCloneArgs']]:
1784
1724
  """
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.
1725
+ A specification for cloning a virtual machine from template.
1786
1726
  """
1787
1727
  return pulumi.get(self, "clone")
1788
1728
 
@@ -1794,7 +1734,7 @@ class _VirtualMachineState:
1794
1734
  @pulumi.getter(name="cpuHotAddEnabled")
1795
1735
  def cpu_hot_add_enabled(self) -> Optional[pulumi.Input[bool]]:
1796
1736
  """
1797
- Allow CPUs to be added to the virtual machine while it is powered on.
1737
+ Allow CPUs to be added to this virtual machine while it is running.
1798
1738
  """
1799
1739
  return pulumi.get(self, "cpu_hot_add_enabled")
1800
1740
 
@@ -1806,7 +1746,7 @@ class _VirtualMachineState:
1806
1746
  @pulumi.getter(name="cpuHotRemoveEnabled")
1807
1747
  def cpu_hot_remove_enabled(self) -> Optional[pulumi.Input[bool]]:
1808
1748
  """
1809
- Allow CPUs to be removed to the virtual machine while it is powered on.
1749
+ Allow CPUs to be added to this virtual machine while it is running.
1810
1750
  """
1811
1751
  return pulumi.get(self, "cpu_hot_remove_enabled")
1812
1752
 
@@ -1818,7 +1758,8 @@ class _VirtualMachineState:
1818
1758
  @pulumi.getter(name="cpuLimit")
1819
1759
  def cpu_limit(self) -> Optional[pulumi.Input[int]]:
1820
1760
  """
1821
- The maximum amount of CPU (in MHz) that the virtual machine can consume, regardless of available resources. The default is no limit.
1761
+ The maximum amount of memory (in MB) or CPU (in MHz) that this virtual machine can consume, regardless of available
1762
+ resources.
1822
1763
  """
1823
1764
  return pulumi.get(self, "cpu_limit")
1824
1765
 
@@ -1830,7 +1771,7 @@ class _VirtualMachineState:
1830
1771
  @pulumi.getter(name="cpuPerformanceCountersEnabled")
1831
1772
  def cpu_performance_counters_enabled(self) -> Optional[pulumi.Input[bool]]:
1832
1773
  """
1833
- Enable CPU performance counters on the virtual machine. Default: `false`.
1774
+ Enable CPU performance counters on this virtual machine.
1834
1775
  """
1835
1776
  return pulumi.get(self, "cpu_performance_counters_enabled")
1836
1777
 
@@ -1842,7 +1783,7 @@ class _VirtualMachineState:
1842
1783
  @pulumi.getter(name="cpuReservation")
1843
1784
  def cpu_reservation(self) -> Optional[pulumi.Input[int]]:
1844
1785
  """
1845
- The amount of CPU (in MHz) that the virtual machine is guaranteed. The default is no reservation.
1786
+ The amount of memory (in MB) or CPU (in MHz) that this virtual machine is guaranteed.
1846
1787
  """
1847
1788
  return pulumi.get(self, "cpu_reservation")
1848
1789
 
@@ -1854,7 +1795,7 @@ class _VirtualMachineState:
1854
1795
  @pulumi.getter(name="cpuShareCount")
1855
1796
  def cpu_share_count(self) -> Optional[pulumi.Input[int]]:
1856
1797
  """
1857
- The number of CPU shares allocated to the virtual machine when the `cpu_share_level` is `custom`.
1798
+ The amount of shares to allocate to cpu for a custom share level.
1858
1799
  """
1859
1800
  return pulumi.get(self, "cpu_share_count")
1860
1801
 
@@ -1866,7 +1807,7 @@ class _VirtualMachineState:
1866
1807
  @pulumi.getter(name="cpuShareLevel")
1867
1808
  def cpu_share_level(self) -> Optional[pulumi.Input[str]]:
1868
1809
  """
1869
- The allocation level for the virtual machine CPU resources. One of `high`, `low`, `normal`, or `custom`. Default: `custom`.
1810
+ The allocation level for cpu resources. Can be one of high, low, normal, or custom.
1870
1811
  """
1871
1812
  return pulumi.get(self, "cpu_share_level")
1872
1813
 
@@ -1878,9 +1819,7 @@ class _VirtualMachineState:
1878
1819
  @pulumi.getter(name="customAttributes")
1879
1820
  def custom_attributes(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]:
1880
1821
  """
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.
1822
+ A list of custom attributes to set on this resource.
1884
1823
  """
1885
1824
  return pulumi.get(self, "custom_attributes")
1886
1825
 
@@ -1892,7 +1831,7 @@ class _VirtualMachineState:
1892
1831
  @pulumi.getter(name="datacenterId")
1893
1832
  def datacenter_id(self) -> Optional[pulumi.Input[str]]:
1894
1833
  """
1895
- The datacenter ID. Required only when deploying an OVF/OVA template.
1834
+ The ID of the datacenter where the VM is to be created.
1896
1835
  """
1897
1836
  return pulumi.get(self, "datacenter_id")
1898
1837
 
@@ -1904,13 +1843,7 @@ class _VirtualMachineState:
1904
1843
  @pulumi.getter(name="datastoreClusterId")
1905
1844
  def datastore_cluster_id(self) -> Optional[pulumi.Input[str]]:
1906
1845
  """
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.
1846
+ The ID of a datastore cluster to put the virtual machine in.
1914
1847
  """
1915
1848
  return pulumi.get(self, "datastore_cluster_id")
1916
1849
 
@@ -1922,7 +1855,8 @@ class _VirtualMachineState:
1922
1855
  @pulumi.getter(name="datastoreId")
1923
1856
  def datastore_id(self) -> Optional[pulumi.Input[str]]:
1924
1857
  """
1925
- The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with `client_device`.
1858
+ The ID of the virtual machine's datastore. The virtual machine configuration is placed here, along with any virtual
1859
+ disks that are created without datastores.
1926
1860
  """
1927
1861
  return pulumi.get(self, "datastore_id")
1928
1862
 
@@ -1946,7 +1880,7 @@ class _VirtualMachineState:
1946
1880
  @pulumi.getter
1947
1881
  def disks(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['VirtualMachineDiskArgs']]]]:
1948
1882
  """
1949
- A specification for a virtual disk device on the virtual machine. See disk options for more information.
1883
+ A specification for a virtual disk device on this virtual machine.
1950
1884
  """
1951
1885
  return pulumi.get(self, "disks")
1952
1886
 
@@ -1958,9 +1892,7 @@ class _VirtualMachineState:
1958
1892
  @pulumi.getter(name="efiSecureBootEnabled")
1959
1893
  def efi_secure_boot_enabled(self) -> Optional[pulumi.Input[bool]]:
1960
1894
  """
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.
1895
+ When the boot type set in firmware is efi, this enables EFI secure boot.
1964
1896
  """
1965
1897
  return pulumi.get(self, "efi_secure_boot_enabled")
1966
1898
 
@@ -1972,7 +1904,7 @@ class _VirtualMachineState:
1972
1904
  @pulumi.getter(name="enableDiskUuid")
1973
1905
  def enable_disk_uuid(self) -> Optional[pulumi.Input[bool]]:
1974
1906
  """
1975
- Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest. Default: `false`.
1907
+ Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest.
1976
1908
  """
1977
1909
  return pulumi.get(self, "enable_disk_uuid")
1978
1910
 
@@ -1984,7 +1916,7 @@ class _VirtualMachineState:
1984
1916
  @pulumi.getter(name="enableLogging")
1985
1917
  def enable_logging(self) -> Optional[pulumi.Input[bool]]:
1986
1918
  """
1987
- Enable logging of virtual machine events to a log file stored in the virtual machine directory. Default: `false`.
1919
+ Enable logging on this virtual machine.
1988
1920
  """
1989
1921
  return pulumi.get(self, "enable_logging")
1990
1922
 
@@ -1996,7 +1928,7 @@ class _VirtualMachineState:
1996
1928
  @pulumi.getter(name="eptRviMode")
1997
1929
  def ept_rvi_mode(self) -> Optional[pulumi.Input[str]]:
1998
1930
  """
1999
- The EPT/RVI (hardware memory virtualization) setting for the virtual machine. One of `automatic`, `on`, or `off`. Default: `automatic`.
1931
+ The EPT/RVI (hardware memory virtualization) setting for this virtual machine. Can be one of automatic, on, or off.
2000
1932
  """
2001
1933
  return pulumi.get(self, "ept_rvi_mode")
2002
1934
 
@@ -2008,9 +1940,8 @@ class _VirtualMachineState:
2008
1940
  @pulumi.getter(name="extraConfig")
2009
1941
  def extra_config(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]:
2010
1942
  """
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.
1943
+ Extra configuration data for this virtual machine. Can be used to supply advanced parameters not normally in
1944
+ configuration, such as instance metadata, or configuration data for OVF images.
2014
1945
  """
2015
1946
  return pulumi.get(self, "extra_config")
2016
1947
 
@@ -2022,7 +1953,7 @@ class _VirtualMachineState:
2022
1953
  @pulumi.getter(name="extraConfigRebootRequired")
2023
1954
  def extra_config_reboot_required(self) -> Optional[pulumi.Input[bool]]:
2024
1955
  """
2025
- Allow the virtual machine to be rebooted when a change to `extra_config` occurs. Default: `true`.
1956
+ Allow the virtual machine to be rebooted when a change to `extra_config` occurs.
2026
1957
  """
2027
1958
  return pulumi.get(self, "extra_config_reboot_required")
2028
1959
 
@@ -2034,7 +1965,7 @@ class _VirtualMachineState:
2034
1965
  @pulumi.getter
2035
1966
  def firmware(self) -> Optional[pulumi.Input[str]]:
2036
1967
  """
2037
- The firmware for the virtual machine. One of `bios` or `efi`.
1968
+ The firmware interface to use on the virtual machine. Can be one of bios or efi.
2038
1969
  """
2039
1970
  return pulumi.get(self, "firmware")
2040
1971
 
@@ -2046,7 +1977,7 @@ class _VirtualMachineState:
2046
1977
  @pulumi.getter
2047
1978
  def folder(self) -> Optional[pulumi.Input[str]]:
2048
1979
  """
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`
1980
+ The name of the folder to locate the virtual machine in.
2050
1981
  """
2051
1982
  return pulumi.get(self, "folder")
2052
1983
 
@@ -2058,7 +1989,7 @@ class _VirtualMachineState:
2058
1989
  @pulumi.getter(name="forcePowerOff")
2059
1990
  def force_power_off(self) -> Optional[pulumi.Input[bool]]:
2060
1991
  """
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`.
1992
+ Set to true to force power-off a virtual machine if a graceful guest shutdown failed for a necessary operation.
2062
1993
  """
2063
1994
  return pulumi.get(self, "force_power_off")
2064
1995
 
@@ -2070,9 +2001,7 @@ class _VirtualMachineState:
2070
2001
  @pulumi.getter(name="guestId")
2071
2002
  def guest_id(self) -> Optional[pulumi.Input[str]]:
2072
2003
  """
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
2004
+ The guest ID for the operating system.
2076
2005
  """
2077
2006
  return pulumi.get(self, "guest_id")
2078
2007
 
@@ -2096,10 +2025,7 @@ class _VirtualMachineState:
2096
2025
  @pulumi.getter(name="hardwareVersion")
2097
2026
  def hardware_version(self) -> Optional[pulumi.Input[int]]:
2098
2027
  """
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
2028
+ The hardware version for the virtual machine.
2103
2029
  """
2104
2030
  return pulumi.get(self, "hardware_version")
2105
2031
 
@@ -2111,7 +2037,7 @@ class _VirtualMachineState:
2111
2037
  @pulumi.getter(name="hostSystemId")
2112
2038
  def host_system_id(self) -> Optional[pulumi.Input[str]]:
2113
2039
  """
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.
2040
+ The ID of an optional host system to pin the virtual machine to.
2115
2041
  """
2116
2042
  return pulumi.get(self, "host_system_id")
2117
2043
 
@@ -2123,7 +2049,7 @@ class _VirtualMachineState:
2123
2049
  @pulumi.getter(name="hvMode")
2124
2050
  def hv_mode(self) -> Optional[pulumi.Input[str]]:
2125
2051
  """
2126
- The hardware virtualization (non-nested) setting for the virtual machine. One of `hvAuto`, `hvOn`, or `hvOff`. Default: `hvAuto`.
2052
+ The (non-nested) hardware virtualization setting for this virtual machine. Can be one of hvAuto, hvOn, or hvOff.
2127
2053
  """
2128
2054
  return pulumi.get(self, "hv_mode")
2129
2055
 
@@ -2135,7 +2061,9 @@ class _VirtualMachineState:
2135
2061
  @pulumi.getter(name="ideControllerCount")
2136
2062
  def ide_controller_count(self) -> Optional[pulumi.Input[int]]:
2137
2063
  """
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`.
2064
+ The number of IDE controllers that Terraform manages on this virtual machine. This directly affects the amount of disks
2065
+ you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove
2066
+ controllers.
2139
2067
  """
2140
2068
  return pulumi.get(self, "ide_controller_count")
2141
2069
 
@@ -2147,7 +2075,7 @@ class _VirtualMachineState:
2147
2075
  @pulumi.getter(name="ignoredGuestIps")
2148
2076
  def ignored_guest_ips(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
2149
2077
  """
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: `[]`.
2078
+ List of IP addresses and CIDR networks to ignore while waiting for an IP
2151
2079
  """
2152
2080
  return pulumi.get(self, "ignored_guest_ips")
2153
2081
 
@@ -2171,9 +2099,9 @@ class _VirtualMachineState:
2171
2099
  @pulumi.getter(name="latencySensitivity")
2172
2100
  def latency_sensitivity(self) -> Optional[pulumi.Input[str]]:
2173
2101
  """
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.
2102
+ Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower
2103
+ latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard
2104
+ devices. Can be one of low, normal, medium, or high.
2177
2105
  """
2178
2106
  return pulumi.get(self, "latency_sensitivity")
2179
2107
 
@@ -2185,7 +2113,7 @@ class _VirtualMachineState:
2185
2113
  @pulumi.getter
2186
2114
  def memory(self) -> Optional[pulumi.Input[int]]:
2187
2115
  """
2188
- The memory size to assign to the virtual machine, in MB. Default: `1024` (1 GB).
2116
+ The size of the virtual machine's memory, in MB.
2189
2117
  """
2190
2118
  return pulumi.get(self, "memory")
2191
2119
 
@@ -2197,15 +2125,7 @@ class _VirtualMachineState:
2197
2125
  @pulumi.getter(name="memoryHotAddEnabled")
2198
2126
  def memory_hot_add_enabled(self) -> Optional[pulumi.Input[bool]]:
2199
2127
  """
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
2128
+ Allow memory to be added to this virtual machine while it is running.
2209
2129
  """
2210
2130
  return pulumi.get(self, "memory_hot_add_enabled")
2211
2131
 
@@ -2217,7 +2137,8 @@ class _VirtualMachineState:
2217
2137
  @pulumi.getter(name="memoryLimit")
2218
2138
  def memory_limit(self) -> Optional[pulumi.Input[int]]:
2219
2139
  """
2220
- The maximum amount of memory (in MB) that th virtual machine can consume, regardless of available resources. The default is no limit.
2140
+ The maximum amount of memory (in MB) or CPU (in MHz) that this virtual machine can consume, regardless of available
2141
+ resources.
2221
2142
  """
2222
2143
  return pulumi.get(self, "memory_limit")
2223
2144
 
@@ -2229,7 +2150,7 @@ class _VirtualMachineState:
2229
2150
  @pulumi.getter(name="memoryReservation")
2230
2151
  def memory_reservation(self) -> Optional[pulumi.Input[int]]:
2231
2152
  """
2232
- The amount of memory (in MB) that the virtual machine is guaranteed. The default is no reservation.
2153
+ The amount of memory (in MB) or CPU (in MHz) that this virtual machine is guaranteed.
2233
2154
  """
2234
2155
  return pulumi.get(self, "memory_reservation")
2235
2156
 
@@ -2255,7 +2176,7 @@ class _VirtualMachineState:
2255
2176
  @pulumi.getter(name="memoryShareCount")
2256
2177
  def memory_share_count(self) -> Optional[pulumi.Input[int]]:
2257
2178
  """
2258
- The number of memory shares allocated to the virtual machine when the `memory_share_level` is `custom`.
2179
+ The amount of shares to allocate to memory for a custom share level.
2259
2180
  """
2260
2181
  return pulumi.get(self, "memory_share_count")
2261
2182
 
@@ -2267,7 +2188,7 @@ class _VirtualMachineState:
2267
2188
  @pulumi.getter(name="memoryShareLevel")
2268
2189
  def memory_share_level(self) -> Optional[pulumi.Input[str]]:
2269
2190
  """
2270
- The allocation level for the virtual machine memory resources. One of `high`, `low`, `normal`, or `custom`. Default: `custom`.
2191
+ The allocation level for memory resources. Can be one of high, low, normal, or custom.
2271
2192
  """
2272
2193
  return pulumi.get(self, "memory_share_level")
2273
2194
 
@@ -2279,7 +2200,7 @@ class _VirtualMachineState:
2279
2200
  @pulumi.getter(name="migrateWaitTimeout")
2280
2201
  def migrate_wait_timeout(self) -> Optional[pulumi.Input[int]]:
2281
2202
  """
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.
2203
+ The amount of time, in minutes, to wait for a vMotion operation to complete before failing.
2283
2204
  """
2284
2205
  return pulumi.get(self, "migrate_wait_timeout")
2285
2206
 
@@ -2303,7 +2224,7 @@ class _VirtualMachineState:
2303
2224
  @pulumi.getter
2304
2225
  def name(self) -> Optional[pulumi.Input[str]]:
2305
2226
  """
2306
- The name of the virtual machine.
2227
+ The name of this virtual machine.
2307
2228
  """
2308
2229
  return pulumi.get(self, "name")
2309
2230
 
@@ -2315,7 +2236,7 @@ class _VirtualMachineState:
2315
2236
  @pulumi.getter(name="nestedHvEnabled")
2316
2237
  def nested_hv_enabled(self) -> Optional[pulumi.Input[bool]]:
2317
2238
  """
2318
- Enable nested hardware virtualization on the virtual machine, facilitating nested virtualization in the guest operating system. Default: `false`.
2239
+ Enable nested hardware virtualization on this virtual machine, facilitating nested virtualization in the guest.
2319
2240
  """
2320
2241
  return pulumi.get(self, "nested_hv_enabled")
2321
2242
 
@@ -2327,7 +2248,7 @@ class _VirtualMachineState:
2327
2248
  @pulumi.getter(name="networkInterfaces")
2328
2249
  def network_interfaces(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['VirtualMachineNetworkInterfaceArgs']]]]:
2329
2250
  """
2330
- A specification for a virtual NIC on the virtual machine. See network interface options for more information.
2251
+ A specification for a virtual NIC on this virtual machine.
2331
2252
  """
2332
2253
  return pulumi.get(self, "network_interfaces")
2333
2254
 
@@ -2339,7 +2260,8 @@ class _VirtualMachineState:
2339
2260
  @pulumi.getter(name="numCoresPerSocket")
2340
2261
  def num_cores_per_socket(self) -> Optional[pulumi.Input[int]]:
2341
2262
  """
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`.
2263
+ The number of cores to distribute amongst the CPUs in this virtual machine. If specified, the value supplied to num_cpus
2264
+ must be evenly divisible by this value.
2343
2265
  """
2344
2266
  return pulumi.get(self, "num_cores_per_socket")
2345
2267
 
@@ -2351,7 +2273,7 @@ class _VirtualMachineState:
2351
2273
  @pulumi.getter(name="numCpus")
2352
2274
  def num_cpus(self) -> Optional[pulumi.Input[int]]:
2353
2275
  """
2354
- The total number of virtual processor cores to assign to the virtual machine. Default: `1`.
2276
+ The number of virtual processors to assign to this virtual machine.
2355
2277
  """
2356
2278
  return pulumi.get(self, "num_cpus")
2357
2279
 
@@ -2363,7 +2285,7 @@ class _VirtualMachineState:
2363
2285
  @pulumi.getter(name="ovfDeploy")
2364
2286
  def ovf_deploy(self) -> Optional[pulumi.Input['VirtualMachineOvfDeployArgs']]:
2365
2287
  """
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.
2288
+ A specification for deploying a virtual machine from ovf/ova template.
2367
2289
  """
2368
2290
  return pulumi.get(self, "ovf_deploy")
2369
2291
 
@@ -2375,9 +2297,7 @@ class _VirtualMachineState:
2375
2297
  @pulumi.getter(name="pciDeviceIds")
2376
2298
  def pci_device_ids(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
2377
2299
  """
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.
2300
+ A list of PCI passthrough devices
2381
2301
  """
2382
2302
  return pulumi.get(self, "pci_device_ids")
2383
2303
 
@@ -2426,8 +2346,6 @@ class _VirtualMachineState:
2426
2346
  def replace_trigger(self) -> Optional[pulumi.Input[str]]:
2427
2347
  """
2428
2348
  Triggers replacement of resource whenever it changes.
2429
-
2430
- For example, `replace_trigger = sha256(format("%s-%s",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
2349
  """
2432
2350
  return pulumi.get(self, "replace_trigger")
2433
2351
 
@@ -2439,9 +2357,7 @@ class _VirtualMachineState:
2439
2357
  @pulumi.getter(name="resourcePoolId")
2440
2358
  def resource_pool_id(self) -> Optional[pulumi.Input[str]]:
2441
2359
  """
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.
2360
+ The ID of a resource pool to put the virtual machine in.
2445
2361
  """
2446
2362
  return pulumi.get(self, "resource_pool_id")
2447
2363
 
@@ -2453,7 +2369,7 @@ class _VirtualMachineState:
2453
2369
  @pulumi.getter(name="runToolsScriptsAfterPowerOn")
2454
2370
  def run_tools_scripts_after_power_on(self) -> Optional[pulumi.Input[bool]]:
2455
2371
  """
2456
- Enable post-power-on scripts to run when VMware Tools is installed. Default: `true`.
2372
+ Enable the run of scripts after virtual machine power-on when VMware Tools is installed.
2457
2373
  """
2458
2374
  return pulumi.get(self, "run_tools_scripts_after_power_on")
2459
2375
 
@@ -2465,7 +2381,7 @@ class _VirtualMachineState:
2465
2381
  @pulumi.getter(name="runToolsScriptsAfterResume")
2466
2382
  def run_tools_scripts_after_resume(self) -> Optional[pulumi.Input[bool]]:
2467
2383
  """
2468
- Enable ost-resume scripts to run when VMware Tools is installed. Default: `true`.
2384
+ Enable the run of scripts after virtual machine resume when when VMware Tools is installed.
2469
2385
  """
2470
2386
  return pulumi.get(self, "run_tools_scripts_after_resume")
2471
2387
 
@@ -2477,7 +2393,7 @@ class _VirtualMachineState:
2477
2393
  @pulumi.getter(name="runToolsScriptsBeforeGuestReboot")
2478
2394
  def run_tools_scripts_before_guest_reboot(self) -> Optional[pulumi.Input[bool]]:
2479
2395
  """
2480
- Enable pre-reboot scripts to run when VMware Tools is installed. Default: `false`.
2396
+ Enable the run of scripts before guest operating system reboot when VMware Tools is installed.
2481
2397
  """
2482
2398
  return pulumi.get(self, "run_tools_scripts_before_guest_reboot")
2483
2399
 
@@ -2489,7 +2405,7 @@ class _VirtualMachineState:
2489
2405
  @pulumi.getter(name="runToolsScriptsBeforeGuestShutdown")
2490
2406
  def run_tools_scripts_before_guest_shutdown(self) -> Optional[pulumi.Input[bool]]:
2491
2407
  """
2492
- Enable pre-shutdown scripts to run when VMware Tools is installed. Default: `true`.
2408
+ Enable the run of scripts before guest operating system shutdown when VMware Tools is installed.
2493
2409
  """
2494
2410
  return pulumi.get(self, "run_tools_scripts_before_guest_shutdown")
2495
2411
 
@@ -2501,7 +2417,7 @@ class _VirtualMachineState:
2501
2417
  @pulumi.getter(name="runToolsScriptsBeforeGuestStandby")
2502
2418
  def run_tools_scripts_before_guest_standby(self) -> Optional[pulumi.Input[bool]]:
2503
2419
  """
2504
- Enable pre-standby scripts to run when VMware Tools is installed. Default: `true`.
2420
+ Enable the run of scripts before guest operating system standby when VMware Tools is installed.
2505
2421
  """
2506
2422
  return pulumi.get(self, "run_tools_scripts_before_guest_standby")
2507
2423
 
@@ -2527,7 +2443,7 @@ class _VirtualMachineState:
2527
2443
  @pulumi.getter(name="scsiBusSharing")
2528
2444
  def scsi_bus_sharing(self) -> Optional[pulumi.Input[str]]:
2529
2445
  """
2530
- The type of SCSI bus sharing for the virtual machine SCSI controller. One of `physicalSharing`, `virtualSharing`, and `noSharing`. Default: `noSharing`.
2446
+ Mode for sharing the SCSI bus. The modes are physicalSharing, virtualSharing, and noSharing.
2531
2447
  """
2532
2448
  return pulumi.get(self, "scsi_bus_sharing")
2533
2449
 
@@ -2553,7 +2469,7 @@ class _VirtualMachineState:
2553
2469
  @pulumi.getter(name="scsiType")
2554
2470
  def scsi_type(self) -> Optional[pulumi.Input[str]]:
2555
2471
  """
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`.
2472
+ The type of SCSI bus this virtual machine will have. Can be one of lsilogic, lsilogic-sas or pvscsi.
2557
2473
  """
2558
2474
  return pulumi.get(self, "scsi_type")
2559
2475
 
@@ -2565,7 +2481,7 @@ class _VirtualMachineState:
2565
2481
  @pulumi.getter(name="shutdownWaitTimeout")
2566
2482
  def shutdown_wait_timeout(self) -> Optional[pulumi.Input[int]]:
2567
2483
  """
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.
2484
+ The amount of time, in minutes, to wait for shutdown when making necessary updates to the virtual machine.
2569
2485
  """
2570
2486
  return pulumi.get(self, "shutdown_wait_timeout")
2571
2487
 
@@ -2577,7 +2493,7 @@ class _VirtualMachineState:
2577
2493
  @pulumi.getter(name="storagePolicyId")
2578
2494
  def storage_policy_id(self) -> Optional[pulumi.Input[str]]:
2579
2495
  """
2580
- The UUID of the storage policy to assign to the virtual disk.
2496
+ The ID of the storage policy to assign to the virtual machine home directory.
2581
2497
  """
2582
2498
  return pulumi.get(self, "storage_policy_id")
2583
2499
 
@@ -2589,7 +2505,7 @@ class _VirtualMachineState:
2589
2505
  @pulumi.getter(name="swapPlacementPolicy")
2590
2506
  def swap_placement_policy(self) -> Optional[pulumi.Input[str]]:
2591
2507
  """
2592
- The swap file placement policy for the virtual machine. One of `inherit`, `hostLocal`, or `vmDirectory`. Default: `inherit`.
2508
+ The swap file placement policy for this virtual machine. Can be one of inherit, hostLocal, or vmDirectory.
2593
2509
  """
2594
2510
  return pulumi.get(self, "swap_placement_policy")
2595
2511
 
@@ -2601,7 +2517,8 @@ class _VirtualMachineState:
2601
2517
  @pulumi.getter(name="syncTimeWithHost")
2602
2518
  def sync_time_with_host(self) -> Optional[pulumi.Input[bool]]:
2603
2519
  """
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`.
2520
+ Enable guest clock synchronization with the host. On vSphere 7.0 U1 and above, with only this setting the clock is
2521
+ synchronized on startup and resume. Requires VMware Tools to be installed.
2605
2522
  """
2606
2523
  return pulumi.get(self, "sync_time_with_host")
2607
2524
 
@@ -2613,7 +2530,8 @@ class _VirtualMachineState:
2613
2530
  @pulumi.getter(name="syncTimeWithHostPeriodically")
2614
2531
  def sync_time_with_host_periodically(self) -> Optional[pulumi.Input[bool]]:
2615
2532
  """
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`.
2533
+ Enable periodic clock synchronization with the host. Supported only on vSphere 7.0 U1 and above. On prior versions
2534
+ setting `sync_time_with_host` is enough for periodic synchronization. Requires VMware Tools to be installed.
2617
2535
  """
2618
2536
  return pulumi.get(self, "sync_time_with_host_periodically")
2619
2537
 
@@ -2625,9 +2543,7 @@ class _VirtualMachineState:
2625
2543
  @pulumi.getter
2626
2544
  def tags(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
2627
2545
  """
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.
2546
+ A list of tag IDs to apply to this object.
2631
2547
  """
2632
2548
  return pulumi.get(self, "tags")
2633
2549
 
@@ -2639,7 +2555,7 @@ class _VirtualMachineState:
2639
2555
  @pulumi.getter(name="toolsUpgradePolicy")
2640
2556
  def tools_upgrade_policy(self) -> Optional[pulumi.Input[str]]:
2641
2557
  """
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`.
2558
+ Set the upgrade policy for VMware Tools. Can be one of `manual` or `upgradeAtPowerCycle`.
2643
2559
  """
2644
2560
  return pulumi.get(self, "tools_upgrade_policy")
2645
2561
 
@@ -2651,7 +2567,7 @@ class _VirtualMachineState:
2651
2567
  @pulumi.getter
2652
2568
  def uuid(self) -> Optional[pulumi.Input[str]]:
2653
2569
  """
2654
- The UUID of the virtual disk VMDK file. This is used to track the virtual disk on the virtual machine.
2570
+ The UUID of the virtual machine. Also exposed as the `id` of the resource.
2655
2571
  """
2656
2572
  return pulumi.get(self, "uuid")
2657
2573
 
@@ -2663,7 +2579,7 @@ class _VirtualMachineState:
2663
2579
  @pulumi.getter
2664
2580
  def vapp(self) -> Optional[pulumi.Input['VirtualMachineVappArgs']]:
2665
2581
  """
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.
2582
+ vApp configuration data for this virtual machine. Can be used to provide configuration data for OVF images.
2667
2583
  """
2668
2584
  return pulumi.get(self, "vapp")
2669
2585
 
@@ -2687,7 +2603,7 @@ class _VirtualMachineState:
2687
2603
  @pulumi.getter(name="vbsEnabled")
2688
2604
  def vbs_enabled(self) -> Optional[pulumi.Input[bool]]:
2689
2605
  """
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`.
2606
+ Flag to specify if Virtualization-based security is enabled for this virtual machine.
2691
2607
  """
2692
2608
  return pulumi.get(self, "vbs_enabled")
2693
2609
 
@@ -2723,7 +2639,8 @@ class _VirtualMachineState:
2723
2639
  @pulumi.getter(name="vvtdEnabled")
2724
2640
  def vvtd_enabled(self) -> Optional[pulumi.Input[bool]]:
2725
2641
  """
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`.
2642
+ Flag to specify if I/O MMU virtualization, also called Intel Virtualization Technology for Directed I/O (VT-d) and AMD
2643
+ I/O Virtualization (AMD-Vi or IOMMU), is enabled.
2727
2644
  """
2728
2645
  return pulumi.get(self, "vvtd_enabled")
2729
2646
 
@@ -2735,7 +2652,8 @@ class _VirtualMachineState:
2735
2652
  @pulumi.getter(name="waitForGuestIpTimeout")
2736
2653
  def wait_for_guest_ip_timeout(self) -> Optional[pulumi.Input[int]]:
2737
2654
  """
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`.
2655
+ The amount of time, in minutes, to wait for an available IP address on this virtual machine. A value less than 1
2656
+ disables the waiter.
2739
2657
  """
2740
2658
  return pulumi.get(self, "wait_for_guest_ip_timeout")
2741
2659
 
@@ -2747,7 +2665,8 @@ class _VirtualMachineState:
2747
2665
  @pulumi.getter(name="waitForGuestNetRoutable")
2748
2666
  def wait_for_guest_net_routable(self) -> Optional[pulumi.Input[bool]]:
2749
2667
  """
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`.
2668
+ Controls whether or not the guest network waiter waits for a routable address. When false, the waiter does not wait for
2669
+ a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria.
2751
2670
  """
2752
2671
  return pulumi.get(self, "wait_for_guest_net_routable")
2753
2672
 
@@ -2759,7 +2678,8 @@ class _VirtualMachineState:
2759
2678
  @pulumi.getter(name="waitForGuestNetTimeout")
2760
2679
  def wait_for_guest_net_timeout(self) -> Optional[pulumi.Input[int]]:
2761
2680
  """
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.
2681
+ The amount of time, in minutes, to wait for an available IP address on this virtual machine. A value less than 1
2682
+ disables the waiter.
2763
2683
  """
2764
2684
  return pulumi.get(self, "wait_for_guest_net_timeout")
2765
2685
 
@@ -2853,122 +2773,102 @@ class VirtualMachine(pulumi.CustomResource):
2853
2773
  Create a VirtualMachine resource with the given unique name, props, and options.
2854
2774
  :param str resource_name: The name of the resource.
2855
2775
  :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.
2776
+ :param pulumi.Input[str] alternate_guest_name: The guest name for the operating system when guest_id is otherGuest or otherGuest64.
2777
+ :param pulumi.Input[str] annotation: User-provided description of the virtual machine.
2778
+ :param pulumi.Input[int] boot_delay: The number of milliseconds to wait before starting the boot sequence.
2779
+ :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.
2780
+ :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.
2781
+ :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['VirtualMachineCdromArgs']]]] cdroms: A specification for a CDROM device on this virtual machine.
2782
+ :param pulumi.Input[pulumi.InputType['VirtualMachineCloneArgs']] clone: A specification for cloning a virtual machine from template.
2783
+ :param pulumi.Input[bool] cpu_hot_add_enabled: Allow CPUs to be added to this virtual machine while it is running.
2784
+ :param pulumi.Input[bool] cpu_hot_remove_enabled: Allow CPUs to be added to this virtual machine while it is running.
2785
+ :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
2786
+ resources.
2787
+ :param pulumi.Input[bool] cpu_performance_counters_enabled: Enable CPU performance counters on this virtual machine.
2788
+ :param pulumi.Input[int] cpu_reservation: The amount of memory (in MB) or CPU (in MHz) that this virtual machine is guaranteed.
2789
+ :param pulumi.Input[int] cpu_share_count: The amount of shares to allocate to cpu for a custom share level.
2790
+ :param pulumi.Input[str] cpu_share_level: The allocation level for cpu resources. Can be one of high, low, normal, or custom.
2791
+ :param pulumi.Input[Mapping[str, pulumi.Input[str]]] custom_attributes: A list of custom attributes to set on this resource.
2792
+ :param pulumi.Input[str] datacenter_id: The ID of the datacenter where the VM is to be created.
2793
+ :param pulumi.Input[str] datastore_cluster_id: The ID of a datastore cluster to put the virtual machine in.
2794
+ :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
2795
+ disks that are created without datastores.
2796
+ :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['VirtualMachineDiskArgs']]]] disks: A specification for a virtual disk device on this virtual machine.
2797
+ :param pulumi.Input[bool] efi_secure_boot_enabled: When the boot type set in firmware is efi, this enables EFI secure boot.
2798
+ :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.
2799
+ :param pulumi.Input[bool] enable_logging: Enable logging on this virtual machine.
2800
+ :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.
2801
+ :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
2802
+ configuration, such as instance metadata, or configuration data for OVF images.
2803
+ :param pulumi.Input[bool] extra_config_reboot_required: Allow the virtual machine to be rebooted when a change to `extra_config` occurs.
2804
+ :param pulumi.Input[str] firmware: The firmware interface to use on the virtual machine. Can be one of bios or efi.
2805
+ :param pulumi.Input[str] folder: The name of the folder to locate the virtual machine in.
2806
+ :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.
2807
+ :param pulumi.Input[str] guest_id: The guest ID for the operating system.
2808
+ :param pulumi.Input[int] hardware_version: The hardware version for the virtual machine.
2809
+ :param pulumi.Input[str] host_system_id: The ID of an optional host system to pin the virtual machine to.
2810
+ :param pulumi.Input[str] hv_mode: The (non-nested) hardware virtualization setting for this virtual machine. Can be one of hvAuto, hvOn, or hvOff.
2811
+ :param pulumi.Input[int] ide_controller_count: The number of IDE controllers that Terraform manages on this virtual machine. This directly affects the amount of disks
2812
+ you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove
2813
+ controllers.
2814
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] ignored_guest_ips: List of IP addresses and CIDR networks to ignore while waiting for an IP
2815
+ :param pulumi.Input[str] latency_sensitivity: Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower
2816
+ latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard
2817
+ devices. Can be one of low, normal, medium, or high.
2818
+ :param pulumi.Input[int] memory: The size of the virtual machine's memory, in MB.
2819
+ :param pulumi.Input[bool] memory_hot_add_enabled: Allow memory to be added to this virtual machine while it is running.
2820
+ :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
2821
+ resources.
2822
+ :param pulumi.Input[int] memory_reservation: The amount of memory (in MB) or CPU (in MHz) that this virtual machine is guaranteed.
2922
2823
  :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
2824
  size;increases in memory size will be rejected when a corresponding reservation increase is not possible. This feature
2924
2825
  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.
2826
+ :param pulumi.Input[int] memory_share_count: The amount of shares to allocate to memory for a custom share level.
2827
+ :param pulumi.Input[str] memory_share_level: The allocation level for memory resources. Can be one of high, low, normal, or custom.
2828
+ :param pulumi.Input[int] migrate_wait_timeout: The amount of time, in minutes, to wait for a vMotion operation to complete before failing.
2829
+ :param pulumi.Input[str] name: The name of this virtual machine.
2830
+ :param pulumi.Input[bool] nested_hv_enabled: Enable nested hardware virtualization on this virtual machine, facilitating nested virtualization in the guest.
2831
+ :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['VirtualMachineNetworkInterfaceArgs']]]] network_interfaces: A specification for a virtual NIC on this virtual machine.
2832
+ :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
2833
+ must be evenly divisible by this value.
2834
+ :param pulumi.Input[int] num_cpus: The number of virtual processors to assign to this virtual machine.
2835
+ :param pulumi.Input[pulumi.InputType['VirtualMachineOvfDeployArgs']] ovf_deploy: A specification for deploying a virtual machine from ovf/ova template.
2836
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] pci_device_ids: A list of PCI passthrough devices
2937
2837
  :param pulumi.Input[int] poweron_timeout: The amount of time, in seconds, that we will be trying to power on a VM
2938
2838
  :param pulumi.Input[str] replace_trigger: Triggers replacement of resource whenever it changes.
2939
-
2940
- For example, `replace_trigger = sha256(format("%s-%s",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`.
2839
+ :param pulumi.Input[str] resource_pool_id: The ID of a resource pool to put the virtual machine in.
2840
+ :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.
2841
+ :param pulumi.Input[bool] run_tools_scripts_after_resume: Enable the run of scripts after virtual machine resume when when VMware Tools is installed.
2842
+ :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.
2843
+ :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.
2844
+ :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.
2949
2845
  :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
2846
  you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove
2951
2847
  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`.
2848
+ :param pulumi.Input[str] scsi_bus_sharing: Mode for sharing the SCSI bus. The modes are physicalSharing, virtualSharing, and noSharing.
2953
2849
  :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
2850
  you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove
2955
2851
  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.
2852
+ :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.
2853
+ :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.
2854
+ :param pulumi.Input[str] storage_policy_id: The ID of the storage policy to assign to the virtual machine home directory.
2855
+ :param pulumi.Input[str] swap_placement_policy: The swap file placement policy for this virtual machine. Can be one of inherit, hostLocal, or vmDirectory.
2856
+ :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
2857
+ synchronized on startup and resume. Requires VMware Tools to be installed.
2858
+ :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
2859
+ setting `sync_time_with_host` is enough for periodic synchronization. Requires VMware Tools to be installed.
2860
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] tags: A list of tag IDs to apply to this object.
2861
+ :param pulumi.Input[str] tools_upgrade_policy: Set the upgrade policy for VMware Tools. Can be one of `manual` or `upgradeAtPowerCycle`.
2862
+ :param pulumi.Input[pulumi.InputType['VirtualMachineVappArgs']] vapp: vApp configuration data for this virtual machine. Can be used to provide configuration data for OVF images.
2863
+ :param pulumi.Input[bool] vbs_enabled: Flag to specify if Virtualization-based security is enabled for this virtual machine.
2864
+ :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
2865
+ I/O Virtualization (AMD-Vi or IOMMU), is enabled.
2866
+ :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
2867
+ disables the waiter.
2868
+ :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
2869
+ a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria.
2870
+ :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
2871
+ disables the waiter.
2972
2872
  """
2973
2873
  ...
2974
2874
  @overload
@@ -3268,133 +3168,113 @@ class VirtualMachine(pulumi.CustomResource):
3268
3168
  :param str resource_name: The unique name of the resulting resource.
3269
3169
  :param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
3270
3170
  :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.
3171
+ :param pulumi.Input[str] alternate_guest_name: The guest name for the operating system when guest_id is otherGuest or otherGuest64.
3172
+ :param pulumi.Input[str] annotation: User-provided description of the virtual machine.
3173
+ :param pulumi.Input[int] boot_delay: The number of milliseconds to wait before starting the boot sequence.
3174
+ :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.
3175
+ :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.
3176
+ :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['VirtualMachineCdromArgs']]]] cdroms: A specification for a CDROM device on this virtual machine.
3277
3177
  :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`.
3178
+ :param pulumi.Input[pulumi.InputType['VirtualMachineCloneArgs']] clone: A specification for cloning a virtual machine from template.
3179
+ :param pulumi.Input[bool] cpu_hot_add_enabled: Allow CPUs to be added to this virtual machine while it is running.
3180
+ :param pulumi.Input[bool] cpu_hot_remove_enabled: Allow CPUs to be added to this virtual machine while it is running.
3181
+ :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
3182
+ resources.
3183
+ :param pulumi.Input[bool] cpu_performance_counters_enabled: Enable CPU performance counters on this virtual machine.
3184
+ :param pulumi.Input[int] cpu_reservation: The amount of memory (in MB) or CPU (in MHz) that this virtual machine is guaranteed.
3185
+ :param pulumi.Input[int] cpu_share_count: The amount of shares to allocate to cpu for a custom share level.
3186
+ :param pulumi.Input[str] cpu_share_level: The allocation level for cpu resources. Can be one of high, low, normal, or custom.
3187
+ :param pulumi.Input[Mapping[str, pulumi.Input[str]]] custom_attributes: A list of custom attributes to set on this resource.
3188
+ :param pulumi.Input[str] datacenter_id: The ID of the datacenter where the VM is to be created.
3189
+ :param pulumi.Input[str] datastore_cluster_id: The ID of a datastore cluster to put the virtual machine in.
3190
+ :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
3191
+ disks that are created without datastores.
3298
3192
  :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
3193
+ :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['VirtualMachineDiskArgs']]]] disks: A specification for a virtual disk device on this virtual machine.
3194
+ :param pulumi.Input[bool] efi_secure_boot_enabled: When the boot type set in firmware is efi, this enables EFI secure boot.
3195
+ :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.
3196
+ :param pulumi.Input[bool] enable_logging: Enable logging on this virtual machine.
3197
+ :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.
3198
+ :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
3199
+ configuration, such as instance metadata, or configuration data for OVF images.
3200
+ :param pulumi.Input[bool] extra_config_reboot_required: Allow the virtual machine to be rebooted when a change to `extra_config` occurs.
3201
+ :param pulumi.Input[str] firmware: The firmware interface to use on the virtual machine. Can be one of bios or efi.
3202
+ :param pulumi.Input[str] folder: The name of the folder to locate the virtual machine in.
3203
+ :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.
3204
+ :param pulumi.Input[str] guest_id: The guest ID for the operating system.
3316
3205
  :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: `[]`.
3206
+ :param pulumi.Input[int] hardware_version: The hardware version for the virtual machine.
3207
+ :param pulumi.Input[str] host_system_id: The ID of an optional host system to pin the virtual machine to.
3208
+ :param pulumi.Input[str] hv_mode: The (non-nested) hardware virtualization setting for this virtual machine. Can be one of hvAuto, hvOn, or hvOff.
3209
+ :param pulumi.Input[int] ide_controller_count: The number of IDE controllers that Terraform manages on this virtual machine. This directly affects the amount of disks
3210
+ you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove
3211
+ controllers.
3212
+ :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
3213
  :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.
3214
+ :param pulumi.Input[str] latency_sensitivity: Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower
3215
+ latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard
3216
+ devices. Can be one of low, normal, medium, or high.
3217
+ :param pulumi.Input[int] memory: The size of the virtual machine's memory, in MB.
3218
+ :param pulumi.Input[bool] memory_hot_add_enabled: Allow memory to be added to this virtual machine while it is running.
3219
+ :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
3220
+ resources.
3221
+ :param pulumi.Input[int] memory_reservation: The amount of memory (in MB) or CPU (in MHz) that this virtual machine is guaranteed.
3341
3222
  :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
3223
  size;increases in memory size will be rejected when a corresponding reservation increase is not possible. This feature
3343
3224
  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.
3225
+ :param pulumi.Input[int] memory_share_count: The amount of shares to allocate to memory for a custom share level.
3226
+ :param pulumi.Input[str] memory_share_level: The allocation level for memory resources. Can be one of high, low, normal, or custom.
3227
+ :param pulumi.Input[int] migrate_wait_timeout: The amount of time, in minutes, to wait for a vMotion operation to complete before failing.
3347
3228
  :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.
3229
+ :param pulumi.Input[str] name: The name of this virtual machine.
3230
+ :param pulumi.Input[bool] nested_hv_enabled: Enable nested hardware virtualization on this virtual machine, facilitating nested virtualization in the guest.
3231
+ :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['VirtualMachineNetworkInterfaceArgs']]]] network_interfaces: A specification for a virtual NIC on this virtual machine.
3232
+ :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
3233
+ must be evenly divisible by this value.
3234
+ :param pulumi.Input[int] num_cpus: The number of virtual processors to assign to this virtual machine.
3235
+ :param pulumi.Input[pulumi.InputType['VirtualMachineOvfDeployArgs']] ovf_deploy: A specification for deploying a virtual machine from ovf/ova template.
3236
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] pci_device_ids: A list of PCI passthrough devices
3357
3237
  :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
3238
  :param pulumi.Input[int] poweron_timeout: The amount of time, in seconds, that we will be trying to power on a VM
3359
3239
  :param pulumi.Input[bool] reboot_required: Value internal to Terraform used to determine if a configuration set change requires a reboot.
3360
3240
  :param pulumi.Input[str] replace_trigger: Triggers replacement of resource whenever it changes.
3361
-
3362
- For example, `replace_trigger = sha256(format("%s-%s",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`.
3241
+ :param pulumi.Input[str] resource_pool_id: The ID of a resource pool to put the virtual machine in.
3242
+ :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.
3243
+ :param pulumi.Input[bool] run_tools_scripts_after_resume: Enable the run of scripts after virtual machine resume when when VMware Tools is installed.
3244
+ :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.
3245
+ :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.
3246
+ :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.
3371
3247
  :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
3248
  you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove
3373
3249
  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`.
3250
+ :param pulumi.Input[str] scsi_bus_sharing: Mode for sharing the SCSI bus. The modes are physicalSharing, virtualSharing, and noSharing.
3375
3251
  :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
3252
  you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove
3377
3253
  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.
3254
+ :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.
3255
+ :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.
3256
+ :param pulumi.Input[str] storage_policy_id: The ID of the storage policy to assign to the virtual machine home directory.
3257
+ :param pulumi.Input[str] swap_placement_policy: The swap file placement policy for this virtual machine. Can be one of inherit, hostLocal, or vmDirectory.
3258
+ :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
3259
+ synchronized on startup and resume. Requires VMware Tools to be installed.
3260
+ :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
3261
+ setting `sync_time_with_host` is enough for periodic synchronization. Requires VMware Tools to be installed.
3262
+ :param pulumi.Input[Sequence[pulumi.Input[str]]] tags: A list of tag IDs to apply to this object.
3263
+ :param pulumi.Input[str] tools_upgrade_policy: Set the upgrade policy for VMware Tools. Can be one of `manual` or `upgradeAtPowerCycle`.
3264
+ :param pulumi.Input[str] uuid: The UUID of the virtual machine. Also exposed as the `id` of the resource.
3265
+ :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
3266
  :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`.
3267
+ :param pulumi.Input[bool] vbs_enabled: Flag to specify if Virtualization-based security is enabled for this virtual machine.
3392
3268
  :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
3269
  :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.
3270
+ :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
3271
+ I/O Virtualization (AMD-Vi or IOMMU), is enabled.
3272
+ :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
3273
+ disables the waiter.
3274
+ :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
3275
+ a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria.
3276
+ :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
3277
+ disables the waiter.
3398
3278
  """
3399
3279
  opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
3400
3280
 
@@ -3492,7 +3372,7 @@ class VirtualMachine(pulumi.CustomResource):
3492
3372
  @pulumi.getter(name="alternateGuestName")
3493
3373
  def alternate_guest_name(self) -> pulumi.Output[Optional[str]]:
3494
3374
  """
3495
- The guest name for the operating system when `guest_id` is `otherGuest` or `otherGuest64`.
3375
+ The guest name for the operating system when guest_id is otherGuest or otherGuest64.
3496
3376
  """
3497
3377
  return pulumi.get(self, "alternate_guest_name")
3498
3378
 
@@ -3500,7 +3380,7 @@ class VirtualMachine(pulumi.CustomResource):
3500
3380
  @pulumi.getter
3501
3381
  def annotation(self) -> pulumi.Output[str]:
3502
3382
  """
3503
- A user-provided description of the virtual machine.
3383
+ User-provided description of the virtual machine.
3504
3384
  """
3505
3385
  return pulumi.get(self, "annotation")
3506
3386
 
@@ -3508,7 +3388,7 @@ class VirtualMachine(pulumi.CustomResource):
3508
3388
  @pulumi.getter(name="bootDelay")
3509
3389
  def boot_delay(self) -> pulumi.Output[Optional[int]]:
3510
3390
  """
3511
- The number of milliseconds to wait before starting the boot sequence. The default is no delay.
3391
+ The number of milliseconds to wait before starting the boot sequence.
3512
3392
  """
3513
3393
  return pulumi.get(self, "boot_delay")
3514
3394
 
@@ -3516,7 +3396,7 @@ class VirtualMachine(pulumi.CustomResource):
3516
3396
  @pulumi.getter(name="bootRetryDelay")
3517
3397
  def boot_retry_delay(self) -> pulumi.Output[Optional[int]]:
3518
3398
  """
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).
3399
+ The number of milliseconds to wait before retrying the boot sequence. This only valid if boot_retry_enabled is true.
3520
3400
  """
3521
3401
  return pulumi.get(self, "boot_retry_delay")
3522
3402
 
@@ -3524,7 +3404,7 @@ class VirtualMachine(pulumi.CustomResource):
3524
3404
  @pulumi.getter(name="bootRetryEnabled")
3525
3405
  def boot_retry_enabled(self) -> pulumi.Output[Optional[bool]]:
3526
3406
  """
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`.
3407
+ If set to true, a virtual machine that fails to boot will try again after the delay defined in boot_retry_delay.
3528
3408
  """
3529
3409
  return pulumi.get(self, "boot_retry_enabled")
3530
3410
 
@@ -3532,7 +3412,7 @@ class VirtualMachine(pulumi.CustomResource):
3532
3412
  @pulumi.getter
3533
3413
  def cdroms(self) -> pulumi.Output[Optional[Sequence['outputs.VirtualMachineCdrom']]]:
3534
3414
  """
3535
- A specification for a CD-ROM device on the virtual machine. See CD-ROM options for more information.
3415
+ A specification for a CDROM device on this virtual machine.
3536
3416
  """
3537
3417
  return pulumi.get(self, "cdroms")
3538
3418
 
@@ -3548,7 +3428,7 @@ class VirtualMachine(pulumi.CustomResource):
3548
3428
  @pulumi.getter
3549
3429
  def clone(self) -> pulumi.Output[Optional['outputs.VirtualMachineClone']]:
3550
3430
  """
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.
3431
+ A specification for cloning a virtual machine from template.
3552
3432
  """
3553
3433
  return pulumi.get(self, "clone")
3554
3434
 
@@ -3556,7 +3436,7 @@ class VirtualMachine(pulumi.CustomResource):
3556
3436
  @pulumi.getter(name="cpuHotAddEnabled")
3557
3437
  def cpu_hot_add_enabled(self) -> pulumi.Output[Optional[bool]]:
3558
3438
  """
3559
- Allow CPUs to be added to the virtual machine while it is powered on.
3439
+ Allow CPUs to be added to this virtual machine while it is running.
3560
3440
  """
3561
3441
  return pulumi.get(self, "cpu_hot_add_enabled")
3562
3442
 
@@ -3564,7 +3444,7 @@ class VirtualMachine(pulumi.CustomResource):
3564
3444
  @pulumi.getter(name="cpuHotRemoveEnabled")
3565
3445
  def cpu_hot_remove_enabled(self) -> pulumi.Output[Optional[bool]]:
3566
3446
  """
3567
- Allow CPUs to be removed to the virtual machine while it is powered on.
3447
+ Allow CPUs to be added to this virtual machine while it is running.
3568
3448
  """
3569
3449
  return pulumi.get(self, "cpu_hot_remove_enabled")
3570
3450
 
@@ -3572,7 +3452,8 @@ class VirtualMachine(pulumi.CustomResource):
3572
3452
  @pulumi.getter(name="cpuLimit")
3573
3453
  def cpu_limit(self) -> pulumi.Output[Optional[int]]:
3574
3454
  """
3575
- The maximum amount of CPU (in MHz) that the virtual machine can consume, regardless of available resources. The default is no limit.
3455
+ The maximum amount of memory (in MB) or CPU (in MHz) that this virtual machine can consume, regardless of available
3456
+ resources.
3576
3457
  """
3577
3458
  return pulumi.get(self, "cpu_limit")
3578
3459
 
@@ -3580,7 +3461,7 @@ class VirtualMachine(pulumi.CustomResource):
3580
3461
  @pulumi.getter(name="cpuPerformanceCountersEnabled")
3581
3462
  def cpu_performance_counters_enabled(self) -> pulumi.Output[Optional[bool]]:
3582
3463
  """
3583
- Enable CPU performance counters on the virtual machine. Default: `false`.
3464
+ Enable CPU performance counters on this virtual machine.
3584
3465
  """
3585
3466
  return pulumi.get(self, "cpu_performance_counters_enabled")
3586
3467
 
@@ -3588,7 +3469,7 @@ class VirtualMachine(pulumi.CustomResource):
3588
3469
  @pulumi.getter(name="cpuReservation")
3589
3470
  def cpu_reservation(self) -> pulumi.Output[Optional[int]]:
3590
3471
  """
3591
- The amount of CPU (in MHz) that the virtual machine is guaranteed. The default is no reservation.
3472
+ The amount of memory (in MB) or CPU (in MHz) that this virtual machine is guaranteed.
3592
3473
  """
3593
3474
  return pulumi.get(self, "cpu_reservation")
3594
3475
 
@@ -3596,7 +3477,7 @@ class VirtualMachine(pulumi.CustomResource):
3596
3477
  @pulumi.getter(name="cpuShareCount")
3597
3478
  def cpu_share_count(self) -> pulumi.Output[int]:
3598
3479
  """
3599
- The number of CPU shares allocated to the virtual machine when the `cpu_share_level` is `custom`.
3480
+ The amount of shares to allocate to cpu for a custom share level.
3600
3481
  """
3601
3482
  return pulumi.get(self, "cpu_share_count")
3602
3483
 
@@ -3604,7 +3485,7 @@ class VirtualMachine(pulumi.CustomResource):
3604
3485
  @pulumi.getter(name="cpuShareLevel")
3605
3486
  def cpu_share_level(self) -> pulumi.Output[Optional[str]]:
3606
3487
  """
3607
- The allocation level for the virtual machine CPU resources. One of `high`, `low`, `normal`, or `custom`. Default: `custom`.
3488
+ The allocation level for cpu resources. Can be one of high, low, normal, or custom.
3608
3489
  """
3609
3490
  return pulumi.get(self, "cpu_share_level")
3610
3491
 
@@ -3612,9 +3493,7 @@ class VirtualMachine(pulumi.CustomResource):
3612
3493
  @pulumi.getter(name="customAttributes")
3613
3494
  def custom_attributes(self) -> pulumi.Output[Optional[Mapping[str, str]]]:
3614
3495
  """
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.
3496
+ A list of custom attributes to set on this resource.
3618
3497
  """
3619
3498
  return pulumi.get(self, "custom_attributes")
3620
3499
 
@@ -3622,7 +3501,7 @@ class VirtualMachine(pulumi.CustomResource):
3622
3501
  @pulumi.getter(name="datacenterId")
3623
3502
  def datacenter_id(self) -> pulumi.Output[Optional[str]]:
3624
3503
  """
3625
- The datacenter ID. Required only when deploying an OVF/OVA template.
3504
+ The ID of the datacenter where the VM is to be created.
3626
3505
  """
3627
3506
  return pulumi.get(self, "datacenter_id")
3628
3507
 
@@ -3630,13 +3509,7 @@ class VirtualMachine(pulumi.CustomResource):
3630
3509
  @pulumi.getter(name="datastoreClusterId")
3631
3510
  def datastore_cluster_id(self) -> pulumi.Output[Optional[str]]:
3632
3511
  """
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.
3512
+ The ID of a datastore cluster to put the virtual machine in.
3640
3513
  """
3641
3514
  return pulumi.get(self, "datastore_cluster_id")
3642
3515
 
@@ -3644,7 +3517,8 @@ class VirtualMachine(pulumi.CustomResource):
3644
3517
  @pulumi.getter(name="datastoreId")
3645
3518
  def datastore_id(self) -> pulumi.Output[str]:
3646
3519
  """
3647
- The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with `client_device`.
3520
+ The ID of the virtual machine's datastore. The virtual machine configuration is placed here, along with any virtual
3521
+ disks that are created without datastores.
3648
3522
  """
3649
3523
  return pulumi.get(self, "datastore_id")
3650
3524
 
@@ -3660,7 +3534,7 @@ class VirtualMachine(pulumi.CustomResource):
3660
3534
  @pulumi.getter
3661
3535
  def disks(self) -> pulumi.Output[Sequence['outputs.VirtualMachineDisk']]:
3662
3536
  """
3663
- A specification for a virtual disk device on the virtual machine. See disk options for more information.
3537
+ A specification for a virtual disk device on this virtual machine.
3664
3538
  """
3665
3539
  return pulumi.get(self, "disks")
3666
3540
 
@@ -3668,9 +3542,7 @@ class VirtualMachine(pulumi.CustomResource):
3668
3542
  @pulumi.getter(name="efiSecureBootEnabled")
3669
3543
  def efi_secure_boot_enabled(self) -> pulumi.Output[Optional[bool]]:
3670
3544
  """
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.
3545
+ When the boot type set in firmware is efi, this enables EFI secure boot.
3674
3546
  """
3675
3547
  return pulumi.get(self, "efi_secure_boot_enabled")
3676
3548
 
@@ -3678,7 +3550,7 @@ class VirtualMachine(pulumi.CustomResource):
3678
3550
  @pulumi.getter(name="enableDiskUuid")
3679
3551
  def enable_disk_uuid(self) -> pulumi.Output[Optional[bool]]:
3680
3552
  """
3681
- Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest. Default: `false`.
3553
+ Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest.
3682
3554
  """
3683
3555
  return pulumi.get(self, "enable_disk_uuid")
3684
3556
 
@@ -3686,7 +3558,7 @@ class VirtualMachine(pulumi.CustomResource):
3686
3558
  @pulumi.getter(name="enableLogging")
3687
3559
  def enable_logging(self) -> pulumi.Output[Optional[bool]]:
3688
3560
  """
3689
- Enable logging of virtual machine events to a log file stored in the virtual machine directory. Default: `false`.
3561
+ Enable logging on this virtual machine.
3690
3562
  """
3691
3563
  return pulumi.get(self, "enable_logging")
3692
3564
 
@@ -3694,7 +3566,7 @@ class VirtualMachine(pulumi.CustomResource):
3694
3566
  @pulumi.getter(name="eptRviMode")
3695
3567
  def ept_rvi_mode(self) -> pulumi.Output[Optional[str]]:
3696
3568
  """
3697
- The EPT/RVI (hardware memory virtualization) setting for the virtual machine. One of `automatic`, `on`, or `off`. Default: `automatic`.
3569
+ The EPT/RVI (hardware memory virtualization) setting for this virtual machine. Can be one of automatic, on, or off.
3698
3570
  """
3699
3571
  return pulumi.get(self, "ept_rvi_mode")
3700
3572
 
@@ -3702,9 +3574,8 @@ class VirtualMachine(pulumi.CustomResource):
3702
3574
  @pulumi.getter(name="extraConfig")
3703
3575
  def extra_config(self) -> pulumi.Output[Optional[Mapping[str, str]]]:
3704
3576
  """
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.
3577
+ Extra configuration data for this virtual machine. Can be used to supply advanced parameters not normally in
3578
+ configuration, such as instance metadata, or configuration data for OVF images.
3708
3579
  """
3709
3580
  return pulumi.get(self, "extra_config")
3710
3581
 
@@ -3712,7 +3583,7 @@ class VirtualMachine(pulumi.CustomResource):
3712
3583
  @pulumi.getter(name="extraConfigRebootRequired")
3713
3584
  def extra_config_reboot_required(self) -> pulumi.Output[Optional[bool]]:
3714
3585
  """
3715
- Allow the virtual machine to be rebooted when a change to `extra_config` occurs. Default: `true`.
3586
+ Allow the virtual machine to be rebooted when a change to `extra_config` occurs.
3716
3587
  """
3717
3588
  return pulumi.get(self, "extra_config_reboot_required")
3718
3589
 
@@ -3720,7 +3591,7 @@ class VirtualMachine(pulumi.CustomResource):
3720
3591
  @pulumi.getter
3721
3592
  def firmware(self) -> pulumi.Output[Optional[str]]:
3722
3593
  """
3723
- The firmware for the virtual machine. One of `bios` or `efi`.
3594
+ The firmware interface to use on the virtual machine. Can be one of bios or efi.
3724
3595
  """
3725
3596
  return pulumi.get(self, "firmware")
3726
3597
 
@@ -3728,7 +3599,7 @@ class VirtualMachine(pulumi.CustomResource):
3728
3599
  @pulumi.getter
3729
3600
  def folder(self) -> pulumi.Output[Optional[str]]:
3730
3601
  """
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`
3602
+ The name of the folder to locate the virtual machine in.
3732
3603
  """
3733
3604
  return pulumi.get(self, "folder")
3734
3605
 
@@ -3736,7 +3607,7 @@ class VirtualMachine(pulumi.CustomResource):
3736
3607
  @pulumi.getter(name="forcePowerOff")
3737
3608
  def force_power_off(self) -> pulumi.Output[Optional[bool]]:
3738
3609
  """
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`.
3610
+ Set to true to force power-off a virtual machine if a graceful guest shutdown failed for a necessary operation.
3740
3611
  """
3741
3612
  return pulumi.get(self, "force_power_off")
3742
3613
 
@@ -3744,9 +3615,7 @@ class VirtualMachine(pulumi.CustomResource):
3744
3615
  @pulumi.getter(name="guestId")
3745
3616
  def guest_id(self) -> pulumi.Output[str]:
3746
3617
  """
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
3618
+ The guest ID for the operating system.
3750
3619
  """
3751
3620
  return pulumi.get(self, "guest_id")
3752
3621
 
@@ -3762,10 +3631,7 @@ class VirtualMachine(pulumi.CustomResource):
3762
3631
  @pulumi.getter(name="hardwareVersion")
3763
3632
  def hardware_version(self) -> pulumi.Output[int]:
3764
3633
  """
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
3634
+ The hardware version for the virtual machine.
3769
3635
  """
3770
3636
  return pulumi.get(self, "hardware_version")
3771
3637
 
@@ -3773,7 +3639,7 @@ class VirtualMachine(pulumi.CustomResource):
3773
3639
  @pulumi.getter(name="hostSystemId")
3774
3640
  def host_system_id(self) -> pulumi.Output[str]:
3775
3641
  """
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.
3642
+ The ID of an optional host system to pin the virtual machine to.
3777
3643
  """
3778
3644
  return pulumi.get(self, "host_system_id")
3779
3645
 
@@ -3781,7 +3647,7 @@ class VirtualMachine(pulumi.CustomResource):
3781
3647
  @pulumi.getter(name="hvMode")
3782
3648
  def hv_mode(self) -> pulumi.Output[Optional[str]]:
3783
3649
  """
3784
- The hardware virtualization (non-nested) setting for the virtual machine. One of `hvAuto`, `hvOn`, or `hvOff`. Default: `hvAuto`.
3650
+ The (non-nested) hardware virtualization setting for this virtual machine. Can be one of hvAuto, hvOn, or hvOff.
3785
3651
  """
3786
3652
  return pulumi.get(self, "hv_mode")
3787
3653
 
@@ -3789,7 +3655,9 @@ class VirtualMachine(pulumi.CustomResource):
3789
3655
  @pulumi.getter(name="ideControllerCount")
3790
3656
  def ide_controller_count(self) -> pulumi.Output[Optional[int]]:
3791
3657
  """
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`.
3658
+ The number of IDE controllers that Terraform manages on this virtual machine. This directly affects the amount of disks
3659
+ you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove
3660
+ controllers.
3793
3661
  """
3794
3662
  return pulumi.get(self, "ide_controller_count")
3795
3663
 
@@ -3797,7 +3665,7 @@ class VirtualMachine(pulumi.CustomResource):
3797
3665
  @pulumi.getter(name="ignoredGuestIps")
3798
3666
  def ignored_guest_ips(self) -> pulumi.Output[Optional[Sequence[str]]]:
3799
3667
  """
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: `[]`.
3668
+ List of IP addresses and CIDR networks to ignore while waiting for an IP
3801
3669
  """
3802
3670
  return pulumi.get(self, "ignored_guest_ips")
3803
3671
 
@@ -3813,9 +3681,9 @@ class VirtualMachine(pulumi.CustomResource):
3813
3681
  @pulumi.getter(name="latencySensitivity")
3814
3682
  def latency_sensitivity(self) -> pulumi.Output[Optional[str]]:
3815
3683
  """
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.
3684
+ Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower
3685
+ latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard
3686
+ devices. Can be one of low, normal, medium, or high.
3819
3687
  """
3820
3688
  return pulumi.get(self, "latency_sensitivity")
3821
3689
 
@@ -3823,7 +3691,7 @@ class VirtualMachine(pulumi.CustomResource):
3823
3691
  @pulumi.getter
3824
3692
  def memory(self) -> pulumi.Output[Optional[int]]:
3825
3693
  """
3826
- The memory size to assign to the virtual machine, in MB. Default: `1024` (1 GB).
3694
+ The size of the virtual machine's memory, in MB.
3827
3695
  """
3828
3696
  return pulumi.get(self, "memory")
3829
3697
 
@@ -3831,15 +3699,7 @@ class VirtualMachine(pulumi.CustomResource):
3831
3699
  @pulumi.getter(name="memoryHotAddEnabled")
3832
3700
  def memory_hot_add_enabled(self) -> pulumi.Output[Optional[bool]]:
3833
3701
  """
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
3702
+ Allow memory to be added to this virtual machine while it is running.
3843
3703
  """
3844
3704
  return pulumi.get(self, "memory_hot_add_enabled")
3845
3705
 
@@ -3847,7 +3707,8 @@ class VirtualMachine(pulumi.CustomResource):
3847
3707
  @pulumi.getter(name="memoryLimit")
3848
3708
  def memory_limit(self) -> pulumi.Output[Optional[int]]:
3849
3709
  """
3850
- The maximum amount of memory (in MB) that th virtual machine can consume, regardless of available resources. The default is no limit.
3710
+ The maximum amount of memory (in MB) or CPU (in MHz) that this virtual machine can consume, regardless of available
3711
+ resources.
3851
3712
  """
3852
3713
  return pulumi.get(self, "memory_limit")
3853
3714
 
@@ -3855,7 +3716,7 @@ class VirtualMachine(pulumi.CustomResource):
3855
3716
  @pulumi.getter(name="memoryReservation")
3856
3717
  def memory_reservation(self) -> pulumi.Output[Optional[int]]:
3857
3718
  """
3858
- The amount of memory (in MB) that the virtual machine is guaranteed. The default is no reservation.
3719
+ The amount of memory (in MB) or CPU (in MHz) that this virtual machine is guaranteed.
3859
3720
  """
3860
3721
  return pulumi.get(self, "memory_reservation")
3861
3722
 
@@ -3873,7 +3734,7 @@ class VirtualMachine(pulumi.CustomResource):
3873
3734
  @pulumi.getter(name="memoryShareCount")
3874
3735
  def memory_share_count(self) -> pulumi.Output[int]:
3875
3736
  """
3876
- The number of memory shares allocated to the virtual machine when the `memory_share_level` is `custom`.
3737
+ The amount of shares to allocate to memory for a custom share level.
3877
3738
  """
3878
3739
  return pulumi.get(self, "memory_share_count")
3879
3740
 
@@ -3881,7 +3742,7 @@ class VirtualMachine(pulumi.CustomResource):
3881
3742
  @pulumi.getter(name="memoryShareLevel")
3882
3743
  def memory_share_level(self) -> pulumi.Output[Optional[str]]:
3883
3744
  """
3884
- The allocation level for the virtual machine memory resources. One of `high`, `low`, `normal`, or `custom`. Default: `custom`.
3745
+ The allocation level for memory resources. Can be one of high, low, normal, or custom.
3885
3746
  """
3886
3747
  return pulumi.get(self, "memory_share_level")
3887
3748
 
@@ -3889,7 +3750,7 @@ class VirtualMachine(pulumi.CustomResource):
3889
3750
  @pulumi.getter(name="migrateWaitTimeout")
3890
3751
  def migrate_wait_timeout(self) -> pulumi.Output[Optional[int]]:
3891
3752
  """
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.
3753
+ The amount of time, in minutes, to wait for a vMotion operation to complete before failing.
3893
3754
  """
3894
3755
  return pulumi.get(self, "migrate_wait_timeout")
3895
3756
 
@@ -3905,7 +3766,7 @@ class VirtualMachine(pulumi.CustomResource):
3905
3766
  @pulumi.getter
3906
3767
  def name(self) -> pulumi.Output[str]:
3907
3768
  """
3908
- The name of the virtual machine.
3769
+ The name of this virtual machine.
3909
3770
  """
3910
3771
  return pulumi.get(self, "name")
3911
3772
 
@@ -3913,7 +3774,7 @@ class VirtualMachine(pulumi.CustomResource):
3913
3774
  @pulumi.getter(name="nestedHvEnabled")
3914
3775
  def nested_hv_enabled(self) -> pulumi.Output[Optional[bool]]:
3915
3776
  """
3916
- Enable nested hardware virtualization on the virtual machine, facilitating nested virtualization in the guest operating system. Default: `false`.
3777
+ Enable nested hardware virtualization on this virtual machine, facilitating nested virtualization in the guest.
3917
3778
  """
3918
3779
  return pulumi.get(self, "nested_hv_enabled")
3919
3780
 
@@ -3921,7 +3782,7 @@ class VirtualMachine(pulumi.CustomResource):
3921
3782
  @pulumi.getter(name="networkInterfaces")
3922
3783
  def network_interfaces(self) -> pulumi.Output[Optional[Sequence['outputs.VirtualMachineNetworkInterface']]]:
3923
3784
  """
3924
- A specification for a virtual NIC on the virtual machine. See network interface options for more information.
3785
+ A specification for a virtual NIC on this virtual machine.
3925
3786
  """
3926
3787
  return pulumi.get(self, "network_interfaces")
3927
3788
 
@@ -3929,7 +3790,8 @@ class VirtualMachine(pulumi.CustomResource):
3929
3790
  @pulumi.getter(name="numCoresPerSocket")
3930
3791
  def num_cores_per_socket(self) -> pulumi.Output[Optional[int]]:
3931
3792
  """
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`.
3793
+ The number of cores to distribute amongst the CPUs in this virtual machine. If specified, the value supplied to num_cpus
3794
+ must be evenly divisible by this value.
3933
3795
  """
3934
3796
  return pulumi.get(self, "num_cores_per_socket")
3935
3797
 
@@ -3937,7 +3799,7 @@ class VirtualMachine(pulumi.CustomResource):
3937
3799
  @pulumi.getter(name="numCpus")
3938
3800
  def num_cpus(self) -> pulumi.Output[Optional[int]]:
3939
3801
  """
3940
- The total number of virtual processor cores to assign to the virtual machine. Default: `1`.
3802
+ The number of virtual processors to assign to this virtual machine.
3941
3803
  """
3942
3804
  return pulumi.get(self, "num_cpus")
3943
3805
 
@@ -3945,7 +3807,7 @@ class VirtualMachine(pulumi.CustomResource):
3945
3807
  @pulumi.getter(name="ovfDeploy")
3946
3808
  def ovf_deploy(self) -> pulumi.Output[Optional['outputs.VirtualMachineOvfDeploy']]:
3947
3809
  """
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.
3810
+ A specification for deploying a virtual machine from ovf/ova template.
3949
3811
  """
3950
3812
  return pulumi.get(self, "ovf_deploy")
3951
3813
 
@@ -3953,9 +3815,7 @@ class VirtualMachine(pulumi.CustomResource):
3953
3815
  @pulumi.getter(name="pciDeviceIds")
3954
3816
  def pci_device_ids(self) -> pulumi.Output[Optional[Sequence[str]]]:
3955
3817
  """
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.
3818
+ A list of PCI passthrough devices
3959
3819
  """
3960
3820
  return pulumi.get(self, "pci_device_ids")
3961
3821
 
@@ -3988,8 +3848,6 @@ class VirtualMachine(pulumi.CustomResource):
3988
3848
  def replace_trigger(self) -> pulumi.Output[Optional[str]]:
3989
3849
  """
3990
3850
  Triggers replacement of resource whenever it changes.
3991
-
3992
- For example, `replace_trigger = sha256(format("%s-%s",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
3851
  """
3994
3852
  return pulumi.get(self, "replace_trigger")
3995
3853
 
@@ -3997,9 +3855,7 @@ class VirtualMachine(pulumi.CustomResource):
3997
3855
  @pulumi.getter(name="resourcePoolId")
3998
3856
  def resource_pool_id(self) -> pulumi.Output[str]:
3999
3857
  """
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.
3858
+ The ID of a resource pool to put the virtual machine in.
4003
3859
  """
4004
3860
  return pulumi.get(self, "resource_pool_id")
4005
3861
 
@@ -4007,7 +3863,7 @@ class VirtualMachine(pulumi.CustomResource):
4007
3863
  @pulumi.getter(name="runToolsScriptsAfterPowerOn")
4008
3864
  def run_tools_scripts_after_power_on(self) -> pulumi.Output[Optional[bool]]:
4009
3865
  """
4010
- Enable post-power-on scripts to run when VMware Tools is installed. Default: `true`.
3866
+ Enable the run of scripts after virtual machine power-on when VMware Tools is installed.
4011
3867
  """
4012
3868
  return pulumi.get(self, "run_tools_scripts_after_power_on")
4013
3869
 
@@ -4015,7 +3871,7 @@ class VirtualMachine(pulumi.CustomResource):
4015
3871
  @pulumi.getter(name="runToolsScriptsAfterResume")
4016
3872
  def run_tools_scripts_after_resume(self) -> pulumi.Output[Optional[bool]]:
4017
3873
  """
4018
- Enable ost-resume scripts to run when VMware Tools is installed. Default: `true`.
3874
+ Enable the run of scripts after virtual machine resume when when VMware Tools is installed.
4019
3875
  """
4020
3876
  return pulumi.get(self, "run_tools_scripts_after_resume")
4021
3877
 
@@ -4023,7 +3879,7 @@ class VirtualMachine(pulumi.CustomResource):
4023
3879
  @pulumi.getter(name="runToolsScriptsBeforeGuestReboot")
4024
3880
  def run_tools_scripts_before_guest_reboot(self) -> pulumi.Output[Optional[bool]]:
4025
3881
  """
4026
- Enable pre-reboot scripts to run when VMware Tools is installed. Default: `false`.
3882
+ Enable the run of scripts before guest operating system reboot when VMware Tools is installed.
4027
3883
  """
4028
3884
  return pulumi.get(self, "run_tools_scripts_before_guest_reboot")
4029
3885
 
@@ -4031,7 +3887,7 @@ class VirtualMachine(pulumi.CustomResource):
4031
3887
  @pulumi.getter(name="runToolsScriptsBeforeGuestShutdown")
4032
3888
  def run_tools_scripts_before_guest_shutdown(self) -> pulumi.Output[Optional[bool]]:
4033
3889
  """
4034
- Enable pre-shutdown scripts to run when VMware Tools is installed. Default: `true`.
3890
+ Enable the run of scripts before guest operating system shutdown when VMware Tools is installed.
4035
3891
  """
4036
3892
  return pulumi.get(self, "run_tools_scripts_before_guest_shutdown")
4037
3893
 
@@ -4039,7 +3895,7 @@ class VirtualMachine(pulumi.CustomResource):
4039
3895
  @pulumi.getter(name="runToolsScriptsBeforeGuestStandby")
4040
3896
  def run_tools_scripts_before_guest_standby(self) -> pulumi.Output[Optional[bool]]:
4041
3897
  """
4042
- Enable pre-standby scripts to run when VMware Tools is installed. Default: `true`.
3898
+ Enable the run of scripts before guest operating system standby when VMware Tools is installed.
4043
3899
  """
4044
3900
  return pulumi.get(self, "run_tools_scripts_before_guest_standby")
4045
3901
 
@@ -4057,7 +3913,7 @@ class VirtualMachine(pulumi.CustomResource):
4057
3913
  @pulumi.getter(name="scsiBusSharing")
4058
3914
  def scsi_bus_sharing(self) -> pulumi.Output[Optional[str]]:
4059
3915
  """
4060
- The type of SCSI bus sharing for the virtual machine SCSI controller. One of `physicalSharing`, `virtualSharing`, and `noSharing`. Default: `noSharing`.
3916
+ Mode for sharing the SCSI bus. The modes are physicalSharing, virtualSharing, and noSharing.
4061
3917
  """
4062
3918
  return pulumi.get(self, "scsi_bus_sharing")
4063
3919
 
@@ -4075,7 +3931,7 @@ class VirtualMachine(pulumi.CustomResource):
4075
3931
  @pulumi.getter(name="scsiType")
4076
3932
  def scsi_type(self) -> pulumi.Output[Optional[str]]:
4077
3933
  """
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`.
3934
+ The type of SCSI bus this virtual machine will have. Can be one of lsilogic, lsilogic-sas or pvscsi.
4079
3935
  """
4080
3936
  return pulumi.get(self, "scsi_type")
4081
3937
 
@@ -4083,7 +3939,7 @@ class VirtualMachine(pulumi.CustomResource):
4083
3939
  @pulumi.getter(name="shutdownWaitTimeout")
4084
3940
  def shutdown_wait_timeout(self) -> pulumi.Output[Optional[int]]:
4085
3941
  """
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.
3942
+ The amount of time, in minutes, to wait for shutdown when making necessary updates to the virtual machine.
4087
3943
  """
4088
3944
  return pulumi.get(self, "shutdown_wait_timeout")
4089
3945
 
@@ -4091,7 +3947,7 @@ class VirtualMachine(pulumi.CustomResource):
4091
3947
  @pulumi.getter(name="storagePolicyId")
4092
3948
  def storage_policy_id(self) -> pulumi.Output[str]:
4093
3949
  """
4094
- The UUID of the storage policy to assign to the virtual disk.
3950
+ The ID of the storage policy to assign to the virtual machine home directory.
4095
3951
  """
4096
3952
  return pulumi.get(self, "storage_policy_id")
4097
3953
 
@@ -4099,7 +3955,7 @@ class VirtualMachine(pulumi.CustomResource):
4099
3955
  @pulumi.getter(name="swapPlacementPolicy")
4100
3956
  def swap_placement_policy(self) -> pulumi.Output[Optional[str]]:
4101
3957
  """
4102
- The swap file placement policy for the virtual machine. One of `inherit`, `hostLocal`, or `vmDirectory`. Default: `inherit`.
3958
+ The swap file placement policy for this virtual machine. Can be one of inherit, hostLocal, or vmDirectory.
4103
3959
  """
4104
3960
  return pulumi.get(self, "swap_placement_policy")
4105
3961
 
@@ -4107,7 +3963,8 @@ class VirtualMachine(pulumi.CustomResource):
4107
3963
  @pulumi.getter(name="syncTimeWithHost")
4108
3964
  def sync_time_with_host(self) -> pulumi.Output[Optional[bool]]:
4109
3965
  """
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`.
3966
+ Enable guest clock synchronization with the host. On vSphere 7.0 U1 and above, with only this setting the clock is
3967
+ synchronized on startup and resume. Requires VMware Tools to be installed.
4111
3968
  """
4112
3969
  return pulumi.get(self, "sync_time_with_host")
4113
3970
 
@@ -4115,7 +3972,8 @@ class VirtualMachine(pulumi.CustomResource):
4115
3972
  @pulumi.getter(name="syncTimeWithHostPeriodically")
4116
3973
  def sync_time_with_host_periodically(self) -> pulumi.Output[Optional[bool]]:
4117
3974
  """
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`.
3975
+ Enable periodic clock synchronization with the host. Supported only on vSphere 7.0 U1 and above. On prior versions
3976
+ setting `sync_time_with_host` is enough for periodic synchronization. Requires VMware Tools to be installed.
4119
3977
  """
4120
3978
  return pulumi.get(self, "sync_time_with_host_periodically")
4121
3979
 
@@ -4123,9 +3981,7 @@ class VirtualMachine(pulumi.CustomResource):
4123
3981
  @pulumi.getter
4124
3982
  def tags(self) -> pulumi.Output[Optional[Sequence[str]]]:
4125
3983
  """
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.
3984
+ A list of tag IDs to apply to this object.
4129
3985
  """
4130
3986
  return pulumi.get(self, "tags")
4131
3987
 
@@ -4133,7 +3989,7 @@ class VirtualMachine(pulumi.CustomResource):
4133
3989
  @pulumi.getter(name="toolsUpgradePolicy")
4134
3990
  def tools_upgrade_policy(self) -> pulumi.Output[Optional[str]]:
4135
3991
  """
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`.
3992
+ Set the upgrade policy for VMware Tools. Can be one of `manual` or `upgradeAtPowerCycle`.
4137
3993
  """
4138
3994
  return pulumi.get(self, "tools_upgrade_policy")
4139
3995
 
@@ -4141,7 +3997,7 @@ class VirtualMachine(pulumi.CustomResource):
4141
3997
  @pulumi.getter
4142
3998
  def uuid(self) -> pulumi.Output[str]:
4143
3999
  """
4144
- The UUID of the virtual disk VMDK file. This is used to track the virtual disk on the virtual machine.
4000
+ The UUID of the virtual machine. Also exposed as the `id` of the resource.
4145
4001
  """
4146
4002
  return pulumi.get(self, "uuid")
4147
4003
 
@@ -4149,7 +4005,7 @@ class VirtualMachine(pulumi.CustomResource):
4149
4005
  @pulumi.getter
4150
4006
  def vapp(self) -> pulumi.Output[Optional['outputs.VirtualMachineVapp']]:
4151
4007
  """
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.
4008
+ vApp configuration data for this virtual machine. Can be used to provide configuration data for OVF images.
4153
4009
  """
4154
4010
  return pulumi.get(self, "vapp")
4155
4011
 
@@ -4165,7 +4021,7 @@ class VirtualMachine(pulumi.CustomResource):
4165
4021
  @pulumi.getter(name="vbsEnabled")
4166
4022
  def vbs_enabled(self) -> pulumi.Output[Optional[bool]]:
4167
4023
  """
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`.
4024
+ Flag to specify if Virtualization-based security is enabled for this virtual machine.
4169
4025
  """
4170
4026
  return pulumi.get(self, "vbs_enabled")
4171
4027
 
@@ -4189,7 +4045,8 @@ class VirtualMachine(pulumi.CustomResource):
4189
4045
  @pulumi.getter(name="vvtdEnabled")
4190
4046
  def vvtd_enabled(self) -> pulumi.Output[Optional[bool]]:
4191
4047
  """
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`.
4048
+ Flag to specify if I/O MMU virtualization, also called Intel Virtualization Technology for Directed I/O (VT-d) and AMD
4049
+ I/O Virtualization (AMD-Vi or IOMMU), is enabled.
4193
4050
  """
4194
4051
  return pulumi.get(self, "vvtd_enabled")
4195
4052
 
@@ -4197,7 +4054,8 @@ class VirtualMachine(pulumi.CustomResource):
4197
4054
  @pulumi.getter(name="waitForGuestIpTimeout")
4198
4055
  def wait_for_guest_ip_timeout(self) -> pulumi.Output[Optional[int]]:
4199
4056
  """
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`.
4057
+ The amount of time, in minutes, to wait for an available IP address on this virtual machine. A value less than 1
4058
+ disables the waiter.
4201
4059
  """
4202
4060
  return pulumi.get(self, "wait_for_guest_ip_timeout")
4203
4061
 
@@ -4205,7 +4063,8 @@ class VirtualMachine(pulumi.CustomResource):
4205
4063
  @pulumi.getter(name="waitForGuestNetRoutable")
4206
4064
  def wait_for_guest_net_routable(self) -> pulumi.Output[Optional[bool]]:
4207
4065
  """
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`.
4066
+ Controls whether or not the guest network waiter waits for a routable address. When false, the waiter does not wait for
4067
+ a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria.
4209
4068
  """
4210
4069
  return pulumi.get(self, "wait_for_guest_net_routable")
4211
4070
 
@@ -4213,7 +4072,8 @@ class VirtualMachine(pulumi.CustomResource):
4213
4072
  @pulumi.getter(name="waitForGuestNetTimeout")
4214
4073
  def wait_for_guest_net_timeout(self) -> pulumi.Output[Optional[int]]:
4215
4074
  """
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.
4075
+ The amount of time, in minutes, to wait for an available IP address on this virtual machine. A value less than 1
4076
+ disables the waiter.
4217
4077
  """
4218
4078
  return pulumi.get(self, "wait_for_guest_net_timeout")
4219
4079