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