1. Packages
  2. Libvirt Provider
  3. API Docs
  4. Pool
libvirt 0.9.1 published on Monday, Dec 1, 2025 by dmacvicar
Schema (JSON)
dmacvicar/terraform-provider-libvirt

libvirt.Pool

libvirt logo
libvirt 0.9.1 published on Monday, Dec 1, 2025 by dmacvicar
Schema (JSON)
dmacvicar/terraform-provider-libvirt

    Storage pool for managing storage volumes

    Create Pool Resource

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

    Constructor syntax

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

@overload
def Pool(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         type: Optional[str] = None,
         allocation_unit: Optional[str] = None,
         available_unit: Optional[str] = None,
         capacity_unit: Optional[str] = None,
         features: Optional[PoolFeaturesArgs] = None,
         name: Optional[str] = None,
         refresh: Optional[PoolRefreshArgs] = None,
         source: Optional[PoolSourceArgs] = None,
         target: Optional[PoolTargetArgs] = None)
    func NewPool(ctx *Context, name string, args PoolArgs, opts ...ResourceOption) (*Pool, error)
    public Pool(string name, PoolArgs args, CustomResourceOptions? opts = null)
    public Pool(String name, PoolArgs args)
public Pool(String name, PoolArgs args, CustomResourceOptions options)

    type: libvirt:Pool
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 PoolArgs
    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 PoolArgs
    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 PoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PoolArgs
    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 poolResource = new Libvirt.Pool("poolResource", new()
{
    Type = "string",
    AllocationUnit = "string",
    AvailableUnit = "string",
    CapacityUnit = "string",
    Features = new Libvirt.Inputs.PoolFeaturesArgs
    {
        Cow = new Libvirt.Inputs.PoolFeaturesCowArgs
        {
            State = "string",
        },
    },
    Name = "string",
    Refresh = new Libvirt.Inputs.PoolRefreshArgs
    {
        Volume = new Libvirt.Inputs.PoolRefreshVolumeArgs
        {
            Allocation = "string",
        },
    },
    Source = new Libvirt.Inputs.PoolSourceArgs
    {
        Adapter = new Libvirt.Inputs.PoolSourceAdapterArgs
        {
            Managed = false,
            Name = "string",
            Parent = "string",
            ParentAddr = new Libvirt.Inputs.PoolSourceAdapterParentAddrArgs
            {
                UniqueId = 0,
                Address = new Libvirt.Inputs.PoolSourceAdapterParentAddrAddressArgs
                {
                    Bus = 0,
                    Domain = 0,
                    Function = 0,
                    Slot = 0,
                },
            },
            Type = "string",
            Wwnn = "string",
            Wwpn = "string",
        },
        Auth = new Libvirt.Inputs.PoolSourceAuthArgs
        {
            Type = "string",
            Username = "string",
            Secret = new Libvirt.Inputs.PoolSourceAuthSecretArgs
            {
                Usage = "string",
                Uuid = "string",
            },
        },
        Devices = new[]
        {
            new Libvirt.Inputs.PoolSourceDeviceArgs
            {
                Path = "string",
                FreeExtents = new[]
                {
                    new Libvirt.Inputs.PoolSourceDeviceFreeExtentArgs
                    {
                        End = 0,
                        Start = 0,
                    },
                },
                PartSeparator = "string",
            },
        },
        Dir = new Libvirt.Inputs.PoolSourceDirArgs
        {
            Path = "string",
        },
        Format = new Libvirt.Inputs.PoolSourceFormatArgs
        {
            Type = "string",
        },
        Hosts = new[]
        {
            new Libvirt.Inputs.PoolSourceHostArgs
            {
                Name = "string",
                Port = "string",
            },
        },
        Initiator = new Libvirt.Inputs.PoolSourceInitiatorArgs
        {
            Iqn = new Libvirt.Inputs.PoolSourceInitiatorIqnArgs
            {
                Name = "string",
            },
        },
        Name = "string",
        Product = new Libvirt.Inputs.PoolSourceProductArgs
        {
            Name = "string",
        },
        Protocol = new Libvirt.Inputs.PoolSourceProtocolArgs
        {
            Version = "string",
        },
        Vendor = new Libvirt.Inputs.PoolSourceVendorArgs
        {
            Name = "string",
        },
    },
    Target = new Libvirt.Inputs.PoolTargetArgs
    {
        Encryption = new Libvirt.Inputs.PoolTargetEncryptionArgs
        {
            Format = "string",
            Cipher = new Libvirt.Inputs.PoolTargetEncryptionCipherArgs
            {
                Hash = "string",
                Mode = "string",
                Name = "string",
                Size = 0,
            },
            Ivgen = new Libvirt.Inputs.PoolTargetEncryptionIvgenArgs
            {
                Hash = "string",
                Name = "string",
            },
            Secret = new Libvirt.Inputs.PoolTargetEncryptionSecretArgs
            {
                Type = "string",
                Uuid = "string",
            },
        },
        Path = "string",
        Permissions = new Libvirt.Inputs.PoolTargetPermissionsArgs
        {
            Group = "string",
            Label = "string",
            Mode = "string",
            Owner = "string",
        },
        Timestamps = new Libvirt.Inputs.PoolTargetTimestampsArgs
        {
            Atime = "string",
            Ctime = "string",
            Mtime = "string",
        },
    },
});

    example, err := libvirt.NewPool(ctx, "poolResource", &libvirt.PoolArgs{
	Type:           pulumi.String("string"),
	AllocationUnit: pulumi.String("string"),
	AvailableUnit:  pulumi.String("string"),
	CapacityUnit:   pulumi.String("string"),
	Features: &libvirt.PoolFeaturesArgs{
		Cow: &libvirt.PoolFeaturesCowArgs{
			State: pulumi.String("string"),
		},
	},
	Name: pulumi.String("string"),
	Refresh: &libvirt.PoolRefreshArgs{
		Volume: &libvirt.PoolRefreshVolumeArgs{
			Allocation: pulumi.String("string"),
		},
	},
	Source: &libvirt.PoolSourceArgs{
		Adapter: &libvirt.PoolSourceAdapterArgs{
			Managed: pulumi.Bool(false),
			Name:    pulumi.String("string"),
			Parent:  pulumi.String("string"),
			ParentAddr: &libvirt.PoolSourceAdapterParentAddrArgs{
				UniqueId: pulumi.Float64(0),
				Address: &libvirt.PoolSourceAdapterParentAddrAddressArgs{
					Bus:      pulumi.Float64(0),
					Domain:   pulumi.Float64(0),
					Function: pulumi.Float64(0),
					Slot:     pulumi.Float64(0),
				},
			},
			Type: pulumi.String("string"),
			Wwnn: pulumi.String("string"),
			Wwpn: pulumi.String("string"),
		},
		Auth: &libvirt.PoolSourceAuthArgs{
			Type:     pulumi.String("string"),
			Username: pulumi.String("string"),
			Secret: &libvirt.PoolSourceAuthSecretArgs{
				Usage: pulumi.String("string"),
				Uuid:  pulumi.String("string"),
			},
		},
		Devices: libvirt.PoolSourceDeviceArray{
			&libvirt.PoolSourceDeviceArgs{
				Path: pulumi.String("string"),
				FreeExtents: libvirt.PoolSourceDeviceFreeExtentArray{
					&libvirt.PoolSourceDeviceFreeExtentArgs{
						End:   pulumi.Float64(0),
						Start: pulumi.Float64(0),
					},
				},
				PartSeparator: pulumi.String("string"),
			},
		},
		Dir: &libvirt.PoolSourceDirArgs{
			Path: pulumi.String("string"),
		},
		Format: &libvirt.PoolSourceFormatArgs{
			Type: pulumi.String("string"),
		},
		Hosts: libvirt.PoolSourceHostArray{
			&libvirt.PoolSourceHostArgs{
				Name: pulumi.String("string"),
				Port: pulumi.String("string"),
			},
		},
		Initiator: &libvirt.PoolSourceInitiatorArgs{
			Iqn: &libvirt.PoolSourceInitiatorIqnArgs{
				Name: pulumi.String("string"),
			},
		},
		Name: pulumi.String("string"),
		Product: &libvirt.PoolSourceProductArgs{
			Name: pulumi.String("string"),
		},
		Protocol: &libvirt.PoolSourceProtocolArgs{
			Version: pulumi.String("string"),
		},
		Vendor: &libvirt.PoolSourceVendorArgs{
			Name: pulumi.String("string"),
		},
	},
	Target: &libvirt.PoolTargetArgs{
		Encryption: &libvirt.PoolTargetEncryptionArgs{
			Format: pulumi.String("string"),
			Cipher: &libvirt.PoolTargetEncryptionCipherArgs{
				Hash: pulumi.String("string"),
				Mode: pulumi.String("string"),
				Name: pulumi.String("string"),
				Size: pulumi.Float64(0),
			},
			Ivgen: &libvirt.PoolTargetEncryptionIvgenArgs{
				Hash: pulumi.String("string"),
				Name: pulumi.String("string"),
			},
			Secret: &libvirt.PoolTargetEncryptionSecretArgs{
				Type: pulumi.String("string"),
				Uuid: pulumi.String("string"),
			},
		},
		Path: pulumi.String("string"),
		Permissions: &libvirt.PoolTargetPermissionsArgs{
			Group: pulumi.String("string"),
			Label: pulumi.String("string"),
			Mode:  pulumi.String("string"),
			Owner: pulumi.String("string"),
		},
		Timestamps: &libvirt.PoolTargetTimestampsArgs{
			Atime: pulumi.String("string"),
			Ctime: pulumi.String("string"),
			Mtime: pulumi.String("string"),
		},
	},
})

    var poolResource = new Pool("poolResource", PoolArgs.builder()
    .type("string")
    .allocationUnit("string")
    .availableUnit("string")
    .capacityUnit("string")
    .features(PoolFeaturesArgs.builder()
        .cow(PoolFeaturesCowArgs.builder()
            .state("string")
            .build())
        .build())
    .name("string")
    .refresh(PoolRefreshArgs.builder()
        .volume(PoolRefreshVolumeArgs.builder()
            .allocation("string")
            .build())
        .build())
    .source(PoolSourceArgs.builder()
        .adapter(PoolSourceAdapterArgs.builder()
            .managed(false)
            .name("string")
            .parent("string")
            .parentAddr(PoolSourceAdapterParentAddrArgs.builder()
                .uniqueId(0.0)
                .address(PoolSourceAdapterParentAddrAddressArgs.builder()
                    .bus(0.0)
                    .domain(0.0)
                    .function(0.0)
                    .slot(0.0)
                    .build())
                .build())
            .type("string")
            .wwnn("string")
            .wwpn("string")
            .build())
        .auth(PoolSourceAuthArgs.builder()
            .type("string")
            .username("string")
            .secret(PoolSourceAuthSecretArgs.builder()
                .usage("string")
                .uuid("string")
                .build())
            .build())
        .devices(PoolSourceDeviceArgs.builder()
            .path("string")
            .freeExtents(PoolSourceDeviceFreeExtentArgs.builder()
                .end(0.0)
                .start(0.0)
                .build())
            .partSeparator("string")
            .build())
        .dir(PoolSourceDirArgs.builder()
            .path("string")
            .build())
        .format(PoolSourceFormatArgs.builder()
            .type("string")
            .build())
        .hosts(PoolSourceHostArgs.builder()
            .name("string")
            .port("string")
            .build())
        .initiator(PoolSourceInitiatorArgs.builder()
            .iqn(PoolSourceInitiatorIqnArgs.builder()
                .name("string")
                .build())
            .build())
        .name("string")
        .product(PoolSourceProductArgs.builder()
            .name("string")
            .build())
        .protocol(PoolSourceProtocolArgs.builder()
            .version("string")
            .build())
        .vendor(PoolSourceVendorArgs.builder()
            .name("string")
            .build())
        .build())
    .target(PoolTargetArgs.builder()
        .encryption(PoolTargetEncryptionArgs.builder()
            .format("string")
            .cipher(PoolTargetEncryptionCipherArgs.builder()
                .hash("string")
                .mode("string")
                .name("string")
                .size(0.0)
                .build())
            .ivgen(PoolTargetEncryptionIvgenArgs.builder()
                .hash("string")
                .name("string")
                .build())
            .secret(PoolTargetEncryptionSecretArgs.builder()
                .type("string")
                .uuid("string")
                .build())
            .build())
        .path("string")
        .permissions(PoolTargetPermissionsArgs.builder()
            .group("string")
            .label("string")
            .mode("string")
            .owner("string")
            .build())
        .timestamps(PoolTargetTimestampsArgs.builder()
            .atime("string")
            .ctime("string")
            .mtime("string")
            .build())
        .build())
    .build());

    pool_resource = libvirt.Pool("poolResource",
    type="string",
    allocation_unit="string",
    available_unit="string",
    capacity_unit="string",
    features={
        "cow": {
            "state": "string",
        },
    },
    name="string",
    refresh={
        "volume": {
            "allocation": "string",
        },
    },
    source={
        "adapter": {
            "managed": False,
            "name": "string",
            "parent": "string",
            "parent_addr": {
                "unique_id": 0,
                "address": {
                    "bus": 0,
                    "domain": 0,
                    "function": 0,
                    "slot": 0,
                },
            },
            "type": "string",
            "wwnn": "string",
            "wwpn": "string",
        },
        "auth": {
            "type": "string",
            "username": "string",
            "secret": {
                "usage": "string",
                "uuid": "string",
            },
        },
        "devices": [{
            "path": "string",
            "free_extents": [{
                "end": 0,
                "start": 0,
            }],
            "part_separator": "string",
        }],
        "dir": {
            "path": "string",
        },
        "format": {
            "type": "string",
        },
        "hosts": [{
            "name": "string",
            "port": "string",
        }],
        "initiator": {
            "iqn": {
                "name": "string",
            },
        },
        "name": "string",
        "product": {
            "name": "string",
        },
        "protocol": {
            "version": "string",
        },
        "vendor": {
            "name": "string",
        },
    },
    target={
        "encryption": {
            "format": "string",
            "cipher": {
                "hash": "string",
                "mode": "string",
                "name": "string",
                "size": 0,
            },
            "ivgen": {
                "hash": "string",
                "name": "string",
            },
            "secret": {
                "type": "string",
                "uuid": "string",
            },
        },
        "path": "string",
        "permissions": {
            "group": "string",
            "label": "string",
            "mode": "string",
            "owner": "string",
        },
        "timestamps": {
            "atime": "string",
            "ctime": "string",
            "mtime": "string",
        },
    })

    const poolResource = new libvirt.Pool("poolResource", {
    type: "string",
    allocationUnit: "string",
    availableUnit: "string",
    capacityUnit: "string",
    features: {
        cow: {
            state: "string",
        },
    },
    name: "string",
    refresh: {
        volume: {
            allocation: "string",
        },
    },
    source: {
        adapter: {
            managed: false,
            name: "string",
            parent: "string",
            parentAddr: {
                uniqueId: 0,
                address: {
                    bus: 0,
                    domain: 0,
                    "function": 0,
                    slot: 0,
                },
            },
            type: "string",
            wwnn: "string",
            wwpn: "string",
        },
        auth: {
            type: "string",
            username: "string",
            secret: {
                usage: "string",
                uuid: "string",
            },
        },
        devices: [{
            path: "string",
            freeExtents: [{
                end: 0,
                start: 0,
            }],
            partSeparator: "string",
        }],
        dir: {
            path: "string",
        },
        format: {
            type: "string",
        },
        hosts: [{
            name: "string",
            port: "string",
        }],
        initiator: {
            iqn: {
                name: "string",
            },
        },
        name: "string",
        product: {
            name: "string",
        },
        protocol: {
            version: "string",
        },
        vendor: {
            name: "string",
        },
    },
    target: {
        encryption: {
            format: "string",
            cipher: {
                hash: "string",
                mode: "string",
                name: "string",
                size: 0,
            },
            ivgen: {
                hash: "string",
                name: "string",
            },
            secret: {
                type: "string",
                uuid: "string",
            },
        },
        path: "string",
        permissions: {
            group: "string",
            label: "string",
            mode: "string",
            owner: "string",
        },
        timestamps: {
            atime: "string",
            ctime: "string",
            mtime: "string",
        },
    },
});

    type: libvirt:Pool
