pulumi-vsphere 4.10.0a1706750503__py3-none-any.whl → 4.10.0a1706831695__py3-none-any.whl

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

Potentially problematic release.


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

pulumi_vsphere/outputs.py CHANGED
@@ -556,17 +556,27 @@ class DistributedPortGroupVlanRange(dict):
556
556
  def __init__(__self__, *,
557
557
  max_vlan: int,
558
558
  min_vlan: int):
559
+ """
560
+ :param int max_vlan: The minimum VLAN to use in the range.
561
+ :param int min_vlan: The minimum VLAN to use in the range.
562
+ """
559
563
  pulumi.set(__self__, "max_vlan", max_vlan)
560
564
  pulumi.set(__self__, "min_vlan", min_vlan)
561
565
 
562
566
  @property
563
567
  @pulumi.getter(name="maxVlan")
564
568
  def max_vlan(self) -> int:
569
+ """
570
+ The minimum VLAN to use in the range.
571
+ """
565
572
  return pulumi.get(self, "max_vlan")
566
573
 
567
574
  @property
568
575
  @pulumi.getter(name="minVlan")
569
576
  def min_vlan(self) -> int:
577
+ """
578
+ The minimum VLAN to use in the range.
579
+ """
570
580
  return pulumi.get(self, "min_vlan")
571
581
 
572
582
 
@@ -712,17 +722,27 @@ class DistributedVirtualSwitchVlanRange(dict):
712
722
  def __init__(__self__, *,
713
723
  max_vlan: int,
714
724
  min_vlan: int):
725
+ """
726
+ :param int max_vlan: The minimum VLAN to use in the range.
727
+ :param int min_vlan: The minimum VLAN to use in the range.
728
+ """
715
729
  pulumi.set(__self__, "max_vlan", max_vlan)
716
730
  pulumi.set(__self__, "min_vlan", min_vlan)
717
731
 
718
732
  @property
719
733
  @pulumi.getter(name="maxVlan")
720
734
  def max_vlan(self) -> int:
735
+ """
736
+ The minimum VLAN to use in the range.
737
+ """
721
738
  return pulumi.get(self, "max_vlan")
722
739
 
723
740
  @property
724
741
  @pulumi.getter(name="minVlan")
725
742
  def min_vlan(self) -> int:
743
+ """
744
+ The minimum VLAN to use in the range.
745
+ """
726
746
  return pulumi.get(self, "min_vlan")
727
747
 
728
748
 
@@ -840,6 +860,16 @@ class GuestOsCustomizationSpec(dict):
840
860
  network_interfaces: Optional[Sequence['outputs.GuestOsCustomizationSpecNetworkInterface']] = None,
841
861
  windows_options: Optional['outputs.GuestOsCustomizationSpecWindowsOptions'] = None,
842
862
  windows_sysprep_text: Optional[str] = None):
863
+ """
864
+ :param Sequence[str] dns_server_lists: The list of DNS servers for a virtual network adapter with a static IP address.
865
+ :param Sequence[str] dns_suffix_lists: A list of DNS search domains to add to the DNS configuration on the virtual machine.
866
+ :param str ipv4_gateway: The IPv4 default gateway when using network_interface customization on the virtual machine. This address must be local to a static IPv4 address configured in an interface sub-resource.
867
+ :param str ipv6_gateway: The IPv6 default gateway when using network_interface customization on the virtual machine. This address must be local to a static IPv4 address configured in an interface sub-resource.
868
+ :param 'GuestOsCustomizationSpecLinuxOptionsArgs' linux_options: A list of configuration options specific to Linux virtual machines.
869
+ :param Sequence['GuestOsCustomizationSpecNetworkInterfaceArgs'] network_interfaces: A specification of network interface configuration options.
870
+ :param 'GuestOsCustomizationSpecWindowsOptionsArgs' windows_options: A list of configuration options specific to Windows virtual machines.
871
+ :param str windows_sysprep_text: Use this option to specify a windows sysprep file directly.
872
+ """
843
873
  if dns_server_lists is not None:
844
874
  pulumi.set(__self__, "dns_server_lists", dns_server_lists)
845
875
  if dns_suffix_lists is not None:
@@ -860,41 +890,65 @@ class GuestOsCustomizationSpec(dict):
860
890
  @property
861
891
  @pulumi.getter(name="dnsServerLists")
862
892
  def dns_server_lists(self) -> Optional[Sequence[str]]:
893
+ """
894
+ The list of DNS servers for a virtual network adapter with a static IP address.
895
+ """
863
896
  return pulumi.get(self, "dns_server_lists")
864
897
 
865
898
  @property
866
899
  @pulumi.getter(name="dnsSuffixLists")
867
900
  def dns_suffix_lists(self) -> Optional[Sequence[str]]:
901
+ """
902
+ A list of DNS search domains to add to the DNS configuration on the virtual machine.
903
+ """
868
904
  return pulumi.get(self, "dns_suffix_lists")
869
905
 
870
906
  @property
871
907
  @pulumi.getter(name="ipv4Gateway")
872
908
  def ipv4_gateway(self) -> Optional[str]:
909
+ """
910
+ The IPv4 default gateway when using network_interface customization on the virtual machine. This address must be local to a static IPv4 address configured in an interface sub-resource.
911
+ """
873
912
  return pulumi.get(self, "ipv4_gateway")
874
913
 
875
914
  @property
876
915
  @pulumi.getter(name="ipv6Gateway")
877
916
  def ipv6_gateway(self) -> Optional[str]:
917
+ """
918
+ The IPv6 default gateway when using network_interface customization on the virtual machine. This address must be local to a static IPv4 address configured in an interface sub-resource.
919
+ """
878
920
  return pulumi.get(self, "ipv6_gateway")
879
921
 
880
922
  @property
881
923
  @pulumi.getter(name="linuxOptions")
882
924
  def linux_options(self) -> Optional['outputs.GuestOsCustomizationSpecLinuxOptions']:
925
+ """
926
+ A list of configuration options specific to Linux virtual machines.
927
+ """
883
928
  return pulumi.get(self, "linux_options")
884
929
 
885
930
  @property
886
931
  @pulumi.getter(name="networkInterfaces")
887
932
  def network_interfaces(self) -> Optional[Sequence['outputs.GuestOsCustomizationSpecNetworkInterface']]:
933
+ """
934
+ A specification of network interface configuration options.
935
+ """
888
936
  return pulumi.get(self, "network_interfaces")
889
937
 
890
938
  @property
891
939
  @pulumi.getter(name="windowsOptions")
892
940
  def windows_options(self) -> Optional['outputs.GuestOsCustomizationSpecWindowsOptions']:
941
+ """
942
+ A list of configuration options specific to Windows virtual machines.
943
+ """
893
944
  return pulumi.get(self, "windows_options")
894
945
 
895
946
  @property
896
947
  @pulumi.getter(name="windowsSysprepText")
897
948
  def windows_sysprep_text(self) -> Optional[str]:
949
+ """
950
+ Use this option to specify a windows sysprep file directly.
951
+ """
898
952
  return pulumi.get(self, "windows_sysprep_text")
899
953
 
900
954
 
@@ -929,6 +983,13 @@ class GuestOsCustomizationSpecLinuxOptions(dict):
929
983
  hw_clock_utc: Optional[bool] = None,
930
984
  script_text: Optional[str] = None,
931
985
  time_zone: Optional[str] = None):
986
+ """
987
+ :param str domain: The domain name for this virtual machine.
988
+ :param str host_name: The hostname for this virtual machine.
989
+ :param bool hw_clock_utc: Specifies whether or not the hardware clock should be in UTC or not.
990
+ :param str script_text: The customization script to run before and or after guest customization
991
+ :param str time_zone: Customize the time zone on the VM. This should be a time zone-style entry, like America/Los_Angeles.
992
+ """
932
993
  pulumi.set(__self__, "domain", domain)
933
994
  pulumi.set(__self__, "host_name", host_name)
934
995
  if hw_clock_utc is not None:
@@ -941,26 +1002,41 @@ class GuestOsCustomizationSpecLinuxOptions(dict):
941
1002
  @property
942
1003
  @pulumi.getter
943
1004
  def domain(self) -> str:
1005
+ """
1006
+ The domain name for this virtual machine.
1007
+ """
944
1008
  return pulumi.get(self, "domain")
945
1009
 
946
1010
  @property
947
1011
  @pulumi.getter(name="hostName")
948
1012
  def host_name(self) -> str:
1013
+ """
1014
+ The hostname for this virtual machine.
1015
+ """
949
1016
  return pulumi.get(self, "host_name")
950
1017
 
951
1018
  @property
952
1019
  @pulumi.getter(name="hwClockUtc")
953
1020
  def hw_clock_utc(self) -> Optional[bool]:
1021
+ """
1022
+ Specifies whether or not the hardware clock should be in UTC or not.
1023
+ """
954
1024
  return pulumi.get(self, "hw_clock_utc")
