@pulumi/vsphere 4.9.1 → 4.9.2

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 (3) hide show
  1. package/package.json +1 -1
  2. package/types/input.d.ts +285 -0
  3. package/types/output.d.ts +366 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pulumi/vsphere",
3
- "version": "v4.9.1",
3
+ "version": "v4.9.2",
4
4
  "description": "A Pulumi package for creating vsphere resources",
5
5
  "keywords": [
6
6
  "pulumi",
package/types/input.d.ts CHANGED
@@ -144,7 +144,13 @@ export interface ContentLibrarySubscription {
144
144
  username?: pulumi.Input<string>;
145
145
  }
146
146
  export interface DistributedPortGroupVlanRange {
147
+ /**
148
+ * The minimum VLAN to use in the range.
149
+ */
147
150
  maxVlan: pulumi.Input<number>;
151
+ /**
152
+ * The minimum VLAN to use in the range.
153
+ */
148
154
  minVlan: pulumi.Input<number>;
149
155
  }
150
156
  export interface DistributedVirtualSwitchHost {
@@ -177,7 +183,13 @@ export interface DistributedVirtualSwitchPvlanMapping {
177
183
  secondaryVlanId: pulumi.Input<number>;
178
184
  }
179
185
  export interface DistributedVirtualSwitchVlanRange {
186
+ /**
187
+ * The minimum VLAN to use in the range.
188
+ */
180
189
  maxVlan: pulumi.Input<number>;
190
+ /**
191
+ * The minimum VLAN to use in the range.
192
+ */
181
193
  minVlan: pulumi.Input<number>;
182
194
  }
183
195
  export interface EntityPermissionsPermission {
@@ -199,53 +211,155 @@ export interface EntityPermissionsPermission {
199
211
  userOrGroup: pulumi.Input<string>;
200
212
  }
201
213
  export interface GetVirtualMachineVapp {
214
+ /**
215
+ * A map of customizable vApp properties and their values. Allows customization of VMs cloned from OVF templates which have customizable vApp properties.
216
+ */
202
217
  properties?: {
203
218
  [key: string]: string;
204
219
  };
205
220
  }
206
221
  export interface GetVirtualMachineVappArgs {
222
+ /**
223
+ * A map of customizable vApp properties and their values. Allows customization of VMs cloned from OVF templates which have customizable vApp properties.
224
+ */
207
225
  properties?: pulumi.Input<{
208
226
  [key: string]: pulumi.Input<string>;
209
227
  }>;
210
228
  }
211
229
  export interface GuestOsCustomizationSpec {
230
+ /**
231
+ * The list of DNS servers for a virtual network adapter with a static IP address.
232
+ */
212
233
  dnsServerLists?: pulumi.Input<pulumi.Input<string>[]>;
234
+ /**
235
+ * A list of DNS search domains to add to the DNS configuration on the virtual machine.
236
+ */
213
237
  dnsSuffixLists?: pulumi.Input<pulumi.Input<string>[]>;
238
+ /**
239
+ * The IPv4 default gateway when using networkInterface customization on the virtual machine. This address must be local to a static IPv4 address configured in an interface sub-resource.
240
+ */
214
241
  ipv4Gateway?: pulumi.Input<string>;
242
+ /**
243
+ * The IPv6 default gateway when using networkInterface customization on the virtual machine. This address must be local to a static IPv4 address configured in an interface sub-resource.
244
+ */
215
245
  ipv6Gateway?: pulumi.Input<string>;
246
+ /**
247
+ * A list of configuration options specific to Linux virtual machines.
248
+ */
216
249
  linuxOptions?: pulumi.Input<inputs.GuestOsCustomizationSpecLinuxOptions>;
250
+ /**
251
+ * A specification of network interface configuration options.
252
+ */
217
253
  networkInterfaces?: pulumi.Input<pulumi.Input<inputs.GuestOsCustomizationSpecNetworkInterface>[]>;
254
+ /**
255
+ * A list of configuration options specific to Windows virtual machines.
256
+ */
218
257
  windowsOptions?: pulumi.Input<inputs.GuestOsCustomizationSpecWindowsOptions>;
258
+ /**
259
+ * Use this option to specify a windows sysprep file directly.
260
+ */
219
261
  windowsSysprepText?: pulumi.Input<string>;
220
262
  }
221
263
  export interface GuestOsCustomizationSpecLinuxOptions {
264
+ /**
265
+ * The domain name for this virtual machine.
266
+ */
222
267
  domain: pulumi.Input<string>;
268
+ /**
269
+ * The hostname for this virtual machine.
270
+ */
223
271
  hostName: pulumi.Input<string>;
272
+ /**
273
+ * Specifies whether or not the hardware clock should be in UTC or not.
274
+ */
224
275
  hwClockUtc?: pulumi.Input<boolean>;
276
+ /**
277
+ * The customization script to run before and or after guest customization
278
+ */
225
279
  scriptText?: pulumi.Input<string>;
280
+ /**
281
+ * Customize the time zone on the VM. This should be a time zone-style entry, like America/Los_Angeles.
282
+ */
226
283
  timeZone?: pulumi.Input<string>;
227
284
  }
228
285
  export interface GuestOsCustomizationSpecNetworkInterface {
286
+ /**
287
+ * A DNS search domain to add to the DNS configuration on the virtual machine.
288
+ */
229
289
  dnsDomain?: pulumi.Input<string>;
290
+ /**
291
+ * Network-interface specific DNS settings for Windows operating systems. Ignored on Linux.
292
+ */
230
293
  dnsServerLists?: pulumi.Input<pulumi.Input<string>[]>;
294
+ /**
295
+ * The IPv4 address assigned to this network adapter. If left blank, DHCP is used.
296
+ */
231
297
  ipv4Address?: pulumi.Input<string>;
298
+ /**
299
+ * The IPv4 CIDR netmask for the supplied IP address. Ignored if DHCP is selected.
300
+ */
232
301
  ipv4Netmask?: pulumi.Input<number>;
302
+ /**
303
+ * The IPv6 address assigned to this network adapter. If left blank, default auto-configuration is used.
304
+ */
233
305
  ipv6Address?: pulumi.Input<string>;
306
+ /**
307
+ * The IPv6 CIDR netmask for the supplied IP address. Ignored if auto-configuration is selected.
308
+ */
234
309
  ipv6Netmask?: pulumi.Input<number>;
235
310
  }
236
311
  export interface GuestOsCustomizationSpecWindowsOptions {
312
+ /**
313
+ * The new administrator password for this virtual machine.
314
+ */
237
315
  adminPassword?: pulumi.Input<string>;
316
+ /**
317
+ * Specifies whether or not the VM automatically logs on as Administrator.
318
+ */
238
319
  autoLogon?: pulumi.Input<boolean>;
320
+ /**
321
+ * Specifies how many times the VM should auto-logon the Administrator account when autoLogon is true.
322
+ */
239
323
  autoLogonCount?: pulumi.Input<number>;
324
+ /**
325
+ * The host name for this virtual machine.
326
+ */
240
327
  computerName: pulumi.Input<string>;
328
+ /**
329
+ * The password of the domain administrator used to join this virtual machine to the domain.
330
+ */
241
331
  domainAdminPassword?: pulumi.Input<string>;
332
+ /**
333
+ * The user account of the domain administrator used to join this virtual machine to the domain.
334
+ */
242
335
  domainAdminUser?: pulumi.Input<string>;
336
+ /**
337
+ * The full name of the user of this virtual machine.
338
+ */
243
339
  fullName?: pulumi.Input<string>;
340
+ /**
341
+ * The domain that the virtual machine should join.
342
+ */
244
343
  joinDomain?: pulumi.Input<string>;
344
+ /**
345
+ * The organization name this virtual machine is being installed for.
346
+ */
245
347
  organizationName?: pulumi.Input<string>;
348
+ /**
349
+ * The product key for this virtual machine.
350
+ */
246
351
  productKey?: pulumi.Input<string>;
352
+ /**
353
+ * A list of commands to run at first user logon, after guest customization.
354
+ */
247
355
  runOnceCommandLists?: pulumi.Input<pulumi.Input<string>[]>;
356
+ /**
357
+ * The new time zone for the virtual machine. This is a sysprep-dictated timezone code.
358
+ */
248
359
  timeZone?: pulumi.Input<number>;
360
+ /**
361
+ * The workgroup for this virtual machine if not joining a domain.
362
+ */
249
363
  workgroup?: pulumi.Input<string>;
250
364
  }
251
365
  export interface HostPortGroupPort {
@@ -253,7 +367,13 @@ export interface HostPortGroupPort {
253
367
  * The key for this port group as returned from the vSphere API.
254
368
  */
255
369
  key?: pulumi.Input<string>;
370
+ /**
371
+ * The MAC addresses of the network service of the virtual machine connected on this port.
372
+ */
256
373
  macAddresses?: pulumi.Input<pulumi.Input<string>[]>;
374
+ /**
375
+ * Type type of the entity connected on this port. Possible values are host (VMKkernel), systemManagement (service console), virtualMachine, or unknown.
376
+ */
257
377
  type?: pulumi.Input<string>;
258
378
  }
259
379
  export interface VirtualMachineCdrom {
@@ -265,6 +385,9 @@ export interface VirtualMachineCdrom {
265
385
  * The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with `clientDevice`.
266
386
  */
267
387
  datastoreId?: pulumi.Input<string>;
388
+ /**
389
+ * The internally-computed address of this device, such as scsi:0:1, denoting scsi bus #0 and device unit 1.
390
+ */
268
391
  deviceAddress?: pulumi.Input<string>;
269
392
  /**
270
393
  * The ID of the device within the virtual machine.
@@ -280,16 +403,37 @@ export interface VirtualMachineCdrom {
280
403
  path?: pulumi.Input<string>;
281
404
  }
282
405
  export interface VirtualMachineClone {
406
+ /**
407
+ * The customization specification for the virtual machine post-clone.
408
+ */
283
409
  customizationSpec?: pulumi.Input<inputs.VirtualMachineCloneCustomizationSpec>;
410
+ /**
411
+ * The customization specification for the virtual machine post-clone.
412
+ */
284
413
  customize?: pulumi.Input<inputs.VirtualMachineCloneCustomize>;
414
+ /**
415
+ * Whether or not to create a linked clone when cloning. When this option is used, the source VM must have a single snapshot associated with it.
416
+ */
285
417
  linkedClone?: pulumi.Input<boolean>;
418
+ /**
419
+ * Mapping of ovf networks to the networks to use in vSphere.
420
+ */
286
421
  ovfNetworkMap?: pulumi.Input<{
287
422
  [key: string]: pulumi.Input<string>;
288
423
  }>;
424
+ /**
425
+ * Mapping of ovf storage to the datastores to use in vSphere.
426
+ */
289
427
  ovfStorageMap?: pulumi.Input<{
290
428
  [key: string]: pulumi.Input<string>;
291
429
  }>;
430
+ /**
431
+ * The UUID of the source virtual machine or template.
432
+ */
292
433
  templateUuid: pulumi.Input<string>;
434
+ /**
435
+ * The timeout, in minutes, to wait for the virtual machine clone to complete.
436
+ */
293
437
  timeout?: pulumi.Input<number>;
294
438
  }
295
439
  export interface VirtualMachineCloneCustomizationSpec {
@@ -297,50 +441,149 @@ export interface VirtualMachineCloneCustomizationSpec {
297
441
  * The UUID of the virtual machine.
298
442
  */
299
443
  id: pulumi.Input<string>;
444
+ /**
445
+ * The amount of time, in minutes, to wait for guest OS customization to complete before returning with an error. Setting this value to 0 or a negative value skips the waiter. Default: 10.
446
+ */
300
447
  timeout?: pulumi.Input<number>;
301
448
  }
302
449
  export interface VirtualMachineCloneCustomize {
450
+ /**
451
+ * The list of DNS servers for a virtual network adapter with a static IP address.
452
+ */
303
453
  dnsServerLists?: pulumi.Input<pulumi.Input<string>[]>;
454
+ /**
455
+ * A list of DNS search domains to add to the DNS configuration on the virtual machine.
456
+ */
304
457
  dnsSuffixLists?: pulumi.Input<pulumi.Input<string>[]>;
458
+ /**
459
+ * The IPv4 default gateway when using networkInterface customization on the virtual machine. This address must be local to a static IPv4 address configured in an interface sub-resource.
460
+ */
305
461
  ipv4Gateway?: pulumi.Input<string>;
462
+ /**
463
+ * The IPv6 default gateway when using networkInterface customization on the virtual machine. This address must be local to a static IPv4 address configured in an interface sub-resource.
464
+ */
306
465
  ipv6Gateway?: pulumi.Input<string>;
466
+ /**
467
+ * A list of configuration options specific to Linux virtual machines.
468
+ */
307
469
  linuxOptions?: pulumi.Input<inputs.VirtualMachineCloneCustomizeLinuxOptions>;
308
470
  /**
309
471
  * A specification for a virtual NIC on the virtual machine. See network interface options for more information.
310
472
  */
311
473
  networkInterfaces?: pulumi.Input<pulumi.Input<inputs.VirtualMachineCloneCustomizeNetworkInterface>[]>;
474
+ /**
475
+ * The amount of time, in minutes, to wait for guest OS customization to complete before returning with an error. Setting this value to 0 or a negative value skips the waiter. Default: 10.
476
+ */
312
477
  timeout?: pulumi.Input<number>;
478
+ /**
479
+ * A list of configuration options specific to Windows virtual machines.
480
+ */
313
481
  windowsOptions?: pulumi.Input<inputs.VirtualMachineCloneCustomizeWindowsOptions>;
482
+ /**
483
+ * Use this option to specify a windows sysprep file directly.
484
+ */
314
485
  windowsSysprepText?: pulumi.Input<string>;
315
486
  }
316
487
  export interface VirtualMachineCloneCustomizeLinuxOptions {
488
+ /**
489
+ * The domain name for this virtual machine.
490
+ */
317
491
  domain: pulumi.Input<string>;
492
+ /**
493
+ * The hostname for this virtual machine.
494
+ */
318
495
  hostName: pulumi.Input<string>;
496
+ /**
497
+ * Specifies whether or not the hardware clock should be in UTC or not.
498
+ */
319
499
  hwClockUtc?: pulumi.Input<boolean>;
500
+ /**
501
+ * The customization script to run before and or after guest customization
502
+ */
320
503
  scriptText?: pulumi.Input<string>;
504
+ /**
505
+ * Customize the time zone on the VM. This should be a time zone-style entry, like America/Los_Angeles.
506
+ */
321
507
  timeZone?: pulumi.Input<string>;
322
508
  }
323
509
  export interface VirtualMachineCloneCustomizeNetworkInterface {
510
+ /**
511
+ * A DNS search domain to add to the DNS configuration on the virtual machine.
512
+ */
324
513
  dnsDomain?: pulumi.Input<string>;
514
+ /**
515
+ * Network-interface specific DNS settings for Windows operating systems. Ignored on Linux.
516
+ */
325
517
  dnsServerLists?: pulumi.Input<pulumi.Input<string>[]>;
518
+ /**
519
+ * The IPv4 address assigned to this network adapter. If left blank, DHCP is used.
520
+ */
326
521
  ipv4Address?: pulumi.Input<string>;
522
+ /**
523
+ * The IPv4 CIDR netmask for the supplied IP address. Ignored if DHCP is selected.
524
+ */
327
525
  ipv4Netmask?: pulumi.Input<number>;
526
+ /**
527
+ * The IPv6 address assigned to this network adapter. If left blank, default auto-configuration is used.
528
+ */
328
529
  ipv6Address?: pulumi.Input<string>;
530
+ /**
531
+ * The IPv6 CIDR netmask for the supplied IP address. Ignored if auto-configuration is selected.
532
+ */
329
533
  ipv6Netmask?: pulumi.Input<number>;
330
534
  }
331
535
  export interface VirtualMachineCloneCustomizeWindowsOptions {
536
+ /**
537
+ * The new administrator password for this virtual machine.
538
+ */
332
539
  adminPassword?: pulumi.Input<string>;
540
+ /**
541
+ * Specifies whether or not the VM automatically logs on as Administrator.
542
+ */
333
543
  autoLogon?: pulumi.Input<boolean>;
544
+ /**
545
+ * Specifies how many times the VM should auto-logon the Administrator account when autoLogon is true.
546
+ */
334
547
  autoLogonCount?: pulumi.Input<number>;
548
+ /**
549
+ * The host name for this virtual machine.
550
+ */
335
551
  computerName: pulumi.Input<string>;
552
+ /**
553
+ * The password of the domain administrator used to join this virtual machine to the domain.
554
+ */
336
555
  domainAdminPassword?: pulumi.Input<string>;
556
+ /**
557
+ * The user account of the domain administrator used to join this virtual machine to the domain.
558
+ */
337
559
  domainAdminUser?: pulumi.Input<string>;
560
+ /**
561
+ * The full name of the user of this virtual machine.
562
+ */
338
563
  fullName?: pulumi.Input<string>;
564
+ /**
565
+ * The domain that the virtual machine should join.
566
+ */
339
567
  joinDomain?: pulumi.Input<string>;
568
+ /**
569
+ * The organization name this virtual machine is being installed for.
570
+ */
340
571
  organizationName?: pulumi.Input<string>;
572
+ /**
573
+ * The product key for this virtual machine.
574
+ */
341
575
  productKey?: pulumi.Input<string>;
576
+ /**
577
+ * A list of commands to run at first user logon, after guest customization.
578
+ */
342
579
  runOnceCommandLists?: pulumi.Input<pulumi.Input<string>[]>;
580
+ /**
581
+ * The new time zone for the virtual machine. This is a sysprep-dictated timezone code.
582
+ */
343
583
  timeZone?: pulumi.Input<number>;
584
+ /**
585
+ * The workgroup for this virtual machine if not joining a domain.
586
+ */
344
587
  workgroup?: pulumi.Input<string>;
345
588
  }
346
589
  export interface VirtualMachineDisk {
@@ -358,6 +601,9 @@ export interface VirtualMachineDisk {
358
601
  * The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with `clientDevice`.
359
602
  */
360
603
  datastoreId?: pulumi.Input<string>;
604
+ /**
605
+ * The internally-computed address of this device, such as scsi:0:1, denoting scsi bus #0 and device unit 1.
606
+ */
361
607
  deviceAddress?: pulumi.Input<string>;
362
608
  /**
363
609
  * The mode of this this virtual disk for purposes of writes and snapshots. One of `append`, `independentNonpersistent`, `independentPersistent`, `nonpersistent`, `persistent`, or `undoable`. Default: `persistent`. For more information on these option, please refer to the [product documentation][vmware-docs-disk-mode].
@@ -399,6 +645,9 @@ export interface VirtualMachineDisk {
399
645
  * The ID of the device within the virtual machine.
400
646
  */
401
647
  key?: pulumi.Input<number>;
648
+ /**
649
+ * A unique label for this disk.
650
+ */
402
651
  label: pulumi.Input<string>;
403
652
  /**
404
653
  * The path to the ISO file. Required for using a datastore ISO. Conflicts with `clientDevice`.
@@ -454,6 +703,9 @@ export interface VirtualMachineNetworkInterface {
454
703
  * The bandwidth share allocation level for the network interface. One of `low`, `normal`, `high`, or `custom`. Default: `normal`. Ignored if `adapterType` is set to `sriov`.
455
704
  */
456
705
  bandwidthShareLevel?: pulumi.Input<string>;
706
+ /**
707
+ * The internally-computed address of this device, such as scsi:0:1, denoting scsi bus #0 and device unit 1.
708
+ */
457
709
  deviceAddress?: pulumi.Input<string>;
458
710
  /**
459
711
  * The ID of the device within the virtual machine.
@@ -471,6 +723,9 @@ export interface VirtualMachineNetworkInterface {
471
723
  * Specifies which NIC in an OVF/OVA the `networkInterface` should be associated. Only applies at creation when deploying from an OVF/OVA.
472
724
  */
473
725
  ovfMapping?: pulumi.Input<string>;
726
+ /**
727
+ * The ID of the Physical SR-IOV NIC to attach to, e.g. '0000:d8:00.0'
728
+ */
474
729
  physicalFunction?: pulumi.Input<string>;
475
730
  /**
476
731
  * If true, the `macAddress` field is treated as a static MAC address and set accordingly. Setting this to `true` requires `macAddress` to be set. Default: `false`.
@@ -478,19 +733,49 @@ export interface VirtualMachineNetworkInterface {
478
733
  useStaticMac?: pulumi.Input<boolean>;
479
734
  }
480
735
  export interface VirtualMachineOvfDeploy {
736
+ /**
737
+ * Allow unverified ssl certificates while deploying ovf/ova from url.
738
+ */
481
739
  allowUnverifiedSslCert?: pulumi.Input<boolean>;
740
+ /**
741
+ * The Deployment option to be chosen. If empty, the default option is used.
742
+ */
482
743
  deploymentOption?: pulumi.Input<string>;
744
+ /**
745
+ * An optional disk provisioning. If set, all the disks in the deployed ovf will have the same specified disk type (e.g., thin provisioned).
746
+ */
483
747
  diskProvisioning?: pulumi.Input<string>;
748
+ /**
749
+ * Allow properties with ovf:userConfigurable=false to be set.
750
+ */
484
751
  enableHiddenProperties?: pulumi.Input<boolean>;
752
+ /**
753
+ * The IP allocation policy.
754
+ */
485
755
  ipAllocationPolicy?: pulumi.Input<string>;
756
+ /**
757
+ * The IP protocol.
758
+ */
486
759
  ipProtocol?: pulumi.Input<string>;
760
+ /**
761
+ * The absolute path to the ovf/ova file in the local system.
762
+ */
487
763
  localOvfPath?: pulumi.Input<string>;
764
+ /**
765
+ * The mapping of name of network identifiers from the ovf descriptor to network UUID in the VI infrastructure.
766
+ */
488
767
  ovfNetworkMap?: pulumi.Input<{
489
768
  [key: string]: pulumi.Input<string>;
490
769
  }>;
770
+ /**
771
+ * URL to the remote ovf/ova file to be deployed.
772
+ */
491
773
  remoteOvfUrl?: pulumi.Input<string>;
492
774
  }
493
775
  export interface VirtualMachineVapp {
776
+ /**
777
+ * A map of customizable vApp properties and their values. Allows customization of VMs cloned from OVF templates which have customizable vApp properties.
778
+ */
494
779
  properties?: pulumi.Input<{
495
780
  [key: string]: pulumi.Input<string>;
496
781
  }>;
package/types/output.d.ts CHANGED
@@ -143,7 +143,13 @@ export interface ContentLibrarySubscription {
143
143
  username: string;
144
144
  }
145
145
  export interface DistributedPortGroupVlanRange {
146
+ /**
147
+ * The minimum VLAN to use in the range.
148
+ */
146
149
  maxVlan: number;
150
+ /**
151
+ * The minimum VLAN to use in the range.
152
+ */
147
153
  minVlan: number;
148
154
  }
149
155
  export interface DistributedVirtualSwitchHost {
@@ -176,7 +182,13 @@ export interface DistributedVirtualSwitchPvlanMapping {
176
182
  secondaryVlanId: number;
177
183
  }
178
184
  export interface DistributedVirtualSwitchVlanRange {
185
+ /**
186
+ * The minimum VLAN to use in the range.
187
+ */
179
188
  maxVlan: number;
189
+ /**
190
+ * The minimum VLAN to use in the range.
191
+ */
180
192
  minVlan: number;
181
193
  }
182
194
  export interface EntityPermissionsPermission {
@@ -198,38 +210,119 @@ export interface EntityPermissionsPermission {
198
210
  userOrGroup: string;
199
211
  }
200
212
  export interface GetGuestOsCustomizationSpec {
213
+ /**
214
+ * A list of DNS servers for a virtual network adapter with a static IP address.
215
+ */
201
216
  dnsServerLists: string[];
217
+ /**
218
+ * A list of DNS search domains to add to the DNS configuration on the virtual machine.
219
+ */
202
220
  dnsSuffixLists: string[];
221
+ /**
222
+ * A list of configuration options specific to Linux.
223
+ */
203
224
  linuxOptions: outputs.GetGuestOsCustomizationSpecLinuxOption[];
225
+ /**
226
+ * A specification of network interface configuration options.
227
+ */
204
228
  networkInterfaces: outputs.GetGuestOsCustomizationSpecNetworkInterface[];
229
+ /**
230
+ * A list of configuration options specific to Windows.
231
+ */
205
232
  windowsOptions: outputs.GetGuestOsCustomizationSpecWindowsOption[];
233
+ /**
234
+ * Use this option to specify use of a Windows Sysprep file.
235
+ */
206
236
  windowsSysprepText: string;
207
237
  }
208
238
  export interface GetGuestOsCustomizationSpecLinuxOption {
239
+ /**
240
+ * The domain name for this virtual machine.
241
+ */
209
242
  domain: string;
243
+ /**
244
+ * The hostname for this virtual machine.
245
+ */
210
246
  hostName: string;
247
+ /**
248
+ * Specifies whether or not the hardware clock should be in UTC or not.
249
+ */
211
250
  hwClockUtc: boolean;
251
+ /**
252
+ * The customization script to run before and or after guest customization.
253
+ */
212
254
  scriptText: string;
255
+ /**
256
+ * Set the time zone on the guest operating system. For a list of the acceptable values for Linux customization specifications, see [List of Time Zone Database Zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) on Wikipedia.
257
+ */
213
258
  timeZone: string;
214
259
  }
215
260
  export interface GetGuestOsCustomizationSpecNetworkInterface {
261
+ /**
262
+ * A DNS search domain to add to the DNS configuration on the virtual machine.
263
+ */
216
264
  dnsDomain: string;
265
+ /**
266
+ * Network-interface specific DNS settings for Windows operating systems. Ignored on Linux.
267
+ */
217
268
  dnsServerLists: string[];
269
+ /**
270
+ * The IPv4 address assigned to this network adapter. If left blank, DHCP is used.
271
+ */
218
272
  ipv4Address: string;
273
+ /**
274
+ * The IPv4 CIDR netmask for the supplied IP address. Ignored if DHCP is selected.
275
+ */
219
276
  ipv4Netmask: number;
277
+ /**
278
+ * The IPv6 address assigned to this network adapter. If left blank, default auto-configuration is used.
279
+ */
220
280
  ipv6Address: string;
281
+ /**
282
+ * The IPv6 CIDR netmask for the supplied IP address. Ignored if auto-configuration is selected.
283
+ */
221
284
  ipv6Netmask: number;
222
285
  }
223
286
  export interface GetGuestOsCustomizationSpecWindowsOption {
287
+ /**
288
+ * The new administrator password for this virtual machine.
289
+ */
224
290
  adminPassword: string;
291
+ /**
292
+ * Specifies whether or not the guest operating system automatically logs on as Administrator.
293
+ */
225
294
  autoLogon: boolean;
295
+ /**
296
+ * Specifies how many times the guest operating system should auto-logon the Administrator account when `autoLogon` is `true`.
297
+ */
226
298
  autoLogonCount: number;
299
+ /**
300
+ * The hostname for this virtual machine.
301
+ */
227
302
  computerName: string;
303
+ /**
304
+ * The user account used to join this virtual machine to the Active Directory domain.
305
+ */
228
306
  domainAdminPassword?: string;
307
+ /**
308
+ * The user account of the domain administrator used to join this virtual machine to the domain.
309
+ */
229
310
  domainAdminUser: string;
311
+ /**
312
+ * The Active Directory domain for the virtual machine to join.
313
+ */
230
314
  joinDomain: string;
315
+ /**
316
+ * A list of commands to run at first user logon, after guest customization.
317
+ */
231
318
  runOnceCommandLists: string[];
319
+ /**
320
+ * The new time zone for the virtual machine. This is a sysprep-dictated timezone code.
321
+ */
232
322
  timeZone: number;
323
+ /**
324
+ * The workgroup for this virtual machine if not joining an Active Directory domain.
325
+ */
233
326
  workgroup: string;
234
327
  }
235
328
  export interface GetVirtualMachineDisk {
@@ -290,51 +383,153 @@ export interface GetVirtualMachineNetworkInterface {
290
383
  * connected to.
291
384
  */
292
385
  networkId: string;
386
+ /**
387
+ * The ID of the Physical SR-IOV NIC to attach to, e.g. '0000:d8:00.0'
388
+ */
293
389
  physicalFunction: string;
294
390
  }
295
391
  export interface GetVirtualMachineVapp {
392
+ /**
393
+ * A map of customizable vApp properties and their values. Allows customization of VMs cloned from OVF templates which have customizable vApp properties.
394
+ */
296
395
  properties?: {
297
396
  [key: string]: string;
298
397
  };
299
398
  }
300
399
  export interface GuestOsCustomizationSpec {
400
+ /**
401
+ * The list of DNS servers for a virtual network adapter with a static IP address.
402
+ */
301
403
  dnsServerLists?: string[];
404
+ /**
405
+ * A list of DNS search domains to add to the DNS configuration on the virtual machine.
406
+ */
302
407
  dnsSuffixLists?: string[];
408
+ /**
409
+ * The IPv4 default gateway when using networkInterface customization on the virtual machine. This address must be local to a static IPv4 address configured in an interface sub-resource.
410
+ */
303
411
  ipv4Gateway?: string;
412
+ /**
413
+ * The IPv6 default gateway when using networkInterface customization on the virtual machine. This address must be local to a static IPv4 address configured in an interface sub-resource.
414
+ */
304
415
  ipv6Gateway?: string;
416
+ /**
417
+ * A list of configuration options specific to Linux virtual machines.
418
+ */
305
419
  linuxOptions?: outputs.GuestOsCustomizationSpecLinuxOptions;
420
+ /**
421
+ * A specification of network interface configuration options.
422
+ */
306
423
  networkInterfaces?: outputs.GuestOsCustomizationSpecNetworkInterface[];
424
+ /**
425
+ * A list of configuration options specific to Windows virtual machines.
426
+ */
307
427
  windowsOptions?: outputs.GuestOsCustomizationSpecWindowsOptions;
428
+ /**
429
+ * Use this option to specify a windows sysprep file directly.
430
+ */
308
431
  windowsSysprepText?: string;
309
432
  }
310
433
  export interface GuestOsCustomizationSpecLinuxOptions {
434
+ /**
435
+ * The domain name for this virtual machine.
436
+ */
311
437
  domain: string;
438
+ /**
439
+ * The hostname for this virtual machine.
440
+ */
312
441
  hostName: string;
442
+ /**
443
+ * Specifies whether or not the hardware clock should be in UTC or not.
444
+ */
313
445
  hwClockUtc?: boolean;
446
+ /**
447
+ * The customization script to run before and or after guest customization
448
+ */
314
449
  scriptText?: string;
450
+ /**
451
+ * Customize the time zone on the VM. This should be a time zone-style entry, like America/Los_Angeles.
452
+ */
315
453
  timeZone?: string;
316
454
  }
317
455
  export interface GuestOsCustomizationSpecNetworkInterface {
456
+ /**
457
+ * A DNS search domain to add to the DNS configuration on the virtual machine.
458
+ */
318
459
  dnsDomain?: string;
460
+ /**
461
+ * Network-interface specific DNS settings for Windows operating systems. Ignored on Linux.
462
+ */
319
463
  dnsServerLists?: string[];
464
+ /**
465
+ * The IPv4 address assigned to this network adapter. If left blank, DHCP is used.
466
+ */
320
467
  ipv4Address?: string;
468
+ /**
469
+ * The IPv4 CIDR netmask for the supplied IP address. Ignored if DHCP is selected.
470
+ */
321
471
  ipv4Netmask?: number;
472
+ /**
473
+ * The IPv6 address assigned to this network adapter. If left blank, default auto-configuration is used.
474
+ */
322
475
  ipv6Address?: string;
476
+ /**
477
+ * The IPv6 CIDR netmask for the supplied IP address. Ignored if auto-configuration is selected.
478
+ */
323
479
  ipv6Netmask?: number;
324
480
  }
325
481
  export interface GuestOsCustomizationSpecWindowsOptions {
482
+ /**
483
+ * The new administrator password for this virtual machine.
484
+ */
326
485
  adminPassword?: string;
486
+ /**
487
+ * Specifies whether or not the VM automatically logs on as Administrator.
488
+ */
327
489
  autoLogon?: boolean;
490
+ /**
491
+ * Specifies how many times the VM should auto-logon the Administrator account when autoLogon is true.
492
+ */
328
493
  autoLogonCount?: number;
494
+ /**
495
+ * The host name for this virtual machine.
496
+ */
329
497
  computerName: string;
498
+ /**
499
+ * The password of the domain administrator used to join this virtual machine to the domain.
500
+ */
330
501
  domainAdminPassword?: string;
502
+ /**
503
+ * The user account of the domain administrator used to join this virtual machine to the domain.
504
+ */
331
505
  domainAdminUser?: string;
506
+ /**
507
+ * The full name of the user of this virtual machine.
508
+ */
332
509
  fullName?: string;
510
+ /**
511
+ * The domain that the virtual machine should join.
512
+ */
333
513
  joinDomain?: string;
514
+ /**
515
+ * The organization name this virtual machine is being installed for.
516
+ */
334
517
  organizationName?: string;
518
+ /**
519
+ * The product key for this virtual machine.
520
+ */
335
521
  productKey?: string;
522
+ /**
523
+ * A list of commands to run at first user logon, after guest customization.
524
+ */
336
525
  runOnceCommandLists?: string[];
526
+ /**
527
+ * The new time zone for the virtual machine. This is a sysprep-dictated timezone code.
528
+ */
337
529
  timeZone?: number;
530
+ /**
531
+ * The workgroup for this virtual machine if not joining a domain.
532
+ */
338
533
  workgroup?: string;
339
534
  }
340
535
  export interface HostPortGroupPort {
@@ -342,7 +537,13 @@ export interface HostPortGroupPort {
342
537
  * The key for this port group as returned from the vSphere API.
343
538
  */
344
539
  key: string;
540
+ /**
541
+ * The MAC addresses of the network service of the virtual machine connected on this port.
542
+ */
345
543
  macAddresses: string[];
544
+ /**
545
+ * Type type of the entity connected on this port. Possible values are host (VMKkernel), systemManagement (service console), virtualMachine, or unknown.
546
+ */
346
547
  type: string;
347
548
  }
348
549
  export interface VirtualMachineCdrom {
@@ -354,6 +555,9 @@ export interface VirtualMachineCdrom {
354
555
  * The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with `clientDevice`.
355
556
  */
356
557
  datastoreId?: string;
558
+ /**
559
+ * The internally-computed address of this device, such as scsi:0:1, denoting scsi bus #0 and device unit 1.
560
+ */
357
561
  deviceAddress: string;
358
562
  /**
359
563
  * The ID of the device within the virtual machine.
@@ -369,16 +573,37 @@ export interface VirtualMachineCdrom {
369
573
  path?: string;
370
574
  }
371
575
  export interface VirtualMachineClone {
576
+ /**
577
+ * The customization specification for the virtual machine post-clone.
578
+ */
372
579
  customizationSpec?: outputs.VirtualMachineCloneCustomizationSpec;
580
+ /**
581
+ * The customization specification for the virtual machine post-clone.
582
+ */
373
583
  customize?: outputs.VirtualMachineCloneCustomize;
584
+ /**
585
+ * Whether or not to create a linked clone when cloning. When this option is used, the source VM must have a single snapshot associated with it.
586
+ */
374
587
  linkedClone?: boolean;
588
+ /**
589
+ * Mapping of ovf networks to the networks to use in vSphere.
590
+ */
375
591
  ovfNetworkMap?: {
376
592
  [key: string]: string;
377
593
  };
594
+ /**
595
+ * Mapping of ovf storage to the datastores to use in vSphere.
596
+ */
378
597
  ovfStorageMap?: {
379
598
  [key: string]: string;
380
599
  };
600
+ /**
601
+ * The UUID of the source virtual machine or template.
602
+ */
381
603
  templateUuid: string;
604
+ /**
605
+ * The timeout, in minutes, to wait for the virtual machine clone to complete.
606
+ */
382
607
  timeout?: number;
383
608
  }
384
609
  export interface VirtualMachineCloneCustomizationSpec {
@@ -386,50 +611,149 @@ export interface VirtualMachineCloneCustomizationSpec {
386
611
  * The UUID of the virtual machine.
387
612
  */
388
613
  id: string;
614
+ /**
615
+ * The amount of time, in minutes, to wait for guest OS customization to complete before returning with an error. Setting this value to 0 or a negative value skips the waiter. Default: 10.
616
+ */
389
617
  timeout?: number;
390
618
  }
391
619
  export interface VirtualMachineCloneCustomize {
620
+ /**
621
+ * The list of DNS servers for a virtual network adapter with a static IP address.
622
+ */
392
623
  dnsServerLists?: string[];
624
+ /**
625
+ * A list of DNS search domains to add to the DNS configuration on the virtual machine.
626
+ */
393
627
  dnsSuffixLists?: string[];
628
+ /**
629
+ * The IPv4 default gateway when using networkInterface customization on the virtual machine. This address must be local to a static IPv4 address configured in an interface sub-resource.
630
+ */
394
631
  ipv4Gateway?: string;
632
+ /**
633
+ * The IPv6 default gateway when using networkInterface customization on the virtual machine. This address must be local to a static IPv4 address configured in an interface sub-resource.
634
+ */
395
635
  ipv6Gateway?: string;
636
+ /**
637
+ * A list of configuration options specific to Linux virtual machines.
638
+ */
396
639
  linuxOptions?: outputs.VirtualMachineCloneCustomizeLinuxOptions;
397
640
  /**
398
641
  * A specification for a virtual NIC on the virtual machine. See network interface options for more information.
399
642
  */
400
643
  networkInterfaces?: outputs.VirtualMachineCloneCustomizeNetworkInterface[];
644
+ /**
645
+ * The amount of time, in minutes, to wait for guest OS customization to complete before returning with an error. Setting this value to 0 or a negative value skips the waiter. Default: 10.
646
+ */
401
647
  timeout?: number;
648
+ /**
649
+ * A list of configuration options specific to Windows virtual machines.
650
+ */
402
651
  windowsOptions?: outputs.VirtualMachineCloneCustomizeWindowsOptions;
652
+ /**
653
+ * Use this option to specify a windows sysprep file directly.
654
+ */
403
655
  windowsSysprepText?: string;
404
656
  }
405
657
  export interface VirtualMachineCloneCustomizeLinuxOptions {
658
+ /**
659
+ * The domain name for this virtual machine.
660
+ */
406
661
  domain: string;
662
+ /**
663
+ * The hostname for this virtual machine.
664
+ */
407
665
  hostName: string;
666
+ /**
667
+ * Specifies whether or not the hardware clock should be in UTC or not.
668
+ */
408
669
  hwClockUtc?: boolean;
670
+ /**
671
+ * The customization script to run before and or after guest customization
672
+ */
409
673
  scriptText?: string;
674
+ /**
675
+ * Customize the time zone on the VM. This should be a time zone-style entry, like America/Los_Angeles.
676
+ */
410
677
  timeZone?: string;
411
678
  }
412
679
  export interface VirtualMachineCloneCustomizeNetworkInterface {
680
+ /**
681
+ * A DNS search domain to add to the DNS configuration on the virtual machine.
682
+ */
413
683
  dnsDomain?: string;
684
+ /**
685
+ * Network-interface specific DNS settings for Windows operating systems. Ignored on Linux.
686
+ */
414
687
  dnsServerLists?: string[];
688
+ /**
689
+ * The IPv4 address assigned to this network adapter. If left blank, DHCP is used.
690
+ */
415
691
  ipv4Address?: string;
692
+ /**
693
+ * The IPv4 CIDR netmask for the supplied IP address. Ignored if DHCP is selected.
694
+ */
416
695
  ipv4Netmask?: number;
696
+ /**
697
+ * The IPv6 address assigned to this network adapter. If left blank, default auto-configuration is used.
698
+ */
417
699
  ipv6Address?: string;
700
+ /**
701
+ * The IPv6 CIDR netmask for the supplied IP address. Ignored if auto-configuration is selected.
702
+ */
418
703
  ipv6Netmask?: number;
419
704
  }
420
705
  export interface VirtualMachineCloneCustomizeWindowsOptions {
706
+ /**
707
+ * The new administrator password for this virtual machine.
708
+ */
421
709
  adminPassword?: string;
710
+ /**
711
+ * Specifies whether or not the VM automatically logs on as Administrator.
712
+ */
422
713
  autoLogon?: boolean;
714
+ /**
715
+ * Specifies how many times the VM should auto-logon the Administrator account when autoLogon is true.
716
+ */
423
717
  autoLogonCount?: number;
718
+ /**
719
+ * The host name for this virtual machine.
720
+ */
424
721
  computerName: string;
722
+ /**
723
+ * The password of the domain administrator used to join this virtual machine to the domain.
724
+ */
425
725
  domainAdminPassword?: string;
726
+ /**
727
+ * The user account of the domain administrator used to join this virtual machine to the domain.
728
+ */
426
729
  domainAdminUser?: string;
730
+ /**
731
+ * The full name of the user of this virtual machine.
732
+ */
427
733
  fullName?: string;
734
+ /**
735
+ * The domain that the virtual machine should join.
736
+ */
428
737
  joinDomain?: string;
738
+ /**
739
+ * The organization name this virtual machine is being installed for.
740
+ */
429
741
  organizationName?: string;
742
+ /**
743
+ * The product key for this virtual machine.
744
+ */
430
745
  productKey?: string;
746
+ /**
747
+ * A list of commands to run at first user logon, after guest customization.
748
+ */
431
749
  runOnceCommandLists?: string[];
750
+ /**
751
+ * The new time zone for the virtual machine. This is a sysprep-dictated timezone code.
752
+ */
432
753
  timeZone?: number;
754
+ /**
755
+ * The workgroup for this virtual machine if not joining a domain.
756
+ */
433
757
  workgroup?: string;
434
758
  }
435
759
  export interface VirtualMachineDisk {
@@ -447,6 +771,9 @@ export interface VirtualMachineDisk {
447
771
  * The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with `clientDevice`.
448
772
  */
449
773
  datastoreId: string;
774
+ /**
775
+ * The internally-computed address of this device, such as scsi:0:1, denoting scsi bus #0 and device unit 1.
776
+ */
450
777
  deviceAddress: string;
451
778
  /**
452
779
  * The mode of this this virtual disk for purposes of writes and snapshots. One of `append`, `independentNonpersistent`, `independentPersistent`, `nonpersistent`, `persistent`, or `undoable`. Default: `persistent`. For more information on these option, please refer to the [product documentation][vmware-docs-disk-mode].
@@ -488,6 +815,9 @@ export interface VirtualMachineDisk {
488
815
  * The ID of the device within the virtual machine.
489
816
  */
490
817
  key: number;
818
+ /**
819
+ * A unique label for this disk.
820
+ */
491
821
  label: string;
492
822
  /**
493
823
  * The path to the ISO file. Required for using a datastore ISO. Conflicts with `clientDevice`.
@@ -543,6 +873,9 @@ export interface VirtualMachineNetworkInterface {
543
873
  * The bandwidth share allocation level for the network interface. One of `low`, `normal`, `high`, or `custom`. Default: `normal`. Ignored if `adapterType` is set to `sriov`.
544
874
  */
545
875
  bandwidthShareLevel?: string;
876
+ /**
877
+ * The internally-computed address of this device, such as scsi:0:1, denoting scsi bus #0 and device unit 1.
878
+ */
546
879
  deviceAddress: string;
547
880
  /**
548
881
  * The ID of the device within the virtual machine.
@@ -560,6 +893,9 @@ export interface VirtualMachineNetworkInterface {
560
893
  * Specifies which NIC in an OVF/OVA the `networkInterface` should be associated. Only applies at creation when deploying from an OVF/OVA.
561
894
  */
562
895
  ovfMapping?: string;
896
+ /**
897
+ * The ID of the Physical SR-IOV NIC to attach to, e.g. '0000:d8:00.0'
898
+ */
563
899
  physicalFunction?: string;
564
900
  /**
565
901
  * If true, the `macAddress` field is treated as a static MAC address and set accordingly. Setting this to `true` requires `macAddress` to be set. Default: `false`.
@@ -567,19 +903,49 @@ export interface VirtualMachineNetworkInterface {
567
903
  useStaticMac?: boolean;
568
904
  }
569
905
  export interface VirtualMachineOvfDeploy {
906
+ /**
907
+ * Allow unverified ssl certificates while deploying ovf/ova from url.
908
+ */
570
909
  allowUnverifiedSslCert?: boolean;
910
+ /**
911
+ * The Deployment option to be chosen. If empty, the default option is used.
912
+ */
571
913
  deploymentOption?: string;
914
+ /**
915
+ * An optional disk provisioning. If set, all the disks in the deployed ovf will have the same specified disk type (e.g., thin provisioned).
916
+ */
572
917
  diskProvisioning?: string;
918
+ /**
919
+ * Allow properties with ovf:userConfigurable=false to be set.
920
+ */
573
921
  enableHiddenProperties?: boolean;
922
+ /**
923
+ * The IP allocation policy.
924
+ */
574
925
  ipAllocationPolicy?: string;
926
+ /**
927
+ * The IP protocol.
928
+ */
575
929
  ipProtocol?: string;
930
+ /**
931
+ * The absolute path to the ovf/ova file in the local system.
932
+ */
576
933
  localOvfPath?: string;
934
+ /**
935
+ * The mapping of name of network identifiers from the ovf descriptor to network UUID in the VI infrastructure.
936
+ */
577
937
  ovfNetworkMap?: {
578
938
  [key: string]: string;
579
939
  };
940
+ /**
941
+ * URL to the remote ovf/ova file to be deployed.
942
+ */
580
943
  remoteOvfUrl?: string;
581
944
  }
582
945
  export interface VirtualMachineVapp {
946
+ /**
947
+ * A map of customizable vApp properties and their values. Allows customization of VMs cloned from OVF templates which have customizable vApp properties.
948
+ */
583
949
  properties?: {
584
950
  [key: string]: string;
585
951
  };