This page documents the language specification for the openstack package. If you're looking for help working with the inputs, outputs, or functions of openstack resources in a Pulumi program, please see the resource documentation for examples and API reference.

sharedfilesystem¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-openstack repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-openstack repo.

class pulumi_openstack.sharedfilesystem.AwaitableGetAvailbilityZonesResult(id=None, names=None, region=None)¶

class pulumi_openstack.sharedfilesystem.AwaitableGetShareNetworkResult(cidr=None, description=None, id=None, ip_version=None, name=None, network_type=None, neutron_net_id=None, neutron_subnet_id=None, project_id=None, region=None, security_service_id=None, security_service_ids=None, segmentation_id=None)¶

class pulumi_openstack.sharedfilesystem.AwaitableGetShareResult(availability_zone=None, description=None, export_location_path=None, export_locations=None, id=None, is_public=None, metadata=None, name=None, project_id=None, region=None, share_network_id=None, share_proto=None, size=None, snapshot_id=None, status=None)¶

class pulumi_openstack.sharedfilesystem.AwaitableGetSnapshotResult(description=None, id=None, name=None, project_id=None, region=None, share_id=None, share_proto=None, share_size=None, size=None, status=None)¶

class pulumi_openstack.sharedfilesystem.GetAvailbilityZonesResult(id=None, names=None, region=None)¶

A collection of values returned by getAvailbilityZones.

id = None¶: The provider-assigned unique ID for this managed resource.

names = None¶: The names of the availability zones, ordered alphanumerically.

region = None¶: See Argument Reference above.

class pulumi_openstack.sharedfilesystem.GetShareNetworkResult(cidr=None, description=None, id=None, ip_version=None, name=None, network_type=None, neutron_net_id=None, neutron_subnet_id=None, project_id=None, region=None, security_service_id=None, security_service_ids=None, segmentation_id=None)¶

A collection of values returned by getShareNetwork.

cidr = None¶: See Argument Reference above.

description = None¶: See Argument Reference above.

id = None¶: The provider-assigned unique ID for this managed resource.

ip_version = None¶: See Argument Reference above.

name = None¶: See Argument Reference above.

network_type = None¶: See Argument Reference above.

neutron_net_id = None¶: See Argument Reference above.

neutron_subnet_id = None¶: See Argument Reference above.

project_id = None¶: The owner of the Share Network.

region = None¶: See Argument Reference above.

security_service_id = None¶: See Argument Reference above.

security_service_ids = None¶: The list of security service IDs associated with the share network.

segmentation_id = None¶: See Argument Reference above.

class pulumi_openstack.sharedfilesystem.GetShareResult(availability_zone=None, description=None, export_location_path=None, export_locations=None, id=None, is_public=None, metadata=None, name=None, project_id=None, region=None, share_network_id=None, share_proto=None, size=None, snapshot_id=None, status=None)¶

A collection of values returned by getShare.

availability_zone = None¶: The share availability zone.

description = None¶: See Argument Reference above.

export_location_path = None¶: See Argument Reference above.

export_locations = None¶: A list of export locations. For example, when a share server has more than one network interface, it can have multiple export locations.

id = None¶: The provider-assigned unique ID for this managed resource.

is_public = None¶: See Argument Reference above.

metadata = None¶: See Argument Reference above.

name = None¶: See Argument Reference above.

project_id = None¶: See Argument Reference above.

region = None¶: The region in which to obtain the V2 Shared File System client.

share_network_id = None¶: See Argument Reference above.

share_proto = None¶: The share protocol.

size = None¶: The share size, in GBs.

snapshot_id = None¶: See Argument Reference above.

status = None¶: See Argument Reference above.

class pulumi_openstack.sharedfilesystem.GetSnapshotResult(description=None, id=None, name=None, project_id=None, region=None, share_id=None, share_proto=None, share_size=None, size=None, status=None)¶

A collection of values returned by getSnapshot.

description = None¶: See Argument Reference above.

id = None¶: The provider-assigned unique ID for this managed resource.