955
1025
 
956
1026
  @property
957
1027
  @pulumi.getter(name="scriptText")
958
1028
  def script_text(self) -> Optional[str]:
1029
+ """
1030
+ The customization script to run before and or after guest customization
1031
+ """
959
1032
  return pulumi.get(self, "script_text")
960
1033
 
961
1034
  @property
962
1035
  @pulumi.getter(name="timeZone")
963
1036
  def time_zone(self) -> Optional[str]:
1037
+ """
1038
+ Customize the time zone on the VM. This should be a time zone-style entry, like America/Los_Angeles.
1039
+ """
964
1040
  return pulumi.get(self, "time_zone")
965
1041
 
966
1042
 
@@ -1000,6 +1076,14 @@ class GuestOsCustomizationSpecNetworkInterface(dict):
1000
1076
  ipv4_netmask: Optional[int] = None,
1001
1077
  ipv6_address: Optional[str] = None,
1002
1078
  ipv6_netmask: Optional[int] = None):
1079
+ """
1080
+ :param str dns_domain: A DNS search domain to add to the DNS configuration on the virtual machine.
1081
+ :param Sequence[str] dns_server_lists: Network-interface specific DNS settings for Windows operating systems. Ignored on Linux.
1082
+ :param str ipv4_address: The IPv4 address assigned to this network adapter. If left blank, DHCP is used.
1083
+ :param int ipv4_netmask: The IPv4 CIDR netmask for the supplied IP address. Ignored if DHCP is selected.
1084
+ :param str ipv6_address: The IPv6 address assigned to this network adapter. If left blank, default auto-configuration is used.
1085
+ :param int ipv6_netmask: The IPv6 CIDR netmask for the supplied IP address. Ignored if auto-configuration is selected.
1086
+ """
1003
1087
  if dns_domain is not None:
1004
1088
  pulumi.set(__self__, "dns_domain", dns_domain)
1005
1089
  if dns_server_lists is not None:
@@ -1016,31 +1100,49 @@ class GuestOsCustomizationSpecNetworkInterface(dict):
1016
1100
  @property
1017
1101
  @pulumi.getter(name="dnsDomain")
1018
1102
  def dns_domain(self) -> Optional[str]:
1103
+ """
1104
+ A DNS search domain to add to the DNS configuration on the virtual machine.
1105
+ """
1019
1106
  return pulumi.get(self, "dns_domain")
1020
1107
 
1021
1108
  @property
1022
1109
  @pulumi.getter(name="dnsServerLists")
1023
1110
  def dns_server_lists(self) -> Optional[Sequence[str]]:
1111
+ """
1112
+ Network-interface specific DNS settings for Windows operating systems. Ignored on Linux.
1113
+ """
1024
1114
  return pulumi.get(self, "dns_server_lists")
1025
1115
 
1026
1116
  @property
1027
1117
  @pulumi.getter(name="ipv4Address")
1028
1118
  def ipv4_address(self) -> Optional[str]:
1119
+ """
1120
+ The IPv4 address assigned to this network adapter. If left blank, DHCP is used.
1121
+ """
1029
1122
  return pulumi.get(self, "ipv4_address")
1030
1123
 
1031
1124
  @property
1032
1125
  @pulumi.getter(name="ipv4Netmask")
1033
1126
  def ipv4_netmask(self) -> Optional[int]:
1127
+ """
1128
+ The IPv4 CIDR netmask for the supplied IP address. Ignored if DHCP is selected.
1129
+ """
1034
1130
  return pulumi.get(self, "ipv4_netmask")
1035
1131
 
1036
1132
  @property
1037
1133
  @pulumi.getter(name="ipv6Address")
1038
1134
  def ipv6_address(self) -> Optional[str]:
1135
+ """
1136
+ The IPv6 address assigned to this network adapter. If left blank, default auto-configuration is used.
1137
+ """
1039
1138
  return pulumi.get(self, "ipv6_address")
1040
1139
 
1041
1140
  @property
1042
1141
  @pulumi.getter(name="ipv6Netmask")
1043
1142
  def ipv6_netmask(self) -> Optional[int]:
1143
+ """
1144
+ The IPv6 CIDR netmask for the supplied IP address. Ignored if auto-configuration is selected.
1145
+ """
1044
1146
  return pulumi.get(self, "ipv6_netmask")
1045
1147
 
1046
1148
 
@@ -1099,6 +1201,21 @@ class GuestOsCustomizationSpecWindowsOptions(dict):
1099
1201
  run_once_command_lists: Optional[Sequence[str]] = None,
1100
1202
  time_zone: Optional[int] = None,
1101
1203
  workgroup: Optional[str] = None):
1204
+ """
1205
+ :param str computer_name: The host name for this virtual machine.
1206
+ :param str admin_password: The new administrator password for this virtual machine.
1207
+ :param bool auto_logon: Specifies whether or not the VM automatically logs on as Administrator.
1208
+ :param int auto_logon_count: Specifies how many times the VM should auto-logon the Administrator account when auto_logon is true.
1209
+ :param str domain_admin_password: The password of the domain administrator used to join this virtual machine to the domain.
1210
+ :param str domain_admin_user: The user account of the domain administrator used to join this virtual machine to the domain.
1211
+ :param str full_name: The full name of the user of this virtual machine.
1212
+ :param str join_domain: The domain that the virtual machine should join.
1213
+ :param str organization_name: The organization name this virtual machine is being installed for.
1214
+ :param str product_key: The product key for this virtual machine.
1215
+ :param Sequence[str] run_once_command_lists: A list of commands to run at first user logon, after guest customization.
1216
+ :param int time_zone: The new time zone for the virtual machine. This is a sysprep-dictated timezone code.
1217
+ :param str workgroup: The workgroup for this virtual machine if not joining a domain.
1218
+ """
1102
1219
  pulumi.set(__self__, "computer_name", computer_name)
1103
1220
  if admin_password is not None:
1104
1221
  pulumi.set(__self__, "admin_password", admin_password)
@@ -1128,66 +1245,105 @@ class GuestOsCustomizationSpecWindowsOptions(dict):
1128
1245
  @property
1129
1246
  @pulumi.getter(name="computerName")
1130
1247
  def computer_name(self) -> str:
1248
+ """
1249
+ The host name for this virtual machine.
1250
+ """
1131
1251
  return pulumi.get(self, "computer_name")
1132
1252
 
1133
1253
  @property
1134
1254
  @pulumi.getter(name="adminPassword")
1135
1255
  def admin_password(self) -> Optional[str]:
1256
+ """
1257
+ The new administrator password for this virtual machine.
1258
+ """
1136
1259
  return pulumi.get(self, "admin_password")
1137
1260
 
1138
1261
  @property
1139
1262
  @pulumi.getter(name="autoLogon")
1140
1263
  def auto_logon(self) -> Optional[bool]:
1264
+ """
1265
+ Specifies whether or not the VM automatically logs on as Administrator.
1266
+ """
1141
1267
  return pulumi.get(self, "auto_logon")
1142
1268
 
1143
1269
  @property
1144
1270
  @pulumi.getter(name="autoLogonCount")
1145
1271
  def auto_logon_count(self) -> Optional[int]:
1272
+ """
1273
+ Specifies how many times the VM should auto-logon the Administrator account when auto_logon is true.
1274
+ """
1146
1275
  return pulumi.get(self, "auto_logon_count")
1147
1276
 
1148
1277
  @property
1149
1278
  @pulumi.getter(name="domainAdminPassword")
1150
1279
  def domain_admin_password(self) -> Optional[str]:
1280
+ """
1281
+ The password of the domain administrator used to join this virtual machine to the domain.
1282
+ """
1151
1283
  return pulumi.get(self, "domain_admin_password")
1152
1284
 
1153
1285
  @property
1154
1286
  @pulumi.getter(name="domainAdminUser")
1155
1287
  def domain_admin_user(self) -> Optional[str]:
1288
+ """
1289
+ The user account of the domain administrator used to join this virtual machine to the domain.
1290
+ """
1156
1291
  return pulumi.get(self, "domain_admin_user")
1157
1292
 
1158
1293
  @property
1159
1294
  @pulumi.getter(name="fullName")
1160
1295
  def full_name(self) -> Optional[str]:
1296
+ """
1297
+ The full name of the user of this virtual machine.
1298
+ """
1161
1299
  return pulumi.get(self, "full_name")
1162
1300
 
1163
1301
  @property
1164
1302
  @pulumi.getter(name="joinDomain")
1165
1303
  def join_domain(self) -> Optional[str]:
1304
+ """
1305
+ The domain that the virtual machine should join.
1306
+ """
1166
1307
  return pulumi.get(self, "join_domain")
1167
1308
 
1168
1309
  @property
1169
1310
  @pulumi.getter(name="organizationName")
1170
1311
  def organization_name(self) -> Optional[str]:
