blockstorage

class pulumi_openstack.blockstorage.GetAvailabilityZonesV3Result(names=None, region=None, state=None, id=None)

A collection of values returned by getAvailabilityZonesV3.

names = None

The names of the availability zones, ordered alphanumerically, that match the queried state.

region = None

See Argument Reference above.

state = None

See Argument Reference above.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_openstack.blockstorage.GetSnapshotV2Result(description=None, metadata=None, most_recent=None, name=None, region=None, size=None, status=None, volume_id=None, id=None)

A collection of values returned by getSnapshotV2.

description = None

The snapshot’s description.

metadata = None

The snapshot’s metadata.

name = None

See Argument Reference above.

region = None

See Argument Reference above.

size = None

The size of the snapshot.

status = None

See Argument Reference above.

volume_id = None

See Argument Reference above.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_openstack.blockstorage.GetSnapshotV3Result(description=None, metadata=None, most_recent=None, name=None, region=None, size=None, status=None, volume_id=None, id=None)

A collection of values returned by getSnapshotV3.

description = None

The snapshot’s description.

metadata = None

The snapshot’s metadata.

name = None

See Argument Reference above.

region = None

See Argument Reference above.

size = None

The size of the snapshot.

status = None

See Argument Reference above.

volume_id = None

See Argument Reference above.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_openstack.blockstorage.Volume(resource_name, opts=None, availability_zone=None, consistency_group_id=None, description=None, enable_online_resize=None, image_id=None, metadata=None, multiattach=None, name=None, region=None, size=None, snapshot_id=None, source_replica=None, source_vol_id=None, volume_type=None, __name__=None, __opts__=None)

Manages a V3 volume resource within OpenStack.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • availability_zone (pulumi.Input[str]) – The availability zone for the volume. Changing this creates a new volume.
  • consistency_group_id (pulumi.Input[str]) – The consistency group to place the volume in.
  • description (pulumi.Input[str]) – A description of the volume. Changing this updates the volume’s description.
  • enable_online_resize (pulumi.Input[bool]) – When this option is set it allows extending attached volumes. Note: updating size of an attached volume requires Cinder support for version 3.42 and a compatible storage driver.
  • image_id (pulumi.Input[str]) – The image ID from which to create the volume. Changing this creates a new volume.
  • metadata (pulumi.Input[dict]) – Metadata key/value pairs to associate with the volume. Changing this updates the existing volume metadata.
  • multiattach (pulumi.Input[bool]) – Allow the volume to be attached to more than one Compute instance.
  • name (pulumi.Input[str]) – A unique name for the volume. Changing this updates the volume’s name.
  • region (pulumi.Input[str]) – The region in which to create the volume. If omitted, the region argument of the provider is used. Changing this creates a new volume.
  • size (pulumi.Input[float]) – The size of the volume to create (in gigabytes).
  • snapshot_id (pulumi.Input[str]) – The snapshot ID from which to create the volume. Changing this creates a new volume.
  • source_replica (pulumi.Input[str]) – The volume ID to replicate with.
  • source_vol_id (pulumi.Input[str]) – The volume ID from which to create the volume. Changing this creates a new volume.
  • volume_type (pulumi.Input[str]) – The type of volume to create. Changing this creates a new volume.
attachments = None

If a volume is attached to an instance, this attribute will display the Attachment ID, Instance ID, and the Device as the Instance sees it.

availability_zone = None

The availability zone for the volume. Changing this creates a new volume.

consistency_group_id = None

The consistency group to place the volume in.

description = None

A description of the volume. Changing this updates the volume’s description.

enable_online_resize = None

When this option is set it allows extending attached volumes. Note: updating size of an attached volume requires Cinder support for version 3.42 and a compatible storage driver.

image_id = None

The image ID from which to create the volume. Changing this creates a new volume.

metadata = None

Metadata key/value pairs to associate with the volume. Changing this updates the existing volume metadata.

multiattach = None

Allow the volume to be attached to more than one Compute instance.

name = None

A unique name for the volume. Changing this updates the volume’s name.

region = None

The region in which to create the volume. If omitted, the region argument of the provider is used. Changing this creates a new volume.

size = None

The size of the volume to create (in gigabytes).

snapshot_id = None

The snapshot ID from which to create the volume. Changing this creates a new volume.

source_replica = None

The volume ID to replicate with.

source_vol_id = None

The volume ID from which to create the volume. Changing this creates a new volume.

volume_type = None