name = None¶: See Argument Reference above.

project_id = None¶: See Argument Reference above.

share_id = None¶: The UUID of the source share that was used to create the snapshot.

share_proto = None¶: The file system protocol of a share snapshot.

share_size = None¶: The share snapshot size, in GBs.

size = None¶: The snapshot size, in GBs.

status = None¶: See Argument Reference above.

class pulumi_openstack.sharedfilesystem.SecurityService(resource_name, opts=None, description=None, dns_ip=None, domain=None, name=None, ou=None, password=None, region=None, server=None, type=None, user=None, __props__=None, __name__=None, __opts__=None)¶

Create a SecurityService resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] description: The human-readable description for the security service.

Changing this updates the description of the existing security service.

Parameters

dns_ip (pulumi.Input[str]) – The security service DNS IP address that is used inside the tenant network.
domain (pulumi.Input[str]) – The security service domain.
name (pulumi.Input[str]) – The name of the security service. Changing this updates the name of the existing security service.
ou (pulumi.Input[str]) – The security service ou. An organizational unit can be added to specify where the share ends up. New in Manila microversion 2.44.
password (pulumi.Input[str]) – The user password, if you specify a user.
region (pulumi.Input[str]) – The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a security service. If omitted, the region argument of the provider is used. Changing this creates a new security service.
server (pulumi.Input[str]) – The security service host name or IP address.
type (pulumi.Input[str]) – The security service type - can either be active_directory, kerberos or ldap. Changing this updates the existing security service.
user (pulumi.Input[str]) – The security service user or group name that is used by the tenant.

description: pulumi.Output[str] = None¶: The human-readable description for the security service. Changing this updates the description of the existing security service.

dns_ip: pulumi.Output[str] = None¶: The security service DNS IP address that is used inside the tenant network.

domain: pulumi.Output[str] = None¶: The security service domain.

name: pulumi.Output[str] = None¶: The name of the security service. Changing this updates the name of the existing security service.

ou: pulumi.Output[str] = None¶: The security service ou. An organizational unit can be added to specify where the share ends up. New in Manila microversion 2.44.

password: pulumi.Output[str] = None¶: The user password, if you specify a user.

project_id: pulumi.Output[str] = None¶: The owner of the Security Service.

region: pulumi.Output[str] = None¶: The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a security service. If omitted, the region argument of the provider is used. Changing this creates a new security service.

server: pulumi.Output[str] = None¶: The security service host name or IP address.

type: pulumi.Output[str] = None¶: The security service type - can either be active_directory, kerberos or ldap. Changing this updates the existing security service.

user: pulumi.Output[str] = None¶: The security service user or group name that is used by the tenant.

static get(resource_name, id, opts=None, description=None, dns_ip=None, domain=None, name=None, ou=None, password=None, project_id=None, region=None, server=None, type=None, user=None)¶

Get an existing SecurityService resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – The human-readable description for the security service. Changing this updates the description of the existing security service.
dns_ip (pulumi.Input[str]) – The security service DNS IP address that is used inside the tenant network.
domain (pulumi.Input[str]) – The security service domain.
name (pulumi.Input[str]) – The name of the security service. Changing this updates the name of the existing security service.
ou (pulumi.Input[str]) – The security service ou. An organizational unit can be added to specify where the share ends up. New in Manila microversion 2.44.
password (pulumi.Input[str]) – The user password, if you specify a user.
project_id (pulumi.Input[str]) – The owner of the Security Service.
region (pulumi.Input[str]) – The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a security service. If omitted, the region argument of the provider is used. Changing this creates a new security service.
server (pulumi.Input[str]) – The security service host name or IP address.
type (pulumi.Input[str]) – The security service type - can either be active_directory, kerberos or ldap. Changing this updates the existing security service.
user (pulumi.Input[str]) – The security service user or group name that is used by the tenant.

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.sharedfilesystem.Share(resource_name, opts=None, availability_zone=None, description=None, is_public=None, metadata=None, name=None, region=None, share_network_id=None, share_proto=None, share_type=None, size=None, snapshot_id=None, __props__=None, __name__=None, __opts__=None)¶