1312
+ """
1313
+ The organization name this virtual machine is being installed for.
1314
+ """
1171
1315
  return pulumi.get(self, "organization_name")
1172
1316
 
1173
1317
  @property
1174
1318
  @pulumi.getter(name="productKey")
1175
1319
  def product_key(self) -> Optional[str]:
1320
+ """
1321
+ The product key for this virtual machine.
1322
+ """
1176
1323
  return pulumi.get(self, "product_key")
1177
1324
 
1178
1325
  @property
1179
1326
  @pulumi.getter(name="runOnceCommandLists")
1180
1327
  def run_once_command_lists(self) -> Optional[Sequence[str]]:
1328
+ """
1329
+ A list of commands to run at first user logon, after guest customization.
1330
+ """
1181
1331
  return pulumi.get(self, "run_once_command_lists")
1182
1332
 
1183
1333
  @property
1184
1334
  @pulumi.getter(name="timeZone")
1185
1335
  def time_zone(self) -> Optional[int]:
1336
+ """
1337
+ The new time zone for the virtual machine. This is a sysprep-dictated timezone code.
1338
+ """
1186
1339
  return pulumi.get(self, "time_zone")
1187
1340
 
1188
1341
  @property
1189
1342
  @pulumi.getter
1190
1343
  def workgroup(self) -> Optional[str]:
1344
+ """
1345
+ The workgroup for this virtual machine if not joining a domain.
1346
+ """
1191
1347
  return pulumi.get(self, "workgroup")
1192
1348
 
1193
1349
 
@@ -1216,6 +1372,8 @@ class HostPortGroupPort(dict):
1216
1372
  type: Optional[str] = None):
1217
1373
  """
1218
1374
  :param str key: The key for this port group as returned from the vSphere API.
1375
+ :param Sequence[str] mac_addresses: The MAC addresses of the network service of the virtual machine connected on this port.
1376
+ :param str type: Type type of the entity connected on this port. Possible values are host (VMKkernel), systemManagement (service console), virtualMachine, or unknown.
1219
1377
  """
1220
1378
  if key is not None:
1221
1379
  pulumi.set(__self__, "key", key)
@@ -1235,11 +1393,17 @@ class HostPortGroupPort(dict):
1235
1393
  @property
1236
1394
  @pulumi.getter(name="macAddresses")
1237
1395
  def mac_addresses(self) -> Optional[Sequence[str]]:
1396
+ """
1397
+ The MAC addresses of the network service of the virtual machine connected on this port.
1398
+ """
1238
1399
  return pulumi.get(self, "mac_addresses")
1239
1400
 
1240
1401
  @property
1241
1402
  @pulumi.getter
1242
1403
  def type(self) -> Optional[str]:
1404
+ """
1405
+ Type type of the entity connected on this port. Possible values are host (VMKkernel), systemManagement (service console), virtualMachine, or unknown.
1406
+ """
1243
1407
  return pulumi.get(self, "type")
1244
1408
 
1245
1409
 
@@ -1275,6 +1439,7 @@ class VirtualMachineCdrom(dict):
1275
1439
  """
1276
1440
  :param bool client_device: Indicates whether the device should be backed by remote client device. Conflicts with `datastore_id` and `path`.
1277
1441
  :param str datastore_id: The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with `client_device`.
1442
+ :param str device_address: The internally-computed address of this device, such as scsi:0:1, denoting scsi bus #0 and device unit 1.
1278
1443
  :param int key: The ID of the device within the virtual machine.
1279
1444
  :param str path: The path to the ISO file. Required for using a datastore ISO. Conflicts with `client_device`.
1280
1445
 
@@ -1312,6 +1477,9 @@ class VirtualMachineCdrom(dict):
1312
1477
  @property
1313
1478
  @pulumi.getter(name="deviceAddress")
1314
1479
  def device_address(self) -> Optional[str]:
1480
+ """
1481
+ The internally-computed address of this device, such as scsi:0:1, denoting scsi bus #0 and device unit 1.
1482
+ """
1315
1483
  return pulumi.get(self, "device_address")
1316
1484
 
1317
1485
  @property
@@ -1370,6 +1538,15 @@ class VirtualMachineClone(dict):
1370
1538
  ovf_network_map: Optional[Mapping[str, str]] = None,
1371
1539
  ovf_storage_map: Optional[Mapping[str, str]] = None,
1372
1540
  timeout: Optional[int] = None):
1541
+ """
1542
+ :param str template_uuid: The UUID of the source virtual machine or template.
1543
+ :param 'VirtualMachineCloneCustomizationSpecArgs' customization_spec: The customization specification for the virtual machine post-clone.
1544
+ :param 'VirtualMachineCloneCustomizeArgs' customize: The customization specification for the virtual machine post-clone.
1545
+ :param bool linked_clone: 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.
1546
+ :param Mapping[str, str] ovf_network_map: Mapping of ovf networks to the networks to use in vSphere.
1547
+ :param Mapping[str, str] ovf_storage_map: Mapping of ovf storage to the datastores to use in vSphere.
1548
+ :param int timeout: The timeout, in minutes, to wait for the virtual machine clone to complete.
1549
+ """
1373
1550
  pulumi.set(__self__, "template_uuid", template_uuid)
1374
1551
  if customization_spec is not None:
1375
1552
  pulumi.set(__self__, "customization_spec", customization_spec)
@@ -1387,36 +1564,57 @@ class VirtualMachineClone(dict):
1387
1564
  @property
1388
1565
  @pulumi.getter(name="templateUuid")
1389
1566
  def template_uuid(self) -> str:
1567
+ """
1568
+ The UUID of the source virtual machine or template.
1569
+ """
1390
1570
  return pulumi.get(self, "template_uuid")
1391
1571
 
1392
1572
  @property
1393
1573
  @pulumi.getter(name="customizationSpec")
1394
1574
  def customization_spec(self) -> Optional['outputs.VirtualMachineCloneCustomizationSpec']:
1575
+ """
1576
+ The customization specification for the virtual machine post-clone.
1577
+ """
1395
1578
  return pulumi.get(self, "customization_spec")
1396
1579
 
1397
1580
  @property
1398
1581
  @pulumi.getter
1399
1582
  def customize(self) -> Optional['outputs.VirtualMachineCloneCustomize']:
1583
+ """
1584
+ The customization specification for the virtual machine post-clone.
1585
+ """
1400
1586
  return pulumi.get(self, "customize")
1401
1587
 
1402
1588
  @property
1403
1589
  @pulumi.getter(name="linkedClone")
1404
1590
  def linked_clone(self) -> Optional[bool]:
1591
+ """
1592
+ 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.
1593
+ """
1405
1594
  return pulumi.get(self, "linked_clone")
1406
1595
 
1407
1596
  @property
1408
1597
  @pulumi.getter(name="ovfNetworkMap")
1409
1598
  def ovf_network_map(self) -> Optional[Mapping[str, str]]:
1599
+ """
1600
+ Mapping of ovf networks to the networks to use in vSphere.
1601
+ """
1410
1602
  return pulumi.get(self, "ovf_network_map")
1411
1603
 
1412
1604
  @property
1413
1605
  @pulumi.getter(name="ovfStorageMap")
1414
1606
  def ovf_storage_map(self) -> Optional[Mapping[str, str]]:
1607
+ """
1608
+ Mapping of ovf storage to the datastores to use in vSphere.
1609
+ """
1415
1610
  return pulumi.get(self, "ovf_storage_map")
1416
1611
 
1417
1612
  @property
1418
1613
  @pulumi.getter
1419
1614
  def timeout(self) -> Optional[int]:
1615
+ """
1616
+ The timeout, in minutes, to wait for the virtual machine clone to complete.
1617
+ """
1420
1618
  return pulumi.get(self, "timeout")
1421
1619
 
1422
1620
 
@@ -1427,6 +1625,7 @@ class VirtualMachineCloneCustomizationSpec(dict):
1427
1625
  timeout: Optional[int] = None):
1428
1626
  """
1429
1627
  :param str id: The UUID of the virtual machine.
1628
+ :param int timeout: 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.
1430
1629
  """
1431
1630
  pulumi.set(__self__, "id", id)
1432
1631
  if timeout is not None:
@@ -1443,6 +1642,9 @@ class VirtualMachineCloneCustomizationSpec(dict):
1443
1642
  @property
1444
1643
  @pulumi.getter
1445
1644
  def timeout(self) -> Optional[int]:
1645
+ """
1646
+ 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.
1647
+ """
1446
1648
  return pulumi.get(self, "timeout")
1447
1649
 
1448
1650
 
@@ -1490,7 +1692,15 @@ class VirtualMachineCloneCustomize(dict):
1490
1692
  windows_options: Optional['outputs.VirtualMachineCloneCustomizeWindowsOptions'] = None,
1491
1693
  windows_sysprep_text: Optional[str] = None):
1492
1694
  """
