Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Openstack Provider
  3. API Docs
  4. blockstorage
  5. VolumeAttach
OpenStack v5.0.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-openstack

openstack.blockstorage.VolumeAttach

Explore with Pulumi AI

openstack logo
OpenStack v5.0.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-openstack

    Note: This resource usually requires admin privileges.

    Note: This resource does not actually attach a volume to an instance. Please use the openstack.compute.VolumeAttach resource for that.

    Note: All arguments including the data computed attribute will be stored in the raw state as plain-text. Read more about sensitive data in state.

    Creates a general purpose attachment connection to a Block Storage volume using the OpenStack Block Storage (Cinder) v3 API.

    Depending on your Block Storage service configuration, this resource can assist in attaching a volume to a non-OpenStack resource such as a bare-metal server or a remote virtual machine in a different cloud provider.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";

const volume1 = new openstack.blockstorage.Volume("volume_1", {
    name: "volume_1",
    size: 1,
});
const va1 = new openstack.blockstorage.VolumeAttach("va_1", {
    volumeId: volume1.id,
    device: "auto",
    hostName: "devstack",
    ipAddress: "192.168.255.10",
    initiator: "iqn.1993-08.org.debian:01:e9861fb1859",
    osType: "linux2",
    platform: "x86_64",
});

    import pulumi
import pulumi_openstack as openstack

volume1 = openstack.blockstorage.Volume("volume_1",
    name="volume_1",
    size=1)
va1 = openstack.blockstorage.VolumeAttach("va_1",
    volume_id=volume1.id,
    device="auto",
    host_name="devstack",
    ip_address="192.168.255.10",
    initiator="iqn.1993-08.org.debian:01:e9861fb1859",
    os_type="linux2",
    platform="x86_64")

    package main