Use this resource to configure a share.

import pulumi
import pulumi_openstack as openstack

network1 = openstack.networking.Network("network1", admin_state_up="true")
subnet1 = openstack.networking.Subnet("subnet1",
    cidr="192.168.199.0/24",
    ip_version=4,
    network_id=network1.id)
sharenetwork1 = openstack.sharedfilesystem.ShareNetwork("sharenetwork1",
    description="test share network with security services",
    neutron_net_id=network1.id,
    neutron_subnet_id=subnet1.id)
share1 = openstack.sharedfilesystem.Share("share1",
    description="test share description",
    share_network_id=sharenetwork1.id,
    share_proto="NFS",
    size=1)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
availability_zone (pulumi.Input[str]) – The share availability zone. Changing this creates a new share.
description (pulumi.Input[str]) – The human-readable description for the share. Changing this updates the description of the existing share.
is_public (pulumi.Input[bool]) – The level of visibility for the share. Set to true to make share public. Set to false to make it private. Default value is false. Changing this updates the existing share.
metadata (pulumi.Input[dict]) – One or more metadata key and value pairs as a dictionary of strings.
name (pulumi.Input[str]) – The name of the share. Changing this updates the name of the existing share.
region (pulumi.Input[str]) – The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share. Changing this creates a new share.
share_network_id (pulumi.Input[str]) – The UUID of a share network where the share server exists or will be created. If share_network_id is not set and you provide a snapshot_id, the share_network_id value from the snapshot is used. Changing this creates a new share.
share_proto (pulumi.Input[str]) – The share protocol - can either be NFS, CIFS, CEPHFS, GLUSTERFS, HDFS or MAPRFS. Changing this creates a new share.
share_type (pulumi.Input[str]) – The share type name. If you omit this parameter, the default share type is used.
size (pulumi.Input[float]) – The share size, in GBs. The requested share size cannot be greater than the allowed GB quota. Changing this resizes the existing share.
snapshot_id (pulumi.Input[str]) – The UUID of the share’s base snapshot. Changing this creates a new share.

all_metadata: pulumi.Output[dict] = None¶: The map of metadata, assigned on the share, which has been explicitly and implicitly added.

availability_zone: pulumi.Output[str] = None¶: The share availability zone. Changing this creates a new share.

description: pulumi.Output[str] = None¶: The human-readable description for the share. Changing this updates the description of the existing share.

export_locations: pulumi.Output[list] = None¶

A list of export locations. For example, when a share server has more than one network interface, it can have multiple export locations.

path (str)
preferred (str)

has_replicas: pulumi.Output[bool] = None¶: Indicates whether a share has replicas or not.

host: pulumi.Output[str] = None¶: The share host name.

is_public: pulumi.Output[bool] = None¶: The level of visibility for the share. Set to true to make share public. Set to false to make it private. Default value is false. Changing this updates the existing share.

metadata: pulumi.Output[dict] = None¶: One or more metadata key and value pairs as a dictionary of strings.

name: pulumi.Output[str] = None¶: The name of the share. Changing this updates the name of the existing share.

project_id: pulumi.Output[str] = None¶: The owner of the Share.

region: pulumi.Output[str] = None¶: The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share. Changing this creates a new share.

replication_type: pulumi.Output[str] = None¶: The share replication type.

share_network_id: pulumi.Output[str] = None¶: The UUID of a share network where the share server exists or will be created. If share_network_id is not set and you provide a snapshot_id, the share_network_id value from the snapshot is used. Changing this creates a new share.

share_proto: pulumi.Output[str] = None¶: The share protocol - can either be NFS, CIFS, CEPHFS, GLUSTERFS, HDFS or MAPRFS. Changing this creates a new share.

share_server_id: pulumi.Output[str] = None¶: The UUID of the share server.

share_type: pulumi.Output[str] = None¶: The share type name. If you omit this parameter, the default share type is used.