1695
+ :param Sequence[str] dns_server_lists: The list of DNS servers for a virtual network adapter with a static IP address.
1696
+ :param Sequence[str] dns_suffix_lists: A list of DNS search domains to add to the DNS configuration on the virtual machine.
1697
+ :param str ipv4_gateway: The IPv4 default gateway when using network_interface customization on the virtual machine. This address must be local to a static IPv4 address configured in an interface sub-resource.
1698
+ :param str ipv6_gateway: The IPv6 default gateway when using network_interface customization on the virtual machine. This address must be local to a static IPv4 address configured in an interface sub-resource.
1699
+ :param 'VirtualMachineCloneCustomizeLinuxOptionsArgs' linux_options: A list of configuration options specific to Linux virtual machines.
1493
1700
  :param Sequence['VirtualMachineCloneCustomizeNetworkInterfaceArgs'] network_interfaces: A specification for a virtual NIC on the virtual machine. See network interface options for more information.
1701
+ :param int timeout: 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.
1702
+ :param 'VirtualMachineCloneCustomizeWindowsOptionsArgs' windows_options: A list of configuration options specific to Windows virtual machines.
1703
+ :param str windows_sysprep_text: Use this option to specify a windows sysprep file directly.
1494
1704
  """
1495
1705
  if dns_server_lists is not None:
1496
1706
  pulumi.set(__self__, "dns_server_lists", dns_server_lists)
@@ -1514,26 +1724,41 @@ class VirtualMachineCloneCustomize(dict):
1514
1724
  @property
1515
1725
  @pulumi.getter(name="dnsServerLists")
1516
1726
  def dns_server_lists(self) -> Optional[Sequence[str]]:
1727
+ """
1728
+ The list of DNS servers for a virtual network adapter with a static IP address.
1729
+ """
1517
1730
  return pulumi.get(self, "dns_server_lists")
1518
1731
 
1519
1732
  @property
1520
1733
  @pulumi.getter(name="dnsSuffixLists")
1521
1734
  def dns_suffix_lists(self) -> Optional[Sequence[str]]:
1735
+ """
1736
+ A list of DNS search domains to add to the DNS configuration on the virtual machine.
1737
+ """
1522
1738
  return pulumi.get(self, "dns_suffix_lists")
1523
1739
 
1524
1740
  @property
1525
1741
  @pulumi.getter(name="ipv4Gateway")
1526
1742
  def ipv4_gateway(self) -> Optional[str]:
1743
+ """
1744
+ The IPv4 default gateway when using network_interface customization on the virtual machine. This address must be local to a static IPv4 address configured in an interface sub-resource.
1745
+ """
1527
1746
  return pulumi.get(self, "ipv4_gateway")
1528
1747
 
1529
1748
  @property
1530
1749
  @pulumi.getter(name="ipv6Gateway")
1531
1750
  def ipv6_gateway(self) -> Optional[str]:
1751
+ """
1752
+ The IPv6 default gateway when using network_interface customization on the virtual machine. This address must be local to a static IPv4 address configured in an interface sub-resource.
1753
+ """
1532
1754
  return pulumi.get(self, "ipv6_gateway")
1533
1755
 
1534
1756
  @property
1535
1757
  @pulumi.getter(name="linuxOptions")
1536
1758
  def linux_options(self) -> Optional['outputs.VirtualMachineCloneCustomizeLinuxOptions']:
1759
+ """
1760
+ A list of configuration options specific to Linux virtual machines.
1761
+ """
1537
1762
  return pulumi.get(self, "linux_options")
1538
1763
 
1539
1764
  @property
@@ -1547,16 +1772,25 @@ class VirtualMachineCloneCustomize(dict):
1547
1772
  @property
1548
1773
  @pulumi.getter
1549
1774
  def timeout(self) -> Optional[int]:
1775
+ """
1776
+ 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.
1777
+ """
1550
1778
  return pulumi.get(self, "timeout")
1551
1779
 
1552
1780
  @property
1553
1781
  @pulumi.getter(name="windowsOptions")
1554
1782
  def windows_options(self) -> Optional['outputs.VirtualMachineCloneCustomizeWindowsOptions']:
1783
+ """
1784
+ A list of configuration options specific to Windows virtual machines.
1785
+ """
1555
1786
  return pulumi.get(self, "windows_options")
1556
1787
 
1557
1788
  @property
1558
1789
  @pulumi.getter(name="windowsSysprepText")
1559
1790
  def windows_sysprep_text(self) -> Optional[str]:
1791
+ """
1792
+ Use this option to specify a windows sysprep file directly.
1793
+ """
1560
1794
  return pulumi.get(self, "windows_sysprep_text")
1561
1795
 
1562
1796
 
@@ -1591,6 +1825,13 @@ class VirtualMachineCloneCustomizeLinuxOptions(dict):
1591
1825
  hw_clock_utc: Optional[bool] = None,
1592
1826
  script_text: Optional[str] = None,
1593
1827
  time_zone: Optional[str] = None):
1828
+ """
1829
+ :param str domain: The domain name for this virtual machine.
1830
+ :param str host_name: The hostname for this virtual machine.
1831
+ :param bool hw_clock_utc: Specifies whether or not the hardware clock should be in UTC or not.
1832
+ :param str script_text: The customization script to run before and or after guest customization
1833
+ :param str time_zone: Customize the time zone on the VM. This should be a time zone-style entry, like America/Los_Angeles.
1834
+ """
1594
1835
  pulumi.set(__self__, "domain", domain)
1595
1836
  pulumi.set(__self__, "host_name", host_name)
1596
1837
  if hw_clock_utc is not None:
@@ -1603,26 +1844,41 @@ class VirtualMachineCloneCustomizeLinuxOptions(dict):
1603
1844
  @property
1604
1845
  @pulumi.getter
1605
1846
  def domain(self) -> str:
1847
+ """
1848
+ The domain name for this virtual machine.
1849
+ """
1606
1850
  return pulumi.get(self, "domain")
1607
1851
 
1608
1852
  @property
1609
1853
  @pulumi.getter(name="hostName")
1610
1854
  def host_name(self) -> str:
1855
+ """
1856
+ The hostname for this virtual machine.
1857
+ """
1611
1858
  return pulumi.get(self, "host_name")
1612
1859
 
1613
1860
  @property
1614
1861
  @pulumi.getter(name="hwClockUtc")
1615
1862
  def hw_clock_utc(self) -> Optional[bool]:
1863
+ """
1864
+ Specifies whether or not the hardware clock should be in UTC or not.
1865
+ """
1616
1866
  return pulumi.get(self, "hw_clock_utc")
1617
1867
 
1618
1868
  @property
1619
1869
  @pulumi.getter(name="scriptText")
1620
1870
  def script_text(self) -> Optional[str]:
1871
+ """
1872
+ The customization script to run before and or after guest customization
1873
+ """
1621
1874
  return pulumi.get(self, "script_text")
1622
1875
 
1623
1876
  @property
1624
1877
  @pulumi.getter(name="timeZone")
1625
1878
  def time_zone(self) -> Optional[str]:
1879
+ """
1880
+ Customize the time zone on the VM. This should be a time zone-style entry, like America/Los_Angeles.
1881
+ """
1626
1882
  return pulumi.get(self, "time_zone")
1627
1883
 
1628
1884
 
@@ -1662,6 +1918,14 @@ class VirtualMachineCloneCustomizeNetworkInterface(dict):
1662
1918
  ipv4_netmask: Optional[int] = None,
1663
1919
  ipv6_address: Optional[str] = None,
1664
1920
  ipv6_netmask: Optional[int] = None):
1921
+ """
1922
+ :param str dns_domain: A DNS search domain to add to the DNS configuration on the virtual machine.
1923
+ :param Sequence[str] dns_server_lists: Network-interface specific DNS settings for Windows operating systems. Ignored on Linux.
1924
+ :param str ipv4_address: The IPv4 address assigned to this network adapter. If left blank, DHCP is used.
1925
+ :param int ipv4_netmask: The IPv4 CIDR netmask for the supplied IP address. Ignored if DHCP is selected.
1926
+ :param str ipv6_address: The IPv6 address assigned to this network adapter. If left blank, default auto-configuration is used.
1927
+ :param int ipv6_netmask: The IPv6 CIDR netmask for the supplied IP address. Ignored if auto-configuration is selected.
1928
+ """
1665
1929
  if dns_domain is not None:
1666
1930
  pulumi.set(__self__, "dns_domain", dns_domain)
1667
1931
  if dns_server_lists is not None:
@@ -1678,31 +1942,49 @@ class VirtualMachineCloneCustomizeNetworkInterface(dict):
1678
1942
  @property
1679
1943
  @pulumi.getter(name="dnsDomain")
1680
1944
  def dns_domain(self) -> Optional[str]:
1945
+ """
1946
+ A DNS search domain to add to the DNS configuration on the virtual machine.
1947
+ """
1681
1948
  return pulumi.get(self, "dns_domain")
1682
1949
 
1683
1950
  @property
1684
1951
  @pulumi.getter(name="dnsServerLists")
1685
1952
  def dns_server_lists(self) -> Optional[Sequence[str]]:
1953
+ """
1954
+ Network-interface specific DNS settings for Windows operating systems. Ignored on Linux.
1955
+ """
1686
1956
  return pulumi.get(self, "dns_server_lists")
1687
1957
 
1688
1958
  @property
1689
1959
  @pulumi.getter(name="ipv4Address")
1690
1960
  def ipv4_address(self) -> Optional[str]:
1961
+ """
1962
+ The IPv4 address assigned to this network adapter. If left blank, DHCP is used.
1963
+ """
1691
1964
  return pulumi.get(self, "ipv4_address")
1692
1965
 
1693
1966
  @property
1694
1967
  @pulumi.getter(name="ipv4Netmask")
1695
1968
  def ipv4_netmask(self) -> Optional[int]:
1969
+ """
1970
+ The IPv4 CIDR netmask for the supplied IP address. Ignored if DHCP is selected.
1971
+ """
1696
1972
  return pulumi.get(self, "ipv4_netmask")
1697
1973
 
1698
1974
  @property
1699
1975
  @pulumi.getter(name="ipv6Address")
1700
1976
  def ipv6_address(self) -> Optional[str]:
1977
+ """
1978
+ The IPv6 address assigned to this network adapter. If left blank, default auto-configuration is used.
1979
+ """
1701
1980
  return pulumi.get(self, "ipv6_address")
1702
1981
 
1703
1982
  @property
1704
1983
  @pulumi.getter(name="ipv6Netmask")
1705
1984
  def ipv6_netmask(self) -> Optional[int]:
1985
+ """
1986
+ The IPv6 CIDR netmask for the supplied IP address. Ignored if auto-configuration is selected.
1987
+ """
1706
1988
  return pulumi.get(self, "ipv6_netmask")
1707
1989
 
1708
1990
 
@@ -1761,6 +2043,21 @@ class VirtualMachineCloneCustomizeWindowsOptions(dict):
1761
2043
  run_once_command_lists: Optional[Sequence[str]] = None,
1762
2044
  time_zone: Optional[int] = None,
1763
2045
  workgroup: Optional[str] = None):
2046
+ """
2047
+ :param str computer_name: The host name for this virtual machine.
2048
+ :param str admin_password: The new administrator password for this virtual machine.
2049
+ :param bool auto_logon: Specifies whether or not the VM automatically logs on as Administrator.
2050
+ :param int auto_logon_count: Specifies how many times the VM should auto-logon the Administrator account when auto_logon is true.
2051
+ :param str domain_admin_password: The password of the domain administrator used to join this virtual machine to the domain.
2052
+ :param str domain_admin_user: The user account of the domain administrator used to join this virtual machine to the domain.
2053
+ :param str full_name: The full name of the user of this virtual machine.
2054
+ :param str join_domain: The domain that the virtual machine should join.
2055
+ :param str organization_name: The organization name this virtual machine is being installed for.
2056
+ :param str product_key: The product key for this virtual machine.
2057
+ :param Sequence[str] run_once_command_lists: A list of commands to run at first user logon, after guest customization.
2058
+ :param int time_zone: The new time zone for the virtual machine. This is a sysprep-dictated timezone code.
2059
+ :param str workgroup: The workgroup for this virtual machine if not joining a domain.
2060
+ """
1764
2061
  pulumi.set(__self__, "computer_name", computer_name)
1765
2062
  if admin_password is not None:
1766
2063
  pulumi.set(__self__, "admin_password", admin_password)
@@ -1790,66 +2087,105 @@ class VirtualMachineCloneCustomizeWindowsOptions(dict):
1790
2087
  @property
1791
2088
  @pulumi.getter(name="computerName")
1792
2089
  def computer_name(self) -> str:
2090
+ """
2091
+ The host name for this virtual machine.
2092
+ """
1793
2093
  return pulumi.get(self, "computer_name")
1794
2094
 
1795
2095
  @property
1796
2096
  @pulumi.getter(name="adminPassword")
1797
2097
  def admin_password(self) -> Optional[str]:
2098
+ """
2099
+ The new administrator password for this virtual machine.
2100
+ """
1798
2101
  return pulumi.get(self, "admin_password")
1799
2102
 
1800
2103
  @property
1801
2104
  @pulumi.getter(name="autoLogon")
1802
2105
  def auto_logon(self) -> Optional[bool]:
2106
+ """
2107
+ Specifies whether or not the VM automatically logs on as Administrator.
2108
+ """
1803
2109
  return pulumi.get(self, "auto_logon")
1804
2110
 
1805
2111
  @property
1806
2112
  @pulumi.getter(name="autoLogonCount")
1807
2113
  def auto_logon_count(self) -> Optional[int]:
2114
+ """
2115
+ Specifies how many times the VM should auto-logon the Administrator account when auto_logon is true.
2116
+ """
1808
2117
  return pulumi.get(self, "auto_logon_count")
1809
2118
 
1810
2119
  @property
1811
2120
  @pulumi.getter(name="domainAdminPassword")
1812
2121
  def domain_admin_password(self) -> Optional[str]:
2122
+ """
2123
+ The password of the domain administrator used to join this virtual machine to the domain.
2124
+ """
1813
2125
  return pulumi.get(self, "domain_admin_password")
1814
2126
 
1815
2127
  @property
1816
2128
  @pulumi.getter(name="domainAdminUser")
1817
2129
  def domain_admin_user(self) -> Optional[str]:
2130
+ """
2131
+ The user account of the domain administrator used to join this virtual machine to the domain.
2132
+ """
1818
2133
  return pulumi.get(self, "domain_admin_user")
1819
2134
 
1820
2135
  @property
1821
2136
  @pulumi.getter(name="fullName")
1822
2137
  def full_name(self) -> Optional[str]:
2138
+ """
2139
+ The full name of the user of this virtual machine.
2140
+ """
1823
2141
  return pulumi.get(self, "full_name")
1824
2142
 
1825
2143
  @property
1826
2144
  @pulumi.getter(name="joinDomain")
1827
2145
  def join_domain(self) -> Optional[str]:
2146
+ """
2147
+ The domain that the virtual machine should join.
2148
+ """
1828
2149
  return pulumi.get(self, "join_domain")
1829
2150
 
1830
2151
  @property
1831
2152
  @pulumi.getter(name="organizationName")
1832
2153
  def organization_name(self) -> Optional[str]:
2154
+ """
2155
+ The organization name this virtual machine is being installed for.
2156
+ """
1833
2157
  return pulumi.get(self, "organization_name")
1834
2158
 
1835
2159
  @property
1836
2160
  @pulumi.getter(name="productKey")
1837
2161
  def product_key(self) -> Optional[str]:
2162
+ """
2163
+ The product key for this virtual machine.
2164
+ """
1838
2165
  return pulumi.get(self, "product_key")
1839
2166
 
1840
2167
  @property
1841
2168
  @pulumi.getter(name="runOnceCommandLists")
1842
2169
  def run_once_command_lists(self) -> Optional[Sequence[str]]:
2170
+ """
2171
+ A list of commands to run at first user logon, after guest customization.
2172
+ """
1843
2173
  return pulumi.get(self, "run_once_command_lists")
1844
2174
 
1845
2175
  @property
1846
2176
  @pulumi.getter(name="timeZone")
1847
2177
  def time_zone(self) -> Optional[int]:
2178
+ """
2179
+ The new time zone for the virtual machine. This is a sysprep-dictated timezone code.
2180
+ """
1848
2181
  return pulumi.get(self, "time_zone")
1849
2182
 
1850
2183
  @property
1851
2184
  @pulumi.getter
1852
2185
  def workgroup(self) -> Optional[str]:
2186
+ """
2187
+ The workgroup for this virtual machine if not joining a domain.
2188
+ """
1853
2189
  return pulumi.get(self, "workgroup")
1854
2190
 
1855
2191
 
@@ -1923,11 +2259,13 @@ class VirtualMachineDisk(dict):
1923
2259
  uuid: Optional[str] = None,
1924
2260
  write_through: Optional[bool] = None):
1925
2261
  """
