vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vcd.getVm
Explore with Pulumi AI
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>
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]
func LookupVm(ctx *Context, args *LookupVmArgs, opts ...InvokeOption) (*LookupVmResult, error)
func LookupVmOutput(ctx *Context, args *LookupVmOutputArgs, opts ...InvokeOption) LookupVmResultOutput
> 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)
}
public static CompletableFuture<GetVmResult> getVm(GetVmArgs args, InvokeOptions options)
public static Output<GetVmResult> getVm(GetVmArgs args, InvokeOptions options)
fn::invoke:
function: vcd:index/getVm:getVm
arguments:
# arguments dictionary
The following arguments are supported:
- Name
This property is required. string - A name or ID for the standalone VM in VDC
- Id string
- Network
Dhcp doubleWait Seconds - Org string
- The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
- Placement
Policy stringId - Sizing
Policy stringId - Vapp
Name 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
- Network
Dhcp float64Wait Seconds - Org string
- The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
- Placement
Policy stringId - Sizing
Policy stringId - Vapp
Name 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
- network
Dhcp DoubleWait Seconds - org String
- The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
- placement
Policy StringId - sizing
Policy StringId - vapp
Name 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
- network
Dhcp numberWait Seconds - org string
- The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
- placement
Policy stringId - sizing
Policy stringId - vapp
Name 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_ floatwait_ seconds - 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_ strid - sizing_
policy_ strid - 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
- network
Dhcp NumberWait Seconds - org String
- The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
- placement
Policy StringId - sizing
Policy StringId - vapp
Name String - vdc String
- The name of VDC to use, optional if defined at provider level
getVm Result
The following output properties are available:
- Boot
Options List<GetVm Boot Option> - Computer
Name string - Cpu
Cores double - Cpu
Hot boolAdd Enabled - Cpu
Limit double - Cpu
Priority string - Cpu
Reservation double - double
- Cpus double
- Customizations
List<Get
Vm Customization> - Description string
- Disks
List<Get
Vm Disk> - Expose
Hardware boolVirtualization - Extra
Configs List<GetVm Extra Config> - Firmware string
- Guest
Properties Dictionary<string, string> - Hardware
Version string - Href string
- Id string
- Inherited
Metadata Dictionary<string, string> - Internal
Disks List<GetVm Internal Disk> - Memory double
- Memory
Hot boolAdd Enabled - Memory
Limit double - Memory
Priority string - Memory
Reservation double - double
- Metadata Dictionary<string, string>
- Metadata
Entries List<GetVm Metadata Entry> - Name string
- Networks
List<Get
Vm Network> - Os
Type string - Placement
Policy stringId - List<string>
- Sizing
Policy stringId - Status double
- Status
Text string - Storage
Profile string - Vapp
Id string - Vapp
Name string - Vm
Type string - Network
Dhcp doubleWait Seconds - Org string
- Vdc string
- Boot
Options []GetVm Boot Option - Computer
Name string - Cpu
Cores float64 - Cpu
Hot boolAdd Enabled - Cpu
Limit float64 - Cpu
Priority string - Cpu
Reservation float64 - float64
- Cpus float64
- Customizations
[]Get
Vm Customization - Description string
- Disks
[]Get
Vm Disk - Expose
Hardware boolVirtualization - Extra
Configs []GetVm Extra Config - Firmware string
- Guest
Properties map[string]string - Hardware
Version string - Href string
- Id string
- Inherited
Metadata map[string]string - Internal
Disks []GetVm Internal Disk Type - Memory float64
- Memory
Hot boolAdd Enabled - Memory
Limit float64 - Memory
Priority string - Memory
Reservation float64 - float64
- Metadata map[string]string
- Metadata
Entries []GetVm Metadata Entry - Name string
- Networks
[]Get
Vm Network - Os
Type string - Placement
Policy stringId - []string
- Sizing
Policy stringId - Status float64
- Status
Text string - Storage
Profile string - Vapp
Id string - Vapp
Name string - Vm
Type string - Network
Dhcp float64Wait Seconds - Org string
- Vdc string
- boot
Options List<GetVm Boot Option> - computer
Name String - cpu
Cores Double - cpu
Hot BooleanAdd Enabled - cpu
Limit Double - cpu
Priority String - cpu
Reservation Double - Double
- cpus Double
- customizations
List<Get
Vm Customization> - description String
- disks
List<Get
Vm Disk> - expose
Hardware BooleanVirtualization - extra
Configs List<GetVm Extra Config> - firmware String
- guest
Properties Map<String,String> - hardware
Version String - href String
- id String
- inherited
Metadata Map<String,String> - internal
Disks List<GetVm Internal Disk> - memory Double
- memory
Hot BooleanAdd Enabled - memory
Limit Double - memory
Priority String - memory
Reservation Double - Double
- metadata Map<String,String>
- metadata
Entries List<GetVm Metadata Entry> - name String
- networks
List<Get
Vm Network> - os
Type String - placement
Policy StringId - List<String>
- sizing
Policy StringId - status Double
- status
Text String - storage
Profile String - vapp
Id String - vapp
Name String - vm
Type String - network
Dhcp DoubleWait Seconds - org String
- vdc String
- boot
Options GetVm Boot Option[] - computer
Name string - cpu
Cores number - cpu
Hot booleanAdd Enabled - cpu
Limit number - cpu
Priority string - cpu
Reservation number - number
- cpus number
- customizations
Get
Vm Customization[] - description string
- disks
Get
Vm Disk[] - expose
Hardware booleanVirtualization - extra
Configs GetVm Extra Config[] - firmware string
- guest
Properties {[key: string]: string} - hardware
Version string - href string
- id string
- inherited
Metadata {[key: string]: string} - internal
Disks GetVm Internal Disk[] - memory number
- memory
Hot booleanAdd Enabled - memory
Limit number - memory
Priority string - memory
Reservation number - number
- metadata {[key: string]: string}
- metadata
Entries GetVm Metadata Entry[] - name string
- networks
Get
Vm Network[] - os
Type string - placement
Policy stringId - string[]
- sizing
Policy stringId - status number
- status
Text string - storage
Profile string - vapp
Id string - vapp
Name string - vm
Type string - network
Dhcp numberWait Seconds - org string
- vdc string
- boot_
options Sequence[GetVm Boot Option] - computer_
name str - cpu_
cores float - cpu_
hot_ booladd_ enabled - cpu_
limit float - cpu_
priority str - cpu_
reservation float - float
- cpus float
- customizations
Sequence[Get
Vm Customization] - description str
- disks
Sequence[Get
Vm Disk] - expose_
hardware_ boolvirtualization - extra_
configs Sequence[GetVm Extra Config] - firmware str
- guest_
properties Mapping[str, str] - hardware_
version str - href str
- id str
- inherited_
metadata Mapping[str, str] - internal_
disks Sequence[GetVm Internal Disk] - memory float
- memory_
hot_ booladd_ enabled - memory_
limit float - memory_
priority str - memory_
reservation float - float
- metadata Mapping[str, str]
- metadata_
entries Sequence[GetVm Metadata Entry] - name str
- networks
Sequence[Get
Vm Network] - os_
type str - placement_
policy_ strid - Sequence[str]
- sizing_
policy_ strid - status float
- status_
text str - storage_
profile str - vapp_
id str - vapp_
name str - vm_
type str - network_
dhcp_ floatwait_ seconds - org str
- vdc str
- boot
Options List<Property Map> - computer
Name String - cpu
Cores Number - cpu
Hot BooleanAdd Enabled - cpu
Limit Number - cpu
Priority String - cpu
Reservation Number - Number
- cpus Number
- customizations List<Property Map>
- description String
- disks List<Property Map>
- expose
Hardware BooleanVirtualization - extra
Configs List<Property Map> - firmware String
- guest
Properties Map<String> - hardware
Version String - href String
- id String
- inherited
Metadata Map<String> - internal
Disks List<Property Map> - memory Number
- memory
Hot BooleanAdd Enabled - memory
Limit Number - memory
Priority String - memory
Reservation Number - Number
- metadata Map<String>
- metadata
Entries List<Property Map> - name String
- networks List<Property Map>
- os
Type String - placement
Policy StringId - List<String>
- sizing
Policy StringId - status Number
- status
Text String - storage
Profile String - vapp
Id String - vapp
Name String - vm
Type String - network
Dhcp NumberWait Seconds - org String
- vdc String
Supporting Types
GetVmBootOption
- Boot
Delay This property is required. double - Boot
Retry Delay This property is required. double - 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
- Boot
Delay This property is required. float64 - Boot
Retry Delay This property is required. float64 - 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
- boot
Delay This property is required. Double - boot
Retry Delay This property is required. Double - boot
Retry Enabled This property is required. Boolean - efi
Secure Boot This property is required. Boolean - enter
Bios Setup On Next Boot This property is required. Boolean
- boot
Delay This property is required. number - boot
Retry Delay This property is required. number - boot
Retry Enabled This property is required. boolean - efi
Secure Boot This property is required. boolean - enter
Bios Setup On Next Boot 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
- boot
Delay This property is required. Number - boot
Retry Delay This property is required. Number - boot
Retry Enabled This property is required. Boolean - efi
Secure Boot This property is required. Boolean - enter
Bios Setup On Next Boot This property is required. Boolean
GetVmCustomization
- Admin
Password This property is required. string - 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. string - Join
Domain This property is required. bool - Join
Domain Account Ou This property is required. string - Join
Domain Name This property is required. string - Join
Domain Password This property is required. string - Join
Domain User This property is required. string - 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. double
- Admin
Password This property is required. string - 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. string - Join
Domain This property is required. bool - Join
Domain Account Ou This property is required. string - Join
Domain Name This property is required. string - Join
Domain Password This property is required. string - Join
Domain User This property is required. string - 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. float64
- admin
Password This property is required. String - allow
Local Admin Password This property is required. Boolean - auto
Generate Password This property is required. Boolean - change
Sid This property is required. Boolean - enabled
This property is required. Boolean - force
This property is required. Boolean - initscript
This property is required. String - join
Domain This property is required. Boolean - join
Domain Account Ou This property is required. String - join
Domain Name This property is required. String - join
Domain Password This property is required. String - join
Domain User This property is required. String - join
Org Domain This property is required. Boolean - must
Change Password On First Login This property is required. Boolean - number
Of Auto Logons This property is required. Double
- admin
Password This property is required. string - allow
Local Admin Password This property is required. boolean - auto
Generate Password This property is required. boolean - change
Sid This property is required. boolean - enabled
This property is required. boolean - force
This property is required. boolean - initscript
This property is required. string - join
Domain This property is required. boolean - join
Domain Account Ou This property is required. string - join
Domain Name This property is required. string - join
Domain Password This property is required. string - join
Domain User This property is required. string - join
Org Domain This property is required. boolean - must
Change Password On First Login This property is required. boolean - number
Of Auto Logons 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
- admin
Password This property is required. String - allow
Local Admin Password This property is required. Boolean - auto
Generate Password This property is required. Boolean - change
Sid This property is required. Boolean - enabled
This property is required. Boolean - force
This property is required. Boolean - initscript
This property is required. String - join
Domain This property is required. Boolean - join
Domain Account Ou This property is required. String - join
Domain Name This property is required. String - join
Domain Password This property is required. String - join
Domain User This property is required. String - join
Org Domain This property is required. Boolean - must
Change Password On First Login This property is required. Boolean - number
Of Auto Logons This property is required. Number
GetVmDisk
- Bus
Number This property is required. string - Name
This property is required. string - A name or ID for the standalone VM in VDC
- Size
In Mb This property is required. double - Unit
Number This property is required. string
- Bus
Number This property is required. string - Name
This property is required. string - A name or ID for the standalone VM in VDC
- Size
In Mb This property is required. float64 - Unit
Number This property is required. string
- bus
Number This property is required. String - name
This property is required. String - A name or ID for the standalone VM in VDC
- size
In Mb This property is required. Double - unit
Number This property is required. String
- bus
Number This property is required. string - name
This property is required. string - A name or ID for the standalone VM in VDC
- size
In Mb This property is required. number - unit
Number 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
- bus
Number This property is required. String - name
This property is required. String - A name or ID for the standalone VM in VDC
- size
In Mb This property is required. Number - unit
Number This property is required. String
GetVmExtraConfig
GetVmInternalDisk
- Bus
Number This property is required. double - Bus
Type This property is required. string - Disk
Id This property is required. string - Iops
This property is required. double - Size
In Mb This property is required. double - Storage
Profile This property is required. string - Thin
Provisioned This property is required. bool - Unit
Number This property is required. double
- Bus
Number This property is required. float64 - Bus
Type This property is required. string - Disk
Id This property is required. string - Iops
This property is required. float64 - Size
In Mb This property is required. float64 - Storage
Profile This property is required. string - Thin
Provisioned This property is required. bool - Unit
Number This property is required. float64
- bus
Number This property is required. Double - bus
Type This property is required. String - disk
Id This property is required. String - iops
This property is required. Double - size
In Mb This property is required. Double - storage
Profile This property is required. String - thin
Provisioned This property is required. Boolean - unit
Number This property is required. Double
- bus
Number This property is required. number - bus
Type This property is required. string - disk
Id This property is required. string - iops
This property is required. number - size
In Mb This property is required. number - storage
Profile This property is required. string - thin
Provisioned This property is required. boolean - unit
Number 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
- bus
Number This property is required. Number - bus
Type This property is required. String - disk
Id This property is required. String - iops
This property is required. Number - size
In Mb This property is required. Number - storage
Profile This property is required. String - thin
Provisioned This property is required. Boolean - unit
Number This property is required. Number
GetVmMetadataEntry
- Is
System This property is required. bool - Key
This property is required. string - Type
This property is required. string - User
Access This property is required. string - Value
This property is required. string
- Is
System This property is required. bool - Key
This property is required. string - Type
This property is required. string - User
Access This property is required. string - Value
This property is required. string
- is
System This property is required. Boolean - key
This property is required. String - type
This property is required. String - user
Access This property is required. String - value
This property is required. String
- is
System This property is required. boolean - key
This property is required. string - type
This property is required. string - user
Access 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
- is
System This property is required. Boolean - key
This property is required. String - type
This property is required. String - user
Access This property is required. String - value
This property is required. String
GetVmNetwork
- Adapter
Type This property is required. string - Connected
This property is required. bool - Ip
This property is required. string - Ip
Allocation Mode This property is required. string - Is
Primary 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
- Secondary
Ip This property is required. string - Secondary
Ip Allocation Mode This property is required. string - Type
This property is required. string
- Adapter
Type This property is required. string - Connected
This property is required. bool - Ip
This property is required. string - Ip
Allocation Mode This property is required. string - Is
Primary 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
- Secondary
Ip This property is required. string - Secondary
Ip Allocation Mode This property is required. string - Type
This property is required. string
- adapter
Type This property is required. String - connected
This property is required. Boolean - ip
This property is required. String - ip
Allocation Mode This property is required. String - is
Primary 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
- secondary
Ip This property is required. String - secondary
Ip Allocation Mode This property is required. String - type
This property is required. String
- adapter
Type This property is required. string - connected
This property is required. boolean - ip
This property is required. string - ip
Allocation Mode This property is required. string - is
Primary 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
- secondary
Ip This property is required. string - secondary
Ip Allocation Mode 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
- adapter
Type This property is required. String - connected
This property is required. Boolean - ip
This property is required. String - ip
Allocation Mode This property is required. String - is
Primary 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
- secondary
Ip This property is required. String - secondary
Ip Allocation Mode 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.