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

proxmoxve.VM.VirtualMachine2

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 resource using Plugin Framework.

    It is a Proof of Concept, highly experimental and will change in future. It does not support all features of the Proxmox API for VMs and MUST NOT be used in production.

    Many attributes are marked as optional and computed in the schema, hence you may seem added to the plan with “(known after apply)” status, even if they are not set in the configuration. This is done to support the clone operation, when a VM is created from an existing VM or template, and the source attributes are copied to the clone.

    Computed attributes allow the provider to set those attributes without user input. The attributes are also marked as optional to allow the practitioner to set (or overwrite) them if needed.

    Create VirtualMachine2 Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new VirtualMachine2(name: string, args: VirtualMachine2Args, opts?: CustomResourceOptions);
    @overload
def VirtualMachine2(resource_name: str,
                    args: VirtualMachine2Args,
                    opts: Optional[ResourceOptions] = None)

@overload
def VirtualMachine2(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    node_name: Optional[str] = None,
                    cdrom: Optional[Mapping[str, _vm.VirtualMachine2CdromArgs]] = None,
                    clone: Optional[_vm.VirtualMachine2CloneArgs] = None,
                    cpu: Optional[_vm.VirtualMachine2CpuArgs] = None,
                    description: Optional[str] = None,
                    name: Optional[str] = None,
                    stop_on_destroy: Optional[bool] = None,
                    tags: Optional[Sequence[str]] = None,
                    template: Optional[bool] = None,
                    timeouts: Optional[_vm.VirtualMachine2TimeoutsArgs] = None,
                    vga: Optional[_vm.VirtualMachine2VgaArgs] = None)
    func NewVirtualMachine2(ctx *Context, name string, args VirtualMachine2Args, opts ...ResourceOption) (*VirtualMachine2, error)
    public VirtualMachine2(string name, VirtualMachine2Args args, CustomResourceOptions? opts = null)
    public VirtualMachine2(String name, VirtualMachine2Args args)