2262
+ :param str label: A unique label for this disk.
1926
2263
  :param bool attach: Attach an external disk instead of creating a new one. Implies and conflicts with `keep_on_remove`. If set, you cannot set `size`, `eagerly_scrub`, or `thin_provisioned`. Must set `path` if used.
1927
2264
 
1928
2265
  > **NOTE:** External disks cannot be attached when `datastore_cluster_id` is used.
1929
2266
  :param str controller_type: The type of storage controller to attach the disk to. Can be `scsi`, `sata`, or `ide`. You must have the appropriate number of controllers enabled for the selected type. Default `scsi`.
1930
2267
  :param str datastore_id: The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with `client_device`.
2268
+ :param str device_address: The internally-computed address of this device, such as scsi:0:1, denoting scsi bus #0 and device unit 1.
1931
2269
  :param str disk_mode: The mode of this this virtual disk for purposes of writes and snapshots. One of `append`, `independent_nonpersistent`, `independent_persistent`, `nonpersistent`, `persistent`, or `undoable`. Default: `persistent`. For more information on these option, please refer to the [product documentation][vmware-docs-disk-mode].
1932
2270
 
1933
2271
  [vmware-docs-disk-mode]: https://vdc-download.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.device.VirtualDiskOption.DiskMode.html
@@ -1998,6 +2336,9 @@ class VirtualMachineDisk(dict):
1998
2336
  @property
