1. Packages
  2. Proxmox Virtual Environment (Proxmox VE)
  3. API Docs
  4. getVm2
Proxmox Virtual Environment (Proxmox VE) v6.18.1 published on Tuesday, Jan 7, 2025 by Daniel Muehlbachler-Pietrzykowski

proxmoxve.getVm2

Explore with Pulumi AI

Proxmox Virtual Environment (Proxmox VE) v6.18.1 published on Tuesday, Jan 7, 2025 by Daniel Muehlbachler-Pietrzykowski

!> DO NOT USE This is an experimental implementation of a Proxmox VM datasource using Plugin Framework.

Using getVm2

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 getVm2(args: GetVm2Args, opts?: InvokeOptions): Promise<GetVm2Result>
function getVm2Output(args: GetVm2OutputArgs, opts?: InvokeOptions): Output<GetVm2Result>
Copy
def get_vm2(clone: Optional[GetVm2Clone] = None,
            cpu: Optional[GetVm2Cpu] = None,
            description: Optional[str] = None,
            id: Optional[int] = None,
            name: Optional[str] = None,
            node_name: Optional[str] = None,
            tags: Optional[Sequence[str]] = None,
            template: Optional[bool] = None,
            timeouts: Optional[GetVm2Timeouts] = None,
            vga: Optional[GetVm2Vga] = None,
            opts: Optional[InvokeOptions] = None) -> GetVm2Result
