1. Packages
  2. Proxmox Virtual Environment (Proxmox VE)
  3. API Docs
  4. storage
  5. Zfspool
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.0.0
published on Sunday, Apr 5, 2026 by Daniel Muehlbachler-Pietrzykowski
Schema (JSON)
muhlba91/pulumi-proxmoxve

proxmoxve.storage.Zfspool

proxmoxve logo
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.0.0
published on Sunday, Apr 5, 2026 by Daniel Muehlbachler-Pietrzykowski
Schema (JSON)
muhlba91/pulumi-proxmoxve

    Manages ZFS-based storage in Proxmox VE.

    Create Zfspool Resource

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

    Constructor syntax

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

@overload
def Zfspool(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            resource_id: Optional[str] = None,
            zfs_pool: Optional[str] = None,
            blocksize: Optional[str] = None,
            contents: Optional[Sequence[str]] = None,
            disable: Optional[bool] = None,
            nodes: Optional[Sequence[str]] = None,
            thin_provision: Optional[bool] = None)
    func NewZfspool(ctx *Context, name string, args ZfspoolArgs, opts ...ResourceOption) (*Zfspool, error)
    public Zfspool(string name, ZfspoolArgs args, CustomResourceOptions? opts = null)
    public Zfspool(String name, ZfspoolArgs args)
public Zfspool(String name, ZfspoolArgs args, CustomResourceOptions options)

    type: proxmoxve:storage:Zfspool
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 ZfspoolArgs
    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 ZfspoolArgs
    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 ZfspoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ZfspoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ZfspoolArgs
    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 zfspoolResource = new ProxmoxVE.Storage.Zfspool("zfspoolResource", new()
{
    ResourceId = "string",
    ZfsPool = "string",
    Blocksize = "string",
    Contents = new[]
    {
        "string",
    },
    Disable = false,
    Nodes = new[]
    {
        "string",
    },
    ThinProvision = false,
});

    example, err := storage.NewZfspool(ctx, "zfspoolResource", &storage.ZfspoolArgs{
	ResourceId: pulumi.String("string"),
	ZfsPool:    pulumi.String("string"),
	Blocksize:  pulumi.String("string"),
	Contents: pulumi.StringArray{
		pulumi.String("string"),
	},
	Disable: pulumi.Bool(false),
	Nodes: pulumi.StringArray{
		pulumi.String("string"),
	},
	ThinProvision: pulumi.Bool(false),
})

    var zfspoolResource = new Zfspool("zfspoolResource", ZfspoolArgs.builder()
    .resourceId("string")
    .zfsPool("string")
    .blocksize("string")
    .contents("string")
    .disable(false)
    .nodes("string")
    .thinProvision(false)
    .build());

    zfspool_resource = proxmoxve.storage.Zfspool("zfspoolResource",
    resource_id="string",
    zfs_pool="string",
    blocksize="string",
    contents=["string"],
    disable=False,
    nodes=["string"],
    thin_provision=False)

    const zfspoolResource = new proxmoxve.storage.Zfspool("zfspoolResource", {
    resourceId: "string",
    zfsPool: "string",
    blocksize: "string",
    contents: ["string"],
    disable: false,
    nodes: ["string"],
    thinProvision: false,
});

    type: proxmoxve:storage:Zfspool