1999
2337
  @pulumi.getter
2000
2338
  def label(self) -> str:
2339
+ """
2340
+ A unique label for this disk.
2341
+ """
2001
2342
  return pulumi.get(self, "label")
2002
2343
 
2003
2344
  @property
@@ -2029,6 +2370,9 @@ class VirtualMachineDisk(dict):
2029
2370
  @property
2030
2371
  @pulumi.getter(name="deviceAddress")
2031
2372
  def device_address(self) -> Optional[str]:
2373
+ """
2374
+ The internally-computed address of this device, such as scsi:0:1, denoting scsi bus #0 and device unit 1.
2375
+ """
2032
2376
  return pulumi.get(self, "device_address")
2033
2377
 
2034
2378
  @property
@@ -2227,9 +2571,11 @@ class VirtualMachineNetworkInterface(dict):
2227
2571
  :param int bandwidth_reservation: The bandwidth reservation of the network interface, in Mbits/sec. The default is no reservation.
2228
2572
  :param int bandwidth_share_count: The share count for the network interface when the share level is `custom`. Ignored if `adapter_type` is set to `sriov`.
2229
2573
  :param str bandwidth_share_level: The bandwidth share allocation level for the network interface. One of `low`, `normal`, `high`, or `custom`. Default: `normal`. Ignored if `adapter_type` is set to `sriov`.
2574
+ :param str device_address: The internally-computed address of this device, such as scsi:0:1, denoting scsi bus #0 and device unit 1.
2230
2575
  :param int key: The ID of the device within the virtual machine.
2231
2576
  :param str mac_address: The MAC address of the network interface. Can only be manually set if `use_static_mac` is `true`. Otherwise, the value is computed and presents the assigned MAC address for the interface.
2232
2577
  :param str ovf_mapping: Specifies which NIC in an OVF/OVA the `network_interface` should be associated. Only applies at creation when deploying from an OVF/OVA.
2578
+ :param str physical_function: The ID of the Physical SR-IOV NIC to attach to, e.g. '0000:d8:00.0'
2233
2579
  :param bool use_static_mac: If true, the `mac_address` field is treated as a static MAC address and set accordingly. Setting this to `true` requires `mac_address` to be set. Default: `false`.
