@pulumi/vsphere 4.10.0 → 4.10.1

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.
Files changed (129) hide show
  1. package/computeCluster.d.ts +297 -633
  2. package/computeCluster.js.map +1 -1
  3. package/computeClusterVmAffinityRule.d.ts +14 -8
  4. package/computeClusterVmAffinityRule.js +14 -8
  5. package/computeClusterVmAffinityRule.js.map +1 -1
  6. package/datacenter.d.ts +14 -6
  7. package/datacenter.js +14 -6
  8. package/datacenter.js.map +1 -1
  9. package/datastoreCluster.d.ts +72 -156
  10. package/datastoreCluster.js.map +1 -1
  11. package/distributedPortGroup.d.ts +30 -75
  12. package/distributedPortGroup.js.map +1 -1
  13. package/distributedVirtualSwitch.d.ts +132 -345
  14. package/distributedVirtualSwitch.js.map +1 -1
  15. package/file.d.ts +8 -12
  16. package/file.js +8 -12
  17. package/file.js.map +1 -1
  18. package/getComputeCluster.d.ts +0 -4
  19. package/getComputeCluster.js +0 -4
  20. package/getComputeCluster.js.map +1 -1
  21. package/getComputeClusterHostGroup.d.ts +8 -10
  22. package/getComputeClusterHostGroup.js +8 -10
  23. package/getComputeClusterHostGroup.js.map +1 -1
  24. package/getContentLibrary.d.ts +0 -4
  25. package/getContentLibrary.js +0 -4
  26. package/getContentLibrary.js.map +1 -1
  27. package/getCustomAttribute.d.ts +0 -4
  28. package/getCustomAttribute.js +0 -4
  29. package/getCustomAttribute.js.map +1 -1
  30. package/getDatacenter.d.ts +0 -4
  31. package/getDatacenter.js +0 -4
  32. package/getDatacenter.js.map +1 -1
  33. package/getDatastore.d.ts +0 -4
  34. package/getDatastore.js +0 -4
  35. package/getDatastore.js.map +1 -1
  36. package/getDatastoreCluster.d.ts +0 -4
  37. package/getDatastoreCluster.js +0 -4
  38. package/getDatastoreCluster.js.map +1 -1
  39. package/getDatastoreStats.d.ts +4 -12
  40. package/getDatastoreStats.js +4 -12
  41. package/getDatastoreStats.js.map +1 -1
  42. package/getDistributedVirtualSwitch.d.ts +2 -4
  43. package/getDistributedVirtualSwitch.js +2 -4
  44. package/getDistributedVirtualSwitch.js.map +1 -1
  45. package/getDynamic.d.ts +4 -8
  46. package/getDynamic.js +4 -8
  47. package/getDynamic.js.map +1 -1
  48. package/getFolder.d.ts +0 -4
  49. package/getFolder.js +0 -4
  50. package/getFolder.js.map +1 -1
  51. package/getGuestOsCustomization.d.ts +0 -4
  52. package/getGuestOsCustomization.js +0 -4
  53. package/getGuestOsCustomization.js.map +1 -1
  54. package/getHost.d.ts +0 -4
  55. package/getHost.js +0 -4
  56. package/getHost.js.map +1 -1
  57. package/getHostPciDevice.d.ts +10 -18
  58. package/getHostPciDevice.js +10 -18
  59. package/getHostPciDevice.js.map +1 -1
  60. package/getHostThumbprint.d.ts +0 -4
  61. package/getHostThumbprint.js +0 -4
  62. package/getHostThumbprint.js.map +1 -1
  63. package/getHostVgpuProfile.d.ts +0 -8
  64. package/getHostVgpuProfile.js +0 -8
  65. package/getHostVgpuProfile.js.map +1 -1
  66. package/getLicense.d.ts +0 -4
  67. package/getLicense.js +0 -4
  68. package/getLicense.js.map +1 -1
  69. package/getNetwork.d.ts +0 -4
  70. package/getNetwork.js +0 -4
  71. package/getNetwork.js.map +1 -1
  72. package/getPolicy.d.ts +0 -4
  73. package/getPolicy.js +0 -4
  74. package/getPolicy.js.map +1 -1
  75. package/getResourcePool.d.ts +2 -10
  76. package/getResourcePool.js +2 -10
  77. package/getResourcePool.js.map +1 -1
  78. package/getRole.d.ts +0 -4
  79. package/getRole.js +0 -4
  80. package/getRole.js.map +1 -1
  81. package/getTag.d.ts +0 -4
  82. package/getTag.js +0 -4
  83. package/getTag.js.map +1 -1
  84. package/getTagCategory.d.ts +0 -4
  85. package/getTagCategory.js +0 -4
  86. package/getTagCategory.js.map +1 -1
  87. package/getVappContainer.d.ts +0 -4
  88. package/getVappContainer.js +0 -4
  89. package/getVappContainer.js.map +1 -1
  90. package/getVirtualMachine.d.ts +0 -8
  91. package/getVirtualMachine.js +0 -8
  92. package/getVirtualMachine.js.map +1 -1
  93. package/getVmfsDisks.d.ts +0 -4
  94. package/getVmfsDisks.js +0 -4
  95. package/getVmfsDisks.js.map +1 -1
  96. package/guestOsCustomization.d.ts +26 -0
  97. package/guestOsCustomization.js +26 -0
  98. package/guestOsCustomization.js.map +1 -1
  99. package/haVmOverride.d.ts +81 -162
  100. package/haVmOverride.js.map +1 -1
  101. package/host.d.ts +0 -10
  102. package/host.js +0 -10
  103. package/host.js.map +1 -1
  104. package/hostPortGroup.d.ts +6 -12
  105. package/hostPortGroup.js +6 -12
  106. package/hostPortGroup.js.map +1 -1
  107. package/hostVirtualSwitch.d.ts +60 -123
  108. package/hostVirtualSwitch.js.map +1 -1
  109. package/license.d.ts +0 -17
  110. package/license.js +0 -17
  111. package/license.js.map +1 -1
  112. package/package.json +1 -1
  113. package/resourcePool.d.ts +27 -11
  114. package/resourcePool.js +27 -11
  115. package/resourcePool.js.map +1 -1
  116. package/types/input.d.ts +48 -116
  117. package/types/output.d.ts +48 -116
  118. package/virtualDisk.d.ts +3 -3
  119. package/virtualMachine.d.ts +248 -359
  120. package/virtualMachine.js.map +1 -1
  121. package/virtualMachineSnapshot.d.ts +3 -5
  122. package/virtualMachineSnapshot.js +3 -5
  123. package/virtualMachineSnapshot.js.map +1 -1
  124. package/vmStoragePolicy.d.ts +28 -34
  125. package/vmStoragePolicy.js +28 -34
  126. package/vmStoragePolicy.js.map +1 -1
  127. package/vnic.d.ts +4 -10
  128. package/vnic.js +4 -10
  129. package/vnic.js.map +1 -1