properties:
    allocationUnit: string
    availableUnit: string
    capacityUnit: string
    features:
        cow:
            state: string
    name: string
    refresh:
        volume:
            allocation: string
    source:
        adapter:
            managed: false
            name: string
            parent: string
            parentAddr:
                address:
                    bus: 0
                    domain: 0
                    function: 0
                    slot: 0
                uniqueId: 0
            type: string
            wwnn: string
            wwpn: string
        auth:
            secret:
                usage: string
                uuid: string
            type: string
            username: string
        devices:
            - freeExtents:
                - end: 0
                  start: 0
              partSeparator: string
              path: string
        dir:
            path: string
        format:
            type: string
        hosts:
            - name: string
              port: string
        initiator:
            iqn:
                name: string
        name: string
        product:
            name: string
        protocol:
            version: string
        vendor:
            name: string
    target:
        encryption:
            cipher:
                hash: string
                mode: string
                name: string
                size: 0
            format: string
            ivgen:
                hash: string
                name: string
            secret:
                type: string
                uuid: string
        path: string
        permissions:
            group: string
            label: string
            mode: string
            owner: string
        timestamps:
            atime: string
            ctime: string
            mtime: string
    type: string

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

    Type string
    Specifies the type of the storage pool being defined.
    AllocationUnit string
    Specifies the unit type for the pool's allocated storage, defining measurement standards.
    AvailableUnit string
    Sets the unit type for measuring available storage within the pool.
    CapacityUnit string
    Specifies the unit type for measuring the total capacity of the storage pool.
    Features PoolFeatures
    Defines optional features supported by the storage pool, enhancing functional capabilities.
    Name string
    Sets the unique name for the storage pool, required for identification on the host.
    Refresh PoolRefresh
    Controls the refresh behavior of the storage pool and associated volumes.
    Source PoolSource
    Source location for the storage pool
    Target PoolTarget
    Target path and permissions for the storage pool
    Type string
    Specifies the type of the storage pool being defined.
    AllocationUnit string
    Specifies the unit type for the pool's allocated storage, defining measurement standards.
    AvailableUnit string
    Sets the unit type for measuring available storage within the pool.
    CapacityUnit string
    Specifies the unit type for measuring the total capacity of the storage pool.
    Features PoolFeaturesArgs
    Defines optional features supported by the storage pool, enhancing functional capabilities.
    Name string
    Sets the unique name for the storage pool, required for identification on the host.
    Refresh PoolRefreshArgs
    Controls the refresh behavior of the storage pool and associated volumes.
    Source PoolSourceArgs
    Source location for the storage pool
    Target PoolTargetArgs
    Target path and permissions for the storage pool
    type String
    Specifies the type of the storage pool being defined.
    allocationUnit String
    Specifies the unit type for the pool's allocated storage, defining measurement standards.
    availableUnit String
    Sets the unit type for measuring available storage within the pool.
    capacityUnit String
    Specifies the unit type for measuring the total capacity of the storage pool.
    features PoolFeatures
    Defines optional features supported by the storage pool, enhancing functional capabilities.
    name String
    Sets the unique name for the storage pool, required for identification on the host.
    refresh PoolRefresh
    Controls the refresh behavior of the storage pool and associated volumes.
    source PoolSource
    Source location for the storage pool
    target PoolTarget
    Target path and permissions for the storage pool
    type string
    Specifies the type of the storage pool being defined.
    allocationUnit string
    Specifies the unit type for the pool's allocated storage, defining measurement standards.
    availableUnit string
    Sets the unit type for measuring available storage within the pool.
    capacityUnit string
    Specifies the unit type for measuring the total capacity of the storage pool.
    features PoolFeatures
    Defines optional features supported by the storage pool, enhancing functional capabilities.
    name string
    Sets the unique name for the storage pool, required for identification on the host.
    refresh PoolRefresh
    Controls the refresh behavior of the storage pool and associated volumes.
    source PoolSource
    Source location for the storage pool
    target PoolTarget
    Target path and permissions for the storage pool
    type str
    Specifies the type of the storage pool being defined.
    allocation_unit str
    Specifies the unit type for the pool's allocated storage, defining measurement standards.
    available_unit str
    Sets the unit type for measuring available storage within the pool.
    capacity_unit str
    Specifies the unit type for measuring the total capacity of the storage pool.
    features PoolFeaturesArgs
    Defines optional features supported by the storage pool, enhancing functional capabilities.
    name str
    Sets the unique name for the storage pool, required for identification on the host.
    refresh PoolRefreshArgs
    Controls the refresh behavior of the storage pool and associated volumes.
    source PoolSourceArgs
    Source location for the storage pool
    target PoolTargetArgs
    Target path and permissions for the storage pool
    type String
    Specifies the type of the storage pool being defined.
    allocationUnit String
    Specifies the unit type for the pool's allocated storage, defining measurement standards.
    availableUnit String
    Sets the unit type for measuring available storage within the pool.
    capacityUnit String
    Specifies the unit type for measuring the total capacity of the storage pool.
    features Property Map
    Defines optional features supported by the storage pool, enhancing functional capabilities.
    name String
    Sets the unique name for the storage pool, required for identification on the host.
    refresh Property Map
    Controls the refresh behavior of the storage pool and associated volumes.
    source Property Map
    Source location for the storage pool
    target Property Map
    Target path and permissions for the storage pool

    Outputs

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

    Allocation double
    Configures the amount of storage allocated to the pool, determining capacity usage.
    Available double
    Indicates the amount of available storage within the pool for new allocations.
    Capacity double
    Configures the total capacity of the storage pool, defining its maximum size.
    Id string
    The provider-assigned unique ID for this managed resource.
    Uuid string
    Sets the universally unique identifier for the storage pool.
    Allocation float64
    Configures the amount of storage allocated to the pool, determining capacity usage.
    Available float64
    Indicates the amount of available storage within the pool for new allocations.
    Capacity float64
    Configures the total capacity of the storage pool, defining its maximum size.
    Id string
    The provider-assigned unique ID for this managed resource.
    Uuid string
    Sets the universally unique identifier for the storage pool.
    allocation Double
    Configures the amount of storage allocated to the pool, determining capacity usage.
    available Double
    Indicates the amount of available storage within the pool for new allocations.
    capacity Double
    Configures the total capacity of the storage pool, defining its maximum size.
    id String
    The provider-assigned unique ID for this managed resource.
    uuid String
    Sets the universally unique identifier for the storage pool.
    allocation number
    Configures the amount of storage allocated to the pool, determining capacity usage.
    available number
    Indicates the amount of available storage within the pool for new allocations.
    capacity number
    Configures the total capacity of the storage pool, defining its maximum size.
    id string
    The provider-assigned unique ID for this managed resource.
    uuid string
    Sets the universally unique identifier for the storage pool.
    allocation float
    Configures the amount of storage allocated to the pool, determining capacity usage.
    available float
    Indicates the amount of available storage within the pool for new allocations.
    capacity float
    Configures the total capacity of the storage pool, defining its maximum size.
    id str
    The provider-assigned unique ID for this managed resource.
    uuid str
    Sets the universally unique identifier for the storage pool.
    allocation Number
    Configures the amount of storage allocated to the pool, determining capacity usage.
    available Number
    Indicates the amount of available storage within the pool for new allocations.
    capacity Number
    Configures the total capacity of the storage pool, defining its maximum size.
    id String
    The provider-assigned unique ID for this managed resource.
    uuid String
    Sets the universally unique identifier for the storage pool.

    Look up Existing Pool Resource

    Get an existing Pool 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?: PoolState, opts?: CustomResourceOptions): Pool
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allocation: Optional[float] = None,
        allocation_unit: Optional[str] = None,
        available: Optional[float] = None,
        available_unit: Optional[str] = None,
        capacity: Optional[float] = None,
        capacity_unit: Optional[str] = None,
        features: Optional[PoolFeaturesArgs] = None,
        name: Optional[str] = None,
        refresh: Optional[PoolRefreshArgs] = None,
        source: Optional[PoolSourceArgs] = None,
        target: Optional[PoolTargetArgs] = None,
        type: Optional[str] = None,
        uuid: Optional[str] = None) -> Pool
    func GetPool(ctx *Context, name string, id IDInput, state *PoolState, opts ...ResourceOption) (*Pool, error)
    public static Pool Get(string name, Input<string> id, PoolState? state, CustomResourceOptions? opts = null)
    public static Pool get(String name, Output<String> id, PoolState state, CustomResourceOptions options)
    resources:  _:    type: libvirt:Pool    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:
    Allocation double
    Configures the amount of storage allocated to the pool, determining capacity usage.
    AllocationUnit string
    Specifies the unit type for the pool's allocated storage, defining measurement standards.
    Available double
    Indicates the amount of available storage within the pool for new allocations.
    AvailableUnit string
    Sets the unit type for measuring available storage within the pool.
    Capacity double
    Configures the total capacity of the storage pool, defining its maximum size.
    CapacityUnit string
    Specifies the unit type for measuring the total capacity of the storage pool.
    Features PoolFeatures
    Defines optional features supported by the storage pool, enhancing functional capabilities.
    Name string
    Sets the unique name for the storage pool, required for identification on the host.
    Refresh PoolRefresh
    Controls the refresh behavior of the storage pool and associated volumes.
    Source PoolSource
    Source location for the storage pool
    Target PoolTarget
    Target path and permissions for the storage pool
    Type string
    Specifies the type of the storage pool being defined.
    Uuid string
    Sets the universally unique identifier for the storage pool.
    Allocation float64
    Configures the amount of storage allocated to the pool, determining capacity usage.
    AllocationUnit string
    Specifies the unit type for the pool's allocated storage, defining measurement standards.
    Available float64
    Indicates the amount of available storage within the pool for new allocations.
    AvailableUnit string
    Sets the unit type for measuring available storage within the pool.
    Capacity float64
    Configures the total capacity of the storage pool, defining its maximum size.
    CapacityUnit string
    Specifies the unit type for measuring the total capacity of the storage pool.
    Features PoolFeaturesArgs
    Defines optional features supported by the storage pool, enhancing functional capabilities.
    Name string
    Sets the unique name for the storage pool, required for identification on the host.
    Refresh PoolRefreshArgs
    Controls the refresh behavior of the storage pool and associated volumes.
    Source PoolSourceArgs
    Source location for the storage pool
    Target PoolTargetArgs
    Target path and permissions for the storage pool
    Type string
    Specifies the type of the storage pool being defined.
    Uuid string
    Sets the universally unique identifier for the storage pool.
    allocation Double
    Configures the amount of storage allocated to the pool, determining capacity usage.
    allocationUnit String
    Specifies the unit type for the pool's allocated storage, defining measurement standards.
    available Double
    Indicates the amount of available storage within the pool for new allocations.
    availableUnit String
    Sets the unit type for measuring available storage within the pool.
    capacity Double
    Configures the total capacity of the storage pool, defining its maximum size.
    capacityUnit String
    Specifies the unit type for measuring the total capacity of the storage pool.
    features PoolFeatures
    Defines optional features supported by the storage pool, enhancing functional capabilities.
    name String
    Sets the unique name for the storage pool, required for identification on the host.
    refresh PoolRefresh
    Controls the refresh behavior of the storage pool and associated volumes.
    source PoolSource
    Source location for the storage pool
    target PoolTarget
    Target path and permissions for the storage pool
    type String
    Specifies the type of the storage pool being defined.
    uuid String
    Sets the universally unique identifier for the storage pool.
    allocation number
    Configures the amount of storage allocated to the pool, determining capacity usage.
    allocationUnit string
    Specifies the unit type for the pool's allocated storage, defining measurement standards.
    available number
    Indicates the amount of available storage within the pool for new allocations.
    availableUnit string
    Sets the unit type for measuring available storage within the pool.
    capacity number
    Configures the total capacity of the storage pool, defining its maximum size.
    capacityUnit string
    Specifies the unit type for measuring the total capacity of the storage pool.
    features PoolFeatures
    Defines optional features supported by the storage pool, enhancing functional capabilities.
    name string
    Sets the unique name for the storage pool, required for identification on the host.
    refresh PoolRefresh
    Controls the refresh behavior of the storage pool and associated volumes.
    source PoolSource
    Source location for the storage pool
    target PoolTarget
    Target path and permissions for the storage pool
    type string
    Specifies the type of the storage pool being defined.
    uuid string
    Sets the universally unique identifier for the storage pool.
    allocation float
    Configures the amount of storage allocated to the pool, determining capacity usage.
    allocation_unit str
    Specifies the unit type for the pool's allocated storage, defining measurement standards.
    available float
    Indicates the amount of available storage within the pool for new allocations.
    available_unit str
    Sets the unit type for measuring available storage within the pool.
    capacity float
    Configures the total capacity of the storage pool, defining its maximum size.
    capacity_unit str
    Specifies the unit type for measuring the total capacity of the storage pool.
    features PoolFeaturesArgs
    Defines optional features supported by the storage pool, enhancing functional capabilities.
    name str
    Sets the unique name for the storage pool, required for identification on the host.
    refresh PoolRefreshArgs
    Controls the refresh behavior of the storage pool and associated volumes.
    source PoolSourceArgs
    Source location for the storage pool
    target PoolTargetArgs
    Target path and permissions for the storage pool
    type str
    Specifies the type of the storage pool being defined.
    uuid str
    Sets the universally unique identifier for the storage pool.
    allocation Number
    Configures the amount of storage allocated to the pool, determining capacity usage.
    allocationUnit String
    Specifies the unit type for the pool's allocated storage, defining measurement standards.
    available Number
    Indicates the amount of available storage within the pool for new allocations.
    availableUnit String
    Sets the unit type for measuring available storage within the pool.
    capacity Number
    Configures the total capacity of the storage pool, defining its maximum size.
    capacityUnit String
    Specifies the unit type for measuring the total capacity of the storage pool.
    features Property Map
    Defines optional features supported by the storage pool, enhancing functional capabilities.
    name String
    Sets the unique name for the storage pool, required for identification on the host.
    refresh Property Map
    Controls the refresh behavior of the storage pool and associated volumes.
    source Property Map
    Source location for the storage pool
    target Property Map
    Target path and permissions for the storage pool
    type String
    Specifies the type of the storage pool being defined.
    uuid String
    Sets the universally unique identifier for the storage pool.

    Supporting Types

    PoolFeatures, PoolFeaturesArgs

    Cow PoolFeaturesCow
    Indicates whether copy-on-write (COW) is enabled for the storage pool's images.
    Cow PoolFeaturesCow
    Indicates whether copy-on-write (COW) is enabled for the storage pool's images.
    cow PoolFeaturesCow
    Indicates whether copy-on-write (COW) is enabled for the storage pool's images.
    cow PoolFeaturesCow
    Indicates whether copy-on-write (COW) is enabled for the storage pool's images.
    cow PoolFeaturesCow
    Indicates whether copy-on-write (COW) is enabled for the storage pool's images.
    cow Property Map
    Indicates whether copy-on-write (COW) is enabled for the storage pool's images.

    PoolFeaturesCow, PoolFeaturesCowArgs

    State string
    Configures the state of the copy-on-write feature within the storage pool.
    State string
    Configures the state of the copy-on-write feature within the storage pool.
    state String
    Configures the state of the copy-on-write feature within the storage pool.
    state string
    Configures the state of the copy-on-write feature within the storage pool.
    state str
    Configures the state of the copy-on-write feature within the storage pool.
    state String
    Configures the state of the copy-on-write feature within the storage pool.

    PoolRefresh, PoolRefreshArgs

    Volume PoolRefreshVolume
    Configures the refresh settings for individual volumes within the storage pool.
    Volume PoolRefreshVolume
    Configures the refresh settings for individual volumes within the storage pool.
    volume PoolRefreshVolume
    Configures the refresh settings for individual volumes within the storage pool.
    volume PoolRefreshVolume
    Configures the refresh settings for individual volumes within the storage pool.
    volume PoolRefreshVolume
    Configures the refresh settings for individual volumes within the storage pool.
    volume Property Map
    Configures the refresh settings for individual volumes within the storage pool.

    PoolRefreshVolume, PoolRefreshVolumeArgs

    Allocation string
    Defines how allocation amounts are calculated during the refresh operation for the volume.
    Allocation string
    Defines how allocation amounts are calculated during the refresh operation for the volume.
    allocation String
    Defines how allocation amounts are calculated during the refresh operation for the volume.
    allocation string
    Defines how allocation amounts are calculated during the refresh operation for the volume.
    allocation str
    Defines how allocation amounts are calculated during the refresh operation for the volume.
    allocation String
    Defines how allocation amounts are calculated during the refresh operation for the volume.

    PoolSource, PoolSourceArgs

    Adapter PoolSourceAdapter
    Configures the details of the adapter used for connecting to the storage source.
    Auth PoolSourceAuth
    Specifies the authentication method used when connecting to the storage source.
    Devices List<PoolSourceDevice>
    Specifies the device to be used as the source for the storage pool.
    Dir PoolSourceDir
    Indicates the directory used as a source for the storage pool.
    Format PoolSourceFormat
    Sets the format of the storage source being used, affecting how data is stored and accessed.
    Hosts List<PoolSourceHost>
    Specifies the host details for connecting to the storage source.
    Initiator PoolSourceInitiator
    Defines the iSCSI initiator settings associated with the storage source.
    Name string
    Specifies the name of the source for the storage pool.
    Product PoolSourceProduct
    Identifies the product details associated with the storage source.
    Protocol PoolSourceProtocol
    Sets the protocol used to connect to the storage source.
    Vendor PoolSourceVendor
    Specifies the vendor information for the storage source being used.
    Adapter PoolSourceAdapter
    Configures the details of the adapter used for connecting to the storage source.
    Auth PoolSourceAuth
    Specifies the authentication method used when connecting to the storage source.
    Devices []PoolSourceDevice
    Specifies the device to be used as the source for the storage pool.
    Dir PoolSourceDir
    Indicates the directory used as a source for the storage pool.
    Format PoolSourceFormat
    Sets the format of the storage source being used, affecting how data is stored and accessed.
    Hosts []PoolSourceHost
    Specifies the host details for connecting to the storage source.
    Initiator PoolSourceInitiator
    Defines the iSCSI initiator settings associated with the storage source.
    Name string
    Specifies the name of the source for the storage pool.
    Product PoolSourceProduct
    Identifies the product details associated with the storage source.
    Protocol PoolSourceProtocol
    Sets the protocol used to connect to the storage source.
    Vendor PoolSourceVendor
    Specifies the vendor information for the storage source being used.
    adapter PoolSourceAdapter
    Configures the details of the adapter used for connecting to the storage source.
    auth PoolSourceAuth
    Specifies the authentication method used when connecting to the storage source.
    devices List<PoolSourceDevice>
    Specifies the device to be used as the source for the storage pool.
    dir PoolSourceDir
    Indicates the directory used as a source for the storage pool.
    format PoolSourceFormat
    Sets the format of the storage source being used, affecting how data is stored and accessed.
    hosts List<PoolSourceHost>
    Specifies the host details for connecting to the storage source.
    initiator PoolSourceInitiator
    Defines the iSCSI initiator settings associated with the storage source.
    name String
    Specifies the name of the source for the storage pool.
    product PoolSourceProduct
    Identifies the product details associated with the storage source.
    protocol PoolSourceProtocol
    Sets the protocol used to connect to the storage source.
    vendor PoolSourceVendor
    Specifies the vendor information for the storage source being used.
    adapter PoolSourceAdapter
    Configures the details of the adapter used for connecting to the storage source.
    auth PoolSourceAuth
    Specifies the authentication method used when connecting to the storage source.
    devices PoolSourceDevice[]
    Specifies the device to be used as the source for the storage pool.
    dir PoolSourceDir
    Indicates the directory used as a source for the storage pool.
    format PoolSourceFormat
    Sets the format of the storage source being used, affecting how data is stored and accessed.
    hosts PoolSourceHost[]
    Specifies the host details for connecting to the storage source.
    initiator PoolSourceInitiator
    Defines the iSCSI initiator settings associated with the storage source.
    name string
    Specifies the name of the source for the storage pool.
    product PoolSourceProduct
    Identifies the product details associated with the storage source.
    protocol PoolSourceProtocol
    Sets the protocol used to connect to the storage source.
    vendor PoolSourceVendor
    Specifies the vendor information for the storage source being used.
    adapter PoolSourceAdapter
    Configures the details of the adapter used for connecting to the storage source.
    auth PoolSourceAuth
    Specifies the authentication method used when connecting to the storage source.
    devices Sequence[PoolSourceDevice]
    Specifies the device to be used as the source for the storage pool.
    dir PoolSourceDir
    Indicates the directory used as a source for the storage pool.
    format PoolSourceFormat
    Sets the format of the storage source being used, affecting how data is stored and accessed.
    hosts Sequence[PoolSourceHost]
    Specifies the host details for connecting to the storage source.
    initiator PoolSourceInitiator
    Defines the iSCSI initiator settings associated with the storage source.
    name str
    Specifies the name of the source for the storage pool.
    product PoolSourceProduct
    Identifies the product details associated with the storage source.
    protocol PoolSourceProtocol
    Sets the protocol used to connect to the storage source.
    vendor PoolSourceVendor
    Specifies the vendor information for the storage source being used.
    adapter Property Map
    Configures the details of the adapter used for connecting to the storage source.
    auth Property Map
    Specifies the authentication method used when connecting to the storage source.
    devices List<Property Map>
    Specifies the device to be used as the source for the storage pool.
    dir Property Map
    Indicates the directory used as a source for the storage pool.
    format Property Map
    Sets the format of the storage source being used, affecting how data is stored and accessed.
    hosts List<Property Map>
    Specifies the host details for connecting to the storage source.
    initiator Property Map
    Defines the iSCSI initiator settings associated with the storage source.
    name String
    Specifies the name of the source for the storage pool.
    product Property Map
    Identifies the product details associated with the storage source.
    protocol Property Map
    Sets the protocol used to connect to the storage source.
    vendor Property Map
    Specifies the vendor information for the storage source being used.

    PoolSourceAdapter, PoolSourceAdapterArgs

    Managed bool
    Indicates whether the adapter is managed by the virtualization framework.
    Name string
    Sets the name of the adapter for identification purposes.
    Parent string
    Specifies the parent identifier of the adapter if applicable, linking it to a higher-level entity.
    ParentAddr PoolSourceAdapterParentAddr
    Provides the address details of the adapter's parent device.
    Type string
    Sets the type of the adapter being used for the storage source connection.
    Wwnn string
    Defines the World Wide Name for the node of the adapter used in the storage source context.
    Wwpn string
    Configures the World Wide Name for the portal of the adapter connected to the storage source.
    Managed bool
    Indicates whether the adapter is managed by the virtualization framework.
    Name string
    Sets the name of the adapter for identification purposes.
    Parent string
    Specifies the parent identifier of the adapter if applicable, linking it to a higher-level entity.
    ParentAddr PoolSourceAdapterParentAddr
    Provides the address details of the adapter's parent device.
    Type string
    Sets the type of the adapter being used for the storage source connection.
    Wwnn string
    Defines the World Wide Name for the node of the adapter used in the storage source context.
    Wwpn string
    Configures the World Wide Name for the portal of the adapter connected to the storage source.
    managed Boolean
    Indicates whether the adapter is managed by the virtualization framework.
    name String
    Sets the name of the adapter for identification purposes.
    parent String
    Specifies the parent identifier of the adapter if applicable, linking it to a higher-level entity.
    parentAddr PoolSourceAdapterParentAddr
    Provides the address details of the adapter's parent device.
    type String
    Sets the type of the adapter being used for the storage source connection.
    wwnn String
    Defines the World Wide Name for the node of the adapter used in the storage source context.
    wwpn String
    Configures the World Wide Name for the portal of the adapter connected to the storage source.
    managed boolean
    Indicates whether the adapter is managed by the virtualization framework.
    name string
    Sets the name of the adapter for identification purposes.
    parent string
    Specifies the parent identifier of the adapter if applicable, linking it to a higher-level entity.
    parentAddr PoolSourceAdapterParentAddr
    Provides the address details of the adapter's parent device.
    type string
    Sets the type of the adapter being used for the storage source connection.
    wwnn string
    Defines the World Wide Name for the node of the adapter used in the storage source context.
    wwpn string
    Configures the World Wide Name for the portal of the adapter connected to the storage source.
    managed bool
    Indicates whether the adapter is managed by the virtualization framework.
    name str
    Sets the name of the adapter for identification purposes.
    parent str
    Specifies the parent identifier of the adapter if applicable, linking it to a higher-level entity.
    parent_addr PoolSourceAdapterParentAddr
    Provides the address details of the adapter's parent device.
    type str
    Sets the type of the adapter being used for the storage source connection.
    wwnn str
    Defines the World Wide Name for the node of the adapter used in the storage source context.
    wwpn str
    Configures the World Wide Name for the portal of the adapter connected to the storage source.
    managed Boolean
    Indicates whether the adapter is managed by the virtualization framework.
    name String
    Sets the name of the adapter for identification purposes.
    parent String
    Specifies the parent identifier of the adapter if applicable, linking it to a higher-level entity.
    parentAddr Property Map
    Provides the address details of the adapter's parent device.
    type String
    Sets the type of the adapter being used for the storage source connection.
    wwnn String
    Defines the World Wide Name for the node of the adapter used in the storage source context.
    wwpn String
    Configures the World Wide Name for the portal of the adapter connected to the storage source.

    PoolSourceAdapterParentAddr, PoolSourceAdapterParentAddrArgs

    UniqueId double
    Provides a unique identifier for the address of the parent adapter.
    Address PoolSourceAdapterParentAddrAddress
    Configures the address information related to the parent device of the adapter.
    UniqueId float64
    Provides a unique identifier for the address of the parent adapter.
    Address PoolSourceAdapterParentAddrAddress
    Configures the address information related to the parent device of the adapter.
    uniqueId Double
    Provides a unique identifier for the address of the parent adapter.
    address PoolSourceAdapterParentAddrAddress
    Configures the address information related to the parent device of the adapter.
    uniqueId number
    Provides a unique identifier for the address of the parent adapter.
    address PoolSourceAdapterParentAddrAddress
    Configures the address information related to the parent device of the adapter.
    unique_id float
    Provides a unique identifier for the address of the parent adapter.
    address PoolSourceAdapterParentAddrAddress
    Configures the address information related to the parent device of the adapter.
    uniqueId Number
    Provides a unique identifier for the address of the parent adapter.
    address Property Map
    Configures the address information related to the parent device of the adapter.

    PoolSourceAdapterParentAddrAddress, PoolSourceAdapterParentAddrAddressArgs

    Bus double
    Specifies the bus identifier for the parent address.
    Domain double
    Defines the domain associated with the parent address of the adapter.
    Function double
    Configures the function field for the address of the adapter's parent device.
    Slot double
    Indicates the slot number for the adapter's parent address.
    Bus float64
    Specifies the bus identifier for the parent address.
    Domain float64
    Defines the domain associated with the parent address of the adapter.
    Function float64
    Configures the function field for the address of the adapter's parent device.
    Slot float64
    Indicates the slot number for the adapter's parent address.
    bus Double
    Specifies the bus identifier for the parent address.
    domain Double
    Defines the domain associated with the parent address of the adapter.
    function Double
    Configures the function field for the address of the adapter's parent device.
    slot Double
    Indicates the slot number for the adapter's parent address.
    bus number
    Specifies the bus identifier for the parent address.
    domain number
    Defines the domain associated with the parent address of the adapter.
    function number
    Configures the function field for the address of the adapter's parent device.
    slot number
    Indicates the slot number for the adapter's parent address.
    bus float
    Specifies the bus identifier for the parent address.
    domain float
    Defines the domain associated with the parent address of the adapter.
    function float
    Configures the function field for the address of the adapter's parent device.
    slot float
    Indicates the slot number for the adapter's parent address.
    bus Number
    Specifies the bus identifier for the parent address.
    domain Number
    Defines the domain associated with the parent address of the adapter.
    function Number
    Configures the function field for the address of the adapter's parent device.
    slot Number
    Indicates the slot number for the adapter's parent address.

    PoolSourceAuth, PoolSourceAuthArgs

    Type string
    Configures the type of authentication mechanism to be used on the storage source connection.
    Username string
    Sets the username for authenticating access to the storage source.
    Secret PoolSourceAuthSecret
    Defines the secret used for authenticated access to the storage source.
    Type string
    Configures the type of authentication mechanism to be used on the storage source connection.
    Username string
    Sets the username for authenticating access to the storage source.
    Secret PoolSourceAuthSecret
    Defines the secret used for authenticated access to the storage source.
    type String
    Configures the type of authentication mechanism to be used on the storage source connection.
    username String
    Sets the username for authenticating access to the storage source.
    secret PoolSourceAuthSecret
    Defines the secret used for authenticated access to the storage source.
    type string
    Configures the type of authentication mechanism to be used on the storage source connection.
    username string
    Sets the username for authenticating access to the storage source.
    secret PoolSourceAuthSecret
    Defines the secret used for authenticated access to the storage source.
    type str
    Configures the type of authentication mechanism to be used on the storage source connection.
    username str
    Sets the username for authenticating access to the storage source.
    secret PoolSourceAuthSecret
    Defines the secret used for authenticated access to the storage source.
    type String
    Configures the type of authentication mechanism to be used on the storage source connection.
    username String
    Sets the username for authenticating access to the storage source.
    secret Property Map
    Defines the secret used for authenticated access to the storage source.

    PoolSourceAuthSecret, PoolSourceAuthSecretArgs

    Usage string
    Indicates the intended usage for the authentication secret.
    Uuid string
    Sets the UUID for the authentication secret tied to the storage source connection.
    Usage string
    Indicates the intended usage for the authentication secret.
    Uuid string
    Sets the UUID for the authentication secret tied to the storage source connection.
    usage String
    Indicates the intended usage for the authentication secret.
    uuid String
    Sets the UUID for the authentication secret tied to the storage source connection.
    usage string
    Indicates the intended usage for the authentication secret.
    uuid string
    Sets the UUID for the authentication secret tied to the storage source connection.
    usage str
    Indicates the intended usage for the authentication secret.
    uuid str
    Sets the UUID for the authentication secret tied to the storage source connection.
    usage String
    Indicates the intended usage for the authentication secret.
    uuid String
    Sets the UUID for the authentication secret tied to the storage source connection.

    PoolSourceDevice, PoolSourceDeviceArgs

    Path string
    Specifies the physical path to the device used as the source for the storage pool.
    FreeExtents List<PoolSourceDeviceFreeExtent>
    Controls the free extents available for allocation within the source device.
    PartSeparator string
    Configures the separator character used for partitioning in the device path.
    Path string
    Specifies the physical path to the device used as the source for the storage pool.
    FreeExtents []PoolSourceDeviceFreeExtent
    Controls the free extents available for allocation within the source device.
    PartSeparator string
    Configures the separator character used for partitioning in the device path.
    path String
    Specifies the physical path to the device used as the source for the storage pool.
    freeExtents List<PoolSourceDeviceFreeExtent>
    Controls the free extents available for allocation within the source device.
    partSeparator String
    Configures the separator character used for partitioning in the device path.
    path string
    Specifies the physical path to the device used as the source for the storage pool.
    freeExtents PoolSourceDeviceFreeExtent[]
    Controls the free extents available for allocation within the source device.
    partSeparator string
    Configures the separator character used for partitioning in the device path.
    path str
    Specifies the physical path to the device used as the source for the storage pool.
    free_extents Sequence[PoolSourceDeviceFreeExtent]
    Controls the free extents available for allocation within the source device.
    part_separator str
    Configures the separator character used for partitioning in the device path.
    path String
    Specifies the physical path to the device used as the source for the storage pool.
    freeExtents List<Property Map>
    Controls the free extents available for allocation within the source device.
    partSeparator String
    Configures the separator character used for partitioning in the device path.

    PoolSourceDeviceFreeExtent, PoolSourceDeviceFreeExtentArgs

    End double
    Indicates the end value for the free extents available in the source device.
    Start double
    Defines the starting point for the free extents in the source device.
    End float64
    Indicates the end value for the free extents available in the source device.
    Start float64
    Defines the starting point for the free extents in the source device.
    end Double
    Indicates the end value for the free extents available in the source device.
    start Double
    Defines the starting point for the free extents in the source device.
    end number
    Indicates the end value for the free extents available in the source device.
    start number
    Defines the starting point for the free extents in the source device.
    end float
    Indicates the end value for the free extents available in the source device.
    start float
    Defines the starting point for the free extents in the source device.
    end Number
    Indicates the end value for the free extents available in the source device.
    start Number
    Defines the starting point for the free extents in the source device.

    PoolSourceDir, PoolSourceDirArgs

    Path string
    Provides the path to the directory that serves as a source for the storage pool.
    Path string
    Provides the path to the directory that serves as a source for the storage pool.
    path String
    Provides the path to the directory that serves as a source for the storage pool.
    path string
    Provides the path to the directory that serves as a source for the storage pool.
    path str
    Provides the path to the directory that serves as a source for the storage pool.
    path String
    Provides the path to the directory that serves as a source for the storage pool.

    PoolSourceFormat, PoolSourceFormatArgs

    Type string
    Defines the specific type of format for the storage source.
    Type string
    Defines the specific type of format for the storage source.
    type String
    Defines the specific type of format for the storage source.
    type string
    Defines the specific type of format for the storage source.
    type str
    Defines the specific type of format for the storage source.
    type String
    Defines the specific type of format for the storage source.

    PoolSourceHost, PoolSourceHostArgs

    Name string
    Sets the name of the host where the storage source is located.
    Port string
    Configures the port number to be used for connecting to the storage source on the host.
    Name string
    Sets the name of the host where the storage source is located.
    Port string
    Configures the port number to be used for connecting to the storage source on the host.
    name String
    Sets the name of the host where the storage source is located.
    port String
    Configures the port number to be used for connecting to the storage source on the host.
    name string
    Sets the name of the host where the storage source is located.
    port string
    Configures the port number to be used for connecting to the storage source on the host.
    name str
    Sets the name of the host where the storage source is located.
    port str
    Configures the port number to be used for connecting to the storage source on the host.
    name String
    Sets the name of the host where the storage source is located.
    port String
    Configures the port number to be used for connecting to the storage source on the host.

    PoolSourceInitiator, PoolSourceInitiatorArgs

    Iqn PoolSourceInitiatorIqn
    Configures the iSCSI Qualified Name (IQN) for the initiator connecting to the storage source.
    Iqn PoolSourceInitiatorIqn
    Configures the iSCSI Qualified Name (IQN) for the initiator connecting to the storage source.
    iqn PoolSourceInitiatorIqn
    Configures the iSCSI Qualified Name (IQN) for the initiator connecting to the storage source.
    iqn PoolSourceInitiatorIqn
    Configures the iSCSI Qualified Name (IQN) for the initiator connecting to the storage source.
    iqn PoolSourceInitiatorIqn
    Configures the iSCSI Qualified Name (IQN) for the initiator connecting to the storage source.
    iqn Property Map
    Configures the iSCSI Qualified Name (IQN) for the initiator connecting to the storage source.

    PoolSourceInitiatorIqn, PoolSourceInitiatorIqnArgs

    Name string
    Sets the name attribute of the iSCSI IQN for identification.
    Name string
    Sets the name attribute of the iSCSI IQN for identification.
    name String
    Sets the name attribute of the iSCSI IQN for identification.
    name string
    Sets the name attribute of the iSCSI IQN for identification.
    name str
    Sets the name attribute of the iSCSI IQN for identification.
    name String
    Sets the name attribute of the iSCSI IQN for identification.

    PoolSourceProduct, PoolSourceProductArgs

    Name string
    Configures the name attribute of the product related to the storage source.
    Name string
    Configures the name attribute of the product related to the storage source.
    name String
    Configures the name attribute of the product related to the storage source.
    name string
    Configures the name attribute of the product related to the storage source.
    name str
    Configures the name attribute of the product related to the storage source.
    name String
    Configures the name attribute of the product related to the storage source.

    PoolSourceProtocol, PoolSourceProtocolArgs

    Version string
    Indicates the version of the protocol being used for the connection.
    Version string
    Indicates the version of the protocol being used for the connection.
    version String
    Indicates the version of the protocol being used for the connection.
    version string
    Indicates the version of the protocol being used for the connection.
    version str
    Indicates the version of the protocol being used for the connection.
    version String
    Indicates the version of the protocol being used for the connection.

    PoolSourceVendor, PoolSourceVendorArgs

    Name string
    Configures the name attribute for the vendor related to the storage source.
    Name string
    Configures the name attribute for the vendor related to the storage source.
    name String
    Configures the name attribute for the vendor related to the storage source.
    name string
    Configures the name attribute for the vendor related to the storage source.
    name str
    Configures the name attribute for the vendor related to the storage source.
    name String
    Configures the name attribute for the vendor related to the storage source.

    PoolTarget, PoolTargetArgs

    Encryption PoolTargetEncryption
    Configures the encryption settings for the storage volume.
    Path string
    Defines the path in the host filesystem where the storage pool is mapped.
    Permissions PoolTargetPermissions
    Configures the permissions for the storage pool target.
    Timestamps PoolTargetTimestamps
    Sets the timestamp attributes for the storage pool target.
    Encryption PoolTargetEncryption
    Configures the encryption settings for the storage volume.
    Path string
    Defines the path in the host filesystem where the storage pool is mapped.
    Permissions PoolTargetPermissions
    Configures the permissions for the storage pool target.
    Timestamps PoolTargetTimestamps
    Sets the timestamp attributes for the storage pool target.
    encryption PoolTargetEncryption
    Configures the encryption settings for the storage volume.
    path String
    Defines the path in the host filesystem where the storage pool is mapped.
    permissions PoolTargetPermissions
    Configures the permissions for the storage pool target.
    timestamps PoolTargetTimestamps
    Sets the timestamp attributes for the storage pool target.
    encryption PoolTargetEncryption
    Configures the encryption settings for the storage volume.
    path string
    Defines the path in the host filesystem where the storage pool is mapped.
    permissions PoolTargetPermissions
    Configures the permissions for the storage pool target.
    timestamps PoolTargetTimestamps
    Sets the timestamp attributes for the storage pool target.
    encryption PoolTargetEncryption
    Configures the encryption settings for the storage volume.
    path str
    Defines the path in the host filesystem where the storage pool is mapped.
    permissions PoolTargetPermissions
    Configures the permissions for the storage pool target.
    timestamps PoolTargetTimestamps
    Sets the timestamp attributes for the storage pool target.
    encryption Property Map
    Configures the encryption settings for the storage volume.
    path String
    Defines the path in the host filesystem where the storage pool is mapped.
    permissions Property Map
    Configures the permissions for the storage pool target.
    timestamps Property Map
    Sets the timestamp attributes for the storage pool target.

    PoolTargetEncryption, PoolTargetEncryptionArgs

    Format string
    Defines the format of the encryption for the storage volume.
    Cipher PoolTargetEncryptionCipher
    Sets the encryption cipher for the storage volume to be applied.
    Ivgen PoolTargetEncryptionIvgen
    Controls the initialization vector generation settings for the encryption.
    Secret PoolTargetEncryptionSecret
    Provides the configuration for the secret used in the encryption process.
    Format string
    Defines the format of the encryption for the storage volume.
    Cipher PoolTargetEncryptionCipher
    Sets the encryption cipher for the storage volume to be applied.
    Ivgen PoolTargetEncryptionIvgen
    Controls the initialization vector generation settings for the encryption.
    Secret PoolTargetEncryptionSecret
    Provides the configuration for the secret used in the encryption process.
    format String
    Defines the format of the encryption for the storage volume.
    cipher PoolTargetEncryptionCipher
    Sets the encryption cipher for the storage volume to be applied.
    ivgen PoolTargetEncryptionIvgen
    Controls the initialization vector generation settings for the encryption.
    secret PoolTargetEncryptionSecret
    Provides the configuration for the secret used in the encryption process.
    format string
    Defines the format of the encryption for the storage volume.
    cipher PoolTargetEncryptionCipher
    Sets the encryption cipher for the storage volume to be applied.
    ivgen PoolTargetEncryptionIvgen
    Controls the initialization vector generation settings for the encryption.
    secret PoolTargetEncryptionSecret
    Provides the configuration for the secret used in the encryption process.
    format str
    Defines the format of the encryption for the storage volume.
    cipher PoolTargetEncryptionCipher
    Sets the encryption cipher for the storage volume to be applied.
    ivgen PoolTargetEncryptionIvgen
    Controls the initialization vector generation settings for the encryption.
    secret PoolTargetEncryptionSecret
    Provides the configuration for the secret used in the encryption process.
    format String
    Defines the format of the encryption for the storage volume.
    cipher Property Map
    Sets the encryption cipher for the storage volume to be applied.
    ivgen Property Map
    Controls the initialization vector generation settings for the encryption.
    secret Property Map
    Provides the configuration for the secret used in the encryption process.

    PoolTargetEncryptionCipher, PoolTargetEncryptionCipherArgs

    Hash string
    Specifies the hash algorithm used with the encryption cipher.
    Mode string
    Defines the mode for the encryption cipher of the storage volume.
    Name string
    Sets the name of the encryption cipher for the storage volume.
    Size double
    Sets the size of the encryption cipher for the storage volume.
    Hash string
    Specifies the hash algorithm used with the encryption cipher.
    Mode string
    Defines the mode for the encryption cipher of the storage volume.
    Name string
    Sets the name of the encryption cipher for the storage volume.
    Size float64
    Sets the size of the encryption cipher for the storage volume.
    hash String
    Specifies the hash algorithm used with the encryption cipher.
    mode String
    Defines the mode for the encryption cipher of the storage volume.
    name String
    Sets the name of the encryption cipher for the storage volume.
    size Double
    Sets the size of the encryption cipher for the storage volume.
    hash string
    Specifies the hash algorithm used with the encryption cipher.
    mode string
    Defines the mode for the encryption cipher of the storage volume.
    name string
    Sets the name of the encryption cipher for the storage volume.
    size number
    Sets the size of the encryption cipher for the storage volume.
    hash str
    Specifies the hash algorithm used with the encryption cipher.
    mode str
    Defines the mode for the encryption cipher of the storage volume.
    name str
    Sets the name of the encryption cipher for the storage volume.
    size float
    Sets the size of the encryption cipher for the storage volume.
    hash String
    Specifies the hash algorithm used with the encryption cipher.
    mode String
    Defines the mode for the encryption cipher of the storage volume.
    name String
    Sets the name of the encryption cipher for the storage volume.
    size Number
    Sets the size of the encryption cipher for the storage volume.

    PoolTargetEncryptionIvgen, PoolTargetEncryptionIvgenArgs

    Hash string
    Specifies the hashing algorithm used for the initialization vector generation.
    Name string
    Sets the name of the initialization vector generator for the encryption.
    Hash string
    Specifies the hashing algorithm used for the initialization vector generation.
    Name string
    Sets the name of the initialization vector generator for the encryption.
    hash String
    Specifies the hashing algorithm used for the initialization vector generation.
    name String
    Sets the name of the initialization vector generator for the encryption.
    hash string
    Specifies the hashing algorithm used for the initialization vector generation.
    name string
    Sets the name of the initialization vector generator for the encryption.
    hash str
    Specifies the hashing algorithm used for the initialization vector generation.
    name str
    Sets the name of the initialization vector generator for the encryption.
    hash String
    Specifies the hashing algorithm used for the initialization vector generation.
    name String
    Sets the name of the initialization vector generator for the encryption.

    PoolTargetEncryptionSecret, PoolTargetEncryptionSecretArgs

    Type string
    Defines the type of the secret used for encryption purposes.
    Uuid string
    Sets the universally unique identifier (UUID) for the encryption secret.
    Type string
    Defines the type of the secret used for encryption purposes.
    Uuid string
    Sets the universally unique identifier (UUID) for the encryption secret.
    type String
    Defines the type of the secret used for encryption purposes.
    uuid String
    Sets the universally unique identifier (UUID) for the encryption secret.
    type string
    Defines the type of the secret used for encryption purposes.
    uuid string
    Sets the universally unique identifier (UUID) for the encryption secret.
    type str
    Defines the type of the secret used for encryption purposes.
    uuid str
    Sets the universally unique identifier (UUID) for the encryption secret.
    type String
    Defines the type of the secret used for encryption purposes.
    uuid String
    Sets the universally unique identifier (UUID) for the encryption secret.

    PoolTargetPermissions, PoolTargetPermissionsArgs

    Group string
    Sets the group ownership for the storage pool target permissions.
    Label string
    Configures the label associated with the target permissions for the storage pool.
    Mode string
    Defines the mode (file permissions) for the storage pool target.
    Owner string
    Specifies the owner of the permissions for the storage pool target.
    Group string
    Sets the group ownership for the storage pool target permissions.
    Label string
    Configures the label associated with the target permissions for the storage pool.
    Mode string
    Defines the mode (file permissions) for the storage pool target.
    Owner string
    Specifies the owner of the permissions for the storage pool target.
    group String
    Sets the group ownership for the storage pool target permissions.
    label String
    Configures the label associated with the target permissions for the storage pool.
    mode String
    Defines the mode (file permissions) for the storage pool target.
    owner String
    Specifies the owner of the permissions for the storage pool target.
    group string
    Sets the group ownership for the storage pool target permissions.
    label string
    Configures the label associated with the target permissions for the storage pool.
    mode string
    Defines the mode (file permissions) for the storage pool target.
    owner string
    Specifies the owner of the permissions for the storage pool target.
    group str
    Sets the group ownership for the storage pool target permissions.
    label str
    Configures the label associated with the target permissions for the storage pool.
    mode str
    Defines the mode (file permissions) for the storage pool target.
    owner str
    Specifies the owner of the permissions for the storage pool target.
    group String
    Sets the group ownership for the storage pool target permissions.
    label String
    Configures the label associated with the target permissions for the storage pool.
    mode String
    Defines the mode (file permissions) for the storage pool target.
    owner String
    Specifies the owner of the permissions for the storage pool target.

    PoolTargetTimestamps, PoolTargetTimestampsArgs

    Atime string
    Configures the last access time for the storage pool target.
    Ctime string
    Sets the last metadata change time for the storage pool target.
    Mtime string
    Specifies the last modification time for the storage pool target.
    Atime string
    Configures the last access time for the storage pool target.
    Ctime string
    Sets the last metadata change time for the storage pool target.
    Mtime string
    Specifies the last modification time for the storage pool target.
    atime String
    Configures the last access time for the storage pool target.
    ctime String
    Sets the last metadata change time for the storage pool target.
    mtime String
    Specifies the last modification time for the storage pool target.
    atime string
    Configures the last access time for the storage pool target.
    ctime string
    Sets the last metadata change time for the storage pool target.
    mtime string
    Specifies the last modification time for the storage pool target.
    atime str
    Configures the last access time for the storage pool target.
    ctime str
    Sets the last metadata change time for the storage pool target.
    mtime str
    Specifies the last modification time for the storage pool target.
    atime String
    Configures the last access time for the storage pool target.
    ctime String
    Sets the last metadata change time for the storage pool target.
    mtime String
    Specifies the last modification time for the storage pool target.

    Package Details

    Repository
    libvirt dmacvicar/terraform-provider-libvirt
    License
    Notes
    This Pulumi package is based on the libvirt Terraform Provider.
    libvirt logo
    libvirt 0.9.1 published on Monday, Dec 1, 2025 by dmacvicar
    Schema (JSON)
    dmacvicar/terraform-provider-libvirt
      Meet Neo: Your AI Platform Teammate