1. Packages
  2. Vcd Provider
  3. API Docs
  4. getVm
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

vcd.getVm

Explore with Pulumi AI

vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

Using getVm

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getVm(args: GetVmArgs, opts?: InvokeOptions): Promise<GetVmResult>
function getVmOutput(args: GetVmOutputArgs, opts?: InvokeOptions): Output<GetVmResult>
Copy
def get_vm(id: Optional[str] = None,
           name: Optional[str] = None,
           network_dhcp_wait_seconds: Optional[float] = None,
           org: Optional[str] = None,
           placement_policy_id: Optional[str] = None,
           sizing_policy_id: Optional[str] = None,
           vapp_name: Optional[str] = None,
           vdc: Optional[str] = None,
           opts: Optional[InvokeOptions] = None) -> GetVmResult
def get_vm_output(id: Optional[pulumi.Input[str]] = None,
           name: Optional[pulumi.Input[str]] = None,
           network_dhcp_wait_seconds: Optional[pulumi.Input[float]] = None,
           org: Optional[pulumi.Input[str]] = None,
           placement_policy_id: Optional[pulumi.Input[str]] = None,
           sizing_policy_id: Optional[pulumi.Input[str]] = None,
           vapp_name: Optional[pulumi.Input[str]] = None,
           vdc: Optional[pulumi.Input[str]] = None,
           opts: Optional[InvokeOptions] = None) -> Output[GetVmResult]
Copy
func LookupVm(ctx *Context, args *LookupVmArgs, opts ...InvokeOption) (*LookupVmResult, error)
func LookupVmOutput(ctx *Context, args *LookupVmOutputArgs, opts ...InvokeOption) LookupVmResultOutput
Copy

> Note: This function is named LookupVm in the Go SDK.

