Docs Packages
  1. Packages
  2. Proxmox Virtual Environment (Proxmox VE)
  3. API Docs
  4. Vm2
Proxmox Virtual Environment (Proxmox VE) v6.5.1 published on Tuesday, May 7, 2024 by Daniel Muehlbachler-Pietrzykowski
muhlba91/pulumi-proxmoxve

proxmoxve.Vm2

Explore with Pulumi AI

proxmoxve logo
Proxmox Virtual Environment (Proxmox VE) v6.5.1 published on Tuesday, May 7, 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 one, and attributes of the original VM are copied to the new one.

    Computed attributes allow the provider to set those attributes without user input. The attributes are marked as optional to allow the user to set (or overwrite) them if needed. In order to remove the computed attribute from the plan, you can set it to an empty value (e.g. "" for string, [] for collection).

    Create Vm2 Resource

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

    Constructor syntax

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

@overload
def Vm2(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        node_name: Optional[str] = None,
        clone: Optional[Vm2CloneArgs] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        template: Optional[bool] = None,
        timeouts: Optional[Vm2TimeoutsArgs] = None)
    func NewVm2(ctx *Context, name string, args Vm2Args, opts ...ResourceOption) (*Vm2, error)
    public Vm2(string name, Vm2Args args, CustomResourceOptions? opts = null)
    public Vm2(String name, Vm2Args args)
