Class VolumeAttach

This resource is experimental and may be removed in the future! Feedback is requested if you find this resource useful or if you find any problems with it.

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.

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

Example Usage

using Pulumi;
using OpenStack = Pulumi.OpenStack;

class MyStack : Stack
{
public MyStack()
{
    var volume1 = new OpenStack.BlockStorage.Volume(&quot;volume1&quot;, new OpenStack.BlockStorage.VolumeArgs
    {
        Size = 1,
    });
    var va1 = new OpenStack.BlockStorage.VolumeAttach(&quot;va1&quot;, new OpenStack.BlockStorage.VolumeAttachArgs
    {
        Device = &quot;auto&quot;,
        HostName = &quot;devstack&quot;,
        Initiator = &quot;iqn.1993-08.org.debian:01:e9861fb1859&quot;,
        IpAddress = &quot;192.168.255.10&quot;,
        OsType = &quot;linux2&quot;,
        Platform = &quot;x86_64&quot;,
        VolumeId = volume1.Id,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

VolumeAttach

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.OpenStack.BlockStorage

Assembly: Pulumi.OpenStack.dll

Syntax

public class VolumeAttach : CustomResource

Constructors

View Source

VolumeAttach(String, VolumeAttachArgs, CustomResourceOptions)

Create a VolumeAttach resource with the given unique name, arguments, and options.

Declaration

public VolumeAttach(string name, VolumeAttachArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
VolumeAttachArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

View Source

AttachMode

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.

Declaration

public Output<string> AttachMode { get; }

Property Value

Type	Description
Output<System.String>

View Source

Data

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.

Declaration

public Output<ImmutableDictionary<string, object>> Data { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

View Source

Device

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.

Declaration

public Output<string> Device { get; }

Property Value

Type	Description
Output<System.String>

View Source

DriverVolumeType

The storage driver that the volume is based on.

Declaration

public Output<string> DriverVolumeType { get; }

Property Value

Type	Description
Output<System.String>

View Source

HostName

The host to attach the volume to.

Declaration

public Output<string> HostName { get; }

Property Value

Type	Description
Output<System.String>

View Source

Initiator

The iSCSI initiator string to make the connection.

Declaration

public Output<string> Initiator { get; }

Property Value

Type	Description
Output<System.String>

View Source

IpAddress

The IP address of the host_name above.

Declaration

public Output<string> IpAddress { get; }

Property Value

Type	Description
Output<System.String>

View Source

MountPointBase

A mount point base name for shared storage.

Declaration

public Output<string> MountPointBase { get; }

Property Value

Type	Description
Output<System.String>

View Source

Multipath

Whether to connect to this volume via multipath.

Declaration

public Output<bool?> Multipath { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

View Source

OsType

The iSCSI initiator OS type.

Declaration

public Output<string> OsType { get; }

Property Value

Type	Description
Output<System.String>

View Source

Platform

The iSCSI initiator platform.

Declaration

public Output<string> Platform { get; }

Property Value

Type	Description
Output<System.String>

View Source

Region

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.

Declaration

public Output<string> Region { get; }

Property Value

Type	Description
Output<System.String>

View Source

VolumeId

The ID of the Volume to attach to an Instance.

Declaration

public Output<string> VolumeId { get; }

Property Value

Type	Description
Output<System.String>

View Source

Wwnn

A wwnn name. Used for Fibre Channel connections.

Declaration

public Output<string> Wwnn { get; }

Property Value

Type	Description
Output<System.String>

View Source

Wwpns

An array of wwpn strings. Used for Fibre Channel connections.

Declaration

public Output<ImmutableArray<string>> Wwpns { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

Methods

View Source

Get(String, Input<String>, VolumeAttachState, CustomResourceOptions)

Get an existing VolumeAttach resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static VolumeAttach Get(string name, Input<string> id, VolumeAttachState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
VolumeAttachState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
VolumeAttach