def get_vm2_output(clone: Optional[pulumi.Input[GetVm2CloneArgs]] = None,
            cpu: Optional[pulumi.Input[GetVm2CpuArgs]] = None,
            description: Optional[pulumi.Input[str]] = None,
            id: Optional[pulumi.Input[int]] = None,
            name: Optional[pulumi.Input[str]] = None,
            node_name: Optional[pulumi.Input[str]] = None,
            tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
            template: Optional[pulumi.Input[bool]] = None,
            timeouts: Optional[pulumi.Input[GetVm2TimeoutsArgs]] = None,
            vga: Optional[pulumi.Input[GetVm2VgaArgs]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetVm2Result]
Copy
func LookupVm2(ctx *Context, args *LookupVm2Args, opts ...InvokeOption) (*LookupVm2Result, error)
func LookupVm2Output(ctx *Context, args *LookupVm2OutputArgs, opts ...InvokeOption) LookupVm2ResultOutput
Copy

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

public static class GetVm2 
{
    public static Task<GetVm2Result> InvokeAsync(GetVm2Args args, InvokeOptions? opts = null)
    public static Output<GetVm2Result> Invoke(GetVm2InvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetVm2Result> getVm2(GetVm2Args args, InvokeOptions options)
public static Output<GetVm2Result> getVm2(GetVm2Args args, InvokeOptions options)
Copy
fn::invoke:
  function: proxmoxve:index/getVm2:getVm2
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id This property is required. int
The unique identifier of the VM in the Proxmox cluster.
NodeName This property is required. string
The name of the node where the VM is provisioned.
Clone Pulumi.ProxmoxVE.Inputs.GetVm2Clone
The cloning configuration.
Cpu Pulumi.ProxmoxVE.Inputs.GetVm2Cpu
The CPU configuration.
Description string
The description of the VM.
Name string
The name of the VM.
Tags List<string>
The tags assigned to the VM.
Template bool
Whether the VM is a template.
Timeouts Pulumi.ProxmoxVE.Inputs.GetVm2Timeouts
Vga Pulumi.ProxmoxVE.Inputs.GetVm2Vga
The VGA configuration.
Id This property is required. int
The unique identifier of the VM in the Proxmox cluster.
NodeName This property is required. string
The name of the node where the VM is provisioned.
Clone GetVm2Clone
The cloning configuration.
Cpu GetVm2Cpu
The CPU configuration.
Description string
The description of the VM.
Name string
The name of the VM.
Tags []string
The tags assigned to the VM.
Template bool
Whether the VM is a template.
Timeouts GetVm2Timeouts
Vga GetVm2Vga
The VGA configuration.
id This property is required. Integer
The unique identifier of the VM in the Proxmox cluster.
nodeName This property is required. String
The name of the node where the VM is provisioned.
clone_ GetVm2Clone
The cloning configuration.
cpu GetVm2Cpu
The CPU configuration.
description String
The description of the VM.
name String
The name of the VM.
tags List<String>
The tags assigned to the VM.
template Boolean
Whether the VM is a template.
timeouts GetVm2Timeouts
vga GetVm2Vga
The VGA configuration.
id This property is required. number
The unique identifier of the VM in the Proxmox cluster.
nodeName This property is required. string
The name of the node where the VM is provisioned.
clone GetVm2Clone
The cloning configuration.
cpu GetVm2Cpu
The CPU configuration.
description string
The description of the VM.
name string
The name of the VM.
tags string[]
The tags assigned to the VM.
template boolean
Whether the VM is a template.
timeouts GetVm2Timeouts
vga GetVm2Vga
The VGA configuration.
id This property is required. int
The unique identifier of the VM in the Proxmox cluster.
node_name This property is required. str
The name of the node where the VM is provisioned.
clone GetVm2Clone
The cloning configuration.
cpu GetVm2Cpu
The CPU configuration.
description str
The description of the VM.
name str
The name of the VM.
tags Sequence[str]
The tags assigned to the VM.
template bool
Whether the VM is a template.
timeouts GetVm2Timeouts
vga GetVm2Vga
The VGA configuration.
id This property is required. Number
The unique identifier of the VM in the Proxmox cluster.
nodeName This property is required. String
The name of the node where the VM is provisioned.
clone Property Map
The cloning configuration.
cpu Property Map
The CPU configuration.
description String
The description of the VM.
name String
The name of the VM.
tags List<String>
The tags assigned to the VM.
template Boolean
Whether the VM is a template.
timeouts Property Map
vga Property Map
The VGA configuration.

getVm2 Result

The following output properties are available:

Cpu Pulumi.ProxmoxVE.Outputs.GetVm2Cpu
The CPU configuration.
Id int
The unique identifier of the VM in the Proxmox cluster.
NodeName string
The name of the node where the VM is provisioned.
Tags List<string>
The tags assigned to the VM.
Vga Pulumi.ProxmoxVE.Outputs.GetVm2Vga
The VGA configuration.
Clone Pulumi.ProxmoxVE.Outputs.GetVm2Clone
The cloning configuration.
Description string
The description of the VM.
Name string
The name of the VM.
Template bool
Whether the VM is a template.
Timeouts Pulumi.ProxmoxVE.Outputs.GetVm2Timeouts
Cpu GetVm2Cpu
The CPU configuration.
Id int
The unique identifier of the VM in the Proxmox cluster.
NodeName string
The name of the node where the VM is provisioned.
Tags []string
The tags assigned to the VM.
Vga GetVm2Vga
The VGA configuration.
Clone GetVm2Clone
The cloning configuration.
Description string
The description of the VM.
Name string
The name of the VM.
Template bool
Whether the VM is a template.
Timeouts GetVm2Timeouts
cpu GetVm2Cpu
The CPU configuration.
id Integer
The unique identifier of the VM in the Proxmox cluster.
nodeName String
The name of the node where the VM is provisioned.
tags List<String>
The tags assigned to the VM.
vga GetVm2Vga
The VGA configuration.
clone_ GetVm2Clone
The cloning configuration.
description String
The description of the VM.
name String
The name of the VM.
template Boolean
Whether the VM is a template.
timeouts GetVm2Timeouts
cpu GetVm2Cpu
The CPU configuration.
id number
The unique identifier of the VM in the Proxmox cluster.
nodeName string
The name of the node where the VM is provisioned.
tags string[]
The tags assigned to the VM.
vga GetVm2Vga
The VGA configuration.
clone GetVm2Clone
The cloning configuration.
description string
The description of the VM.
name string
The name of the VM.
template boolean
Whether the VM is a template.
timeouts GetVm2Timeouts
cpu GetVm2Cpu
The CPU configuration.
id int
The unique identifier of the VM in the Proxmox cluster.
node_name str
The name of the node where the VM is provisioned.
tags Sequence[str]
The tags assigned to the VM.
vga GetVm2Vga
The VGA configuration.
clone GetVm2Clone
The cloning configuration.
description str
The description of the VM.
name str
The name of the VM.
template bool
Whether the VM is a template.
timeouts GetVm2Timeouts
cpu Property Map
The CPU configuration.
id Number
The unique identifier of the VM in the Proxmox cluster.
nodeName String
The name of the node where the VM is provisioned.
tags List<String>
The tags assigned to the VM.
vga Property Map
The VGA configuration.
clone Property Map
The cloning configuration.
description String
The description of the VM.
name String
The name of the VM.
template Boolean
Whether the VM is a template.
timeouts Property Map

Supporting Types

GetVm2Clone

Id This property is required. int
The ID of the VM to clone.
Retries This property is required. int
The number of retries to perform when cloning the VM (default: 3).
Id This property is required. int
The ID of the VM to clone.
Retries This property is required. int
The number of retries to perform when cloning the VM (default: 3).
id This property is required. Integer
The ID of the VM to clone.
retries This property is required. Integer
The number of retries to perform when cloning the VM (default: 3).
id This property is required. number
The ID of the VM to clone.
retries This property is required. number
The number of retries to perform when cloning the VM (default: 3).
id This property is required. int
The ID of the VM to clone.
retries This property is required. int
The number of retries to perform when cloning the VM (default: 3).
id This property is required. Number
The ID of the VM to clone.
retries This property is required. Number
The number of retries to perform when cloning the VM (default: 3).

GetVm2Cpu

Affinity This property is required. string
List of host cores used to execute guest processes, for example: '0,5,8-11'
Architecture This property is required. string
The CPU architecture.
Cores This property is required. int
The number of CPU cores per socket.
Flags This property is required. List<string>
Set of additional CPU flags.
Hotplugged This property is required. int
The number of hotplugged vCPUs.
Limit This property is required. int
Limit of CPU usage.
Numa This property is required. bool
Enable NUMA.
Sockets This property is required. int
The number of CPU sockets.
Type This property is required. string
Emulated CPU type.
Units This property is required. int
CPU weight for a VM
Affinity This property is required. string
List of host cores used to execute guest processes, for example: '0,5,8-11'
Architecture This property is required. string
The CPU architecture.
Cores This property is required. int
The number of CPU cores per socket.
Flags This property is required. []string
Set of additional CPU flags.
Hotplugged This property is required. int
The number of hotplugged vCPUs.
Limit This property is required. int
Limit of CPU usage.
Numa This property is required. bool
Enable NUMA.
Sockets This property is required. int
The number of CPU sockets.
Type This property is required. string
Emulated CPU type.
Units This property is required. int
CPU weight for a VM
affinity This property is required. String
List of host cores used to execute guest processes, for example: '0,5,8-11'
architecture This property is required. String
The CPU architecture.
cores This property is required. Integer
The number of CPU cores per socket.
flags This property is required. List<String>
Set of additional CPU flags.
hotplugged This property is required. Integer
The number of hotplugged vCPUs.
limit This property is required. Integer
Limit of CPU usage.
numa This property is required. Boolean
Enable NUMA.
sockets This property is required. Integer
The number of CPU sockets.
type This property is required. String
Emulated CPU type.
units This property is required. Integer
CPU weight for a VM
affinity This property is required. string
List of host cores used to execute guest processes, for example: '0,5,8-11'
architecture This property is required. string
The CPU architecture.
cores This property is required. number
The number of CPU cores per socket.
flags This property is required. string[]
Set of additional CPU flags.
hotplugged This property is required. number
The number of hotplugged vCPUs.
limit This property is required. number
Limit of CPU usage.
numa This property is required. boolean
Enable NUMA.
sockets This property is required. number
The number of CPU sockets.
type This property is required. string
Emulated CPU type.
units This property is required. number
CPU weight for a VM
affinity This property is required. str
List of host cores used to execute guest processes, for example: '0,5,8-11'
architecture This property is required. str
The CPU architecture.
cores This property is required. int
The number of CPU cores per socket.
flags This property is required. Sequence[str]
Set of additional CPU flags.
hotplugged This property is required. int
The number of hotplugged vCPUs.
limit This property is required. int
Limit of CPU usage.
numa This property is required. bool
Enable NUMA.
sockets This property is required. int
The number of CPU sockets.
type This property is required. str
Emulated CPU type.
units This property is required. int
CPU weight for a VM
affinity This property is required. String
List of host cores used to execute guest processes, for example: '0,5,8-11'
architecture This property is required. String
The CPU architecture.
cores This property is required. Number
The number of CPU cores per socket.
flags This property is required. List<String>
Set of additional CPU flags.
hotplugged This property is required. Number
The number of hotplugged vCPUs.
limit This property is required. Number
Limit of CPU usage.
numa This property is required. Boolean
Enable NUMA.
sockets This property is required. Number
The number of CPU sockets.
type This property is required. String
Emulated CPU type.
units This property is required. Number
CPU weight for a VM

GetVm2Timeouts

Read string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
Read string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
read String
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
read string
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
read str
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
read String
A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.

GetVm2Vga

Clipboard This property is required. string
Enable a specific clipboard.
Memory This property is required. int
The VGA memory in megabytes (4-512 MB). Has no effect with serial display.
Type This property is required. string
The VGA type.
Clipboard This property is required. string
Enable a specific clipboard.
Memory This property is required. int
The VGA memory in megabytes (4-512 MB). Has no effect with serial display.
Type This property is required. string
The VGA type.
clipboard This property is required. String
Enable a specific clipboard.
memory This property is required. Integer
The VGA memory in megabytes (4-512 MB). Has no effect with serial display.
type This property is required. String
The VGA type.
clipboard This property is required. string
Enable a specific clipboard.
memory This property is required. number
The VGA memory in megabytes (4-512 MB). Has no effect with serial display.
type This property is required. string
The VGA type.
clipboard This property is required. str
Enable a specific clipboard.
memory This property is required. int
The VGA memory in megabytes (4-512 MB). Has no effect with serial display.
type This property is required. str
The VGA type.
clipboard This property is required. String
Enable a specific clipboard.
memory This property is required. Number
The VGA memory in megabytes (4-512 MB). Has no effect with serial display.
type This property is required. String
The VGA type.

Package Details

Repository
proxmoxve muhlba91/pulumi-proxmoxve
License
Apache-2.0
Notes
This Pulumi package is based on the proxmox Terraform Provider.
Proxmox Virtual Environment (Proxmox VE) v6.18.1 published on Tuesday, Jan 7, 2025 by Daniel Muehlbachler-Pietrzykowski