@@ -18,27 +18,27 @@ export declare class VirtualMachine extends pulumi.CustomResource {
18
18
  */
19
19
  static isInstance(obj: any): obj is VirtualMachine;
20
20
  /**
21
- * The guest name for the operating system when `guestId` is `otherGuest` or `otherGuest64`.
21
+ * The guest name for the operating system when guestId is otherGuest or otherGuest64.
22
22
  */
23
23
  readonly alternateGuestName: pulumi.Output<string | undefined>;
24
24
  /**
25
- * A user-provided description of the virtual machine.
25
+ * User-provided description of the virtual machine.
26
26
  */
27
27
  readonly annotation: pulumi.Output<string>;
28
28
  /**
29
- * The number of milliseconds to wait before starting the boot sequence. The default is no delay.
29
+ * The number of milliseconds to wait before starting the boot sequence.
30
30
  */
31
31
  readonly bootDelay: pulumi.Output<number | undefined>;
32
32
  /**
33
- * The number of milliseconds to wait before retrying the boot sequence. This option is only valid if `bootRetryEnabled` is `true`. Default: `10000` (10 seconds).
33
+ * The number of milliseconds to wait before retrying the boot sequence. This only valid if bootRetryEnabled is true.
34
34
  */
35
35
  readonly bootRetryDelay: pulumi.Output<number | undefined>;
36
36
  /**
37
- * If set to `true`, a virtual machine that fails to boot will try again after the delay defined in `bootRetryDelay`. Default: `false`.
37
+ * If set to true, a virtual machine that fails to boot will try again after the delay defined in boot_retry_delay.
38
38
  */
39
39
  readonly bootRetryEnabled: pulumi.Output<boolean | undefined>;
40
40
  /**
41
- * A specification for a CD-ROM device on the virtual machine. See CD-ROM options for more information.
41
+ * A specification for a CDROM device on this virtual machine.
42
42
  */
43
43
  readonly cdroms: pulumi.Output<outputs.VirtualMachineCdrom[] | undefined>;
44
44
  /**
@@ -46,61 +46,55 @@ export declare class VirtualMachine extends pulumi.CustomResource {
46
46
  */
47
47
  readonly changeVersion: pulumi.Output<string>;
48
48
  /**
49
- * 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.
49
+ * A specification for cloning a virtual machine from template.
50
50
  */
51
51
  readonly clone: pulumi.Output<outputs.VirtualMachineClone | undefined>;
52
52
  /**
53
- * Allow CPUs to be added to the virtual machine while it is powered on.
53
+ * Allow CPUs to be added to this virtual machine while it is running.
54
54
  */
55
55
  readonly cpuHotAddEnabled: pulumi.Output<boolean | undefined>;
56
56
  /**
57
- * Allow CPUs to be removed to the virtual machine while it is powered on.
57
+ * Allow CPUs to be added to this virtual machine while it is running.
58
58
  */
59
59
  readonly cpuHotRemoveEnabled: pulumi.Output<boolean | undefined>;
60
60
  /**
61
- * The maximum amount of CPU (in MHz) that the virtual machine can consume, regardless of available resources. The default is no limit.
61
+ * The maximum amount of memory (in MB) or CPU (in MHz) that this virtual machine can consume, regardless of available
62
+ * resources.
62
63
  */
63
64
  readonly cpuLimit: pulumi.Output<number | undefined>;
64
65
  /**
65
- * Enable CPU performance counters on the virtual machine. Default: `false`.
66
+ * Enable CPU performance counters on this virtual machine.
66
67
  */
67
68
  readonly cpuPerformanceCountersEnabled: pulumi.Output<boolean | undefined>;
68
69
  /**
69
- * The amount of CPU (in MHz) that the virtual machine is guaranteed. The default is no reservation.
70
+ * The amount of memory (in MB) or CPU (in MHz) that this virtual machine is guaranteed.
70
71
  */
71
72
  readonly cpuReservation: pulumi.Output<number | undefined>;
72
73
  /**
73
- * The number of CPU shares allocated to the virtual machine when the `cpuShareLevel` is `custom`.
74
+ * The amount of shares to allocate to cpu for a custom share level.
74
75
  */
75
76
  readonly cpuShareCount: pulumi.Output<number>;
76
77
  /**
77
- * The allocation level for the virtual machine CPU resources. One of `high`, `low`, `normal`, or `custom`. Default: `custom`.
78
+ * The allocation level for cpu resources. Can be one of high, low, normal, or custom.
78
79
  */
79
80
  readonly cpuShareLevel: pulumi.Output<string | undefined>;
80
81
  /**
81
- * Map of custom attribute ids to attribute value strings to set for virtual machine. Please refer to the `vsphereCustomAttributes` resource for more information on setting custom attributes.
82
- *
83
- * > **NOTE:** Custom attributes requires vCenter Server and is not supported on direct ESXi host connections.
82
+ * A list of custom attributes to set on this resource.
84
83
  */
85
84
  readonly customAttributes: pulumi.Output<{
86
85
  [key: string]: string;
87
86
  } | undefined>;
88
87
  /**
89
- * The datacenter ID. Required only when deploying an OVF/OVA template.
88
+ * The ID of the datacenter where the VM is to be created.
90
89
  */
91
90
  readonly datacenterId: pulumi.Output<string | undefined>;
92
91
  /**
93
- * 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.
94
- *
95
- * > **NOTE:** One of `datastoreId` or `datastoreClusterId` must be specified.
96
- *
97
- * > **NOTE:** Use of `datastoreClusterId` requires vSphere Storage DRS to be enabled on the specified datastore cluster.
98
- *
99
- * > **NOTE:** The `datastoreClusterId` 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.
92
+ * The ID of a datastore cluster to put the virtual machine in.
100
93
  */
101
94
  readonly datastoreClusterId: pulumi.Output<string | undefined>;
102
95
  /**
103
- * The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with `clientDevice`.
96
+ * The ID of the virtual machine's datastore. The virtual machine configuration is placed here, along with any virtual
97
+ * disks that are created without datastores.
104
98
  */
105
99
  readonly datastoreId: pulumi.Output<string>;
106
100
  /**
@@ -108,55 +102,50 @@ export declare class VirtualMachine extends pulumi.CustomResource {
108
102
  */
109
103
  readonly defaultIpAddress: pulumi.Output<string>;
110
104
  /**
111
- * A specification for a virtual disk device on the virtual machine. See disk options for more information.
105
+ * A specification for a virtual disk device on this virtual machine.
112
106
  */
113
107
  readonly disks: pulumi.Output<outputs.VirtualMachineDisk[]>;
114
108
  /**
115
- * Use this option to enable EFI secure boot when the `firmware` type is set to is `efi`. Default: `false`.
116
- *
117
- * > **NOTE:** EFI secure boot is only available on vSphere 6.5 and later.
109
+ * When the boot type set in firmware is efi, this enables EFI secure boot.
118
110
  */
119
111
  readonly efiSecureBootEnabled: pulumi.Output<boolean | undefined>;
120
112
  /**
121
- * Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest. Default: `false`.
113
+ * Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest.
122
114
  */
123
115
  readonly enableDiskUuid: pulumi.Output<boolean | undefined>;
124
116
  /**
125
- * Enable logging of virtual machine events to a log file stored in the virtual machine directory. Default: `false`.
117
+ * Enable logging on this virtual machine.
126
118
  */
127
119
  readonly enableLogging: pulumi.Output<boolean | undefined>;
128
120
  /**
129
- * The EPT/RVI (hardware memory virtualization) setting for the virtual machine. One of `automatic`, `on`, or `off`. Default: `automatic`.
121
+ * The EPT/RVI (hardware memory virtualization) setting for this virtual machine. Can be one of automatic, on, or off.
130
122
  */
131
123
  readonly eptRviMode: pulumi.Output<string | undefined>;
132
124
  /**
133
- * Extra configuration data for the virtual machine. Can be used to supply advanced parameters not normally in configuration, such as instance metadata and userdata.
134
- *
135
- * > **NOTE:** Do not use `extraConfig` 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.
125
+ * Extra configuration data for this virtual machine. Can be used to supply advanced parameters not normally in
126
+ * configuration, such as instance metadata, or configuration data for OVF images.
136
127
  */
137
128
  readonly extraConfig: pulumi.Output<{
138
129
  [key: string]: string;
139
130
  } | undefined>;
140
131
  /**
141
- * Allow the virtual machine to be rebooted when a change to `extraConfig` occurs. Default: `true`.
132
+ * Allow the virtual machine to be rebooted when a change to `extraConfig` occurs.
142
133
  */
143
134
  readonly extraConfigRebootRequired: pulumi.Output<boolean | undefined>;
144
135
  /**
145
- * The firmware for the virtual machine. One of `bios` or `efi`.
136
+ * The firmware interface to use on the virtual machine. Can be one of bios or efi.
146
137
  */
147
138
  readonly firmware: pulumi.Output<string | undefined>;
148
139
  /**
149
- * 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`
140
+ * The name of the folder to locate the virtual machine in.
150
141
  */
151
142
  readonly folder: pulumi.Output<string | undefined>;
152
143
  /**
153
- * If a guest shutdown failed or times out while updating or destroying (see `shutdownWaitTimeout`), force the power-off of the virtual machine. Default: `true`.
144
+ * Set to true to force power-off a virtual machine if a graceful guest shutdown failed for a necessary operation.
154
145
  */
155
146
  readonly forcePowerOff: pulumi.Output<boolean | undefined>;
156
147
  /**
157
- * The guest ID for the operating system type. For a full list of possible values, see [here][vmware-docs-guest-ids]. Default: `otherGuest64`.
158
- *
159
- * [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
148
+ * The guest ID for the operating system.
160
149
  */
161
150
  readonly guestId: pulumi.Output<string>;
162
151
  /**
@@ -164,26 +153,20 @@ export declare class VirtualMachine extends pulumi.CustomResource {
164
153
  */
165
154
  readonly guestIpAddresses: pulumi.Output<string[]>;
166
155
  /**
167
- * 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.
168
- *
169
- * [virtual-machine-hardware-versions]: https://kb.vmware.com/s/article/1003746
170
- * [virtual-machine-hardware-compatibility]: https://kb.vmware.com/s/article/2007240
156
+ * The hardware version for the virtual machine.
171
157
  */
172
158
  readonly hardwareVersion: pulumi.Output<number>;
173
159
  /**
174
- * 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 `hostSystemId` 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.
160
+ * The ID of an optional host system to pin the virtual machine to.
175
161
  */
176
162
  readonly hostSystemId: pulumi.Output<string>;
177
163
  /**
178
- * The hardware virtualization (non-nested) setting for the virtual machine. One of `hvAuto`, `hvOn`, or `hvOff`. Default: `hvAuto`.
164
+ * The (non-nested) hardware virtualization setting for this virtual machine. Can be one of hvAuto, hvOn, or hvOff.
179
165
  */
180
166
  readonly hvMode: pulumi.Output<string | undefined>;
181
- /**
182
- * 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`.
183
- */
184
167
  readonly ideControllerCount: pulumi.Output<number | undefined>;
185
168
  /**
186
- * 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: `[]`.
169
+ * List of IP addresses and CIDR networks to ignore while waiting for an IP
187
170
  */
188
171
  readonly ignoredGuestIps: pulumi.Output<string[] | undefined>;
189
172
  /**
@@ -191,33 +174,26 @@ export declare class VirtualMachine extends pulumi.CustomResource {
191
174
  */
192
175
  readonly imported: pulumi.Output<boolean>;
193
176
  /**
194
- * 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`.
195
- *
196
- * > **NOTE:** On higher sensitivities, you may need to adjust the `memoryReservation` to the full amount of memory provisioned for the virtual machine.
177
+ * Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower
178
+ * latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard
179
+ * devices. Can be one of low, normal, medium, or high.
197
180
  */
198
181
  readonly latencySensitivity: pulumi.Output<string | undefined>;
199
182
  /**
200
- * The memory size to assign to the virtual machine, in MB. Default: `1024` (1 GB).
183
+ * The size of the virtual machine's memory, in MB.
201
184
  */
202
185
  readonly memory: pulumi.Output<number | undefined>;
203
186
  /**
204
- * Allow memory to be added to the virtual machine while it is powered on.
205
- *
206
- * > **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.
207
- *
208
- * [vmware-docs-compat-guide]: http://partnerweb.vmware.com/comp_guide2/pdf/VMware_GOS_Compatibility_Guide.pdf
209
- *
210
- * > **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].
211
- *
212
- * [vmware-kb-2008405]: https://kb.vmware.com/s/article/2008405
187
+ * Allow memory to be added to this virtual machine while it is running.
213
188
  */
214
189
  readonly memoryHotAddEnabled: pulumi.Output<boolean | undefined>;
215
190
  /**
216
- * The maximum amount of memory (in MB) that th virtual machine can consume, regardless of available resources. The default is no limit.
191
+ * The maximum amount of memory (in MB) or CPU (in MHz) that this virtual machine can consume, regardless of available
192
+ * resources.
217
193
  */
218
194
  readonly memoryLimit: pulumi.Output<number | undefined>;
219
195
  /**
220
- * The amount of memory (in MB) that the virtual machine is guaranteed. The default is no reservation.
196
+ * The amount of memory (in MB) or CPU (in MHz) that this virtual machine is guaranteed.
221
197
  */
222
198
  readonly memoryReservation: pulumi.Output<number | undefined>;
223
199
  /**
@@ -227,15 +203,15 @@ export declare class VirtualMachine extends pulumi.CustomResource {
227
203
  */
228
204
  readonly memoryReservationLockedToMax: pulumi.Output<boolean | undefined>;
229
205
  /**
230
- * The number of memory shares allocated to the virtual machine when the `memoryShareLevel` is `custom`.
206
+ * The amount of shares to allocate to memory for a custom share level.
231
207
  */
232
208
  readonly memoryShareCount: pulumi.Output<number>;
233
209
  /**
234
- * The allocation level for the virtual machine memory resources. One of `high`, `low`, `normal`, or `custom`. Default: `custom`.
210
+ * The allocation level for memory resources. Can be one of high, low, normal, or custom.
235
211
  */
236
212
  readonly memoryShareLevel: pulumi.Output<string | undefined>;
237
213
  /**
238
- * 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.
214
+ * The amount of time, in minutes, to wait for a vMotion operation to complete before failing.
239
215
  */
240
216
  readonly migrateWaitTimeout: pulumi.Output<number | undefined>;
241
217
  /**
@@ -243,33 +219,32 @@ export declare class VirtualMachine extends pulumi.CustomResource {
243
219
  */
244
220
  readonly moid: pulumi.Output<string>;
245
221
  /**
246
- * The name of the virtual machine.
222
+ * The name of this virtual machine.
247
223
  */
248
224
  readonly name: pulumi.Output<string>;
249
225
  /**
250
- * Enable nested hardware virtualization on the virtual machine, facilitating nested virtualization in the guest operating system. Default: `false`.
226
+ * Enable nested hardware virtualization on this virtual machine, facilitating nested virtualization in the guest.
251
227
  */
252
228
  readonly nestedHvEnabled: pulumi.Output<boolean | undefined>;
253
229
  /**
254
- * A specification for a virtual NIC on the virtual machine. See network interface options for more information.
230
+ * A specification for a virtual NIC on this virtual machine.
255
231
  */
256
232
  readonly networkInterfaces: pulumi.Output<outputs.VirtualMachineNetworkInterface[] | undefined>;
257
233
  /**
258
- * The number of cores per socket in the virtual machine. The number of vCPUs on the virtual machine will be `numCpus` divided by `numCoresPerSocket`. If specified, the value supplied to `numCpus` must be evenly divisible by this value. Default: `1`.
234
+ * The number of cores to distribute amongst the CPUs in this virtual machine. If specified, the value supplied to numCpus
235
+ * must be evenly divisible by this value.
259
236
  */
260
237
  readonly numCoresPerSocket: pulumi.Output<number | undefined>;
261
238
  /**
262
- * The total number of virtual processor cores to assign to the virtual machine. Default: `1`.
239
+ * The number of virtual processors to assign to this virtual machine.
263
240
  */
264
241
  readonly numCpus: pulumi.Output<number | undefined>;
265
242
  /**
266
- * 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.
243
+ * A specification for deploying a virtual machine from ovf/ova template.
267
244
  */
268
245
  readonly ovfDeploy: pulumi.Output<outputs.VirtualMachineOvfDeploy | undefined>;
269
246
  /**
270
- * List of host PCI device IDs in which to create PCI passthroughs.
271
- *
272
- * > **NOTE:** Cloning requires vCenter Server and is not supported on direct ESXi host connections.
247
+ * A list of PCI passthrough devices
273
248
  */
274
249
  readonly pciDeviceIds: pulumi.Output<string[] | undefined>;
275
250
  /**
@@ -280,98 +255,81 @@ export declare class VirtualMachine extends pulumi.CustomResource {
280
255
  * The amount of time, in seconds, that we will be trying to power on a VM
281
256
  */
282
257
  readonly poweronTimeout: pulumi.Output<number | undefined>;
283
- /**
284
- * Value internal to Terraform used to determine if a configuration set change requires a reboot.
285
- */
286
258
  readonly rebootRequired: pulumi.Output<boolean>;
287
259
  /**
288
260
  * Triggers replacement of resource whenever it changes.
289
- *
290
- * For example, `replaceTrigger = 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.)
291
261
  */
292
262
  readonly replaceTrigger: pulumi.Output<string | undefined>;
293
263
  /**
294
- * 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.
295
- *
296
- * > **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 `vsphere.ResourcePool` data source documentation on using the root resource pool.
264
+ * The ID of a resource pool to put the virtual machine in.
297
265
  */
298
266
  readonly resourcePoolId: pulumi.Output<string>;
299
267
  /**
300
- * Enable post-power-on scripts to run when VMware Tools is installed. Default: `true`.
268
+ * Enable the run of scripts after virtual machine power-on when VMware Tools is installed.
301
269
  */
302
270
  readonly runToolsScriptsAfterPowerOn: pulumi.Output<boolean | undefined>;
303
271
  /**
304
- * Enable ost-resume scripts to run when VMware Tools is installed. Default: `true`.
272
+ * Enable the run of scripts after virtual machine resume when when VMware Tools is installed.
305
273
  */
306
274
  readonly runToolsScriptsAfterResume: pulumi.Output<boolean | undefined>;
307
275
  /**
308
- * Enable pre-reboot scripts to run when VMware Tools is installed. Default: `false`.
276
+ * Enable the run of scripts before guest operating system reboot when VMware Tools is installed.
309
277
  */
310
278
  readonly runToolsScriptsBeforeGuestReboot: pulumi.Output<boolean | undefined>;
311
279
  /**
312
- * Enable pre-shutdown scripts to run when VMware Tools is installed. Default: `true`.
280
+ * Enable the run of scripts before guest operating system shutdown when VMware Tools is installed.
313
281
  */
314
282
  readonly runToolsScriptsBeforeGuestShutdown: pulumi.Output<boolean | undefined>;
315
283
  /**
316
- * Enable pre-standby scripts to run when VMware Tools is installed. Default: `true`.
284
+ * Enable the run of scripts before guest operating system standby when VMware Tools is installed.
317
285
  */
318
286
  readonly runToolsScriptsBeforeGuestStandby: pulumi.Output<boolean | undefined>;
319
- /**
320
- * The number of SATA controllers that Terraform manages on this virtual machine. This directly affects the amount of disks
321
- * you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove
322
- * controllers.
323
- */
324
287
  readonly sataControllerCount: pulumi.Output<number | undefined>;
325
288
  /**
326
- * The type of SCSI bus sharing for the virtual machine SCSI controller. One of `physicalSharing`, `virtualSharing`, and `noSharing`. Default: `noSharing`.
289
+ * Mode for sharing the SCSI bus. The modes are physicalSharing, virtualSharing, and noSharing.
327
290
  */
328
291
  readonly scsiBusSharing: pulumi.Output<string | undefined>;
329
- /**
330
- * The number of SCSI controllers that Terraform manages on this virtual machine. This directly affects the amount of disks
331
- * you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove
332
- * controllers.
333
- */
334
292
  readonly scsiControllerCount: pulumi.Output<number | undefined>;
335
293
  /**
336
- * 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`.
294
+ * The type of SCSI bus this virtual machine will have. Can be one of lsilogic, lsilogic-sas or pvscsi.
337
295
  */
338
296
  readonly scsiType: pulumi.Output<string | undefined>;
339
297
  /**
340
- * The amount of time, in minutes, to wait for a graceful guest shutdown when making necessary updates to the virtual machine. If `forcePowerOff` is set to `true`, the virtual machine will be forced to power-off after the timeout, otherwise an error is returned. Default: `3` minutes.
298
+ * The amount of time, in minutes, to wait for shutdown when making necessary updates to the virtual machine.
341
299
  */
342
300
  readonly shutdownWaitTimeout: pulumi.Output<number | undefined>;
343
301
  /**
344
- * The UUID of the storage policy to assign to the virtual disk.
302
+ * The ID of the storage policy to assign to the virtual machine home directory.
345
303
  */
346
304
  readonly storagePolicyId: pulumi.Output<string>;
347
305
  /**
348
- * The swap file placement policy for the virtual machine. One of `inherit`, `hostLocal`, or `vmDirectory`. Default: `inherit`.
306
+ * The swap file placement policy for this virtual machine. Can be one of inherit, hostLocal, or vmDirectory.
349
307
  */
350
308
  readonly swapPlacementPolicy: pulumi.Output<string | undefined>;
351
309
  /**
352
- * 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`.
310
+ * Enable guest clock synchronization with the host. On vSphere 7.0 U1 and above, with only this setting the clock is
311
+ * synchronized on startup and resume. Requires VMware Tools to be installed.
353
312
  */
354
313
  readonly syncTimeWithHost: pulumi.Output<boolean | undefined>;
355
314
  /**
356
- * 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 `syncTimeWithHost` is will enable periodic synchronization. Requires VMware Tools to be installed. Default: `false`.
315
+ * Enable periodic clock synchronization with the host. Supported only on vSphere 7.0 U1 and above. On prior versions
316
+ * setting `syncTimeWithHost` is enough for periodic synchronization. Requires VMware Tools to be installed.
357
317
  */
358
318
  readonly syncTimeWithHostPeriodically: pulumi.Output<boolean | undefined>;
359
319
  /**
360
- * The IDs of any tags to attach to this resource. Please refer to the `vsphere.Tag` resource for more information on applying tags to virtual machine resources.
361
- *
362
- * > **NOTE:** Tagging support is unsupported on direct ESXi host connections and requires vCenter Server instance.
320
+ * A list of tag IDs to apply to this object.
363
321
  */
364
322
  readonly tags: pulumi.Output<string[] | undefined>;
365
323
  /**
366
- * 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`.
324
+ * Set the upgrade policy for VMware Tools. Can be one of `manual` or `upgradeAtPowerCycle`.
367
325
  */
368
326
  readonly toolsUpgradePolicy: pulumi.Output<string | undefined>;
369
327
  /**
370
- * The UUID of the virtual disk VMDK file. This is used to track the virtual disk on the virtual machine.
328
+ * The UUID of the virtual machine. Also exposed as the `id` of the resource.
371
329
  */
372
330
  readonly uuid: pulumi.Output<string>;
373
331
  /**
374
- * 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.
332
+ * vApp configuration data for this virtual machine. Can be used to provide configuration data for OVF images.
375
333
  */
376
334
  readonly vapp: pulumi.Output<outputs.VirtualMachineVapp | undefined>;
377
335
  /**
@@ -379,7 +337,7 @@ export declare class VirtualMachine extends pulumi.CustomResource {
379
337
  */
380
338
  readonly vappTransports: pulumi.Output<string[]>;
381
339
  /**
382
- * Enable Virtualization Based Security. Requires `firmware` to be `efi`. In addition, `vvtdEnabled`, `nestedHvEnabled`, and `efiSecureBootEnabled` must all have a value of `true`. Supported on vSphere 6.7 and later. Default: `false`.
340
+ * Flag to specify if Virtualization-based security is enabled for this virtual machine.
383
341
  */
384
342
  readonly vbsEnabled: pulumi.Output<boolean | undefined>;
385
343
  /**
@@ -391,19 +349,23 @@ export declare class VirtualMachine extends pulumi.CustomResource {
391
349
  */
392
350
  readonly vmxPath: pulumi.Output<string>;
393
351
  /**
394
- * 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`.
352
+ * Flag to specify if I/O MMU virtualization, also called Intel Virtualization Technology for Directed I/O (VT-d) and AMD
353
+ * I/O Virtualization (AMD-Vi or IOMMU), is enabled.
395
354
  */
396
355
  readonly vvtdEnabled: pulumi.Output<boolean | undefined>;
397
356
  /**
398
- * 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 `waitForGuestNetTimeout` waiter to be used. A value less than `1` disables the waiter. Default: `0`.
357
+ * The amount of time, in minutes, to wait for an available IP address on this virtual machine. A value less than 1
358
+ * disables the waiter.
399
359
  */
400
360
  readonly waitForGuestIpTimeout: pulumi.Output<number | undefined>;
401
361
  /**
402
- * 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 `waitForGuestIpTimeout` waiter is used. Default: `true`.
362
+ * Controls whether or not the guest network waiter waits for a routable address. When false, the waiter does not wait for
363
+ * a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria.
403
364
  */
404
365
  readonly waitForGuestNetRoutable: pulumi.Output<boolean | undefined>;
405
366
  /**
406
- * 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 `waitForGuestIpTimeout` waiter can be used instead. A value less than `1` disables the waiter. Default: `5` minutes.
367
+ * The amount of time, in minutes, to wait for an available IP address on this virtual machine. A value less than 1
368
+ * disables the waiter.
407
369
  */
408
370
  readonly waitForGuestNetTimeout: pulumi.Output<number | undefined>;
409
371
  /**
@@ -420,27 +382,27 @@ export declare class VirtualMachine extends pulumi.CustomResource {
420
382
  */
421
383
  export interface VirtualMachineState {
422
384
  /**
423
- * The guest name for the operating system when `guestId` is `otherGuest` or `otherGuest64`.
385
+ * The guest name for the operating system when guestId is otherGuest or otherGuest64.
424
386
  */
425
387
  alternateGuestName?: pulumi.Input<string>;
426
388
  /**
427
- * A user-provided description of the virtual machine.
389
+ * User-provided description of the virtual machine.
428
390
  */
429
391
  annotation?: pulumi.Input<string>;
430
392
  /**
431
- * The number of milliseconds to wait before starting the boot sequence. The default is no delay.
393
+ * The number of milliseconds to wait before starting the boot sequence.
432
394
  */
433
395
  bootDelay?: pulumi.Input<number>;
434
396
  /**
435
- * The number of milliseconds to wait before retrying the boot sequence. This option is only valid if `bootRetryEnabled` is `true`. Default: `10000` (10 seconds).
397
+ * The number of milliseconds to wait before retrying the boot sequence. This only valid if bootRetryEnabled is true.
436
398
  */
437
399
  bootRetryDelay?: pulumi.Input<number>;
438
400
  /**
439
- * If set to `true`, a virtual machine that fails to boot will try again after the delay defined in `bootRetryDelay`. Default: `false`.
401
+ * If set to true, a virtual machine that fails to boot will try again after the delay defined in boot_retry_delay.
440
402
  */
441
403
  bootRetryEnabled?: pulumi.Input<boolean>;
442
404
  /**
443
- * A specification for a CD-ROM device on the virtual machine. See CD-ROM options for more information.
405
+ * A specification for a CDROM device on this virtual machine.
444
406
  */
445
407
  cdroms?: pulumi.Input<pulumi.Input<inputs.VirtualMachineCdrom>[]>;
446
408
  /**
@@ -448,61 +410,55 @@ export interface VirtualMachineState {
448
410
  */
449
411
  changeVersion?: pulumi.Input<string>;
450
412
  /**
451
- * 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.
413
+ * A specification for cloning a virtual machine from template.
452
414
  */
453
415
  clone?: pulumi.Input<inputs.VirtualMachineClone>;
454
416
  /**
455
- * Allow CPUs to be added to the virtual machine while it is powered on.
417
+ * Allow CPUs to be added to this virtual machine while it is running.
456
418
  */
457
419
  cpuHotAddEnabled?: pulumi.Input<boolean>;
458
420
  /**
459
- * Allow CPUs to be removed to the virtual machine while it is powered on.
421
+ * Allow CPUs to be added to this virtual machine while it is running.
460
422
  */
461
423
  cpuHotRemoveEnabled?: pulumi.Input<boolean>;
462
424
  /**
463
- * The maximum amount of CPU (in MHz) that the virtual machine can consume, regardless of available resources. The default is no limit.
425
+ * The maximum amount of memory (in MB) or CPU (in MHz) that this virtual machine can consume, regardless of available
426
+ * resources.
464
427
  */
465
428
  cpuLimit?: pulumi.Input<number>;
466
429
  /**
467
- * Enable CPU performance counters on the virtual machine. Default: `false`.
430
+ * Enable CPU performance counters on this virtual machine.
468
431
  */
469
432
  cpuPerformanceCountersEnabled?: pulumi.Input<boolean>;
470
433
  /**
471
- * The amount of CPU (in MHz) that the virtual machine is guaranteed. The default is no reservation.
434
+ * The amount of memory (in MB) or CPU (in MHz) that this virtual machine is guaranteed.
472
435
  */
473
436
  cpuReservation?: pulumi.Input<number>;
474
437
  /**
475
- * The number of CPU shares allocated to the virtual machine when the `cpuShareLevel` is `custom`.
438
+ * The amount of shares to allocate to cpu for a custom share level.
476
439
  */
477
440
  cpuShareCount?: pulumi.Input<number>;
478
441
  /**
479
- * The allocation level for the virtual machine CPU resources. One of `high`, `low`, `normal`, or `custom`. Default: `custom`.
442
+ * The allocation level for cpu resources. Can be one of high, low, normal, or custom.
480
443
  */
481
444
  cpuShareLevel?: pulumi.Input<string>;
482
445
  /**
483
- * Map of custom attribute ids to attribute value strings to set for virtual machine. Please refer to the `vsphereCustomAttributes` resource for more information on setting custom attributes.
484
- *
485
- * > **NOTE:** Custom attributes requires vCenter Server and is not supported on direct ESXi host connections.
446
+ * A list of custom attributes to set on this resource.
486
447
  */
487
448
  customAttributes?: pulumi.Input<{
488
449
  [key: string]: pulumi.Input<string>;
489
450
  }>;
490
451
  /**
491
- * The datacenter ID. Required only when deploying an OVF/OVA template.
452
+ * The ID of the datacenter where the VM is to be created.
492
453
  */
493
454
  datacenterId?: pulumi.Input<string>;
494
455
  /**
495
- * 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.
496
- *
497
- * > **NOTE:** One of `datastoreId` or `datastoreClusterId` must be specified.
498
- *
499
- * > **NOTE:** Use of `datastoreClusterId` requires vSphere Storage DRS to be enabled on the specified datastore cluster.
500
- *
501
- * > **NOTE:** The `datastoreClusterId` 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.
456
+ * The ID of a datastore cluster to put the virtual machine in.
502
457
  */
503
458
  datastoreClusterId?: pulumi.Input<string>;
504
459
  /**
505
- * The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with `clientDevice`.
460
+ * The ID of the virtual machine's datastore. The virtual machine configuration is placed here, along with any virtual
461
+ * disks that are created without datastores.
506
462
  */
507
463
  datastoreId?: pulumi.Input<string>;
508
464
  /**
@@ -510,55 +466,50 @@ export interface VirtualMachineState {
510
466
  */
511
467
  defaultIpAddress?: pulumi.Input<string>;
512
468
  /**
513
- * A specification for a virtual disk device on the virtual machine. See disk options for more information.
469
+ * A specification for a virtual disk device on this virtual machine.
514
470
  */
515
471
  disks?: pulumi.Input<pulumi.Input<inputs.VirtualMachineDisk>[]>;
516
472
  /**
517
- * Use this option to enable EFI secure boot when the `firmware` type is set to is `efi`. Default: `false`.
518
- *
519
- * > **NOTE:** EFI secure boot is only available on vSphere 6.5 and later.
473
+ * When the boot type set in firmware is efi, this enables EFI secure boot.
520
474
  */
521
475
  efiSecureBootEnabled?: pulumi.Input<boolean>;
522
476
  /**
523
- * Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest. Default: `false`.
477
+ * Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest.
524
478
  */
525
479
  enableDiskUuid?: pulumi.Input<boolean>;
526
480
  /**
527
- * Enable logging of virtual machine events to a log file stored in the virtual machine directory. Default: `false`.
481
+ * Enable logging on this virtual machine.
528
482
  */
529
483
  enableLogging?: pulumi.Input<boolean>;
530
484
  /**
531
- * The EPT/RVI (hardware memory virtualization) setting for the virtual machine. One of `automatic`, `on`, or `off`. Default: `automatic`.
485
+ * The EPT/RVI (hardware memory virtualization) setting for this virtual machine. Can be one of automatic, on, or off.
532
486
  */
533
487
  eptRviMode?: pulumi.Input<string>;
534
488
  /**
535
- * Extra configuration data for the virtual machine. Can be used to supply advanced parameters not normally in configuration, such as instance metadata and userdata.
536
- *
537
- * > **NOTE:** Do not use `extraConfig` 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.
489
+ * Extra configuration data for this virtual machine. Can be used to supply advanced parameters not normally in
490
+ * configuration, such as instance metadata, or configuration data for OVF images.
538
491
  */
539
492
  extraConfig?: pulumi.Input<{
540
493
  [key: string]: pulumi.Input<string>;
541
494
  }>;
542
495
  /**
543
- * Allow the virtual machine to be rebooted when a change to `extraConfig` occurs. Default: `true`.
496
+ * Allow the virtual machine to be rebooted when a change to `extraConfig` occurs.
544
497
  */
545
498
  extraConfigRebootRequired?: pulumi.Input<boolean>;
546
499
  /**
547
- * The firmware for the virtual machine. One of `bios` or `efi`.
500
+ * The firmware interface to use on the virtual machine. Can be one of bios or efi.
548
501
  */
549
502
  firmware?: pulumi.Input<string>;
550
503
  /**
551
- * 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`
504
+ * The name of the folder to locate the virtual machine in.
552
505
  */
553
506
  folder?: pulumi.Input<string>;
554
507
  /**
555
- * If a guest shutdown failed or times out while updating or destroying (see `shutdownWaitTimeout`), force the power-off of the virtual machine. Default: `true`.
508
+ * Set to true to force power-off a virtual machine if a graceful guest shutdown failed for a necessary operation.
556
509
  */
557
510
  forcePowerOff?: pulumi.Input<boolean>;
558
511
  /**
559
- * The guest ID for the operating system type. For a full list of possible values, see [here][vmware-docs-guest-ids]. Default: `otherGuest64`.
560
- *
561
- * [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
512
+ * The guest ID for the operating system.
562
513
  */
563
514
  guestId?: pulumi.Input<string>;
564
515
  /**
@@ -566,26 +517,20 @@ export interface VirtualMachineState {
566
517
  */
567
518
  guestIpAddresses?: pulumi.Input<pulumi.Input<string>[]>;
568
519
  /**
569
- * 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.
570
- *
571
- * [virtual-machine-hardware-versions]: https://kb.vmware.com/s/article/1003746
572
- * [virtual-machine-hardware-compatibility]: https://kb.vmware.com/s/article/2007240
520
+ * The hardware version for the virtual machine.
573
521
  */
574
522
  hardwareVersion?: pulumi.Input<number>;
575
523
  /**
576
- * 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 `hostSystemId` 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.
524
+ * The ID of an optional host system to pin the virtual machine to.
577
525
  */
578
526
  hostSystemId?: pulumi.Input<string>;
579
527
  /**
580
- * The hardware virtualization (non-nested) setting for the virtual machine. One of `hvAuto`, `hvOn`, or `hvOff`. Default: `hvAuto`.
528
+ * The (non-nested) hardware virtualization setting for this virtual machine. Can be one of hvAuto, hvOn, or hvOff.
581
529
  */
582
530
  hvMode?: pulumi.Input<string>;
583
- /**
584
- * 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`.
585
- */
586
531
  ideControllerCount?: pulumi.Input<number>;
587
532
  /**
588
- * 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: `[]`.
533
+ * List of IP addresses and CIDR networks to ignore while waiting for an IP
589
534
  */
590
535
  ignoredGuestIps?: pulumi.Input<pulumi.Input<string>[]>;
591
536
  /**
@@ -593,33 +538,26 @@ export interface VirtualMachineState {
593
538
  */
594
539
  imported?: pulumi.Input<boolean>;
595
540
  /**
596
- * 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`.
597
- *
598
- * > **NOTE:** On higher sensitivities, you may need to adjust the `memoryReservation` to the full amount of memory provisioned for the virtual machine.
541
+ * Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower
542
+ * latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard
543
+ * devices. Can be one of low, normal, medium, or high.
599
544
  */
600
545
  latencySensitivity?: pulumi.Input<string>;
601
546
  /**
602
- * The memory size to assign to the virtual machine, in MB. Default: `1024` (1 GB).
547
+ * The size of the virtual machine's memory, in MB.
603
548
  */
604
549
  memory?: pulumi.Input<number>;
605
550
  /**
606
- * Allow memory to be added to the virtual machine while it is powered on.
607
- *
608
- * > **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.
609
- *
610
- * [vmware-docs-compat-guide]: http://partnerweb.vmware.com/comp_guide2/pdf/VMware_GOS_Compatibility_Guide.pdf
611
- *
612
- * > **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].
613
- *
614
- * [vmware-kb-2008405]: https://kb.vmware.com/s/article/2008405
551
+ * Allow memory to be added to this virtual machine while it is running.
615
552
  */
616
553
  memoryHotAddEnabled?: pulumi.Input<boolean>;
617
554
  /**
618
- * The maximum amount of memory (in MB) that th virtual machine can consume, regardless of available resources. The default is no limit.
555
+ * The maximum amount of memory (in MB) or CPU (in MHz) that this virtual machine can consume, regardless of available
556
+ * resources.
619
557
  */
620
558
  memoryLimit?: pulumi.Input<number>;
621
559
  /**
622
- * The amount of memory (in MB) that the virtual machine is guaranteed. The default is no reservation.
560
+ * The amount of memory (in MB) or CPU (in MHz) that this virtual machine is guaranteed.
623
561
  */
624
562
  memoryReservation?: pulumi.Input<number>;
625
563
  /**
@@ -629,15 +567,15 @@ export interface VirtualMachineState {
629
567
  */
630
568
  memoryReservationLockedToMax?: pulumi.Input<boolean>;
631
569
  /**
632
- * The number of memory shares allocated to the virtual machine when the `memoryShareLevel` is `custom`.
570
+ * The amount of shares to allocate to memory for a custom share level.
633
571
  */
634
572
  memoryShareCount?: pulumi.Input<number>;
635
573
  /**
636
- * The allocation level for the virtual machine memory resources. One of `high`, `low`, `normal`, or `custom`. Default: `custom`.
574
+ * The allocation level for memory resources. Can be one of high, low, normal, or custom.
637
575
  */
638
576
  memoryShareLevel?: pulumi.Input<string>;
639
577
  /**
640
- * 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.
578
+ * The amount of time, in minutes, to wait for a vMotion operation to complete before failing.
641
579
  */
642
580
  migrateWaitTimeout?: pulumi.Input<number>;
643
581
  /**
@@ -645,33 +583,32 @@ export interface VirtualMachineState {
645
583
  */
646
584
  moid?: pulumi.Input<string>;
647
585
  /**
648
- * The name of the virtual machine.
586
+ * The name of this virtual machine.
649
587
  */
650
588
  name?: pulumi.Input<string>;
651
589
  /**
652
- * Enable nested hardware virtualization on the virtual machine, facilitating nested virtualization in the guest operating system. Default: `false`.
590
+ * Enable nested hardware virtualization on this virtual machine, facilitating nested virtualization in the guest.
653
591
  */
654
592
  nestedHvEnabled?: pulumi.Input<boolean>;
655
593
  /**
656
- * A specification for a virtual NIC on the virtual machine. See network interface options for more information.
594
+ * A specification for a virtual NIC on this virtual machine.
657
595
  */
658
596
  networkInterfaces?: pulumi.Input<pulumi.Input<inputs.VirtualMachineNetworkInterface>[]>;
659
597
  /**
660
- * The number of cores per socket in the virtual machine. The number of vCPUs on the virtual machine will be `numCpus` divided by `numCoresPerSocket`. If specified, the value supplied to `numCpus` must be evenly divisible by this value. Default: `1`.
598
+ * The number of cores to distribute amongst the CPUs in this virtual machine. If specified, the value supplied to numCpus
599
+ * must be evenly divisible by this value.
661
600
  */
662
601
  numCoresPerSocket?: pulumi.Input<number>;
663
602
  /**
664
- * The total number of virtual processor cores to assign to the virtual machine. Default: `1`.
603
+ * The number of virtual processors to assign to this virtual machine.
665
604
  */
666
605
  numCpus?: pulumi.Input<number>;
667
606
  /**
668
- * 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.
607
+ * A specification for deploying a virtual machine from ovf/ova template.
669
608
  */
670
609
  ovfDeploy?: pulumi.Input<inputs.VirtualMachineOvfDeploy>;
671
610
  /**
672
- * List of host PCI device IDs in which to create PCI passthroughs.
673
- *
674
- * > **NOTE:** Cloning requires vCenter Server and is not supported on direct ESXi host connections.
611
+ * A list of PCI passthrough devices
675
612
  */
676
613
  pciDeviceIds?: pulumi.Input<pulumi.Input<string>[]>;
677
614
  /**
@@ -682,98 +619,81 @@ export interface VirtualMachineState {
682
619
  * The amount of time, in seconds, that we will be trying to power on a VM
683
620
  */
684
621
  poweronTimeout?: pulumi.Input<number>;
685
- /**
686
- * Value internal to Terraform used to determine if a configuration set change requires a reboot.
687
- */
688
622
  rebootRequired?: pulumi.Input<boolean>;
689
623
  /**
690
624
  * Triggers replacement of resource whenever it changes.
691
- *
692
- * For example, `replaceTrigger = 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.)
693
625
  */
694
626
  replaceTrigger?: pulumi.Input<string>;
695
627
  /**
696
- * 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.
697
- *
698
- * > **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 `vsphere.ResourcePool` data source documentation on using the root resource pool.
628
+ * The ID of a resource pool to put the virtual machine in.
699
629
  */
700
630
  resourcePoolId?: pulumi.Input<string>;
701
631
  /**
702
- * Enable post-power-on scripts to run when VMware Tools is installed. Default: `true`.
632
+ * Enable the run of scripts after virtual machine power-on when VMware Tools is installed.
703
633
  */
704
634
  runToolsScriptsAfterPowerOn?: pulumi.Input<boolean>;
705
635
  /**
706
- * Enable ost-resume scripts to run when VMware Tools is installed. Default: `true`.
636
+ * Enable the run of scripts after virtual machine resume when when VMware Tools is installed.
707
637
  */
708
638
  runToolsScriptsAfterResume?: pulumi.Input<boolean>;
709
639
  /**
710
- * Enable pre-reboot scripts to run when VMware Tools is installed. Default: `false`.
640
+ * Enable the run of scripts before guest operating system reboot when VMware Tools is installed.
711
641
  */
712
642
  runToolsScriptsBeforeGuestReboot?: pulumi.Input<boolean>;
713
643
  /**
714
- * Enable pre-shutdown scripts to run when VMware Tools is installed. Default: `true`.
644
+ * Enable the run of scripts before guest operating system shutdown when VMware Tools is installed.
715
645
  */
716
646
  runToolsScriptsBeforeGuestShutdown?: pulumi.Input<boolean>;
717
647
  /**
718
- * Enable pre-standby scripts to run when VMware Tools is installed. Default: `true`.
648
+ * Enable the run of scripts before guest operating system standby when VMware Tools is installed.
719
649
  */
720
650
  runToolsScriptsBeforeGuestStandby?: pulumi.Input<boolean>;
721
- /**
722
- * The number of SATA controllers that Terraform manages on this virtual machine. This directly affects the amount of disks
723
- * you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove
724
- * controllers.
725
- */
726
651
  sataControllerCount?: pulumi.Input<number>;
727
652
  /**
728
- * The type of SCSI bus sharing for the virtual machine SCSI controller. One of `physicalSharing`, `virtualSharing`, and `noSharing`. Default: `noSharing`.
653
+ * Mode for sharing the SCSI bus. The modes are physicalSharing, virtualSharing, and noSharing.
729
654
  */
730
655
  scsiBusSharing?: pulumi.Input<string>;
731
- /**
732
- * The number of SCSI controllers that Terraform manages on this virtual machine. This directly affects the amount of disks
733
- * you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove
734
- * controllers.
735
- */
736
656
  scsiControllerCount?: pulumi.Input<number>;
737
657
  /**
738
- * 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`.
658
+ * The type of SCSI bus this virtual machine will have. Can be one of lsilogic, lsilogic-sas or pvscsi.
739
659
  */
740
660
  scsiType?: pulumi.Input<string>;
741
661
  /**
742
- * The amount of time, in minutes, to wait for a graceful guest shutdown when making necessary updates to the virtual machine. If `forcePowerOff` is set to `true`, the virtual machine will be forced to power-off after the timeout, otherwise an error is returned. Default: `3` minutes.
662
+ * The amount of time, in minutes, to wait for shutdown when making necessary updates to the virtual machine.
743
663
  */
744
664
  shutdownWaitTimeout?: pulumi.Input<number>;
745
665
  /**
746
- * The UUID of the storage policy to assign to the virtual disk.
666
+ * The ID of the storage policy to assign to the virtual machine home directory.
747
667
  */
748
668
  storagePolicyId?: pulumi.Input<string>;
749
669
  /**
750
- * The swap file placement policy for the virtual machine. One of `inherit`, `hostLocal`, or `vmDirectory`. Default: `inherit`.
670
+ * The swap file placement policy for this virtual machine. Can be one of inherit, hostLocal, or vmDirectory.
751
671
  */
752
672
  swapPlacementPolicy?: pulumi.Input<string>;
753
673
  /**
754
- * 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`.
674
+ * Enable guest clock synchronization with the host. On vSphere 7.0 U1 and above, with only this setting the clock is
675
+ * synchronized on startup and resume. Requires VMware Tools to be installed.
755
676
  */
756
677
  syncTimeWithHost?: pulumi.Input<boolean>;
757
678
  /**
758
- * 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 `syncTimeWithHost` is will enable periodic synchronization. Requires VMware Tools to be installed. Default: `false`.
679
+ * Enable periodic clock synchronization with the host. Supported only on vSphere 7.0 U1 and above. On prior versions
680
+ * setting `syncTimeWithHost` is enough for periodic synchronization. Requires VMware Tools to be installed.
759
681
  */
760
682
  syncTimeWithHostPeriodically?: pulumi.Input<boolean>;
761
683
  /**
762
- * The IDs of any tags to attach to this resource. Please refer to the `vsphere.Tag` resource for more information on applying tags to virtual machine resources.
763
- *
764
- * > **NOTE:** Tagging support is unsupported on direct ESXi host connections and requires vCenter Server instance.
684
+ * A list of tag IDs to apply to this object.
765
685
  */
766
686
  tags?: pulumi.Input<pulumi.Input<string>[]>;
767
687
  /**
768
- * 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`.
688
+ * Set the upgrade policy for VMware Tools. Can be one of `manual` or `upgradeAtPowerCycle`.
769
689
  */
770
690
  toolsUpgradePolicy?: pulumi.Input<string>;
771
691
  /**
772
- * The UUID of the virtual disk VMDK file. This is used to track the virtual disk on the virtual machine.
692
+ * The UUID of the virtual machine. Also exposed as the `id` of the resource.
773
693
  */
774
694
  uuid?: pulumi.Input<string>;
775
695
  /**
776
- * 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.
696
+ * vApp configuration data for this virtual machine. Can be used to provide configuration data for OVF images.
777
697
  */
778
698
  vapp?: pulumi.Input<inputs.VirtualMachineVapp>;
779
699
  /**
@@ -781,7 +701,7 @@ export interface VirtualMachineState {
781
701
  */
782
702
  vappTransports?: pulumi.Input<pulumi.Input<string>[]>;
783
703
  /**
784
- * Enable Virtualization Based Security. Requires `firmware` to be `efi`. In addition, `vvtdEnabled`, `nestedHvEnabled`, and `efiSecureBootEnabled` must all have a value of `true`. Supported on vSphere 6.7 and later. Default: `false`.
704
+ * Flag to specify if Virtualization-based security is enabled for this virtual machine.
785
705
  */
786
706
  vbsEnabled?: pulumi.Input<boolean>;
787
707
  /**
@@ -793,19 +713,23 @@ export interface VirtualMachineState {
793
713
  */
794
714
  vmxPath?: pulumi.Input<string>;
795
715
  /**
796
- * 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`.
716
+ * Flag to specify if I/O MMU virtualization, also called Intel Virtualization Technology for Directed I/O (VT-d) and AMD
717
+ * I/O Virtualization (AMD-Vi or IOMMU), is enabled.
797
718
  */
798
719
  vvtdEnabled?: pulumi.Input<boolean>;
799
720
  /**
800
- * 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 `waitForGuestNetTimeout` waiter to be used. A value less than `1` disables the waiter. Default: `0`.
721
+ * The amount of time, in minutes, to wait for an available IP address on this virtual machine. A value less than 1
722
+ * disables the waiter.
801
723
  */
802
724
  waitForGuestIpTimeout?: pulumi.Input<number>;
803
725
  /**
804
- * 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 `waitForGuestIpTimeout` waiter is used. Default: `true`.
726
+ * Controls whether or not the guest network waiter waits for a routable address. When false, the waiter does not wait for
727
+ * a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria.
805
728
  */
806
729
  waitForGuestNetRoutable?: pulumi.Input<boolean>;
807
730
  /**
808
- * 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 `waitForGuestIpTimeout` waiter can be used instead. A value less than `1` disables the waiter. Default: `5` minutes.
731
+ * The amount of time, in minutes, to wait for an available IP address on this virtual machine. A value less than 1
732
+ * disables the waiter.
809
733
  */
810
734
  waitForGuestNetTimeout?: pulumi.Input<number>;
811
735
  }
@@ -814,190 +738,166 @@ export interface VirtualMachineState {
814
738
  */
815
739
  export interface VirtualMachineArgs {
816
740
  /**
817
- * The guest name for the operating system when `guestId` is `otherGuest` or `otherGuest64`.
741
+ * The guest name for the operating system when guestId is otherGuest or otherGuest64.
818
742
  */
819
743
  alternateGuestName?: pulumi.Input<string>;
820
744
  /**
821
- * A user-provided description of the virtual machine.
745
+ * User-provided description of the virtual machine.
822
746
  */
823
747
  annotation?: pulumi.Input<string>;
824
748
  /**
825
- * The number of milliseconds to wait before starting the boot sequence. The default is no delay.
749
+ * The number of milliseconds to wait before starting the boot sequence.
826
750
  */
827
751
  bootDelay?: pulumi.Input<number>;
828
752
  /**
829
- * The number of milliseconds to wait before retrying the boot sequence. This option is only valid if `bootRetryEnabled` is `true`. Default: `10000` (10 seconds).
753
+ * The number of milliseconds to wait before retrying the boot sequence. This only valid if bootRetryEnabled is true.
830
754
  */
831
755
  bootRetryDelay?: pulumi.Input<number>;
832
756
  /**
833
- * If set to `true`, a virtual machine that fails to boot will try again after the delay defined in `bootRetryDelay`. Default: `false`.
757
+ * If set to true, a virtual machine that fails to boot will try again after the delay defined in boot_retry_delay.
834
758
  */
835
759
  bootRetryEnabled?: pulumi.Input<boolean>;
836
760
  /**
837
- * A specification for a CD-ROM device on the virtual machine. See CD-ROM options for more information.
761
+ * A specification for a CDROM device on this virtual machine.
838
762
  */
839
763
  cdroms?: pulumi.Input<pulumi.Input<inputs.VirtualMachineCdrom>[]>;
840
764
  /**
841
- * 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.
765
+ * A specification for cloning a virtual machine from template.
842
766
  */
843
767
  clone?: pulumi.Input<inputs.VirtualMachineClone>;
844
768
  /**
845
- * Allow CPUs to be added to the virtual machine while it is powered on.
769
+ * Allow CPUs to be added to this virtual machine while it is running.
846
770
  */
847
771
  cpuHotAddEnabled?: pulumi.Input<boolean>;
848
772
  /**
849
- * Allow CPUs to be removed to the virtual machine while it is powered on.
773
+ * Allow CPUs to be added to this virtual machine while it is running.
850
774
  */
851
775
  cpuHotRemoveEnabled?: pulumi.Input<boolean>;
852
776
  /**
853
- * The maximum amount of CPU (in MHz) that the virtual machine can consume, regardless of available resources. The default is no limit.
777
+ * The maximum amount of memory (in MB) or CPU (in MHz) that this virtual machine can consume, regardless of available
778
+ * resources.
854
779
  */
855
780
  cpuLimit?: pulumi.Input<number>;
856
781
  /**
857
- * Enable CPU performance counters on the virtual machine. Default: `false`.
782
+ * Enable CPU performance counters on this virtual machine.
858
783
  */
859
784
  cpuPerformanceCountersEnabled?: pulumi.Input<boolean>;
860
785
  /**
861
- * The amount of CPU (in MHz) that the virtual machine is guaranteed. The default is no reservation.
786
+ * The amount of memory (in MB) or CPU (in MHz) that this virtual machine is guaranteed.
862
787
  */
863
788
  cpuReservation?: pulumi.Input<number>;
864
789
  /**
865
- * The number of CPU shares allocated to the virtual machine when the `cpuShareLevel` is `custom`.
790
+ * The amount of shares to allocate to cpu for a custom share level.
866
791
  */
867
792
  cpuShareCount?: pulumi.Input<number>;
868
793
  /**
869
- * The allocation level for the virtual machine CPU resources. One of `high`, `low`, `normal`, or `custom`. Default: `custom`.
794
+ * The allocation level for cpu resources. Can be one of high, low, normal, or custom.
870
795
  */
871
796
  cpuShareLevel?: pulumi.Input<string>;
872
797
  /**
873
- * Map of custom attribute ids to attribute value strings to set for virtual machine. Please refer to the `vsphereCustomAttributes` resource for more information on setting custom attributes.
874
- *
875
- * > **NOTE:** Custom attributes requires vCenter Server and is not supported on direct ESXi host connections.
798
+ * A list of custom attributes to set on this resource.
876
799
  */
877
800
  customAttributes?: pulumi.Input<{
878
801
  [key: string]: pulumi.Input<string>;
879
802
  }>;
880
803
  /**
881
- * The datacenter ID. Required only when deploying an OVF/OVA template.
804
+ * The ID of the datacenter where the VM is to be created.
882
805
  */
883
806
  datacenterId?: pulumi.Input<string>;
884
807
  /**
885
- * 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.
886
- *
887
- * > **NOTE:** One of `datastoreId` or `datastoreClusterId` must be specified.
888
- *
889
- * > **NOTE:** Use of `datastoreClusterId` requires vSphere Storage DRS to be enabled on the specified datastore cluster.
890
- *
891
- * > **NOTE:** The `datastoreClusterId` 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.
808
+ * The ID of a datastore cluster to put the virtual machine in.
892
809
  */
893
810
  datastoreClusterId?: pulumi.Input<string>;
894
811
  /**
895
- * The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with `clientDevice`.
812
+ * The ID of the virtual machine's datastore. The virtual machine configuration is placed here, along with any virtual
813
+ * disks that are created without datastores.
896
814
  */
897
815
  datastoreId?: pulumi.Input<string>;
898
816
  /**
899
- * A specification for a virtual disk device on the virtual machine. See disk options for more information.
817
+ * A specification for a virtual disk device on this virtual machine.
900
818
  */
901
819
  disks?: pulumi.Input<pulumi.Input<inputs.VirtualMachineDisk>[]>;
902
820
  /**
903
- * Use this option to enable EFI secure boot when the `firmware` type is set to is `efi`. Default: `false`.
904
- *
905
- * > **NOTE:** EFI secure boot is only available on vSphere 6.5 and later.
821
+ * When the boot type set in firmware is efi, this enables EFI secure boot.
906
822
  */
907
823
  efiSecureBootEnabled?: pulumi.Input<boolean>;
908
824
  /**
909
- * Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest. Default: `false`.
825
+ * Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest.
910
826
  */
911
827
  enableDiskUuid?: pulumi.Input<boolean>;
912
828
  /**
913
- * Enable logging of virtual machine events to a log file stored in the virtual machine directory. Default: `false`.
829
+ * Enable logging on this virtual machine.
914
830
  */
915
831
  enableLogging?: pulumi.Input<boolean>;
916
832
  /**
917
- * The EPT/RVI (hardware memory virtualization) setting for the virtual machine. One of `automatic`, `on`, or `off`. Default: `automatic`.
833
+ * The EPT/RVI (hardware memory virtualization) setting for this virtual machine. Can be one of automatic, on, or off.
918
834
  */
919
835
  eptRviMode?: pulumi.Input<string>;
920
836
  /**
921
- * Extra configuration data for the virtual machine. Can be used to supply advanced parameters not normally in configuration, such as instance metadata and userdata.
922
- *
923
- * > **NOTE:** Do not use `extraConfig` 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.
837
+ * Extra configuration data for this virtual machine. Can be used to supply advanced parameters not normally in
838
+ * configuration, such as instance metadata, or configuration data for OVF images.
924
839
  */
925
840
  extraConfig?: pulumi.Input<{
926
841
  [key: string]: pulumi.Input<string>;
927
842
  }>;
928
843
  /**
929
- * Allow the virtual machine to be rebooted when a change to `extraConfig` occurs. Default: `true`.
844
+ * Allow the virtual machine to be rebooted when a change to `extraConfig` occurs.
930
845
  */
931
846
  extraConfigRebootRequired?: pulumi.Input<boolean>;
932
847
  /**
933
- * The firmware for the virtual machine. One of `bios` or `efi`.
848
+ * The firmware interface to use on the virtual machine. Can be one of bios or efi.
934
849
  */
935
850
  firmware?: pulumi.Input<string>;
936
851
  /**
937
- * 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`
852
+ * The name of the folder to locate the virtual machine in.
938
853
  */
939
854
  folder?: pulumi.Input<string>;
940
855
  /**
941
- * If a guest shutdown failed or times out while updating or destroying (see `shutdownWaitTimeout`), force the power-off of the virtual machine. Default: `true`.
856
+ * Set to true to force power-off a virtual machine if a graceful guest shutdown failed for a necessary operation.
942
857
  */
943
858
  forcePowerOff?: pulumi.Input<boolean>;
944
859
  /**
945
- * The guest ID for the operating system type. For a full list of possible values, see [here][vmware-docs-guest-ids]. Default: `otherGuest64`.
946
- *
947
- * [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
860
+ * The guest ID for the operating system.
948
861
  */
949
862
  guestId?: pulumi.Input<string>;
950
863
  /**
951
- * 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.
952
- *
953
- * [virtual-machine-hardware-versions]: https://kb.vmware.com/s/article/1003746
954
- * [virtual-machine-hardware-compatibility]: https://kb.vmware.com/s/article/2007240
864
+ * The hardware version for the virtual machine.
955
865
  */
956
866
  hardwareVersion?: pulumi.Input<number>;
957
867
  /**
958
- * 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 `hostSystemId` 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.
868
+ * The ID of an optional host system to pin the virtual machine to.
959
869
  */
960
870
  hostSystemId?: pulumi.Input<string>;
961
871
  /**
962
- * The hardware virtualization (non-nested) setting for the virtual machine. One of `hvAuto`, `hvOn`, or `hvOff`. Default: `hvAuto`.
872
+ * The (non-nested) hardware virtualization setting for this virtual machine. Can be one of hvAuto, hvOn, or hvOff.
963
873
  */
964
874
  hvMode?: pulumi.Input<string>;
965
- /**
966
- * 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`.
967
- */
968
875
  ideControllerCount?: pulumi.Input<number>;
969
876
  /**
970
- * 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: `[]`.
877
+ * List of IP addresses and CIDR networks to ignore while waiting for an IP
971
878
  */
972
879
  ignoredGuestIps?: pulumi.Input<pulumi.Input<string>[]>;
973
880
  /**
974
- * 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`.
975
- *
976
- * > **NOTE:** On higher sensitivities, you may need to adjust the `memoryReservation` to the full amount of memory provisioned for the virtual machine.
881
+ * Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower
882
+ * latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard
883
+ * devices. Can be one of low, normal, medium, or high.
977
884
  */
978
885
  latencySensitivity?: pulumi.Input<string>;
979
886
  /**
980
- * The memory size to assign to the virtual machine, in MB. Default: `1024` (1 GB).
887
+ * The size of the virtual machine's memory, in MB.
981
888
  */
982
889
  memory?: pulumi.Input<number>;
983
890
  /**
984
- * Allow memory to be added to the virtual machine while it is powered on.
985
- *
986
- * > **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.
987
- *
988
- * [vmware-docs-compat-guide]: http://partnerweb.vmware.com/comp_guide2/pdf/VMware_GOS_Compatibility_Guide.pdf
989
- *
990
- * > **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].
991
- *
992
- * [vmware-kb-2008405]: https://kb.vmware.com/s/article/2008405
891
+ * Allow memory to be added to this virtual machine while it is running.
993
892
  */
994
893
  memoryHotAddEnabled?: pulumi.Input<boolean>;
995
894
  /**
996
- * The maximum amount of memory (in MB) that th virtual machine can consume, regardless of available resources. The default is no limit.
895
+ * The maximum amount of memory (in MB) or CPU (in MHz) that this virtual machine can consume, regardless of available
896
+ * resources.
997
897
  */
998
898
  memoryLimit?: pulumi.Input<number>;
999
899
  /**
1000
- * The amount of memory (in MB) that the virtual machine is guaranteed. The default is no reservation.
900
+ * The amount of memory (in MB) or CPU (in MHz) that this virtual machine is guaranteed.
1001
901
  */
1002
902
  memoryReservation?: pulumi.Input<number>;
1003
903
  /**
@@ -1007,45 +907,44 @@ export interface VirtualMachineArgs {
1007
907
  */
1008
908
  memoryReservationLockedToMax?: pulumi.Input<boolean>;
1009
909
  /**
1010
- * The number of memory shares allocated to the virtual machine when the `memoryShareLevel` is `custom`.
910
+ * The amount of shares to allocate to memory for a custom share level.
1011
911
  */
1012
912
  memoryShareCount?: pulumi.Input<number>;
1013
913
  /**
1014
- * The allocation level for the virtual machine memory resources. One of `high`, `low`, `normal`, or `custom`. Default: `custom`.
914
+ * The allocation level for memory resources. Can be one of high, low, normal, or custom.
1015
915
  */
1016
916
  memoryShareLevel?: pulumi.Input<string>;
1017
917
  /**
1018
- * 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.
918
+ * The amount of time, in minutes, to wait for a vMotion operation to complete before failing.
1019
919
  */
1020
920
  migrateWaitTimeout?: pulumi.Input<number>;
1021
921
  /**
1022
- * The name of the virtual machine.
922
+ * The name of this virtual machine.
1023
923
  */
1024
924
  name?: pulumi.Input<string>;
1025
925
  /**
1026
- * Enable nested hardware virtualization on the virtual machine, facilitating nested virtualization in the guest operating system. Default: `false`.
926
+ * Enable nested hardware virtualization on this virtual machine, facilitating nested virtualization in the guest.
1027
927
  */
1028
928
  nestedHvEnabled?: pulumi.Input<boolean>;
1029
929
  /**
1030
- * A specification for a virtual NIC on the virtual machine. See network interface options for more information.
930
+ * A specification for a virtual NIC on this virtual machine.
1031
931
  */
1032
932
  networkInterfaces?: pulumi.Input<pulumi.Input<inputs.VirtualMachineNetworkInterface>[]>;
1033
933
  /**
1034
- * The number of cores per socket in the virtual machine. The number of vCPUs on the virtual machine will be `numCpus` divided by `numCoresPerSocket`. If specified, the value supplied to `numCpus` must be evenly divisible by this value. Default: `1`.
934
+ * The number of cores to distribute amongst the CPUs in this virtual machine. If specified, the value supplied to numCpus
935
+ * must be evenly divisible by this value.
1035
936
  */
1036
937
  numCoresPerSocket?: pulumi.Input<number>;
1037
938
  /**
1038
- * The total number of virtual processor cores to assign to the virtual machine. Default: `1`.
939
+ * The number of virtual processors to assign to this virtual machine.
1039
940
  */
1040
941
  numCpus?: pulumi.Input<number>;
1041
942
  /**
1042
- * 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.
943
+ * A specification for deploying a virtual machine from ovf/ova template.
1043
944
  */
1044
945
  ovfDeploy?: pulumi.Input<inputs.VirtualMachineOvfDeploy>;
1045
946
  /**
1046
- * List of host PCI device IDs in which to create PCI passthroughs.
1047
- *
1048
- * > **NOTE:** Cloning requires vCenter Server and is not supported on direct ESXi host connections.
947
+ * A list of PCI passthrough devices
1049
948
  */
1050
949
  pciDeviceIds?: pulumi.Input<pulumi.Input<string>[]>;
1051
950
  /**
@@ -1054,108 +953,98 @@ export interface VirtualMachineArgs {
1054
953
  poweronTimeout?: pulumi.Input<number>;
1055
954
  /**
1056
955
  * Triggers replacement of resource whenever it changes.
1057
- *
1058
- * For example, `replaceTrigger = 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.)
1059
956
  */
1060
957
  replaceTrigger?: pulumi.Input<string>;
1061
958
  /**
1062
- * 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.
1063
- *
1064
- * > **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 `vsphere.ResourcePool` data source documentation on using the root resource pool.
959
+ * The ID of a resource pool to put the virtual machine in.
1065
960
  */
1066
961
  resourcePoolId: pulumi.Input<string>;
1067
962
  /**
1068
- * Enable post-power-on scripts to run when VMware Tools is installed. Default: `true`.
963
+ * Enable the run of scripts after virtual machine power-on when VMware Tools is installed.
1069
964
  */
1070
965
  runToolsScriptsAfterPowerOn?: pulumi.Input<boolean>;
1071
966
  /**
1072
- * Enable ost-resume scripts to run when VMware Tools is installed. Default: `true`.
967
+ * Enable the run of scripts after virtual machine resume when when VMware Tools is installed.
1073
968
  */
1074
969
  runToolsScriptsAfterResume?: pulumi.Input<boolean>;
1075
970
  /**
1076
- * Enable pre-reboot scripts to run when VMware Tools is installed. Default: `false`.
971
+ * Enable the run of scripts before guest operating system reboot when VMware Tools is installed.
1077
972
  */
1078
973
  runToolsScriptsBeforeGuestReboot?: pulumi.Input<boolean>;
1079
974
  /**
1080
- * Enable pre-shutdown scripts to run when VMware Tools is installed. Default: `true`.
975
+ * Enable the run of scripts before guest operating system shutdown when VMware Tools is installed.
1081
976
  */
1082
977
  runToolsScriptsBeforeGuestShutdown?: pulumi.Input<boolean>;
1083
978
  /**
1084
- * Enable pre-standby scripts to run when VMware Tools is installed. Default: `true`.
979
+ * Enable the run of scripts before guest operating system standby when VMware Tools is installed.
1085
980
  */
1086
981
  runToolsScriptsBeforeGuestStandby?: pulumi.Input<boolean>;
1087
- /**
1088
- * The number of SATA controllers that Terraform manages on this virtual machine. This directly affects the amount of disks
1089
- * you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove
1090
- * controllers.
1091
- */
1092
982
  sataControllerCount?: pulumi.Input<number>;
1093
983
  /**
1094
- * The type of SCSI bus sharing for the virtual machine SCSI controller. One of `physicalSharing`, `virtualSharing`, and `noSharing`. Default: `noSharing`.
984
+ * Mode for sharing the SCSI bus. The modes are physicalSharing, virtualSharing, and noSharing.
1095
985
  */
1096
986
  scsiBusSharing?: pulumi.Input<string>;
1097
- /**
1098
- * The number of SCSI controllers that Terraform manages on this virtual machine. This directly affects the amount of disks
1099
- * you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove
1100
- * controllers.
1101
- */
1102
987
  scsiControllerCount?: pulumi.Input<number>;
1103
988
  /**
1104
- * 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`.
989
+ * The type of SCSI bus this virtual machine will have. Can be one of lsilogic, lsilogic-sas or pvscsi.
1105
990
  */
1106
991
  scsiType?: pulumi.Input<string>;
1107
992
  /**
1108
- * The amount of time, in minutes, to wait for a graceful guest shutdown when making necessary updates to the virtual machine. If `forcePowerOff` is set to `true`, the virtual machine will be forced to power-off after the timeout, otherwise an error is returned. Default: `3` minutes.
993
+ * The amount of time, in minutes, to wait for shutdown when making necessary updates to the virtual machine.
1109
994
  */
1110
995
  shutdownWaitTimeout?: pulumi.Input<number>;
1111
996
  /**
1112
- * The UUID of the storage policy to assign to the virtual disk.
997
+ * The ID of the storage policy to assign to the virtual machine home directory.
1113
998
  */
1114
999
  storagePolicyId?: pulumi.Input<string>;
1115
1000
  /**
1116
- * The swap file placement policy for the virtual machine. One of `inherit`, `hostLocal`, or `vmDirectory`. Default: `inherit`.
1001
+ * The swap file placement policy for this virtual machine. Can be one of inherit, hostLocal, or vmDirectory.
1117
1002
  */
1118
1003
  swapPlacementPolicy?: pulumi.Input<string>;
1119
1004
  /**
1120
- * 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`.
1005
+ * Enable guest clock synchronization with the host. On vSphere 7.0 U1 and above, with only this setting the clock is
1006
+ * synchronized on startup and resume. Requires VMware Tools to be installed.
1121
1007
  */
1122
1008
  syncTimeWithHost?: pulumi.Input<boolean>;
1123
1009
  /**
1124
- * 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 `syncTimeWithHost` is will enable periodic synchronization. Requires VMware Tools to be installed. Default: `false`.
1010
+ * Enable periodic clock synchronization with the host. Supported only on vSphere 7.0 U1 and above. On prior versions
1011
+ * setting `syncTimeWithHost` is enough for periodic synchronization. Requires VMware Tools to be installed.
1125
1012
  */
1126
1013
  syncTimeWithHostPeriodically?: pulumi.Input<boolean>;
1127
1014
  /**
1128
- * The IDs of any tags to attach to this resource. Please refer to the `vsphere.Tag` resource for more information on applying tags to virtual machine resources.
1129
- *
1130
- * > **NOTE:** Tagging support is unsupported on direct ESXi host connections and requires vCenter Server instance.
1015
+ * A list of tag IDs to apply to this object.
1131
1016
  */
1132
1017
  tags?: pulumi.Input<pulumi.Input<string>[]>;
1133
1018
  /**
1134
- * 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`.
1019
+ * Set the upgrade policy for VMware Tools. Can be one of `manual` or `upgradeAtPowerCycle`.
1135
1020
  */
1136
1021
  toolsUpgradePolicy?: pulumi.Input<string>;
1137
1022
  /**
1138
- * 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.
1023
+ * vApp configuration data for this virtual machine. Can be used to provide configuration data for OVF images.
1139
1024
  */
1140
1025
  vapp?: pulumi.Input<inputs.VirtualMachineVapp>;
1141
1026
  /**
1142
- * Enable Virtualization Based Security. Requires `firmware` to be `efi`. In addition, `vvtdEnabled`, `nestedHvEnabled`, and `efiSecureBootEnabled` must all have a value of `true`. Supported on vSphere 6.7 and later. Default: `false`.
1027
+ * Flag to specify if Virtualization-based security is enabled for this virtual machine.
1143
1028
  */
1144
1029
  vbsEnabled?: pulumi.Input<boolean>;
1145
1030
  /**
1146
- * 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`.
1031
+ * Flag to specify if I/O MMU virtualization, also called Intel Virtualization Technology for Directed I/O (VT-d) and AMD
1032
+ * I/O Virtualization (AMD-Vi or IOMMU), is enabled.
1147
1033
  */
1148
1034
  vvtdEnabled?: pulumi.Input<boolean>;
1149
1035
  /**
1150
- * 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 `waitForGuestNetTimeout` waiter to be used. A value less than `1` disables the waiter. Default: `0`.
1036
+ * The amount of time, in minutes, to wait for an available IP address on this virtual machine. A value less than 1
1037
+ * disables the waiter.
1151
1038
  */
1152
1039
  waitForGuestIpTimeout?: pulumi.Input<number>;
1153
1040
  /**
1154
- * 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 `waitForGuestIpTimeout` waiter is used. Default: `true`.
1041
+ * Controls whether or not the guest network waiter waits for a routable address. When false, the waiter does not wait for
1042
+ * a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria.
1155
1043
  */
1156
1044
  waitForGuestNetRoutable?: pulumi.Input<boolean>;
1157
1045
  /**
1158
- * 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 `waitForGuestIpTimeout` waiter can be used instead. A value less than `1` disables the waiter. Default: `5` minutes.
1046
+ * The amount of time, in minutes, to wait for an available IP address on this virtual machine. A value less than 1
1047
+ * disables the waiter.
1159
1048
  */
1160
1049
  waitForGuestNetTimeout?: pulumi.Input<number>;
1161
1050
  }