Docs Packages
  1. Packages
  2. Proxmox Virtual Environment (Proxmox VE)
  3. API Docs
  4. getVm2
Proxmox Virtual Environment (Proxmox VE) v6.10.1 published on Friday, Jun 28, 2024 by Daniel Muehlbachler-Pietrzykowski
muhlba91/pulumi-proxmoxve

proxmoxve.getVm2

Explore with Pulumi AI

proxmoxve logo
Proxmox Virtual Environment (Proxmox VE) v6.10.1 published on Friday, Jun 28, 2024 by Daniel Muehlbachler-Pietrzykowski
muhlba91/pulumi-proxmoxve

    !> 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>
    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]
    func LookupVm2(ctx *Context, args *LookupVm2Args, opts ...InvokeOption) (*LookupVm2Result, error)
func LookupVm2Output(ctx *Context, args *LookupVm2OutputArgs, opts ...InvokeOption) LookupVm2ResultOutput

    > 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)
}
    public static CompletableFuture<GetVm2Result> getVm2(GetVm2Args args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: proxmoxve:index/getVm2:getVm2
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id int
    The unique identifier of the VM in the Proxmox cluster.
    NodeName 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 int
    The unique identifier of the VM in the Proxmox cluster.
    NodeName 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 Integer
    The unique identifier of the VM in the Proxmox cluster.
    nodeName 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 number
    The unique identifier of the VM in the Proxmox cluster.
    nodeName 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 int
    The unique identifier of the VM in the Proxmox cluster.
    node_name 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 Number
    The unique identifier of the VM in the Proxmox cluster.
    nodeName 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 int
    The ID of the VM to clone.
    Retries int
    The number of retries to perform when cloning the VM (default: 3).
    Id int
    The ID of the VM to clone.
    Retries int
    The number of retries to perform when cloning the VM (default: 3).
    id Integer
    The ID of the VM to clone.
    retries Integer
    The number of retries to perform when cloning the VM (default: 3).
    id number
    The ID of the VM to clone.
    retries number
    The number of retries to perform when cloning the VM (default: 3).
    id int
    The ID of the VM to clone.
    retries int
    The number of retries to perform when cloning the VM (default: 3).
    id Number
    The ID of the VM to clone.
    retries Number
    The number of retries to perform when cloning the VM (default: 3).

    GetVm2Cpu

    Affinity string
    List of host cores used to execute guest processes, for example: '0,5,8-11'
    Architecture string
    The CPU architecture.
    Cores int
    The number of CPU cores per socket.
    Flags List<string>
    Set of additional CPU flags.
    Hotplugged int
    The number of hotplugged vCPUs.
    Limit int
    Limit of CPU usage.
    Numa bool
    Enable NUMA.
    Sockets int
    The number of CPU sockets.
    Type string
    Emulated CPU type.
    Units int
    CPU weight for a VM
    Affinity string
    List of host cores used to execute guest processes, for example: '0,5,8-11'
    Architecture string
    The CPU architecture.
    Cores int
    The number of CPU cores per socket.
    Flags []string
    Set of additional CPU flags.
    Hotplugged int
    The number of hotplugged vCPUs.
    Limit int
    Limit of CPU usage.
    Numa bool
    Enable NUMA.
    Sockets int
    The number of CPU sockets.
    Type string
    Emulated CPU type.
    Units int
    CPU weight for a VM
    affinity String
    List of host cores used to execute guest processes, for example: '0,5,8-11'
    architecture String
    The CPU architecture.
    cores Integer
    The number of CPU cores per socket.
    flags List<String>
    Set of additional CPU flags.
    hotplugged Integer
    The number of hotplugged vCPUs.
    limit Integer
    Limit of CPU usage.
    numa Boolean
    Enable NUMA.
    sockets Integer
    The number of CPU sockets.
    type String
    Emulated CPU type.
    units Integer
    CPU weight for a VM
    affinity string
    List of host cores used to execute guest processes, for example: '0,5,8-11'
    architecture string
    The CPU architecture.
    cores number
    The number of CPU cores per socket.
    flags string[]
    Set of additional CPU flags.
    hotplugged number
    The number of hotplugged vCPUs.
    limit number
    Limit of CPU usage.
    numa boolean
    Enable NUMA.
    sockets number
    The number of CPU sockets.
    type string
    Emulated CPU type.
    units number
    CPU weight for a VM
    affinity str
    List of host cores used to execute guest processes, for example: '0,5,8-11'
    architecture str
    The CPU architecture.
    cores int
    The number of CPU cores per socket.
    flags Sequence[str]
    Set of additional CPU flags.
    hotplugged int
    The number of hotplugged vCPUs.
    limit int
    Limit of CPU usage.
    numa bool
    Enable NUMA.
    sockets int
    The number of CPU sockets.
    type str
    Emulated CPU type.
    units int
    CPU weight for a VM
    affinity String
    List of host cores used to execute guest processes, for example: '0,5,8-11'
    architecture String
    The CPU architecture.
    cores Number
    The number of CPU cores per socket.
    flags List<String>
    Set of additional CPU flags.
    hotplugged Number
    The number of hotplugged vCPUs.
    limit Number
    Limit of CPU usage.
    numa Boolean
    Enable NUMA.
    sockets Number
    The number of CPU sockets.
    type String
    Emulated CPU type.
    units 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 string
    Enable a specific clipboard.
    Memory int
    The VGA memory in megabytes (4-512 MB). Has no effect with serial display.
    Type string
    The VGA type.
    Clipboard string
    Enable a specific clipboard.
    Memory int
    The VGA memory in megabytes (4-512 MB). Has no effect with serial display.
    Type string
    The VGA type.
    clipboard String
    Enable a specific clipboard.
    memory Integer
    The VGA memory in megabytes (4-512 MB). Has no effect with serial display.
    type String
    The VGA type.
    clipboard string
    Enable a specific clipboard.
    memory number
    The VGA memory in megabytes (4-512 MB). Has no effect with serial display.
    type string
    The VGA type.
    clipboard str
    Enable a specific clipboard.
    memory int
    The VGA memory in megabytes (4-512 MB). Has no effect with serial display.
    type str
    The VGA type.
    clipboard String
    Enable a specific clipboard.
    memory Number
    The VGA memory in megabytes (4-512 MB). Has no effect with serial display.
    type 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.
    proxmoxve logo
    Proxmox Virtual Environment (Proxmox VE) v6.10.1 published on Friday, Jun 28, 2024 by Daniel Muehlbachler-Pietrzykowski
    muhlba91/pulumi-proxmoxve