size: pulumi.Output[float] = None¶: The share size, in GBs. The requested share size cannot be greater than the allowed GB quota. Changing this resizes the existing share.

snapshot_id: pulumi.Output[str] = None¶: The UUID of the share’s base snapshot. Changing this creates a new share.

static get(resource_name, id, opts=None, all_metadata=None, availability_zone=None, description=None, export_locations=None, has_replicas=None, host=None, is_public=None, metadata=None, name=None, project_id=None, region=None, replication_type=None, share_network_id=None, share_proto=None, share_server_id=None, share_type=None, size=None, snapshot_id=None)¶

Get an existing Share resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
all_metadata (pulumi.Input[dict]) – The map of metadata, assigned on the share, which has been explicitly and implicitly added.
availability_zone (pulumi.Input[str]) – The share availability zone. Changing this creates a new share.
description (pulumi.Input[str]) – The human-readable description for the share. Changing this updates the description of the existing share.
export_locations (pulumi.Input[list]) – A list of export locations. For example, when a share server has more than one network interface, it can have multiple export locations.
has_replicas (pulumi.Input[bool]) – Indicates whether a share has replicas or not.
host (pulumi.Input[str]) – The share host name.
is_public (pulumi.Input[bool]) – The level of visibility for the share. Set to true to make share public. Set to false to make it private. Default value is false. Changing this updates the existing share.
metadata (pulumi.Input[dict]) – One or more metadata key and value pairs as a dictionary of strings.
name (pulumi.Input[str]) – The name of the share. Changing this updates the name of the existing share.
project_id (pulumi.Input[str]) – The owner of the Share.
region (pulumi.Input[str]) – The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share. Changing this creates a new share.
replication_type (pulumi.Input[str]) – The share replication type.
share_network_id (pulumi.Input[str]) – The UUID of a share network where the share server exists or will be created. If share_network_id is not set and you provide a snapshot_id, the share_network_id value from the snapshot is used. Changing this creates a new share.
share_proto (pulumi.Input[str]) – The share protocol - can either be NFS, CIFS, CEPHFS, GLUSTERFS, HDFS or MAPRFS. Changing this creates a new share.
share_server_id (pulumi.Input[str]) – The UUID of the share server.
share_type (pulumi.Input[str]) – The share type name. If you omit this parameter, the default share type is used.
size (pulumi.Input[float]) – The share size, in GBs. The requested share size cannot be greater than the allowed GB quota. Changing this resizes the existing share.
snapshot_id (pulumi.Input[str]) – The UUID of the share’s base snapshot. Changing this creates a new share.

The export_locations object supports the following:

path (pulumi.Input[str])
preferred (pulumi.Input[str])

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.sharedfilesystem.ShareAccess(resource_name, opts=None, access_level=None, access_to=None, access_type=None, region=None, share_id=None, __props__=None, __name__=None, __opts__=None)¶

Create a ShareAccess resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] access_level: The access level to the share. Can either be rw or ro. :param pulumi.Input[str] access_to: The value that defines the access. Can either be an IP

address or a username verified by configured Security Service of the Share Network.

Parameters

access_type (pulumi.Input[str]) – The access rule type. Can either be an ip, user, cert, or cephx. cephx support requires an OpenStack environment that supports Shared Filesystem microversion 2.13 (Mitaka) or later.
region (pulumi.Input[str]) – The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share access. Changing this creates a new share access.
share_id (pulumi.Input[str]) – The UUID of the share to which you are granted access.

access_key: pulumi.Output[str] = None¶: The access credential of the entity granted access.

access_level: pulumi.Output[str] = None¶: The access level to the share. Can either be rw or ro.

access_to: pulumi.Output[str] = None¶: The value that defines the access. Can either be an IP address or a username verified by configured Security Service of the Share Network.

access_type: pulumi.Output[str] = None¶: The access rule type. Can either be an ip, user, cert, or cephx. cephx support requires an OpenStack environment that supports Shared Filesystem microversion 2.13 (Mitaka) or later.