public VirtualMachine2(String name, VirtualMachine2Args args, CustomResourceOptions options)

    type: proxmoxve:VM:VirtualMachine2
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 VirtualMachine2Args
    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 VirtualMachine2Args
    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 VirtualMachine2Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VirtualMachine2Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VirtualMachine2Args
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var virtualMachine2Resource = new ProxmoxVE.VM.VirtualMachine2("virtualMachine2Resource", new()
{
    NodeName = "string",
    Cdrom = 
    {
        { "string", new ProxmoxVE.VM.Inputs.VirtualMachine2CdromArgs
        {
            FileId = "string",
        } },
    },
    Clone = new ProxmoxVE.VM.Inputs.VirtualMachine2CloneArgs
    {
        Id = 0,
        Retries = 0,
    },
    Cpu = new ProxmoxVE.VM.Inputs.VirtualMachine2CpuArgs
    {
        Affinity = "string",
        Architecture = "string",
        Cores = 0,
        Flags = new[]
        {
            "string",
        },
        Hotplugged = 0,
        Limit = 0,
        Numa = false,
        Sockets = 0,
        Type = "string",
        Units = 0,
    },
    Description = "string",
    Name = "string",
    StopOnDestroy = false,
    Tags = new[]
    {
        "string",
    },
    Template = false,
    Timeouts = new ProxmoxVE.VM.Inputs.VirtualMachine2TimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Read = "string",
        Update = "string",
    },
    Vga = new ProxmoxVE.VM.Inputs.VirtualMachine2VgaArgs
    {
        Clipboard = "string",
        Memory = 0,
        Type = "string",
    },
});

    example, err := VM.NewVirtualMachine2(ctx, "virtualMachine2Resource", &VM.VirtualMachine2Args{
	NodeName: pulumi.String("string"),
	Cdrom: vm.VirtualMachine2CdromMap{
		"string": &vm.VirtualMachine2CdromArgs{
			FileId: pulumi.String("string"),
		},
	},
	Clone: &vm.VirtualMachine2CloneArgs{
		Id:      pulumi.Int(0),
		Retries: pulumi.Int(0),
	},
	Cpu: &vm.VirtualMachine2CpuArgs{
		Affinity:     pulumi.String("string"),
		Architecture: pulumi.String("string"),
		Cores:        pulumi.Int(0),
		Flags: pulumi.StringArray{
			pulumi.String("string"),
		},
		Hotplugged: pulumi.Int(0),
		Limit:      pulumi.Int(0),
		Numa:       pulumi.Bool(false),
		Sockets:    pulumi.Int(0),
		Type:       pulumi.String("string"),
		Units:      pulumi.Int(0),
	},
	Description:   pulumi.String("string"),
	Name:          pulumi.String("string"),
	StopOnDestroy: pulumi.Bool(false),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Template: pulumi.Bool(false),
	Timeouts: &vm.VirtualMachine2TimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Read:   pulumi.String("string"),
		Update: pulumi.String("string"),
	},
	Vga: &vm.VirtualMachine2VgaArgs{
		Clipboard: pulumi.String("string"),
		Memory:    pulumi.Int(0),
		Type:      pulumi.String("string"),
	},
})

    var virtualMachine2Resource = new VirtualMachine2("virtualMachine2Resource", VirtualMachine2Args.builder()
    .nodeName("string")
    .cdrom(Map.of("string", Map.of("fileId", "string")))
    .clone(VirtualMachine2CloneArgs.builder()
        .id(0)
        .retries(0)
        .build())
    .cpu(VirtualMachine2CpuArgs.builder()
        .affinity("string")
        .architecture("string")
        .cores(0)
        .flags("string")
        .hotplugged(0)
        .limit(0)
        .numa(false)
        .sockets(0)
        .type("string")
        .units(0)
        .build())
    .description("string")
    .name("string")
    .stopOnDestroy(false)
    .tags("string")
    .template(false)
    .timeouts(VirtualMachine2TimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .read("string")
        .update("string")
        .build())
    .vga(VirtualMachine2VgaArgs.builder()
        .clipboard("string")
        .memory(0)
        .type("string")
        .build())
    .build());

    virtual_machine2_resource = proxmoxve.vm.VirtualMachine2("virtualMachine2Resource",
    node_name="string",
    cdrom={
        "string": proxmoxve.vm.VirtualMachine2CdromArgs(
            file_id="string",
        ),
    },
    clone=proxmoxve.vm.VirtualMachine2CloneArgs(
        id=0,
        retries=0,
    ),
    cpu=proxmoxve.vm.VirtualMachine2CpuArgs(
        affinity="string",
        architecture="string",
        cores=0,
        flags=["string"],
        hotplugged=0,
        limit=0,
        numa=False,
        sockets=0,
        type="string",
        units=0,
    ),
    description="string",
    name="string",
    stop_on_destroy=False,
    tags=["string"],
    template=False,
    timeouts=proxmoxve.vm.VirtualMachine2TimeoutsArgs(
        create="string",
        delete="string",
        read="string",
        update="string",
    ),
    vga=proxmoxve.vm.VirtualMachine2VgaArgs(
        clipboard="string",
        memory=0,
        type="string",
    ))

    const virtualMachine2Resource = new proxmoxve.vm.VirtualMachine2("virtualMachine2Resource", {
    nodeName: "string",
    cdrom: {
        string: {
            fileId: "string",
        },
    },
    clone: {
        id: 0,
        retries: 0,
    },
    cpu: {
        affinity: "string",
        architecture: "string",
        cores: 0,
        flags: ["string"],
        hotplugged: 0,
        limit: 0,
        numa: false,
        sockets: 0,
        type: "string",
        units: 0,
    },
    description: "string",
    name: "string",
    stopOnDestroy: false,
    tags: ["string"],
    template: false,
    timeouts: {
        create: "string",
        "delete": "string",
        read: "string",
        update: "string",
    },
    vga: {
        clipboard: "string",
        memory: 0,
        type: "string",
    },
});

    type: proxmoxve:VM:VirtualMachine2