import (
	"github.com/pulumi/pulumi-openstack/sdk/v5/go/openstack/blockstorage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		volume1, err := blockstorage.NewVolume(ctx, "volume_1", &blockstorage.VolumeArgs{
			Name: pulumi.String("volume_1"),
			Size: pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		_, err = blockstorage.NewVolumeAttach(ctx, "va_1", &blockstorage.VolumeAttachArgs{
			VolumeId:  volume1.ID(),
			Device:    pulumi.String("auto"),
			HostName:  pulumi.String("devstack"),
			IpAddress: pulumi.String("192.168.255.10"),
			Initiator: pulumi.String("iqn.1993-08.org.debian:01:e9861fb1859"),
			OsType:    pulumi.String("linux2"),
			Platform:  pulumi.String("x86_64"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using OpenStack = Pulumi.OpenStack;

return await Deployment.RunAsync(() => 
{
    var volume1 = new OpenStack.BlockStorage.Volume("volume_1", new()
    {
        Name = "volume_1",
        Size = 1,
    });

    var va1 = new OpenStack.BlockStorage.VolumeAttach("va_1", new()
    {
        VolumeId = volume1.Id,
        Device = "auto",
        HostName = "devstack",
        IpAddress = "192.168.255.10",
        Initiator = "iqn.1993-08.org.debian:01:e9861fb1859",
        OsType = "linux2",
        Platform = "x86_64",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.openstack.blockstorage.Volume;
import com.pulumi.openstack.blockstorage.VolumeArgs;
import com.pulumi.openstack.blockstorage.VolumeAttach;
import com.pulumi.openstack.blockstorage.VolumeAttachArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var volume1 = new Volume("volume1", VolumeArgs.builder()
            .name("volume_1")
            .size(1)
            .build());

        var va1 = new VolumeAttach("va1", VolumeAttachArgs.builder()
            .volumeId(volume1.id())
            .device("auto")
            .hostName("devstack")
            .ipAddress("192.168.255.10")
            .initiator("iqn.1993-08.org.debian:01:e9861fb1859")
            .osType("linux2")
            .platform("x86_64")
            .build());

    }
}

    resources:
  volume1:
    type: openstack:blockstorage:Volume
    name: volume_1
    properties:
      name: volume_1
      size: 1
  va1:
    type: openstack:blockstorage:VolumeAttach
    name: va_1
    properties:
      volumeId: ${volume1.id}
      device: auto
      hostName: devstack
      ipAddress: 192.168.255.10
      initiator: iqn.1993-08.org.debian:01:e9861fb1859
      osType: linux2
      platform: x86_64

    Volume Connection Data

    Upon creation of this resource, a data exported attribute will be available. This attribute is a set of key/value pairs that contains the information required to complete the block storage connection.

    As an example, creating an iSCSI-based volume will return the following:

    data.access_mode = rw
data.auth_method = CHAP
data.auth_password = xUhbGKQ8QCwKmHQ2
data.auth_username = Sphn5X4EoyFUUMYVYSA4
data.target_iqn = iqn.2010-10.org.openstack:volume-2d87ed25-c312-4f42-be1d-3b36b014561d
data.target_portal = 192.168.255.10:3260
data.volume_id = 2d87ed25-c312-4f42-be1d-3b36b014561d

    This information can then be fed into a provisioner or a template shell script, where the final result would look something like:

    iscsiadm -m node -T ${self.data.target_iqn} -p ${self.data.target_portal} --interface default --op new
iscsiadm -m node -T ${self.data.target_iqn} -p ${self.data.target_portal} --op update -n node.session.auth.authmethod -v ${self.data.auth_method}
iscsiadm -m node -T ${self.data.target_iqn} -p ${self.data.target_portal} --op update -n node.session.auth.username -v ${self.data.auth_username}
iscsiadm -m node -T ${self.data.target_iqn} -p ${self.data.target_portal} --op update -n node.session.auth.password -v ${self.data.auth_password}
iscsiadm -m node -T ${self.data.target_iqn} -p ${self.data.target_portal} --login
iscsiadm -m node -T ${self.data.target_iqn} -p ${self.data.target_portal} --op update -n node.startup -v automatic
iscsiadm -m node -T ${self.data.target_iqn} -p ${self.data.target_portal} --rescan

    The contents of data will vary from each Block Storage service. You must have a good understanding of how the service is configured and how to make the appropriate final connection. However, if used correctly, this has the flexibility to be able to attach OpenStack Block Storage volumes to non-OpenStack resources.

    Create VolumeAttach Resource

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

    Constructor syntax

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

@overload
def VolumeAttach(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 host_name: Optional[str] = None,
                 volume_id: Optional[str] = None,
                 attach_mode: Optional[str] = None,
                 device: Optional[str] = None,
                 initiator: Optional[str] = None,
                 ip_address: Optional[str] = None,
                 multipath: Optional[bool] = None,
                 os_type: Optional[str] = None,
                 platform: Optional[str] = None,
                 region: Optional[str] = None,
                 wwnn: Optional[str] = None,
                 wwpns: Optional[Sequence[str]] = None)
    func NewVolumeAttach(ctx *Context, name string, args VolumeAttachArgs, opts ...ResourceOption) (*VolumeAttach, error)
    public VolumeAttach(string name, VolumeAttachArgs args, CustomResourceOptions? opts = null)
    public VolumeAttach(String name, VolumeAttachArgs args)
public VolumeAttach(String name, VolumeAttachArgs args, CustomResourceOptions options)

    type: openstack:blockstorage:VolumeAttach
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 VolumeAttachArgs
    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 VolumeAttachArgs
    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 VolumeAttachArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VolumeAttachArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VolumeAttachArgs
    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 volumeAttachResource = new OpenStack.BlockStorage.VolumeAttach("volumeAttachResource", new()
{
    HostName = "string",
    VolumeId = "string",
    AttachMode = "string",
    Device = "string",
    Initiator = "string",
    IpAddress = "string",
    Multipath = false,
    OsType = "string",
    Platform = "string",
    Region = "string",
    Wwnn = "string",
    Wwpns = new[]
    {
        "string",
    },
});

    example, err := blockstorage.NewVolumeAttach(ctx, "volumeAttachResource", &blockstorage.VolumeAttachArgs{
	HostName:   pulumi.String("string"),
	VolumeId:   pulumi.String("string"),
	AttachMode: pulumi.String("string"),
	Device:     pulumi.String("string"),
	Initiator:  pulumi.String("string"),
	IpAddress:  pulumi.String("string"),
	Multipath:  pulumi.Bool(false),
	OsType:     pulumi.String("string"),
	Platform:   pulumi.String("string"),
	Region:     pulumi.String("string"),
	Wwnn:       pulumi.String("string"),
	Wwpns: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var volumeAttachResource = new VolumeAttach("volumeAttachResource", VolumeAttachArgs.builder()
    .hostName("string")
    .volumeId("string")
    .attachMode("string")
    .device("string")
    .initiator("string")
    .ipAddress("string")
    .multipath(false)
    .osType("string")
    .platform("string")
    .region("string")
    .wwnn("string")
    .wwpns("string")
    .build());

    volume_attach_resource = openstack.blockstorage.VolumeAttach("volumeAttachResource",
    host_name="string",
    volume_id="string",
    attach_mode="string",
    device="string",
    initiator="string",
    ip_address="string",
    multipath=False,
    os_type="string",
    platform="string",
    region="string",
    wwnn="string",
    wwpns=["string"])

    const volumeAttachResource = new openstack.blockstorage.VolumeAttach("volumeAttachResource", {
    hostName: "string",
    volumeId: "string",
    attachMode: "string",
    device: "string",
    initiator: "string",
    ipAddress: "string",
    multipath: false,
    osType: "string",
    platform: "string",
    region: "string",
    wwnn: "string",
    wwpns: ["string"],
});

    type: openstack:blockstorage:VolumeAttach
properties:
    attachMode: string
    device: string
    hostName: string
    initiator: string
    ipAddress: string
    multipath: false
    osType: string
    platform: string
    region: string
    volumeId: string
    wwnn: string
    wwpns:
        - string

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

    HostName string
    The host to attach the volume to.
    VolumeId string
    The ID of the Volume to attach to an Instance.
    AttachMode string
    Specify whether to attach the volume as Read-Only (ro) or Read-Write (rw). Only values of ro and rw are accepted. If left unspecified, the Block Storage API will apply a default of rw.
    Device string
    The device to tell the Block Storage service this volume will be attached as. This is purely for informational purposes. You can specify auto or a device such as /dev/vdc.
    Initiator string
    The iSCSI initiator string to make the connection.
    IpAddress string
    The IP address of the host_name above.
    Multipath bool
    Whether to connect to this volume via multipath.
    OsType string
    The iSCSI initiator OS type.
    Platform string
    The iSCSI initiator platform.
    Region string
    The region in which to obtain the V3 Block Storage client. A Block Storage client is needed to create a volume attachment. If omitted, the region argument of the provider is used. Changing this creates a new volume attachment.
    Wwnn string
    A wwnn name. Used for Fibre Channel connections.
    Wwpns List<string>
    An array of wwpn strings. Used for Fibre Channel connections.
    HostName string
    The host to attach the volume to.
    VolumeId string
    The ID of the Volume to attach to an Instance.
    AttachMode string
    Specify whether to attach the volume as Read-Only (ro) or Read-Write (rw). Only values of ro and rw are accepted. If left unspecified, the Block Storage API will apply a default of rw.
    Device string
    The device to tell the Block Storage service this volume will be attached as. This is purely for informational purposes. You can specify auto or a device such as /dev/vdc.
    Initiator string
    The iSCSI initiator string to make the connection.
    IpAddress string
    The IP address of the host_name above.
    Multipath bool
    Whether to connect to this volume via multipath.
    OsType string
    The iSCSI initiator OS type.
    Platform string
    The iSCSI initiator platform.
    Region string
    The region in which to obtain the V3 Block Storage client. A Block Storage client is needed to create a volume attachment. If omitted, the region argument of the provider is used. Changing this creates a new volume attachment.
    Wwnn string
    A wwnn name. Used for Fibre Channel connections.
    Wwpns []string
    An array of wwpn strings. Used for Fibre Channel connections.
    hostName String
    The host to attach the volume to.
    volumeId String
    The ID of the Volume to attach to an Instance.
    attachMode String
    Specify whether to attach the volume as Read-Only (ro) or Read-Write (rw). Only values of ro and rw are accepted. If left unspecified, the Block Storage API will apply a default of rw.
    device String
    The device to tell the Block Storage service this volume will be attached as. This is purely for informational purposes. You can specify auto or a device such as /dev/vdc.
    initiator String
    The iSCSI initiator string to make the connection.
    ipAddress String
    The IP address of the host_name above.
    multipath Boolean
    Whether to connect to this volume via multipath.
    osType String
    The iSCSI initiator OS type.
    platform String
    The iSCSI initiator platform.
    region String
    The region in which to obtain the V3 Block Storage client. A Block Storage client is needed to create a volume attachment. If omitted, the region argument of the provider is used. Changing this creates a new volume attachment.
    wwnn String
    A wwnn name. Used for Fibre Channel connections.
    wwpns List<String>
    An array of wwpn strings. Used for Fibre Channel connections.
    hostName string
    The host to attach the volume to.
    volumeId string
    The ID of the Volume to attach to an Instance.
    attachMode string
    Specify whether to attach the volume as Read-Only (ro) or Read-Write (rw). Only values of ro and rw are accepted. If left unspecified, the Block Storage API will apply a default of rw.
    device string
    The device to tell the Block Storage service this volume will be attached as. This is purely for informational purposes. You can specify auto or a device such as /dev/vdc.
    initiator string
    The iSCSI initiator string to make the connection.
    ipAddress string
    The IP address of the host_name above.
    multipath boolean
    Whether to connect to this volume via multipath.
    osType string
    The iSCSI initiator OS type.
    platform string
    The iSCSI initiator platform.
    region string
    The region in which to obtain the V3 Block Storage client. A Block Storage client is needed to create a volume attachment. If omitted, the region argument of the provider is used. Changing this creates a new volume attachment.
    wwnn string
    A wwnn name. Used for Fibre Channel connections.
    wwpns string[]
    An array of wwpn strings. Used for Fibre Channel connections.
    host_name str
    The host to attach the volume to.
    volume_id str
    The ID of the Volume to attach to an Instance.
    attach_mode str
    Specify whether to attach the volume as Read-Only (ro) or Read-Write (rw). Only values of ro and rw are accepted. If left unspecified, the Block Storage API will apply a default of rw.
    device str
    The device to tell the Block Storage service this volume will be attached as. This is purely for informational purposes. You can specify auto or a device such as /dev/vdc.
    initiator str
    The iSCSI initiator string to make the connection.
    ip_address str
    The IP address of the host_name above.
    multipath bool
    Whether to connect to this volume via multipath.
    os_type str
    The iSCSI initiator OS type.
    platform str
    The iSCSI initiator platform.
    region str
    The region in which to obtain the V3 Block Storage client. A Block Storage client is needed to create a volume attachment. If omitted, the region argument of the provider is used. Changing this creates a new volume attachment.
    wwnn str
    A wwnn name. Used for Fibre Channel connections.
    wwpns Sequence[str]
    An array of wwpn strings. Used for Fibre Channel connections.
    hostName String
    The host to attach the volume to.
    volumeId String
    The ID of the Volume to attach to an Instance.
    attachMode String
    Specify whether to attach the volume as Read-Only (ro) or Read-Write (rw). Only values of ro and rw are accepted. If left unspecified, the Block Storage API will apply a default of rw.
    device String
    The device to tell the Block Storage service this volume will be attached as. This is purely for informational purposes. You can specify auto or a device such as /dev/vdc.
    initiator String
    The iSCSI initiator string to make the connection.
    ipAddress String
    The IP address of the host_name above.
    multipath Boolean
    Whether to connect to this volume via multipath.
    osType String
    The iSCSI initiator OS type.
    platform String
    The iSCSI initiator platform.
    region String
    The region in which to obtain the V3 Block Storage client. A Block Storage client is needed to create a volume attachment. If omitted, the region argument of the provider is used. Changing this creates a new volume attachment.
    wwnn String
    A wwnn name. Used for Fibre Channel connections.
    wwpns List<String>
    An array of wwpn strings. Used for Fibre Channel connections.

    Outputs

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

    Data Dictionary<string, string>
    This is a map of key/value pairs that contain the connection information. You will want to pass this information to a provisioner script to finalize the connection. See below for more information.
    DriverVolumeType string
    The storage driver that the volume is based on.
    Id string
    The provider-assigned unique ID for this managed resource.
    MountPointBase string
    A mount point base name for shared storage.
    Data map[string]string
    This is a map of key/value pairs that contain the connection information. You will want to pass this information to a provisioner script to finalize the connection. See below for more information.
    DriverVolumeType string
    The storage driver that the volume is based on.
    Id string
    The provider-assigned unique ID for this managed resource.
    MountPointBase string
    A mount point base name for shared storage.
    data Map<String,String>
    This is a map of key/value pairs that contain the connection information. You will want to pass this information to a provisioner script to finalize the connection. See below for more information.
    driverVolumeType String
    The storage driver that the volume is based on.
    id String
    The provider-assigned unique ID for this managed resource.
    mountPointBase String
    A mount point base name for shared storage.
    data {[key: string]: string}
    This is a map of key/value pairs that contain the connection information. You will want to pass this information to a provisioner script to finalize the connection. See below for more information.
    driverVolumeType string
    The storage driver that the volume is based on.
    id string
    The provider-assigned unique ID for this managed resource.
    mountPointBase string
    A mount point base name for shared storage.
    data Mapping[str, str]
    This is a map of key/value pairs that contain the connection information. You will want to pass this information to a provisioner script to finalize the connection. See below for more information.
    driver_volume_type str
    The storage driver that the volume is based on.
    id str
    The provider-assigned unique ID for this managed resource.
    mount_point_base str
    A mount point base name for shared storage.
    data Map<String>
    This is a map of key/value pairs that contain the connection information. You will want to pass this information to a provisioner script to finalize the connection. See below for more information.
    driverVolumeType String
    The storage driver that the volume is based on.
    id String
    The provider-assigned unique ID for this managed resource.
    mountPointBase String
    A mount point base name for shared storage.

    Look up Existing VolumeAttach Resource

    Get an existing VolumeAttach 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?: VolumeAttachState, opts?: CustomResourceOptions): VolumeAttach
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        attach_mode: Optional[str] = None,
        data: Optional[Mapping[str, str]] = None,
        device: Optional[str] = None,
        driver_volume_type: Optional[str] = None,
        host_name: Optional[str] = None,
        initiator: Optional[str] = None,
        ip_address: Optional[str] = None,
        mount_point_base: Optional[str] = None,
        multipath: Optional[bool] = None,
        os_type: Optional[str] = None,
        platform: Optional[str] = None,
        region: Optional[str] = None,
        volume_id: Optional[str] = None,
        wwnn: Optional[str] = None,
        wwpns: Optional[Sequence[str]] = None) -> VolumeAttach
    func GetVolumeAttach(ctx *Context, name string, id IDInput, state *VolumeAttachState, opts ...ResourceOption) (*VolumeAttach, error)
    public static VolumeAttach Get(string name, Input<string> id, VolumeAttachState? state, CustomResourceOptions? opts = null)
    public static VolumeAttach get(String name, Output<String> id, VolumeAttachState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AttachMode string
    Specify whether to attach the volume as Read-Only (ro) or Read-Write (rw). Only values of ro and rw are accepted. If left unspecified, the Block Storage API will apply a default of rw.
    Data Dictionary<string, string>
    This is a map of key/value pairs that contain the connection information. You will want to pass this information to a provisioner script to finalize the connection. See below for more information.
    Device string
    The device to tell the Block Storage service this volume will be attached as. This is purely for informational purposes. You can specify auto or a device such as /dev/vdc.
    DriverVolumeType string
    The storage driver that the volume is based on.
    HostName string
    The host to attach the volume to.
    Initiator string
    The iSCSI initiator string to make the connection.
    IpAddress string
    The IP address of the host_name above.
    MountPointBase string
    A mount point base name for shared storage.
    Multipath bool
    Whether to connect to this volume via multipath.
    OsType string
    The iSCSI initiator OS type.
    Platform string
    The iSCSI initiator platform.
    Region string
    The region in which to obtain the V3 Block Storage client. A Block Storage client is needed to create a volume attachment. If omitted, the region argument of the provider is used. Changing this creates a new volume attachment.
    VolumeId string
    The ID of the Volume to attach to an Instance.
    Wwnn string
    A wwnn name. Used for Fibre Channel connections.
    Wwpns List<string>
    An array of wwpn strings. Used for Fibre Channel connections.
    AttachMode string
    Specify whether to attach the volume as Read-Only (ro) or Read-Write (rw). Only values of ro and rw are accepted. If left unspecified, the Block Storage API will apply a default of rw.
    Data map[string]string
    This is a map of key/value pairs that contain the connection information. You will want to pass this information to a provisioner script to finalize the connection. See below for more information.
    Device string
    The device to tell the Block Storage service this volume will be attached as. This is purely for informational purposes. You can specify auto or a device such as /dev/vdc.
    DriverVolumeType string
    The storage driver that the volume is based on.
    HostName string
    The host to attach the volume to.
    Initiator string
    The iSCSI initiator string to make the connection.
    IpAddress string
    The IP address of the host_name above.
    MountPointBase string
    A mount point base name for shared storage.
    Multipath bool
    Whether to connect to this volume via multipath.
    OsType string
    The iSCSI initiator OS type.
    Platform string
    The iSCSI initiator platform.
    Region string
    The region in which to obtain the V3 Block Storage client. A Block Storage client is needed to create a volume attachment. If omitted, the region argument of the provider is used. Changing this creates a new volume attachment.
    VolumeId string
    The ID of the Volume to attach to an Instance.
    Wwnn string
    A wwnn name. Used for Fibre Channel connections.
    Wwpns []string
    An array of wwpn strings. Used for Fibre Channel connections.
    attachMode String
    Specify whether to attach the volume as Read-Only (ro) or Read-Write (rw). Only values of ro and rw are accepted. If left unspecified, the Block Storage API will apply a default of rw.
    data Map<String,String>
    This is a map of key/value pairs that contain the connection information. You will want to pass this information to a provisioner script to finalize the connection. See below for more information.
    device String
    The device to tell the Block Storage service this volume will be attached as. This is purely for informational purposes. You can specify auto or a device such as /dev/vdc.
    driverVolumeType String
    The storage driver that the volume is based on.
    hostName String
    The host to attach the volume to.
    initiator String
    The iSCSI initiator string to make the connection.
    ipAddress String
    The IP address of the host_name above.
    mountPointBase String
    A mount point base name for shared storage.
    multipath Boolean
    Whether to connect to this volume via multipath.
    osType String
    The iSCSI initiator OS type.
    platform String
    The iSCSI initiator platform.
    region String
    The region in which to obtain the V3 Block Storage client. A Block Storage client is needed to create a volume attachment. If omitted, the region argument of the provider is used. Changing this creates a new volume attachment.
    volumeId String
    The ID of the Volume to attach to an Instance.
    wwnn String
    A wwnn name. Used for Fibre Channel connections.
    wwpns List<String>
    An array of wwpn strings. Used for Fibre Channel connections.
    attachMode string
    Specify whether to attach the volume as Read-Only (ro) or Read-Write (rw). Only values of ro and rw are accepted. If left unspecified, the Block Storage API will apply a default of rw.
    data {[key: string]: string}
    This is a map of key/value pairs that contain the connection information. You will want to pass this information to a provisioner script to finalize the connection. See below for more information.
    device string
    The device to tell the Block Storage service this volume will be attached as. This is purely for informational purposes. You can specify auto or a device such as /dev/vdc.
    driverVolumeType string
    The storage driver that the volume is based on.
    hostName string
    The host to attach the volume to.
    initiator string
    The iSCSI initiator string to make the connection.
    ipAddress string
    The IP address of the host_name above.
    mountPointBase string
    A mount point base name for shared storage.
    multipath boolean
    Whether to connect to this volume via multipath.
    osType string
    The iSCSI initiator OS type.
    platform string
    The iSCSI initiator platform.
    region string
    The region in which to obtain the V3 Block Storage client. A Block Storage client is needed to create a volume attachment. If omitted, the region argument of the provider is used. Changing this creates a new volume attachment.
    volumeId string
    The ID of the Volume to attach to an Instance.
    wwnn string
    A wwnn name. Used for Fibre Channel connections.
    wwpns string[]
    An array of wwpn strings. Used for Fibre Channel connections.
    attach_mode str
    Specify whether to attach the volume as Read-Only (ro) or Read-Write (rw). Only values of ro and rw are accepted. If left unspecified, the Block Storage API will apply a default of rw.
    data Mapping[str, str]
    This is a map of key/value pairs that contain the connection information. You will want to pass this information to a provisioner script to finalize the connection. See below for more information.
    device str
    The device to tell the Block Storage service this volume will be attached as. This is purely for informational purposes. You can specify auto or a device such as /dev/vdc.
    driver_volume_type str
    The storage driver that the volume is based on.
    host_name str
    The host to attach the volume to.
    initiator str
    The iSCSI initiator string to make the connection.
    ip_address str
    The IP address of the host_name above.
    mount_point_base str
    A mount point base name for shared storage.
    multipath bool
    Whether to connect to this volume via multipath.
    os_type str
    The iSCSI initiator OS type.
    platform str
    The iSCSI initiator platform.
    region str
    The region in which to obtain the V3 Block Storage client. A Block Storage client is needed to create a volume attachment. If omitted, the region argument of the provider is used. Changing this creates a new volume attachment.
    volume_id str
    The ID of the Volume to attach to an Instance.
    wwnn str
    A wwnn name. Used for Fibre Channel connections.
    wwpns Sequence[str]
    An array of wwpn strings. Used for Fibre Channel connections.
    attachMode String
    Specify whether to attach the volume as Read-Only (ro) or Read-Write (rw). Only values of ro and rw are accepted. If left unspecified, the Block Storage API will apply a default of rw.
    data Map<String>
    This is a map of key/value pairs that contain the connection information. You will want to pass this information to a provisioner script to finalize the connection. See below for more information.
    device String
    The device to tell the Block Storage service this volume will be attached as. This is purely for informational purposes. You can specify auto or a device such as /dev/vdc.
    driverVolumeType String
    The storage driver that the volume is based on.
    hostName String
    The host to attach the volume to.
    initiator String
    The iSCSI initiator string to make the connection.
    ipAddress String
    The IP address of the host_name above.
    mountPointBase String
    A mount point base name for shared storage.
    multipath Boolean
    Whether to connect to this volume via multipath.
    osType String
    The iSCSI initiator OS type.
    platform String
    The iSCSI initiator platform.
    region String
    The region in which to obtain the V3 Block Storage client. A Block Storage client is needed to create a volume attachment. If omitted, the region argument of the provider is used. Changing this creates a new volume attachment.
    volumeId String
    The ID of the Volume to attach to an Instance.
    wwnn String
    A wwnn name. Used for Fibre Channel connections.
    wwpns List<String>
    An array of wwpn strings. Used for Fibre Channel connections.

    Import

    It is not possible to import this resource.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    OpenStack pulumi/pulumi-openstack
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the openstack Terraform Provider.
    openstack logo
    OpenStack v5.0.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-openstack