The type of volume to create. Changing this creates a new volume.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_openstack.blockstorage.VolumeAttach(resource_name, opts=None, attach_mode=None, device=None, host_name=None, initiator=None, ip_address=None, multipath=None, os_type=None, platform=None, region=None, volume_id=None, wwnn=None, wwpns=None, __name__=None, __opts__=None)

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_volume_attach_v3 resource for that.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • attach_mode (pulumi.Input[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 (pulumi.Input[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.
  • host_name (pulumi.Input[str]) – The host to attach the volume to.
  • initiator (pulumi.Input[str]) – The iSCSI initiator string to make the connection.
  • ip_address (pulumi.Input[str]) – The IP address of the host_name above.
  • multipath (pulumi.Input[bool]) – Whether to connect to this volume via multipath.
  • os_type (pulumi.Input[str]) – The iSCSI initiator OS type.
  • platform (pulumi.Input[str]) – The iSCSI initiator platform.
  • region (pulumi.Input[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 (pulumi.Input[str]) – The ID of the Volume to attach to an Instance.
  • wwnn (pulumi.Input[str]) – A wwnn name. Used for Fibre Channel connections.
  • wwpns (pulumi.Input[list]) – An array of wwpn strings. Used for Fibre Channel connections.
attach_mode = None

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 = None

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 = None

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 = None

The storage driver that the volume is based on.

host_name = None

The host to attach the volume to.

initiator = None

The iSCSI initiator string to make the connection.

ip_address = None

The IP address of the host_name above.

mount_point_base = None

A mount point base name for shared storage.

multipath = None

Whether to connect to this volume via multipath.

os_type = None

The iSCSI initiator OS type.

platform = None

The iSCSI initiator platform.

region = None

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 = None

The ID of the Volume to attach to an Instance.

wwnn = None

A wwnn name. Used for Fibre Channel connections.

wwpns = None

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

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_openstack.blockstorage.VolumeAttachV2(resource_name, opts=None, attach_mode=None, device=None, host_name=None, initiator=None, ip_address=None, multipath=None, os_type=None, platform=None, region=None, volume_id=None, wwnn=None, wwpns=None, __name__=None, __opts__=None)

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) v2 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_volume_attach_v2 resource for that.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • attach_mode (pulumi.Input[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 (pulumi.Input[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.
  • host_name (pulumi.Input[str]) – The host to attach the volume to.
  • initiator (pulumi.Input[str]) – The iSCSI initiator string to make the connection.
  • ip_address (pulumi.Input[str]) – The IP address of the host_name above.
  • multipath (pulumi.Input[bool]) – Whether to connect to this volume via multipath.
  • os_type (pulumi.Input[str]) – The iSCSI initiator OS type.
  • platform (pulumi.Input[str]) – The iSCSI initiator platform.
  • region (pulumi.Input[str]) – The region in which to obtain the V2 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 (pulumi.Input[str]) – The ID of the Volume to attach to an Instance.
  • wwnn (pulumi.Input[str]) – A wwnn name. Used for Fibre Channel connections.
  • wwpns (pulumi.Input[list]) – An array of wwpn strings. Used for Fibre Channel connections.
attach_mode = None

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 = None

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 = None

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 = None

The storage driver that the volume is based on.

host_name = None

The host to attach the volume to.

initiator = None

The iSCSI initiator string to make the connection.

ip_address = None

The IP address of the host_name above.

mount_point_base = None

A mount point base name for shared storage.

multipath = None

Whether to connect to this volume via multipath.

os_type = None

The iSCSI initiator OS type.

platform = None

The iSCSI initiator platform.

region = None

The region in which to obtain the V2 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 = None

The ID of the Volume to attach to an Instance.

wwnn = None

A wwnn name. Used for Fibre Channel connections.

wwpns = None

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

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_openstack.blockstorage.VolumeV1(resource_name, opts=None, availability_zone=None, description=None, image_id=None, metadata=None, name=None, region=None, size=None, snapshot_id=None, source_vol_id=None, volume_type=None, __name__=None, __opts__=None)

Manages a V1 volume resource within OpenStack.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • availability_zone (pulumi.Input[str]) – The availability zone for the volume. Changing this creates a new volume.
  • description (pulumi.Input[str]) – A description of the volume. Changing this updates the volume’s description.
  • image_id (pulumi.Input[str]) – The image ID from which to create the volume. Changing this creates a new volume.
  • metadata (pulumi.Input[dict]) – Metadata key/value pairs to associate with the volume. Changing this updates the existing volume metadata.
  • name (pulumi.Input[str]) – A unique name for the volume. Changing this updates the volume’s name.
  • region (pulumi.Input[str]) – The region in which to create the volume. If omitted, the region argument of the provider is used. Changing this creates a new volume.
  • size (pulumi.Input[float]) – The size of the volume to create (in gigabytes). Changing this creates a new volume.
  • snapshot_id (pulumi.Input[str]) – The snapshot ID from which to create the volume. Changing this creates a new volume.
  • source_vol_id (pulumi.Input[str]) – The volume ID from which to create the volume. Changing this creates a new volume.
  • volume_type (pulumi.Input[str]) – The type of volume to create. Changing this creates a new volume.
attachments = None

If a volume is attached to an instance, this attribute will display the Attachment ID, Instance ID, and the Device as the Instance sees it.

availability_zone = None

The availability zone for the volume. Changing this creates a new volume.

description = None

A description of the volume. Changing this updates the volume’s description.

image_id = None

The image ID from which to create the volume. Changing this creates a new volume.

metadata = None

Metadata key/value pairs to associate with the volume. Changing this updates the existing volume metadata.

name = None

A unique name for the volume. Changing this updates the volume’s name.

region = None

The region in which to create the volume. If omitted, the region argument of the provider is used. Changing this creates a new volume.

size = None

The size of the volume to create (in gigabytes). Changing this creates a new volume.

snapshot_id = None

The snapshot ID from which to create the volume. Changing this creates a new volume.

source_vol_id = None

The volume ID from which to create the volume. Changing this creates a new volume.

volume_type = None

The type of volume to create. Changing this creates a new volume.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_openstack.blockstorage.VolumeV2(resource_name, opts=None, availability_zone=None, consistency_group_id=None, description=None, image_id=None, metadata=None, name=None, region=None, size=None, snapshot_id=None, source_replica=None, source_vol_id=None, volume_type=None, __name__=None, __opts__=None)

Manages a V2 volume resource within OpenStack.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • availability_zone (pulumi.Input[str]) – The availability zone for the volume. Changing this creates a new volume.
  • consistency_group_id (pulumi.Input[str]) – The consistency group to place the volume in.
  • description (pulumi.Input[str]) – A description of the volume. Changing this updates the volume’s description.
  • image_id (pulumi.Input[str]) – The image ID from which to create the volume. Changing this creates a new volume.
  • metadata (pulumi.Input[dict]) – Metadata key/value pairs to associate with the volume. Changing this updates the existing volume metadata.
  • name (pulumi.Input[str]) – A unique name for the volume. Changing this updates the volume’s name.
  • region (pulumi.Input[str]) – The region in which to create the volume. If omitted, the region argument of the provider is used. Changing this creates a new volume.
  • size (pulumi.Input[float]) – The size of the volume to create (in gigabytes). Changing this creates a new volume.
  • snapshot_id (pulumi.Input[str]) – The snapshot ID from which to create the volume. Changing this creates a new volume.
  • source_replica (pulumi.Input[str]) – The volume ID to replicate with.
  • source_vol_id (pulumi.Input[str]) – The volume ID from which to create the volume. Changing this creates a new volume.
  • volume_type (pulumi.Input[str]) – The type of volume to create. Changing this creates a new volume.
attachments = None

If a volume is attached to an instance, this attribute will display the Attachment ID, Instance ID, and the Device as the Instance sees it.

availability_zone = None

The availability zone for the volume. Changing this creates a new volume.

consistency_group_id = None

The consistency group to place the volume in.

description = None

A description of the volume. Changing this updates the volume’s description.

image_id = None

The image ID from which to create the volume. Changing this creates a new volume.

metadata = None

Metadata key/value pairs to associate with the volume. Changing this updates the existing volume metadata.

name = None

A unique name for the volume. Changing this updates the volume’s name.

region = None

The region in which to create the volume. If omitted, the region argument of the provider is used. Changing this creates a new volume.

size = None

The size of the volume to create (in gigabytes). Changing this creates a new volume.

snapshot_id = None

The snapshot ID from which to create the volume. Changing this creates a new volume.

source_replica = None

The volume ID to replicate with.

source_vol_id = None

The volume ID from which to create the volume. Changing this creates a new volume.

volume_type = None

The type of volume to create. Changing this creates a new volume.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
pulumi_openstack.blockstorage.get_availability_zones_v3(region=None, state=None, opts=None)

Use this data source to get a list of Block Storage availability zones from OpenStack

pulumi_openstack.blockstorage.get_snapshot_v2(most_recent=None, name=None, region=None, status=None, volume_id=None, opts=None)

Use this data source to get information about an existing snapshot.

pulumi_openstack.blockstorage.get_snapshot_v3(most_recent=None, name=None, region=None, status=None, volume_id=None, opts=None)

Use this data source to get information about an existing snapshot.