2234
2580
  """
2235
2581
  pulumi.set(__self__, "network_id", network_id)
@@ -2307,6 +2653,9 @@ class VirtualMachineNetworkInterface(dict):
2307
2653
  @property
2308
2654
  @pulumi.getter(name="deviceAddress")
2309
2655
  def device_address(self) -> Optional[str]:
2656
+ """
2657
+ The internally-computed address of this device, such as scsi:0:1, denoting scsi bus #0 and device unit 1.
2658
+ """
2310
2659
  return pulumi.get(self, "device_address")
2311
2660
 
2312
2661
  @property
@@ -2336,6 +2685,9 @@ class VirtualMachineNetworkInterface(dict):
2336
2685
  @property
2337
2686
  @pulumi.getter(name="physicalFunction")
2338
2687
  def physical_function(self) -> Optional[str]:
2688
+ """
2689
+ The ID of the Physical SR-IOV NIC to attach to, e.g. '0000:d8:00.0'
2690
+ """
2339
2691
  return pulumi.get(self, "physical_function")
2340
2692
 
2341
2693
  @property
@@ -2392,6 +2744,17 @@ class VirtualMachineOvfDeploy(dict):
2392
2744
  local_ovf_path: Optional[str] = None,
2393
2745
  ovf_network_map: Optional[Mapping[str, str]] = None,
2394
2746
  remote_ovf_url: Optional[str] = None):
2747
+ """
2748
+ :param bool allow_unverified_ssl_cert: Allow unverified ssl certificates while deploying ovf/ova from url.
2749
+ :param str deployment_option: The Deployment option to be chosen. If empty, the default option is used.
2750
+ :param str disk_provisioning: An optional disk provisioning. If set, all the disks in the deployed ovf will have the same specified disk type (e.g., thin provisioned).
2751
+ :param bool enable_hidden_properties: Allow properties with ovf:userConfigurable=false to be set.
2752
+ :param str ip_allocation_policy: The IP allocation policy.
2753
+ :param str ip_protocol: The IP protocol.
2754
+ :param str local_ovf_path: The absolute path to the ovf/ova file in the local system.
2755
+ :param Mapping[str, str] ovf_network_map: The mapping of name of network identifiers from the ovf descriptor to network UUID in the VI infrastructure.
2756
+ :param str remote_ovf_url: URL to the remote ovf/ova file to be deployed.
2757
+ """
2395
2758
  if allow_unverified_ssl_cert is not None:
2396
2759
  pulumi.set(__self__, "allow_unverified_ssl_cert", allow_unverified_ssl_cert)
2397
2760
  if deployment_option is not None:
@@ -2414,46 +2777,73 @@ class VirtualMachineOvfDeploy(dict):
2414
2777
  @property
2415
2778
  @pulumi.getter(name="allowUnverifiedSslCert")
2416
2779
  def allow_unverified_ssl_cert(self) -> Optional[bool]:
2780
+ """
2781
+ Allow unverified ssl certificates while deploying ovf/ova from url.
2782
+ """
2417
2783
  return pulumi.get(self, "allow_unverified_ssl_cert")
2418
2784
 
2419
2785
  @property
2420
2786
  @pulumi.getter(name="deploymentOption")
2421
2787
  def deployment_option(self) -> Optional[str]:
2788
+ """
2789
+ The Deployment option to be chosen. If empty, the default option is used.
2790
+ """
2422
2791
  return pulumi.get(self, "deployment_option")
2423
2792
 
2424
2793
  @property
2425
2794
  @pulumi.getter(name="diskProvisioning")
2426
2795
  def disk_provisioning(self) -> Optional[str]:
2796
+ """
2797
+ An optional disk provisioning. If set, all the disks in the deployed ovf will have the same specified disk type (e.g., thin provisioned).
2798
+ """
2427
2799
  return pulumi.get(self, "disk_provisioning")
2428
2800
 
2429
2801
  @property
2430
2802
  @pulumi.getter(name="enableHiddenProperties")
2431
2803
  def enable_hidden_properties(self) -> Optional[bool]:
2804
+ """
2805
+ Allow properties with ovf:userConfigurable=false to be set.
2806
+ """
2432
2807
  return pulumi.get(self, "enable_hidden_properties")
2433
2808
 
2434
2809
  @property
2435
2810
  @pulumi.getter(name="ipAllocationPolicy")
2436
2811
  def ip_allocation_policy(self) -> Optional[str]:
2812
+ """
2813
+ The IP allocation policy.
2814
+ """
2437
2815
  return pulumi.get(self, "ip_allocation_policy")
2438
2816
 
2439
2817
  @property
2440
2818
  @pulumi.getter(name="ipProtocol")
2441
2819
  def ip_protocol(self) -> Optional[str]:
2820
+ """
2821
+ The IP protocol.
2822
+ """
2442
2823
  return pulumi.get(self, "ip_protocol")
2443
2824
 
2444
2825
  @property
2445
2826
  @pulumi.getter(name="localOvfPath")
2446
2827
  def local_ovf_path(self) -> Optional[str]:
2828
+ """
2829
+ The absolute path to the ovf/ova file in the local system.
2830
+ """
2447
2831
  return pulumi.get(self, "local_ovf_path")
2448
2832
 
2449
2833
  @property
2450
2834
  @pulumi.getter(name="ovfNetworkMap")
2451
2835
  def ovf_network_map(self) -> Optional[Mapping[str, str]]:
2836
+ """
2837
+ The mapping of name of network identifiers from the ovf descriptor to network UUID in the VI infrastructure.
2838
+ """
2452
2839
  return pulumi.get(self, "ovf_network_map")
2453
2840
 
2454
2841
  @property
2455
2842
  @pulumi.getter(name="remoteOvfUrl")
2456
2843
  def remote_ovf_url(self) -> Optional[str]:
2844
+ """
2845
+ URL to the remote ovf/ova file to be deployed.
2846
+ """
2457
2847
  return pulumi.get(self, "remote_ovf_url")
2458
2848
 
2459
2849
 
@@ -2461,12 +2851,18 @@ class VirtualMachineOvfDeploy(dict):
2461
2851
  class VirtualMachineVapp(dict):
2462
2852
  def __init__(__self__, *,
2463
2853
  properties: Optional[Mapping[str, str]] = None):
2854
+ """
2855
+ :param Mapping[str, str] properties: A map of customizable vApp properties and their values. Allows customization of VMs cloned from OVF templates which have customizable vApp properties.
2856
+ """
2464
2857
  if properties is not None:
2465
2858
  pulumi.set(__self__, "properties", properties)
2466
2859
 
2467
2860
  @property
2468
2861
  @pulumi.getter
2469
2862
  def properties(self) -> Optional[Mapping[str, str]]:
2863
+ """
2864
+ A map of customizable vApp properties and their values. Allows customization of VMs cloned from OVF templates which have customizable vApp properties.
2865
+ """
2470
2866
  return pulumi.get(self, "properties")
2471
2867
 
2472
2868
 
@@ -2649,6 +3045,14 @@ class GetGuestOsCustomizationSpecResult(dict):
2649
3045
  network_interfaces: Sequence['outputs.GetGuestOsCustomizationSpecNetworkInterfaceResult'],
2650
3046
  windows_options: Sequence['outputs.GetGuestOsCustomizationSpecWindowsOptionResult'],
2651
3047
  windows_sysprep_text: str):
3048
+ """
3049
+ :param Sequence[str] dns_server_lists: A list of DNS servers for a virtual network adapter with a static IP address.
3050
+ :param Sequence[str] dns_suffix_lists: A list of DNS search domains to add to the DNS configuration on the virtual machine.
3051
+ :param Sequence['GetGuestOsCustomizationSpecLinuxOptionArgs'] linux_options: A list of configuration options specific to Linux.
3052
+ :param Sequence['GetGuestOsCustomizationSpecNetworkInterfaceArgs'] network_interfaces: A specification of network interface configuration options.
3053
+ :param Sequence['GetGuestOsCustomizationSpecWindowsOptionArgs'] windows_options: A list of configuration options specific to Windows.
3054
+ :param str windows_sysprep_text: Use this option to specify use of a Windows Sysprep file.
3055
+ """
2652
3056
  pulumi.set(__self__, "dns_server_lists", dns_server_lists)
2653
3057
  pulumi.set(__self__, "dns_suffix_lists", dns_suffix_lists)
2654
3058
  pulumi.set(__self__, "linux_options", linux_options)
@@ -2659,31 +3063,49 @@ class GetGuestOsCustomizationSpecResult(dict):
2659
3063
  @property
2660
3064
  @pulumi.getter(name="dnsServerLists")
2661
3065
  def dns_server_lists(self) -> Sequence[str]:
3066
+ """
3067
+ A list of DNS servers for a virtual network adapter with a static IP address.
3068
+ """
2662
3069
  return pulumi.get(self, "dns_server_lists")
2663
3070
 
2664
3071
  @property
2665
3072
  @pulumi.getter(name="dnsSuffixLists")
2666
3073
  def dns_suffix_lists(self) -> Sequence[str]:
3074
+ """
3075
+ A list of DNS search domains to add to the DNS configuration on the virtual machine.
3076
+ """
2667
3077
  return pulumi.get(self, "dns_suffix_lists")
2668
3078
 
2669
3079
  @property
2670
3080
  @pulumi.getter(name="linuxOptions")
2671
3081
  def linux_options(self) -> Sequence['outputs.GetGuestOsCustomizationSpecLinuxOptionResult']:
3082
+ """
3083
+ A list of configuration options specific to Linux.
3084
+ """
2672
3085
  return pulumi.get(self, "linux_options")
2673
3086
 
2674
3087
  @property
2675
3088
  @pulumi.getter(name="networkInterfaces")
2676
3089
  def network_interfaces(self) -> Sequence['outputs.GetGuestOsCustomizationSpecNetworkInterfaceResult']:
3090
+ """
3091
+ A specification of network interface configuration options.
3092
+ """
2677
3093
  return pulumi.get(self, "network_interfaces")
2678
3094
 
2679
3095
  @property
2680
3096
  @pulumi.getter(name="windowsOptions")
2681
3097
  def windows_options(self) -> Sequence['outputs.GetGuestOsCustomizationSpecWindowsOptionResult']:
3098
+ """
3099
+ A list of configuration options specific to Windows.
3100
+ """
2682
3101
  return pulumi.get(self, "windows_options")
2683
3102
 
2684
3103
  @property
2685
3104
  @pulumi.getter(name="windowsSysprepText")
2686
3105
  def windows_sysprep_text(self) -> str:
3106
+ """
3107
+ Use this option to specify use of a Windows Sysprep file.
3108
+ """
2687
3109
  return pulumi.get(self, "windows_sysprep_text")
2688
3110
 
2689
3111
 
@@ -2695,6 +3117,13 @@ class GetGuestOsCustomizationSpecLinuxOptionResult(dict):
2695
3117
  hw_clock_utc: bool,
2696
3118
  script_text: str,
2697
3119
  time_zone: str):
3120
+ """
3121
+ :param str domain: The domain name for this virtual machine.
3122
+ :param str host_name: The hostname for this virtual machine.
3123
+ :param bool hw_clock_utc: Specifies whether or not the hardware clock should be in UTC or not.
3124
+ :param str script_text: The customization script to run before and or after guest customization.
3125
+ :param str time_zone: 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.
3126
+ """
2698
3127
  pulumi.set(__self__, "domain", domain)
2699
3128
  pulumi.set(__self__, "host_name", host_name)
2700
3129
  pulumi.set(__self__, "hw_clock_utc", hw_clock_utc)
@@ -2704,26 +3133,41 @@ class GetGuestOsCustomizationSpecLinuxOptionResult(dict):
2704
3133
  @property
2705
3134
  @pulumi.getter
2706
3135
  def domain(self) -> str:
3136
+ """
3137
+ The domain name for this virtual machine.
3138
+ """
2707
3139
  return pulumi.get(self, "domain")
2708
3140
 
2709
3141
  @property
2710
3142
  @pulumi.getter(name="hostName")
2711
3143
  def host_name(self) -> str:
3144
+ """
3145
+ The hostname for this virtual machine.
3146
+ """
2712
3147
  return pulumi.get(self, "host_name")
2713
3148
 
2714
3149
  @property
2715
3150
  @pulumi.getter(name="hwClockUtc")
2716
3151
  def hw_clock_utc(self) -> bool:
3152
+ """
3153
+ Specifies whether or not the hardware clock should be in UTC or not.
3154
+ """
2717
3155
  return pulumi.get(self, "hw_clock_utc")
2718
3156
 
2719
3157
  @property
2720
3158
  @pulumi.getter(name="scriptText")
2721
3159
  def script_text(self) -> str:
3160
+ """
3161
+ The customization script to run before and or after guest customization.
3162
+ """
2722
3163
  return pulumi.get(self, "script_text")
2723
3164
 
2724
3165
  @property
2725
3166
  @pulumi.getter(name="timeZone")
2726
3167
  def time_zone(self) -> str:
3168
+ """
3169
+ 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.
3170
+ """
2727
3171
  return pulumi.get(self, "time_zone")
2728
3172
 
2729
3173
 
@@ -2736,6 +3180,14 @@ class GetGuestOsCustomizationSpecNetworkInterfaceResult(dict):
2736
3180
  ipv4_netmask: int,
2737
3181
  ipv6_address: str,
2738
3182
  ipv6_netmask: int):
3183
+ """
3184
+ :param str dns_domain: A DNS search domain to add to the DNS configuration on the virtual machine.
3185
+ :param Sequence[str] dns_server_lists: Network-interface specific DNS settings for Windows operating systems. Ignored on Linux.
3186
+ :param str ipv4_address: The IPv4 address assigned to this network adapter. If left blank, DHCP is used.
3187
+ :param int ipv4_netmask: The IPv4 CIDR netmask for the supplied IP address. Ignored if DHCP is selected.
3188
+ :param str ipv6_address: The IPv6 address assigned to this network adapter. If left blank, default auto-configuration is used.
3189
+ :param int ipv6_netmask: The IPv6 CIDR netmask for the supplied IP address. Ignored if auto-configuration is selected.
3190
+ """
2739
3191
  pulumi.set(__self__, "dns_domain", dns_domain)
2740
3192
  pulumi.set(__self__, "dns_server_lists", dns_server_lists)
2741
3193
  pulumi.set(__self__, "ipv4_address", ipv4_address)
@@ -2746,31 +3198,49 @@ class GetGuestOsCustomizationSpecNetworkInterfaceResult(dict):
2746
3198
  @property
2747
3199
  @pulumi.getter(name="dnsDomain")
2748
3200
  def dns_domain(self) -> str:
3201
+ """
3202
+ A DNS search domain to add to the DNS configuration on the virtual machine.
3203
+ """
2749
3204
  return pulumi.get(self, "dns_domain")
2750
3205
 
2751
3206
  @property
2752
3207
  @pulumi.getter(name="dnsServerLists")
2753
3208
  def dns_server_lists(self) -> Sequence[str]:
3209
+ """
3210
+ Network-interface specific DNS settings for Windows operating systems. Ignored on Linux.
3211
+ """
2754
3212
  return pulumi.get(self, "dns_server_lists")
2755
3213
 
2756
3214
  @property
2757
3215
  @pulumi.getter(name="ipv4Address")
2758
3216
  def ipv4_address(self) -> str:
3217
+ """
3218
+ The IPv4 address assigned to this network adapter. If left blank, DHCP is used.
3219
+ """
2759
3220
  return pulumi.get(self, "ipv4_address")
2760
3221
 
2761
3222
  @property
2762
3223
  @pulumi.getter(name="ipv4Netmask")
2763
3224
  def ipv4_netmask(self) -> int:
3225
+ """
3226
+ The IPv4 CIDR netmask for the supplied IP address. Ignored if DHCP is selected.
3227
+ """
2764
3228
  return pulumi.get(self, "ipv4_netmask")
2765
3229
 
2766
3230
  @property
2767
3231
  @pulumi.getter(name="ipv6Address")
2768
3232
  def ipv6_address(self) -> str:
3233
+ """
3234
+ The IPv6 address assigned to this network adapter. If left blank, default auto-configuration is used.
3235
+ """
2769
3236
  return pulumi.get(self, "ipv6_address")
2770
3237
 
2771
3238
  @property
2772
3239
  @pulumi.getter(name="ipv6Netmask")
2773
3240
  def ipv6_netmask(self) -> int:
3241
+ """
3242
+ The IPv6 CIDR netmask for the supplied IP address. Ignored if auto-configuration is selected.
3243
+ """
2774
3244
  return pulumi.get(self, "ipv6_netmask")
2775
3245
 
2776
3246
 
@@ -2787,6 +3257,18 @@ class GetGuestOsCustomizationSpecWindowsOptionResult(dict):
2787
3257
  time_zone: int,
2788
3258
  workgroup: str,
2789
3259
  domain_admin_password: Optional[str] = None):
3260
+ """
3261
+ :param str admin_password: The new administrator password for this virtual machine.
3262
+ :param bool auto_logon: Specifies whether or not the guest operating system automatically logs on as Administrator.
3263
+ :param int auto_logon_count: Specifies how many times the guest operating system should auto-logon the Administrator account when `auto_logon` is `true`.
3264
+ :param str computer_name: The hostname for this virtual machine.
3265
+ :param str domain_admin_user: The user account of the domain administrator used to join this virtual machine to the domain.
3266
+ :param str join_domain: The Active Directory domain for the virtual machine to join.
3267
+ :param Sequence[str] run_once_command_lists: A list of commands to run at first user logon, after guest customization.
3268
+ :param int time_zone: The new time zone for the virtual machine. This is a sysprep-dictated timezone code.
3269
+ :param str workgroup: The workgroup for this virtual machine if not joining an Active Directory domain.
3270
+ :param str domain_admin_password: The user account used to join this virtual machine to the Active Directory domain.
3271
+ """
2790
3272
  pulumi.set(__self__, "admin_password", admin_password)
2791
3273
  pulumi.set(__self__, "auto_logon", auto_logon)
2792
3274
  pulumi.set(__self__, "auto_logon_count", auto_logon_count)
@@ -2802,51 +3284,81 @@ class GetGuestOsCustomizationSpecWindowsOptionResult(dict):
2802
3284
  @property
2803
3285
  @pulumi.getter(name="adminPassword")
2804
3286
  def admin_password(self) -> str:
3287
+ """
3288
+ The new administrator password for this virtual machine.
3289
+ """
2805
3290
  return pulumi.get(self, "admin_password")
2806
3291
 
2807
3292
  @property
2808
3293
  @pulumi.getter(name="autoLogon")
2809
3294
  def auto_logon(self) -> bool:
3295
+ """
3296
+ Specifies whether or not the guest operating system automatically logs on as Administrator.
3297
+ """
2810
3298
  return pulumi.get(self, "auto_logon")
2811
3299
 
2812
3300
  @property
2813
3301
  @pulumi.getter(name="autoLogonCount")
2814
3302
  def auto_logon_count(self) -> int:
3303
+ """
3304
+ Specifies how many times the guest operating system should auto-logon the Administrator account when `auto_logon` is `true`.
3305
+ """
2815
3306
  return pulumi.get(self, "auto_logon_count")
2816
3307
 
2817
3308
  @property
2818
3309
  @pulumi.getter(name="computerName")
2819
3310
  def computer_name(self) -> str:
3311
+ """
3312
+ The hostname for this virtual machine.
3313
+ """
2820
3314
  return pulumi.get(self, "computer_name")
2821
3315
 
2822
3316
  @property
2823
3317
  @pulumi.getter(name="domainAdminUser")
2824
3318
  def domain_admin_user(self) -> str:
3319
+ """
3320
+ The user account of the domain administrator used to join this virtual machine to the domain.
3321
+ """
2825
3322
  return pulumi.get(self, "domain_admin_user")
2826
3323
 
2827
3324
  @property
2828
3325
  @pulumi.getter(name="joinDomain")
2829
3326
  def join_domain(self) -> str:
3327
+ """
3328
+ The Active Directory domain for the virtual machine to join.
3329
+ """
2830
3330
  return pulumi.get(self, "join_domain")
2831
3331
 
2832
3332
  @property
2833
3333
  @pulumi.getter(name="runOnceCommandLists")
2834
3334
  def run_once_command_lists(self) -> Sequence[str]:
3335
+ """
3336
+ A list of commands to run at first user logon, after guest customization.
3337
+ """
2835
3338
  return pulumi.get(self, "run_once_command_lists")
2836
3339
 
2837
3340
  @property
2838
3341
  @pulumi.getter(name="timeZone")
2839
3342
  def time_zone(self) -> int:
3343
+ """
3344
+ The new time zone for the virtual machine. This is a sysprep-dictated timezone code.
3345
+ """
2840
3346
  return pulumi.get(self, "time_zone")
2841
3347
 
2842
3348
  @property
2843
3349
  @pulumi.getter
2844
3350
  def workgroup(self) -> str:
3351
+ """
3352
+ The workgroup for this virtual machine if not joining an Active Directory domain.
3353
+ """
2845
3354
  return pulumi.get(self, "workgroup")
2846
3355
 
2847
3356
  @property
2848
3357
  @pulumi.getter(name="domainAdminPassword")
2849
3358
  def domain_admin_password(self) -> Optional[str]:
3359
+ """
3360
+ The user account used to join this virtual machine to the Active Directory domain.
3361
+ """
2850
3362
  return pulumi.get(self, "domain_admin_password")
2851
3363
 
2852
3364
 
@@ -2932,6 +3444,7 @@ class GetVirtualMachineNetworkInterfaceResult(dict):
2932
3444
  :param str mac_address: The MAC address of this network interface.
2933
3445
  :param str network_id: The managed object reference ID of the network this interface is
2934
3446
  connected to.
3447
+ :param str physical_function: The ID of the Physical SR-IOV NIC to attach to, e.g. '0000:d8:00.0'
2935
3448
  :param int bandwidth_limit: The upper bandwidth limit of this network interface,
2936
3449
  in Mbits/sec.
2937
3450
  :param int bandwidth_reservation: The bandwidth reservation of this network interface,
@@ -2990,6 +3503,9 @@ class GetVirtualMachineNetworkInterfaceResult(dict):
2990
3503
  @property
2991
3504
  @pulumi.getter(name="physicalFunction")
2992
3505
  def physical_function(self) -> str:
3506
+ """
3507
+ The ID of the Physical SR-IOV NIC to attach to, e.g. '0000:d8:00.0'
3508
+ """
2993
3509
  return pulumi.get(self, "physical_function")
2994
3510
 
2995
3511
  @property
@@ -3024,12 +3540,18 @@ class GetVirtualMachineNetworkInterfaceResult(dict):
3024
3540
  class GetVirtualMachineVappResult(dict):
3025
3541
  def __init__(__self__, *,
3026
3542
  properties: Optional[Mapping[str, str]] = None):
3543
+ """
3544
+ :param Mapping[str, str] properties: A map of customizable vApp properties and their values. Allows customization of VMs cloned from OVF templates which have customizable vApp properties.
3545
+ """
3027
3546
  if properties is not None:
3028
3547
  pulumi.set(__self__, "properties", properties)
3029
3548
 
3030
3549
  @property
3031
3550
  @pulumi.getter
3032
3551
  def properties(self) -> Optional[Mapping[str, str]]:
3552
+ """
3553
+ A map of customizable vApp properties and their values. Allows customization of VMs cloned from OVF templates which have customizable vApp properties.
3554
+ """
3033
3555
  return pulumi.get(self, "properties")
3034
3556
 
3035
3557