public static class GetVm 
{
    public static Task<GetVmResult> InvokeAsync(GetVmArgs args, InvokeOptions? opts = null)
    public static Output<GetVmResult> Invoke(GetVmInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetVmResult> getVm(GetVmArgs args, InvokeOptions options)
public static Output<GetVmResult> getVm(GetVmArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: vcd:index/getVm:getVm
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
A name or ID for the standalone VM in VDC
Id string
NetworkDhcpWaitSeconds double
Org string
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
PlacementPolicyId string
SizingPolicyId string
VappName string
Vdc string
The name of VDC to use, optional if defined at provider level
Name This property is required. string
A name or ID for the standalone VM in VDC
Id string
NetworkDhcpWaitSeconds float64
Org string
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
PlacementPolicyId string
SizingPolicyId string
VappName string
Vdc string
The name of VDC to use, optional if defined at provider level
name This property is required. String
A name or ID for the standalone VM in VDC
id String
networkDhcpWaitSeconds Double
org String
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
placementPolicyId String
sizingPolicyId String
vappName String
vdc String
The name of VDC to use, optional if defined at provider level
name This property is required. string
A name or ID for the standalone VM in VDC
id string
networkDhcpWaitSeconds number
org string
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
placementPolicyId string
sizingPolicyId string
vappName string
vdc string
The name of VDC to use, optional if defined at provider level
name This property is required. str
A name or ID for the standalone VM in VDC
id str
network_dhcp_wait_seconds float
org str
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
placement_policy_id str
sizing_policy_id str
vapp_name str
vdc str
The name of VDC to use, optional if defined at provider level
name This property is required. String
A name or ID for the standalone VM in VDC
id String
networkDhcpWaitSeconds Number
org String
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
placementPolicyId String
sizingPolicyId String
vappName String
vdc String
The name of VDC to use, optional if defined at provider level

getVm Result

The following output properties are available:

BootOptions List<GetVmBootOption>
ComputerName string
CpuCores double
CpuHotAddEnabled bool
CpuLimit double
CpuPriority string
CpuReservation double
CpuShares double
Cpus double
Customizations List<GetVmCustomization>
Description string
Disks List<GetVmDisk>
ExposeHardwareVirtualization bool
ExtraConfigs List<GetVmExtraConfig>
Firmware string
GuestProperties Dictionary<string, string>
HardwareVersion string
Href string
Id string
InheritedMetadata Dictionary<string, string>
InternalDisks List<GetVmInternalDisk>
Memory double
MemoryHotAddEnabled bool
MemoryLimit double
MemoryPriority string
MemoryReservation double
MemoryShares double
Metadata Dictionary<string, string>

Deprecated: Deprecated

MetadataEntries List<GetVmMetadataEntry>
Name string
Networks List<GetVmNetwork>
OsType string
PlacementPolicyId string
SecurityTags List<string>
SizingPolicyId string
Status double
StatusText string
StorageProfile string
VappId string
VappName string
VmType string
NetworkDhcpWaitSeconds double
Org string
Vdc string
BootOptions []GetVmBootOption
ComputerName string
CpuCores float64
CpuHotAddEnabled bool
CpuLimit float64
CpuPriority string
CpuReservation float64
CpuShares float64
Cpus float64
Customizations []GetVmCustomization
Description string
Disks []GetVmDisk
ExposeHardwareVirtualization bool
ExtraConfigs []GetVmExtraConfig
Firmware string
GuestProperties map[string]string
HardwareVersion string
Href string
Id string
InheritedMetadata map[string]string
InternalDisks []GetVmInternalDiskType
Memory float64
MemoryHotAddEnabled bool
MemoryLimit float64
MemoryPriority string
MemoryReservation float64
MemoryShares float64
Metadata map[string]string

Deprecated: Deprecated

MetadataEntries []GetVmMetadataEntry
Name string
Networks []GetVmNetwork
OsType string
PlacementPolicyId string
SecurityTags []string
SizingPolicyId string
Status float64
StatusText string
StorageProfile string
VappId string
VappName string
VmType string
NetworkDhcpWaitSeconds float64
Org string
Vdc string
bootOptions List<GetVmBootOption>
computerName String
cpuCores Double
cpuHotAddEnabled Boolean
cpuLimit Double
cpuPriority String
cpuReservation Double
cpuShares Double
cpus Double
customizations List<GetVmCustomization>
description String
disks List<GetVmDisk>
exposeHardwareVirtualization Boolean
extraConfigs List<GetVmExtraConfig>
firmware String
guestProperties Map<String,String>
hardwareVersion String
href String
id String
inheritedMetadata Map<String,String>
internalDisks List<GetVmInternalDisk>
memory Double
memoryHotAddEnabled Boolean
memoryLimit Double
memoryPriority String
memoryReservation Double
memoryShares Double
metadata Map<String,String>

Deprecated: Deprecated

metadataEntries List<GetVmMetadataEntry>
name String
networks List<GetVmNetwork>
osType String
placementPolicyId String
securityTags List<String>
sizingPolicyId String
status Double
statusText String
storageProfile String
vappId String
vappName String
vmType String
networkDhcpWaitSeconds Double
org String
vdc String
boot_options Sequence[GetVmBootOption]
computer_name str
cpu_cores float
cpu_hot_add_enabled bool
cpu_limit float
cpu_priority str
cpu_reservation float
cpu_shares float
cpus float
customizations Sequence[GetVmCustomization]
description str
disks Sequence[GetVmDisk]
expose_hardware_virtualization bool
extra_configs Sequence[GetVmExtraConfig]
firmware str
guest_properties Mapping[str, str]
hardware_version str
href str
id str
inherited_metadata Mapping[str, str]
internal_disks Sequence[GetVmInternalDisk]
memory float
memory_hot_add_enabled bool
memory_limit float
memory_priority str
memory_reservation float
memory_shares float
metadata Mapping[str, str]

Deprecated: Deprecated

metadata_entries Sequence[GetVmMetadataEntry]
name str
networks Sequence[GetVmNetwork]
os_type str
placement_policy_id str
security_tags Sequence[str]
sizing_policy_id str
status float
status_text str
storage_profile str
vapp_id str
vapp_name str
vm_type str
network_dhcp_wait_seconds float
org str
vdc str
bootOptions List<Property Map>
computerName String
cpuCores Number
cpuHotAddEnabled Boolean
cpuLimit Number
cpuPriority String
cpuReservation Number
cpuShares Number
cpus Number
customizations List<Property Map>
description String
disks List<Property Map>
exposeHardwareVirtualization Boolean
extraConfigs List<Property Map>
firmware String
guestProperties Map<String>
hardwareVersion String
href String
id String
inheritedMetadata Map<String>
internalDisks List<Property Map>
memory Number
memoryHotAddEnabled Boolean
memoryLimit Number
memoryPriority String
memoryReservation Number
memoryShares Number
metadata Map<String>

Deprecated: Deprecated

metadataEntries List<Property Map>
name String
networks List<Property Map>
osType String
placementPolicyId String
securityTags List<String>
sizingPolicyId String
status Number
statusText String
storageProfile String
vappId String
vappName String
vmType String
networkDhcpWaitSeconds Number
org String
vdc String

Supporting Types

GetVmBootOption

BootDelay This property is required. double
BootRetryDelay This property is required. double
BootRetryEnabled This property is required. bool
EfiSecureBoot This property is required. bool
EnterBiosSetupOnNextBoot This property is required. bool
BootDelay This property is required. float64
BootRetryDelay This property is required. float64
BootRetryEnabled This property is required. bool
EfiSecureBoot This property is required. bool
EnterBiosSetupOnNextBoot This property is required. bool
bootDelay This property is required. Double
bootRetryDelay This property is required. Double
bootRetryEnabled This property is required. Boolean
efiSecureBoot This property is required. Boolean
enterBiosSetupOnNextBoot This property is required. Boolean
bootDelay This property is required. number
bootRetryDelay This property is required. number
bootRetryEnabled This property is required. boolean
efiSecureBoot This property is required. boolean
enterBiosSetupOnNextBoot This property is required. boolean
boot_delay This property is required. float
boot_retry_delay This property is required. float
boot_retry_enabled This property is required. bool
efi_secure_boot This property is required. bool
enter_bios_setup_on_next_boot This property is required. bool
bootDelay This property is required. Number
bootRetryDelay This property is required. Number
bootRetryEnabled This property is required. Boolean
efiSecureBoot This property is required. Boolean
enterBiosSetupOnNextBoot This property is required. Boolean

GetVmCustomization

AdminPassword This property is required. string
AllowLocalAdminPassword This property is required. bool
AutoGeneratePassword This property is required. bool
ChangeSid This property is required. bool
Enabled This property is required. bool
Force This property is required. bool
Initscript This property is required. string
JoinDomain This property is required. bool
JoinDomainAccountOu This property is required. string
JoinDomainName This property is required. string
JoinDomainPassword This property is required. string
JoinDomainUser This property is required. string
JoinOrgDomain This property is required. bool
MustChangePasswordOnFirstLogin This property is required. bool
NumberOfAutoLogons This property is required. double
AdminPassword This property is required. string
AllowLocalAdminPassword This property is required. bool
AutoGeneratePassword This property is required. bool
ChangeSid This property is required. bool
Enabled This property is required. bool
Force This property is required. bool
Initscript This property is required. string
JoinDomain This property is required. bool
JoinDomainAccountOu This property is required. string
JoinDomainName This property is required. string
JoinDomainPassword This property is required. string
JoinDomainUser This property is required. string
JoinOrgDomain This property is required. bool
MustChangePasswordOnFirstLogin This property is required. bool
NumberOfAutoLogons This property is required. float64
adminPassword This property is required. String
allowLocalAdminPassword This property is required. Boolean
autoGeneratePassword This property is required. Boolean
changeSid This property is required. Boolean
enabled This property is required. Boolean
force This property is required. Boolean
initscript This property is required. String
joinDomain This property is required. Boolean
joinDomainAccountOu This property is required. String
joinDomainName This property is required. String
joinDomainPassword This property is required. String
joinDomainUser This property is required. String
joinOrgDomain This property is required. Boolean
mustChangePasswordOnFirstLogin This property is required. Boolean
numberOfAutoLogons This property is required. Double
adminPassword This property is required. string
allowLocalAdminPassword This property is required. boolean
autoGeneratePassword This property is required. boolean
changeSid This property is required. boolean
enabled This property is required. boolean
force This property is required. boolean
initscript This property is required. string
joinDomain This property is required. boolean
joinDomainAccountOu This property is required. string
joinDomainName This property is required. string
joinDomainPassword This property is required. string
joinDomainUser This property is required. string
joinOrgDomain This property is required. boolean
mustChangePasswordOnFirstLogin This property is required. boolean
numberOfAutoLogons This property is required. number
admin_password This property is required. str
allow_local_admin_password This property is required. bool
auto_generate_password This property is required. bool
change_sid This property is required. bool
enabled This property is required. bool
force This property is required. bool
initscript This property is required. str
join_domain This property is required. bool
join_domain_account_ou This property is required. str
join_domain_name This property is required. str
join_domain_password This property is required. str
join_domain_user This property is required. str
join_org_domain This property is required. bool
must_change_password_on_first_login This property is required. bool
number_of_auto_logons This property is required. float
adminPassword This property is required. String
allowLocalAdminPassword This property is required. Boolean
autoGeneratePassword This property is required. Boolean
changeSid This property is required. Boolean
enabled This property is required. Boolean
force This property is required. Boolean
initscript This property is required. String
joinDomain This property is required. Boolean
joinDomainAccountOu This property is required. String
joinDomainName This property is required. String
joinDomainPassword This property is required. String
joinDomainUser This property is required. String
joinOrgDomain This property is required. Boolean
mustChangePasswordOnFirstLogin This property is required. Boolean
numberOfAutoLogons This property is required. Number

GetVmDisk

BusNumber This property is required. string
Name This property is required. string
A name or ID for the standalone VM in VDC
SizeInMb This property is required. double
UnitNumber This property is required. string
BusNumber This property is required. string
Name This property is required. string
A name or ID for the standalone VM in VDC
SizeInMb This property is required. float64
UnitNumber This property is required. string
busNumber This property is required. String
name This property is required. String
A name or ID for the standalone VM in VDC
sizeInMb This property is required. Double
unitNumber This property is required. String
busNumber This property is required. string
name This property is required. string
A name or ID for the standalone VM in VDC
sizeInMb This property is required. number
unitNumber This property is required. string
bus_number This property is required. str
name This property is required. str
A name or ID for the standalone VM in VDC
size_in_mb This property is required. float
unit_number This property is required. str
busNumber This property is required. String
name This property is required. String
A name or ID for the standalone VM in VDC
sizeInMb This property is required. Number
unitNumber This property is required. String

GetVmExtraConfig

Key This property is required. string
Required This property is required. bool
Value This property is required. string
Key This property is required. string
Required This property is required. bool
Value This property is required. string
key This property is required. String
required This property is required. Boolean
value This property is required. String
key This property is required. string
required This property is required. boolean
value This property is required. string
key This property is required. str
required This property is required. bool
value This property is required. str
key This property is required. String
required This property is required. Boolean
value This property is required. String

GetVmInternalDisk

BusNumber This property is required. double
BusType This property is required. string
DiskId This property is required. string
Iops This property is required. double
SizeInMb This property is required. double
StorageProfile This property is required. string
ThinProvisioned This property is required. bool
UnitNumber This property is required. double
BusNumber This property is required. float64
BusType This property is required. string
DiskId This property is required. string
Iops This property is required. float64
SizeInMb This property is required. float64
StorageProfile This property is required. string
ThinProvisioned This property is required. bool
UnitNumber This property is required. float64
busNumber This property is required. Double
busType This property is required. String
diskId This property is required. String
iops This property is required. Double
sizeInMb This property is required. Double
storageProfile This property is required. String
thinProvisioned This property is required. Boolean
unitNumber This property is required. Double
busNumber This property is required. number
busType This property is required. string
diskId This property is required. string
iops This property is required. number
sizeInMb This property is required. number
storageProfile This property is required. string
thinProvisioned This property is required. boolean
unitNumber This property is required. number
bus_number This property is required. float
bus_type This property is required. str
disk_id This property is required. str
iops This property is required. float
size_in_mb This property is required. float
storage_profile This property is required. str
thin_provisioned This property is required. bool
unit_number This property is required. float
busNumber This property is required. Number
busType This property is required. String
diskId This property is required. String
iops This property is required. Number
sizeInMb This property is required. Number
storageProfile This property is required. String
thinProvisioned This property is required. Boolean
unitNumber This property is required. Number

GetVmMetadataEntry

IsSystem This property is required. bool
Key This property is required. string
Type This property is required. string
UserAccess This property is required. string
Value This property is required. string
IsSystem This property is required. bool
Key This property is required. string
Type This property is required. string
UserAccess This property is required. string
Value This property is required. string
isSystem This property is required. Boolean
key This property is required. String
type This property is required. String
userAccess This property is required. String
value This property is required. String
isSystem This property is required. boolean
key This property is required. string
type This property is required. string
userAccess This property is required. string
value This property is required. string
is_system This property is required. bool
key This property is required. str
type This property is required. str
user_access This property is required. str
value This property is required. str
isSystem This property is required. Boolean
key This property is required. String
type This property is required. String
userAccess This property is required. String
value This property is required. String

GetVmNetwork

AdapterType This property is required. string
Connected This property is required. bool
Ip This property is required. string
IpAllocationMode This property is required. string
IsPrimary This property is required. bool
Mac This property is required. string
Name This property is required. string
A name or ID for the standalone VM in VDC
SecondaryIp This property is required. string
SecondaryIpAllocationMode This property is required. string
Type This property is required. string
AdapterType This property is required. string
Connected This property is required. bool
Ip This property is required. string
IpAllocationMode This property is required. string
IsPrimary This property is required. bool
Mac This property is required. string
Name This property is required. string
A name or ID for the standalone VM in VDC
SecondaryIp This property is required. string
SecondaryIpAllocationMode This property is required. string
Type This property is required. string
adapterType This property is required. String
connected This property is required. Boolean
ip This property is required. String
ipAllocationMode This property is required. String
isPrimary This property is required. Boolean
mac This property is required. String
name This property is required. String
A name or ID for the standalone VM in VDC
secondaryIp This property is required. String
secondaryIpAllocationMode This property is required. String
type This property is required. String
adapterType This property is required. string
connected This property is required. boolean
ip This property is required. string
ipAllocationMode This property is required. string
isPrimary This property is required. boolean
mac This property is required. string
name This property is required. string
A name or ID for the standalone VM in VDC
secondaryIp This property is required. string
secondaryIpAllocationMode This property is required. string
type This property is required. string
adapter_type This property is required. str
connected This property is required. bool
ip This property is required. str
ip_allocation_mode This property is required. str
is_primary This property is required. bool
mac This property is required. str
name This property is required. str
A name or ID for the standalone VM in VDC
secondary_ip This property is required. str
secondary_ip_allocation_mode This property is required. str
type This property is required. str
adapterType This property is required. String
connected This property is required. Boolean
ip This property is required. String
ipAllocationMode This property is required. String
isPrimary This property is required. Boolean
mac This property is required. String
name This property is required. String
A name or ID for the standalone VM in VDC
secondaryIp This property is required. String
secondaryIpAllocationMode This property is required. String
type This property is required. String

Package Details

Repository
vcd vmware/terraform-provider-vcd
License
Notes
This Pulumi package is based on the vcd Terraform Provider.
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware