vsphere.VirtualMachine
Explore with Pulumi AI
Create VirtualMachine Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new VirtualMachine(name: string, args: VirtualMachineArgs, opts?: CustomResourceOptions);
@overload
def VirtualMachine(resource_name: str,
args: VirtualMachineArgs,
opts: Optional[ResourceOptions] = None)
@overload
def VirtualMachine(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_pool_id: Optional[str] = None,
alternate_guest_name: Optional[str] = None,
annotation: Optional[str] = None,
boot_delay: Optional[int] = None,
boot_retry_delay: Optional[int] = None,
boot_retry_enabled: Optional[bool] = None,
cdroms: Optional[Sequence[VirtualMachineCdromArgs]] = None,
clone: Optional[VirtualMachineCloneArgs] = None,
cpu_hot_add_enabled: Optional[bool] = None,
cpu_hot_remove_enabled: Optional[bool] = None,
cpu_limit: Optional[int] = None,
cpu_performance_counters_enabled: Optional[bool] = None,
cpu_reservation: Optional[int] = None,
cpu_share_count: Optional[int] = None,
cpu_share_level: Optional[str] = None,
custom_attributes: Optional[Mapping[str, str]] = None,
datacenter_id: Optional[str] = None,
datastore_cluster_id: Optional[str] = None,
datastore_id: Optional[str] = None,
disks: Optional[Sequence[VirtualMachineDiskArgs]] = None,
efi_secure_boot_enabled: Optional[bool] = None,
enable_disk_uuid: Optional[bool] = None,
enable_logging: Optional[bool] = None,
ept_rvi_mode: Optional[str] = None,
extra_config: Optional[Mapping[str, str]] = None,
extra_config_reboot_required: Optional[bool] = None,
firmware: Optional[str] = None,
folder: Optional[str] = None,
force_power_off: Optional[bool] = None,
guest_id: Optional[str] = None,
hardware_version: Optional[int] = None,
host_system_id: Optional[str] = None,
hv_mode: Optional[str] = None,
ide_controller_count: Optional[int] = None,
ignored_guest_ips: Optional[Sequence[str]] = None,
latency_sensitivity: Optional[str] = None,
memory: Optional[int] = None,
memory_hot_add_enabled: Optional[bool] = None,
memory_limit: Optional[int] = None,
memory_reservation: Optional[int] = None,
memory_reservation_locked_to_max: Optional[bool] = None,
memory_share_count: Optional[int] = None,
memory_share_level: Optional[str] = None,
migrate_wait_timeout: Optional[int] = None,
name: Optional[str] = None,
nested_hv_enabled: Optional[bool] = None,
network_interfaces: Optional[Sequence[VirtualMachineNetworkInterfaceArgs]] = None,
num_cores_per_socket: Optional[int] = None,
num_cpus: Optional[int] = None,
ovf_deploy: Optional[VirtualMachineOvfDeployArgs] = None,
pci_device_ids: Optional[Sequence[str]] = None,
poweron_timeout: Optional[int] = None,
replace_trigger: Optional[str] = None,
run_tools_scripts_after_power_on: Optional[bool] = None,
run_tools_scripts_after_resume: Optional[bool] = None,
run_tools_scripts_before_guest_reboot: Optional[bool] = None,
run_tools_scripts_before_guest_shutdown: Optional[bool] = None,
run_tools_scripts_before_guest_standby: Optional[bool] = None,
sata_controller_count: Optional[int] = None,
scsi_bus_sharing: Optional[str] = None,
scsi_controller_count: Optional[int] = None,
scsi_type: Optional[str] = None,
shutdown_wait_timeout: Optional[int] = None,
storage_policy_id: Optional[str] = None,
swap_placement_policy: Optional[str] = None,
sync_time_with_host: Optional[bool] = None,
sync_time_with_host_periodically: Optional[bool] = None,
tags: Optional[Sequence[str]] = None,
tools_upgrade_policy: Optional[str] = None,
vapp: Optional[VirtualMachineVappArgs] = None,
vbs_enabled: Optional[bool] = None,
vvtd_enabled: Optional[bool] = None,
wait_for_guest_ip_timeout: Optional[int] = None,
wait_for_guest_net_routable: Optional[bool] = None,
wait_for_guest_net_timeout: Optional[int] = None)
func NewVirtualMachine(ctx *Context, name string, args VirtualMachineArgs, opts ...ResourceOption) (*VirtualMachine, error)
public VirtualMachine(string name, VirtualMachineArgs args, CustomResourceOptions? opts = null)
public VirtualMachine(String name, VirtualMachineArgs args)
public VirtualMachine(String name, VirtualMachineArgs args, CustomResourceOptions options)
type: vsphere:VirtualMachine
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args VirtualMachineArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args VirtualMachineArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args VirtualMachineArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args VirtualMachineArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args VirtualMachineArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Example
The following reference example uses placeholder values for all input properties.
var virtualMachineResource = new VSphere.VirtualMachine("virtualMachineResource", new()
{
ResourcePoolId = "string",
AlternateGuestName = "string",
Annotation = "string",
BootDelay = 0,
BootRetryDelay = 0,
BootRetryEnabled = false,
Cdroms = new[]
{
new VSphere.Inputs.VirtualMachineCdromArgs
{
ClientDevice = false,
DatastoreId = "string",
DeviceAddress = "string",
Key = 0,
Path = "string",
},
},
Clone = new VSphere.Inputs.VirtualMachineCloneArgs
{
TemplateUuid = "string",
CustomizationSpec = new VSphere.Inputs.VirtualMachineCloneCustomizationSpecArgs
{
Id = "string",
Timeout = 0,
},
Customize = new VSphere.Inputs.VirtualMachineCloneCustomizeArgs
{
DnsServerLists = new[]
{
"string",
},
DnsSuffixLists = new[]
{
"string",
},
Ipv4Gateway = "string",
Ipv6Gateway = "string",
LinuxOptions = new VSphere.Inputs.VirtualMachineCloneCustomizeLinuxOptionsArgs
{
Domain = "string",
HostName = "string",
HwClockUtc = false,
ScriptText = "string",
TimeZone = "string",
},
NetworkInterfaces = new[]
{
new VSphere.Inputs.VirtualMachineCloneCustomizeNetworkInterfaceArgs
{
DnsDomain = "string",
DnsServerLists = new[]
{
"string",
},
Ipv4Address = "string",
Ipv4Netmask = 0,
Ipv6Address = "string",
Ipv6Netmask = 0,
},
},
Timeout = 0,
WindowsOptions = new VSphere.Inputs.VirtualMachineCloneCustomizeWindowsOptionsArgs
{
ComputerName = "string",
FullName = "string",
AutoLogonCount = 0,
AutoLogon = false,
DomainAdminPassword = "string",
DomainAdminUser = "string",
AdminPassword = "string",
JoinDomain = "string",
OrganizationName = "string",
ProductKey = "string",
RunOnceCommandLists = new[]
{
"string",
},
TimeZone = 0,
Workgroup = "string",
},
WindowsSysprepText = "string",
},
LinkedClone = false,
OvfNetworkMap =
{
{ "string", "string" },
},
OvfStorageMap =
{
{ "string", "string" },
},
Timeout = 0,
},
CpuHotAddEnabled = false,
CpuHotRemoveEnabled = false,
CpuLimit = 0,
CpuPerformanceCountersEnabled = false,
CpuReservation = 0,
CpuShareCount = 0,
CpuShareLevel = "string",
CustomAttributes =
{
{ "string", "string" },
},
DatacenterId = "string",
DatastoreClusterId = "string",
DatastoreId = "string",
Disks = new[]
{
new VSphere.Inputs.VirtualMachineDiskArgs
{
Label = "string",
IoShareLevel = "string",
UnitNumber = 0,
DeviceAddress = "string",
DiskMode = "string",
DiskSharing = "string",
EagerlyScrub = false,
IoLimit = 0,
KeepOnRemove = false,
WriteThrough = false,
DatastoreId = "string",
IoReservation = 0,
Key = 0,
ControllerType = "string",
Path = "string",
Size = 0,
StoragePolicyId = "string",
ThinProvisioned = false,
Attach = false,
Uuid = "string",
IoShareCount = 0,
},
},
EfiSecureBootEnabled = false,
EnableDiskUuid = false,
EnableLogging = false,
EptRviMode = "string",
ExtraConfig =
{
{ "string", "string" },
},
ExtraConfigRebootRequired = false,
Firmware = "string",
Folder = "string",
ForcePowerOff = false,
GuestId = "string",
HardwareVersion = 0,
HostSystemId = "string",
HvMode = "string",
IdeControllerCount = 0,
IgnoredGuestIps = new[]
{
"string",
},
LatencySensitivity = "string",
Memory = 0,
MemoryHotAddEnabled = false,
MemoryLimit = 0,
MemoryReservation = 0,
MemoryReservationLockedToMax = false,
MemoryShareCount = 0,
MemoryShareLevel = "string",
MigrateWaitTimeout = 0,
Name = "string",
NestedHvEnabled = false,
NetworkInterfaces = new[]
{
new VSphere.Inputs.VirtualMachineNetworkInterfaceArgs
{
NetworkId = "string",
AdapterType = "string",
BandwidthLimit = 0,
BandwidthReservation = 0,
BandwidthShareCount = 0,
BandwidthShareLevel = "string",
DeviceAddress = "string",
Key = 0,
MacAddress = "string",
OvfMapping = "string",
PhysicalFunction = "string",
UseStaticMac = false,
},
},
NumCoresPerSocket = 0,
NumCpus = 0,
OvfDeploy = new VSphere.Inputs.VirtualMachineOvfDeployArgs
{
AllowUnverifiedSslCert = false,
DeploymentOption = "string",
DiskProvisioning = "string",
EnableHiddenProperties = false,
IpAllocationPolicy = "string",
IpProtocol = "string",
LocalOvfPath = "string",
OvfNetworkMap =
{
{ "string", "string" },
},
RemoteOvfUrl = "string",
},
PciDeviceIds = new[]
{
"string",
},
PoweronTimeout = 0,
ReplaceTrigger = "string",
RunToolsScriptsAfterPowerOn = false,
RunToolsScriptsAfterResume = false,
RunToolsScriptsBeforeGuestReboot = false,
RunToolsScriptsBeforeGuestShutdown = false,
RunToolsScriptsBeforeGuestStandby = false,
SataControllerCount = 0,
ScsiBusSharing = "string",
ScsiControllerCount = 0,
ScsiType = "string",
ShutdownWaitTimeout = 0,
StoragePolicyId = "string",
SwapPlacementPolicy = "string",
SyncTimeWithHost = false,
SyncTimeWithHostPeriodically = false,
Tags = new[]
{
"string",
},
ToolsUpgradePolicy = "string",
Vapp = new VSphere.Inputs.VirtualMachineVappArgs
{
Properties =
{
{ "string", "string" },
},
},
VbsEnabled = false,
VvtdEnabled = false,
WaitForGuestIpTimeout = 0,
WaitForGuestNetRoutable = false,
WaitForGuestNetTimeout = 0,
});
example, err := vsphere.NewVirtualMachine(ctx, "virtualMachineResource", &vsphere.VirtualMachineArgs{
ResourcePoolId: pulumi.String("string"),
AlternateGuestName: pulumi.String("string"),
Annotation: pulumi.String("string"),
BootDelay: pulumi.Int(0),
BootRetryDelay: pulumi.Int(0),
BootRetryEnabled: pulumi.Bool(false),
Cdroms: vsphere.VirtualMachineCdromArray{
&vsphere.VirtualMachineCdromArgs{
ClientDevice: pulumi.Bool(false),
DatastoreId: pulumi.String("string"),
DeviceAddress: pulumi.String("string"),
Key: pulumi.Int(0),
Path: pulumi.String("string"),
},
},
Clone: &vsphere.VirtualMachineCloneArgs{
TemplateUuid: pulumi.String("string"),
CustomizationSpec: &vsphere.VirtualMachineCloneCustomizationSpecArgs{
Id: pulumi.String("string"),
Timeout: pulumi.Int(0),
},
Customize: &vsphere.VirtualMachineCloneCustomizeArgs{
DnsServerLists: pulumi.StringArray{
pulumi.String("string"),
},
DnsSuffixLists: pulumi.StringArray{
pulumi.String("string"),
},
Ipv4Gateway: pulumi.String("string"),
Ipv6Gateway: pulumi.String("string"),
LinuxOptions: &vsphere.VirtualMachineCloneCustomizeLinuxOptionsArgs{
Domain: pulumi.String("string"),
HostName: pulumi.String("string"),
HwClockUtc: pulumi.Bool(false),
ScriptText: pulumi.String("string"),
TimeZone: pulumi.String("string"),
},
NetworkInterfaces: vsphere.VirtualMachineCloneCustomizeNetworkInterfaceArray{
&vsphere.VirtualMachineCloneCustomizeNetworkInterfaceArgs{
DnsDomain: pulumi.String("string"),
DnsServerLists: pulumi.StringArray{
pulumi.String("string"),
},
Ipv4Address: pulumi.String("string"),
Ipv4Netmask: pulumi.Int(0),
Ipv6Address: pulumi.String("string"),
Ipv6Netmask: pulumi.Int(0),
},
},
Timeout: pulumi.Int(0),
WindowsOptions: &vsphere.VirtualMachineCloneCustomizeWindowsOptionsArgs{
ComputerName: pulumi.String("string"),
FullName: pulumi.String("string"),
AutoLogonCount: pulumi.Int(0),
AutoLogon: pulumi.Bool(false),
DomainAdminPassword: pulumi.String("string"),
DomainAdminUser: pulumi.String("string"),
AdminPassword: pulumi.String("string"),
JoinDomain: pulumi.String("string"),
OrganizationName: pulumi.String("string"),
ProductKey: pulumi.String("string"),
RunOnceCommandLists: pulumi.StringArray{
pulumi.String("string"),
},
TimeZone: pulumi.Int(0),
Workgroup: pulumi.String("string"),
},
WindowsSysprepText: pulumi.String("string"),
},
LinkedClone: pulumi.Bool(false),
OvfNetworkMap: pulumi.StringMap{
"string": pulumi.String("string"),
},
OvfStorageMap: pulumi.StringMap{
"string": pulumi.String("string"),
},
Timeout: pulumi.Int(0),
},
CpuHotAddEnabled: pulumi.Bool(false),
CpuHotRemoveEnabled: pulumi.Bool(false),
CpuLimit: pulumi.Int(0),
CpuPerformanceCountersEnabled: pulumi.Bool(false),
CpuReservation: pulumi.Int(0),
CpuShareCount: pulumi.Int(0),
CpuShareLevel: pulumi.String("string"),
CustomAttributes: pulumi.StringMap{
"string": pulumi.String("string"),
},
DatacenterId: pulumi.String("string"),
DatastoreClusterId: pulumi.String("string"),
DatastoreId: pulumi.String("string"),
Disks: vsphere.VirtualMachineDiskArray{
&vsphere.VirtualMachineDiskArgs{
Label: pulumi.String("string"),
IoShareLevel: pulumi.String("string"),
UnitNumber: pulumi.Int(0),
DeviceAddress: pulumi.String("string"),
DiskMode: pulumi.String("string"),
DiskSharing: pulumi.String("string"),
EagerlyScrub: pulumi.Bool(false),
IoLimit: pulumi.Int(0),
KeepOnRemove: pulumi.Bool(false),
WriteThrough: pulumi.Bool(false),
DatastoreId: pulumi.String("string"),
IoReservation: pulumi.Int(0),
Key: pulumi.Int(0),
ControllerType: pulumi.String("string"),
Path: pulumi.String("string"),
Size: pulumi.Int(0),
StoragePolicyId: pulumi.String("string"),
ThinProvisioned: pulumi.Bool(false),
Attach: pulumi.Bool(false),
Uuid: pulumi.String("string"),
IoShareCount: pulumi.Int(0),
},
},
EfiSecureBootEnabled: pulumi.Bool(false),
EnableDiskUuid: pulumi.Bool(false),
EnableLogging: pulumi.Bool(false),
EptRviMode: pulumi.String("string"),
ExtraConfig: pulumi.StringMap{
"string": pulumi.String("string"),
},
ExtraConfigRebootRequired: pulumi.Bool(false),
Firmware: pulumi.String("string"),
Folder: pulumi.String("string"),
ForcePowerOff: pulumi.Bool(false),
GuestId: pulumi.String("string"),
HardwareVersion: pulumi.Int(0),
HostSystemId: pulumi.String("string"),
HvMode: pulumi.String("string"),
IdeControllerCount: pulumi.Int(0),
IgnoredGuestIps: pulumi.StringArray{
pulumi.String("string"),
},
LatencySensitivity: pulumi.String("string"),
Memory: pulumi.Int(0),
MemoryHotAddEnabled: pulumi.Bool(false),
MemoryLimit: pulumi.Int(0),
MemoryReservation: pulumi.Int(0),
MemoryReservationLockedToMax: pulumi.Bool(false),
MemoryShareCount: pulumi.Int(0),
MemoryShareLevel: pulumi.String("string"),
MigrateWaitTimeout: pulumi.Int(0),
Name: pulumi.String("string"),
NestedHvEnabled: pulumi.Bool(false),
NetworkInterfaces: vsphere.VirtualMachineNetworkInterfaceArray{
&vsphere.VirtualMachineNetworkInterfaceArgs{
NetworkId: pulumi.String("string"),
AdapterType: pulumi.String("string"),
BandwidthLimit: pulumi.Int(0),
BandwidthReservation: pulumi.Int(0),
BandwidthShareCount: pulumi.Int(0),
BandwidthShareLevel: pulumi.String("string"),
DeviceAddress: pulumi.String("string"),
Key: pulumi.Int(0),
MacAddress: pulumi.String("string"),
OvfMapping: pulumi.String("string"),
PhysicalFunction: pulumi.String("string"),
UseStaticMac: pulumi.Bool(false),
},
},
NumCoresPerSocket: pulumi.Int(0),
NumCpus: pulumi.Int(0),
OvfDeploy: &vsphere.VirtualMachineOvfDeployArgs{
AllowUnverifiedSslCert: pulumi.Bool(false),
DeploymentOption: pulumi.String("string"),
DiskProvisioning: pulumi.String("string"),
EnableHiddenProperties: pulumi.Bool(false),
IpAllocationPolicy: pulumi.String("string"),
IpProtocol: pulumi.String("string"),
LocalOvfPath: pulumi.String("string"),
OvfNetworkMap: pulumi.StringMap{
"string": pulumi.String("string"),
},
RemoteOvfUrl: pulumi.String("string"),
},
PciDeviceIds: pulumi.StringArray{
pulumi.String("string"),
},
PoweronTimeout: pulumi.Int(0),
ReplaceTrigger: pulumi.String("string"),
RunToolsScriptsAfterPowerOn: pulumi.Bool(false),
RunToolsScriptsAfterResume: pulumi.Bool(false),
RunToolsScriptsBeforeGuestReboot: pulumi.Bool(false),
RunToolsScriptsBeforeGuestShutdown: pulumi.Bool(false),
RunToolsScriptsBeforeGuestStandby: pulumi.Bool(false),
SataControllerCount: pulumi.Int(0),
ScsiBusSharing: pulumi.String("string"),
ScsiControllerCount: pulumi.Int(0),
ScsiType: pulumi.String("string"),
ShutdownWaitTimeout: pulumi.Int(0),
StoragePolicyId: pulumi.String("string"),
SwapPlacementPolicy: pulumi.String("string"),
SyncTimeWithHost: pulumi.Bool(false),
SyncTimeWithHostPeriodically: pulumi.Bool(false),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
ToolsUpgradePolicy: pulumi.String("string"),
Vapp: &vsphere.VirtualMachineVappArgs{
Properties: pulumi.StringMap{
"string": pulumi.String("string"),
},
},
VbsEnabled: pulumi.Bool(false),
VvtdEnabled: pulumi.Bool(false),
WaitForGuestIpTimeout: pulumi.Int(0),
WaitForGuestNetRoutable: pulumi.Bool(false),
WaitForGuestNetTimeout: pulumi.Int(0),
})
var virtualMachineResource = new VirtualMachine("virtualMachineResource", VirtualMachineArgs.builder()
.resourcePoolId("string")
.alternateGuestName("string")
.annotation("string")
.bootDelay(0)
.bootRetryDelay(0)
.bootRetryEnabled(false)
.cdroms(VirtualMachineCdromArgs.builder()
.clientDevice(false)
.datastoreId("string")
.deviceAddress("string")
.key(0)
.path("string")
.build())
.clone(VirtualMachineCloneArgs.builder()
.templateUuid("string")
.customizationSpec(VirtualMachineCloneCustomizationSpecArgs.builder()
.id("string")
.timeout(0)
.build())
.customize(VirtualMachineCloneCustomizeArgs.builder()
.dnsServerLists("string")
.dnsSuffixLists("string")
.ipv4Gateway("string")
.ipv6Gateway("string")
.linuxOptions(VirtualMachineCloneCustomizeLinuxOptionsArgs.builder()
.domain("string")
.hostName("string")
.hwClockUtc(false)
.scriptText("string")
.timeZone("string")
.build())
.networkInterfaces(VirtualMachineCloneCustomizeNetworkInterfaceArgs.builder()
.dnsDomain("string")
.dnsServerLists("string")
.ipv4Address("string")
.ipv4Netmask(0)
.ipv6Address("string")
.ipv6Netmask(0)
.build())
.timeout(0)
.windowsOptions(VirtualMachineCloneCustomizeWindowsOptionsArgs.builder()
.computerName("string")
.fullName("string")
.autoLogonCount(0)
.autoLogon(false)
.domainAdminPassword("string")
.domainAdminUser("string")
.adminPassword("string")
.joinDomain("string")
.organizationName("string")
.productKey("string")
.runOnceCommandLists("string")
.timeZone(0)
.workgroup("string")
.build())
.windowsSysprepText("string")
.build())
.linkedClone(false)
.ovfNetworkMap(Map.of("string", "string"))
.ovfStorageMap(Map.of("string", "string"))
.timeout(0)
.build())
.cpuHotAddEnabled(false)
.cpuHotRemoveEnabled(false)
.cpuLimit(0)
.cpuPerformanceCountersEnabled(false)
.cpuReservation(0)
.cpuShareCount(0)
.cpuShareLevel("string")
.customAttributes(Map.of("string", "string"))
.datacenterId("string")
.datastoreClusterId("string")
.datastoreId("string")
.disks(VirtualMachineDiskArgs.builder()
.label("string")
.ioShareLevel("string")
.unitNumber(0)
.deviceAddress("string")
.diskMode("string")
.diskSharing("string")
.eagerlyScrub(false)
.ioLimit(0)
.keepOnRemove(false)
.writeThrough(false)
.datastoreId("string")
.ioReservation(0)
.key(0)
.controllerType("string")
.path("string")
.size(0)
.storagePolicyId("string")
.thinProvisioned(false)
.attach(false)
.uuid("string")
.ioShareCount(0)
.build())
.efiSecureBootEnabled(false)
.enableDiskUuid(false)
.enableLogging(false)
.eptRviMode("string")
.extraConfig(Map.of("string", "string"))
.extraConfigRebootRequired(false)
.firmware("string")
.folder("string")
.forcePowerOff(false)
.guestId("string")
.hardwareVersion(0)
.hostSystemId("string")
.hvMode("string")
.ideControllerCount(0)
.ignoredGuestIps("string")
.latencySensitivity("string")
.memory(0)
.memoryHotAddEnabled(false)
.memoryLimit(0)
.memoryReservation(0)
.memoryReservationLockedToMax(false)
.memoryShareCount(0)
.memoryShareLevel("string")
.migrateWaitTimeout(0)
.name("string")
.nestedHvEnabled(false)
.networkInterfaces(VirtualMachineNetworkInterfaceArgs.builder()
.networkId("string")
.adapterType("string")
.bandwidthLimit(0)
.bandwidthReservation(0)
.bandwidthShareCount(0)
.bandwidthShareLevel("string")
.deviceAddress("string")
.key(0)
.macAddress("string")
.ovfMapping("string")
.physicalFunction("string")
.useStaticMac(false)
.build())
.numCoresPerSocket(0)
.numCpus(0)
.ovfDeploy(VirtualMachineOvfDeployArgs.builder()
.allowUnverifiedSslCert(false)
.deploymentOption("string")
.diskProvisioning("string")
.enableHiddenProperties(false)
.ipAllocationPolicy("string")
.ipProtocol("string")
.localOvfPath("string")
.ovfNetworkMap(Map.of("string", "string"))
.remoteOvfUrl("string")
.build())
.pciDeviceIds("string")
.poweronTimeout(0)
.replaceTrigger("string")
.runToolsScriptsAfterPowerOn(false)
.runToolsScriptsAfterResume(false)
.runToolsScriptsBeforeGuestReboot(false)
.runToolsScriptsBeforeGuestShutdown(false)
.runToolsScriptsBeforeGuestStandby(false)
.sataControllerCount(0)
.scsiBusSharing("string")
.scsiControllerCount(0)
.scsiType("string")
.shutdownWaitTimeout(0)
.storagePolicyId("string")
.swapPlacementPolicy("string")
.syncTimeWithHost(false)
.syncTimeWithHostPeriodically(false)
.tags("string")
.toolsUpgradePolicy("string")
.vapp(VirtualMachineVappArgs.builder()
.properties(Map.of("string", "string"))
.build())
.vbsEnabled(false)
.vvtdEnabled(false)
.waitForGuestIpTimeout(0)
.waitForGuestNetRoutable(false)
.waitForGuestNetTimeout(0)
.build());
virtual_machine_resource = vsphere.VirtualMachine("virtualMachineResource",
resource_pool_id="string",
alternate_guest_name="string",
annotation="string",
boot_delay=0,
boot_retry_delay=0,
boot_retry_enabled=False,
cdroms=[vsphere.VirtualMachineCdromArgs(
client_device=False,
datastore_id="string",
device_address="string",
key=0,
path="string",
)],
clone=vsphere.VirtualMachineCloneArgs(
template_uuid="string",
customization_spec=vsphere.VirtualMachineCloneCustomizationSpecArgs(
id="string",
timeout=0,
),
customize=vsphere.VirtualMachineCloneCustomizeArgs(
dns_server_lists=["string"],
dns_suffix_lists=["string"],
ipv4_gateway="string",
ipv6_gateway="string",
linux_options=vsphere.VirtualMachineCloneCustomizeLinuxOptionsArgs(
domain="string",
host_name="string",
hw_clock_utc=False,
script_text="string",
time_zone="string",
),
network_interfaces=[vsphere.VirtualMachineCloneCustomizeNetworkInterfaceArgs(
dns_domain="string",
dns_server_lists=["string"],
ipv4_address="string",
ipv4_netmask=0,
ipv6_address="string",
ipv6_netmask=0,
)],
timeout=0,
windows_options=vsphere.VirtualMachineCloneCustomizeWindowsOptionsArgs(
computer_name="string",
full_name="string",
auto_logon_count=0,
auto_logon=False,
domain_admin_password="string",
domain_admin_user="string",
admin_password="string",
join_domain="string",
organization_name="string",
product_key="string",
run_once_command_lists=["string"],
time_zone=0,
workgroup="string",
),
windows_sysprep_text="string",
),
linked_clone=False,
ovf_network_map={
"string": "string",
},
ovf_storage_map={
"string": "string",
},
timeout=0,
),
cpu_hot_add_enabled=False,
cpu_hot_remove_enabled=False,
cpu_limit=0,
cpu_performance_counters_enabled=False,
cpu_reservation=0,
cpu_share_count=0,
cpu_share_level="string",
custom_attributes={
"string": "string",
},
datacenter_id="string",
datastore_cluster_id="string",
datastore_id="string",
disks=[vsphere.VirtualMachineDiskArgs(
label="string",
io_share_level="string",
unit_number=0,
device_address="string",
disk_mode="string",
disk_sharing="string",
eagerly_scrub=False,
io_limit=0,
keep_on_remove=False,
write_through=False,
datastore_id="string",
io_reservation=0,
key=0,
controller_type="string",
path="string",
size=0,
storage_policy_id="string",
thin_provisioned=False,
attach=False,
uuid="string",
io_share_count=0,
)],
efi_secure_boot_enabled=False,
enable_disk_uuid=False,
enable_logging=False,
ept_rvi_mode="string",
extra_config={
"string": "string",
},
extra_config_reboot_required=False,
firmware="string",
folder="string",
force_power_off=False,
guest_id="string",
hardware_version=0,
host_system_id="string",
hv_mode="string",
ide_controller_count=0,
ignored_guest_ips=["string"],
latency_sensitivity="string",
memory=0,
memory_hot_add_enabled=False,
memory_limit=0,
memory_reservation=0,
memory_reservation_locked_to_max=False,
memory_share_count=0,
memory_share_level="string",
migrate_wait_timeout=0,
name="string",
nested_hv_enabled=False,
network_interfaces=[vsphere.VirtualMachineNetworkInterfaceArgs(
network_id="string",
adapter_type="string",
bandwidth_limit=0,
bandwidth_reservation=0,
bandwidth_share_count=0,
bandwidth_share_level="string",
device_address="string",
key=0,
mac_address="string",
ovf_mapping="string",
physical_function="string",
use_static_mac=False,
)],
num_cores_per_socket=0,
num_cpus=0,
ovf_deploy=vsphere.VirtualMachineOvfDeployArgs(
allow_unverified_ssl_cert=False,
deployment_option="string",
disk_provisioning="string",
enable_hidden_properties=False,
ip_allocation_policy="string",
ip_protocol="string",
local_ovf_path="string",
ovf_network_map={
"string": "string",
},
remote_ovf_url="string",
),
pci_device_ids=["string"],
poweron_timeout=0,
replace_trigger="string",
run_tools_scripts_after_power_on=False,
run_tools_scripts_after_resume=False,
run_tools_scripts_before_guest_reboot=False,
run_tools_scripts_before_guest_shutdown=False,
run_tools_scripts_before_guest_standby=False,
sata_controller_count=0,
scsi_bus_sharing="string",
scsi_controller_count=0,
scsi_type="string",
shutdown_wait_timeout=0,
storage_policy_id="string",
swap_placement_policy="string",
sync_time_with_host=False,
sync_time_with_host_periodically=False,
tags=["string"],
tools_upgrade_policy="string",
vapp=vsphere.VirtualMachineVappArgs(
properties={
"string": "string",
},
),
vbs_enabled=False,
vvtd_enabled=False,
wait_for_guest_ip_timeout=0,
wait_for_guest_net_routable=False,
wait_for_guest_net_timeout=0)
const virtualMachineResource = new vsphere.VirtualMachine("virtualMachineResource", {
resourcePoolId: "string",
alternateGuestName: "string",
annotation: "string",
bootDelay: 0,
bootRetryDelay: 0,
bootRetryEnabled: false,
cdroms: [{
clientDevice: false,
datastoreId: "string",
deviceAddress: "string",
key: 0,
path: "string",
}],
clone: {
templateUuid: "string",
customizationSpec: {
id: "string",
timeout: 0,
},
customize: {
dnsServerLists: ["string"],
dnsSuffixLists: ["string"],
ipv4Gateway: "string",
ipv6Gateway: "string",
linuxOptions: {
domain: "string",
hostName: "string",
hwClockUtc: false,
scriptText: "string",
timeZone: "string",
},
networkInterfaces: [{
dnsDomain: "string",
dnsServerLists: ["string"],
ipv4Address: "string",
ipv4Netmask: 0,
ipv6Address: "string",
ipv6Netmask: 0,
}],
timeout: 0,
windowsOptions: {
computerName: "string",
fullName: "string",
autoLogonCount: 0,
autoLogon: false,
domainAdminPassword: "string",
domainAdminUser: "string",
adminPassword: "string",
joinDomain: "string",
organizationName: "string",
productKey: "string",
runOnceCommandLists: ["string"],
timeZone: 0,
workgroup: "string",
},
windowsSysprepText: "string",
},
linkedClone: false,
ovfNetworkMap: {
string: "string",
},
ovfStorageMap: {
string: "string",
},
timeout: 0,
},
cpuHotAddEnabled: false,
cpuHotRemoveEnabled: false,
cpuLimit: 0,
cpuPerformanceCountersEnabled: false,
cpuReservation: 0,
cpuShareCount: 0,
cpuShareLevel: "string",
customAttributes: {
string: "string",
},
datacenterId: "string",
datastoreClusterId: "string",
datastoreId: "string",
disks: [{
label: "string",
ioShareLevel: "string",
unitNumber: 0,
deviceAddress: "string",
diskMode: "string",
diskSharing: "string",
eagerlyScrub: false,
ioLimit: 0,
keepOnRemove: false,
writeThrough: false,
datastoreId: "string",
ioReservation: 0,
key: 0,
controllerType: "string",
path: "string",
size: 0,
storagePolicyId: "string",
thinProvisioned: false,
attach: false,
uuid: "string",
ioShareCount: 0,
}],
efiSecureBootEnabled: false,
enableDiskUuid: false,
enableLogging: false,
eptRviMode: "string",
extraConfig: {
string: "string",
},
extraConfigRebootRequired: false,
firmware: "string",
folder: "string",
forcePowerOff: false,
guestId: "string",
hardwareVersion: 0,
hostSystemId: "string",
hvMode: "string",
ideControllerCount: 0,
ignoredGuestIps: ["string"],
latencySensitivity: "string",
memory: 0,
memoryHotAddEnabled: false,
memoryLimit: 0,
memoryReservation: 0,
memoryReservationLockedToMax: false,
memoryShareCount: 0,
memoryShareLevel: "string",
migrateWaitTimeout: 0,
name: "string",
nestedHvEnabled: false,
networkInterfaces: [{
networkId: "string",
adapterType: "string",
bandwidthLimit: 0,
bandwidthReservation: 0,
bandwidthShareCount: 0,
bandwidthShareLevel: "string",
deviceAddress: "string",
key: 0,
macAddress: "string",
ovfMapping: "string",
physicalFunction: "string",
useStaticMac: false,
}],
numCoresPerSocket: 0,
numCpus: 0,
ovfDeploy: {
allowUnverifiedSslCert: false,
deploymentOption: "string",
diskProvisioning: "string",
enableHiddenProperties: false,
ipAllocationPolicy: "string",
ipProtocol: "string",
localOvfPath: "string",
ovfNetworkMap: {
string: "string",
},
remoteOvfUrl: "string",
},
pciDeviceIds: ["string"],
poweronTimeout: 0,
replaceTrigger: "string",
runToolsScriptsAfterPowerOn: false,
runToolsScriptsAfterResume: false,
runToolsScriptsBeforeGuestReboot: false,
runToolsScriptsBeforeGuestShutdown: false,
runToolsScriptsBeforeGuestStandby: false,
sataControllerCount: 0,
scsiBusSharing: "string",
scsiControllerCount: 0,
scsiType: "string",
shutdownWaitTimeout: 0,
storagePolicyId: "string",
swapPlacementPolicy: "string",
syncTimeWithHost: false,
syncTimeWithHostPeriodically: false,
tags: ["string"],
toolsUpgradePolicy: "string",
vapp: {
properties: {
string: "string",
},
},
vbsEnabled: false,
vvtdEnabled: false,
waitForGuestIpTimeout: 0,
waitForGuestNetRoutable: false,
waitForGuestNetTimeout: 0,
});
type: vsphere:VirtualMachine
properties:
alternateGuestName: string
annotation: string
bootDelay: 0
bootRetryDelay: 0
bootRetryEnabled: false
cdroms:
- clientDevice: false
datastoreId: string
deviceAddress: string
key: 0
path: string
clone:
customizationSpec:
id: string
timeout: 0
customize:
dnsServerLists:
- string
dnsSuffixLists:
- string
ipv4Gateway: string
ipv6Gateway: string
linuxOptions:
domain: string
hostName: string
hwClockUtc: false
scriptText: string
timeZone: string
networkInterfaces:
- dnsDomain: string
dnsServerLists:
- string
ipv4Address: string
ipv4Netmask: 0
ipv6Address: string
ipv6Netmask: 0
timeout: 0
windowsOptions:
adminPassword: string
autoLogon: false
autoLogonCount: 0
computerName: string
domainAdminPassword: string
domainAdminUser: string
fullName: string
joinDomain: string
organizationName: string
productKey: string
runOnceCommandLists:
- string
timeZone: 0
workgroup: string
windowsSysprepText: string
linkedClone: false
ovfNetworkMap:
string: string
ovfStorageMap:
string: string
templateUuid: string
timeout: 0
cpuHotAddEnabled: false
cpuHotRemoveEnabled: false
cpuLimit: 0
cpuPerformanceCountersEnabled: false
cpuReservation: 0
cpuShareCount: 0
cpuShareLevel: string
customAttributes:
string: string
datacenterId: string
datastoreClusterId: string
datastoreId: string
disks:
- attach: false
controllerType: string
datastoreId: string
deviceAddress: string
diskMode: string
diskSharing: string
eagerlyScrub: false
ioLimit: 0
ioReservation: 0
ioShareCount: 0
ioShareLevel: string
keepOnRemove: false
key: 0
label: string
path: string
size: 0
storagePolicyId: string
thinProvisioned: false
unitNumber: 0
uuid: string
writeThrough: false
efiSecureBootEnabled: false
enableDiskUuid: false
enableLogging: false
eptRviMode: string
extraConfig:
string: string
extraConfigRebootRequired: false
firmware: string
folder: string
forcePowerOff: false
guestId: string
hardwareVersion: 0
hostSystemId: string
hvMode: string
ideControllerCount: 0
ignoredGuestIps:
- string
latencySensitivity: string
memory: 0
memoryHotAddEnabled: false
memoryLimit: 0
memoryReservation: 0
memoryReservationLockedToMax: false
memoryShareCount: 0
memoryShareLevel: string
migrateWaitTimeout: 0
name: string
nestedHvEnabled: false
networkInterfaces:
- adapterType: string
bandwidthLimit: 0
bandwidthReservation: 0
bandwidthShareCount: 0
bandwidthShareLevel: string
deviceAddress: string
key: 0
macAddress: string
networkId: string
ovfMapping: string
physicalFunction: string
useStaticMac: false
numCoresPerSocket: 0
numCpus: 0
ovfDeploy:
allowUnverifiedSslCert: false
deploymentOption: string
diskProvisioning: string
enableHiddenProperties: false
ipAllocationPolicy: string
ipProtocol: string
localOvfPath: string
ovfNetworkMap:
string: string
remoteOvfUrl: string
pciDeviceIds:
- string
poweronTimeout: 0
replaceTrigger: string
resourcePoolId: string
runToolsScriptsAfterPowerOn: false
runToolsScriptsAfterResume: false
runToolsScriptsBeforeGuestReboot: false
runToolsScriptsBeforeGuestShutdown: false
runToolsScriptsBeforeGuestStandby: false
sataControllerCount: 0
scsiBusSharing: string
scsiControllerCount: 0
scsiType: string
shutdownWaitTimeout: 0
storagePolicyId: string
swapPlacementPolicy: string
syncTimeWithHost: false
syncTimeWithHostPeriodically: false
tags:
- string
toolsUpgradePolicy: string
vapp:
properties:
string: string
vbsEnabled: false
vvtdEnabled: false
waitForGuestIpTimeout: 0
waitForGuestNetRoutable: false
waitForGuestNetTimeout: 0
VirtualMachine Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The VirtualMachine resource accepts the following input properties:
- Resource
Pool stringId The managed object reference ID of the resource pool in which to place the virtual machine. See the Virtual Machine Migration section for more information on modifying this value.
NOTE: All clusters and standalone hosts have a default root resource pool. This resource argument does not directly accept the cluster or standalone host resource. For more information, see the section on specifying the Root Resource Pool in the
vsphere.ResourcePool
data source documentation on using the root resource pool.- Alternate
Guest stringName - The guest name for the operating system when
guest_id
isotherGuest
orotherGuest64
. - Annotation string
- A user-provided description of the virtual machine.
- Boot
Delay int - The number of milliseconds to wait before starting the boot sequence. The default is no delay.
- Boot
Retry intDelay - The number of milliseconds to wait before retrying the boot sequence. This option is only valid if
boot_retry_enabled
istrue
. Default:10000
(10 seconds). - Boot
Retry boolEnabled - If set to
true
, a virtual machine that fails to boot will try again after the delay defined inboot_retry_delay
. Default:false
. - Cdroms
List<Pulumi.
VSphere. Inputs. Virtual Machine Cdrom> - A specification for a CD-ROM device on the virtual machine. See CD-ROM options for more information.
- Clone
Pulumi.
VSphere. Inputs. Virtual Machine Clone - When specified, the virtual machine will be created as a clone of a specified template. Optional customization options can be submitted for the resource. See creating a virtual machine from a template for more information.
- Cpu
Hot boolAdd Enabled - Allow CPUs to be added to the virtual machine while it is powered on.
- Cpu
Hot boolRemove Enabled - Allow CPUs to be removed to the virtual machine while it is powered on.
- Cpu
Limit int - The maximum amount of CPU (in MHz) that the virtual machine can consume, regardless of available resources. The default is no limit.
- Cpu
Performance boolCounters Enabled - Enable CPU performance counters on the virtual machine. Default:
false
. - Cpu
Reservation int - The amount of CPU (in MHz) that the virtual machine is guaranteed. The default is no reservation.
- int
- The number of CPU shares allocated to the virtual machine when the
cpu_share_level
iscustom
. - string
- The allocation level for the virtual machine CPU resources. One of
high
,low
,normal
, orcustom
. Default:custom
. - Custom
Attributes Dictionary<string, string> Map of custom attribute ids to attribute value strings to set for virtual machine. Please refer to the
vsphere_custom_attributes
resource for more information on setting custom attributes.NOTE: Custom attributes requires vCenter Server and is not supported on direct ESXi host connections.
- Datacenter
Id string - The datacenter ID. Required only when deploying an OVF/OVA template.
- Datastore
Cluster stringId The managed object reference ID of the datastore cluster in which to place the virtual machine. This setting applies to entire virtual machine and implies that you wish to use vSphere Storage DRS with the virtual machine. See the section on virtual machine migration for more information on modifying this value.
NOTE: One of
datastore_id
ordatastore_cluster_id
must be specified.NOTE: Use of
datastore_cluster_id
requires vSphere Storage DRS to be enabled on the specified datastore cluster.NOTE: The
datastore_cluster_id
setting applies to the entire virtual machine resource. You cannot assign individual individual disks to datastore clusters. In addition, you cannot use theattach
setting to attach external disks on virtual machines that are assigned to datastore clusters.- Datastore
Id string - The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with
client_device
. - Disks
List<Pulumi.
VSphere. Inputs. Virtual Machine Disk> - A specification for a virtual disk device on the virtual machine. See disk options for more information.
- Efi
Secure boolBoot Enabled Use this option to enable EFI secure boot when the
firmware
type is set to isefi
. Default:false
.NOTE: EFI secure boot is only available on vSphere 6.5 and later.
- Enable
Disk boolUuid - Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest. Default:
false
. - Enable
Logging bool - Enable logging of virtual machine events to a log file stored in the virtual machine directory. Default:
false
. - Ept
Rvi stringMode - The EPT/RVI (hardware memory virtualization) setting for the virtual machine. One of
automatic
,on
, oroff
. Default:automatic
. - Extra
Config Dictionary<string, string> Extra configuration data for the virtual machine. Can be used to supply advanced parameters not normally in configuration, such as instance metadata and userdata.
NOTE: Do not use
extra_config
when working with a template imported from OVF/OVA as your settings may be ignored. Use thevapp
blockproperties
section as described in Using vApp Properties for OVF/OVA Configuration.- Extra
Config boolReboot Required - Allow the virtual machine to be rebooted when a change to
extra_config
occurs. Default:true
. - Firmware string
- The firmware for the virtual machine. One of
bios
orefi
. - Folder string
- The path to the virtual machine folder in which to place the virtual machine, relative to the datacenter path (
/<datacenter-name>/vm
). For example,/dc-01/vm/foo
- Force
Power boolOff - If a guest shutdown failed or times out while updating or destroying (see
shutdown_wait_timeout
), force the power-off of the virtual machine. Default:true
. - Guest
Id string - The guest ID for the operating system type. For a full list of possible values, see here. Default:
otherGuest64
. - Hardware
Version int - The hardware version number. Valid range is from 4 to 21. The hardware version cannot be downgraded. See virtual machine hardware versions and compatibility for more information on supported settings.
- Host
System stringId - The managed object reference ID of a host on which to place the virtual machine. See the section on virtual machine migration for more information on modifying this value. When using a vSphere cluster, if a
host_system_id
is not supplied, vSphere will select a host in the cluster to place the virtual machine, according to any defaults or vSphere DRS placement policies. - Hv
Mode string - The hardware virtualization (non-nested) setting for the virtual machine. One of
hvAuto
,hvOn
, orhvOff
. Default:hvAuto
. - Ide
Controller intCount - The number of IDE controllers that the virtual machine. This directly affects the number of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers. Default:
2
. - Ignored
Guest List<string>Ips - List of IP addresses and CIDR networks to ignore while waiting for an available IP address using either of the waiters. Any IP addresses in this list will be ignored so that the waiter will continue to wait for a valid IP address. Default:
[]
. - Latency
Sensitivity string Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard devices. One of
low
,normal
,medium
, orhigh
.NOTE: On higher sensitivities, you may need to adjust the
memory_reservation
to the full amount of memory provisioned for the virtual machine.- Memory int
- The memory size to assign to the virtual machine, in MB. Default:
1024
(1 GB). - Memory
Hot boolAdd Enabled Allow memory to be added to the virtual machine while it is powered on.
NOTE: CPU and memory hot add options are not available on all guest operating systems. Please refer to the VMware Guest OS Compatibility Guide to which settings are allow for your guest operating system. In addition, at least one
pulumi up
must be run before you are able to use CPU and memory hot add.NOTE: For Linux 64-bit guest operating systems with less than or equal to 3GB, the virtual machine must powered off to add memory beyond 3GB. Subsequent hot add of memory does not require the virtual machine to be powered-off to apply the plan. Please refer to VMware KB 2008405.
- Memory
Limit int - The maximum amount of memory (in MB) that th virtual machine can consume, regardless of available resources. The default is no limit.
- Memory
Reservation int - The amount of memory (in MB) that the virtual machine is guaranteed. The default is no reservation.
- Memory
Reservation boolLocked To Max - If set true, memory resource reservation for this virtual machine will always be equal to the virtual machine's memory size;increases in memory size will be rejected when a corresponding reservation increase is not possible. This feature may only be enabled if it is currently possible to reserve all of the virtual machine's memory.
- int
- The number of memory shares allocated to the virtual machine when the
memory_share_level
iscustom
. - string
- The allocation level for the virtual machine memory resources. One of
high
,low
,normal
, orcustom
. Default:custom
. - Migrate
Wait intTimeout - The amount of time, in minutes, to wait for a virtual machine migration to complete before failing. Default:
10
minutes. See the section on virtual machine migration for more information. - Name string
- The name of the virtual machine.
- Nested
Hv boolEnabled - Enable nested hardware virtualization on the virtual machine, facilitating nested virtualization in the guest operating system. Default:
false
. - Network
Interfaces List<Pulumi.VSphere. Inputs. Virtual Machine Network Interface> - A specification for a virtual NIC on the virtual machine. See network interface options for more information.
- Num
Cores intPer Socket - The number of cores per socket in the virtual machine. The number of vCPUs on the virtual machine will be
num_cpus
divided bynum_cores_per_socket
. If specified, the value supplied tonum_cpus
must be evenly divisible by this value. Default:1
. - Num
Cpus int - The total number of virtual processor cores to assign to the virtual machine. Default:
1
. - Ovf
Deploy Pulumi.VSphere. Inputs. Virtual Machine Ovf Deploy - When specified, the virtual machine will be deployed from the provided OVF/OVA template. See creating a virtual machine from an OVF/OVA template for more information.
- Pci
Device List<string>Ids List of host PCI device IDs in which to create PCI passthroughs.
NOTE: Cloning requires vCenter Server and is not supported on direct ESXi host connections.
- Poweron
Timeout int - The amount of time, in seconds, that we will be trying to power on a VM
- Replace
Trigger string Triggers replacement of resource whenever it changes.
For example,
replace_trigger = sha256(format("%!s(MISSING)-%!s(MISSING)",data.template_file.cloud_init_metadata.rendered,data.template_file.cloud_init_userdata.rendered))
will fingerprint the changes in cloud-init metadata and userdata templates. This will enable a replacement of the resource whenever the dependant template renders a new configuration. (Forces a replacement.)- Run
Tools boolScripts After Power On - Enable post-power-on scripts to run when VMware Tools is installed. Default:
true
. - Run
Tools boolScripts After Resume - Enable ost-resume scripts to run when VMware Tools is installed. Default:
true
. - Run
Tools boolScripts Before Guest Reboot - Enable pre-reboot scripts to run when VMware Tools is installed. Default:
false
. - Run
Tools boolScripts Before Guest Shutdown - Enable pre-shutdown scripts to run when VMware Tools is installed. Default:
true
. - Run
Tools boolScripts Before Guest Standby - Enable pre-standby scripts to run when VMware Tools is installed. Default:
true
. - Sata
Controller intCount - The number of SATA controllers that Terraform manages on this virtual machine. This directly affects the amount of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers.
- Scsi
Bus stringSharing - The type of SCSI bus sharing for the virtual machine SCSI controller. One of
physicalSharing
,virtualSharing
, andnoSharing
. Default:noSharing
. - Scsi
Controller intCount - The number of SCSI controllers that Terraform manages on this virtual machine. This directly affects the amount of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers.
- Scsi
Type string - The SCSI controller type for the virtual machine. One of
lsilogic
(LSI Logic Parallel),lsilogic-sas
(LSI Logic SAS) orpvscsi
(VMware Paravirtual). Default:pvscsi
. - Shutdown
Wait intTimeout - The amount of time, in minutes, to wait for a graceful guest shutdown when making necessary updates to the virtual machine. If
force_power_off
is set totrue
, the virtual machine will be forced to power-off after the timeout, otherwise an error is returned. Default:3
minutes. - Storage
Policy stringId - The UUID of the storage policy to assign to the virtual disk.
- Swap
Placement stringPolicy - The swap file placement policy for the virtual machine. One of
inherit
,hostLocal
, orvmDirectory
. Default:inherit
. - Sync
Time boolWith Host - Enable the guest operating system to synchronization its clock with the host when the virtual machine is powered on or resumed. Requires vSphere 7.0 Update 1 and later. Requires VMware Tools to be installed. Default:
true
. - Sync
Time boolWith Host Periodically - Enable the guest operating system to periodically synchronize its clock with the host. Requires vSphere 7.0 Update 1 and later. On previous versions, setting
sync_time_with_host
is will enable periodic synchronization. Requires VMware Tools to be installed. Default:false
. - List<string>
The IDs of any tags to attach to this resource. Please refer to the
vsphere.Tag
resource for more information on applying tags to virtual machine resources.NOTE: Tagging support is unsupported on direct ESXi host connections and requires vCenter Server instance.
- Tools
Upgrade stringPolicy - Enable automatic upgrade of the VMware Tools version when the virtual machine is rebooted. If necessary, VMware Tools is upgraded to the latest version supported by the host on which the virtual machine is running. Requires VMware Tools to be installed. One of
manual
orupgradeAtPowerCycle
. Default:manual
. - Vapp
Pulumi.
VSphere. Inputs. Virtual Machine Vapp - Used for vApp configurations. The only sub-key available is
properties
, which is a key/value map of properties for virtual machines imported from and OVF/OVA. See Using vApp Properties for OVF/OVA Configuration for more information. - Vbs
Enabled bool - Enable Virtualization Based Security. Requires
firmware
to beefi
. In addition,vvtd_enabled
,nested_hv_enabled
, andefi_secure_boot_enabled
must all have a value oftrue
. Supported on vSphere 6.7 and later. Default:false
. - Vvtd
Enabled bool - Enable Intel Virtualization Technology for Directed I/O for the virtual machine (I/O MMU in the vSphere Client). Supported on vSphere 6.7 and later. Default:
false
. - Wait
For intGuest Ip Timeout - The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. This should only be used if the version VMware Tools does not allow the
wait_for_guest_net_timeout
waiter to be used. A value less than1
disables the waiter. Default:0
. - Wait
For boolGuest Net Routable - Controls whether or not the guest network waiter waits for a routable address. When
false
, the waiter does not wait for a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria. This property is ignored if thewait_for_guest_ip_timeout
waiter is used. Default:true
. - Wait
For intGuest Net Timeout - The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. Older versions of VMware Tools do not populate this property. In those cases, this waiter can be disabled and the
wait_for_guest_ip_timeout
waiter can be used instead. A value less than1
disables the waiter. Default:5
minutes.
- Resource
Pool stringId The managed object reference ID of the resource pool in which to place the virtual machine. See the Virtual Machine Migration section for more information on modifying this value.
NOTE: All clusters and standalone hosts have a default root resource pool. This resource argument does not directly accept the cluster or standalone host resource. For more information, see the section on specifying the Root Resource Pool in the
vsphere.ResourcePool
data source documentation on using the root resource pool.- Alternate
Guest stringName - The guest name for the operating system when
guest_id
isotherGuest
orotherGuest64
. - Annotation string
- A user-provided description of the virtual machine.
- Boot
Delay int - The number of milliseconds to wait before starting the boot sequence. The default is no delay.
- Boot
Retry intDelay - The number of milliseconds to wait before retrying the boot sequence. This option is only valid if
boot_retry_enabled
istrue
. Default:10000
(10 seconds). - Boot
Retry boolEnabled - If set to
true
, a virtual machine that fails to boot will try again after the delay defined inboot_retry_delay
. Default:false
. - Cdroms
[]Virtual
Machine Cdrom Args - A specification for a CD-ROM device on the virtual machine. See CD-ROM options for more information.
- Clone
Virtual
Machine Clone Args - When specified, the virtual machine will be created as a clone of a specified template. Optional customization options can be submitted for the resource. See creating a virtual machine from a template for more information.
- Cpu
Hot boolAdd Enabled - Allow CPUs to be added to the virtual machine while it is powered on.
- Cpu
Hot boolRemove Enabled - Allow CPUs to be removed to the virtual machine while it is powered on.
- Cpu
Limit int - The maximum amount of CPU (in MHz) that the virtual machine can consume, regardless of available resources. The default is no limit.
- Cpu
Performance boolCounters Enabled - Enable CPU performance counters on the virtual machine. Default:
false
. - Cpu
Reservation int - The amount of CPU (in MHz) that the virtual machine is guaranteed. The default is no reservation.
- int
- The number of CPU shares allocated to the virtual machine when the
cpu_share_level
iscustom
. - string
- The allocation level for the virtual machine CPU resources. One of
high
,low
,normal
, orcustom
. Default:custom
. - Custom
Attributes map[string]string Map of custom attribute ids to attribute value strings to set for virtual machine. Please refer to the
vsphere_custom_attributes
resource for more information on setting custom attributes.NOTE: Custom attributes requires vCenter Server and is not supported on direct ESXi host connections.
- Datacenter
Id string - The datacenter ID. Required only when deploying an OVF/OVA template.
- Datastore
Cluster stringId The managed object reference ID of the datastore cluster in which to place the virtual machine. This setting applies to entire virtual machine and implies that you wish to use vSphere Storage DRS with the virtual machine. See the section on virtual machine migration for more information on modifying this value.
NOTE: One of
datastore_id
ordatastore_cluster_id
must be specified.NOTE: Use of
datastore_cluster_id
requires vSphere Storage DRS to be enabled on the specified datastore cluster.NOTE: The
datastore_cluster_id
setting applies to the entire virtual machine resource. You cannot assign individual individual disks to datastore clusters. In addition, you cannot use theattach
setting to attach external disks on virtual machines that are assigned to datastore clusters.- Datastore
Id string - The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with
client_device
. - Disks
[]Virtual
Machine Disk Args - A specification for a virtual disk device on the virtual machine. See disk options for more information.
- Efi
Secure boolBoot Enabled Use this option to enable EFI secure boot when the
firmware
type is set to isefi
. Default:false
.NOTE: EFI secure boot is only available on vSphere 6.5 and later.
- Enable
Disk boolUuid - Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest. Default:
false
. - Enable
Logging bool - Enable logging of virtual machine events to a log file stored in the virtual machine directory. Default:
false
. - Ept
Rvi stringMode - The EPT/RVI (hardware memory virtualization) setting for the virtual machine. One of
automatic
,on
, oroff
. Default:automatic
. - Extra
Config map[string]string Extra configuration data for the virtual machine. Can be used to supply advanced parameters not normally in configuration, such as instance metadata and userdata.
NOTE: Do not use
extra_config
when working with a template imported from OVF/OVA as your settings may be ignored. Use thevapp
blockproperties
section as described in Using vApp Properties for OVF/OVA Configuration.- Extra
Config boolReboot Required - Allow the virtual machine to be rebooted when a change to
extra_config
occurs. Default:true
. - Firmware string
- The firmware for the virtual machine. One of
bios
orefi
. - Folder string
- The path to the virtual machine folder in which to place the virtual machine, relative to the datacenter path (
/<datacenter-name>/vm
). For example,/dc-01/vm/foo
- Force
Power boolOff - If a guest shutdown failed or times out while updating or destroying (see
shutdown_wait_timeout
), force the power-off of the virtual machine. Default:true
. - Guest
Id string - The guest ID for the operating system type. For a full list of possible values, see here. Default:
otherGuest64
. - Hardware
Version int - The hardware version number. Valid range is from 4 to 21. The hardware version cannot be downgraded. See virtual machine hardware versions and compatibility for more information on supported settings.
- Host
System stringId - The managed object reference ID of a host on which to place the virtual machine. See the section on virtual machine migration for more information on modifying this value. When using a vSphere cluster, if a
host_system_id
is not supplied, vSphere will select a host in the cluster to place the virtual machine, according to any defaults or vSphere DRS placement policies. - Hv
Mode string - The hardware virtualization (non-nested) setting for the virtual machine. One of
hvAuto
,hvOn
, orhvOff
. Default:hvAuto
. - Ide
Controller intCount - The number of IDE controllers that the virtual machine. This directly affects the number of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers. Default:
2
. - Ignored
Guest []stringIps - List of IP addresses and CIDR networks to ignore while waiting for an available IP address using either of the waiters. Any IP addresses in this list will be ignored so that the waiter will continue to wait for a valid IP address. Default:
[]
. - Latency
Sensitivity string Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard devices. One of
low
,normal
,medium
, orhigh
.NOTE: On higher sensitivities, you may need to adjust the
memory_reservation
to the full amount of memory provisioned for the virtual machine.- Memory int
- The memory size to assign to the virtual machine, in MB. Default:
1024
(1 GB). - Memory
Hot boolAdd Enabled Allow memory to be added to the virtual machine while it is powered on.
NOTE: CPU and memory hot add options are not available on all guest operating systems. Please refer to the VMware Guest OS Compatibility Guide to which settings are allow for your guest operating system. In addition, at least one
pulumi up
must be run before you are able to use CPU and memory hot add.NOTE: For Linux 64-bit guest operating systems with less than or equal to 3GB, the virtual machine must powered off to add memory beyond 3GB. Subsequent hot add of memory does not require the virtual machine to be powered-off to apply the plan. Please refer to VMware KB 2008405.
- Memory
Limit int - The maximum amount of memory (in MB) that th virtual machine can consume, regardless of available resources. The default is no limit.
- Memory
Reservation int - The amount of memory (in MB) that the virtual machine is guaranteed. The default is no reservation.
- Memory
Reservation boolLocked To Max - If set true, memory resource reservation for this virtual machine will always be equal to the virtual machine's memory size;increases in memory size will be rejected when a corresponding reservation increase is not possible. This feature may only be enabled if it is currently possible to reserve all of the virtual machine's memory.
- int
- The number of memory shares allocated to the virtual machine when the
memory_share_level
iscustom
. - string
- The allocation level for the virtual machine memory resources. One of
high
,low
,normal
, orcustom
. Default:custom
. - Migrate
Wait intTimeout - The amount of time, in minutes, to wait for a virtual machine migration to complete before failing. Default:
10
minutes. See the section on virtual machine migration for more information. - Name string
- The name of the virtual machine.
- Nested
Hv boolEnabled - Enable nested hardware virtualization on the virtual machine, facilitating nested virtualization in the guest operating system. Default:
false
. - Network
Interfaces []VirtualMachine Network Interface Args - A specification for a virtual NIC on the virtual machine. See network interface options for more information.
- Num
Cores intPer Socket - The number of cores per socket in the virtual machine. The number of vCPUs on the virtual machine will be
num_cpus
divided bynum_cores_per_socket
. If specified, the value supplied tonum_cpus
must be evenly divisible by this value. Default:1
. - Num
Cpus int - The total number of virtual processor cores to assign to the virtual machine. Default:
1
. - Ovf
Deploy VirtualMachine Ovf Deploy Args - When specified, the virtual machine will be deployed from the provided OVF/OVA template. See creating a virtual machine from an OVF/OVA template for more information.
- Pci
Device []stringIds List of host PCI device IDs in which to create PCI passthroughs.
NOTE: Cloning requires vCenter Server and is not supported on direct ESXi host connections.
- Poweron
Timeout int - The amount of time, in seconds, that we will be trying to power on a VM
- Replace
Trigger string Triggers replacement of resource whenever it changes.
For example,
replace_trigger = sha256(format("%!s(MISSING)-%!s(MISSING)",data.template_file.cloud_init_metadata.rendered,data.template_file.cloud_init_userdata.rendered))
will fingerprint the changes in cloud-init metadata and userdata templates. This will enable a replacement of the resource whenever the dependant template renders a new configuration. (Forces a replacement.)- Run
Tools boolScripts After Power On - Enable post-power-on scripts to run when VMware Tools is installed. Default:
true
. - Run
Tools boolScripts After Resume - Enable ost-resume scripts to run when VMware Tools is installed. Default:
true
. - Run
Tools boolScripts Before Guest Reboot - Enable pre-reboot scripts to run when VMware Tools is installed. Default:
false
. - Run
Tools boolScripts Before Guest Shutdown - Enable pre-shutdown scripts to run when VMware Tools is installed. Default:
true
. - Run
Tools boolScripts Before Guest Standby - Enable pre-standby scripts to run when VMware Tools is installed. Default:
true
. - Sata
Controller intCount - The number of SATA controllers that Terraform manages on this virtual machine. This directly affects the amount of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers.
- Scsi
Bus stringSharing - The type of SCSI bus sharing for the virtual machine SCSI controller. One of
physicalSharing
,virtualSharing
, andnoSharing
. Default:noSharing
. - Scsi
Controller intCount - The number of SCSI controllers that Terraform manages on this virtual machine. This directly affects the amount of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers.
- Scsi
Type string - The SCSI controller type for the virtual machine. One of
lsilogic
(LSI Logic Parallel),lsilogic-sas
(LSI Logic SAS) orpvscsi
(VMware Paravirtual). Default:pvscsi
. - Shutdown
Wait intTimeout - The amount of time, in minutes, to wait for a graceful guest shutdown when making necessary updates to the virtual machine. If
force_power_off
is set totrue
, the virtual machine will be forced to power-off after the timeout, otherwise an error is returned. Default:3
minutes. - Storage
Policy stringId - The UUID of the storage policy to assign to the virtual disk.
- Swap
Placement stringPolicy - The swap file placement policy for the virtual machine. One of
inherit
,hostLocal
, orvmDirectory
. Default:inherit
. - Sync
Time boolWith Host - Enable the guest operating system to synchronization its clock with the host when the virtual machine is powered on or resumed. Requires vSphere 7.0 Update 1 and later. Requires VMware Tools to be installed. Default:
true
. - Sync
Time boolWith Host Periodically - Enable the guest operating system to periodically synchronize its clock with the host. Requires vSphere 7.0 Update 1 and later. On previous versions, setting
sync_time_with_host
is will enable periodic synchronization. Requires VMware Tools to be installed. Default:false
. - []string
The IDs of any tags to attach to this resource. Please refer to the
vsphere.Tag
resource for more information on applying tags to virtual machine resources.NOTE: Tagging support is unsupported on direct ESXi host connections and requires vCenter Server instance.
- Tools
Upgrade stringPolicy - Enable automatic upgrade of the VMware Tools version when the virtual machine is rebooted. If necessary, VMware Tools is upgraded to the latest version supported by the host on which the virtual machine is running. Requires VMware Tools to be installed. One of
manual
orupgradeAtPowerCycle
. Default:manual
. - Vapp
Virtual
Machine Vapp Args - Used for vApp configurations. The only sub-key available is
properties
, which is a key/value map of properties for virtual machines imported from and OVF/OVA. See Using vApp Properties for OVF/OVA Configuration for more information. - Vbs
Enabled bool - Enable Virtualization Based Security. Requires
firmware
to beefi
. In addition,vvtd_enabled
,nested_hv_enabled
, andefi_secure_boot_enabled
must all have a value oftrue
. Supported on vSphere 6.7 and later. Default:false
. - Vvtd
Enabled bool - Enable Intel Virtualization Technology for Directed I/O for the virtual machine (I/O MMU in the vSphere Client). Supported on vSphere 6.7 and later. Default:
false
. - Wait
For intGuest Ip Timeout - The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. This should only be used if the version VMware Tools does not allow the
wait_for_guest_net_timeout
waiter to be used. A value less than1
disables the waiter. Default:0
. - Wait
For boolGuest Net Routable - Controls whether or not the guest network waiter waits for a routable address. When
false
, the waiter does not wait for a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria. This property is ignored if thewait_for_guest_ip_timeout
waiter is used. Default:true
. - Wait
For intGuest Net Timeout - The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. Older versions of VMware Tools do not populate this property. In those cases, this waiter can be disabled and the
wait_for_guest_ip_timeout
waiter can be used instead. A value less than1
disables the waiter. Default:5
minutes.
- resource
Pool StringId The managed object reference ID of the resource pool in which to place the virtual machine. See the Virtual Machine Migration section for more information on modifying this value.
NOTE: All clusters and standalone hosts have a default root resource pool. This resource argument does not directly accept the cluster or standalone host resource. For more information, see the section on specifying the Root Resource Pool in the
vsphere.ResourcePool
data source documentation on using the root resource pool.- alternate
Guest StringName - The guest name for the operating system when
guest_id
isotherGuest
orotherGuest64
. - annotation String
- A user-provided description of the virtual machine.
- boot
Delay Integer - The number of milliseconds to wait before starting the boot sequence. The default is no delay.
- boot
Retry IntegerDelay - The number of milliseconds to wait before retrying the boot sequence. This option is only valid if
boot_retry_enabled
istrue
. Default:10000
(10 seconds). - boot
Retry BooleanEnabled - If set to
true
, a virtual machine that fails to boot will try again after the delay defined inboot_retry_delay
. Default:false
. - cdroms
List<Virtual
Machine Cdrom> - A specification for a CD-ROM device on the virtual machine. See CD-ROM options for more information.
- clone_
Virtual
Machine Clone - When specified, the virtual machine will be created as a clone of a specified template. Optional customization options can be submitted for the resource. See creating a virtual machine from a template for more information.
- cpu
Hot BooleanAdd Enabled - Allow CPUs to be added to the virtual machine while it is powered on.
- cpu
Hot BooleanRemove Enabled - Allow CPUs to be removed to the virtual machine while it is powered on.
- cpu
Limit Integer - The maximum amount of CPU (in MHz) that the virtual machine can consume, regardless of available resources. The default is no limit.
- cpu
Performance BooleanCounters Enabled - Enable CPU performance counters on the virtual machine. Default:
false
. - cpu
Reservation Integer - The amount of CPU (in MHz) that the virtual machine is guaranteed. The default is no reservation.
- Integer
- The number of CPU shares allocated to the virtual machine when the
cpu_share_level
iscustom
. - String
- The allocation level for the virtual machine CPU resources. One of
high
,low
,normal
, orcustom
. Default:custom
. - custom
Attributes Map<String,String> Map of custom attribute ids to attribute value strings to set for virtual machine. Please refer to the
vsphere_custom_attributes
resource for more information on setting custom attributes.NOTE: Custom attributes requires vCenter Server and is not supported on direct ESXi host connections.
- datacenter
Id String - The datacenter ID. Required only when deploying an OVF/OVA template.
- datastore
Cluster StringId The managed object reference ID of the datastore cluster in which to place the virtual machine. This setting applies to entire virtual machine and implies that you wish to use vSphere Storage DRS with the virtual machine. See the section on virtual machine migration for more information on modifying this value.
NOTE: One of
datastore_id
ordatastore_cluster_id
must be specified.NOTE: Use of
datastore_cluster_id
requires vSphere Storage DRS to be enabled on the specified datastore cluster.NOTE: The
datastore_cluster_id
setting applies to the entire virtual machine resource. You cannot assign individual individual disks to datastore clusters. In addition, you cannot use theattach
setting to attach external disks on virtual machines that are assigned to datastore clusters.- datastore
Id String - The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with
client_device
. - disks
List<Virtual
Machine Disk> - A specification for a virtual disk device on the virtual machine. See disk options for more information.
- efi
Secure BooleanBoot Enabled Use this option to enable EFI secure boot when the
firmware
type is set to isefi
. Default:false
.NOTE: EFI secure boot is only available on vSphere 6.5 and later.
- enable
Disk BooleanUuid - Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest. Default:
false
. - enable
Logging Boolean - Enable logging of virtual machine events to a log file stored in the virtual machine directory. Default:
false
. - ept
Rvi StringMode - The EPT/RVI (hardware memory virtualization) setting for the virtual machine. One of
automatic
,on
, oroff
. Default:automatic
. - extra
Config Map<String,String> Extra configuration data for the virtual machine. Can be used to supply advanced parameters not normally in configuration, such as instance metadata and userdata.
NOTE: Do not use
extra_config
when working with a template imported from OVF/OVA as your settings may be ignored. Use thevapp
blockproperties
section as described in Using vApp Properties for OVF/OVA Configuration.- extra
Config BooleanReboot Required - Allow the virtual machine to be rebooted when a change to
extra_config
occurs. Default:true
. - firmware String
- The firmware for the virtual machine. One of
bios
orefi
. - folder String
- The path to the virtual machine folder in which to place the virtual machine, relative to the datacenter path (
/<datacenter-name>/vm
). For example,/dc-01/vm/foo
- force
Power BooleanOff - If a guest shutdown failed or times out while updating or destroying (see
shutdown_wait_timeout
), force the power-off of the virtual machine. Default:true
. - guest
Id String - The guest ID for the operating system type. For a full list of possible values, see here. Default:
otherGuest64
. - hardware
Version Integer - The hardware version number. Valid range is from 4 to 21. The hardware version cannot be downgraded. See virtual machine hardware versions and compatibility for more information on supported settings.
- host
System StringId - The managed object reference ID of a host on which to place the virtual machine. See the section on virtual machine migration for more information on modifying this value. When using a vSphere cluster, if a
host_system_id
is not supplied, vSphere will select a host in the cluster to place the virtual machine, according to any defaults or vSphere DRS placement policies. - hv
Mode String - The hardware virtualization (non-nested) setting for the virtual machine. One of
hvAuto
,hvOn
, orhvOff
. Default:hvAuto
. - ide
Controller IntegerCount - The number of IDE controllers that the virtual machine. This directly affects the number of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers. Default:
2
. - ignored
Guest List<String>Ips - List of IP addresses and CIDR networks to ignore while waiting for an available IP address using either of the waiters. Any IP addresses in this list will be ignored so that the waiter will continue to wait for a valid IP address. Default:
[]
. - latency
Sensitivity String Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard devices. One of
low
,normal
,medium
, orhigh
.NOTE: On higher sensitivities, you may need to adjust the
memory_reservation
to the full amount of memory provisioned for the virtual machine.- memory Integer
- The memory size to assign to the virtual machine, in MB. Default:
1024
(1 GB). - memory
Hot BooleanAdd Enabled Allow memory to be added to the virtual machine while it is powered on.
NOTE: CPU and memory hot add options are not available on all guest operating systems. Please refer to the VMware Guest OS Compatibility Guide to which settings are allow for your guest operating system. In addition, at least one
pulumi up
must be run before you are able to use CPU and memory hot add.NOTE: For Linux 64-bit guest operating systems with less than or equal to 3GB, the virtual machine must powered off to add memory beyond 3GB. Subsequent hot add of memory does not require the virtual machine to be powered-off to apply the plan. Please refer to VMware KB 2008405.
- memory
Limit Integer - The maximum amount of memory (in MB) that th virtual machine can consume, regardless of available resources. The default is no limit.
- memory
Reservation Integer - The amount of memory (in MB) that the virtual machine is guaranteed. The default is no reservation.
- memory
Reservation BooleanLocked To Max - If set true, memory resource reservation for this virtual machine will always be equal to the virtual machine's memory size;increases in memory size will be rejected when a corresponding reservation increase is not possible. This feature may only be enabled if it is currently possible to reserve all of the virtual machine's memory.
- Integer
- The number of memory shares allocated to the virtual machine when the
memory_share_level
iscustom
. - String
- The allocation level for the virtual machine memory resources. One of
high
,low
,normal
, orcustom
. Default:custom
. - migrate
Wait IntegerTimeout - The amount of time, in minutes, to wait for a virtual machine migration to complete before failing. Default:
10
minutes. See the section on virtual machine migration for more information. - name String
- The name of the virtual machine.
- nested
Hv BooleanEnabled - Enable nested hardware virtualization on the virtual machine, facilitating nested virtualization in the guest operating system. Default:
false
. - network
Interfaces List<VirtualMachine Network Interface> - A specification for a virtual NIC on the virtual machine. See network interface options for more information.
- num
Cores IntegerPer Socket - The number of cores per socket in the virtual machine. The number of vCPUs on the virtual machine will be
num_cpus
divided bynum_cores_per_socket
. If specified, the value supplied tonum_cpus
must be evenly divisible by this value. Default:1
. - num
Cpus Integer - The total number of virtual processor cores to assign to the virtual machine. Default:
1
. - ovf
Deploy VirtualMachine Ovf Deploy - When specified, the virtual machine will be deployed from the provided OVF/OVA template. See creating a virtual machine from an OVF/OVA template for more information.
- pci
Device List<String>Ids List of host PCI device IDs in which to create PCI passthroughs.
NOTE: Cloning requires vCenter Server and is not supported on direct ESXi host connections.
- poweron
Timeout Integer - The amount of time, in seconds, that we will be trying to power on a VM
- replace
Trigger String Triggers replacement of resource whenever it changes.
For example,
replace_trigger = sha256(format("%!s(MISSING)-%!s(MISSING)",data.template_file.cloud_init_metadata.rendered,data.template_file.cloud_init_userdata.rendered))
will fingerprint the changes in cloud-init metadata and userdata templates. This will enable a replacement of the resource whenever the dependant template renders a new configuration. (Forces a replacement.)- run
Tools BooleanScripts After Power On - Enable post-power-on scripts to run when VMware Tools is installed. Default:
true
. - run
Tools BooleanScripts After Resume - Enable ost-resume scripts to run when VMware Tools is installed. Default:
true
. - run
Tools BooleanScripts Before Guest Reboot - Enable pre-reboot scripts to run when VMware Tools is installed. Default:
false
. - run
Tools BooleanScripts Before Guest Shutdown - Enable pre-shutdown scripts to run when VMware Tools is installed. Default:
true
. - run
Tools BooleanScripts Before Guest Standby - Enable pre-standby scripts to run when VMware Tools is installed. Default:
true
. - sata
Controller IntegerCount - The number of SATA controllers that Terraform manages on this virtual machine. This directly affects the amount of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers.
- scsi
Bus StringSharing - The type of SCSI bus sharing for the virtual machine SCSI controller. One of
physicalSharing
,virtualSharing
, andnoSharing
. Default:noSharing
. - scsi
Controller IntegerCount - The number of SCSI controllers that Terraform manages on this virtual machine. This directly affects the amount of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers.
- scsi
Type String - The SCSI controller type for the virtual machine. One of
lsilogic
(LSI Logic Parallel),lsilogic-sas
(LSI Logic SAS) orpvscsi
(VMware Paravirtual). Default:pvscsi
. - shutdown
Wait IntegerTimeout - The amount of time, in minutes, to wait for a graceful guest shutdown when making necessary updates to the virtual machine. If
force_power_off
is set totrue
, the virtual machine will be forced to power-off after the timeout, otherwise an error is returned. Default:3
minutes. - storage
Policy StringId - The UUID of the storage policy to assign to the virtual disk.
- swap
Placement StringPolicy - The swap file placement policy for the virtual machine. One of
inherit
,hostLocal
, orvmDirectory
. Default:inherit
. - sync
Time BooleanWith Host - Enable the guest operating system to synchronization its clock with the host when the virtual machine is powered on or resumed. Requires vSphere 7.0 Update 1 and later. Requires VMware Tools to be installed. Default:
true
. - sync
Time BooleanWith Host Periodically - Enable the guest operating system to periodically synchronize its clock with the host. Requires vSphere 7.0 Update 1 and later. On previous versions, setting
sync_time_with_host
is will enable periodic synchronization. Requires VMware Tools to be installed. Default:false
. - List<String>
The IDs of any tags to attach to this resource. Please refer to the
vsphere.Tag
resource for more information on applying tags to virtual machine resources.NOTE: Tagging support is unsupported on direct ESXi host connections and requires vCenter Server instance.
- tools
Upgrade StringPolicy - Enable automatic upgrade of the VMware Tools version when the virtual machine is rebooted. If necessary, VMware Tools is upgraded to the latest version supported by the host on which the virtual machine is running. Requires VMware Tools to be installed. One of
manual
orupgradeAtPowerCycle
. Default:manual
. - vapp
Virtual
Machine Vapp - Used for vApp configurations. The only sub-key available is
properties
, which is a key/value map of properties for virtual machines imported from and OVF/OVA. See Using vApp Properties for OVF/OVA Configuration for more information. - vbs
Enabled Boolean - Enable Virtualization Based Security. Requires
firmware
to beefi
. In addition,vvtd_enabled
,nested_hv_enabled
, andefi_secure_boot_enabled
must all have a value oftrue
. Supported on vSphere 6.7 and later. Default:false
. - vvtd
Enabled Boolean - Enable Intel Virtualization Technology for Directed I/O for the virtual machine (I/O MMU in the vSphere Client). Supported on vSphere 6.7 and later. Default:
false
. - wait
For IntegerGuest Ip Timeout - The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. This should only be used if the version VMware Tools does not allow the
wait_for_guest_net_timeout
waiter to be used. A value less than1
disables the waiter. Default:0
. - wait
For BooleanGuest Net Routable - Controls whether or not the guest network waiter waits for a routable address. When
false
, the waiter does not wait for a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria. This property is ignored if thewait_for_guest_ip_timeout
waiter is used. Default:true
. - wait
For IntegerGuest Net Timeout - The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. Older versions of VMware Tools do not populate this property. In those cases, this waiter can be disabled and the
wait_for_guest_ip_timeout
waiter can be used instead. A value less than1
disables the waiter. Default:5
minutes.
- resource
Pool stringId The managed object reference ID of the resource pool in which to place the virtual machine. See the Virtual Machine Migration section for more information on modifying this value.
NOTE: All clusters and standalone hosts have a default root resource pool. This resource argument does not directly accept the cluster or standalone host resource. For more information, see the section on specifying the Root Resource Pool in the
vsphere.ResourcePool
data source documentation on using the root resource pool.- alternate
Guest stringName - The guest name for the operating system when
guest_id
isotherGuest
orotherGuest64
. - annotation string
- A user-provided description of the virtual machine.
- boot
Delay number - The number of milliseconds to wait before starting the boot sequence. The default is no delay.
- boot
Retry numberDelay - The number of milliseconds to wait before retrying the boot sequence. This option is only valid if
boot_retry_enabled
istrue
. Default:10000
(10 seconds). - boot
Retry booleanEnabled - If set to
true
, a virtual machine that fails to boot will try again after the delay defined inboot_retry_delay
. Default:false
. - cdroms
Virtual
Machine Cdrom[] - A specification for a CD-ROM device on the virtual machine. See CD-ROM options for more information.
- clone
Virtual
Machine Clone - When specified, the virtual machine will be created as a clone of a specified template. Optional customization options can be submitted for the resource. See creating a virtual machine from a template for more information.
- cpu
Hot booleanAdd Enabled - Allow CPUs to be added to the virtual machine while it is powered on.
- cpu
Hot booleanRemove Enabled - Allow CPUs to be removed to the virtual machine while it is powered on.
- cpu
Limit number - The maximum amount of CPU (in MHz) that the virtual machine can consume, regardless of available resources. The default is no limit.
- cpu
Performance booleanCounters Enabled - Enable CPU performance counters on the virtual machine. Default:
false
. - cpu
Reservation number - The amount of CPU (in MHz) that the virtual machine is guaranteed. The default is no reservation.
- number
- The number of CPU shares allocated to the virtual machine when the
cpu_share_level
iscustom
. - string
- The allocation level for the virtual machine CPU resources. One of
high
,low
,normal
, orcustom
. Default:custom
. - custom
Attributes {[key: string]: string} Map of custom attribute ids to attribute value strings to set for virtual machine. Please refer to the
vsphere_custom_attributes
resource for more information on setting custom attributes.NOTE: Custom attributes requires vCenter Server and is not supported on direct ESXi host connections.
- datacenter
Id string - The datacenter ID. Required only when deploying an OVF/OVA template.
- datastore
Cluster stringId The managed object reference ID of the datastore cluster in which to place the virtual machine. This setting applies to entire virtual machine and implies that you wish to use vSphere Storage DRS with the virtual machine. See the section on virtual machine migration for more information on modifying this value.
NOTE: One of
datastore_id
ordatastore_cluster_id
must be specified.NOTE: Use of
datastore_cluster_id
requires vSphere Storage DRS to be enabled on the specified datastore cluster.NOTE: The
datastore_cluster_id
setting applies to the entire virtual machine resource. You cannot assign individual individual disks to datastore clusters. In addition, you cannot use theattach
setting to attach external disks on virtual machines that are assigned to datastore clusters.- datastore
Id string - The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with
client_device
. - disks
Virtual
Machine Disk[] - A specification for a virtual disk device on the virtual machine. See disk options for more information.
- efi
Secure booleanBoot Enabled Use this option to enable EFI secure boot when the
firmware
type is set to isefi
. Default:false
.NOTE: EFI secure boot is only available on vSphere 6.5 and later.
- enable
Disk booleanUuid - Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest. Default:
false
. - enable
Logging boolean - Enable logging of virtual machine events to a log file stored in the virtual machine directory. Default:
false
. - ept
Rvi stringMode - The EPT/RVI (hardware memory virtualization) setting for the virtual machine. One of
automatic
,on
, oroff
. Default:automatic
. - extra
Config {[key: string]: string} Extra configuration data for the virtual machine. Can be used to supply advanced parameters not normally in configuration, such as instance metadata and userdata.
NOTE: Do not use
extra_config
when working with a template imported from OVF/OVA as your settings may be ignored. Use thevapp
blockproperties
section as described in Using vApp Properties for OVF/OVA Configuration.- extra
Config booleanReboot Required - Allow the virtual machine to be rebooted when a change to
extra_config
occurs. Default:true
. - firmware string
- The firmware for the virtual machine. One of
bios
orefi
. - folder string
- The path to the virtual machine folder in which to place the virtual machine, relative to the datacenter path (
/<datacenter-name>/vm
). For example,/dc-01/vm/foo
- force
Power booleanOff - If a guest shutdown failed or times out while updating or destroying (see
shutdown_wait_timeout
), force the power-off of the virtual machine. Default:true
. - guest
Id string - The guest ID for the operating system type. For a full list of possible values, see here. Default:
otherGuest64
. - hardware
Version number - The hardware version number. Valid range is from 4 to 21. The hardware version cannot be downgraded. See virtual machine hardware versions and compatibility for more information on supported settings.
- host
System stringId - The managed object reference ID of a host on which to place the virtual machine. See the section on virtual machine migration for more information on modifying this value. When using a vSphere cluster, if a
host_system_id
is not supplied, vSphere will select a host in the cluster to place the virtual machine, according to any defaults or vSphere DRS placement policies. - hv
Mode string - The hardware virtualization (non-nested) setting for the virtual machine. One of
hvAuto
,hvOn
, orhvOff
. Default:hvAuto
. - ide
Controller numberCount - The number of IDE controllers that the virtual machine. This directly affects the number of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers. Default:
2
. - ignored
Guest string[]Ips - List of IP addresses and CIDR networks to ignore while waiting for an available IP address using either of the waiters. Any IP addresses in this list will be ignored so that the waiter will continue to wait for a valid IP address. Default:
[]
. - latency
Sensitivity string Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard devices. One of
low
,normal
,medium
, orhigh
.NOTE: On higher sensitivities, you may need to adjust the
memory_reservation
to the full amount of memory provisioned for the virtual machine.- memory number
- The memory size to assign to the virtual machine, in MB. Default:
1024
(1 GB). - memory
Hot booleanAdd Enabled Allow memory to be added to the virtual machine while it is powered on.
NOTE: CPU and memory hot add options are not available on all guest operating systems. Please refer to the VMware Guest OS Compatibility Guide to which settings are allow for your guest operating system. In addition, at least one
pulumi up
must be run before you are able to use CPU and memory hot add.NOTE: For Linux 64-bit guest operating systems with less than or equal to 3GB, the virtual machine must powered off to add memory beyond 3GB. Subsequent hot add of memory does not require the virtual machine to be powered-off to apply the plan. Please refer to VMware KB 2008405.
- memory
Limit number - The maximum amount of memory (in MB) that th virtual machine can consume, regardless of available resources. The default is no limit.
- memory
Reservation number - The amount of memory (in MB) that the virtual machine is guaranteed. The default is no reservation.
- memory
Reservation booleanLocked To Max - If set true, memory resource reservation for this virtual machine will always be equal to the virtual machine's memory size;increases in memory size will be rejected when a corresponding reservation increase is not possible. This feature may only be enabled if it is currently possible to reserve all of the virtual machine's memory.
- number
- The number of memory shares allocated to the virtual machine when the
memory_share_level
iscustom
. - string
- The allocation level for the virtual machine memory resources. One of
high
,low
,normal
, orcustom
. Default:custom
. - migrate
Wait numberTimeout - The amount of time, in minutes, to wait for a virtual machine migration to complete before failing. Default:
10
minutes. See the section on virtual machine migration for more information. - name string
- The name of the virtual machine.
- nested
Hv booleanEnabled - Enable nested hardware virtualization on the virtual machine, facilitating nested virtualization in the guest operating system. Default:
false
. - network
Interfaces VirtualMachine Network Interface[] - A specification for a virtual NIC on the virtual machine. See network interface options for more information.
- num
Cores numberPer Socket - The number of cores per socket in the virtual machine. The number of vCPUs on the virtual machine will be
num_cpus
divided bynum_cores_per_socket
. If specified, the value supplied tonum_cpus
must be evenly divisible by this value. Default:1
. - num
Cpus number - The total number of virtual processor cores to assign to the virtual machine. Default:
1
. - ovf
Deploy VirtualMachine Ovf Deploy - When specified, the virtual machine will be deployed from the provided OVF/OVA template. See creating a virtual machine from an OVF/OVA template for more information.
- pci
Device string[]Ids List of host PCI device IDs in which to create PCI passthroughs.
NOTE: Cloning requires vCenter Server and is not supported on direct ESXi host connections.
- poweron
Timeout number - The amount of time, in seconds, that we will be trying to power on a VM
- replace
Trigger string Triggers replacement of resource whenever it changes.
For example,
replace_trigger = sha256(format("%!s(MISSING)-%!s(MISSING)",data.template_file.cloud_init_metadata.rendered,data.template_file.cloud_init_userdata.rendered))
will fingerprint the changes in cloud-init metadata and userdata templates. This will enable a replacement of the resource whenever the dependant template renders a new configuration. (Forces a replacement.)- run
Tools booleanScripts After Power On - Enable post-power-on scripts to run when VMware Tools is installed. Default:
true
. - run
Tools booleanScripts After Resume - Enable ost-resume scripts to run when VMware Tools is installed. Default:
true
. - run
Tools booleanScripts Before Guest Reboot - Enable pre-reboot scripts to run when VMware Tools is installed. Default:
false
. - run
Tools booleanScripts Before Guest Shutdown - Enable pre-shutdown scripts to run when VMware Tools is installed. Default:
true
. - run
Tools booleanScripts Before Guest Standby - Enable pre-standby scripts to run when VMware Tools is installed. Default:
true
. - sata
Controller numberCount - The number of SATA controllers that Terraform manages on this virtual machine. This directly affects the amount of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers.
- scsi
Bus stringSharing - The type of SCSI bus sharing for the virtual machine SCSI controller. One of
physicalSharing
,virtualSharing
, andnoSharing
. Default:noSharing
. - scsi
Controller numberCount - The number of SCSI controllers that Terraform manages on this virtual machine. This directly affects the amount of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers.
- scsi
Type string - The SCSI controller type for the virtual machine. One of
lsilogic
(LSI Logic Parallel),lsilogic-sas
(LSI Logic SAS) orpvscsi
(VMware Paravirtual). Default:pvscsi
. - shutdown
Wait numberTimeout - The amount of time, in minutes, to wait for a graceful guest shutdown when making necessary updates to the virtual machine. If
force_power_off
is set totrue
, the virtual machine will be forced to power-off after the timeout, otherwise an error is returned. Default:3
minutes. - storage
Policy stringId - The UUID of the storage policy to assign to the virtual disk.
- swap
Placement stringPolicy - The swap file placement policy for the virtual machine. One of
inherit
,hostLocal
, orvmDirectory
. Default:inherit
. - sync
Time booleanWith Host - Enable the guest operating system to synchronization its clock with the host when the virtual machine is powered on or resumed. Requires vSphere 7.0 Update 1 and later. Requires VMware Tools to be installed. Default:
true
. - sync
Time booleanWith Host Periodically - Enable the guest operating system to periodically synchronize its clock with the host. Requires vSphere 7.0 Update 1 and later. On previous versions, setting
sync_time_with_host
is will enable periodic synchronization. Requires VMware Tools to be installed. Default:false
. - string[]
The IDs of any tags to attach to this resource. Please refer to the
vsphere.Tag
resource for more information on applying tags to virtual machine resources.NOTE: Tagging support is unsupported on direct ESXi host connections and requires vCenter Server instance.
- tools
Upgrade stringPolicy - Enable automatic upgrade of the VMware Tools version when the virtual machine is rebooted. If necessary, VMware Tools is upgraded to the latest version supported by the host on which the virtual machine is running. Requires VMware Tools to be installed. One of
manual
orupgradeAtPowerCycle
. Default:manual
. - vapp
Virtual
Machine Vapp - Used for vApp configurations. The only sub-key available is
properties
, which is a key/value map of properties for virtual machines imported from and OVF/OVA. See Using vApp Properties for OVF/OVA Configuration for more information. - vbs
Enabled boolean - Enable Virtualization Based Security. Requires
firmware
to beefi
. In addition,vvtd_enabled
,nested_hv_enabled
, andefi_secure_boot_enabled
must all have a value oftrue
. Supported on vSphere 6.7 and later. Default:false
. - vvtd
Enabled boolean - Enable Intel Virtualization Technology for Directed I/O for the virtual machine (I/O MMU in the vSphere Client). Supported on vSphere 6.7 and later. Default:
false
. - wait
For numberGuest Ip Timeout - The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. This should only be used if the version VMware Tools does not allow the
wait_for_guest_net_timeout
waiter to be used. A value less than1
disables the waiter. Default:0
. - wait
For booleanGuest Net Routable - Controls whether or not the guest network waiter waits for a routable address. When
false
, the waiter does not wait for a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria. This property is ignored if thewait_for_guest_ip_timeout
waiter is used. Default:true
. - wait
For numberGuest Net Timeout - The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. Older versions of VMware Tools do not populate this property. In those cases, this waiter can be disabled and the
wait_for_guest_ip_timeout
waiter can be used instead. A value less than1
disables the waiter. Default:5
minutes.
- resource_
pool_ strid The managed object reference ID of the resource pool in which to place the virtual machine. See the Virtual Machine Migration section for more information on modifying this value.
NOTE: All clusters and standalone hosts have a default root resource pool. This resource argument does not directly accept the cluster or standalone host resource. For more information, see the section on specifying the Root Resource Pool in the
vsphere.ResourcePool
data source documentation on using the root resource pool.- alternate_
guest_ strname - The guest name for the operating system when
guest_id
isotherGuest
orotherGuest64
. - annotation str
- A user-provided description of the virtual machine.
- boot_
delay int - The number of milliseconds to wait before starting the boot sequence. The default is no delay.
- boot_
retry_ intdelay - The number of milliseconds to wait before retrying the boot sequence. This option is only valid if
boot_retry_enabled
istrue
. Default:10000
(10 seconds). - boot_
retry_ boolenabled - If set to
true
, a virtual machine that fails to boot will try again after the delay defined inboot_retry_delay
. Default:false
. - cdroms
Sequence[Virtual
Machine Cdrom Args] - A specification for a CD-ROM device on the virtual machine. See CD-ROM options for more information.
- clone
Virtual
Machine Clone Args - When specified, the virtual machine will be created as a clone of a specified template. Optional customization options can be submitted for the resource. See creating a virtual machine from a template for more information.
- cpu_
hot_ booladd_ enabled - Allow CPUs to be added to the virtual machine while it is powered on.
- cpu_
hot_ boolremove_ enabled - Allow CPUs to be removed to the virtual machine while it is powered on.
- cpu_
limit int - The maximum amount of CPU (in MHz) that the virtual machine can consume, regardless of available resources. The default is no limit.
- cpu_
performance_ boolcounters_ enabled - Enable CPU performance counters on the virtual machine. Default:
false
. - cpu_
reservation int - The amount of CPU (in MHz) that the virtual machine is guaranteed. The default is no reservation.
- int
- The number of CPU shares allocated to the virtual machine when the
cpu_share_level
iscustom
. - str
- The allocation level for the virtual machine CPU resources. One of
high
,low
,normal
, orcustom
. Default:custom
. - custom_
attributes Mapping[str, str] Map of custom attribute ids to attribute value strings to set for virtual machine. Please refer to the
vsphere_custom_attributes
resource for more information on setting custom attributes.NOTE: Custom attributes requires vCenter Server and is not supported on direct ESXi host connections.
- datacenter_
id str - The datacenter ID. Required only when deploying an OVF/OVA template.
- datastore_
cluster_ strid The managed object reference ID of the datastore cluster in which to place the virtual machine. This setting applies to entire virtual machine and implies that you wish to use vSphere Storage DRS with the virtual machine. See the section on virtual machine migration for more information on modifying this value.
NOTE: One of
datastore_id
ordatastore_cluster_id
must be specified.NOTE: Use of
datastore_cluster_id
requires vSphere Storage DRS to be enabled on the specified datastore cluster.NOTE: The
datastore_cluster_id
setting applies to the entire virtual machine resource. You cannot assign individual individual disks to datastore clusters. In addition, you cannot use theattach
setting to attach external disks on virtual machines that are assigned to datastore clusters.- datastore_
id str - The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with
client_device
. - disks
Sequence[Virtual
Machine Disk Args] - A specification for a virtual disk device on the virtual machine. See disk options for more information.
- efi_
secure_ boolboot_ enabled Use this option to enable EFI secure boot when the
firmware
type is set to isefi
. Default:false
.NOTE: EFI secure boot is only available on vSphere 6.5 and later.
- enable_
disk_ booluuid - Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest. Default:
false
. - enable_
logging bool - Enable logging of virtual machine events to a log file stored in the virtual machine directory. Default:
false
. - ept_
rvi_ strmode - The EPT/RVI (hardware memory virtualization) setting for the virtual machine. One of
automatic
,on
, oroff
. Default:automatic
. - extra_
config Mapping[str, str] Extra configuration data for the virtual machine. Can be used to supply advanced parameters not normally in configuration, such as instance metadata and userdata.
NOTE: Do not use
extra_config
when working with a template imported from OVF/OVA as your settings may be ignored. Use thevapp
blockproperties
section as described in Using vApp Properties for OVF/OVA Configuration.- extra_
config_ boolreboot_ required - Allow the virtual machine to be rebooted when a change to
extra_config
occurs. Default:true
. - firmware str
- The firmware for the virtual machine. One of
bios
orefi
. - folder str
- The path to the virtual machine folder in which to place the virtual machine, relative to the datacenter path (
/<datacenter-name>/vm
). For example,/dc-01/vm/foo
- force_
power_ booloff - If a guest shutdown failed or times out while updating or destroying (see
shutdown_wait_timeout
), force the power-off of the virtual machine. Default:true
. - guest_
id str - The guest ID for the operating system type. For a full list of possible values, see here. Default:
otherGuest64
. - hardware_
version int - The hardware version number. Valid range is from 4 to 21. The hardware version cannot be downgraded. See virtual machine hardware versions and compatibility for more information on supported settings.
- host_
system_ strid - The managed object reference ID of a host on which to place the virtual machine. See the section on virtual machine migration for more information on modifying this value. When using a vSphere cluster, if a
host_system_id
is not supplied, vSphere will select a host in the cluster to place the virtual machine, according to any defaults or vSphere DRS placement policies. - hv_
mode str - The hardware virtualization (non-nested) setting for the virtual machine. One of
hvAuto
,hvOn
, orhvOff
. Default:hvAuto
. - ide_
controller_ intcount - The number of IDE controllers that the virtual machine. This directly affects the number of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers. Default:
2
. - ignored_
guest_ Sequence[str]ips - List of IP addresses and CIDR networks to ignore while waiting for an available IP address using either of the waiters. Any IP addresses in this list will be ignored so that the waiter will continue to wait for a valid IP address. Default:
[]
. - latency_
sensitivity str Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard devices. One of
low
,normal
,medium
, orhigh
.NOTE: On higher sensitivities, you may need to adjust the
memory_reservation
to the full amount of memory provisioned for the virtual machine.- memory int
- The memory size to assign to the virtual machine, in MB. Default:
1024
(1 GB). - memory_
hot_ booladd_ enabled Allow memory to be added to the virtual machine while it is powered on.
NOTE: CPU and memory hot add options are not available on all guest operating systems. Please refer to the VMware Guest OS Compatibility Guide to which settings are allow for your guest operating system. In addition, at least one
pulumi up
must be run before you are able to use CPU and memory hot add.NOTE: For Linux 64-bit guest operating systems with less than or equal to 3GB, the virtual machine must powered off to add memory beyond 3GB. Subsequent hot add of memory does not require the virtual machine to be powered-off to apply the plan. Please refer to VMware KB 2008405.
- memory_
limit int - The maximum amount of memory (in MB) that th virtual machine can consume, regardless of available resources. The default is no limit.
- memory_
reservation int - The amount of memory (in MB) that the virtual machine is guaranteed. The default is no reservation.
- memory_
reservation_ boollocked_ to_ max - If set true, memory resource reservation for this virtual machine will always be equal to the virtual machine's memory size;increases in memory size will be rejected when a corresponding reservation increase is not possible. This feature may only be enabled if it is currently possible to reserve all of the virtual machine's memory.
- int
- The number of memory shares allocated to the virtual machine when the
memory_share_level
iscustom
. - str
- The allocation level for the virtual machine memory resources. One of
high
,low
,normal
, orcustom
. Default:custom
. - migrate_
wait_ inttimeout - The amount of time, in minutes, to wait for a virtual machine migration to complete before failing. Default:
10
minutes. See the section on virtual machine migration for more information. - name str
- The name of the virtual machine.
- nested_
hv_ boolenabled - Enable nested hardware virtualization on the virtual machine, facilitating nested virtualization in the guest operating system. Default:
false
. - network_
interfaces Sequence[VirtualMachine Network Interface Args] - A specification for a virtual NIC on the virtual machine. See network interface options for more information.
- num_
cores_ intper_ socket - The number of cores per socket in the virtual machine. The number of vCPUs on the virtual machine will be
num_cpus
divided bynum_cores_per_socket
. If specified, the value supplied tonum_cpus
must be evenly divisible by this value. Default:1
. - num_
cpus int - The total number of virtual processor cores to assign to the virtual machine. Default:
1
. - ovf_
deploy VirtualMachine Ovf Deploy Args - When specified, the virtual machine will be deployed from the provided OVF/OVA template. See creating a virtual machine from an OVF/OVA template for more information.
- pci_
device_ Sequence[str]ids List of host PCI device IDs in which to create PCI passthroughs.
NOTE: Cloning requires vCenter Server and is not supported on direct ESXi host connections.
- poweron_
timeout int - The amount of time, in seconds, that we will be trying to power on a VM
- replace_
trigger str Triggers replacement of resource whenever it changes.
For example,
replace_trigger = sha256(format("%!s(MISSING)-%!s(MISSING)",data.template_file.cloud_init_metadata.rendered,data.template_file.cloud_init_userdata.rendered))
will fingerprint the changes in cloud-init metadata and userdata templates. This will enable a replacement of the resource whenever the dependant template renders a new configuration. (Forces a replacement.)- run_
tools_ boolscripts_ after_ power_ on - Enable post-power-on scripts to run when VMware Tools is installed. Default:
true
. - run_
tools_ boolscripts_ after_ resume - Enable ost-resume scripts to run when VMware Tools is installed. Default:
true
. - run_
tools_ boolscripts_ before_ guest_ reboot - Enable pre-reboot scripts to run when VMware Tools is installed. Default:
false
. - run_
tools_ boolscripts_ before_ guest_ shutdown - Enable pre-shutdown scripts to run when VMware Tools is installed. Default:
true
. - run_
tools_ boolscripts_ before_ guest_ standby - Enable pre-standby scripts to run when VMware Tools is installed. Default:
true
. - sata_
controller_ intcount - The number of SATA controllers that Terraform manages on this virtual machine. This directly affects the amount of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers.
- scsi_
bus_ strsharing - The type of SCSI bus sharing for the virtual machine SCSI controller. One of
physicalSharing
,virtualSharing
, andnoSharing
. Default:noSharing
. - scsi_
controller_ intcount - The number of SCSI controllers that Terraform manages on this virtual machine. This directly affects the amount of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers.
- scsi_
type str - The SCSI controller type for the virtual machine. One of
lsilogic
(LSI Logic Parallel),lsilogic-sas
(LSI Logic SAS) orpvscsi
(VMware Paravirtual). Default:pvscsi
. - shutdown_
wait_ inttimeout - The amount of time, in minutes, to wait for a graceful guest shutdown when making necessary updates to the virtual machine. If
force_power_off
is set totrue
, the virtual machine will be forced to power-off after the timeout, otherwise an error is returned. Default:3
minutes. - storage_
policy_ strid - The UUID of the storage policy to assign to the virtual disk.
- swap_
placement_ strpolicy - The swap file placement policy for the virtual machine. One of
inherit
,hostLocal
, orvmDirectory
. Default:inherit
. - sync_
time_ boolwith_ host - Enable the guest operating system to synchronization its clock with the host when the virtual machine is powered on or resumed. Requires vSphere 7.0 Update 1 and later. Requires VMware Tools to be installed. Default:
true
. - sync_
time_ boolwith_ host_ periodically - Enable the guest operating system to periodically synchronize its clock with the host. Requires vSphere 7.0 Update 1 and later. On previous versions, setting
sync_time_with_host
is will enable periodic synchronization. Requires VMware Tools to be installed. Default:false
. - Sequence[str]
The IDs of any tags to attach to this resource. Please refer to the
vsphere.Tag
resource for more information on applying tags to virtual machine resources.NOTE: Tagging support is unsupported on direct ESXi host connections and requires vCenter Server instance.
- tools_
upgrade_ strpolicy - Enable automatic upgrade of the VMware Tools version when the virtual machine is rebooted. If necessary, VMware Tools is upgraded to the latest version supported by the host on which the virtual machine is running. Requires VMware Tools to be installed. One of
manual
orupgradeAtPowerCycle
. Default:manual
. - vapp
Virtual
Machine Vapp Args - Used for vApp configurations. The only sub-key available is
properties
, which is a key/value map of properties for virtual machines imported from and OVF/OVA. See Using vApp Properties for OVF/OVA Configuration for more information. - vbs_
enabled bool - Enable Virtualization Based Security. Requires
firmware
to beefi
. In addition,vvtd_enabled
,nested_hv_enabled
, andefi_secure_boot_enabled
must all have a value oftrue
. Supported on vSphere 6.7 and later. Default:false
. - vvtd_
enabled bool - Enable Intel Virtualization Technology for Directed I/O for the virtual machine (I/O MMU in the vSphere Client). Supported on vSphere 6.7 and later. Default:
false
. - wait_
for_ intguest_ ip_ timeout - The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. This should only be used if the version VMware Tools does not allow the
wait_for_guest_net_timeout
waiter to be used. A value less than1
disables the waiter. Default:0
. - wait_
for_ boolguest_ net_ routable - Controls whether or not the guest network waiter waits for a routable address. When
false
, the waiter does not wait for a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria. This property is ignored if thewait_for_guest_ip_timeout
waiter is used. Default:true
. - wait_
for_ intguest_ net_ timeout - The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. Older versions of VMware Tools do not populate this property. In those cases, this waiter can be disabled and the
wait_for_guest_ip_timeout
waiter can be used instead. A value less than1
disables the waiter. Default:5
minutes.
- resource
Pool StringId The managed object reference ID of the resource pool in which to place the virtual machine. See the Virtual Machine Migration section for more information on modifying this value.
NOTE: All clusters and standalone hosts have a default root resource pool. This resource argument does not directly accept the cluster or standalone host resource. For more information, see the section on specifying the Root Resource Pool in the
vsphere.ResourcePool
data source documentation on using the root resource pool.- alternate
Guest StringName - The guest name for the operating system when
guest_id
isotherGuest
orotherGuest64
. - annotation String
- A user-provided description of the virtual machine.
- boot
Delay Number - The number of milliseconds to wait before starting the boot sequence. The default is no delay.
- boot
Retry NumberDelay - The number of milliseconds to wait before retrying the boot sequence. This option is only valid if
boot_retry_enabled
istrue
. Default:10000
(10 seconds). - boot
Retry BooleanEnabled - If set to
true
, a virtual machine that fails to boot will try again after the delay defined inboot_retry_delay
. Default:false
. - cdroms List<Property Map>
- A specification for a CD-ROM device on the virtual machine. See CD-ROM options for more information.
- clone Property Map
- When specified, the virtual machine will be created as a clone of a specified template. Optional customization options can be submitted for the resource. See creating a virtual machine from a template for more information.
- cpu
Hot BooleanAdd Enabled - Allow CPUs to be added to the virtual machine while it is powered on.
- cpu
Hot BooleanRemove Enabled - Allow CPUs to be removed to the virtual machine while it is powered on.
- cpu
Limit Number - The maximum amount of CPU (in MHz) that the virtual machine can consume, regardless of available resources. The default is no limit.
- cpu
Performance BooleanCounters Enabled - Enable CPU performance counters on the virtual machine. Default:
false
. - cpu
Reservation Number - The amount of CPU (in MHz) that the virtual machine is guaranteed. The default is no reservation.
- Number
- The number of CPU shares allocated to the virtual machine when the
cpu_share_level
iscustom
. - String
- The allocation level for the virtual machine CPU resources. One of
high
,low
,normal
, orcustom
. Default:custom
. - custom
Attributes Map<String> Map of custom attribute ids to attribute value strings to set for virtual machine. Please refer to the
vsphere_custom_attributes
resource for more information on setting custom attributes.NOTE: Custom attributes requires vCenter Server and is not supported on direct ESXi host connections.
- datacenter
Id String - The datacenter ID. Required only when deploying an OVF/OVA template.
- datastore
Cluster StringId The managed object reference ID of the datastore cluster in which to place the virtual machine. This setting applies to entire virtual machine and implies that you wish to use vSphere Storage DRS with the virtual machine. See the section on virtual machine migration for more information on modifying this value.
NOTE: One of
datastore_id
ordatastore_cluster_id
must be specified.NOTE: Use of
datastore_cluster_id
requires vSphere Storage DRS to be enabled on the specified datastore cluster.NOTE: The
datastore_cluster_id
setting applies to the entire virtual machine resource. You cannot assign individual individual disks to datastore clusters. In addition, you cannot use theattach
setting to attach external disks on virtual machines that are assigned to datastore clusters.- datastore
Id String - The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with
client_device
. - disks List<Property Map>
- A specification for a virtual disk device on the virtual machine. See disk options for more information.
- efi
Secure BooleanBoot Enabled Use this option to enable EFI secure boot when the
firmware
type is set to isefi
. Default:false
.NOTE: EFI secure boot is only available on vSphere 6.5 and later.
- enable
Disk BooleanUuid - Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest. Default:
false
. - enable
Logging Boolean - Enable logging of virtual machine events to a log file stored in the virtual machine directory. Default:
false
. - ept
Rvi StringMode - The EPT/RVI (hardware memory virtualization) setting for the virtual machine. One of
automatic
,on
, oroff
. Default:automatic
. - extra
Config Map<String> Extra configuration data for the virtual machine. Can be used to supply advanced parameters not normally in configuration, such as instance metadata and userdata.
NOTE: Do not use
extra_config
when working with a template imported from OVF/OVA as your settings may be ignored. Use thevapp
blockproperties
section as described in Using vApp Properties for OVF/OVA Configuration.- extra
Config BooleanReboot Required - Allow the virtual machine to be rebooted when a change to
extra_config
occurs. Default:true
. - firmware String
- The firmware for the virtual machine. One of
bios
orefi
. - folder String
- The path to the virtual machine folder in which to place the virtual machine, relative to the datacenter path (
/<datacenter-name>/vm
). For example,/dc-01/vm/foo
- force
Power BooleanOff - If a guest shutdown failed or times out while updating or destroying (see
shutdown_wait_timeout
), force the power-off of the virtual machine. Default:true
. - guest
Id String - The guest ID for the operating system type. For a full list of possible values, see here. Default:
otherGuest64
. - hardware
Version Number - The hardware version number. Valid range is from 4 to 21. The hardware version cannot be downgraded. See virtual machine hardware versions and compatibility for more information on supported settings.
- host
System StringId - The managed object reference ID of a host on which to place the virtual machine. See the section on virtual machine migration for more information on modifying this value. When using a vSphere cluster, if a
host_system_id
is not supplied, vSphere will select a host in the cluster to place the virtual machine, according to any defaults or vSphere DRS placement policies. - hv
Mode String - The hardware virtualization (non-nested) setting for the virtual machine. One of
hvAuto
,hvOn
, orhvOff
. Default:hvAuto
. - ide
Controller NumberCount - The number of IDE controllers that the virtual machine. This directly affects the number of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers. Default:
2
. - ignored
Guest List<String>Ips - List of IP addresses and CIDR networks to ignore while waiting for an available IP address using either of the waiters. Any IP addresses in this list will be ignored so that the waiter will continue to wait for a valid IP address. Default:
[]
. - latency
Sensitivity String Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard devices. One of
low
,normal
,medium
, orhigh
.NOTE: On higher sensitivities, you may need to adjust the
memory_reservation
to the full amount of memory provisioned for the virtual machine.- memory Number
- The memory size to assign to the virtual machine, in MB. Default:
1024
(1 GB). - memory
Hot BooleanAdd Enabled Allow memory to be added to the virtual machine while it is powered on.
NOTE: CPU and memory hot add options are not available on all guest operating systems. Please refer to the VMware Guest OS Compatibility Guide to which settings are allow for your guest operating system. In addition, at least one
pulumi up
must be run before you are able to use CPU and memory hot add.NOTE: For Linux 64-bit guest operating systems with less than or equal to 3GB, the virtual machine must powered off to add memory beyond 3GB. Subsequent hot add of memory does not require the virtual machine to be powered-off to apply the plan. Please refer to VMware KB 2008405.
- memory
Limit Number - The maximum amount of memory (in MB) that th virtual machine can consume, regardless of available resources. The default is no limit.
- memory
Reservation Number - The amount of memory (in MB) that the virtual machine is guaranteed. The default is no reservation.
- memory
Reservation BooleanLocked To Max - If set true, memory resource reservation for this virtual machine will always be equal to the virtual machine's memory size;increases in memory size will be rejected when a corresponding reservation increase is not possible. This feature may only be enabled if it is currently possible to reserve all of the virtual machine's memory.
- Number
- The number of memory shares allocated to the virtual machine when the
memory_share_level
iscustom
. - String
- The allocation level for the virtual machine memory resources. One of
high
,low
,normal
, orcustom
. Default:custom
. - migrate
Wait NumberTimeout - The amount of time, in minutes, to wait for a virtual machine migration to complete before failing. Default:
10
minutes. See the section on virtual machine migration for more information. - name String
- The name of the virtual machine.
- nested
Hv BooleanEnabled - Enable nested hardware virtualization on the virtual machine, facilitating nested virtualization in the guest operating system. Default:
false
. - network
Interfaces List<Property Map> - A specification for a virtual NIC on the virtual machine. See network interface options for more information.
- num
Cores NumberPer Socket - The number of cores per socket in the virtual machine. The number of vCPUs on the virtual machine will be
num_cpus
divided bynum_cores_per_socket
. If specified, the value supplied tonum_cpus
must be evenly divisible by this value. Default:1
. - num
Cpus Number - The total number of virtual processor cores to assign to the virtual machine. Default:
1
. - ovf
Deploy Property Map - When specified, the virtual machine will be deployed from the provided OVF/OVA template. See creating a virtual machine from an OVF/OVA template for more information.
- pci
Device List<String>Ids List of host PCI device IDs in which to create PCI passthroughs.
NOTE: Cloning requires vCenter Server and is not supported on direct ESXi host connections.
- poweron
Timeout Number - The amount of time, in seconds, that we will be trying to power on a VM
- replace
Trigger String Triggers replacement of resource whenever it changes.
For example,
replace_trigger = sha256(format("%!s(MISSING)-%!s(MISSING)",data.template_file.cloud_init_metadata.rendered,data.template_file.cloud_init_userdata.rendered))
will fingerprint the changes in cloud-init metadata and userdata templates. This will enable a replacement of the resource whenever the dependant template renders a new configuration. (Forces a replacement.)- run
Tools BooleanScripts After Power On - Enable post-power-on scripts to run when VMware Tools is installed. Default:
true
. - run
Tools BooleanScripts After Resume - Enable ost-resume scripts to run when VMware Tools is installed. Default:
true
. - run
Tools BooleanScripts Before Guest Reboot - Enable pre-reboot scripts to run when VMware Tools is installed. Default:
false
. - run
Tools BooleanScripts Before Guest Shutdown - Enable pre-shutdown scripts to run when VMware Tools is installed. Default:
true
. - run
Tools BooleanScripts Before Guest Standby - Enable pre-standby scripts to run when VMware Tools is installed. Default:
true
. - sata
Controller NumberCount - The number of SATA controllers that Terraform manages on this virtual machine. This directly affects the amount of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers.
- scsi
Bus StringSharing - The type of SCSI bus sharing for the virtual machine SCSI controller. One of
physicalSharing
,virtualSharing
, andnoSharing
. Default:noSharing
. - scsi
Controller NumberCount - The number of SCSI controllers that Terraform manages on this virtual machine. This directly affects the amount of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers.
- scsi
Type String - The SCSI controller type for the virtual machine. One of
lsilogic
(LSI Logic Parallel),lsilogic-sas
(LSI Logic SAS) orpvscsi
(VMware Paravirtual). Default:pvscsi
. - shutdown
Wait NumberTimeout - The amount of time, in minutes, to wait for a graceful guest shutdown when making necessary updates to the virtual machine. If
force_power_off
is set totrue
, the virtual machine will be forced to power-off after the timeout, otherwise an error is returned. Default:3
minutes. - storage
Policy StringId - The UUID of the storage policy to assign to the virtual disk.
- swap
Placement StringPolicy - The swap file placement policy for the virtual machine. One of
inherit
,hostLocal
, orvmDirectory
. Default:inherit
. - sync
Time BooleanWith Host - Enable the guest operating system to synchronization its clock with the host when the virtual machine is powered on or resumed. Requires vSphere 7.0 Update 1 and later. Requires VMware Tools to be installed. Default:
true
. - sync
Time BooleanWith Host Periodically - Enable the guest operating system to periodically synchronize its clock with the host. Requires vSphere 7.0 Update 1 and later. On previous versions, setting
sync_time_with_host
is will enable periodic synchronization. Requires VMware Tools to be installed. Default:false
. - List<String>
The IDs of any tags to attach to this resource. Please refer to the
vsphere.Tag
resource for more information on applying tags to virtual machine resources.NOTE: Tagging support is unsupported on direct ESXi host connections and requires vCenter Server instance.
- tools
Upgrade StringPolicy - Enable automatic upgrade of the VMware Tools version when the virtual machine is rebooted. If necessary, VMware Tools is upgraded to the latest version supported by the host on which the virtual machine is running. Requires VMware Tools to be installed. One of
manual
orupgradeAtPowerCycle
. Default:manual
. - vapp Property Map
- Used for vApp configurations. The only sub-key available is
properties
, which is a key/value map of properties for virtual machines imported from and OVF/OVA. See Using vApp Properties for OVF/OVA Configuration for more information. - vbs
Enabled Boolean - Enable Virtualization Based Security. Requires
firmware
to beefi
. In addition,vvtd_enabled
,nested_hv_enabled
, andefi_secure_boot_enabled
must all have a value oftrue
. Supported on vSphere 6.7 and later. Default:false
. - vvtd
Enabled Boolean - Enable Intel Virtualization Technology for Directed I/O for the virtual machine (I/O MMU in the vSphere Client). Supported on vSphere 6.7 and later. Default:
false
. - wait
For NumberGuest Ip Timeout - The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. This should only be used if the version VMware Tools does not allow the
wait_for_guest_net_timeout
waiter to be used. A value less than1
disables the waiter. Default:0
. - wait
For BooleanGuest Net Routable - Controls whether or not the guest network waiter waits for a routable address. When
false
, the waiter does not wait for a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria. This property is ignored if thewait_for_guest_ip_timeout
waiter is used. Default:true
. - wait
For NumberGuest Net Timeout - The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. Older versions of VMware Tools do not populate this property. In those cases, this waiter can be disabled and the
wait_for_guest_ip_timeout
waiter can be used instead. A value less than1
disables the waiter. Default:5
minutes.
Outputs
All input properties are implicitly available as output properties. Additionally, the VirtualMachine resource produces the following output properties:
- Change
Version string - A unique identifier for a given version of the last configuration was applied.
- Default
Ip stringAddress - The IP address selected by the provider to be used with any provisioners configured on this resource. When possible, this is the first IPv4 address that is reachable through the default gateway configured on the machine, then the first reachable IPv6 address, and then the first general discovered address if neither exists. If VMware Tools is not running on the virtual machine, or if the virtual machine is powered off, this value will be blank.
- Guest
Ip List<string>Addresses - The current list of IP addresses on this machine, including the value of
default_ip_address
. If VMware Tools is not running on the virtual machine, or if the virtul machine is powered off, this list will be empty. - Id string
- The provider-assigned unique ID for this managed resource.
- Imported bool
- Indicates if the virtual machine resource has been imported, or if the state has been migrated from a previous version of the resource. It influences the behavior of the first post-import apply operation. See the section on importing below.
- Moid string
- The managed object reference ID of the created virtual machine.
- Power
State string - A computed value for the current power state of the virtual machine. One of
on
,off
, orsuspended
. - Reboot
Required bool - Value internal to Terraform used to determine if a configuration set change requires a reboot.
- Uuid string
- The UUID of the virtual disk VMDK file. This is used to track the virtual disk on the virtual machine.
- Vapp
Transports List<string> - Computed value which is only valid for cloned virtual machines. A list of vApp transport methods supported by the source virtual machine or template.
- Vmware
Tools stringStatus - The state of VMware Tools in the guest. This will determine the proper course of action for some device operations.
- Vmx
Path string - The path of the virtual machine configuration file on the datastore in which the virtual machine is placed.
- Change
Version string - A unique identifier for a given version of the last configuration was applied.
- Default
Ip stringAddress - The IP address selected by the provider to be used with any provisioners configured on this resource. When possible, this is the first IPv4 address that is reachable through the default gateway configured on the machine, then the first reachable IPv6 address, and then the first general discovered address if neither exists. If VMware Tools is not running on the virtual machine, or if the virtual machine is powered off, this value will be blank.
- Guest
Ip []stringAddresses - The current list of IP addresses on this machine, including the value of
default_ip_address
. If VMware Tools is not running on the virtual machine, or if the virtul machine is powered off, this list will be empty. - Id string
- The provider-assigned unique ID for this managed resource.
- Imported bool
- Indicates if the virtual machine resource has been imported, or if the state has been migrated from a previous version of the resource. It influences the behavior of the first post-import apply operation. See the section on importing below.
- Moid string
- The managed object reference ID of the created virtual machine.
- Power
State string - A computed value for the current power state of the virtual machine. One of
on
,off
, orsuspended
. - Reboot
Required bool - Value internal to Terraform used to determine if a configuration set change requires a reboot.
- Uuid string
- The UUID of the virtual disk VMDK file. This is used to track the virtual disk on the virtual machine.
- Vapp
Transports []string - Computed value which is only valid for cloned virtual machines. A list of vApp transport methods supported by the source virtual machine or template.
- Vmware
Tools stringStatus - The state of VMware Tools in the guest. This will determine the proper course of action for some device operations.
- Vmx
Path string - The path of the virtual machine configuration file on the datastore in which the virtual machine is placed.
- change
Version String - A unique identifier for a given version of the last configuration was applied.
- default
Ip StringAddress - The IP address selected by the provider to be used with any provisioners configured on this resource. When possible, this is the first IPv4 address that is reachable through the default gateway configured on the machine, then the first reachable IPv6 address, and then the first general discovered address if neither exists. If VMware Tools is not running on the virtual machine, or if the virtual machine is powered off, this value will be blank.
- guest
Ip List<String>Addresses - The current list of IP addresses on this machine, including the value of
default_ip_address
. If VMware Tools is not running on the virtual machine, or if the virtul machine is powered off, this list will be empty. - id String
- The provider-assigned unique ID for this managed resource.
- imported Boolean
- Indicates if the virtual machine resource has been imported, or if the state has been migrated from a previous version of the resource. It influences the behavior of the first post-import apply operation. See the section on importing below.
- moid String
- The managed object reference ID of the created virtual machine.
- power
State String - A computed value for the current power state of the virtual machine. One of
on
,off
, orsuspended
. - reboot
Required Boolean - Value internal to Terraform used to determine if a configuration set change requires a reboot.
- uuid String
- The UUID of the virtual disk VMDK file. This is used to track the virtual disk on the virtual machine.
- vapp
Transports List<String> - Computed value which is only valid for cloned virtual machines. A list of vApp transport methods supported by the source virtual machine or template.
- vmware
Tools StringStatus - The state of VMware Tools in the guest. This will determine the proper course of action for some device operations.
- vmx
Path String - The path of the virtual machine configuration file on the datastore in which the virtual machine is placed.
- change
Version string - A unique identifier for a given version of the last configuration was applied.
- default
Ip stringAddress - The IP address selected by the provider to be used with any provisioners configured on this resource. When possible, this is the first IPv4 address that is reachable through the default gateway configured on the machine, then the first reachable IPv6 address, and then the first general discovered address if neither exists. If VMware Tools is not running on the virtual machine, or if the virtual machine is powered off, this value will be blank.
- guest
Ip string[]Addresses - The current list of IP addresses on this machine, including the value of
default_ip_address
. If VMware Tools is not running on the virtual machine, or if the virtul machine is powered off, this list will be empty. - id string
- The provider-assigned unique ID for this managed resource.
- imported boolean
- Indicates if the virtual machine resource has been imported, or if the state has been migrated from a previous version of the resource. It influences the behavior of the first post-import apply operation. See the section on importing below.
- moid string
- The managed object reference ID of the created virtual machine.
- power
State string - A computed value for the current power state of the virtual machine. One of
on
,off
, orsuspended
. - reboot
Required boolean - Value internal to Terraform used to determine if a configuration set change requires a reboot.
- uuid string
- The UUID of the virtual disk VMDK file. This is used to track the virtual disk on the virtual machine.
- vapp
Transports string[] - Computed value which is only valid for cloned virtual machines. A list of vApp transport methods supported by the source virtual machine or template.
- vmware
Tools stringStatus - The state of VMware Tools in the guest. This will determine the proper course of action for some device operations.
- vmx
Path string - The path of the virtual machine configuration file on the datastore in which the virtual machine is placed.
- change_
version str - A unique identifier for a given version of the last configuration was applied.
- default_
ip_ straddress - The IP address selected by the provider to be used with any provisioners configured on this resource. When possible, this is the first IPv4 address that is reachable through the default gateway configured on the machine, then the first reachable IPv6 address, and then the first general discovered address if neither exists. If VMware Tools is not running on the virtual machine, or if the virtual machine is powered off, this value will be blank.
- guest_
ip_ Sequence[str]addresses - The current list of IP addresses on this machine, including the value of
default_ip_address
. If VMware Tools is not running on the virtual machine, or if the virtul machine is powered off, this list will be empty. - id str
- The provider-assigned unique ID for this managed resource.
- imported bool
- Indicates if the virtual machine resource has been imported, or if the state has been migrated from a previous version of the resource. It influences the behavior of the first post-import apply operation. See the section on importing below.
- moid str
- The managed object reference ID of the created virtual machine.
- power_
state str - A computed value for the current power state of the virtual machine. One of
on
,off
, orsuspended
. - reboot_
required bool - Value internal to Terraform used to determine if a configuration set change requires a reboot.
- uuid str
- The UUID of the virtual disk VMDK file. This is used to track the virtual disk on the virtual machine.
- vapp_
transports Sequence[str] - Computed value which is only valid for cloned virtual machines. A list of vApp transport methods supported by the source virtual machine or template.
- vmware_
tools_ strstatus - The state of VMware Tools in the guest. This will determine the proper course of action for some device operations.
- vmx_
path str - The path of the virtual machine configuration file on the datastore in which the virtual machine is placed.
- change
Version String - A unique identifier for a given version of the last configuration was applied.
- default
Ip StringAddress - The IP address selected by the provider to be used with any provisioners configured on this resource. When possible, this is the first IPv4 address that is reachable through the default gateway configured on the machine, then the first reachable IPv6 address, and then the first general discovered address if neither exists. If VMware Tools is not running on the virtual machine, or if the virtual machine is powered off, this value will be blank.
- guest
Ip List<String>Addresses - The current list of IP addresses on this machine, including the value of
default_ip_address
. If VMware Tools is not running on the virtual machine, or if the virtul machine is powered off, this list will be empty. - id String
- The provider-assigned unique ID for this managed resource.
- imported Boolean
- Indicates if the virtual machine resource has been imported, or if the state has been migrated from a previous version of the resource. It influences the behavior of the first post-import apply operation. See the section on importing below.
- moid String
- The managed object reference ID of the created virtual machine.
- power
State String - A computed value for the current power state of the virtual machine. One of
on
,off
, orsuspended
. - reboot
Required Boolean - Value internal to Terraform used to determine if a configuration set change requires a reboot.
- uuid String
- The UUID of the virtual disk VMDK file. This is used to track the virtual disk on the virtual machine.
- vapp
Transports List<String> - Computed value which is only valid for cloned virtual machines. A list of vApp transport methods supported by the source virtual machine or template.
- vmware
Tools StringStatus - The state of VMware Tools in the guest. This will determine the proper course of action for some device operations.
- vmx
Path String - The path of the virtual machine configuration file on the datastore in which the virtual machine is placed.
Look up Existing VirtualMachine Resource
Get an existing VirtualMachine resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: VirtualMachineState, opts?: CustomResourceOptions): VirtualMachine
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
alternate_guest_name: Optional[str] = None,
annotation: Optional[str] = None,
boot_delay: Optional[int] = None,
boot_retry_delay: Optional[int] = None,
boot_retry_enabled: Optional[bool] = None,
cdroms: Optional[Sequence[VirtualMachineCdromArgs]] = None,
change_version: Optional[str] = None,
clone: Optional[VirtualMachineCloneArgs] = None,
cpu_hot_add_enabled: Optional[bool] = None,
cpu_hot_remove_enabled: Optional[bool] = None,
cpu_limit: Optional[int] = None,
cpu_performance_counters_enabled: Optional[bool] = None,
cpu_reservation: Optional[int] = None,
cpu_share_count: Optional[int] = None,
cpu_share_level: Optional[str] = None,
custom_attributes: Optional[Mapping[str, str]] = None,
datacenter_id: Optional[str] = None,
datastore_cluster_id: Optional[str] = None,
datastore_id: Optional[str] = None,
default_ip_address: Optional[str] = None,
disks: Optional[Sequence[VirtualMachineDiskArgs]] = None,
efi_secure_boot_enabled: Optional[bool] = None,
enable_disk_uuid: Optional[bool] = None,
enable_logging: Optional[bool] = None,
ept_rvi_mode: Optional[str] = None,
extra_config: Optional[Mapping[str, str]] = None,
extra_config_reboot_required: Optional[bool] = None,
firmware: Optional[str] = None,
folder: Optional[str] = None,
force_power_off: Optional[bool] = None,
guest_id: Optional[str] = None,
guest_ip_addresses: Optional[Sequence[str]] = None,
hardware_version: Optional[int] = None,
host_system_id: Optional[str] = None,
hv_mode: Optional[str] = None,
ide_controller_count: Optional[int] = None,
ignored_guest_ips: Optional[Sequence[str]] = None,
imported: Optional[bool] = None,
latency_sensitivity: Optional[str] = None,
memory: Optional[int] = None,
memory_hot_add_enabled: Optional[bool] = None,
memory_limit: Optional[int] = None,
memory_reservation: Optional[int] = None,
memory_reservation_locked_to_max: Optional[bool] = None,
memory_share_count: Optional[int] = None,
memory_share_level: Optional[str] = None,
migrate_wait_timeout: Optional[int] = None,
moid: Optional[str] = None,
name: Optional[str] = None,
nested_hv_enabled: Optional[bool] = None,
network_interfaces: Optional[Sequence[VirtualMachineNetworkInterfaceArgs]] = None,
num_cores_per_socket: Optional[int] = None,
num_cpus: Optional[int] = None,
ovf_deploy: Optional[VirtualMachineOvfDeployArgs] = None,
pci_device_ids: Optional[Sequence[str]] = None,
power_state: Optional[str] = None,
poweron_timeout: Optional[int] = None,
reboot_required: Optional[bool] = None,
replace_trigger: Optional[str] = None,
resource_pool_id: Optional[str] = None,
run_tools_scripts_after_power_on: Optional[bool] = None,
run_tools_scripts_after_resume: Optional[bool] = None,
run_tools_scripts_before_guest_reboot: Optional[bool] = None,
run_tools_scripts_before_guest_shutdown: Optional[bool] = None,
run_tools_scripts_before_guest_standby: Optional[bool] = None,
sata_controller_count: Optional[int] = None,
scsi_bus_sharing: Optional[str] = None,
scsi_controller_count: Optional[int] = None,
scsi_type: Optional[str] = None,
shutdown_wait_timeout: Optional[int] = None,
storage_policy_id: Optional[str] = None,
swap_placement_policy: Optional[str] = None,
sync_time_with_host: Optional[bool] = None,
sync_time_with_host_periodically: Optional[bool] = None,
tags: Optional[Sequence[str]] = None,
tools_upgrade_policy: Optional[str] = None,
uuid: Optional[str] = None,
vapp: Optional[VirtualMachineVappArgs] = None,
vapp_transports: Optional[Sequence[str]] = None,
vbs_enabled: Optional[bool] = None,
vmware_tools_status: Optional[str] = None,
vmx_path: Optional[str] = None,
vvtd_enabled: Optional[bool] = None,
wait_for_guest_ip_timeout: Optional[int] = None,
wait_for_guest_net_routable: Optional[bool] = None,
wait_for_guest_net_timeout: Optional[int] = None) -> VirtualMachine
func GetVirtualMachine(ctx *Context, name string, id IDInput, state *VirtualMachineState, opts ...ResourceOption) (*VirtualMachine, error)
public static VirtualMachine Get(string name, Input<string> id, VirtualMachineState? state, CustomResourceOptions? opts = null)
public static VirtualMachine get(String name, Output<String> id, VirtualMachineState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Alternate
Guest stringName - The guest name for the operating system when
guest_id
isotherGuest
orotherGuest64
. - Annotation string
- A user-provided description of the virtual machine.
- Boot
Delay int - The number of milliseconds to wait before starting the boot sequence. The default is no delay.
- Boot
Retry intDelay - The number of milliseconds to wait before retrying the boot sequence. This option is only valid if
boot_retry_enabled
istrue
. Default:10000
(10 seconds). - Boot
Retry boolEnabled - If set to
true
, a virtual machine that fails to boot will try again after the delay defined inboot_retry_delay
. Default:false
. - Cdroms
List<Pulumi.
VSphere. Inputs. Virtual Machine Cdrom> - A specification for a CD-ROM device on the virtual machine. See CD-ROM options for more information.
- Change
Version string - A unique identifier for a given version of the last configuration was applied.
- Clone
Pulumi.
VSphere. Inputs. Virtual Machine Clone - When specified, the virtual machine will be created as a clone of a specified template. Optional customization options can be submitted for the resource. See creating a virtual machine from a template for more information.
- Cpu
Hot boolAdd Enabled - Allow CPUs to be added to the virtual machine while it is powered on.
- Cpu
Hot boolRemove Enabled - Allow CPUs to be removed to the virtual machine while it is powered on.
- Cpu
Limit int - The maximum amount of CPU (in MHz) that the virtual machine can consume, regardless of available resources. The default is no limit.
- Cpu
Performance boolCounters Enabled - Enable CPU performance counters on the virtual machine. Default:
false
. - Cpu
Reservation int - The amount of CPU (in MHz) that the virtual machine is guaranteed. The default is no reservation.
- int
- The number of CPU shares allocated to the virtual machine when the
cpu_share_level
iscustom
. - string
- The allocation level for the virtual machine CPU resources. One of
high
,low
,normal
, orcustom
. Default:custom
. - Custom
Attributes Dictionary<string, string> Map of custom attribute ids to attribute value strings to set for virtual machine. Please refer to the
vsphere_custom_attributes
resource for more information on setting custom attributes.NOTE: Custom attributes requires vCenter Server and is not supported on direct ESXi host connections.
- Datacenter
Id string - The datacenter ID. Required only when deploying an OVF/OVA template.
- Datastore
Cluster stringId The managed object reference ID of the datastore cluster in which to place the virtual machine. This setting applies to entire virtual machine and implies that you wish to use vSphere Storage DRS with the virtual machine. See the section on virtual machine migration for more information on modifying this value.
NOTE: One of
datastore_id
ordatastore_cluster_id
must be specified.NOTE: Use of
datastore_cluster_id
requires vSphere Storage DRS to be enabled on the specified datastore cluster.NOTE: The
datastore_cluster_id
setting applies to the entire virtual machine resource. You cannot assign individual individual disks to datastore clusters. In addition, you cannot use theattach
setting to attach external disks on virtual machines that are assigned to datastore clusters.- Datastore
Id string - The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with
client_device
. - Default
Ip stringAddress - The IP address selected by the provider to be used with any provisioners configured on this resource. When possible, this is the first IPv4 address that is reachable through the default gateway configured on the machine, then the first reachable IPv6 address, and then the first general discovered address if neither exists. If VMware Tools is not running on the virtual machine, or if the virtual machine is powered off, this value will be blank.
- Disks
List<Pulumi.
VSphere. Inputs. Virtual Machine Disk> - A specification for a virtual disk device on the virtual machine. See disk options for more information.
- Efi
Secure boolBoot Enabled Use this option to enable EFI secure boot when the
firmware
type is set to isefi
. Default:false
.NOTE: EFI secure boot is only available on vSphere 6.5 and later.
- Enable
Disk boolUuid - Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest. Default:
false
. - Enable
Logging bool - Enable logging of virtual machine events to a log file stored in the virtual machine directory. Default:
false
. - Ept
Rvi stringMode - The EPT/RVI (hardware memory virtualization) setting for the virtual machine. One of
automatic
,on
, oroff
. Default:automatic
. - Extra
Config Dictionary<string, string> Extra configuration data for the virtual machine. Can be used to supply advanced parameters not normally in configuration, such as instance metadata and userdata.
NOTE: Do not use
extra_config
when working with a template imported from OVF/OVA as your settings may be ignored. Use thevapp
blockproperties
section as described in Using vApp Properties for OVF/OVA Configuration.- Extra
Config boolReboot Required - Allow the virtual machine to be rebooted when a change to
extra_config
occurs. Default:true
. - Firmware string
- The firmware for the virtual machine. One of
bios
orefi
. - Folder string
- The path to the virtual machine folder in which to place the virtual machine, relative to the datacenter path (
/<datacenter-name>/vm
). For example,/dc-01/vm/foo
- Force
Power boolOff - If a guest shutdown failed or times out while updating or destroying (see
shutdown_wait_timeout
), force the power-off of the virtual machine. Default:true
. - Guest
Id string - The guest ID for the operating system type. For a full list of possible values, see here. Default:
otherGuest64
. - Guest
Ip List<string>Addresses - The current list of IP addresses on this machine, including the value of
default_ip_address
. If VMware Tools is not running on the virtual machine, or if the virtul machine is powered off, this list will be empty. - Hardware
Version int - The hardware version number. Valid range is from 4 to 21. The hardware version cannot be downgraded. See virtual machine hardware versions and compatibility for more information on supported settings.
- Host
System stringId - The managed object reference ID of a host on which to place the virtual machine. See the section on virtual machine migration for more information on modifying this value. When using a vSphere cluster, if a
host_system_id
is not supplied, vSphere will select a host in the cluster to place the virtual machine, according to any defaults or vSphere DRS placement policies. - Hv
Mode string - The hardware virtualization (non-nested) setting for the virtual machine. One of
hvAuto
,hvOn
, orhvOff
. Default:hvAuto
. - Ide
Controller intCount - The number of IDE controllers that the virtual machine. This directly affects the number of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers. Default:
2
. - Ignored
Guest List<string>Ips - List of IP addresses and CIDR networks to ignore while waiting for an available IP address using either of the waiters. Any IP addresses in this list will be ignored so that the waiter will continue to wait for a valid IP address. Default:
[]
. - Imported bool
- Indicates if the virtual machine resource has been imported, or if the state has been migrated from a previous version of the resource. It influences the behavior of the first post-import apply operation. See the section on importing below.
- Latency
Sensitivity string Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard devices. One of
low
,normal
,medium
, orhigh
.NOTE: On higher sensitivities, you may need to adjust the
memory_reservation
to the full amount of memory provisioned for the virtual machine.- Memory int
- The memory size to assign to the virtual machine, in MB. Default:
1024
(1 GB). - Memory
Hot boolAdd Enabled Allow memory to be added to the virtual machine while it is powered on.
NOTE: CPU and memory hot add options are not available on all guest operating systems. Please refer to the VMware Guest OS Compatibility Guide to which settings are allow for your guest operating system. In addition, at least one
pulumi up
must be run before you are able to use CPU and memory hot add.NOTE: For Linux 64-bit guest operating systems with less than or equal to 3GB, the virtual machine must powered off to add memory beyond 3GB. Subsequent hot add of memory does not require the virtual machine to be powered-off to apply the plan. Please refer to VMware KB 2008405.
- Memory
Limit int - The maximum amount of memory (in MB) that th virtual machine can consume, regardless of available resources. The default is no limit.
- Memory
Reservation int - The amount of memory (in MB) that the virtual machine is guaranteed. The default is no reservation.
- Memory
Reservation boolLocked To Max - If set true, memory resource reservation for this virtual machine will always be equal to the virtual machine's memory size;increases in memory size will be rejected when a corresponding reservation increase is not possible. This feature may only be enabled if it is currently possible to reserve all of the virtual machine's memory.
- int
- The number of memory shares allocated to the virtual machine when the
memory_share_level
iscustom
. - string
- The allocation level for the virtual machine memory resources. One of
high
,low
,normal
, orcustom
. Default:custom
. - Migrate
Wait intTimeout - The amount of time, in minutes, to wait for a virtual machine migration to complete before failing. Default:
10
minutes. See the section on virtual machine migration for more information. - Moid string
- The managed object reference ID of the created virtual machine.
- Name string
- The name of the virtual machine.
- Nested
Hv boolEnabled - Enable nested hardware virtualization on the virtual machine, facilitating nested virtualization in the guest operating system. Default:
false
. - Network
Interfaces List<Pulumi.VSphere. Inputs. Virtual Machine Network Interface> - A specification for a virtual NIC on the virtual machine. See network interface options for more information.
- Num
Cores intPer Socket - The number of cores per socket in the virtual machine. The number of vCPUs on the virtual machine will be
num_cpus
divided bynum_cores_per_socket
. If specified, the value supplied tonum_cpus
must be evenly divisible by this value. Default:1
. - Num
Cpus int - The total number of virtual processor cores to assign to the virtual machine. Default:
1
. - Ovf
Deploy Pulumi.VSphere. Inputs. Virtual Machine Ovf Deploy - When specified, the virtual machine will be deployed from the provided OVF/OVA template. See creating a virtual machine from an OVF/OVA template for more information.
- Pci
Device List<string>Ids List of host PCI device IDs in which to create PCI passthroughs.
NOTE: Cloning requires vCenter Server and is not supported on direct ESXi host connections.
- Power
State string - A computed value for the current power state of the virtual machine. One of
on
,off
, orsuspended
. - Poweron
Timeout int - The amount of time, in seconds, that we will be trying to power on a VM
- Reboot
Required bool - Value internal to Terraform used to determine if a configuration set change requires a reboot.
- Replace
Trigger string Triggers replacement of resource whenever it changes.
For example,
replace_trigger = sha256(format("%!s(MISSING)-%!s(MISSING)",data.template_file.cloud_init_metadata.rendered,data.template_file.cloud_init_userdata.rendered))
will fingerprint the changes in cloud-init metadata and userdata templates. This will enable a replacement of the resource whenever the dependant template renders a new configuration. (Forces a replacement.)- Resource
Pool stringId The managed object reference ID of the resource pool in which to place the virtual machine. See the Virtual Machine Migration section for more information on modifying this value.
NOTE: All clusters and standalone hosts have a default root resource pool. This resource argument does not directly accept the cluster or standalone host resource. For more information, see the section on specifying the Root Resource Pool in the
vsphere.ResourcePool
data source documentation on using the root resource pool.- Run
Tools boolScripts After Power On - Enable post-power-on scripts to run when VMware Tools is installed. Default:
true
. - Run
Tools boolScripts After Resume - Enable ost-resume scripts to run when VMware Tools is installed. Default:
true
. - Run
Tools boolScripts Before Guest Reboot - Enable pre-reboot scripts to run when VMware Tools is installed. Default:
false
. - Run
Tools boolScripts Before Guest Shutdown - Enable pre-shutdown scripts to run when VMware Tools is installed. Default:
true
. - Run
Tools boolScripts Before Guest Standby - Enable pre-standby scripts to run when VMware Tools is installed. Default:
true
. - Sata
Controller intCount - The number of SATA controllers that Terraform manages on this virtual machine. This directly affects the amount of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers.
- Scsi
Bus stringSharing - The type of SCSI bus sharing for the virtual machine SCSI controller. One of
physicalSharing
,virtualSharing
, andnoSharing
. Default:noSharing
. - Scsi
Controller intCount - The number of SCSI controllers that Terraform manages on this virtual machine. This directly affects the amount of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers.
- Scsi
Type string - The SCSI controller type for the virtual machine. One of
lsilogic
(LSI Logic Parallel),lsilogic-sas
(LSI Logic SAS) orpvscsi
(VMware Paravirtual). Default:pvscsi
. - Shutdown
Wait intTimeout - The amount of time, in minutes, to wait for a graceful guest shutdown when making necessary updates to the virtual machine. If
force_power_off
is set totrue
, the virtual machine will be forced to power-off after the timeout, otherwise an error is returned. Default:3
minutes. - Storage
Policy stringId - The UUID of the storage policy to assign to the virtual disk.
- Swap
Placement stringPolicy - The swap file placement policy for the virtual machine. One of
inherit
,hostLocal
, orvmDirectory
. Default:inherit
. - Sync
Time boolWith Host - Enable the guest operating system to synchronization its clock with the host when the virtual machine is powered on or resumed. Requires vSphere 7.0 Update 1 and later. Requires VMware Tools to be installed. Default:
true
. - Sync
Time boolWith Host Periodically - Enable the guest operating system to periodically synchronize its clock with the host. Requires vSphere 7.0 Update 1 and later. On previous versions, setting
sync_time_with_host
is will enable periodic synchronization. Requires VMware Tools to be installed. Default:false
. - List<string>
The IDs of any tags to attach to this resource. Please refer to the
vsphere.Tag
resource for more information on applying tags to virtual machine resources.NOTE: Tagging support is unsupported on direct ESXi host connections and requires vCenter Server instance.
- Tools
Upgrade stringPolicy - Enable automatic upgrade of the VMware Tools version when the virtual machine is rebooted. If necessary, VMware Tools is upgraded to the latest version supported by the host on which the virtual machine is running. Requires VMware Tools to be installed. One of
manual
orupgradeAtPowerCycle
. Default:manual
. - Uuid string
- The UUID of the virtual disk VMDK file. This is used to track the virtual disk on the virtual machine.
- Vapp
Pulumi.
VSphere. Inputs. Virtual Machine Vapp - Used for vApp configurations. The only sub-key available is
properties
, which is a key/value map of properties for virtual machines imported from and OVF/OVA. See Using vApp Properties for OVF/OVA Configuration for more information. - Vapp
Transports List<string> - Computed value which is only valid for cloned virtual machines. A list of vApp transport methods supported by the source virtual machine or template.
- Vbs
Enabled bool - Enable Virtualization Based Security. Requires
firmware
to beefi
. In addition,vvtd_enabled
,nested_hv_enabled
, andefi_secure_boot_enabled
must all have a value oftrue
. Supported on vSphere 6.7 and later. Default:false
. - Vmware
Tools stringStatus - The state of VMware Tools in the guest. This will determine the proper course of action for some device operations.
- Vmx
Path string - The path of the virtual machine configuration file on the datastore in which the virtual machine is placed.
- Vvtd
Enabled bool - Enable Intel Virtualization Technology for Directed I/O for the virtual machine (I/O MMU in the vSphere Client). Supported on vSphere 6.7 and later. Default:
false
. - Wait
For intGuest Ip Timeout - The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. This should only be used if the version VMware Tools does not allow the
wait_for_guest_net_timeout
waiter to be used. A value less than1
disables the waiter. Default:0
. - Wait
For boolGuest Net Routable - Controls whether or not the guest network waiter waits for a routable address. When
false
, the waiter does not wait for a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria. This property is ignored if thewait_for_guest_ip_timeout
waiter is used. Default:true
. - Wait
For intGuest Net Timeout - The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. Older versions of VMware Tools do not populate this property. In those cases, this waiter can be disabled and the
wait_for_guest_ip_timeout
waiter can be used instead. A value less than1
disables the waiter. Default:5
minutes.
- Alternate
Guest stringName - The guest name for the operating system when
guest_id
isotherGuest
orotherGuest64
. - Annotation string
- A user-provided description of the virtual machine.
- Boot
Delay int - The number of milliseconds to wait before starting the boot sequence. The default is no delay.
- Boot
Retry intDelay - The number of milliseconds to wait before retrying the boot sequence. This option is only valid if
boot_retry_enabled
istrue
. Default:10000
(10 seconds). - Boot
Retry boolEnabled - If set to
true
, a virtual machine that fails to boot will try again after the delay defined inboot_retry_delay
. Default:false
. - Cdroms
[]Virtual
Machine Cdrom Args - A specification for a CD-ROM device on the virtual machine. See CD-ROM options for more information.
- Change
Version string - A unique identifier for a given version of the last configuration was applied.
- Clone
Virtual
Machine Clone Args - When specified, the virtual machine will be created as a clone of a specified template. Optional customization options can be submitted for the resource. See creating a virtual machine from a template for more information.
- Cpu
Hot boolAdd Enabled - Allow CPUs to be added to the virtual machine while it is powered on.
- Cpu
Hot boolRemove Enabled - Allow CPUs to be removed to the virtual machine while it is powered on.
- Cpu
Limit int - The maximum amount of CPU (in MHz) that the virtual machine can consume, regardless of available resources. The default is no limit.
- Cpu
Performance boolCounters Enabled - Enable CPU performance counters on the virtual machine. Default:
false
. - Cpu
Reservation int - The amount of CPU (in MHz) that the virtual machine is guaranteed. The default is no reservation.
- int
- The number of CPU shares allocated to the virtual machine when the
cpu_share_level
iscustom
. - string
- The allocation level for the virtual machine CPU resources. One of
high
,low
,normal
, orcustom
. Default:custom
. - Custom
Attributes map[string]string Map of custom attribute ids to attribute value strings to set for virtual machine. Please refer to the
vsphere_custom_attributes
resource for more information on setting custom attributes.NOTE: Custom attributes requires vCenter Server and is not supported on direct ESXi host connections.
- Datacenter
Id string - The datacenter ID. Required only when deploying an OVF/OVA template.
- Datastore
Cluster stringId The managed object reference ID of the datastore cluster in which to place the virtual machine. This setting applies to entire virtual machine and implies that you wish to use vSphere Storage DRS with the virtual machine. See the section on virtual machine migration for more information on modifying this value.
NOTE: One of
datastore_id
ordatastore_cluster_id
must be specified.NOTE: Use of
datastore_cluster_id
requires vSphere Storage DRS to be enabled on the specified datastore cluster.NOTE: The
datastore_cluster_id
setting applies to the entire virtual machine resource. You cannot assign individual individual disks to datastore clusters. In addition, you cannot use theattach
setting to attach external disks on virtual machines that are assigned to datastore clusters.- Datastore
Id string - The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with
client_device
. - Default
Ip stringAddress - The IP address selected by the provider to be used with any provisioners configured on this resource. When possible, this is the first IPv4 address that is reachable through the default gateway configured on the machine, then the first reachable IPv6 address, and then the first general discovered address if neither exists. If VMware Tools is not running on the virtual machine, or if the virtual machine is powered off, this value will be blank.
- Disks
[]Virtual
Machine Disk Args - A specification for a virtual disk device on the virtual machine. See disk options for more information.
- Efi
Secure boolBoot Enabled Use this option to enable EFI secure boot when the
firmware
type is set to isefi
. Default:false
.NOTE: EFI secure boot is only available on vSphere 6.5 and later.
- Enable
Disk boolUuid - Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest. Default:
false
. - Enable
Logging bool - Enable logging of virtual machine events to a log file stored in the virtual machine directory. Default:
false
. - Ept
Rvi stringMode - The EPT/RVI (hardware memory virtualization) setting for the virtual machine. One of
automatic
,on
, oroff
. Default:automatic
. - Extra
Config map[string]string Extra configuration data for the virtual machine. Can be used to supply advanced parameters not normally in configuration, such as instance metadata and userdata.
NOTE: Do not use
extra_config
when working with a template imported from OVF/OVA as your settings may be ignored. Use thevapp
blockproperties
section as described in Using vApp Properties for OVF/OVA Configuration.- Extra
Config boolReboot Required - Allow the virtual machine to be rebooted when a change to
extra_config
occurs. Default:true
. - Firmware string
- The firmware for the virtual machine. One of
bios
orefi
. - Folder string
- The path to the virtual machine folder in which to place the virtual machine, relative to the datacenter path (
/<datacenter-name>/vm
). For example,/dc-01/vm/foo
- Force
Power boolOff - If a guest shutdown failed or times out while updating or destroying (see
shutdown_wait_timeout
), force the power-off of the virtual machine. Default:true
. - Guest
Id string - The guest ID for the operating system type. For a full list of possible values, see here. Default:
otherGuest64
. - Guest
Ip []stringAddresses - The current list of IP addresses on this machine, including the value of
default_ip_address
. If VMware Tools is not running on the virtual machine, or if the virtul machine is powered off, this list will be empty. - Hardware
Version int - The hardware version number. Valid range is from 4 to 21. The hardware version cannot be downgraded. See virtual machine hardware versions and compatibility for more information on supported settings.
- Host
System stringId - The managed object reference ID of a host on which to place the virtual machine. See the section on virtual machine migration for more information on modifying this value. When using a vSphere cluster, if a
host_system_id
is not supplied, vSphere will select a host in the cluster to place the virtual machine, according to any defaults or vSphere DRS placement policies. - Hv
Mode string - The hardware virtualization (non-nested) setting for the virtual machine. One of
hvAuto
,hvOn
, orhvOff
. Default:hvAuto
. - Ide
Controller intCount - The number of IDE controllers that the virtual machine. This directly affects the number of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers. Default:
2
. - Ignored
Guest []stringIps - List of IP addresses and CIDR networks to ignore while waiting for an available IP address using either of the waiters. Any IP addresses in this list will be ignored so that the waiter will continue to wait for a valid IP address. Default:
[]
. - Imported bool
- Indicates if the virtual machine resource has been imported, or if the state has been migrated from a previous version of the resource. It influences the behavior of the first post-import apply operation. See the section on importing below.
- Latency
Sensitivity string Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard devices. One of
low
,normal
,medium
, orhigh
.NOTE: On higher sensitivities, you may need to adjust the
memory_reservation
to the full amount of memory provisioned for the virtual machine.- Memory int
- The memory size to assign to the virtual machine, in MB. Default:
1024
(1 GB). - Memory
Hot boolAdd Enabled Allow memory to be added to the virtual machine while it is powered on.
NOTE: CPU and memory hot add options are not available on all guest operating systems. Please refer to the VMware Guest OS Compatibility Guide to which settings are allow for your guest operating system. In addition, at least one
pulumi up
must be run before you are able to use CPU and memory hot add.NOTE: For Linux 64-bit guest operating systems with less than or equal to 3GB, the virtual machine must powered off to add memory beyond 3GB. Subsequent hot add of memory does not require the virtual machine to be powered-off to apply the plan. Please refer to VMware KB 2008405.
- Memory
Limit int - The maximum amount of memory (in MB) that th virtual machine can consume, regardless of available resources. The default is no limit.
- Memory
Reservation int - The amount of memory (in MB) that the virtual machine is guaranteed. The default is no reservation.
- Memory
Reservation boolLocked To Max - If set true, memory resource reservation for this virtual machine will always be equal to the virtual machine's memory size;increases in memory size will be rejected when a corresponding reservation increase is not possible. This feature may only be enabled if it is currently possible to reserve all of the virtual machine's memory.
- int
- The number of memory shares allocated to the virtual machine when the
memory_share_level
iscustom
. - string
- The allocation level for the virtual machine memory resources. One of
high
,low
,normal
, orcustom
. Default:custom
. - Migrate
Wait intTimeout - The amount of time, in minutes, to wait for a virtual machine migration to complete before failing. Default:
10
minutes. See the section on virtual machine migration for more information. - Moid string
- The managed object reference ID of the created virtual machine.
- Name string
- The name of the virtual machine.
- Nested
Hv boolEnabled - Enable nested hardware virtualization on the virtual machine, facilitating nested virtualization in the guest operating system. Default:
false
. - Network
Interfaces []VirtualMachine Network Interface Args - A specification for a virtual NIC on the virtual machine. See network interface options for more information.
- Num
Cores intPer Socket - The number of cores per socket in the virtual machine. The number of vCPUs on the virtual machine will be
num_cpus
divided bynum_cores_per_socket
. If specified, the value supplied tonum_cpus
must be evenly divisible by this value. Default:1
. - Num
Cpus int - The total number of virtual processor cores to assign to the virtual machine. Default:
1
. - Ovf
Deploy VirtualMachine Ovf Deploy Args - When specified, the virtual machine will be deployed from the provided OVF/OVA template. See creating a virtual machine from an OVF/OVA template for more information.
- Pci
Device []stringIds List of host PCI device IDs in which to create PCI passthroughs.
NOTE: Cloning requires vCenter Server and is not supported on direct ESXi host connections.
- Power
State string - A computed value for the current power state of the virtual machine. One of
on
,off
, orsuspended
. - Poweron
Timeout int - The amount of time, in seconds, that we will be trying to power on a VM
- Reboot
Required bool - Value internal to Terraform used to determine if a configuration set change requires a reboot.
- Replace
Trigger string Triggers replacement of resource whenever it changes.
For example,
replace_trigger = sha256(format("%!s(MISSING)-%!s(MISSING)",data.template_file.cloud_init_metadata.rendered,data.template_file.cloud_init_userdata.rendered))
will fingerprint the changes in cloud-init metadata and userdata templates. This will enable a replacement of the resource whenever the dependant template renders a new configuration. (Forces a replacement.)- Resource
Pool stringId The managed object reference ID of the resource pool in which to place the virtual machine. See the Virtual Machine Migration section for more information on modifying this value.
NOTE: All clusters and standalone hosts have a default root resource pool. This resource argument does not directly accept the cluster or standalone host resource. For more information, see the section on specifying the Root Resource Pool in the
vsphere.ResourcePool
data source documentation on using the root resource pool.- Run
Tools boolScripts After Power On - Enable post-power-on scripts to run when VMware Tools is installed. Default:
true
. - Run
Tools boolScripts After Resume - Enable ost-resume scripts to run when VMware Tools is installed. Default:
true
. - Run
Tools boolScripts Before Guest Reboot - Enable pre-reboot scripts to run when VMware Tools is installed. Default:
false
. - Run
Tools boolScripts Before Guest Shutdown - Enable pre-shutdown scripts to run when VMware Tools is installed. Default:
true
. - Run
Tools boolScripts Before Guest Standby - Enable pre-standby scripts to run when VMware Tools is installed. Default:
true
. - Sata
Controller intCount - The number of SATA controllers that Terraform manages on this virtual machine. This directly affects the amount of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers.
- Scsi
Bus stringSharing - The type of SCSI bus sharing for the virtual machine SCSI controller. One of
physicalSharing
,virtualSharing
, andnoSharing
. Default:noSharing
. - Scsi
Controller intCount - The number of SCSI controllers that Terraform manages on this virtual machine. This directly affects the amount of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers.
- Scsi
Type string - The SCSI controller type for the virtual machine. One of
lsilogic
(LSI Logic Parallel),lsilogic-sas
(LSI Logic SAS) orpvscsi
(VMware Paravirtual). Default:pvscsi
. - Shutdown
Wait intTimeout - The amount of time, in minutes, to wait for a graceful guest shutdown when making necessary updates to the virtual machine. If
force_power_off
is set totrue
, the virtual machine will be forced to power-off after the timeout, otherwise an error is returned. Default:3
minutes. - Storage
Policy stringId - The UUID of the storage policy to assign to the virtual disk.
- Swap
Placement stringPolicy - The swap file placement policy for the virtual machine. One of
inherit
,hostLocal
, orvmDirectory
. Default:inherit
. - Sync
Time boolWith Host - Enable the guest operating system to synchronization its clock with the host when the virtual machine is powered on or resumed. Requires vSphere 7.0 Update 1 and later. Requires VMware Tools to be installed. Default:
true
. - Sync
Time boolWith Host Periodically - Enable the guest operating system to periodically synchronize its clock with the host. Requires vSphere 7.0 Update 1 and later. On previous versions, setting
sync_time_with_host
is will enable periodic synchronization. Requires VMware Tools to be installed. Default:false
. - []string
The IDs of any tags to attach to this resource. Please refer to the
vsphere.Tag
resource for more information on applying tags to virtual machine resources.NOTE: Tagging support is unsupported on direct ESXi host connections and requires vCenter Server instance.
- Tools
Upgrade stringPolicy - Enable automatic upgrade of the VMware Tools version when the virtual machine is rebooted. If necessary, VMware Tools is upgraded to the latest version supported by the host on which the virtual machine is running. Requires VMware Tools to be installed. One of
manual
orupgradeAtPowerCycle
. Default:manual
. - Uuid string
- The UUID of the virtual disk VMDK file. This is used to track the virtual disk on the virtual machine.
- Vapp
Virtual
Machine Vapp Args - Used for vApp configurations. The only sub-key available is
properties
, which is a key/value map of properties for virtual machines imported from and OVF/OVA. See Using vApp Properties for OVF/OVA Configuration for more information. - Vapp
Transports []string - Computed value which is only valid for cloned virtual machines. A list of vApp transport methods supported by the source virtual machine or template.
- Vbs
Enabled bool - Enable Virtualization Based Security. Requires
firmware
to beefi
. In addition,vvtd_enabled
,nested_hv_enabled
, andefi_secure_boot_enabled
must all have a value oftrue
. Supported on vSphere 6.7 and later. Default:false
. - Vmware
Tools stringStatus - The state of VMware Tools in the guest. This will determine the proper course of action for some device operations.
- Vmx
Path string - The path of the virtual machine configuration file on the datastore in which the virtual machine is placed.
- Vvtd
Enabled bool - Enable Intel Virtualization Technology for Directed I/O for the virtual machine (I/O MMU in the vSphere Client). Supported on vSphere 6.7 and later. Default:
false
. - Wait
For intGuest Ip Timeout - The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. This should only be used if the version VMware Tools does not allow the
wait_for_guest_net_timeout
waiter to be used. A value less than1
disables the waiter. Default:0
. - Wait
For boolGuest Net Routable - Controls whether or not the guest network waiter waits for a routable address. When
false
, the waiter does not wait for a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria. This property is ignored if thewait_for_guest_ip_timeout
waiter is used. Default:true
. - Wait
For intGuest Net Timeout - The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. Older versions of VMware Tools do not populate this property. In those cases, this waiter can be disabled and the
wait_for_guest_ip_timeout
waiter can be used instead. A value less than1
disables the waiter. Default:5
minutes.
- alternate
Guest StringName - The guest name for the operating system when
guest_id
isotherGuest
orotherGuest64
. - annotation String
- A user-provided description of the virtual machine.
- boot
Delay Integer - The number of milliseconds to wait before starting the boot sequence. The default is no delay.
- boot
Retry IntegerDelay - The number of milliseconds to wait before retrying the boot sequence. This option is only valid if
boot_retry_enabled
istrue
. Default:10000
(10 seconds). - boot
Retry BooleanEnabled - If set to
true
, a virtual machine that fails to boot will try again after the delay defined inboot_retry_delay
. Default:false
. - cdroms
List<Virtual
Machine Cdrom> - A specification for a CD-ROM device on the virtual machine. See CD-ROM options for more information.
- change
Version String - A unique identifier for a given version of the last configuration was applied.
- clone_
Virtual
Machine Clone - When specified, the virtual machine will be created as a clone of a specified template. Optional customization options can be submitted for the resource. See creating a virtual machine from a template for more information.
- cpu
Hot BooleanAdd Enabled - Allow CPUs to be added to the virtual machine while it is powered on.
- cpu
Hot BooleanRemove Enabled - Allow CPUs to be removed to the virtual machine while it is powered on.
- cpu
Limit Integer - The maximum amount of CPU (in MHz) that the virtual machine can consume, regardless of available resources. The default is no limit.
- cpu
Performance BooleanCounters Enabled - Enable CPU performance counters on the virtual machine. Default:
false
. - cpu
Reservation Integer - The amount of CPU (in MHz) that the virtual machine is guaranteed. The default is no reservation.
- Integer
- The number of CPU shares allocated to the virtual machine when the
cpu_share_level
iscustom
. - String
- The allocation level for the virtual machine CPU resources. One of
high
,low
,normal
, orcustom
. Default:custom
. - custom
Attributes Map<String,String> Map of custom attribute ids to attribute value strings to set for virtual machine. Please refer to the
vsphere_custom_attributes
resource for more information on setting custom attributes.NOTE: Custom attributes requires vCenter Server and is not supported on direct ESXi host connections.
- datacenter
Id String - The datacenter ID. Required only when deploying an OVF/OVA template.
- datastore
Cluster StringId The managed object reference ID of the datastore cluster in which to place the virtual machine. This setting applies to entire virtual machine and implies that you wish to use vSphere Storage DRS with the virtual machine. See the section on virtual machine migration for more information on modifying this value.
NOTE: One of
datastore_id
ordatastore_cluster_id
must be specified.NOTE: Use of
datastore_cluster_id
requires vSphere Storage DRS to be enabled on the specified datastore cluster.NOTE: The
datastore_cluster_id
setting applies to the entire virtual machine resource. You cannot assign individual individual disks to datastore clusters. In addition, you cannot use theattach
setting to attach external disks on virtual machines that are assigned to datastore clusters.- datastore
Id String - The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with
client_device
. - default
Ip StringAddress - The IP address selected by the provider to be used with any provisioners configured on this resource. When possible, this is the first IPv4 address that is reachable through the default gateway configured on the machine, then the first reachable IPv6 address, and then the first general discovered address if neither exists. If VMware Tools is not running on the virtual machine, or if the virtual machine is powered off, this value will be blank.
- disks
List<Virtual
Machine Disk> - A specification for a virtual disk device on the virtual machine. See disk options for more information.
- efi
Secure BooleanBoot Enabled Use this option to enable EFI secure boot when the
firmware
type is set to isefi
. Default:false
.NOTE: EFI secure boot is only available on vSphere 6.5 and later.
- enable
Disk BooleanUuid - Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest. Default:
false
. - enable
Logging Boolean - Enable logging of virtual machine events to a log file stored in the virtual machine directory. Default:
false
. - ept
Rvi StringMode - The EPT/RVI (hardware memory virtualization) setting for the virtual machine. One of
automatic
,on
, oroff
. Default:automatic
. - extra
Config Map<String,String> Extra configuration data for the virtual machine. Can be used to supply advanced parameters not normally in configuration, such as instance metadata and userdata.
NOTE: Do not use
extra_config
when working with a template imported from OVF/OVA as your settings may be ignored. Use thevapp
blockproperties
section as described in Using vApp Properties for OVF/OVA Configuration.- extra
Config BooleanReboot Required - Allow the virtual machine to be rebooted when a change to
extra_config
occurs. Default:true
. - firmware String
- The firmware for the virtual machine. One of
bios
orefi
. - folder String
- The path to the virtual machine folder in which to place the virtual machine, relative to the datacenter path (
/<datacenter-name>/vm
). For example,/dc-01/vm/foo
- force
Power BooleanOff - If a guest shutdown failed or times out while updating or destroying (see
shutdown_wait_timeout
), force the power-off of the virtual machine. Default:true
. - guest
Id String - The guest ID for the operating system type. For a full list of possible values, see here. Default:
otherGuest64
. - guest
Ip List<String>Addresses - The current list of IP addresses on this machine, including the value of
default_ip_address
. If VMware Tools is not running on the virtual machine, or if the virtul machine is powered off, this list will be empty. - hardware
Version Integer - The hardware version number. Valid range is from 4 to 21. The hardware version cannot be downgraded. See virtual machine hardware versions and compatibility for more information on supported settings.
- host
System StringId - The managed object reference ID of a host on which to place the virtual machine. See the section on virtual machine migration for more information on modifying this value. When using a vSphere cluster, if a
host_system_id
is not supplied, vSphere will select a host in the cluster to place the virtual machine, according to any defaults or vSphere DRS placement policies. - hv
Mode String - The hardware virtualization (non-nested) setting for the virtual machine. One of
hvAuto
,hvOn
, orhvOff
. Default:hvAuto
. - ide
Controller IntegerCount - The number of IDE controllers that the virtual machine. This directly affects the number of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers. Default:
2
. - ignored
Guest List<String>Ips - List of IP addresses and CIDR networks to ignore while waiting for an available IP address using either of the waiters. Any IP addresses in this list will be ignored so that the waiter will continue to wait for a valid IP address. Default:
[]
. - imported Boolean
- Indicates if the virtual machine resource has been imported, or if the state has been migrated from a previous version of the resource. It influences the behavior of the first post-import apply operation. See the section on importing below.
- latency
Sensitivity String Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard devices. One of
low
,normal
,medium
, orhigh
.NOTE: On higher sensitivities, you may need to adjust the
memory_reservation
to the full amount of memory provisioned for the virtual machine.- memory Integer
- The memory size to assign to the virtual machine, in MB. Default:
1024
(1 GB). - memory
Hot BooleanAdd Enabled Allow memory to be added to the virtual machine while it is powered on.
NOTE: CPU and memory hot add options are not available on all guest operating systems. Please refer to the VMware Guest OS Compatibility Guide to which settings are allow for your guest operating system. In addition, at least one
pulumi up
must be run before you are able to use CPU and memory hot add.NOTE: For Linux 64-bit guest operating systems with less than or equal to 3GB, the virtual machine must powered off to add memory beyond 3GB. Subsequent hot add of memory does not require the virtual machine to be powered-off to apply the plan. Please refer to VMware KB 2008405.
- memory
Limit Integer - The maximum amount of memory (in MB) that th virtual machine can consume, regardless of available resources. The default is no limit.
- memory
Reservation Integer - The amount of memory (in MB) that the virtual machine is guaranteed. The default is no reservation.
- memory
Reservation BooleanLocked To Max - If set true, memory resource reservation for this virtual machine will always be equal to the virtual machine's memory size;increases in memory size will be rejected when a corresponding reservation increase is not possible. This feature may only be enabled if it is currently possible to reserve all of the virtual machine's memory.
- Integer
- The number of memory shares allocated to the virtual machine when the
memory_share_level
iscustom
. - String
- The allocation level for the virtual machine memory resources. One of
high
,low
,normal
, orcustom
. Default:custom
. - migrate
Wait IntegerTimeout - The amount of time, in minutes, to wait for a virtual machine migration to complete before failing. Default:
10
minutes. See the section on virtual machine migration for more information. - moid String
- The managed object reference ID of the created virtual machine.
- name String
- The name of the virtual machine.
- nested
Hv BooleanEnabled - Enable nested hardware virtualization on the virtual machine, facilitating nested virtualization in the guest operating system. Default:
false
. - network
Interfaces List<VirtualMachine Network Interface> - A specification for a virtual NIC on the virtual machine. See network interface options for more information.
- num
Cores IntegerPer Socket - The number of cores per socket in the virtual machine. The number of vCPUs on the virtual machine will be
num_cpus
divided bynum_cores_per_socket
. If specified, the value supplied tonum_cpus
must be evenly divisible by this value. Default:1
. - num
Cpus Integer - The total number of virtual processor cores to assign to the virtual machine. Default:
1
. - ovf
Deploy VirtualMachine Ovf Deploy - When specified, the virtual machine will be deployed from the provided OVF/OVA template. See creating a virtual machine from an OVF/OVA template for more information.
- pci
Device List<String>Ids List of host PCI device IDs in which to create PCI passthroughs.
NOTE: Cloning requires vCenter Server and is not supported on direct ESXi host connections.
- power
State String - A computed value for the current power state of the virtual machine. One of
on
,off
, orsuspended
. - poweron
Timeout Integer - The amount of time, in seconds, that we will be trying to power on a VM
- reboot
Required Boolean - Value internal to Terraform used to determine if a configuration set change requires a reboot.
- replace
Trigger String Triggers replacement of resource whenever it changes.
For example,
replace_trigger = sha256(format("%!s(MISSING)-%!s(MISSING)",data.template_file.cloud_init_metadata.rendered,data.template_file.cloud_init_userdata.rendered))
will fingerprint the changes in cloud-init metadata and userdata templates. This will enable a replacement of the resource whenever the dependant template renders a new configuration. (Forces a replacement.)- resource
Pool StringId The managed object reference ID of the resource pool in which to place the virtual machine. See the Virtual Machine Migration section for more information on modifying this value.
NOTE: All clusters and standalone hosts have a default root resource pool. This resource argument does not directly accept the cluster or standalone host resource. For more information, see the section on specifying the Root Resource Pool in the
vsphere.ResourcePool
data source documentation on using the root resource pool.- run
Tools BooleanScripts After Power On - Enable post-power-on scripts to run when VMware Tools is installed. Default:
true
. - run
Tools BooleanScripts After Resume - Enable ost-resume scripts to run when VMware Tools is installed. Default:
true
. - run
Tools BooleanScripts Before Guest Reboot - Enable pre-reboot scripts to run when VMware Tools is installed. Default:
false
. - run
Tools BooleanScripts Before Guest Shutdown - Enable pre-shutdown scripts to run when VMware Tools is installed. Default:
true
. - run
Tools BooleanScripts Before Guest Standby - Enable pre-standby scripts to run when VMware Tools is installed. Default:
true
. - sata
Controller IntegerCount - The number of SATA controllers that Terraform manages on this virtual machine. This directly affects the amount of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers.
- scsi
Bus StringSharing - The type of SCSI bus sharing for the virtual machine SCSI controller. One of
physicalSharing
,virtualSharing
, andnoSharing
. Default:noSharing
. - scsi
Controller IntegerCount - The number of SCSI controllers that Terraform manages on this virtual machine. This directly affects the amount of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers.
- scsi
Type String - The SCSI controller type for the virtual machine. One of
lsilogic
(LSI Logic Parallel),lsilogic-sas
(LSI Logic SAS) orpvscsi
(VMware Paravirtual). Default:pvscsi
. - shutdown
Wait IntegerTimeout - The amount of time, in minutes, to wait for a graceful guest shutdown when making necessary updates to the virtual machine. If
force_power_off
is set totrue
, the virtual machine will be forced to power-off after the timeout, otherwise an error is returned. Default:3
minutes. - storage
Policy StringId - The UUID of the storage policy to assign to the virtual disk.
- swap
Placement StringPolicy - The swap file placement policy for the virtual machine. One of
inherit
,hostLocal
, orvmDirectory
. Default:inherit
. - sync
Time BooleanWith Host - Enable the guest operating system to synchronization its clock with the host when the virtual machine is powered on or resumed. Requires vSphere 7.0 Update 1 and later. Requires VMware Tools to be installed. Default:
true
. - sync
Time BooleanWith Host Periodically - Enable the guest operating system to periodically synchronize its clock with the host. Requires vSphere 7.0 Update 1 and later. On previous versions, setting
sync_time_with_host
is will enable periodic synchronization. Requires VMware Tools to be installed. Default:false
. - List<String>
The IDs of any tags to attach to this resource. Please refer to the
vsphere.Tag
resource for more information on applying tags to virtual machine resources.NOTE: Tagging support is unsupported on direct ESXi host connections and requires vCenter Server instance.
- tools
Upgrade StringPolicy - Enable automatic upgrade of the VMware Tools version when the virtual machine is rebooted. If necessary, VMware Tools is upgraded to the latest version supported by the host on which the virtual machine is running. Requires VMware Tools to be installed. One of
manual
orupgradeAtPowerCycle
. Default:manual
. - uuid String
- The UUID of the virtual disk VMDK file. This is used to track the virtual disk on the virtual machine.
- vapp
Virtual
Machine Vapp - Used for vApp configurations. The only sub-key available is
properties
, which is a key/value map of properties for virtual machines imported from and OVF/OVA. See Using vApp Properties for OVF/OVA Configuration for more information. - vapp
Transports List<String> - Computed value which is only valid for cloned virtual machines. A list of vApp transport methods supported by the source virtual machine or template.
- vbs
Enabled Boolean - Enable Virtualization Based Security. Requires
firmware
to beefi
. In addition,vvtd_enabled
,nested_hv_enabled
, andefi_secure_boot_enabled
must all have a value oftrue
. Supported on vSphere 6.7 and later. Default:false
. - vmware
Tools StringStatus - The state of VMware Tools in the guest. This will determine the proper course of action for some device operations.
- vmx
Path String - The path of the virtual machine configuration file on the datastore in which the virtual machine is placed.
- vvtd
Enabled Boolean - Enable Intel Virtualization Technology for Directed I/O for the virtual machine (I/O MMU in the vSphere Client). Supported on vSphere 6.7 and later. Default:
false
. - wait
For IntegerGuest Ip Timeout - The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. This should only be used if the version VMware Tools does not allow the
wait_for_guest_net_timeout
waiter to be used. A value less than1
disables the waiter. Default:0
. - wait
For BooleanGuest Net Routable - Controls whether or not the guest network waiter waits for a routable address. When
false
, the waiter does not wait for a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria. This property is ignored if thewait_for_guest_ip_timeout
waiter is used. Default:true
. - wait
For IntegerGuest Net Timeout - The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. Older versions of VMware Tools do not populate this property. In those cases, this waiter can be disabled and the
wait_for_guest_ip_timeout
waiter can be used instead. A value less than1
disables the waiter. Default:5
minutes.
- alternate
Guest stringName - The guest name for the operating system when
guest_id
isotherGuest
orotherGuest64
. - annotation string
- A user-provided description of the virtual machine.
- boot
Delay number - The number of milliseconds to wait before starting the boot sequence. The default is no delay.
- boot
Retry numberDelay - The number of milliseconds to wait before retrying the boot sequence. This option is only valid if
boot_retry_enabled
istrue
. Default:10000
(10 seconds). - boot
Retry booleanEnabled - If set to
true
, a virtual machine that fails to boot will try again after the delay defined inboot_retry_delay
. Default:false
. - cdroms
Virtual
Machine Cdrom[] - A specification for a CD-ROM device on the virtual machine. See CD-ROM options for more information.
- change
Version string - A unique identifier for a given version of the last configuration was applied.
- clone
Virtual
Machine Clone - When specified, the virtual machine will be created as a clone of a specified template. Optional customization options can be submitted for the resource. See creating a virtual machine from a template for more information.
- cpu
Hot booleanAdd Enabled - Allow CPUs to be added to the virtual machine while it is powered on.
- cpu
Hot booleanRemove Enabled - Allow CPUs to be removed to the virtual machine while it is powered on.
- cpu
Limit number - The maximum amount of CPU (in MHz) that the virtual machine can consume, regardless of available resources. The default is no limit.
- cpu
Performance booleanCounters Enabled - Enable CPU performance counters on the virtual machine. Default:
false
. - cpu
Reservation number - The amount of CPU (in MHz) that the virtual machine is guaranteed. The default is no reservation.
- number
- The number of CPU shares allocated to the virtual machine when the
cpu_share_level
iscustom
. - string
- The allocation level for the virtual machine CPU resources. One of
high
,low
,normal
, orcustom
. Default:custom
. - custom
Attributes {[key: string]: string} Map of custom attribute ids to attribute value strings to set for virtual machine. Please refer to the
vsphere_custom_attributes
resource for more information on setting custom attributes.NOTE: Custom attributes requires vCenter Server and is not supported on direct ESXi host connections.
- datacenter
Id string - The datacenter ID. Required only when deploying an OVF/OVA template.
- datastore
Cluster stringId The managed object reference ID of the datastore cluster in which to place the virtual machine. This setting applies to entire virtual machine and implies that you wish to use vSphere Storage DRS with the virtual machine. See the section on virtual machine migration for more information on modifying this value.
NOTE: One of
datastore_id
ordatastore_cluster_id
must be specified.NOTE: Use of
datastore_cluster_id
requires vSphere Storage DRS to be enabled on the specified datastore cluster.NOTE: The
datastore_cluster_id
setting applies to the entire virtual machine resource. You cannot assign individual individual disks to datastore clusters. In addition, you cannot use theattach
setting to attach external disks on virtual machines that are assigned to datastore clusters.- datastore
Id string - The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with
client_device
. - default
Ip stringAddress - The IP address selected by the provider to be used with any provisioners configured on this resource. When possible, this is the first IPv4 address that is reachable through the default gateway configured on the machine, then the first reachable IPv6 address, and then the first general discovered address if neither exists. If VMware Tools is not running on the virtual machine, or if the virtual machine is powered off, this value will be blank.
- disks
Virtual
Machine Disk[] - A specification for a virtual disk device on the virtual machine. See disk options for more information.
- efi
Secure booleanBoot Enabled Use this option to enable EFI secure boot when the
firmware
type is set to isefi
. Default:false
.NOTE: EFI secure boot is only available on vSphere 6.5 and later.
- enable
Disk booleanUuid - Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest. Default:
false
. - enable
Logging boolean - Enable logging of virtual machine events to a log file stored in the virtual machine directory. Default:
false
. - ept
Rvi stringMode - The EPT/RVI (hardware memory virtualization) setting for the virtual machine. One of
automatic
,on
, oroff
. Default:automatic
. - extra
Config {[key: string]: string} Extra configuration data for the virtual machine. Can be used to supply advanced parameters not normally in configuration, such as instance metadata and userdata.
NOTE: Do not use
extra_config
when working with a template imported from OVF/OVA as your settings may be ignored. Use thevapp
blockproperties
section as described in Using vApp Properties for OVF/OVA Configuration.- extra
Config booleanReboot Required - Allow the virtual machine to be rebooted when a change to
extra_config
occurs. Default:true
. - firmware string
- The firmware for the virtual machine. One of
bios
orefi
. - folder string
- The path to the virtual machine folder in which to place the virtual machine, relative to the datacenter path (
/<datacenter-name>/vm
). For example,/dc-01/vm/foo
- force
Power booleanOff - If a guest shutdown failed or times out while updating or destroying (see
shutdown_wait_timeout
), force the power-off of the virtual machine. Default:true
. - guest
Id string - The guest ID for the operating system type. For a full list of possible values, see here. Default:
otherGuest64
. - guest
Ip string[]Addresses - The current list of IP addresses on this machine, including the value of
default_ip_address
. If VMware Tools is not running on the virtual machine, or if the virtul machine is powered off, this list will be empty. - hardware
Version number - The hardware version number. Valid range is from 4 to 21. The hardware version cannot be downgraded. See virtual machine hardware versions and compatibility for more information on supported settings.
- host
System stringId - The managed object reference ID of a host on which to place the virtual machine. See the section on virtual machine migration for more information on modifying this value. When using a vSphere cluster, if a
host_system_id
is not supplied, vSphere will select a host in the cluster to place the virtual machine, according to any defaults or vSphere DRS placement policies. - hv
Mode string - The hardware virtualization (non-nested) setting for the virtual machine. One of
hvAuto
,hvOn
, orhvOff
. Default:hvAuto
. - ide
Controller numberCount - The number of IDE controllers that the virtual machine. This directly affects the number of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers. Default:
2
. - ignored
Guest string[]Ips - List of IP addresses and CIDR networks to ignore while waiting for an available IP address using either of the waiters. Any IP addresses in this list will be ignored so that the waiter will continue to wait for a valid IP address. Default:
[]
. - imported boolean
- Indicates if the virtual machine resource has been imported, or if the state has been migrated from a previous version of the resource. It influences the behavior of the first post-import apply operation. See the section on importing below.
- latency
Sensitivity string Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard devices. One of
low
,normal
,medium
, orhigh
.NOTE: On higher sensitivities, you may need to adjust the
memory_reservation
to the full amount of memory provisioned for the virtual machine.- memory number
- The memory size to assign to the virtual machine, in MB. Default:
1024
(1 GB). - memory
Hot booleanAdd Enabled Allow memory to be added to the virtual machine while it is powered on.
NOTE: CPU and memory hot add options are not available on all guest operating systems. Please refer to the VMware Guest OS Compatibility Guide to which settings are allow for your guest operating system. In addition, at least one
pulumi up
must be run before you are able to use CPU and memory hot add.NOTE: For Linux 64-bit guest operating systems with less than or equal to 3GB, the virtual machine must powered off to add memory beyond 3GB. Subsequent hot add of memory does not require the virtual machine to be powered-off to apply the plan. Please refer to VMware KB 2008405.
- memory
Limit number - The maximum amount of memory (in MB) that th virtual machine can consume, regardless of available resources. The default is no limit.
- memory
Reservation number - The amount of memory (in MB) that the virtual machine is guaranteed. The default is no reservation.
- memory
Reservation booleanLocked To Max - If set true, memory resource reservation for this virtual machine will always be equal to the virtual machine's memory size;increases in memory size will be rejected when a corresponding reservation increase is not possible. This feature may only be enabled if it is currently possible to reserve all of the virtual machine's memory.
- number
- The number of memory shares allocated to the virtual machine when the
memory_share_level
iscustom
. - string
- The allocation level for the virtual machine memory resources. One of
high
,low
,normal
, orcustom
. Default:custom
. - migrate
Wait numberTimeout - The amount of time, in minutes, to wait for a virtual machine migration to complete before failing. Default:
10
minutes. See the section on virtual machine migration for more information. - moid string
- The managed object reference ID of the created virtual machine.
- name string
- The name of the virtual machine.
- nested
Hv booleanEnabled - Enable nested hardware virtualization on the virtual machine, facilitating nested virtualization in the guest operating system. Default:
false
. - network
Interfaces VirtualMachine Network Interface[] - A specification for a virtual NIC on the virtual machine. See network interface options for more information.
- num
Cores numberPer Socket - The number of cores per socket in the virtual machine. The number of vCPUs on the virtual machine will be
num_cpus
divided bynum_cores_per_socket
. If specified, the value supplied tonum_cpus
must be evenly divisible by this value. Default:1
. - num
Cpus number - The total number of virtual processor cores to assign to the virtual machine. Default:
1
. - ovf
Deploy VirtualMachine Ovf Deploy - When specified, the virtual machine will be deployed from the provided OVF/OVA template. See creating a virtual machine from an OVF/OVA template for more information.
- pci
Device string[]Ids List of host PCI device IDs in which to create PCI passthroughs.
NOTE: Cloning requires vCenter Server and is not supported on direct ESXi host connections.
- power
State string - A computed value for the current power state of the virtual machine. One of
on
,off
, orsuspended
. - poweron
Timeout number - The amount of time, in seconds, that we will be trying to power on a VM
- reboot
Required boolean - Value internal to Terraform used to determine if a configuration set change requires a reboot.
- replace
Trigger string Triggers replacement of resource whenever it changes.
For example,
replace_trigger = sha256(format("%!s(MISSING)-%!s(MISSING)",data.template_file.cloud_init_metadata.rendered,data.template_file.cloud_init_userdata.rendered))
will fingerprint the changes in cloud-init metadata and userdata templates. This will enable a replacement of the resource whenever the dependant template renders a new configuration. (Forces a replacement.)- resource
Pool stringId The managed object reference ID of the resource pool in which to place the virtual machine. See the Virtual Machine Migration section for more information on modifying this value.
NOTE: All clusters and standalone hosts have a default root resource pool. This resource argument does not directly accept the cluster or standalone host resource. For more information, see the section on specifying the Root Resource Pool in the
vsphere.ResourcePool
data source documentation on using the root resource pool.- run
Tools booleanScripts After Power On - Enable post-power-on scripts to run when VMware Tools is installed. Default:
true
. - run
Tools booleanScripts After Resume - Enable ost-resume scripts to run when VMware Tools is installed. Default:
true
. - run
Tools booleanScripts Before Guest Reboot - Enable pre-reboot scripts to run when VMware Tools is installed. Default:
false
. - run
Tools booleanScripts Before Guest Shutdown - Enable pre-shutdown scripts to run when VMware Tools is installed. Default:
true
. - run
Tools booleanScripts Before Guest Standby - Enable pre-standby scripts to run when VMware Tools is installed. Default:
true
. - sata
Controller numberCount - The number of SATA controllers that Terraform manages on this virtual machine. This directly affects the amount of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers.
- scsi
Bus stringSharing - The type of SCSI bus sharing for the virtual machine SCSI controller. One of
physicalSharing
,virtualSharing
, andnoSharing
. Default:noSharing
. - scsi
Controller numberCount - The number of SCSI controllers that Terraform manages on this virtual machine. This directly affects the amount of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers.
- scsi
Type string - The SCSI controller type for the virtual machine. One of
lsilogic
(LSI Logic Parallel),lsilogic-sas
(LSI Logic SAS) orpvscsi
(VMware Paravirtual). Default:pvscsi
. - shutdown
Wait numberTimeout - The amount of time, in minutes, to wait for a graceful guest shutdown when making necessary updates to the virtual machine. If
force_power_off
is set totrue
, the virtual machine will be forced to power-off after the timeout, otherwise an error is returned. Default:3
minutes. - storage
Policy stringId - The UUID of the storage policy to assign to the virtual disk.
- swap
Placement stringPolicy - The swap file placement policy for the virtual machine. One of
inherit
,hostLocal
, orvmDirectory
. Default:inherit
. - sync
Time booleanWith Host - Enable the guest operating system to synchronization its clock with the host when the virtual machine is powered on or resumed. Requires vSphere 7.0 Update 1 and later. Requires VMware Tools to be installed. Default:
true
. - sync
Time booleanWith Host Periodically - Enable the guest operating system to periodically synchronize its clock with the host. Requires vSphere 7.0 Update 1 and later. On previous versions, setting
sync_time_with_host
is will enable periodic synchronization. Requires VMware Tools to be installed. Default:false
. - string[]
The IDs of any tags to attach to this resource. Please refer to the
vsphere.Tag
resource for more information on applying tags to virtual machine resources.NOTE: Tagging support is unsupported on direct ESXi host connections and requires vCenter Server instance.
- tools
Upgrade stringPolicy - Enable automatic upgrade of the VMware Tools version when the virtual machine is rebooted. If necessary, VMware Tools is upgraded to the latest version supported by the host on which the virtual machine is running. Requires VMware Tools to be installed. One of
manual
orupgradeAtPowerCycle
. Default:manual
. - uuid string
- The UUID of the virtual disk VMDK file. This is used to track the virtual disk on the virtual machine.
- vapp
Virtual
Machine Vapp - Used for vApp configurations. The only sub-key available is
properties
, which is a key/value map of properties for virtual machines imported from and OVF/OVA. See Using vApp Properties for OVF/OVA Configuration for more information. - vapp
Transports string[] - Computed value which is only valid for cloned virtual machines. A list of vApp transport methods supported by the source virtual machine or template.
- vbs
Enabled boolean - Enable Virtualization Based Security. Requires
firmware
to beefi
. In addition,vvtd_enabled
,nested_hv_enabled
, andefi_secure_boot_enabled
must all have a value oftrue
. Supported on vSphere 6.7 and later. Default:false
. - vmware
Tools stringStatus - The state of VMware Tools in the guest. This will determine the proper course of action for some device operations.
- vmx
Path string - The path of the virtual machine configuration file on the datastore in which the virtual machine is placed.
- vvtd
Enabled boolean - Enable Intel Virtualization Technology for Directed I/O for the virtual machine (I/O MMU in the vSphere Client). Supported on vSphere 6.7 and later. Default:
false
. - wait
For numberGuest Ip Timeout - The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. This should only be used if the version VMware Tools does not allow the
wait_for_guest_net_timeout
waiter to be used. A value less than1
disables the waiter. Default:0
. - wait
For booleanGuest Net Routable - Controls whether or not the guest network waiter waits for a routable address. When
false
, the waiter does not wait for a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria. This property is ignored if thewait_for_guest_ip_timeout
waiter is used. Default:true
. - wait
For numberGuest Net Timeout - The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. Older versions of VMware Tools do not populate this property. In those cases, this waiter can be disabled and the
wait_for_guest_ip_timeout
waiter can be used instead. A value less than1
disables the waiter. Default:5
minutes.
- alternate_
guest_ strname - The guest name for the operating system when
guest_id
isotherGuest
orotherGuest64
. - annotation str
- A user-provided description of the virtual machine.
- boot_
delay int - The number of milliseconds to wait before starting the boot sequence. The default is no delay.
- boot_
retry_ intdelay - The number of milliseconds to wait before retrying the boot sequence. This option is only valid if
boot_retry_enabled
istrue
. Default:10000
(10 seconds). - boot_
retry_ boolenabled - If set to
true
, a virtual machine that fails to boot will try again after the delay defined inboot_retry_delay
. Default:false
. - cdroms
Sequence[Virtual
Machine Cdrom Args] - A specification for a CD-ROM device on the virtual machine. See CD-ROM options for more information.
- change_
version str - A unique identifier for a given version of the last configuration was applied.
- clone
Virtual
Machine Clone Args - When specified, the virtual machine will be created as a clone of a specified template. Optional customization options can be submitted for the resource. See creating a virtual machine from a template for more information.
- cpu_
hot_ booladd_ enabled - Allow CPUs to be added to the virtual machine while it is powered on.
- cpu_
hot_ boolremove_ enabled - Allow CPUs to be removed to the virtual machine while it is powered on.
- cpu_
limit int - The maximum amount of CPU (in MHz) that the virtual machine can consume, regardless of available resources. The default is no limit.
- cpu_
performance_ boolcounters_ enabled - Enable CPU performance counters on the virtual machine. Default:
false
. - cpu_
reservation int - The amount of CPU (in MHz) that the virtual machine is guaranteed. The default is no reservation.
- int
- The number of CPU shares allocated to the virtual machine when the
cpu_share_level
iscustom
. - str
- The allocation level for the virtual machine CPU resources. One of
high
,low
,normal
, orcustom
. Default:custom
. - custom_
attributes Mapping[str, str] Map of custom attribute ids to attribute value strings to set for virtual machine. Please refer to the
vsphere_custom_attributes
resource for more information on setting custom attributes.NOTE: Custom attributes requires vCenter Server and is not supported on direct ESXi host connections.
- datacenter_
id str - The datacenter ID. Required only when deploying an OVF/OVA template.
- datastore_
cluster_ strid The managed object reference ID of the datastore cluster in which to place the virtual machine. This setting applies to entire virtual machine and implies that you wish to use vSphere Storage DRS with the virtual machine. See the section on virtual machine migration for more information on modifying this value.
NOTE: One of
datastore_id
ordatastore_cluster_id
must be specified.NOTE: Use of
datastore_cluster_id
requires vSphere Storage DRS to be enabled on the specified datastore cluster.NOTE: The
datastore_cluster_id
setting applies to the entire virtual machine resource. You cannot assign individual individual disks to datastore clusters. In addition, you cannot use theattach
setting to attach external disks on virtual machines that are assigned to datastore clusters.- datastore_
id str - The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with
client_device
. - default_
ip_ straddress - The IP address selected by the provider to be used with any provisioners configured on this resource. When possible, this is the first IPv4 address that is reachable through the default gateway configured on the machine, then the first reachable IPv6 address, and then the first general discovered address if neither exists. If VMware Tools is not running on the virtual machine, or if the virtual machine is powered off, this value will be blank.
- disks
Sequence[Virtual
Machine Disk Args] - A specification for a virtual disk device on the virtual machine. See disk options for more information.
- efi_
secure_ boolboot_ enabled Use this option to enable EFI secure boot when the
firmware
type is set to isefi
. Default:false
.NOTE: EFI secure boot is only available on vSphere 6.5 and later.
- enable_
disk_ booluuid - Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest. Default:
false
. - enable_
logging bool - Enable logging of virtual machine events to a log file stored in the virtual machine directory. Default:
false
. - ept_
rvi_ strmode - The EPT/RVI (hardware memory virtualization) setting for the virtual machine. One of
automatic
,on
, oroff
. Default:automatic
. - extra_
config Mapping[str, str] Extra configuration data for the virtual machine. Can be used to supply advanced parameters not normally in configuration, such as instance metadata and userdata.
NOTE: Do not use
extra_config
when working with a template imported from OVF/OVA as your settings may be ignored. Use thevapp
blockproperties
section as described in Using vApp Properties for OVF/OVA Configuration.- extra_
config_ boolreboot_ required - Allow the virtual machine to be rebooted when a change to
extra_config
occurs. Default:true
. - firmware str
- The firmware for the virtual machine. One of
bios
orefi
. - folder str
- The path to the virtual machine folder in which to place the virtual machine, relative to the datacenter path (
/<datacenter-name>/vm
). For example,/dc-01/vm/foo
- force_
power_ booloff - If a guest shutdown failed or times out while updating or destroying (see
shutdown_wait_timeout
), force the power-off of the virtual machine. Default:true
. - guest_
id str - The guest ID for the operating system type. For a full list of possible values, see here. Default:
otherGuest64
. - guest_
ip_ Sequence[str]addresses - The current list of IP addresses on this machine, including the value of
default_ip_address
. If VMware Tools is not running on the virtual machine, or if the virtul machine is powered off, this list will be empty. - hardware_
version int - The hardware version number. Valid range is from 4 to 21. The hardware version cannot be downgraded. See virtual machine hardware versions and compatibility for more information on supported settings.
- host_
system_ strid - The managed object reference ID of a host on which to place the virtual machine. See the section on virtual machine migration for more information on modifying this value. When using a vSphere cluster, if a
host_system_id
is not supplied, vSphere will select a host in the cluster to place the virtual machine, according to any defaults or vSphere DRS placement policies. - hv_
mode str - The hardware virtualization (non-nested) setting for the virtual machine. One of
hvAuto
,hvOn
, orhvOff
. Default:hvAuto
. - ide_
controller_ intcount - The number of IDE controllers that the virtual machine. This directly affects the number of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers. Default:
2
. - ignored_
guest_ Sequence[str]ips - List of IP addresses and CIDR networks to ignore while waiting for an available IP address using either of the waiters. Any IP addresses in this list will be ignored so that the waiter will continue to wait for a valid IP address. Default:
[]
. - imported bool
- Indicates if the virtual machine resource has been imported, or if the state has been migrated from a previous version of the resource. It influences the behavior of the first post-import apply operation. See the section on importing below.
- latency_
sensitivity str Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard devices. One of
low
,normal
,medium
, orhigh
.NOTE: On higher sensitivities, you may need to adjust the
memory_reservation
to the full amount of memory provisioned for the virtual machine.- memory int
- The memory size to assign to the virtual machine, in MB. Default:
1024
(1 GB). - memory_
hot_ booladd_ enabled Allow memory to be added to the virtual machine while it is powered on.
NOTE: CPU and memory hot add options are not available on all guest operating systems. Please refer to the VMware Guest OS Compatibility Guide to which settings are allow for your guest operating system. In addition, at least one
pulumi up
must be run before you are able to use CPU and memory hot add.NOTE: For Linux 64-bit guest operating systems with less than or equal to 3GB, the virtual machine must powered off to add memory beyond 3GB. Subsequent hot add of memory does not require the virtual machine to be powered-off to apply the plan. Please refer to VMware KB 2008405.
- memory_
limit int - The maximum amount of memory (in MB) that th virtual machine can consume, regardless of available resources. The default is no limit.
- memory_
reservation int - The amount of memory (in MB) that the virtual machine is guaranteed. The default is no reservation.
- memory_
reservation_ boollocked_ to_ max - If set true, memory resource reservation for this virtual machine will always be equal to the virtual machine's memory size;increases in memory size will be rejected when a corresponding reservation increase is not possible. This feature may only be enabled if it is currently possible to reserve all of the virtual machine's memory.
- int
- The number of memory shares allocated to the virtual machine when the
memory_share_level
iscustom
. - str
- The allocation level for the virtual machine memory resources. One of
high
,low
,normal
, orcustom
. Default:custom
. - migrate_
wait_ inttimeout - The amount of time, in minutes, to wait for a virtual machine migration to complete before failing. Default:
10
minutes. See the section on virtual machine migration for more information. - moid str
- The managed object reference ID of the created virtual machine.
- name str
- The name of the virtual machine.
- nested_
hv_ boolenabled - Enable nested hardware virtualization on the virtual machine, facilitating nested virtualization in the guest operating system. Default:
false
. - network_
interfaces Sequence[VirtualMachine Network Interface Args] - A specification for a virtual NIC on the virtual machine. See network interface options for more information.
- num_
cores_ intper_ socket - The number of cores per socket in the virtual machine. The number of vCPUs on the virtual machine will be
num_cpus
divided bynum_cores_per_socket
. If specified, the value supplied tonum_cpus
must be evenly divisible by this value. Default:1
. - num_
cpus int - The total number of virtual processor cores to assign to the virtual machine. Default:
1
. - ovf_
deploy VirtualMachine Ovf Deploy Args - When specified, the virtual machine will be deployed from the provided OVF/OVA template. See creating a virtual machine from an OVF/OVA template for more information.
- pci_
device_ Sequence[str]ids List of host PCI device IDs in which to create PCI passthroughs.
NOTE: Cloning requires vCenter Server and is not supported on direct ESXi host connections.
- power_
state str - A computed value for the current power state of the virtual machine. One of
on
,off
, orsuspended
. - poweron_
timeout int - The amount of time, in seconds, that we will be trying to power on a VM
- reboot_
required bool - Value internal to Terraform used to determine if a configuration set change requires a reboot.
- replace_
trigger str Triggers replacement of resource whenever it changes.
For example,
replace_trigger = sha256(format("%!s(MISSING)-%!s(MISSING)",data.template_file.cloud_init_metadata.rendered,data.template_file.cloud_init_userdata.rendered))
will fingerprint the changes in cloud-init metadata and userdata templates. This will enable a replacement of the resource whenever the dependant template renders a new configuration. (Forces a replacement.)- resource_
pool_ strid The managed object reference ID of the resource pool in which to place the virtual machine. See the Virtual Machine Migration section for more information on modifying this value.
NOTE: All clusters and standalone hosts have a default root resource pool. This resource argument does not directly accept the cluster or standalone host resource. For more information, see the section on specifying the Root Resource Pool in the
vsphere.ResourcePool
data source documentation on using the root resource pool.- run_
tools_ boolscripts_ after_ power_ on - Enable post-power-on scripts to run when VMware Tools is installed. Default:
true
. - run_
tools_ boolscripts_ after_ resume - Enable ost-resume scripts to run when VMware Tools is installed. Default:
true
. - run_
tools_ boolscripts_ before_ guest_ reboot - Enable pre-reboot scripts to run when VMware Tools is installed. Default:
false
. - run_
tools_ boolscripts_ before_ guest_ shutdown - Enable pre-shutdown scripts to run when VMware Tools is installed. Default:
true
. - run_
tools_ boolscripts_ before_ guest_ standby - Enable pre-standby scripts to run when VMware Tools is installed. Default:
true
. - sata_
controller_ intcount - The number of SATA controllers that Terraform manages on this virtual machine. This directly affects the amount of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers.
- scsi_
bus_ strsharing - The type of SCSI bus sharing for the virtual machine SCSI controller. One of
physicalSharing
,virtualSharing
, andnoSharing
. Default:noSharing
. - scsi_
controller_ intcount - The number of SCSI controllers that Terraform manages on this virtual machine. This directly affects the amount of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers.
- scsi_
type str - The SCSI controller type for the virtual machine. One of
lsilogic
(LSI Logic Parallel),lsilogic-sas
(LSI Logic SAS) orpvscsi
(VMware Paravirtual). Default:pvscsi
. - shutdown_
wait_ inttimeout - The amount of time, in minutes, to wait for a graceful guest shutdown when making necessary updates to the virtual machine. If
force_power_off
is set totrue
, the virtual machine will be forced to power-off after the timeout, otherwise an error is returned. Default:3
minutes. - storage_
policy_ strid - The UUID of the storage policy to assign to the virtual disk.
- swap_
placement_ strpolicy - The swap file placement policy for the virtual machine. One of
inherit
,hostLocal
, orvmDirectory
. Default:inherit
. - sync_
time_ boolwith_ host - Enable the guest operating system to synchronization its clock with the host when the virtual machine is powered on or resumed. Requires vSphere 7.0 Update 1 and later. Requires VMware Tools to be installed. Default:
true
. - sync_
time_ boolwith_ host_ periodically - Enable the guest operating system to periodically synchronize its clock with the host. Requires vSphere 7.0 Update 1 and later. On previous versions, setting
sync_time_with_host
is will enable periodic synchronization. Requires VMware Tools to be installed. Default:false
. - Sequence[str]
The IDs of any tags to attach to this resource. Please refer to the
vsphere.Tag
resource for more information on applying tags to virtual machine resources.NOTE: Tagging support is unsupported on direct ESXi host connections and requires vCenter Server instance.
- tools_
upgrade_ strpolicy - Enable automatic upgrade of the VMware Tools version when the virtual machine is rebooted. If necessary, VMware Tools is upgraded to the latest version supported by the host on which the virtual machine is running. Requires VMware Tools to be installed. One of
manual
orupgradeAtPowerCycle
. Default:manual
. - uuid str
- The UUID of the virtual disk VMDK file. This is used to track the virtual disk on the virtual machine.
- vapp
Virtual
Machine Vapp Args - Used for vApp configurations. The only sub-key available is
properties
, which is a key/value map of properties for virtual machines imported from and OVF/OVA. See Using vApp Properties for OVF/OVA Configuration for more information. - vapp_
transports Sequence[str] - Computed value which is only valid for cloned virtual machines. A list of vApp transport methods supported by the source virtual machine or template.
- vbs_
enabled bool - Enable Virtualization Based Security. Requires
firmware
to beefi
. In addition,vvtd_enabled
,nested_hv_enabled
, andefi_secure_boot_enabled
must all have a value oftrue
. Supported on vSphere 6.7 and later. Default:false
. - vmware_
tools_ strstatus - The state of VMware Tools in the guest. This will determine the proper course of action for some device operations.
- vmx_
path str - The path of the virtual machine configuration file on the datastore in which the virtual machine is placed.
- vvtd_
enabled bool - Enable Intel Virtualization Technology for Directed I/O for the virtual machine (I/O MMU in the vSphere Client). Supported on vSphere 6.7 and later. Default:
false
. - wait_
for_ intguest_ ip_ timeout - The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. This should only be used if the version VMware Tools does not allow the
wait_for_guest_net_timeout
waiter to be used. A value less than1
disables the waiter. Default:0
. - wait_
for_ boolguest_ net_ routable - Controls whether or not the guest network waiter waits for a routable address. When
false
, the waiter does not wait for a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria. This property is ignored if thewait_for_guest_ip_timeout
waiter is used. Default:true
. - wait_
for_ intguest_ net_ timeout - The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. Older versions of VMware Tools do not populate this property. In those cases, this waiter can be disabled and the
wait_for_guest_ip_timeout
waiter can be used instead. A value less than1
disables the waiter. Default:5
minutes.
- alternate
Guest StringName - The guest name for the operating system when
guest_id
isotherGuest
orotherGuest64
. - annotation String
- A user-provided description of the virtual machine.
- boot
Delay Number - The number of milliseconds to wait before starting the boot sequence. The default is no delay.
- boot
Retry NumberDelay - The number of milliseconds to wait before retrying the boot sequence. This option is only valid if
boot_retry_enabled
istrue
. Default:10000
(10 seconds). - boot
Retry BooleanEnabled - If set to
true
, a virtual machine that fails to boot will try again after the delay defined inboot_retry_delay
. Default:false
. - cdroms List<Property Map>
- A specification for a CD-ROM device on the virtual machine. See CD-ROM options for more information.
- change
Version String - A unique identifier for a given version of the last configuration was applied.
- clone Property Map
- When specified, the virtual machine will be created as a clone of a specified template. Optional customization options can be submitted for the resource. See creating a virtual machine from a template for more information.
- cpu
Hot BooleanAdd Enabled - Allow CPUs to be added to the virtual machine while it is powered on.
- cpu
Hot BooleanRemove Enabled - Allow CPUs to be removed to the virtual machine while it is powered on.
- cpu
Limit Number - The maximum amount of CPU (in MHz) that the virtual machine can consume, regardless of available resources. The default is no limit.
- cpu
Performance BooleanCounters Enabled - Enable CPU performance counters on the virtual machine. Default:
false
. - cpu
Reservation Number - The amount of CPU (in MHz) that the virtual machine is guaranteed. The default is no reservation.
- Number
- The number of CPU shares allocated to the virtual machine when the
cpu_share_level
iscustom
. - String
- The allocation level for the virtual machine CPU resources. One of
high
,low
,normal
, orcustom
. Default:custom
. - custom
Attributes Map<String> Map of custom attribute ids to attribute value strings to set for virtual machine. Please refer to the
vsphere_custom_attributes
resource for more information on setting custom attributes.NOTE: Custom attributes requires vCenter Server and is not supported on direct ESXi host connections.
- datacenter
Id String - The datacenter ID. Required only when deploying an OVF/OVA template.
- datastore
Cluster StringId The managed object reference ID of the datastore cluster in which to place the virtual machine. This setting applies to entire virtual machine and implies that you wish to use vSphere Storage DRS with the virtual machine. See the section on virtual machine migration for more information on modifying this value.
NOTE: One of
datastore_id
ordatastore_cluster_id
must be specified.NOTE: Use of
datastore_cluster_id
requires vSphere Storage DRS to be enabled on the specified datastore cluster.NOTE: The
datastore_cluster_id
setting applies to the entire virtual machine resource. You cannot assign individual individual disks to datastore clusters. In addition, you cannot use theattach
setting to attach external disks on virtual machines that are assigned to datastore clusters.- datastore
Id String - The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with
client_device
. - default
Ip StringAddress - The IP address selected by the provider to be used with any provisioners configured on this resource. When possible, this is the first IPv4 address that is reachable through the default gateway configured on the machine, then the first reachable IPv6 address, and then the first general discovered address if neither exists. If VMware Tools is not running on the virtual machine, or if the virtual machine is powered off, this value will be blank.
- disks List<Property Map>
- A specification for a virtual disk device on the virtual machine. See disk options for more information.
- efi
Secure BooleanBoot Enabled Use this option to enable EFI secure boot when the
firmware
type is set to isefi
. Default:false
.NOTE: EFI secure boot is only available on vSphere 6.5 and later.
- enable
Disk BooleanUuid - Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest. Default:
false
. - enable
Logging Boolean - Enable logging of virtual machine events to a log file stored in the virtual machine directory. Default:
false
. - ept
Rvi StringMode - The EPT/RVI (hardware memory virtualization) setting for the virtual machine. One of
automatic
,on
, oroff
. Default:automatic
. - extra
Config Map<String> Extra configuration data for the virtual machine. Can be used to supply advanced parameters not normally in configuration, such as instance metadata and userdata.
NOTE: Do not use
extra_config
when working with a template imported from OVF/OVA as your settings may be ignored. Use thevapp
blockproperties
section as described in Using vApp Properties for OVF/OVA Configuration.- extra
Config BooleanReboot Required - Allow the virtual machine to be rebooted when a change to
extra_config
occurs. Default:true
. - firmware String
- The firmware for the virtual machine. One of
bios
orefi
. - folder String
- The path to the virtual machine folder in which to place the virtual machine, relative to the datacenter path (
/<datacenter-name>/vm
). For example,/dc-01/vm/foo
- force
Power BooleanOff - If a guest shutdown failed or times out while updating or destroying (see
shutdown_wait_timeout
), force the power-off of the virtual machine. Default:true
. - guest
Id String - The guest ID for the operating system type. For a full list of possible values, see here. Default:
otherGuest64
. - guest
Ip List<String>Addresses - The current list of IP addresses on this machine, including the value of
default_ip_address
. If VMware Tools is not running on the virtual machine, or if the virtul machine is powered off, this list will be empty. - hardware
Version Number - The hardware version number. Valid range is from 4 to 21. The hardware version cannot be downgraded. See virtual machine hardware versions and compatibility for more information on supported settings.
- host
System StringId - The managed object reference ID of a host on which to place the virtual machine. See the section on virtual machine migration for more information on modifying this value. When using a vSphere cluster, if a
host_system_id
is not supplied, vSphere will select a host in the cluster to place the virtual machine, according to any defaults or vSphere DRS placement policies. - hv
Mode String - The hardware virtualization (non-nested) setting for the virtual machine. One of
hvAuto
,hvOn
, orhvOff
. Default:hvAuto
. - ide
Controller NumberCount - The number of IDE controllers that the virtual machine. This directly affects the number of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers. Default:
2
. - ignored
Guest List<String>Ips - List of IP addresses and CIDR networks to ignore while waiting for an available IP address using either of the waiters. Any IP addresses in this list will be ignored so that the waiter will continue to wait for a valid IP address. Default:
[]
. - imported Boolean
- Indicates if the virtual machine resource has been imported, or if the state has been migrated from a previous version of the resource. It influences the behavior of the first post-import apply operation. See the section on importing below.
- latency
Sensitivity String Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard devices. One of
low
,normal
,medium
, orhigh
.NOTE: On higher sensitivities, you may need to adjust the
memory_reservation
to the full amount of memory provisioned for the virtual machine.- memory Number
- The memory size to assign to the virtual machine, in MB. Default:
1024
(1 GB). - memory
Hot BooleanAdd Enabled Allow memory to be added to the virtual machine while it is powered on.
NOTE: CPU and memory hot add options are not available on all guest operating systems. Please refer to the VMware Guest OS Compatibility Guide to which settings are allow for your guest operating system. In addition, at least one
pulumi up
must be run before you are able to use CPU and memory hot add.NOTE: For Linux 64-bit guest operating systems with less than or equal to 3GB, the virtual machine must powered off to add memory beyond 3GB. Subsequent hot add of memory does not require the virtual machine to be powered-off to apply the plan. Please refer to VMware KB 2008405.
- memory
Limit Number - The maximum amount of memory (in MB) that th virtual machine can consume, regardless of available resources. The default is no limit.
- memory
Reservation Number - The amount of memory (in MB) that the virtual machine is guaranteed. The default is no reservation.
- memory
Reservation BooleanLocked To Max - If set true, memory resource reservation for this virtual machine will always be equal to the virtual machine's memory size;increases in memory size will be rejected when a corresponding reservation increase is not possible. This feature may only be enabled if it is currently possible to reserve all of the virtual machine's memory.
- Number
- The number of memory shares allocated to the virtual machine when the
memory_share_level
iscustom
. - String
- The allocation level for the virtual machine memory resources. One of
high
,low
,normal
, orcustom
. Default:custom
. - migrate
Wait NumberTimeout - The amount of time, in minutes, to wait for a virtual machine migration to complete before failing. Default:
10
minutes. See the section on virtual machine migration for more information. - moid String
- The managed object reference ID of the created virtual machine.
- name String
- The name of the virtual machine.
- nested
Hv BooleanEnabled - Enable nested hardware virtualization on the virtual machine, facilitating nested virtualization in the guest operating system. Default:
false
. - network
Interfaces List<Property Map> - A specification for a virtual NIC on the virtual machine. See network interface options for more information.
- num
Cores NumberPer Socket - The number of cores per socket in the virtual machine. The number of vCPUs on the virtual machine will be
num_cpus
divided bynum_cores_per_socket
. If specified, the value supplied tonum_cpus
must be evenly divisible by this value. Default:1
. - num
Cpus Number - The total number of virtual processor cores to assign to the virtual machine. Default:
1
. - ovf
Deploy Property Map - When specified, the virtual machine will be deployed from the provided OVF/OVA template. See creating a virtual machine from an OVF/OVA template for more information.
- pci
Device List<String>Ids List of host PCI device IDs in which to create PCI passthroughs.
NOTE: Cloning requires vCenter Server and is not supported on direct ESXi host connections.
- power
State String - A computed value for the current power state of the virtual machine. One of
on
,off
, orsuspended
. - poweron
Timeout Number - The amount of time, in seconds, that we will be trying to power on a VM
- reboot
Required Boolean - Value internal to Terraform used to determine if a configuration set change requires a reboot.
- replace
Trigger String Triggers replacement of resource whenever it changes.
For example,
replace_trigger = sha256(format("%!s(MISSING)-%!s(MISSING)",data.template_file.cloud_init_metadata.rendered,data.template_file.cloud_init_userdata.rendered))
will fingerprint the changes in cloud-init metadata and userdata templates. This will enable a replacement of the resource whenever the dependant template renders a new configuration. (Forces a replacement.)- resource
Pool StringId The managed object reference ID of the resource pool in which to place the virtual machine. See the Virtual Machine Migration section for more information on modifying this value.
NOTE: All clusters and standalone hosts have a default root resource pool. This resource argument does not directly accept the cluster or standalone host resource. For more information, see the section on specifying the Root Resource Pool in the
vsphere.ResourcePool
data source documentation on using the root resource pool.- run
Tools BooleanScripts After Power On - Enable post-power-on scripts to run when VMware Tools is installed. Default:
true
. - run
Tools BooleanScripts After Resume - Enable ost-resume scripts to run when VMware Tools is installed. Default:
true
. - run
Tools BooleanScripts Before Guest Reboot - Enable pre-reboot scripts to run when VMware Tools is installed. Default:
false
. - run
Tools BooleanScripts Before Guest Shutdown - Enable pre-shutdown scripts to run when VMware Tools is installed. Default:
true
. - run
Tools BooleanScripts Before Guest Standby - Enable pre-standby scripts to run when VMware Tools is installed. Default:
true
. - sata
Controller NumberCount - The number of SATA controllers that Terraform manages on this virtual machine. This directly affects the amount of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers.
- scsi
Bus StringSharing - The type of SCSI bus sharing for the virtual machine SCSI controller. One of
physicalSharing
,virtualSharing
, andnoSharing
. Default:noSharing
. - scsi
Controller NumberCount - The number of SCSI controllers that Terraform manages on this virtual machine. This directly affects the amount of disks you can add to the virtual machine and the maximum disk unit number. Note that lowering this value does not remove controllers.
- scsi
Type String - The SCSI controller type for the virtual machine. One of
lsilogic
(LSI Logic Parallel),lsilogic-sas
(LSI Logic SAS) orpvscsi
(VMware Paravirtual). Default:pvscsi
. - shutdown
Wait NumberTimeout - The amount of time, in minutes, to wait for a graceful guest shutdown when making necessary updates to the virtual machine. If
force_power_off
is set totrue
, the virtual machine will be forced to power-off after the timeout, otherwise an error is returned. Default:3
minutes. - storage
Policy StringId - The UUID of the storage policy to assign to the virtual disk.
- swap
Placement StringPolicy - The swap file placement policy for the virtual machine. One of
inherit
,hostLocal
, orvmDirectory
. Default:inherit
. - sync
Time BooleanWith Host - Enable the guest operating system to synchronization its clock with the host when the virtual machine is powered on or resumed. Requires vSphere 7.0 Update 1 and later. Requires VMware Tools to be installed. Default:
true
. - sync
Time BooleanWith Host Periodically - Enable the guest operating system to periodically synchronize its clock with the host. Requires vSphere 7.0 Update 1 and later. On previous versions, setting
sync_time_with_host
is will enable periodic synchronization. Requires VMware Tools to be installed. Default:false
. - List<String>
The IDs of any tags to attach to this resource. Please refer to the
vsphere.Tag
resource for more information on applying tags to virtual machine resources.NOTE: Tagging support is unsupported on direct ESXi host connections and requires vCenter Server instance.
- tools
Upgrade StringPolicy - Enable automatic upgrade of the VMware Tools version when the virtual machine is rebooted. If necessary, VMware Tools is upgraded to the latest version supported by the host on which the virtual machine is running. Requires VMware Tools to be installed. One of
manual
orupgradeAtPowerCycle
. Default:manual
. - uuid String
- The UUID of the virtual disk VMDK file. This is used to track the virtual disk on the virtual machine.
- vapp Property Map
- Used for vApp configurations. The only sub-key available is
properties
, which is a key/value map of properties for virtual machines imported from and OVF/OVA. See Using vApp Properties for OVF/OVA Configuration for more information. - vapp
Transports List<String> - Computed value which is only valid for cloned virtual machines. A list of vApp transport methods supported by the source virtual machine or template.
- vbs
Enabled Boolean - Enable Virtualization Based Security. Requires
firmware
to beefi
. In addition,vvtd_enabled
,nested_hv_enabled
, andefi_secure_boot_enabled
must all have a value oftrue
. Supported on vSphere 6.7 and later. Default:false
. - vmware
Tools StringStatus - The state of VMware Tools in the guest. This will determine the proper course of action for some device operations.
- vmx
Path String - The path of the virtual machine configuration file on the datastore in which the virtual machine is placed.
- vvtd
Enabled Boolean - Enable Intel Virtualization Technology for Directed I/O for the virtual machine (I/O MMU in the vSphere Client). Supported on vSphere 6.7 and later. Default:
false
. - wait
For NumberGuest Ip Timeout - The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. This should only be used if the version VMware Tools does not allow the
wait_for_guest_net_timeout
waiter to be used. A value less than1
disables the waiter. Default:0
. - wait
For BooleanGuest Net Routable - Controls whether or not the guest network waiter waits for a routable address. When
false
, the waiter does not wait for a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria. This property is ignored if thewait_for_guest_ip_timeout
waiter is used. Default:true
. - wait
For NumberGuest Net Timeout - The amount of time, in minutes, to wait for an available guest IP address on the virtual machine. Older versions of VMware Tools do not populate this property. In those cases, this waiter can be disabled and the
wait_for_guest_ip_timeout
waiter can be used instead. A value less than1
disables the waiter. Default:5
minutes.
Supporting Types
VirtualMachineCdrom, VirtualMachineCdromArgs
- Client
Device bool - Indicates whether the device should be backed by remote client device. Conflicts with
datastore_id
andpath
. - Datastore
Id string - The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with
client_device
. - Device
Address string - The internally-computed address of this device, such as scsi:0:1, denoting scsi bus #0 and device unit 1.
- Key int
- The ID of the device within the virtual machine.
- Path string
The path to the ISO file. Required for using a datastore ISO. Conflicts with
client_device
.NOTE: Either
client_device
(for a remote backed CD-ROM) ordatastore_id
andpath
(for a datastore ISO backed CD-ROM) are required to .NOTE: Some CD-ROM drive types are not supported by this resource, such as pass-through devices. If these drives are present in a cloned template, or added outside of the provider, the desired state will be corrected to the defined device, or removed if no
cdrom
block is present.
- Client
Device bool - Indicates whether the device should be backed by remote client device. Conflicts with
datastore_id
andpath
. - Datastore
Id string - The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with
client_device
. - Device
Address string - The internally-computed address of this device, such as scsi:0:1, denoting scsi bus #0 and device unit 1.
- Key int
- The ID of the device within the virtual machine.
- Path string
The path to the ISO file. Required for using a datastore ISO. Conflicts with
client_device
.NOTE: Either
client_device
(for a remote backed CD-ROM) ordatastore_id
andpath
(for a datastore ISO backed CD-ROM) are required to .NOTE: Some CD-ROM drive types are not supported by this resource, such as pass-through devices. If these drives are present in a cloned template, or added outside of the provider, the desired state will be corrected to the defined device, or removed if no
cdrom
block is present.
- client
Device Boolean - Indicates whether the device should be backed by remote client device. Conflicts with
datastore_id
andpath
. - datastore
Id String - The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with
client_device
. - device
Address String - The internally-computed address of this device, such as scsi:0:1, denoting scsi bus #0 and device unit 1.
- key Integer
- The ID of the device within the virtual machine.
- path String
The path to the ISO file. Required for using a datastore ISO. Conflicts with
client_device
.NOTE: Either
client_device
(for a remote backed CD-ROM) ordatastore_id
andpath
(for a datastore ISO backed CD-ROM) are required to .NOTE: Some CD-ROM drive types are not supported by this resource, such as pass-through devices. If these drives are present in a cloned template, or added outside of the provider, the desired state will be corrected to the defined device, or removed if no
cdrom
block is present.
- client
Device boolean - Indicates whether the device should be backed by remote client device. Conflicts with
datastore_id
andpath
. - datastore
Id string - The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with
client_device
. - device
Address string - The internally-computed address of this device, such as scsi:0:1, denoting scsi bus #0 and device unit 1.
- key number
- The ID of the device within the virtual machine.
- path string
The path to the ISO file. Required for using a datastore ISO. Conflicts with
client_device
.NOTE: Either
client_device
(for a remote backed CD-ROM) ordatastore_id
andpath
(for a datastore ISO backed CD-ROM) are required to .NOTE: Some CD-ROM drive types are not supported by this resource, such as pass-through devices. If these drives are present in a cloned template, or added outside of the provider, the desired state will be corrected to the defined device, or removed if no
cdrom
block is present.
- client_
device bool - Indicates whether the device should be backed by remote client device. Conflicts with
datastore_id
andpath
. - datastore_
id str - The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with
client_device
. - device_
address str - The internally-computed address of this device, such as scsi:0:1, denoting scsi bus #0 and device unit 1.
- key int
- The ID of the device within the virtual machine.
- path str
The path to the ISO file. Required for using a datastore ISO. Conflicts with
client_device
.NOTE: Either
client_device
(for a remote backed CD-ROM) ordatastore_id
andpath
(for a datastore ISO backed CD-ROM) are required to .NOTE: Some CD-ROM drive types are not supported by this resource, such as pass-through devices. If these drives are present in a cloned template, or added outside of the provider, the desired state will be corrected to the defined device, or removed if no
cdrom
block is present.
- client
Device Boolean - Indicates whether the device should be backed by remote client device. Conflicts with
datastore_id
andpath
. - datastore
Id String - The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with
client_device
. - device
Address String - The internally-computed address of this device, such as scsi:0:1, denoting scsi bus #0 and device unit 1.
- key Number
- The ID of the device within the virtual machine.
- path String
The path to the ISO file. Required for using a datastore ISO. Conflicts with
client_device
.NOTE: Either
client_device
(for a remote backed CD-ROM) ordatastore_id
andpath
(for a datastore ISO backed CD-ROM) are required to .NOTE: Some CD-ROM drive types are not supported by this resource, such as pass-through devices. If these drives are present in a cloned template, or added outside of the provider, the desired state will be corrected to the defined device, or removed if no
cdrom
block is present.
VirtualMachineClone, VirtualMachineCloneArgs
- Template
Uuid string - The UUID of the source virtual machine or template.
- Customization
Spec Pulumi.VSphere. Inputs. Virtual Machine Clone Customization Spec - The customization specification for the virtual machine post-clone.
- Customize
Pulumi.
VSphere. Inputs. Virtual Machine Clone Customize - The customization specification for the virtual machine post-clone.
- Linked
Clone bool - 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.
- Ovf
Network Dictionary<string, string>Map - Mapping of ovf networks to the networks to use in vSphere.
- Ovf
Storage Dictionary<string, string>Map - Mapping of ovf storage to the datastores to use in vSphere.
- Timeout int
- The timeout, in minutes, to wait for the virtual machine clone to complete.
- Template
Uuid string - The UUID of the source virtual machine or template.
- Customization
Spec VirtualMachine Clone Customization Spec - The customization specification for the virtual machine post-clone.
- Customize
Virtual
Machine Clone Customize - The customization specification for the virtual machine post-clone.
- Linked
Clone bool - 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.
- Ovf
Network map[string]stringMap - Mapping of ovf networks to the networks to use in vSphere.
- Ovf
Storage map[string]stringMap - Mapping of ovf storage to the datastores to use in vSphere.
- Timeout int
- The timeout, in minutes, to wait for the virtual machine clone to complete.
- template
Uuid String - The UUID of the source virtual machine or template.
- customization
Spec VirtualMachine Clone Customization Spec - The customization specification for the virtual machine post-clone.
- customize
Virtual
Machine Clone Customize - The customization specification for the virtual machine post-clone.
- linked
Clone Boolean - 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.
- ovf
Network Map<String,String>Map - Mapping of ovf networks to the networks to use in vSphere.
- ovf
Storage Map<String,String>Map - Mapping of ovf storage to the datastores to use in vSphere.
- timeout Integer
- The timeout, in minutes, to wait for the virtual machine clone to complete.
- template
Uuid string - The UUID of the source virtual machine or template.
- customization
Spec VirtualMachine Clone Customization Spec - The customization specification for the virtual machine post-clone.
- customize
Virtual
Machine Clone Customize - The customization specification for the virtual machine post-clone.
- linked
Clone boolean - 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.
- ovf
Network {[key: string]: string}Map - Mapping of ovf networks to the networks to use in vSphere.
- ovf
Storage {[key: string]: string}Map - Mapping of ovf storage to the datastores to use in vSphere.
- timeout number
- The timeout, in minutes, to wait for the virtual machine clone to complete.
- template_
uuid str - The UUID of the source virtual machine or template.
- customization_
spec VirtualMachine Clone Customization Spec - The customization specification for the virtual machine post-clone.
- customize
Virtual
Machine Clone Customize - The customization specification for the virtual machine post-clone.
- linked_
clone bool - 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.
- ovf_
network_ Mapping[str, str]map - Mapping of ovf networks to the networks to use in vSphere.
- ovf_
storage_ Mapping[str, str]map - Mapping of ovf storage to the datastores to use in vSphere.
- timeout int
- The timeout, in minutes, to wait for the virtual machine clone to complete.
- template
Uuid String - The UUID of the source virtual machine or template.
- customization
Spec Property Map - The customization specification for the virtual machine post-clone.
- customize Property Map
- The customization specification for the virtual machine post-clone.
- linked
Clone Boolean - 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.
- ovf
Network Map<String>Map - Mapping of ovf networks to the networks to use in vSphere.
- ovf
Storage Map<String>Map - Mapping of ovf storage to the datastores to use in vSphere.
- timeout Number
- The timeout, in minutes, to wait for the virtual machine clone to complete.
VirtualMachineCloneCustomizationSpec, VirtualMachineCloneCustomizationSpecArgs
VirtualMachineCloneCustomize, VirtualMachineCloneCustomizeArgs
- Dns
Server List<string>Lists - The list of DNS servers for a virtual network adapter with a static IP address.
- Dns
Suffix List<string>Lists - A list of DNS search domains to add to the DNS configuration on the virtual machine.
- Ipv4Gateway string
- 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.
- Ipv6Gateway string
- 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.
- Linux
Options Pulumi.VSphere. Inputs. Virtual Machine Clone Customize Linux Options - A list of configuration options specific to Linux virtual machines.
- Network
Interfaces List<Pulumi.VSphere. Inputs. Virtual Machine Clone Customize Network Interface> - A specification for a virtual NIC on the virtual machine. See network interface options for more information.
- Timeout int
- 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.
- Windows
Options Pulumi.VSphere. Inputs. Virtual Machine Clone Customize Windows Options - A list of configuration options specific to Windows virtual machines.
- Windows
Sysprep stringText - Use this option to specify a windows sysprep file directly.
- Dns
Server []stringLists - The list of DNS servers for a virtual network adapter with a static IP address.
- Dns
Suffix []stringLists - A list of DNS search domains to add to the DNS configuration on the virtual machine.
- Ipv4Gateway string
- 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.
- Ipv6Gateway string
- 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.
- Linux
Options VirtualMachine Clone Customize Linux Options - A list of configuration options specific to Linux virtual machines.
- Network
Interfaces []VirtualMachine Clone Customize Network Interface - A specification for a virtual NIC on the virtual machine. See network interface options for more information.
- Timeout int
- 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.
- Windows
Options VirtualMachine Clone Customize Windows Options - A list of configuration options specific to Windows virtual machines.
- Windows
Sysprep stringText - Use this option to specify a windows sysprep file directly.
- dns
Server List<String>Lists - The list of DNS servers for a virtual network adapter with a static IP address.
- dns
Suffix List<String>Lists - A list of DNS search domains to add to the DNS configuration on the virtual machine.
- ipv4Gateway String
- 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.
- ipv6Gateway String
- 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.
- linux
Options VirtualMachine Clone Customize Linux Options - A list of configuration options specific to Linux virtual machines.
- network
Interfaces List<VirtualMachine Clone Customize Network Interface> - A specification for a virtual NIC on the virtual machine. See network interface options for more information.
- timeout Integer
- 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.
- windows
Options VirtualMachine Clone Customize Windows Options - A list of configuration options specific to Windows virtual machines.
- windows
Sysprep StringText - Use this option to specify a windows sysprep file directly.
- dns
Server string[]Lists - The list of DNS servers for a virtual network adapter with a static IP address.
- dns
Suffix string[]Lists - A list of DNS search domains to add to the DNS configuration on the virtual machine.
- ipv4Gateway string
- 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.
- ipv6Gateway string
- 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.
- linux
Options VirtualMachine Clone Customize Linux Options - A list of configuration options specific to Linux virtual machines.
- network
Interfaces VirtualMachine Clone Customize Network Interface[] - A specification for a virtual NIC on the virtual machine. See network interface options for more information.
- timeout number
- 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.
- windows
Options VirtualMachine Clone Customize Windows Options - A list of configuration options specific to Windows virtual machines.
- windows
Sysprep stringText - Use this option to specify a windows sysprep file directly.
- dns_
server_ Sequence[str]lists - The list of DNS servers for a virtual network adapter with a static IP address.
- dns_
suffix_ Sequence[str]lists - A list of DNS search domains to add to the DNS configuration on the virtual machine.
- ipv4_
gateway str - 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.
- ipv6_
gateway str - 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.
- linux_
options VirtualMachine Clone Customize Linux Options - A list of configuration options specific to Linux virtual machines.
- network_
interfaces Sequence[VirtualMachine Clone Customize Network Interface] - A specification for a virtual NIC on the virtual machine. See network interface options for more information.
- timeout int
- 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.
- windows_
options VirtualMachine Clone Customize Windows Options - A list of configuration options specific to Windows virtual machines.
- windows_
sysprep_ strtext - Use this option to specify a windows sysprep file directly.
- dns
Server List<String>Lists - The list of DNS servers for a virtual network adapter with a static IP address.
- dns
Suffix List<String>Lists - A list of DNS search domains to add to the DNS configuration on the virtual machine.
- ipv4Gateway String
- 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.
- ipv6Gateway String
- 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.
- linux
Options Property Map - A list of configuration options specific to Linux virtual machines.
- network
Interfaces List<Property Map> - A specification for a virtual NIC on the virtual machine. See network interface options for more information.
- timeout Number
- 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.
- windows
Options Property Map - A list of configuration options specific to Windows virtual machines.
- windows
Sysprep StringText - Use this option to specify a windows sysprep file directly.
VirtualMachineCloneCustomizeLinuxOptions, VirtualMachineCloneCustomizeLinuxOptionsArgs
- Domain string
- The domain name for this virtual machine.
- Host
Name string - The hostname for this virtual machine.
- Hw
Clock boolUtc - Specifies whether or not the hardware clock should be in UTC or not.
- Script
Text string - The customization script to run before and or after guest customization
- Time
Zone string - Customize the time zone on the VM. This should be a time zone-style entry, like America/Los_Angeles.
- Domain string
- The domain name for this virtual machine.
- Host
Name string - The hostname for this virtual machine.
- Hw
Clock boolUtc - Specifies whether or not the hardware clock should be in UTC or not.
- Script
Text string - The customization script to run before and or after guest customization
- Time
Zone string - Customize the time zone on the VM. This should be a time zone-style entry, like America/Los_Angeles.
- domain String
- The domain name for this virtual machine.
- host
Name String - The hostname for this virtual machine.
- hw
Clock BooleanUtc - Specifies whether or not the hardware clock should be in UTC or not.
- script
Text String - The customization script to run before and or after guest customization
- time
Zone String - Customize the time zone on the VM. This should be a time zone-style entry, like America/Los_Angeles.
- domain string
- The domain name for this virtual machine.
- host
Name string - The hostname for this virtual machine.
- hw
Clock booleanUtc - Specifies whether or not the hardware clock should be in UTC or not.
- script
Text string - The customization script to run before and or after guest customization
- time
Zone string - Customize the time zone on the VM. This should be a time zone-style entry, like America/Los_Angeles.
- domain str
- The domain name for this virtual machine.
- host_
name str - The hostname for this virtual machine.
- hw_
clock_ boolutc - Specifies whether or not the hardware clock should be in UTC or not.
- script_
text str - The customization script to run before and or after guest customization
- time_
zone str - Customize the time zone on the VM. This should be a time zone-style entry, like America/Los_Angeles.
- domain String
- The domain name for this virtual machine.
- host
Name String - The hostname for this virtual machine.
- hw
Clock BooleanUtc - Specifies whether or not the hardware clock should be in UTC or not.
- script
Text String - The customization script to run before and or after guest customization
- time
Zone String - Customize the time zone on the VM. This should be a time zone-style entry, like America/Los_Angeles.
VirtualMachineCloneCustomizeNetworkInterface, VirtualMachineCloneCustomizeNetworkInterfaceArgs
- Dns
Domain string - A DNS search domain to add to the DNS configuration on the virtual machine.
- Dns
Server List<string>Lists - Network-interface specific DNS settings for Windows operating systems. Ignored on Linux.
- Ipv4Address string
- The IPv4 address assigned to this network adapter. If left blank, DHCP is used.
- Ipv4Netmask int
- The IPv4 CIDR netmask for the supplied IP address. Ignored if DHCP is selected.
- Ipv6Address string
- The IPv6 address assigned to this network adapter. If left blank, default auto-configuration is used.
- Ipv6Netmask int
- The IPv6 CIDR netmask for the supplied IP address. Ignored if auto-configuration is selected.
- Dns
Domain string - A DNS search domain to add to the DNS configuration on the virtual machine.
- Dns
Server []stringLists - Network-interface specific DNS settings for Windows operating systems. Ignored on Linux.
- Ipv4Address string
- The IPv4 address assigned to this network adapter. If left blank, DHCP is used.
- Ipv4Netmask int
- The IPv4 CIDR netmask for the supplied IP address. Ignored if DHCP is selected.
- Ipv6Address string
- The IPv6 address assigned to this network adapter. If left blank, default auto-configuration is used.
- Ipv6Netmask int
- The IPv6 CIDR netmask for the supplied IP address. Ignored if auto-configuration is selected.
- dns
Domain String - A DNS search domain to add to the DNS configuration on the virtual machine.
- dns
Server List<String>Lists - Network-interface specific DNS settings for Windows operating systems. Ignored on Linux.
- ipv4Address String
- The IPv4 address assigned to this network adapter. If left blank, DHCP is used.
- ipv4Netmask Integer
- The IPv4 CIDR netmask for the supplied IP address. Ignored if DHCP is selected.
- ipv6Address String
- The IPv6 address assigned to this network adapter. If left blank, default auto-configuration is used.
- ipv6Netmask Integer
- The IPv6 CIDR netmask for the supplied IP address. Ignored if auto-configuration is selected.
- dns
Domain string - A DNS search domain to add to the DNS configuration on the virtual machine.
- dns
Server string[]Lists - Network-interface specific DNS settings for Windows operating systems. Ignored on Linux.
- ipv4Address string
- The IPv4 address assigned to this network adapter. If left blank, DHCP is used.
- ipv4Netmask number
- The IPv4 CIDR netmask for the supplied IP address. Ignored if DHCP is selected.
- ipv6Address string
- The IPv6 address assigned to this network adapter. If left blank, default auto-configuration is used.
- ipv6Netmask number
- The IPv6 CIDR netmask for the supplied IP address. Ignored if auto-configuration is selected.
- dns_
domain str - A DNS search domain to add to the DNS configuration on the virtual machine.
- dns_
server_ Sequence[str]lists - Network-interface specific DNS settings for Windows operating systems. Ignored on Linux.
- ipv4_
address str - The IPv4 address assigned to this network adapter. If left blank, DHCP is used.
- ipv4_
netmask int - The IPv4 CIDR netmask for the supplied IP address. Ignored if DHCP is selected.
- ipv6_
address str - The IPv6 address assigned to this network adapter. If left blank, default auto-configuration is used.
- ipv6_
netmask int - The IPv6 CIDR netmask for the supplied IP address. Ignored if auto-configuration is selected.
- dns
Domain String - A DNS search domain to add to the DNS configuration on the virtual machine.
- dns
Server List<String>Lists - Network-interface specific DNS settings for Windows operating systems. Ignored on Linux.
- ipv4Address String
- The IPv4 address assigned to this network adapter. If left blank, DHCP is used.
- ipv4Netmask Number
- The IPv4 CIDR netmask for the supplied IP address. Ignored if DHCP is selected.
- ipv6Address String
- The IPv6 address assigned to this network adapter. If left blank, default auto-configuration is used.
- ipv6Netmask Number
- The IPv6 CIDR netmask for the supplied IP address. Ignored if auto-configuration is selected.
VirtualMachineCloneCustomizeWindowsOptions, VirtualMachineCloneCustomizeWindowsOptionsArgs
- Computer
Name string - The host name for this virtual machine.
- Admin
Password string - The new administrator password for this virtual machine.
- Auto
Logon bool - Specifies whether or not the VM automatically logs on as Administrator.
- Auto
Logon intCount - Specifies how many times the VM should auto-logon the Administrator account when auto_logon is true.
- Domain
Admin stringPassword - The password of the domain administrator used to join this virtual machine to the domain.
- Domain
Admin stringUser - The user account of the domain administrator used to join this virtual machine to the domain.
- Full
Name string - The full name of the user of this virtual machine.
- Join
Domain string - The domain that the virtual machine should join.
- Organization
Name string - The organization name this virtual machine is being installed for.
- Product
Key string - The product key for this virtual machine.
- Run
Once List<string>Command Lists - A list of commands to run at first user logon, after guest customization.
- Time
Zone int - The new time zone for the virtual machine. This is a sysprep-dictated timezone code.
- Workgroup string
- The workgroup for this virtual machine if not joining a domain.
- Computer
Name string - The host name for this virtual machine.
- Admin
Password string - The new administrator password for this virtual machine.
- Auto
Logon bool - Specifies whether or not the VM automatically logs on as Administrator.
- Auto
Logon intCount - Specifies how many times the VM should auto-logon the Administrator account when auto_logon is true.
- Domain
Admin stringPassword - The password of the domain administrator used to join this virtual machine to the domain.
- Domain
Admin stringUser - The user account of the domain administrator used to join this virtual machine to the domain.
- Full
Name string - The full name of the user of this virtual machine.
- Join
Domain string - The domain that the virtual machine should join.
- Organization
Name string - The organization name this virtual machine is being installed for.
- Product
Key string - The product key for this virtual machine.
- Run
Once []stringCommand Lists - A list of commands to run at first user logon, after guest customization.
- Time
Zone int - The new time zone for the virtual machine. This is a sysprep-dictated timezone code.
- Workgroup string
- The workgroup for this virtual machine if not joining a domain.
- computer
Name String - The host name for this virtual machine.
- admin
Password String - The new administrator password for this virtual machine.
- auto
Logon Boolean - Specifies whether or not the VM automatically logs on as Administrator.
- auto
Logon IntegerCount - Specifies how many times the VM should auto-logon the Administrator account when auto_logon is true.
- domain
Admin StringPassword - The password of the domain administrator used to join this virtual machine to the domain.
- domain
Admin StringUser - The user account of the domain administrator used to join this virtual machine to the domain.
- full
Name String - The full name of the user of this virtual machine.
- join
Domain String - The domain that the virtual machine should join.
- organization
Name String - The organization name this virtual machine is being installed for.
- product
Key String - The product key for this virtual machine.
- run
Once List<String>Command Lists - A list of commands to run at first user logon, after guest customization.
- time
Zone Integer - The new time zone for the virtual machine. This is a sysprep-dictated timezone code.
- workgroup String
- The workgroup for this virtual machine if not joining a domain.
- computer
Name string - The host name for this virtual machine.
- admin
Password string - The new administrator password for this virtual machine.
- auto
Logon boolean - Specifies whether or not the VM automatically logs on as Administrator.
- auto
Logon numberCount - Specifies how many times the VM should auto-logon the Administrator account when auto_logon is true.
- domain
Admin stringPassword - The password of the domain administrator used to join this virtual machine to the domain.
- domain
Admin stringUser - The user account of the domain administrator used to join this virtual machine to the domain.
- full
Name string - The full name of the user of this virtual machine.
- join
Domain string - The domain that the virtual machine should join.
- organization
Name string - The organization name this virtual machine is being installed for.
- product
Key string - The product key for this virtual machine.
- run
Once string[]Command Lists - A list of commands to run at first user logon, after guest customization.
- time
Zone number - The new time zone for the virtual machine. This is a sysprep-dictated timezone code.
- workgroup string
- The workgroup for this virtual machine if not joining a domain.
- computer_
name str - The host name for this virtual machine.
- admin_
password str - The new administrator password for this virtual machine.
- auto_
logon bool - Specifies whether or not the VM automatically logs on as Administrator.
- auto_
logon_ intcount - Specifies how many times the VM should auto-logon the Administrator account when auto_logon is true.
- domain_
admin_ strpassword - The password of the domain administrator used to join this virtual machine to the domain.
- domain_
admin_ struser - The user account of the domain administrator used to join this virtual machine to the domain.
- full_
name str - The full name of the user of this virtual machine.
- join_
domain str - The domain that the virtual machine should join.
- organization_
name str - The organization name this virtual machine is being installed for.
- product_
key str - The product key for this virtual machine.
- run_
once_ Sequence[str]command_ lists - A list of commands to run at first user logon, after guest customization.
- time_
zone int - The new time zone for the virtual machine. This is a sysprep-dictated timezone code.
- workgroup str
- The workgroup for this virtual machine if not joining a domain.
- computer
Name String - The host name for this virtual machine.
- admin
Password String - The new administrator password for this virtual machine.
- auto
Logon Boolean - Specifies whether or not the VM automatically logs on as Administrator.
- auto
Logon NumberCount - Specifies how many times the VM should auto-logon the Administrator account when auto_logon is true.
- domain
Admin StringPassword - The password of the domain administrator used to join this virtual machine to the domain.
- domain
Admin StringUser - The user account of the domain administrator used to join this virtual machine to the domain.
- full
Name String - The full name of the user of this virtual machine.
- join
Domain String - The domain that the virtual machine should join.
- organization
Name String - The organization name this virtual machine is being installed for.
- product
Key String - The product key for this virtual machine.
- run
Once List<String>Command Lists - A list of commands to run at first user logon, after guest customization.
- time
Zone Number - The new time zone for the virtual machine. This is a sysprep-dictated timezone code.
- workgroup String
- The workgroup for this virtual machine if not joining a domain.
VirtualMachineDisk, VirtualMachineDiskArgs
- Label string
- A unique label for this disk.
- Attach bool
Attach an external disk instead of creating a new one. Implies and conflicts with
keep_on_remove
. If set, you cannot setsize
,eagerly_scrub
, orthin_provisioned
. Must setpath
if used.NOTE: External disks cannot be attached when
datastore_cluster_id
is used.- Controller
Type string - The type of storage controller to attach the disk to. Can be
scsi
,sata
, oride
. You must have the appropriate number of controllers enabled for the selected type. Defaultscsi
. - Datastore
Id string - The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with
client_device
. - Device
Address string - The internally-computed address of this device, such as scsi:0:1, denoting scsi bus #0 and device unit 1.
- Disk
Mode string - The mode of this this virtual disk for purposes of writes and snapshots. One of
append
,independent_nonpersistent
,independent_persistent
,nonpersistent
,persistent
, orundoable
. Default:persistent
. For more information on these option, please refer to the product documentation. - Disk
Sharing string The sharing mode of this virtual disk. One of
sharingMultiWriter
orsharingNone
. Default:sharingNone
.NOTE: Disk sharing is only available on vSphere 6.0 and later.
- Eagerly
Scrub bool - If set to
true
, the disk space is zeroed out when the virtual machine is created. This will delay the creation of the virtual disk. Cannot be set totrue
whenthin_provisioned
istrue
. See the section on picking a disk type for more information. Default:false
. - Io
Limit int - The upper limit of IOPS that this disk can use. The default is no limit.
- Io
Reservation int - The I/O reservation (guarantee) for the virtual disk has, in IOPS. The default is no reservation.
- int
- The share count for the virtual disk when the share level is
custom
. - string
- The share allocation level for the virtual disk. One of
low
,normal
,high
, orcustom
. Default:normal
. - Keep
On boolRemove - Keep this disk when removing the device or destroying the virtual machine. Default:
false
. - Key int
- The ID of the device within the virtual machine.
- Path string
The path to the ISO file. Required for using a datastore ISO. Conflicts with
client_device
.NOTE: Either
client_device
(for a remote backed CD-ROM) ordatastore_id
andpath
(for a datastore ISO backed CD-ROM) are required to .NOTE: Some CD-ROM drive types are not supported by this resource, such as pass-through devices. If these drives are present in a cloned template, or added outside of the provider, the desired state will be corrected to the defined device, or removed if no
cdrom
block is present.- Size int
- The size of the disk, in GB. Must be a whole number.
- Storage
Policy stringId - The UUID of the storage policy to assign to the virtual disk.
- Thin
Provisioned bool - If
true
, the disk is thin provisioned, with space for the file being allocated on an as-needed basis. Cannot be set totrue
wheneagerly_scrub
istrue
. See the section on selecting a disk type for more information. Default:true
. - Unit
Number int - The disk number on the storage bus. The maximum value for this setting is the value of the controller count times the controller capacity (15 for SCSI, 30 for SATA, and 2 for IDE). Duplicate unit numbers are not allowed. Default
0
, for which one disk must be set to. - Uuid string
- The UUID of the virtual disk VMDK file. This is used to track the virtual disk on the virtual machine.
- Write
Through bool - If
true
, writes for this disk are sent directly to the filesystem immediately instead of being buffered. Default:false
.
- Label string
- A unique label for this disk.
- Attach bool
Attach an external disk instead of creating a new one. Implies and conflicts with
keep_on_remove
. If set, you cannot setsize
,eagerly_scrub
, orthin_provisioned
. Must setpath
if used.NOTE: External disks cannot be attached when
datastore_cluster_id
is used.- Controller
Type string - The type of storage controller to attach the disk to. Can be
scsi
,sata
, oride
. You must have the appropriate number of controllers enabled for the selected type. Defaultscsi
. - Datastore
Id string - The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with
client_device
. - Device
Address string - The internally-computed address of this device, such as scsi:0:1, denoting scsi bus #0 and device unit 1.
- Disk
Mode string - The mode of this this virtual disk for purposes of writes and snapshots. One of
append
,independent_nonpersistent
,independent_persistent
,nonpersistent
,persistent
, orundoable
. Default:persistent
. For more information on these option, please refer to the product documentation. - Disk
Sharing string The sharing mode of this virtual disk. One of
sharingMultiWriter
orsharingNone
. Default:sharingNone
.NOTE: Disk sharing is only available on vSphere 6.0 and later.
- Eagerly
Scrub bool - If set to
true
, the disk space is zeroed out when the virtual machine is created. This will delay the creation of the virtual disk. Cannot be set totrue
whenthin_provisioned
istrue
. See the section on picking a disk type for more information. Default:false
. - Io
Limit int - The upper limit of IOPS that this disk can use. The default is no limit.
- Io
Reservation int - The I/O reservation (guarantee) for the virtual disk has, in IOPS. The default is no reservation.
- int
- The share count for the virtual disk when the share level is
custom
. - string
- The share allocation level for the virtual disk. One of
low
,normal
,high
, orcustom
. Default:normal
. - Keep
On boolRemove - Keep this disk when removing the device or destroying the virtual machine. Default:
false
. - Key int
- The ID of the device within the virtual machine.
- Path string
The path to the ISO file. Required for using a datastore ISO. Conflicts with
client_device
.NOTE: Either
client_device
(for a remote backed CD-ROM) ordatastore_id
andpath
(for a datastore ISO backed CD-ROM) are required to .NOTE: Some CD-ROM drive types are not supported by this resource, such as pass-through devices. If these drives are present in a cloned template, or added outside of the provider, the desired state will be corrected to the defined device, or removed if no
cdrom
block is present.- Size int
- The size of the disk, in GB. Must be a whole number.
- Storage
Policy stringId - The UUID of the storage policy to assign to the virtual disk.
- Thin
Provisioned bool - If
true
, the disk is thin provisioned, with space for the file being allocated on an as-needed basis. Cannot be set totrue
wheneagerly_scrub
istrue
. See the section on selecting a disk type for more information. Default:true
. - Unit
Number int - The disk number on the storage bus. The maximum value for this setting is the value of the controller count times the controller capacity (15 for SCSI, 30 for SATA, and 2 for IDE). Duplicate unit numbers are not allowed. Default
0
, for which one disk must be set to. - Uuid string
- The UUID of the virtual disk VMDK file. This is used to track the virtual disk on the virtual machine.
- Write
Through bool - If
true
, writes for this disk are sent directly to the filesystem immediately instead of being buffered. Default:false
.
- label String
- A unique label for this disk.
- attach Boolean
Attach an external disk instead of creating a new one. Implies and conflicts with
keep_on_remove
. If set, you cannot setsize
,eagerly_scrub
, orthin_provisioned
. Must setpath
if used.NOTE: External disks cannot be attached when
datastore_cluster_id
is used.- controller
Type String - The type of storage controller to attach the disk to. Can be
scsi
,sata
, oride
. You must have the appropriate number of controllers enabled for the selected type. Defaultscsi
. - datastore
Id String - The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with
client_device
. - device
Address String - The internally-computed address of this device, such as scsi:0:1, denoting scsi bus #0 and device unit 1.
- disk
Mode String - The mode of this this virtual disk for purposes of writes and snapshots. One of
append
,independent_nonpersistent
,independent_persistent
,nonpersistent
,persistent
, orundoable
. Default:persistent
. For more information on these option, please refer to the product documentation. - disk
Sharing String The sharing mode of this virtual disk. One of
sharingMultiWriter
orsharingNone
. Default:sharingNone
.NOTE: Disk sharing is only available on vSphere 6.0 and later.
- eagerly
Scrub Boolean - If set to
true
, the disk space is zeroed out when the virtual machine is created. This will delay the creation of the virtual disk. Cannot be set totrue
whenthin_provisioned
istrue
. See the section on picking a disk type for more information. Default:false
. - io
Limit Integer - The upper limit of IOPS that this disk can use. The default is no limit.
- io
Reservation Integer - The I/O reservation (guarantee) for the virtual disk has, in IOPS. The default is no reservation.
- Integer
- The share count for the virtual disk when the share level is
custom
. - String
- The share allocation level for the virtual disk. One of
low
,normal
,high
, orcustom
. Default:normal
. - keep
On BooleanRemove - Keep this disk when removing the device or destroying the virtual machine. Default:
false
. - key Integer
- The ID of the device within the virtual machine.
- path String
The path to the ISO file. Required for using a datastore ISO. Conflicts with
client_device
.NOTE: Either
client_device
(for a remote backed CD-ROM) ordatastore_id
andpath
(for a datastore ISO backed CD-ROM) are required to .NOTE: Some CD-ROM drive types are not supported by this resource, such as pass-through devices. If these drives are present in a cloned template, or added outside of the provider, the desired state will be corrected to the defined device, or removed if no
cdrom
block is present.- size Integer
- The size of the disk, in GB. Must be a whole number.
- storage
Policy StringId - The UUID of the storage policy to assign to the virtual disk.
- thin
Provisioned Boolean - If
true
, the disk is thin provisioned, with space for the file being allocated on an as-needed basis. Cannot be set totrue
wheneagerly_scrub
istrue
. See the section on selecting a disk type for more information. Default:true
. - unit
Number Integer - The disk number on the storage bus. The maximum value for this setting is the value of the controller count times the controller capacity (15 for SCSI, 30 for SATA, and 2 for IDE). Duplicate unit numbers are not allowed. Default
0
, for which one disk must be set to. - uuid String
- The UUID of the virtual disk VMDK file. This is used to track the virtual disk on the virtual machine.
- write
Through Boolean - If
true
, writes for this disk are sent directly to the filesystem immediately instead of being buffered. Default:false
.
- label string
- A unique label for this disk.
- attach boolean
Attach an external disk instead of creating a new one. Implies and conflicts with
keep_on_remove
. If set, you cannot setsize
,eagerly_scrub
, orthin_provisioned
. Must setpath
if used.NOTE: External disks cannot be attached when
datastore_cluster_id
is used.- controller
Type string - The type of storage controller to attach the disk to. Can be
scsi
,sata
, oride
. You must have the appropriate number of controllers enabled for the selected type. Defaultscsi
. - datastore
Id string - The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with
client_device
. - device
Address string - The internally-computed address of this device, such as scsi:0:1, denoting scsi bus #0 and device unit 1.
- disk
Mode string - The mode of this this virtual disk for purposes of writes and snapshots. One of
append
,independent_nonpersistent
,independent_persistent
,nonpersistent
,persistent
, orundoable
. Default:persistent
. For more information on these option, please refer to the product documentation. - disk
Sharing string The sharing mode of this virtual disk. One of
sharingMultiWriter
orsharingNone
. Default:sharingNone
.NOTE: Disk sharing is only available on vSphere 6.0 and later.
- eagerly
Scrub boolean - If set to
true
, the disk space is zeroed out when the virtual machine is created. This will delay the creation of the virtual disk. Cannot be set totrue
whenthin_provisioned
istrue
. See the section on picking a disk type for more information. Default:false
. - io
Limit number - The upper limit of IOPS that this disk can use. The default is no limit.
- io
Reservation number - The I/O reservation (guarantee) for the virtual disk has, in IOPS. The default is no reservation.
- number
- The share count for the virtual disk when the share level is
custom
. - string
- The share allocation level for the virtual disk. One of
low
,normal
,high
, orcustom
. Default:normal
. - keep
On booleanRemove - Keep this disk when removing the device or destroying the virtual machine. Default:
false
. - key number
- The ID of the device within the virtual machine.
- path string
The path to the ISO file. Required for using a datastore ISO. Conflicts with
client_device
.NOTE: Either
client_device
(for a remote backed CD-ROM) ordatastore_id
andpath
(for a datastore ISO backed CD-ROM) are required to .NOTE: Some CD-ROM drive types are not supported by this resource, such as pass-through devices. If these drives are present in a cloned template, or added outside of the provider, the desired state will be corrected to the defined device, or removed if no
cdrom
block is present.- size number
- The size of the disk, in GB. Must be a whole number.
- storage
Policy stringId - The UUID of the storage policy to assign to the virtual disk.
- thin
Provisioned boolean - If
true
, the disk is thin provisioned, with space for the file being allocated on an as-needed basis. Cannot be set totrue
wheneagerly_scrub
istrue
. See the section on selecting a disk type for more information. Default:true
. - unit
Number number - The disk number on the storage bus. The maximum value for this setting is the value of the controller count times the controller capacity (15 for SCSI, 30 for SATA, and 2 for IDE). Duplicate unit numbers are not allowed. Default
0
, for which one disk must be set to. - uuid string
- The UUID of the virtual disk VMDK file. This is used to track the virtual disk on the virtual machine.
- write
Through boolean - If
true
, writes for this disk are sent directly to the filesystem immediately instead of being buffered. Default:false
.
- label str
- A unique label for this disk.
- attach bool
Attach an external disk instead of creating a new one. Implies and conflicts with
keep_on_remove
. If set, you cannot setsize
,eagerly_scrub
, orthin_provisioned
. Must setpath
if used.NOTE: External disks cannot be attached when
datastore_cluster_id
is used.- controller_
type str - The type of storage controller to attach the disk to. Can be
scsi
,sata
, oride
. You must have the appropriate number of controllers enabled for the selected type. Defaultscsi
. - datastore_
id str - The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with
client_device
. - device_
address str - The internally-computed address of this device, such as scsi:0:1, denoting scsi bus #0 and device unit 1.
- disk_
mode str - The mode of this this virtual disk for purposes of writes and snapshots. One of
append
,independent_nonpersistent
,independent_persistent
,nonpersistent
,persistent
, orundoable
. Default:persistent
. For more information on these option, please refer to the product documentation. - disk_
sharing str The sharing mode of this virtual disk. One of
sharingMultiWriter
orsharingNone
. Default:sharingNone
.NOTE: Disk sharing is only available on vSphere 6.0 and later.
- eagerly_
scrub bool - If set to
true
, the disk space is zeroed out when the virtual machine is created. This will delay the creation of the virtual disk. Cannot be set totrue
whenthin_provisioned
istrue
. See the section on picking a disk type for more information. Default:false
. - io_
limit int - The upper limit of IOPS that this disk can use. The default is no limit.
- io_
reservation int - The I/O reservation (guarantee) for the virtual disk has, in IOPS. The default is no reservation.
- int
- The share count for the virtual disk when the share level is
custom
. - str
- The share allocation level for the virtual disk. One of
low
,normal
,high
, orcustom
. Default:normal
. - keep_
on_ boolremove - Keep this disk when removing the device or destroying the virtual machine. Default:
false
. - key int
- The ID of the device within the virtual machine.
- path str
The path to the ISO file. Required for using a datastore ISO. Conflicts with
client_device
.NOTE: Either
client_device
(for a remote backed CD-ROM) ordatastore_id
andpath
(for a datastore ISO backed CD-ROM) are required to .NOTE: Some CD-ROM drive types are not supported by this resource, such as pass-through devices. If these drives are present in a cloned template, or added outside of the provider, the desired state will be corrected to the defined device, or removed if no
cdrom
block is present.- size int
- The size of the disk, in GB. Must be a whole number.
- storage_
policy_ strid - The UUID of the storage policy to assign to the virtual disk.
- thin_
provisioned bool - If
true
, the disk is thin provisioned, with space for the file being allocated on an as-needed basis. Cannot be set totrue
wheneagerly_scrub
istrue
. See the section on selecting a disk type for more information. Default:true
. - unit_
number int - The disk number on the storage bus. The maximum value for this setting is the value of the controller count times the controller capacity (15 for SCSI, 30 for SATA, and 2 for IDE). Duplicate unit numbers are not allowed. Default
0
, for which one disk must be set to. - uuid str
- The UUID of the virtual disk VMDK file. This is used to track the virtual disk on the virtual machine.
- write_
through bool - If
true
, writes for this disk are sent directly to the filesystem immediately instead of being buffered. Default:false
.
- label String
- A unique label for this disk.
- attach Boolean
Attach an external disk instead of creating a new one. Implies and conflicts with
keep_on_remove
. If set, you cannot setsize
,eagerly_scrub
, orthin_provisioned
. Must setpath
if used.NOTE: External disks cannot be attached when
datastore_cluster_id
is used.- controller
Type String - The type of storage controller to attach the disk to. Can be
scsi
,sata
, oride
. You must have the appropriate number of controllers enabled for the selected type. Defaultscsi
. - datastore
Id String - The datastore ID that on which the ISO is located. Required for using a datastore ISO. Conflicts with
client_device
. - device
Address String - The internally-computed address of this device, such as scsi:0:1, denoting scsi bus #0 and device unit 1.
- disk
Mode String - The mode of this this virtual disk for purposes of writes and snapshots. One of
append
,independent_nonpersistent
,independent_persistent
,nonpersistent
,persistent
, orundoable
. Default:persistent
. For more information on these option, please refer to the product documentation. - disk
Sharing String The sharing mode of this virtual disk. One of
sharingMultiWriter
orsharingNone
. Default:sharingNone
.NOTE: Disk sharing is only available on vSphere 6.0 and later.
- eagerly
Scrub Boolean - If set to
true
, the disk space is zeroed out when the virtual machine is created. This will delay the creation of the virtual disk. Cannot be set totrue
whenthin_provisioned
istrue
. See the section on picking a disk type for more information. Default:false
. - io
Limit Number - The upper limit of IOPS that this disk can use. The default is no limit.
- io
Reservation Number - The I/O reservation (guarantee) for the virtual disk has, in IOPS. The default is no reservation.
- Number
- The share count for the virtual disk when the share level is
custom
. - String
- The share allocation level for the virtual disk. One of
low
,normal
,high
, orcustom
. Default:normal
. - keep
On BooleanRemove - Keep this disk when removing the device or destroying the virtual machine. Default:
false
. - key Number
- The ID of the device within the virtual machine.
- path String
The path to the ISO file. Required for using a datastore ISO. Conflicts with
client_device
.NOTE: Either
client_device
(for a remote backed CD-ROM) ordatastore_id
andpath
(for a datastore ISO backed CD-ROM) are required to .NOTE: Some CD-ROM drive types are not supported by this resource, such as pass-through devices. If these drives are present in a cloned template, or added outside of the provider, the desired state will be corrected to the defined device, or removed if no
cdrom
block is present.- size Number
- The size of the disk, in GB. Must be a whole number.
- storage
Policy StringId - The UUID of the storage policy to assign to the virtual disk.
- thin
Provisioned Boolean - If
true
, the disk is thin provisioned, with space for the file being allocated on an as-needed basis. Cannot be set totrue
wheneagerly_scrub
istrue
. See the section on selecting a disk type for more information. Default:true
. - unit
Number Number - The disk number on the storage bus. The maximum value for this setting is the value of the controller count times the controller capacity (15 for SCSI, 30 for SATA, and 2 for IDE). Duplicate unit numbers are not allowed. Default
0
, for which one disk must be set to. - uuid String
- The UUID of the virtual disk VMDK file. This is used to track the virtual disk on the virtual machine.
- write
Through Boolean - If
true
, writes for this disk are sent directly to the filesystem immediately instead of being buffered. Default:false
.
VirtualMachineNetworkInterface, VirtualMachineNetworkInterfaceArgs
- Network
Id string - The [managed object reference ID][docs-about-morefs] of the network on which to connect the virtual machine network interface.
- Adapter
Type string - The network interface type. One of
e1000
,e1000e
,sriov
, orvmxnet3
. Default:vmxnet3
. - Bandwidth
Limit int - The upper bandwidth limit of the network interface, in Mbits/sec. The default is no limit. Ignored if
adapter_type
is set tosriov
. - Bandwidth
Reservation int - The bandwidth reservation of the network interface, in Mbits/sec. The default is no reservation.
- int
- The share count for the network interface when the share level is
custom
. Ignored ifadapter_type
is set tosriov
. - string
- The bandwidth share allocation level for the network interface. One of
low
,normal
,high
, orcustom
. Default:normal
. Ignored ifadapter_type
is set tosriov
. - Device
Address string - The internally-computed address of this device, such as scsi:0:1, denoting scsi bus #0 and device unit 1.
- Key int
- The ID of the device within the virtual machine.
- Mac
Address string - The MAC address of the network interface. Can only be manually set if
use_static_mac
istrue
. Otherwise, the value is computed and presents the assigned MAC address for the interface. - Ovf
Mapping string - Specifies which NIC in an OVF/OVA the
network_interface
should be associated. Only applies at creation when deploying from an OVF/OVA. - Physical
Function string - The ID of the Physical SR-IOV NIC to attach to, e.g. '0000:d8:00.0'
- Use
Static boolMac - If true, the
mac_address
field is treated as a static MAC address and set accordingly. Setting this totrue
requiresmac_address
to be set. Default:false
.
- Network
Id string - The [managed object reference ID][docs-about-morefs] of the network on which to connect the virtual machine network interface.
- Adapter
Type string - The network interface type. One of
e1000
,e1000e
,sriov
, orvmxnet3
. Default:vmxnet3
. - Bandwidth
Limit int - The upper bandwidth limit of the network interface, in Mbits/sec. The default is no limit. Ignored if
adapter_type
is set tosriov
. - Bandwidth
Reservation int - The bandwidth reservation of the network interface, in Mbits/sec. The default is no reservation.
- int
- The share count for the network interface when the share level is
custom
. Ignored ifadapter_type
is set tosriov
. - string
- The bandwidth share allocation level for the network interface. One of
low
,normal
,high
, orcustom
. Default:normal
. Ignored ifadapter_type
is set tosriov
. - Device
Address string - The internally-computed address of this device, such as scsi:0:1, denoting scsi bus #0 and device unit 1.
- Key int
- The ID of the device within the virtual machine.
- Mac
Address string - The MAC address of the network interface. Can only be manually set if
use_static_mac
istrue
. Otherwise, the value is computed and presents the assigned MAC address for the interface. - Ovf
Mapping string - Specifies which NIC in an OVF/OVA the
network_interface
should be associated. Only applies at creation when deploying from an OVF/OVA. - Physical
Function string - The ID of the Physical SR-IOV NIC to attach to, e.g. '0000:d8:00.0'
- Use
Static boolMac - If true, the
mac_address
field is treated as a static MAC address and set accordingly. Setting this totrue
requiresmac_address
to be set. Default:false
.
- network
Id String - The [managed object reference ID][docs-about-morefs] of the network on which to connect the virtual machine network interface.
- adapter
Type String - The network interface type. One of
e1000
,e1000e
,sriov
, orvmxnet3
. Default:vmxnet3
. - bandwidth
Limit Integer - The upper bandwidth limit of the network interface, in Mbits/sec. The default is no limit. Ignored if
adapter_type
is set tosriov
. - bandwidth
Reservation Integer - The bandwidth reservation of the network interface, in Mbits/sec. The default is no reservation.
- Integer
- The share count for the network interface when the share level is
custom
. Ignored ifadapter_type
is set tosriov
. - String
- The bandwidth share allocation level for the network interface. One of
low
,normal
,high
, orcustom
. Default:normal
. Ignored ifadapter_type
is set tosriov
. - device
Address String - The internally-computed address of this device, such as scsi:0:1, denoting scsi bus #0 and device unit 1.
- key Integer
- The ID of the device within the virtual machine.
- mac
Address String - The MAC address of the network interface. Can only be manually set if
use_static_mac
istrue
. Otherwise, the value is computed and presents the assigned MAC address for the interface. - ovf
Mapping String - Specifies which NIC in an OVF/OVA the
network_interface
should be associated. Only applies at creation when deploying from an OVF/OVA. - physical
Function String - The ID of the Physical SR-IOV NIC to attach to, e.g. '0000:d8:00.0'
- use
Static BooleanMac - If true, the
mac_address
field is treated as a static MAC address and set accordingly. Setting this totrue
requiresmac_address
to be set. Default:false
.
- network
Id string - The [managed object reference ID][docs-about-morefs] of the network on which to connect the virtual machine network interface.
- adapter
Type string - The network interface type. One of
e1000
,e1000e
,sriov
, orvmxnet3
. Default:vmxnet3
. - bandwidth
Limit number - The upper bandwidth limit of the network interface, in Mbits/sec. The default is no limit. Ignored if
adapter_type
is set tosriov
. - bandwidth
Reservation number - The bandwidth reservation of the network interface, in Mbits/sec. The default is no reservation.
- number
- The share count for the network interface when the share level is
custom
. Ignored ifadapter_type
is set tosriov
. - string
- The bandwidth share allocation level for the network interface. One of
low
,normal
,high
, orcustom
. Default:normal
. Ignored ifadapter_type
is set tosriov
. - device
Address string - The internally-computed address of this device, such as scsi:0:1, denoting scsi bus #0 and device unit 1.
- key number
- The ID of the device within the virtual machine.
- mac
Address string - The MAC address of the network interface. Can only be manually set if
use_static_mac
istrue
. Otherwise, the value is computed and presents the assigned MAC address for the interface. - ovf
Mapping string - Specifies which NIC in an OVF/OVA the
network_interface
should be associated. Only applies at creation when deploying from an OVF/OVA. - physical
Function string - The ID of the Physical SR-IOV NIC to attach to, e.g. '0000:d8:00.0'
- use
Static booleanMac - If true, the
mac_address
field is treated as a static MAC address and set accordingly. Setting this totrue
requiresmac_address
to be set. Default:false
.
- network_
id str - The [managed object reference ID][docs-about-morefs] of the network on which to connect the virtual machine network interface.
- adapter_
type str - The network interface type. One of
e1000
,e1000e
,sriov
, orvmxnet3
. Default:vmxnet3
. - bandwidth_
limit int - The upper bandwidth limit of the network interface, in Mbits/sec. The default is no limit. Ignored if
adapter_type
is set tosriov
. - bandwidth_
reservation int - The bandwidth reservation of the network interface, in Mbits/sec. The default is no reservation.
- int
- The share count for the network interface when the share level is
custom
. Ignored ifadapter_type
is set tosriov
. - str
- The bandwidth share allocation level for the network interface. One of
low
,normal
,high
, orcustom
. Default:normal
. Ignored ifadapter_type
is set tosriov
. - device_
address str - The internally-computed address of this device, such as scsi:0:1, denoting scsi bus #0 and device unit 1.
- key int
- The ID of the device within the virtual machine.
- mac_
address str - The MAC address of the network interface. Can only be manually set if
use_static_mac
istrue
. Otherwise, the value is computed and presents the assigned MAC address for the interface. - ovf_
mapping str - Specifies which NIC in an OVF/OVA the
network_interface
should be associated. Only applies at creation when deploying from an OVF/OVA. - physical_
function str - The ID of the Physical SR-IOV NIC to attach to, e.g. '0000:d8:00.0'
- use_
static_ boolmac - If true, the
mac_address
field is treated as a static MAC address and set accordingly. Setting this totrue
requiresmac_address
to be set. Default:false
.
- network
Id String - The [managed object reference ID][docs-about-morefs] of the network on which to connect the virtual machine network interface.
- adapter
Type String - The network interface type. One of
e1000
,e1000e
,sriov
, orvmxnet3
. Default:vmxnet3
. - bandwidth
Limit Number - The upper bandwidth limit of the network interface, in Mbits/sec. The default is no limit. Ignored if
adapter_type
is set tosriov
. - bandwidth
Reservation Number - The bandwidth reservation of the network interface, in Mbits/sec. The default is no reservation.
- Number
- The share count for the network interface when the share level is
custom
. Ignored ifadapter_type
is set tosriov
. - String
- The bandwidth share allocation level for the network interface. One of
low
,normal
,high
, orcustom
. Default:normal
. Ignored ifadapter_type
is set tosriov
. - device
Address String - The internally-computed address of this device, such as scsi:0:1, denoting scsi bus #0 and device unit 1.
- key Number
- The ID of the device within the virtual machine.
- mac
Address String - The MAC address of the network interface. Can only be manually set if
use_static_mac
istrue
. Otherwise, the value is computed and presents the assigned MAC address for the interface. - ovf
Mapping String - Specifies which NIC in an OVF/OVA the
network_interface
should be associated. Only applies at creation when deploying from an OVF/OVA. - physical
Function String - The ID of the Physical SR-IOV NIC to attach to, e.g. '0000:d8:00.0'
- use
Static BooleanMac - If true, the
mac_address
field is treated as a static MAC address and set accordingly. Setting this totrue
requiresmac_address
to be set. Default:false
.
VirtualMachineOvfDeploy, VirtualMachineOvfDeployArgs
- Allow
Unverified boolSsl Cert - Allow unverified ssl certificates while deploying ovf/ova from url.
- Deployment
Option string - The Deployment option to be chosen. If empty, the default option is used.
- Disk
Provisioning string - An optional disk provisioning. If set, all the disks in the deployed ovf will have the same specified disk type (e.g., thin provisioned).
- bool
- Allow properties with ovf:userConfigurable=false to be set.
- Ip
Allocation stringPolicy - The IP allocation policy.
- Ip
Protocol string - The IP protocol.
- Local
Ovf stringPath - The absolute path to the ovf/ova file in the local system.
- Ovf
Network Dictionary<string, string>Map - The mapping of name of network identifiers from the ovf descriptor to network UUID in the VI infrastructure.
- Remote
Ovf stringUrl - URL to the remote ovf/ova file to be deployed.
- Allow
Unverified boolSsl Cert - Allow unverified ssl certificates while deploying ovf/ova from url.
- Deployment
Option string - The Deployment option to be chosen. If empty, the default option is used.
- Disk
Provisioning string - An optional disk provisioning. If set, all the disks in the deployed ovf will have the same specified disk type (e.g., thin provisioned).
- bool
- Allow properties with ovf:userConfigurable=false to be set.
- Ip
Allocation stringPolicy - The IP allocation policy.
- Ip
Protocol string - The IP protocol.
- Local
Ovf stringPath - The absolute path to the ovf/ova file in the local system.
- Ovf
Network map[string]stringMap - The mapping of name of network identifiers from the ovf descriptor to network UUID in the VI infrastructure.
- Remote
Ovf stringUrl - URL to the remote ovf/ova file to be deployed.
- allow
Unverified BooleanSsl Cert - Allow unverified ssl certificates while deploying ovf/ova from url.
- deployment
Option String - The Deployment option to be chosen. If empty, the default option is used.
- disk
Provisioning String - An optional disk provisioning. If set, all the disks in the deployed ovf will have the same specified disk type (e.g., thin provisioned).
- Boolean
- Allow properties with ovf:userConfigurable=false to be set.
- ip
Allocation StringPolicy - The IP allocation policy.
- ip
Protocol String - The IP protocol.
- local
Ovf StringPath - The absolute path to the ovf/ova file in the local system.
- ovf
Network Map<String,String>Map - The mapping of name of network identifiers from the ovf descriptor to network UUID in the VI infrastructure.
- remote
Ovf StringUrl - URL to the remote ovf/ova file to be deployed.
- allow
Unverified booleanSsl Cert - Allow unverified ssl certificates while deploying ovf/ova from url.
- deployment
Option string - The Deployment option to be chosen. If empty, the default option is used.
- disk
Provisioning string - An optional disk provisioning. If set, all the disks in the deployed ovf will have the same specified disk type (e.g., thin provisioned).
- boolean
- Allow properties with ovf:userConfigurable=false to be set.
- ip
Allocation stringPolicy - The IP allocation policy.
- ip
Protocol string - The IP protocol.
- local
Ovf stringPath - The absolute path to the ovf/ova file in the local system.
- ovf
Network {[key: string]: string}Map - The mapping of name of network identifiers from the ovf descriptor to network UUID in the VI infrastructure.
- remote
Ovf stringUrl - URL to the remote ovf/ova file to be deployed.
- allow_
unverified_ boolssl_ cert - Allow unverified ssl certificates while deploying ovf/ova from url.
- deployment_
option str - The Deployment option to be chosen. If empty, the default option is used.
- disk_
provisioning str - An optional disk provisioning. If set, all the disks in the deployed ovf will have the same specified disk type (e.g., thin provisioned).
- bool
- Allow properties with ovf:userConfigurable=false to be set.
- ip_
allocation_ strpolicy - The IP allocation policy.
- ip_
protocol str - The IP protocol.
- local_
ovf_ strpath - The absolute path to the ovf/ova file in the local system.
- ovf_
network_ Mapping[str, str]map - The mapping of name of network identifiers from the ovf descriptor to network UUID in the VI infrastructure.
- remote_
ovf_ strurl - URL to the remote ovf/ova file to be deployed.
- allow
Unverified BooleanSsl Cert - Allow unverified ssl certificates while deploying ovf/ova from url.
- deployment
Option String - The Deployment option to be chosen. If empty, the default option is used.
- disk
Provisioning String - An optional disk provisioning. If set, all the disks in the deployed ovf will have the same specified disk type (e.g., thin provisioned).
- Boolean
- Allow properties with ovf:userConfigurable=false to be set.
- ip
Allocation StringPolicy - The IP allocation policy.
- ip
Protocol String - The IP protocol.
- local
Ovf StringPath - The absolute path to the ovf/ova file in the local system.
- ovf
Network Map<String>Map - The mapping of name of network identifiers from the ovf descriptor to network UUID in the VI infrastructure.
- remote
Ovf StringUrl - URL to the remote ovf/ova file to be deployed.
VirtualMachineVapp, VirtualMachineVappArgs
- Properties Dictionary<string, string>
- A map of customizable vApp properties and their values. Allows customization of VMs cloned from OVF templates which have customizable vApp properties.
- Properties map[string]string
- A map of customizable vApp properties and their values. Allows customization of VMs cloned from OVF templates which have customizable vApp properties.
- properties Map<String,String>
- A map of customizable vApp properties and their values. Allows customization of VMs cloned from OVF templates which have customizable vApp properties.
- properties {[key: string]: string}
- A map of customizable vApp properties and their values. Allows customization of VMs cloned from OVF templates which have customizable vApp properties.
- properties Mapping[str, str]
- A map of customizable vApp properties and their values. Allows customization of VMs cloned from OVF templates which have customizable vApp properties.
- properties Map<String>
- A map of customizable vApp properties and their values. Allows customization of VMs cloned from OVF templates which have customizable vApp properties.
Package Details
- Repository
- vSphere pulumi/pulumi-vsphere
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
vsphere
Terraform Provider.