properties:
    cdrom:
        string:
            fileId: string
    clone:
        id: 0
        retries: 0
    cpu:
        affinity: string
        architecture: string
        cores: 0
        flags:
            - string
        hotplugged: 0
        limit: 0
        numa: false
        sockets: 0
        type: string
        units: 0
    description: string
    name: string
    nodeName: string
    stopOnDestroy: false
    tags:
        - string
    template: false
    timeouts:
        create: string
        delete: string
        read: string
        update: string
    vga:
        clipboard: string
        memory: 0
        type: string

    VirtualMachine2 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 VirtualMachine2 resource accepts the following input properties:

    NodeName string
    The name of the node where the VM is provisioned.
    Cdrom Dictionary<string, Pulumi.ProxmoxVE.VM.Inputs.VirtualMachine2CdromArgs>
    The CD-ROM configuration. The key is the interface of the CD-ROM, could be one of ideN, sataN, scsiN, where N is the index of the interface. Note that q35 machine type only supports ide0 and ide2 of IDE interfaces.
    Clone Pulumi.ProxmoxVE.VM.Inputs.VirtualMachine2Clone
    The cloning configuration.
    Cpu Pulumi.ProxmoxVE.VM.Inputs.VirtualMachine2Cpu
    The CPU configuration.
    Description string
    The description of the VM.
    Name string
    The name of the VM. Doesn't have to be unique.
    StopOnDestroy bool
    Set to true to stop (rather than shutdown) the VM on destroy (defaults to false).
    Tags List<string>
    The tags assigned to the VM.
    Template bool
    Set to true to create a VM template.
    Timeouts Pulumi.ProxmoxVE.VM.Inputs.VirtualMachine2Timeouts
    Vga Pulumi.ProxmoxVE.VM.Inputs.VirtualMachine2Vga
    Configure the VGA Hardware. If you want to use high resolution modes (>= 1280x1024x16) you may need to increase the vga memory option. Since QEMU 2.9 the default VGA display type is std for all OS types besides some Windows versions (XP and older) which use cirrus. The qxl option enables the SPICE display server. For win* OS you can select how many independent displays you want, Linux guests can add displays themself. You can also run without any graphic card, using a serial device as terminal. See the Proxmox documentation section 10.2.8 for more information and available configuration parameters.
    NodeName string
    The name of the node where the VM is provisioned.
    Cdrom map[string]VirtualMachine2CdromArgs
    The CD-ROM configuration. The key is the interface of the CD-ROM, could be one of ideN, sataN, scsiN, where N is the index of the interface. Note that q35 machine type only supports ide0 and ide2 of IDE interfaces.
    Clone VirtualMachine2CloneArgs
    The cloning configuration.
    Cpu VirtualMachine2CpuArgs
    The CPU configuration.
    Description string
    The description of the VM.
    Name string
    The name of the VM. Doesn't have to be unique.
    StopOnDestroy bool
    Set to true to stop (rather than shutdown) the VM on destroy (defaults to false).
    Tags []string
    The tags assigned to the VM.
    Template bool
    Set to true to create a VM template.
    Timeouts VirtualMachine2TimeoutsArgs
    Vga VirtualMachine2VgaArgs
    Configure the VGA Hardware. If you want to use high resolution modes (>= 1280x1024x16) you may need to increase the vga memory option. Since QEMU 2.9 the default VGA display type is std for all OS types besides some Windows versions (XP and older) which use cirrus. The qxl option enables the SPICE display server. For win* OS you can select how many independent displays you want, Linux guests can add displays themself. You can also run without any graphic card, using a serial device as terminal. See the Proxmox documentation section 10.2.8 for more information and available configuration parameters.
    nodeName String
    The name of the node where the VM is provisioned.
    cdrom Map<String,VirtualMachine2CdromArgs>
    The CD-ROM configuration. The key is the interface of the CD-ROM, could be one of ideN, sataN, scsiN, where N is the index of the interface. Note that q35 machine type only supports ide0 and ide2 of IDE interfaces.
    clone_ VirtualMachine2Clone
    The cloning configuration.
    cpu VirtualMachine2Cpu
    The CPU configuration.
    description String
    The description of the VM.
    name String
    The name of the VM. Doesn't have to be unique.
    stopOnDestroy Boolean
    Set to true to stop (rather than shutdown) the VM on destroy (defaults to false).
    tags List<String>
    The tags assigned to the VM.
    template Boolean
    Set to true to create a VM template.
    timeouts VirtualMachine2Timeouts
    vga VirtualMachine2Vga
    Configure the VGA Hardware. If you want to use high resolution modes (>= 1280x1024x16) you may need to increase the vga memory option. Since QEMU 2.9 the default VGA display type is std for all OS types besides some Windows versions (XP and older) which use cirrus. The qxl option enables the SPICE display server. For win* OS you can select how many independent displays you want, Linux guests can add displays themself. You can also run without any graphic card, using a serial device as terminal. See the Proxmox documentation section 10.2.8 for more information and available configuration parameters.
    nodeName string
    The name of the node where the VM is provisioned.
    cdrom {[key: string]: VirtualMachine2CdromArgs}
    The CD-ROM configuration. The key is the interface of the CD-ROM, could be one of ideN, sataN, scsiN, where N is the index of the interface. Note that q35 machine type only supports ide0 and ide2 of IDE interfaces.
    clone VirtualMachine2Clone
    The cloning configuration.
    cpu VirtualMachine2Cpu
    The CPU configuration.
    description string
    The description of the VM.
    name string
    The name of the VM. Doesn't have to be unique.
    stopOnDestroy boolean
    Set to true to stop (rather than shutdown) the VM on destroy (defaults to false).
    tags string[]
    The tags assigned to the VM.
    template boolean
    Set to true to create a VM template.
    timeouts VirtualMachine2Timeouts
    vga VirtualMachine2Vga
    Configure the VGA Hardware. If you want to use high resolution modes (>= 1280x1024x16) you may need to increase the vga memory option. Since QEMU 2.9 the default VGA display type is std for all OS types besides some Windows versions (XP and older) which use cirrus. The qxl option enables the SPICE display server. For win* OS you can select how many independent displays you want, Linux guests can add displays themself. You can also run without any graphic card, using a serial device as terminal. See the Proxmox documentation section 10.2.8 for more information and available configuration parameters.
    node_name str
    The name of the node where the VM is provisioned.
    cdrom Mapping[str, vm.VirtualMachine2CdromArgs]
    The CD-ROM configuration. The key is the interface of the CD-ROM, could be one of ideN, sataN, scsiN, where N is the index of the interface. Note that q35 machine type only supports ide0 and ide2 of IDE interfaces.
    clone vm.VirtualMachine2CloneArgs
    The cloning configuration.
    cpu vm.VirtualMachine2CpuArgs
    The CPU configuration.
    description str
    The description of the VM.
    name str
    The name of the VM. Doesn't have to be unique.
    stop_on_destroy bool
    Set to true to stop (rather than shutdown) the VM on destroy (defaults to false).
    tags Sequence[str]
    The tags assigned to the VM.
    template bool
    Set to true to create a VM template.
    timeouts vm.VirtualMachine2TimeoutsArgs
    vga vm.VirtualMachine2VgaArgs
    Configure the VGA Hardware. If you want to use high resolution modes (>= 1280x1024x16) you may need to increase the vga memory option. Since QEMU 2.9 the default VGA display type is std for all OS types besides some Windows versions (XP and older) which use cirrus. The qxl option enables the SPICE display server. For win* OS you can select how many independent displays you want, Linux guests can add displays themself. You can also run without any graphic card, using a serial device as terminal. See the Proxmox documentation section 10.2.8 for more information and available configuration parameters.
    nodeName String
    The name of the node where the VM is provisioned.
    cdrom Map<Property Map>
    The CD-ROM configuration. The key is the interface of the CD-ROM, could be one of ideN, sataN, scsiN, where N is the index of the interface. Note that q35 machine type only supports ide0 and ide2 of IDE interfaces.
    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. Doesn't have to be unique.
    stopOnDestroy Boolean
    Set to true to stop (rather than shutdown) the VM on destroy (defaults to false).
    tags List<String>
    The tags assigned to the VM.
    template Boolean
    Set to true to create a VM template.
    timeouts Property Map
    vga Property Map
    Configure the VGA Hardware. If you want to use high resolution modes (>= 1280x1024x16) you may need to increase the vga memory option. Since QEMU 2.9 the default VGA display type is std for all OS types besides some Windows versions (XP and older) which use cirrus. The qxl option enables the SPICE display server. For win* OS you can select how many independent displays you want, Linux guests can add displays themself. You can also run without any graphic card, using a serial device as terminal. See the Proxmox documentation section 10.2.8 for more information and available configuration parameters.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the VirtualMachine2 resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing VirtualMachine2 Resource

    Get an existing VirtualMachine2 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?: VirtualMachine2State, opts?: CustomResourceOptions): VirtualMachine2
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cdrom: Optional[Mapping[str, _vm.VirtualMachine2CdromArgs]] = None,
        clone: Optional[_vm.VirtualMachine2CloneArgs] = None,
        cpu: Optional[_vm.VirtualMachine2CpuArgs] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        node_name: Optional[str] = None,
        stop_on_destroy: Optional[bool] = None,
        tags: Optional[Sequence[str]] = None,
        template: Optional[bool] = None,
        timeouts: Optional[_vm.VirtualMachine2TimeoutsArgs] = None,
        vga: Optional[_vm.VirtualMachine2VgaArgs] = None) -> VirtualMachine2
    func GetVirtualMachine2(ctx *Context, name string, id IDInput, state *VirtualMachine2State, opts ...ResourceOption) (*VirtualMachine2, error)
    public static VirtualMachine2 Get(string name, Input<string> id, VirtualMachine2State? state, CustomResourceOptions? opts = null)
    public static VirtualMachine2 get(String name, Output<String> id, VirtualMachine2State 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.
    The following state arguments are supported:
    Cdrom Dictionary<string, Pulumi.ProxmoxVE.VM.Inputs.VirtualMachine2CdromArgs>
    The CD-ROM configuration. The key is the interface of the CD-ROM, could be one of ideN, sataN, scsiN, where N is the index of the interface. Note that q35 machine type only supports ide0 and ide2 of IDE interfaces.
    Clone Pulumi.ProxmoxVE.VM.Inputs.VirtualMachine2Clone
    The cloning configuration.
    Cpu Pulumi.ProxmoxVE.VM.Inputs.VirtualMachine2Cpu
    The CPU configuration.
    Description string
    The description of the VM.
    Name string
    The name of the VM. Doesn't have to be unique.
    NodeName string
    The name of the node where the VM is provisioned.
    StopOnDestroy bool
    Set to true to stop (rather than shutdown) the VM on destroy (defaults to false).
    Tags List<string>
    The tags assigned to the VM.
    Template bool
    Set to true to create a VM template.
    Timeouts Pulumi.ProxmoxVE.VM.Inputs.VirtualMachine2Timeouts
    Vga Pulumi.ProxmoxVE.VM.Inputs.VirtualMachine2Vga
    Configure the VGA Hardware. If you want to use high resolution modes (>= 1280x1024x16) you may need to increase the vga memory option. Since QEMU 2.9 the default VGA display type is std for all OS types besides some Windows versions (XP and older) which use cirrus. The qxl option enables the SPICE display server. For win* OS you can select how many independent displays you want, Linux guests can add displays themself. You can also run without any graphic card, using a serial device as terminal. See the Proxmox documentation section 10.2.8 for more information and available configuration parameters.
    Cdrom map[string]VirtualMachine2CdromArgs
    The CD-ROM configuration. The key is the interface of the CD-ROM, could be one of ideN, sataN, scsiN, where N is the index of the interface. Note that q35 machine type only supports ide0 and ide2 of IDE interfaces.
    Clone VirtualMachine2CloneArgs
    The cloning configuration.
    Cpu VirtualMachine2CpuArgs
    The CPU configuration.
    Description string
    The description of the VM.
    Name string
    The name of the VM. Doesn't have to be unique.
    NodeName string
    The name of the node where the VM is provisioned.
    StopOnDestroy bool
    Set to true to stop (rather than shutdown) the VM on destroy (defaults to false).
    Tags []string
    The tags assigned to the VM.
    Template bool
    Set to true to create a VM template.
    Timeouts VirtualMachine2TimeoutsArgs
    Vga VirtualMachine2VgaArgs
    Configure the VGA Hardware. If you want to use high resolution modes (>= 1280x1024x16) you may need to increase the vga memory option. Since QEMU 2.9 the default VGA display type is std for all OS types besides some Windows versions (XP and older) which use cirrus. The qxl option enables the SPICE display server. For win* OS you can select how many independent displays you want, Linux guests can add displays themself. You can also run without any graphic card, using a serial device as terminal. See the Proxmox documentation section 10.2.8 for more information and available configuration parameters.
    cdrom Map<String,VirtualMachine2CdromArgs>
    The CD-ROM configuration. The key is the interface of the CD-ROM, could be one of ideN, sataN, scsiN, where N is the index of the interface. Note that q35 machine type only supports ide0 and ide2 of IDE interfaces.
    clone_ VirtualMachine2Clone
    The cloning configuration.
    cpu VirtualMachine2Cpu
    The CPU configuration.
    description String
    The description of the VM.
    name String
    The name of the VM. Doesn't have to be unique.
    nodeName String
    The name of the node where the VM is provisioned.
    stopOnDestroy Boolean
    Set to true to stop (rather than shutdown) the VM on destroy (defaults to false).
    tags List<String>
    The tags assigned to the VM.
    template Boolean
    Set to true to create a VM template.
    timeouts VirtualMachine2Timeouts
    vga VirtualMachine2Vga
    Configure the VGA Hardware. If you want to use high resolution modes (>= 1280x1024x16) you may need to increase the vga memory option. Since QEMU 2.9 the default VGA display type is std for all OS types besides some Windows versions (XP and older) which use cirrus. The qxl option enables the SPICE display server. For win* OS you can select how many independent displays you want, Linux guests can add displays themself. You can also run without any graphic card, using a serial device as terminal. See the Proxmox documentation section 10.2.8 for more information and available configuration parameters.
    cdrom {[key: string]: VirtualMachine2CdromArgs}
    The CD-ROM configuration. The key is the interface of the CD-ROM, could be one of ideN, sataN, scsiN, where N is the index of the interface. Note that q35 machine type only supports ide0 and ide2 of IDE interfaces.
    clone VirtualMachine2Clone
    The cloning configuration.
    cpu VirtualMachine2Cpu
    The CPU configuration.
    description string
    The description of the VM.
    name string
    The name of the VM. Doesn't have to be unique.
    nodeName string
    The name of the node where the VM is provisioned.
    stopOnDestroy boolean
    Set to true to stop (rather than shutdown) the VM on destroy (defaults to false).
    tags string[]
    The tags assigned to the VM.
    template boolean
    Set to true to create a VM template.
    timeouts VirtualMachine2Timeouts
    vga VirtualMachine2Vga
    Configure the VGA Hardware. If you want to use high resolution modes (>= 1280x1024x16) you may need to increase the vga memory option. Since QEMU 2.9 the default VGA display type is std for all OS types besides some Windows versions (XP and older) which use cirrus. The qxl option enables the SPICE display server. For win* OS you can select how many independent displays you want, Linux guests can add displays themself. You can also run without any graphic card, using a serial device as terminal. See the Proxmox documentation section 10.2.8 for more information and available configuration parameters.
    cdrom Mapping[str, vm.VirtualMachine2CdromArgs]
    The CD-ROM configuration. The key is the interface of the CD-ROM, could be one of ideN, sataN, scsiN, where N is the index of the interface. Note that q35 machine type only supports ide0 and ide2 of IDE interfaces.
    clone vm.VirtualMachine2CloneArgs
    The cloning configuration.
    cpu vm.VirtualMachine2CpuArgs
    The CPU configuration.
    description str
    The description of the VM.
    name str
    The name of the VM. Doesn't have to be unique.
    node_name str
    The name of the node where the VM is provisioned.
    stop_on_destroy bool
    Set to true to stop (rather than shutdown) the VM on destroy (defaults to false).
    tags Sequence[str]
    The tags assigned to the VM.
    template bool
    Set to true to create a VM template.
    timeouts vm.VirtualMachine2TimeoutsArgs
    vga vm.VirtualMachine2VgaArgs
    Configure the VGA Hardware. If you want to use high resolution modes (>= 1280x1024x16) you may need to increase the vga memory option. Since QEMU 2.9 the default VGA display type is std for all OS types besides some Windows versions (XP and older) which use cirrus. The qxl option enables the SPICE display server. For win* OS you can select how many independent displays you want, Linux guests can add displays themself. You can also run without any graphic card, using a serial device as terminal. See the Proxmox documentation section 10.2.8 for more information and available configuration parameters.
    cdrom Map<Property Map>
    The CD-ROM configuration. The key is the interface of the CD-ROM, could be one of ideN, sataN, scsiN, where N is the index of the interface. Note that q35 machine type only supports ide0 and ide2 of IDE interfaces.
    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. Doesn't have to be unique.
    nodeName String
    The name of the node where the VM is provisioned.
    stopOnDestroy Boolean
    Set to true to stop (rather than shutdown) the VM on destroy (defaults to false).
    tags List<String>
    The tags assigned to the VM.
    template Boolean
    Set to true to create a VM template.
    timeouts Property Map
    vga Property Map
    Configure the VGA Hardware. If you want to use high resolution modes (>= 1280x1024x16) you may need to increase the vga memory option. Since QEMU 2.9 the default VGA display type is std for all OS types besides some Windows versions (XP and older) which use cirrus. The qxl option enables the SPICE display server. For win* OS you can select how many independent displays you want, Linux guests can add displays themself. You can also run without any graphic card, using a serial device as terminal. See the Proxmox documentation section 10.2.8 for more information and available configuration parameters.

    Supporting Types

    VirtualMachine2Cdrom, VirtualMachine2CdromArgs

    FileId string
    The file ID of the CD-ROM, or cdrom|none. Defaults to none to leave the CD-ROM empty. Use cdrom to connect to the physical drive.
    FileId string
    The file ID of the CD-ROM, or cdrom|none. Defaults to none to leave the CD-ROM empty. Use cdrom to connect to the physical drive.
    fileId String
    The file ID of the CD-ROM, or cdrom|none. Defaults to none to leave the CD-ROM empty. Use cdrom to connect to the physical drive.
    fileId string
    The file ID of the CD-ROM, or cdrom|none. Defaults to none to leave the CD-ROM empty. Use cdrom to connect to the physical drive.
    file_id str
    The file ID of the CD-ROM, or cdrom|none. Defaults to none to leave the CD-ROM empty. Use cdrom to connect to the physical drive.
    fileId String
    The file ID of the CD-ROM, or cdrom|none. Defaults to none to leave the CD-ROM empty. Use cdrom to connect to the physical drive.

    VirtualMachine2Clone, VirtualMachine2CloneArgs

    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).

    VirtualMachine2Cpu, VirtualMachine2CpuArgs

    Affinity string
    The CPU cores that are used to run the VM’s vCPU. The value is a list of CPU IDs, separated by commas. The CPU IDs are zero-based. For example, 0,1,2,3 (which also can be shortened to 0-3) means that the VM’s vCPUs are run on the first four CPU cores. Setting affinity is only allowed for root@pam authenticated user.
    Architecture string
    The CPU architecture <aarch64 | x86_64> (defaults to the host). Setting affinity is only allowed for root@pam authenticated user.
    Cores int
    The number of CPU cores per socket (defaults to 1).
    Flags List<string>
    Set of additional CPU flags. Use +FLAG to enable, -FLAG to disable a flag. Custom CPU models can specify any flag supported by QEMU/KVM, VM-specific flags must be from the following set for security reasons: pcid, spec-ctrl, ibpb, ssbd, virt-ssbd, amd-ssbd, amd-no-ssb, pdpe1gb, md-clear, hv-tlbflush, hv-evmcs, aes.
    Hotplugged int
    The number of hotplugged vCPUs (defaults to 0).
    Limit int
    Limit of CPU usage (defaults to 0 which means no limit).
    Numa bool
    Enable NUMA (defaults to false).
    Sockets int
    The number of CPU sockets (defaults to 1).
    Type string
    Emulated CPU type, it's recommended to use x86-64-v2-AES or higher (defaults to kvm64). See https://pve.proxmox.com/pve-docs/pve-admin-guide.html#qmvirtualmachines_settings for more information.
    Units int
    CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to weights of all the other running VMs.
    Affinity string
    The CPU cores that are used to run the VM’s vCPU. The value is a list of CPU IDs, separated by commas. The CPU IDs are zero-based. For example, 0,1,2,3 (which also can be shortened to 0-3) means that the VM’s vCPUs are run on the first four CPU cores. Setting affinity is only allowed for root@pam authenticated user.
    Architecture string
    The CPU architecture <aarch64 | x86_64> (defaults to the host). Setting affinity is only allowed for root@pam authenticated user.
    Cores int
    The number of CPU cores per socket (defaults to 1).
    Flags []string
    Set of additional CPU flags. Use +FLAG to enable, -FLAG to disable a flag. Custom CPU models can specify any flag supported by QEMU/KVM, VM-specific flags must be from the following set for security reasons: pcid, spec-ctrl, ibpb, ssbd, virt-ssbd, amd-ssbd, amd-no-ssb, pdpe1gb, md-clear, hv-tlbflush, hv-evmcs, aes.
    Hotplugged int
    The number of hotplugged vCPUs (defaults to 0).
    Limit int
    Limit of CPU usage (defaults to 0 which means no limit).
    Numa bool
    Enable NUMA (defaults to false).
    Sockets int
    The number of CPU sockets (defaults to 1).
    Type string
    Emulated CPU type, it's recommended to use x86-64-v2-AES or higher (defaults to kvm64). See https://pve.proxmox.com/pve-docs/pve-admin-guide.html#qmvirtualmachines_settings for more information.
    Units int
    CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to weights of all the other running VMs.
    affinity String
    The CPU cores that are used to run the VM’s vCPU. The value is a list of CPU IDs, separated by commas. The CPU IDs are zero-based. For example, 0,1,2,3 (which also can be shortened to 0-3) means that the VM’s vCPUs are run on the first four CPU cores. Setting affinity is only allowed for root@pam authenticated user.
    architecture String
    The CPU architecture <aarch64 | x86_64> (defaults to the host). Setting affinity is only allowed for root@pam authenticated user.
    cores Integer
    The number of CPU cores per socket (defaults to 1).
    flags List<String>
    Set of additional CPU flags. Use +FLAG to enable, -FLAG to disable a flag. Custom CPU models can specify any flag supported by QEMU/KVM, VM-specific flags must be from the following set for security reasons: pcid, spec-ctrl, ibpb, ssbd, virt-ssbd, amd-ssbd, amd-no-ssb, pdpe1gb, md-clear, hv-tlbflush, hv-evmcs, aes.
    hotplugged Integer
    The number of hotplugged vCPUs (defaults to 0).
    limit Integer
    Limit of CPU usage (defaults to 0 which means no limit).
    numa Boolean
    Enable NUMA (defaults to false).
    sockets Integer
    The number of CPU sockets (defaults to 1).
    type String
    Emulated CPU type, it's recommended to use x86-64-v2-AES or higher (defaults to kvm64). See https://pve.proxmox.com/pve-docs/pve-admin-guide.html#qmvirtualmachines_settings for more information.
    units Integer
    CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to weights of all the other running VMs.
    affinity string
    The CPU cores that are used to run the VM’s vCPU. The value is a list of CPU IDs, separated by commas. The CPU IDs are zero-based. For example, 0,1,2,3 (which also can be shortened to 0-3) means that the VM’s vCPUs are run on the first four CPU cores. Setting affinity is only allowed for root@pam authenticated user.
    architecture string
    The CPU architecture <aarch64 | x86_64> (defaults to the host). Setting affinity is only allowed for root@pam authenticated user.
    cores number
    The number of CPU cores per socket (defaults to 1).
    flags string[]
    Set of additional CPU flags. Use +FLAG to enable, -FLAG to disable a flag. Custom CPU models can specify any flag supported by QEMU/KVM, VM-specific flags must be from the following set for security reasons: pcid, spec-ctrl, ibpb, ssbd, virt-ssbd, amd-ssbd, amd-no-ssb, pdpe1gb, md-clear, hv-tlbflush, hv-evmcs, aes.
    hotplugged number
    The number of hotplugged vCPUs (defaults to 0).
    limit number
    Limit of CPU usage (defaults to 0 which means no limit).
    numa boolean
    Enable NUMA (defaults to false).
    sockets number
    The number of CPU sockets (defaults to 1).
    type string
    Emulated CPU type, it's recommended to use x86-64-v2-AES or higher (defaults to kvm64). See https://pve.proxmox.com/pve-docs/pve-admin-guide.html#qmvirtualmachines_settings for more information.
    units number
    CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to weights of all the other running VMs.
    affinity str
    The CPU cores that are used to run the VM’s vCPU. The value is a list of CPU IDs, separated by commas. The CPU IDs are zero-based. For example, 0,1,2,3 (which also can be shortened to 0-3) means that the VM’s vCPUs are run on the first four CPU cores. Setting affinity is only allowed for root@pam authenticated user.
    architecture str
    The CPU architecture <aarch64 | x86_64> (defaults to the host). Setting affinity is only allowed for root@pam authenticated user.
    cores int
    The number of CPU cores per socket (defaults to 1).
    flags Sequence[str]
    Set of additional CPU flags. Use +FLAG to enable, -FLAG to disable a flag. Custom CPU models can specify any flag supported by QEMU/KVM, VM-specific flags must be from the following set for security reasons: pcid, spec-ctrl, ibpb, ssbd, virt-ssbd, amd-ssbd, amd-no-ssb, pdpe1gb, md-clear, hv-tlbflush, hv-evmcs, aes.
    hotplugged int
    The number of hotplugged vCPUs (defaults to 0).
    limit int
    Limit of CPU usage (defaults to 0 which means no limit).
    numa bool
    Enable NUMA (defaults to false).
    sockets int
    The number of CPU sockets (defaults to 1).
    type str
    Emulated CPU type, it's recommended to use x86-64-v2-AES or higher (defaults to kvm64). See https://pve.proxmox.com/pve-docs/pve-admin-guide.html#qmvirtualmachines_settings for more information.
    units int
    CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to weights of all the other running VMs.
    affinity String
    The CPU cores that are used to run the VM’s vCPU. The value is a list of CPU IDs, separated by commas. The CPU IDs are zero-based. For example, 0,1,2,3 (which also can be shortened to 0-3) means that the VM’s vCPUs are run on the first four CPU cores. Setting affinity is only allowed for root@pam authenticated user.
    architecture String
    The CPU architecture <aarch64 | x86_64> (defaults to the host). Setting affinity is only allowed for root@pam authenticated user.
    cores Number
    The number of CPU cores per socket (defaults to 1).
    flags List<String>
    Set of additional CPU flags. Use +FLAG to enable, -FLAG to disable a flag. Custom CPU models can specify any flag supported by QEMU/KVM, VM-specific flags must be from the following set for security reasons: pcid, spec-ctrl, ibpb, ssbd, virt-ssbd, amd-ssbd, amd-no-ssb, pdpe1gb, md-clear, hv-tlbflush, hv-evmcs, aes.
    hotplugged Number
    The number of hotplugged vCPUs (defaults to 0).
    limit Number
    Limit of CPU usage (defaults to 0 which means no limit).
    numa Boolean
    Enable NUMA (defaults to false).
    sockets Number
    The number of CPU sockets (defaults to 1).
    type String
    Emulated CPU type, it's recommended to use x86-64-v2-AES or higher (defaults to kvm64). See https://pve.proxmox.com/pve-docs/pve-admin-guide.html#qmvirtualmachines_settings for more information.
    units Number
    CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to weights of all the other running VMs.

    VirtualMachine2Timeouts, VirtualMachine2TimeoutsArgs

    Create 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).
    Delete 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). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    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.
    Update 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).
    Create 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).
    Delete 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). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    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.
    Update 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).
    create 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).
    delete 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). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    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.
    update 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).
    create 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).
    delete 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). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    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.
    update 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).
    create 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).
    delete 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). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    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.
    update 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).
    create 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).
    delete 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). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    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.
    update 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).

    VirtualMachine2Vga, VirtualMachine2VgaArgs

    Clipboard string
    Enable a specific clipboard. If not set, depending on the display type the SPICE one will be added. Currently only vnc is available. Migration with VNC clipboard is not supported by Proxmox.
    Memory int
    The VGA memory in megabytes (4-512 MB). Has no effect with serial display.
    Type string
    The VGA type (defaults to std).
    Clipboard string
    Enable a specific clipboard. If not set, depending on the display type the SPICE one will be added. Currently only vnc is available. Migration with VNC clipboard is not supported by Proxmox.
    Memory int
    The VGA memory in megabytes (4-512 MB). Has no effect with serial display.
    Type string
    The VGA type (defaults to std).
    clipboard String
    Enable a specific clipboard. If not set, depending on the display type the SPICE one will be added. Currently only vnc is available. Migration with VNC clipboard is not supported by Proxmox.
    memory Integer
    The VGA memory in megabytes (4-512 MB). Has no effect with serial display.
    type String
    The VGA type (defaults to std).
    clipboard string
    Enable a specific clipboard. If not set, depending on the display type the SPICE one will be added. Currently only vnc is available. Migration with VNC clipboard is not supported by Proxmox.
    memory number
    The VGA memory in megabytes (4-512 MB). Has no effect with serial display.
    type string
    The VGA type (defaults to std).
    clipboard str
    Enable a specific clipboard. If not set, depending on the display type the SPICE one will be added. Currently only vnc is available. Migration with VNC clipboard is not supported by Proxmox.
    memory int
    The VGA memory in megabytes (4-512 MB). Has no effect with serial display.
    type str
    The VGA type (defaults to std).
    clipboard String
    Enable a specific clipboard. If not set, depending on the display type the SPICE one will be added. Currently only vnc is available. Migration with VNC clipboard is not supported by Proxmox.
    memory Number
    The VGA memory in megabytes (4-512 MB). Has no effect with serial display.
    type String
    The VGA type (defaults to std).

    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