Manages LVM-based storage in Proxmox VE.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as proxmoxve from "@muhlba91/pulumi-proxmoxve";
const example = new proxmoxve.storage.LVM("example", {
lvmId: "example-lvm",
nodes: ["pve"],
volumeGroup: "vg0",
contents: ["images"],
wipeRemovedVolumes: false,
});
import pulumi
import pulumi_proxmoxve as proxmoxve
example = proxmoxve.storage.LVM("example",
lvm_id="example-lvm",
nodes=["pve"],
volume_group="vg0",
contents=["images"],
wipe_removed_volumes=False)
package main
import (
"github.com/muhlba91/pulumi-proxmoxve/sdk/v7/go/proxmoxve/storage"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := storage.NewLVM(ctx, "example", &storage.LVMArgs{
LvmId: pulumi.String("example-lvm"),
Nodes: pulumi.StringArray{
pulumi.String("pve"),
},
VolumeGroup: pulumi.String("vg0"),
Contents: pulumi.StringArray{
pulumi.String("images"),
},
WipeRemovedVolumes: pulumi.Bool(false),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ProxmoxVE = Pulumi.ProxmoxVE;
return await Deployment.RunAsync(() =>
{
var example = new ProxmoxVE.Storage.LVM("example", new()
{
LvmId = "example-lvm",
Nodes = new[]
{
"pve",
},
VolumeGroup = "vg0",
Contents = new[]
{
"images",
},
WipeRemovedVolumes = false,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import io.muehlbachler.pulumi.proxmoxve.Storage.LVM;
import io.muehlbachler.pulumi.proxmoxve.Storage.LVMArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new LVM("example", LVMArgs.builder()
.lvmId("example-lvm")
.nodes("pve")
.volumeGroup("vg0")
.contents("images")
.wipeRemovedVolumes(false)
.build());
}
}
resources:
example:
type: proxmoxve:Storage:LVM
properties:
lvmId: example-lvm
nodes:
- pve
volumeGroup: vg0
contents:
- images
wipeRemovedVolumes: false
Create LVM Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new LVM(name: string, args: LVMArgs, opts?: CustomResourceOptions);@overload
def LVM(resource_name: str,
args: LVMArgs,
opts: Optional[ResourceOptions] = None)
@overload
def LVM(resource_name: str,
opts: Optional[ResourceOptions] = None,
lvm_id: Optional[str] = None,
volume_group: Optional[str] = None,
contents: Optional[Sequence[str]] = None,
disable: Optional[bool] = None,
nodes: Optional[Sequence[str]] = None,
shared: Optional[bool] = None,
wipe_removed_volumes: Optional[bool] = None)func NewLVM(ctx *Context, name string, args LVMArgs, opts ...ResourceOption) (*LVM, error)public LVM(string name, LVMArgs args, CustomResourceOptions? opts = null)type: proxmoxve:Storage:LVM
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 LVMArgs
- 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 LVMArgs
- 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 LVMArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args LVMArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args LVMArgs
- 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 lvmResource = new ProxmoxVE.Storage.LVM("lvmResource", new()
{
LvmId = "string",
VolumeGroup = "string",
Contents = new[]
{
"string",
},
Disable = false,
Nodes = new[]
{
"string",
},
Shared = false,
WipeRemovedVolumes = false,
});
example, err := storage.NewLVM(ctx, "lvmResource", &storage.LVMArgs{
LvmId: pulumi.String("string"),
VolumeGroup: pulumi.String("string"),
Contents: pulumi.StringArray{
pulumi.String("string"),
},
Disable: pulumi.Bool(false),
Nodes: pulumi.StringArray{
pulumi.String("string"),
},
Shared: pulumi.Bool(false),
WipeRemovedVolumes: pulumi.Bool(false),
})
var lvmResource = new LVM("lvmResource", LVMArgs.builder()
.lvmId("string")
.volumeGroup("string")
.contents("string")
.disable(false)
.nodes("string")
.shared(false)
.wipeRemovedVolumes(false)
.build());
lvm_resource = proxmoxve.storage.LVM("lvmResource",
lvm_id="string",
volume_group="string",
contents=["string"],
disable=False,
nodes=["string"],
shared=False,
wipe_removed_volumes=False)
const lvmResource = new proxmoxve.storage.LVM("lvmResource", {
lvmId: "string",
volumeGroup: "string",
contents: ["string"],
disable: false,
nodes: ["string"],
shared: false,
wipeRemovedVolumes: false,
});
type: proxmoxve:Storage:LVM
properties:
contents:
- string
disable: false
lvmId: string
nodes:
- string
shared: false
volumeGroup: string
wipeRemovedVolumes: false
LVM Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The LVM resource accepts the following input properties:
- Lvm
Id string - The unique identifier of the storage.
- Volume
Group string - The name of the volume group to use.
- Contents List<string>
- The content types that can be stored on this storage. Valid values:
backup(VM backups),images(VM disk images),import(VM disk images for import),iso(ISO images),rootdir(container root directories),snippets(cloud-init, hook scripts, etc.),vztmpl(container templates). - Disable bool
- Whether the storage is disabled.
- Nodes List<string>
- A list of nodes where this storage is available.
- bool
- Whether the storage is shared across all nodes.
- Wipe
Removed boolVolumes - Whether to zero-out data when removing LVMs.
- Lvm
Id string - The unique identifier of the storage.
- Volume
Group string - The name of the volume group to use.
- Contents []string
- The content types that can be stored on this storage. Valid values:
backup(VM backups),images(VM disk images),import(VM disk images for import),iso(ISO images),rootdir(container root directories),snippets(cloud-init, hook scripts, etc.),vztmpl(container templates). - Disable bool
- Whether the storage is disabled.
- Nodes []string
- A list of nodes where this storage is available.
- bool
- Whether the storage is shared across all nodes.
- Wipe
Removed boolVolumes - Whether to zero-out data when removing LVMs.
- lvm
Id String - The unique identifier of the storage.
- volume
Group String - The name of the volume group to use.
- contents List<String>
- The content types that can be stored on this storage. Valid values:
backup(VM backups),images(VM disk images),import(VM disk images for import),iso(ISO images),rootdir(container root directories),snippets(cloud-init, hook scripts, etc.),vztmpl(container templates). - disable Boolean
- Whether the storage is disabled.
- nodes List<String>
- A list of nodes where this storage is available.
- Boolean
- Whether the storage is shared across all nodes.
- wipe
Removed BooleanVolumes - Whether to zero-out data when removing LVMs.
- lvm
Id string - The unique identifier of the storage.
- volume
Group string - The name of the volume group to use.
- contents string[]
- The content types that can be stored on this storage. Valid values:
backup(VM backups),images(VM disk images),import(VM disk images for import),iso(ISO images),rootdir(container root directories),snippets(cloud-init, hook scripts, etc.),vztmpl(container templates). - disable boolean
- Whether the storage is disabled.
- nodes string[]
- A list of nodes where this storage is available.
- boolean
- Whether the storage is shared across all nodes.
- wipe
Removed booleanVolumes - Whether to zero-out data when removing LVMs.
- lvm_
id str - The unique identifier of the storage.
- volume_
group str - The name of the volume group to use.
- contents Sequence[str]
- The content types that can be stored on this storage. Valid values:
backup(VM backups),images(VM disk images),import(VM disk images for import),iso(ISO images),rootdir(container root directories),snippets(cloud-init, hook scripts, etc.),vztmpl(container templates). - disable bool
- Whether the storage is disabled.
- nodes Sequence[str]
- A list of nodes where this storage is available.
- bool
- Whether the storage is shared across all nodes.
- wipe_
removed_ boolvolumes - Whether to zero-out data when removing LVMs.
- lvm
Id String - The unique identifier of the storage.
- volume
Group String - The name of the volume group to use.
- contents List<String>
- The content types that can be stored on this storage. Valid values:
backup(VM backups),images(VM disk images),import(VM disk images for import),iso(ISO images),rootdir(container root directories),snippets(cloud-init, hook scripts, etc.),vztmpl(container templates). - disable Boolean
- Whether the storage is disabled.
- nodes List<String>
- A list of nodes where this storage is available.
- Boolean
- Whether the storage is shared across all nodes.
- wipe
Removed BooleanVolumes - Whether to zero-out data when removing LVMs.
Outputs
All input properties are implicitly available as output properties. Additionally, the LVM 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 LVM Resource
Get an existing LVM 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?: LVMState, opts?: CustomResourceOptions): LVM@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
contents: Optional[Sequence[str]] = None,
disable: Optional[bool] = None,
lvm_id: Optional[str] = None,
nodes: Optional[Sequence[str]] = None,
shared: Optional[bool] = None,
volume_group: Optional[str] = None,
wipe_removed_volumes: Optional[bool] = None) -> LVMfunc GetLVM(ctx *Context, name string, id IDInput, state *LVMState, opts ...ResourceOption) (*LVM, error)public static LVM Get(string name, Input<string> id, LVMState? state, CustomResourceOptions? opts = null)public static LVM get(String name, Output<String> id, LVMState state, CustomResourceOptions options)resources: _: type: proxmoxve:Storage:LVM get: id: ${id}- 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.
- Contents List<string>
- The content types that can be stored on this storage. Valid values:
backup(VM backups),images(VM disk images),import(VM disk images for import),iso(ISO images),rootdir(container root directories),snippets(cloud-init, hook scripts, etc.),vztmpl(container templates). - Disable bool
- Whether the storage is disabled.
- Lvm
Id string - The unique identifier of the storage.
- Nodes List<string>
- A list of nodes where this storage is available.
- bool
- Whether the storage is shared across all nodes.
- Volume
Group string - The name of the volume group to use.
- Wipe
Removed boolVolumes - Whether to zero-out data when removing LVMs.
- Contents []string
- The content types that can be stored on this storage. Valid values:
backup(VM backups),images(VM disk images),import(VM disk images for import),iso(ISO images),rootdir(container root directories),snippets(cloud-init, hook scripts, etc.),vztmpl(container templates). - Disable bool
- Whether the storage is disabled.
- Lvm
Id string - The unique identifier of the storage.
- Nodes []string
- A list of nodes where this storage is available.
- bool
- Whether the storage is shared across all nodes.
- Volume
Group string - The name of the volume group to use.
- Wipe
Removed boolVolumes - Whether to zero-out data when removing LVMs.
- contents List<String>
- The content types that can be stored on this storage. Valid values:
backup(VM backups),images(VM disk images),import(VM disk images for import),iso(ISO images),rootdir(container root directories),snippets(cloud-init, hook scripts, etc.),vztmpl(container templates). - disable Boolean
- Whether the storage is disabled.
- lvm
Id String - The unique identifier of the storage.
- nodes List<String>
- A list of nodes where this storage is available.
- Boolean
- Whether the storage is shared across all nodes.
- volume
Group String - The name of the volume group to use.
- wipe
Removed BooleanVolumes - Whether to zero-out data when removing LVMs.
- contents string[]
- The content types that can be stored on this storage. Valid values:
backup(VM backups),images(VM disk images),import(VM disk images for import),iso(ISO images),rootdir(container root directories),snippets(cloud-init, hook scripts, etc.),vztmpl(container templates). - disable boolean
- Whether the storage is disabled.
- lvm
Id string - The unique identifier of the storage.
- nodes string[]
- A list of nodes where this storage is available.
- boolean
- Whether the storage is shared across all nodes.
- volume
Group string - The name of the volume group to use.
- wipe
Removed booleanVolumes - Whether to zero-out data when removing LVMs.
- contents Sequence[str]
- The content types that can be stored on this storage. Valid values:
backup(VM backups),images(VM disk images),import(VM disk images for import),iso(ISO images),rootdir(container root directories),snippets(cloud-init, hook scripts, etc.),vztmpl(container templates). - disable bool
- Whether the storage is disabled.
- lvm_
id str - The unique identifier of the storage.
- nodes Sequence[str]
- A list of nodes where this storage is available.
- bool
- Whether the storage is shared across all nodes.
- volume_
group str - The name of the volume group to use.
- wipe_
removed_ boolvolumes - Whether to zero-out data when removing LVMs.
- contents List<String>
- The content types that can be stored on this storage. Valid values:
backup(VM backups),images(VM disk images),import(VM disk images for import),iso(ISO images),rootdir(container root directories),snippets(cloud-init, hook scripts, etc.),vztmpl(container templates). - disable Boolean
- Whether the storage is disabled.
- lvm
Id String - The unique identifier of the storage.
- nodes List<String>
- A list of nodes where this storage is available.
- Boolean
- Whether the storage is shared across all nodes.
- volume
Group String - The name of the volume group to use.
- wipe
Removed BooleanVolumes - Whether to zero-out data when removing LVMs.
Package Details
- Repository
- proxmoxve muhlba91/pulumi-proxmoxve
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
proxmoxTerraform Provider.