properties:
    blocksize: string
    contents:
        - string
    disable: false
    nodes:
        - string
    resourceId: string
    thinProvision: false
    zfsPool: string

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

    ResourceId string
    The unique identifier of the storage.
    ZfsPool string
    The name of the ZFS storage pool to use (e.g. tank, rpool/data).
    Blocksize string
    Block size for newly created volumes (e.g. 4k, 8k, 16k). Larger values may improve throughput for large I/O, while smaller values optimize space efficiency.
    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.
    ThinProvision bool
    Whether to enable thin provisioning (on or off). Thin provisioning allows flexible disk allocation without pre-allocating full space.
    ResourceId string
    The unique identifier of the storage.
    ZfsPool string
    The name of the ZFS storage pool to use (e.g. tank, rpool/data).
    Blocksize string
    Block size for newly created volumes (e.g. 4k, 8k, 16k). Larger values may improve throughput for large I/O, while smaller values optimize space efficiency.
    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.
    ThinProvision bool
    Whether to enable thin provisioning (on or off). Thin provisioning allows flexible disk allocation without pre-allocating full space.
    resourceId String
    The unique identifier of the storage.
    zfsPool String
    The name of the ZFS storage pool to use (e.g. tank, rpool/data).
    blocksize String
    Block size for newly created volumes (e.g. 4k, 8k, 16k). Larger values may improve throughput for large I/O, while smaller values optimize space efficiency.
    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.
    thinProvision Boolean
    Whether to enable thin provisioning (on or off). Thin provisioning allows flexible disk allocation without pre-allocating full space.
    resourceId string
    The unique identifier of the storage.
    zfsPool string
    The name of the ZFS storage pool to use (e.g. tank, rpool/data).
    blocksize string
    Block size for newly created volumes (e.g. 4k, 8k, 16k). Larger values may improve throughput for large I/O, while smaller values optimize space efficiency.
    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.
    thinProvision boolean
    Whether to enable thin provisioning (on or off). Thin provisioning allows flexible disk allocation without pre-allocating full space.
    resource_id str
    The unique identifier of the storage.
    zfs_pool str
    The name of the ZFS storage pool to use (e.g. tank, rpool/data).
    blocksize str
    Block size for newly created volumes (e.g. 4k, 8k, 16k). Larger values may improve throughput for large I/O, while smaller values optimize space efficiency.
    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.
    thin_provision bool
    Whether to enable thin provisioning (on or off). Thin provisioning allows flexible disk allocation without pre-allocating full space.
    resourceId String
    The unique identifier of the storage.
    zfsPool String
    The name of the ZFS storage pool to use (e.g. tank, rpool/data).
    blocksize String
    Block size for newly created volumes (e.g. 4k, 8k, 16k). Larger values may improve throughput for large I/O, while smaller values optimize space efficiency.
    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.
    thinProvision Boolean
    Whether to enable thin provisioning (on or off). Thin provisioning allows flexible disk allocation without pre-allocating full space.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Shared bool
    Whether the storage is shared across all nodes.
    Id string
    The provider-assigned unique ID for this managed resource.
    Shared bool
    Whether the storage is shared across all nodes.
    id String
    The provider-assigned unique ID for this managed resource.
    shared Boolean
    Whether the storage is shared across all nodes.
    id string
    The provider-assigned unique ID for this managed resource.
    shared boolean
    Whether the storage is shared across all nodes.
    id str
    The provider-assigned unique ID for this managed resource.
    shared bool
    Whether the storage is shared across all nodes.
    id String
    The provider-assigned unique ID for this managed resource.
    shared Boolean
    Whether the storage is shared across all nodes.

    Look up Existing Zfspool Resource

    Get an existing Zfspool 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?: ZfspoolState, opts?: CustomResourceOptions): Zfspool
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        blocksize: Optional[str] = None,
        contents: Optional[Sequence[str]] = None,
        disable: Optional[bool] = None,
        nodes: Optional[Sequence[str]] = None,
        resource_id: Optional[str] = None,
        shared: Optional[bool] = None,
        thin_provision: Optional[bool] = None,
        zfs_pool: Optional[str] = None) -> Zfspool
    func GetZfspool(ctx *Context, name string, id IDInput, state *ZfspoolState, opts ...ResourceOption) (*Zfspool, error)
    public static Zfspool Get(string name, Input<string> id, ZfspoolState? state, CustomResourceOptions? opts = null)
    public static Zfspool get(String name, Output<String> id, ZfspoolState state, CustomResourceOptions options)
    resources:  _:    type: proxmoxve:storage:Zfspool    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.
    The following state arguments are supported:
    Blocksize string
    Block size for newly created volumes (e.g. 4k, 8k, 16k). Larger values may improve throughput for large I/O, while smaller values optimize space efficiency.
    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.
    ResourceId string
    The unique identifier of the storage.
    Shared bool
    Whether the storage is shared across all nodes.
    ThinProvision bool
    Whether to enable thin provisioning (on or off). Thin provisioning allows flexible disk allocation without pre-allocating full space.
    ZfsPool string
    The name of the ZFS storage pool to use (e.g. tank, rpool/data).
    Blocksize string
    Block size for newly created volumes (e.g. 4k, 8k, 16k). Larger values may improve throughput for large I/O, while smaller values optimize space efficiency.
    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.
    ResourceId string
    The unique identifier of the storage.
    Shared bool
    Whether the storage is shared across all nodes.
    ThinProvision bool
    Whether to enable thin provisioning (on or off). Thin provisioning allows flexible disk allocation without pre-allocating full space.
    ZfsPool string
    The name of the ZFS storage pool to use (e.g. tank, rpool/data).
    blocksize String
    Block size for newly created volumes (e.g. 4k, 8k, 16k). Larger values may improve throughput for large I/O, while smaller values optimize space efficiency.
    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.
    resourceId String
    The unique identifier of the storage.
    shared Boolean
    Whether the storage is shared across all nodes.
    thinProvision Boolean
    Whether to enable thin provisioning (on or off). Thin provisioning allows flexible disk allocation without pre-allocating full space.
    zfsPool String
    The name of the ZFS storage pool to use (e.g. tank, rpool/data).
    blocksize string
    Block size for newly created volumes (e.g. 4k, 8k, 16k). Larger values may improve throughput for large I/O, while smaller values optimize space efficiency.
    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.
    resourceId string
    The unique identifier of the storage.
    shared boolean
    Whether the storage is shared across all nodes.
    thinProvision boolean
    Whether to enable thin provisioning (on or off). Thin provisioning allows flexible disk allocation without pre-allocating full space.
    zfsPool string
    The name of the ZFS storage pool to use (e.g. tank, rpool/data).
    blocksize str
    Block size for newly created volumes (e.g. 4k, 8k, 16k). Larger values may improve throughput for large I/O, while smaller values optimize space efficiency.
    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.
    resource_id str
    The unique identifier of the storage.
    shared bool
    Whether the storage is shared across all nodes.
    thin_provision bool
    Whether to enable thin provisioning (on or off). Thin provisioning allows flexible disk allocation without pre-allocating full space.
    zfs_pool str
    The name of the ZFS storage pool to use (e.g. tank, rpool/data).
    blocksize String
    Block size for newly created volumes (e.g. 4k, 8k, 16k). Larger values may improve throughput for large I/O, while smaller values optimize space efficiency.
    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.
    resourceId String
    The unique identifier of the storage.
    shared Boolean
    Whether the storage is shared across all nodes.
    thinProvision Boolean
    Whether to enable thin provisioning (on or off). Thin provisioning allows flexible disk allocation without pre-allocating full space.
    zfsPool String
    The name of the ZFS storage pool to use (e.g. tank, rpool/data).

    Package Details

    Repository
    proxmoxve muhlba91/pulumi-proxmoxve
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the proxmox Terraform Provider.
    proxmoxve logo
    Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.0.0
    published on Sunday, Apr 5, 2026 by Daniel Muehlbachler-Pietrzykowski
    Schema (JSON)
    muhlba91/pulumi-proxmoxve
      Try Pulumi Cloud free. Your team will thank you.