public Vm2(String name, Vm2Args args, CustomResourceOptions options)

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

    Example

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

    var vm2Resource = new ProxmoxVE.Vm2("vm2Resource", new()
{
    NodeName = "string",
    Clone = new ProxmoxVE.Inputs.Vm2CloneArgs
    {
        Id = 0,
        Retries = 0,
    },
    Description = "string",
    Name = "string",
    Tags = new[]
    {
        "string",
    },
    Template = false,
    Timeouts = new ProxmoxVE.Inputs.Vm2TimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Read = "string",
        Update = "string",
    },
});

    example, err := proxmoxve.NewVm2(ctx, "vm2Resource", &proxmoxve.Vm2Args{
	NodeName: pulumi.String("string"),
	Clone: &proxmoxve.Vm2CloneArgs{
		Id:      pulumi.Int(0),
		Retries: pulumi.Int(0),
	},
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Template: pulumi.Bool(false),
	Timeouts: &proxmoxve.Vm2TimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Read:   pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    var vm2Resource = new Vm2("vm2Resource", Vm2Args.builder()        
    .nodeName("string")
    .clone(Vm2CloneArgs.builder()
        .id(0)
        .retries(0)
        .build())
    .description("string")
    .name("string")
    .tags("string")
    .template(false)
    .timeouts(Vm2TimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .read("string")
        .update("string")
        .build())
    .build());

    vm2_resource = proxmoxve.Vm2("vm2Resource",
    node_name="string",
    clone=proxmoxve.Vm2CloneArgs(
        id=0,
        retries=0,
    ),
    description="string",
    name="string",
    tags=["string"],
    template=False,
    timeouts=proxmoxve.Vm2TimeoutsArgs(
        create="string",
        delete="string",
        read="string",
        update="string",
    ))

    const vm2Resource = new proxmoxve.Vm2("vm2Resource", {
    nodeName: "string",
    clone: {
        id: 0,
        retries: 0,
    },
    description: "string",
    name: "string",
    tags: ["string"],
    template: false,
    timeouts: {
        create: "string",
        "delete": "string",
        read: "string",
        update: "string",
    },
});

    type: proxmoxve:Vm2
properties:
    clone:
        id: 0
        retries: 0
    description: string
    name: string
    nodeName: string
    tags:
        - string
    template: false
    timeouts:
        create: string
        delete: string
        read: string
        update: string

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

    NodeName string
    The name of the node where the VM is provisioned.
    Clone Pulumi.ProxmoxVE.Inputs.Vm2Clone
    The cloning configuration.
    Description string
    The description of the VM.
    Name string
    The name of the VM. Doesn't have to be unique.
    Tags List<string>
    The tags assigned to the resource.
    Template bool
    Set to true to create a VM template.
    Timeouts Pulumi.ProxmoxVE.Inputs.Vm2Timeouts
    NodeName string
    The name of the node where the VM is provisioned.
    Clone Vm2CloneArgs
    The cloning configuration.
    Description string
    The description of the VM.
    Name string
    The name of the VM. Doesn't have to be unique.
    Tags []string
    The tags assigned to the resource.
    Template bool
    Set to true to create a VM template.
    Timeouts Vm2TimeoutsArgs
    nodeName String
    The name of the node where the VM is provisioned.
    clone_ Vm2Clone
    The cloning configuration.
    description String
    The description of the VM.
    name String
    The name of the VM. Doesn't have to be unique.
    tags List<String>
    The tags assigned to the resource.
    template Boolean
    Set to true to create a VM template.
    timeouts Vm2Timeouts
    nodeName string
    The name of the node where the VM is provisioned.
    clone Vm2Clone
    The cloning configuration.
    description string
    The description of the VM.
    name string
    The name of the VM. Doesn't have to be unique.
    tags string[]
    The tags assigned to the resource.
    template boolean
    Set to true to create a VM template.
    timeouts Vm2Timeouts
    node_name str
    The name of the node where the VM is provisioned.
    clone Vm2CloneArgs
    The cloning configuration.
    description str
    The description of the VM.
    name str
    The name of the VM. Doesn't have to be unique.
    tags Sequence[str]
    The tags assigned to the resource.
    template bool
    Set to true to create a VM template.
    timeouts Vm2TimeoutsArgs
    nodeName String
    The name of the node where the VM is provisioned.
    clone Property Map
    The cloning configuration.
    description String
    The description of the VM.
    name String
    The name of the VM. Doesn't have to be unique.
    tags List<String>
    The tags assigned to the resource.
    template Boolean
    Set to true to create a VM template.
    timeouts Property Map

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Vm2 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 Vm2 Resource

    Get an existing Vm2 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?: Vm2State, opts?: CustomResourceOptions): Vm2
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        clone: Optional[Vm2CloneArgs] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        node_name: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        template: Optional[bool] = None,
        timeouts: Optional[Vm2TimeoutsArgs] = None) -> Vm2
    func GetVm2(ctx *Context, name string, id IDInput, state *Vm2State, opts ...ResourceOption) (*Vm2, error)
    public static Vm2 Get(string name, Input<string> id, Vm2State? state, CustomResourceOptions? opts = null)
    public static Vm2 get(String name, Output<String> id, Vm2State 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:
    Clone Pulumi.ProxmoxVE.Inputs.Vm2Clone
    The cloning 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.
    Tags List<string>
    The tags assigned to the resource.
    Template bool
    Set to true to create a VM template.
    Timeouts Pulumi.ProxmoxVE.Inputs.Vm2Timeouts
    Clone Vm2CloneArgs
    The cloning 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.
    Tags []string
    The tags assigned to the resource.
    Template bool
    Set to true to create a VM template.
    Timeouts Vm2TimeoutsArgs
    clone_ Vm2Clone
    The cloning 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.
    tags List<String>
    The tags assigned to the resource.
    template Boolean
    Set to true to create a VM template.
    timeouts Vm2Timeouts
    clone Vm2Clone
    The cloning 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.
    tags string[]
    The tags assigned to the resource.
    template boolean
    Set to true to create a VM template.
    timeouts Vm2Timeouts
    clone Vm2CloneArgs
    The cloning 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.
    tags Sequence[str]
    The tags assigned to the resource.
    template bool
    Set to true to create a VM template.
    timeouts Vm2TimeoutsArgs
    clone Property Map
    The cloning 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.
    tags List<String>
    The tags assigned to the resource.
    template Boolean
    Set to true to create a VM template.
    timeouts Property Map

    Supporting Types

    Vm2Clone, Vm2CloneArgs

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

    Vm2Timeouts, Vm2TimeoutsArgs

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

    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.5.1 published on Tuesday, May 7, 2024 by Daniel Muehlbachler-Pietrzykowski
    muhlba91/pulumi-proxmoxve