GetShare

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

Example Usage

using Pulumi;
using OpenStack = Pulumi.OpenStack;

class MyStack : Stack
{
    public MyStack()
    {
        var share1 = Output.Create(OpenStack.SharedFileSystem.GetShare.InvokeAsync(new OpenStack.SharedFileSystem.GetShareArgs
        {
            Name = "share_1",
        }));
    }

}

Coming soon!

import pulumi
import pulumi_openstack as openstack

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

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

const share1 = pulumi.output(openstack.sharedfilesystem.getShare({
    name: "share_1",
}, { async: true }));

Using GetShare

function getShare(args: GetShareArgs, opts?: InvokeOptions): Promise<GetShareResult>

function  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)

func LookupShare(ctx *Context, args *LookupShareArgs, opts ...InvokeOption) (*LookupShareResult, error)

Note: This function is named LookupShare in the Go SDK.

public static class GetShare {
    public static Task<GetShareResult> InvokeAsync(GetShareArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Description string: The human-readable description for the share.
ExportLocationPath string: The export location path of the share. Available since Manila API version 2.35.
IsPublic bool: The level of visibility for the share. length.
Metadata Dictionary<string, object>: One or more metadata key and value pairs as a dictionary of strings.
Name string: The name of the share.
Region string: The region in which to obtain the V2 Shared File System client.
ShareNetworkId string: The UUID of the share’s share network.
SnapshotId string: The UUID of the share’s base snapshot.
Status string: 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.

Description string: The human-readable description for the share.
ExportLocationPath string: The export location path of the share. Available since Manila API version 2.35.
IsPublic bool: The level of visibility for the share. length.
Metadata map[string]interface{}: One or more metadata key and value pairs as a dictionary of strings.
Name string: The name of the share.
Region string: The region in which to obtain the V2 Shared File System client.
ShareNetworkId string: The UUID of the share’s share network.
SnapshotId string: The UUID of the share’s base snapshot.
Status string: 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.

description string: The human-readable description for the share.
exportLocationPath string: The export location path of the share. Available since Manila API version 2.35.
isPublic boolean: The level of visibility for the share. length.
metadata {[key: string]: any}: One or more metadata key and value pairs as a dictionary of strings.
name string: The name of the share.
region string: The region in which to obtain the V2 Shared File System client.
shareNetworkId string: The UUID of the share’s share network.
snapshotId string: The UUID of the share’s base snapshot.
status string: 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.

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[str, Any]: 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.

GetShare Result

The following output properties are available:

AvailabilityZone string: The share availability zone.
Description string: See Argument Reference above.
ExportLocations List<Pulumi.OpenStack.SharedFileSystem.Outputs.GetShareExportLocation>: A list of export locations. For example, when a share server has more than one network interface, it can have multiple export locations.
Id string: The provider-assigned unique ID for this managed resource.
IsPublic bool: See Argument Reference above.
Metadata Dictionary<string, object>: See Argument Reference above.
Name string: See Argument Reference above.
ProjectId string: See Argument Reference above.
Region string: The region in which to obtain the V2 Shared File System client.
ShareNetworkId string: See Argument Reference above.
ShareProto string: The share protocol.
Size int: The share size, in GBs.
SnapshotId string: See Argument Reference above.
Status string: See Argument Reference above.
ExportLocationPath string: See Argument Reference above.

AvailabilityZone string: The share availability zone.
Description string: See Argument Reference above.
ExportLocations []GetShareExportLocation: A list of export locations. For example, when a share server has more than one network interface, it can have multiple export locations.
Id string: The provider-assigned unique ID for this managed resource.
IsPublic bool: See Argument Reference above.
Metadata map[string]interface{}: See Argument Reference above.
Name string: See Argument Reference above.
ProjectId string: See Argument Reference above.
Region string: The region in which to obtain the V2 Shared File System client.
ShareNetworkId string: See Argument Reference above.
ShareProto string: The share protocol.
Size int: The share size, in GBs.
SnapshotId string: See Argument Reference above.
Status string: See Argument Reference above.
ExportLocationPath string: See Argument Reference above.

availabilityZone string: The share availability zone.
description string: See Argument Reference above.
exportLocations GetShareExportLocation[]: A list of export locations. For example, when a share server has more than one network interface, it can have multiple export locations.
id string: The provider-assigned unique ID for this managed resource.
isPublic boolean: See Argument Reference above.
metadata {[key: string]: any}: See Argument Reference above.
name string: See Argument Reference above.
projectId string: See Argument Reference above.
region string: The region in which to obtain the V2 Shared File System client.
shareNetworkId string: See Argument Reference above.
shareProto string: The share protocol.
size number: The share size, in GBs.
snapshotId string: See Argument Reference above.
status string: See Argument Reference above.
exportLocationPath string: See Argument Reference above.

availability_zone str: The share availability zone.
description str: See Argument Reference above.
export_locations List[GetShareExportLocation]: A list of export locations. For example, when a share server has more than one network interface, it can have multiple export locations.
id str: The provider-assigned unique ID for this managed resource.
is_public bool: See Argument Reference above.
metadata Dict[str, Any]: See Argument Reference above.
name str: See Argument Reference above.
project_id str: See Argument Reference above.
region str: The region in which to obtain the V2 Shared File System client.
share_network_id str: See Argument Reference above.
share_proto str: The share protocol.
size float: The share size, in GBs.
snapshot_id str: See Argument Reference above.
status str: See Argument Reference above.
export_location_path str: See Argument Reference above.

Supporting Types

GetShareExportLocation

See the output API doc for this type.

Path string
Preferred string

Path string
Preferred string

path string
preferred string

path str
preferred str

Package Details

Repository: https://github.com/pulumi/pulumi-openstack
License: Apache-2.0
Notes: This Pulumi package is based on the openstack Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetShare

Example Usage

Using GetShare

GetShare Result

Supporting Types

GetShareExportLocation

Package Details

On This Page