region: pulumi.Output[str] = None¶: The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share access. Changing this creates a new share access.

share_id: pulumi.Output[str] = None¶: The UUID of the share to which you are granted access.

static get(resource_name, id, opts=None, access_key=None, access_level=None, access_to=None, access_type=None, region=None, share_id=None)¶

Get an existing ShareAccess resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
access_key (pulumi.Input[str]) – The access credential of the entity granted access.
access_level (pulumi.Input[str]) – The access level to the share. Can either be rw or ro.
access_to (pulumi.Input[str]) – The value that defines the access. Can either be an IP address or a username verified by configured Security Service of the Share Network.
access_type (pulumi.Input[str]) – The access rule type. Can either be an ip, user, cert, or cephx. cephx support requires an OpenStack environment that supports Shared Filesystem microversion 2.13 (Mitaka) or later.
region (pulumi.Input[str]) – The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share access. Changing this creates a new share access.
share_id (pulumi.Input[str]) – The UUID of the share to which you are granted access.

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.sharedfilesystem.ShareNetwork(resource_name, opts=None, description=None, name=None, neutron_net_id=None, neutron_subnet_id=None, region=None, security_service_ids=None, __props__=None, __name__=None, __opts__=None)¶

Create a ShareNetwork resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] description: The human-readable description for the share network.

Changing this updates the description of the existing share network.

Parameters

name (pulumi.Input[str]) – The name for the share network. Changing this updates the name of the existing share network.
neutron_net_id (pulumi.Input[str]) – The UUID of a neutron network when setting up or updating a share network. Changing this updates the existing share network if it’s not used by shares.
neutron_subnet_id (pulumi.Input[str]) – The UUID of the neutron subnet when setting up or updating a share network. Changing this updates the existing share network if it’s not used by shares.
region (pulumi.Input[str]) – The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share network. If omitted, the region argument of the provider is used. Changing this creates a new share network.
security_service_ids (pulumi.Input[list]) – The list of security service IDs to associate with the share network. The security service must be specified by ID and not name.

cidr: pulumi.Output[str] = None¶: The share network CIDR.

description: pulumi.Output[str] = None¶: The human-readable description for the share network. Changing this updates the description of the existing share network.

ip_version: pulumi.Output[float] = None¶: The IP version of the share network. Can either be 4 or 6.

name: pulumi.Output[str] = None¶: The name for the share network. Changing this updates the name of the existing share network.

network_type: pulumi.Output[str] = None¶: The share network type. Can either be VLAN, VXLAN, GRE, or flat.

neutron_net_id: pulumi.Output[str] = None¶: The UUID of a neutron network when setting up or updating a share network. Changing this updates the existing share network if it’s not used by shares.

neutron_subnet_id: pulumi.Output[str] = None¶: The UUID of the neutron subnet when setting up or updating a share network. Changing this updates the existing share network if it’s not used by shares.

project_id: pulumi.Output[str] = None¶: The owner of the Share Network.

region: pulumi.Output[str] = None¶: The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share network. If omitted, the region argument of the provider is used. Changing this creates a new share network.

security_service_ids: pulumi.Output[list] = None¶: The list of security service IDs to associate with the share network. The security service must be specified by ID and not name.

segmentation_id: pulumi.Output[float] = None¶: The share network segmentation ID.

static get(resource_name, id, opts=None, cidr=None, description=None, ip_version=None, name=None, network_type=None, neutron_net_id=None, neutron_subnet_id=None, project_id=None, region=None, security_service_ids=None, segmentation_id=None)¶

Get an existing ShareNetwork resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
cidr (pulumi.Input[str]) – The share network CIDR.
description (pulumi.Input[str]) – The human-readable description for the share network. Changing this updates the description of the existing share network.
ip_version (pulumi.Input[float]) – The IP version of the share network. Can either be 4 or 6.
name (pulumi.Input[str]) – The name for the share network. Changing this updates the name of the existing share network.
network_type (pulumi.Input[str]) – The share network type. Can either be VLAN, VXLAN, GRE, or flat.
neutron_net_id (pulumi.Input[str]) – The UUID of a neutron network when setting up or updating a share network. Changing this updates the existing share network if it’s not used by shares.
neutron_subnet_id (pulumi.Input[str]) – The UUID of the neutron subnet when setting up or updating a share network. Changing this updates the existing share network if it’s not used by shares.
project_id (pulumi.Input[str]) – The owner of the Share Network.
region (pulumi.Input[str]) – The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share network. If omitted, the region argument of the provider is used. Changing this creates a new share network.
security_service_ids (pulumi.Input[list]) – The list of security service IDs to associate with the share network. The security service must be specified by ID and not name.
segmentation_id (pulumi.Input[float]) – The share network segmentation ID.

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.sharedfilesystem.get_availbility_zones(region=None, opts=None)¶

Use this data source to get a list of Shared File System availability zones from OpenStack

import pulumi
import pulumi_openstack as openstack

zones = openstack.sharedfilesystem.get_availbility_zones()

Parameters: region (str) – The region in which to obtain the V2 Shared File System client. If omitted, the region argument of the provider is used.

pulumi_openstack.sharedfilesystem.get_share(description=None, export_location_path=None, is_public=None, metadata=None, name=None, region=None, share_network_id=None, snapshot_id=None, status=None, opts=None)¶

Use this data source to get the ID of an available Shared File System share.

import pulumi
import pulumi_openstack as openstack

share1 = openstack.sharedfilesystem.get_share(name="share_1")

Parameters

description (str) – The human-readable description for the share.
export_location_path (str) – The export location path of the share. Available since Manila API version 2.35.
is_public (bool) – The level of visibility for the share. length.
metadata (dict) – One or more metadata key and value pairs as a dictionary of strings.
name (str) – The name of the share.
region (str) – The region in which to obtain the V2 Shared File System client.
share_network_id (str) – The UUID of the share’s share network.
snapshot_id (str) – The UUID of the share’s base snapshot.
status (str) – A share status filter. A valid value is creating, error, available, deleting, error_deleting, manage_starting, manage_error, unmanage_starting, unmanage_error, unmanaged, extending, extending_error, shrinking, shrinking_error, or shrinking_possible_data_loss_error.

pulumi_openstack.sharedfilesystem.get_share_network(description=None, ip_version=None, name=None, network_type=None, neutron_net_id=None, neutron_subnet_id=None, region=None, security_service_id=None, segmentation_id=None, opts=None)¶

Use this data source to get the ID of an available Shared File System share network.

import pulumi
import pulumi_openstack as openstack

sharenetwork1 = openstack.sharedfilesystem.get_share_network(name="sharenetwork_1")

Parameters

description (str) – The human-readable description of the share network.
ip_version (float) – The IP version of the share network. Can either be 4 or 6.
name (str) – The name of the share network.
network_type (str) – The share network type. Can either be VLAN, VXLAN, GRE, or flat.
neutron_net_id (str) – The neutron network UUID of the share network.
neutron_subnet_id (str) – The neutron subnet UUID of the share network.
region (str) – The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to read a share network. If omitted, the region argument of the provider is used.
security_service_id (str) – The security service IDs associated with the share network.
segmentation_id (float) – The share network segmentation ID.

pulumi_openstack.sharedfilesystem.get_snapshot(description=None, name=None, region=None, share_id=None, status=None, opts=None)¶

Use this data source to get the ID of an available Shared File System snapshot.

import pulumi
import pulumi_openstack as openstack

snapshot1 = openstack.sharedfilesystem.get_snapshot(name="snapshot_1")

Parameters

description (str) – The human-readable description of the snapshot.
name (str) – The name of the snapshot.
region (str) – The region in which to obtain the V2 Shared File System client.
share_id (str) – The UUID of the source share that was used to create the snapshot.
status (str) – A snapshot status filter. A valid value is available, error, creating, deleting, manage_starting, manage_error, unmanage_starting, unmanage_error or error_deleting.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

sharedfilesystem¶

On This Page