Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ionoscloud
  3. API Docs
  4. nfs
  5. getShare
IonosCloud v0.2.2 published on Monday, May 12, 2025 by ionos-cloud
ionos-cloud/pulumi-ionoscloud

ionoscloud.nfs.getShare

Explore with Pulumi AI

ionoscloud logo
IonosCloud v0.2.2 published on Monday, May 12, 2025 by ionos-cloud
ionos-cloud/pulumi-ionoscloud

    Returns information about shares of Network File Storage (NFS) on IonosCloud.

    By ID

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

const example = ionoscloud.nfs.getShare({
    location: "location",
    clusterId: "cluster-id",
    id: "share-id",
});

    import pulumi
import pulumi_ionoscloud as ionoscloud

example = ionoscloud.nfs.get_share(location="location",
    cluster_id="cluster-id",
    id="share-id")

    package main

import (
	"github.com/ionos-cloud/pulumi-ionoscloud/sdk/go/ionoscloud/nfs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := nfs.LookupShare(ctx, &nfs.LookupShareArgs{
			Location:  pulumi.StringRef("location"),
			ClusterId: "cluster-id",
			Id:        pulumi.StringRef("share-id"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Ionoscloud.Nfs.GetShare.Invoke(new()
    {
        Location = "location",
        ClusterId = "cluster-id",
        Id = "share-id",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ionoscloud.nfs.NfsFunctions;
import com.pulumi.ionoscloud.nfs.inputs.GetShareArgs;
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) {
        final var example = NfsFunctions.getShare(GetShareArgs.builder()
            .location("location")
            .clusterId("cluster-id")
            .id("share-id")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: ionoscloud:nfs:getShare
      arguments:
        location: location
        clusterId: cluster-id
        id: share-id

    By Name

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

const example = ionoscloud.nfs.getShare({
    location: "location",
    clusterId: "cluster-id",
    name: "partial-name",
    partialMatch: true,
});

    import pulumi
import pulumi_ionoscloud as ionoscloud

example = ionoscloud.nfs.get_share(location="location",
    cluster_id="cluster-id",
    name="partial-name",
    partial_match=True)

    package main

import (
	"github.com/ionos-cloud/pulumi-ionoscloud/sdk/go/ionoscloud/nfs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := nfs.LookupShare(ctx, &nfs.LookupShareArgs{
			Location:     pulumi.StringRef("location"),
			ClusterId:    "cluster-id",
			Name:         pulumi.StringRef("partial-name"),
			PartialMatch: pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Ionoscloud.Nfs.GetShare.Invoke(new()
    {
        Location = "location",
        ClusterId = "cluster-id",
        Name = "partial-name",
        PartialMatch = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ionoscloud.nfs.NfsFunctions;
import com.pulumi.ionoscloud.nfs.inputs.GetShareArgs;
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) {
        final var example = NfsFunctions.getShare(GetShareArgs.builder()
            .location("location")
            .clusterId("cluster-id")
            .name("partial-name")
            .partialMatch(true)
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: ionoscloud:nfs:getShare
      arguments:
        location: location
        clusterId: cluster-id
        name: partial-name
        partialMatch: true

    Using getShare

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getShare(args: GetShareArgs, opts?: InvokeOptions): Promise<GetShareResult>
function getShareOutput(args: GetShareOutputArgs, opts?: InvokeOptions): Output<GetShareResult>
    def get_share(client_groups: Optional[Sequence[GetShareClientGroup]] = None,
              cluster_id: Optional[str] = None,
              gid: Optional[int] = None,
              id: Optional[str] = None,
              location: Optional[str] = None,
              name: Optional[str] = None,
              partial_match: Optional[bool] = None,
              quota: Optional[int] = None,
              uid: Optional[int] = None,
              opts: Optional[InvokeOptions] = None) -> GetShareResult
def get_share_output(client_groups: Optional[pulumi.Input[Sequence[pulumi.Input[GetShareClientGroupArgs]]]] = None,
              cluster_id: Optional[pulumi.Input[str]] = None,
              gid: Optional[pulumi.Input[int]] = None,
              id: Optional[pulumi.Input[str]] = None,
              location: Optional[pulumi.Input[str]] = None,
              name: Optional[pulumi.Input[str]] = None,
              partial_match: Optional[pulumi.Input[bool]] = None,
              quota: Optional[pulumi.Input[int]] = None,
              uid: Optional[pulumi.Input[int]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetShareResult]
    func LookupShare(ctx *Context, args *LookupShareArgs, opts ...InvokeOption) (*LookupShareResult, error)
func LookupShareOutput(ctx *Context, args *LookupShareOutputArgs, opts ...InvokeOption) LookupShareResultOutput

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

    public static class GetShare 
{
    public static Task<GetShareResult> InvokeAsync(GetShareArgs args, InvokeOptions? opts = null)
    public static Output<GetShareResult> Invoke(GetShareInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetShareResult> getShare(GetShareArgs args, InvokeOptions options)
public static Output<GetShareResult> getShare(GetShareArgs args, InvokeOptions options)

    fn::invoke:
  function: ionoscloud:nfs/getShare:getShare
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ClusterId string
    The ID of the Network File Storage cluster.
    ClientGroups List<Ionoscloud.GetShareClientGroup>
    The groups of clients are the systems connecting to the Network File Storage cluster. Each client group supports the following:
    Gid int
    The group ID that will own the exported directory. If not set, anonymous (512) will be used.
    Id string
    ID of the Network File Storage share.
    Location string
    The location where the Network File Storage share is located.
    Name string
    Name of the Network File Storage share.
    PartialMatch bool
    Whether partial matching is allowed or not when using the name filter. Defaults to false.
    Quota int
    The quota in MiB for the export. The quota can restrict the amount of data that can be stored within the export. The quota can be disabled using 0.
    Uid int
    The user ID that will own the exported directory. If not set, anonymous (512) will be used.
    ClusterId string
    The ID of the Network File Storage cluster.
    ClientGroups []GetShareClientGroup
    The groups of clients are the systems connecting to the Network File Storage cluster. Each client group supports the following:
    Gid int
    The group ID that will own the exported directory. If not set, anonymous (512) will be used.
    Id string
    ID of the Network File Storage share.
    Location string
    The location where the Network File Storage share is located.
    Name string
    Name of the Network File Storage share.
    PartialMatch bool
    Whether partial matching is allowed or not when using the name filter. Defaults to false.
    Quota int
    The quota in MiB for the export. The quota can restrict the amount of data that can be stored within the export. The quota can be disabled using 0.
    Uid int
    The user ID that will own the exported directory. If not set, anonymous (512) will be used.
    clusterId String
    The ID of the Network File Storage cluster.
    clientGroups List<GetShareClientGroup>
    The groups of clients are the systems connecting to the Network File Storage cluster. Each client group supports the following:
    gid Integer
    The group ID that will own the exported directory. If not set, anonymous (512) will be used.
    id String
    ID of the Network File Storage share.
    location String
    The location where the Network File Storage share is located.
    name String
    Name of the Network File Storage share.
    partialMatch Boolean
    Whether partial matching is allowed or not when using the name filter. Defaults to false.
    quota Integer
    The quota in MiB for the export. The quota can restrict the amount of data that can be stored within the export. The quota can be disabled using 0.
    uid Integer
    The user ID that will own the exported directory. If not set, anonymous (512) will be used.
    clusterId string
    The ID of the Network File Storage cluster.
    clientGroups GetShareClientGroup[]
    The groups of clients are the systems connecting to the Network File Storage cluster. Each client group supports the following:
    gid number
    The group ID that will own the exported directory. If not set, anonymous (512) will be used.
    id string
    ID of the Network File Storage share.
    location string
    The location where the Network File Storage share is located.
    name string
    Name of the Network File Storage share.
    partialMatch boolean
    Whether partial matching is allowed or not when using the name filter. Defaults to false.
    quota number
    The quota in MiB for the export. The quota can restrict the amount of data that can be stored within the export. The quota can be disabled using 0.
    uid number
    The user ID that will own the exported directory. If not set, anonymous (512) will be used.
    cluster_id str
    The ID of the Network File Storage cluster.
    client_groups Sequence[GetShareClientGroup]
    The groups of clients are the systems connecting to the Network File Storage cluster. Each client group supports the following:
    gid int
    The group ID that will own the exported directory. If not set, anonymous (512) will be used.
    id str
    ID of the Network File Storage share.
    location str
    The location where the Network File Storage share is located.
    name str
    Name of the Network File Storage share.
    partial_match bool
    Whether partial matching is allowed or not when using the name filter. Defaults to false.
    quota int
    The quota in MiB for the export. The quota can restrict the amount of data that can be stored within the export. The quota can be disabled using 0.
    uid int
    The user ID that will own the exported directory. If not set, anonymous (512) will be used.
    clusterId String
    The ID of the Network File Storage cluster.
    clientGroups List<Property Map>
    The groups of clients are the systems connecting to the Network File Storage cluster. Each client group supports the following:
    gid Number
    The group ID that will own the exported directory. If not set, anonymous (512) will be used.
    id String
    ID of the Network File Storage share.
    location String
    The location where the Network File Storage share is located.
    name String
    Name of the Network File Storage share.
    partialMatch Boolean
    Whether partial matching is allowed or not when using the name filter. Defaults to false.
    quota Number
    The quota in MiB for the export. The quota can restrict the amount of data that can be stored within the export. The quota can be disabled using 0.
    uid Number
    The user ID that will own the exported directory. If not set, anonymous (512) will be used.

    getShare Result

    The following output properties are available:

    ClientGroups List<Ionoscloud.GetShareClientGroup>
    The groups of clients are the systems connecting to the Network File Storage cluster. Each client group supports the following:
    ClusterId string
    The ID of the Network File Storage cluster.
    Gid int
    The group ID that will own the exported directory. If not set, anonymous (512) will be used.
    Id string
    The ID of the Network File Storage share.
    Name string
    The name of the Network File Storage share.
    NfsPath string
    Path to the NFS export. The NFS path is the path to the directory being exported.
    Quota int
    The quota in MiB for the export. The quota can restrict the amount of data that can be stored within the export. The quota can be disabled using 0.
    Uid int
    The user ID that will own the exported directory. If not set, anonymous (512) will be used.
    Location string
    The location where the Network File Storage share is located.
    PartialMatch bool
    ClientGroups []GetShareClientGroup
    The groups of clients are the systems connecting to the Network File Storage cluster. Each client group supports the following:
    ClusterId string
    The ID of the Network File Storage cluster.
    Gid int
    The group ID that will own the exported directory. If not set, anonymous (512) will be used.
    Id string
    The ID of the Network File Storage share.
    Name string
    The name of the Network File Storage share.
    NfsPath string
    Path to the NFS export. The NFS path is the path to the directory being exported.
    Quota int
    The quota in MiB for the export. The quota can restrict the amount of data that can be stored within the export. The quota can be disabled using 0.
    Uid int
    The user ID that will own the exported directory. If not set, anonymous (512) will be used.
    Location string
    The location where the Network File Storage share is located.
    PartialMatch bool
    clientGroups List<GetShareClientGroup>
    The groups of clients are the systems connecting to the Network File Storage cluster. Each client group supports the following:
    clusterId String
    The ID of the Network File Storage cluster.
    gid Integer
    The group ID that will own the exported directory. If not set, anonymous (512) will be used.
    id String
    The ID of the Network File Storage share.
    name String
    The name of the Network File Storage share.
    nfsPath String
    Path to the NFS export. The NFS path is the path to the directory being exported.
    quota Integer
    The quota in MiB for the export. The quota can restrict the amount of data that can be stored within the export. The quota can be disabled using 0.
    uid Integer
    The user ID that will own the exported directory. If not set, anonymous (512) will be used.
    location String
    The location where the Network File Storage share is located.
    partialMatch Boolean
    clientGroups GetShareClientGroup[]
    The groups of clients are the systems connecting to the Network File Storage cluster. Each client group supports the following:
    clusterId string
    The ID of the Network File Storage cluster.
    gid number
    The group ID that will own the exported directory. If not set, anonymous (512) will be used.
    id string
    The ID of the Network File Storage share.
    name string
    The name of the Network File Storage share.
    nfsPath string
    Path to the NFS export. The NFS path is the path to the directory being exported.
    quota number
    The quota in MiB for the export. The quota can restrict the amount of data that can be stored within the export. The quota can be disabled using 0.
    uid number
    The user ID that will own the exported directory. If not set, anonymous (512) will be used.
    location string
    The location where the Network File Storage share is located.
    partialMatch boolean
    client_groups Sequence[GetShareClientGroup]
    The groups of clients are the systems connecting to the Network File Storage cluster. Each client group supports the following:
    cluster_id str
    The ID of the Network File Storage cluster.
    gid int
    The group ID that will own the exported directory. If not set, anonymous (512) will be used.
    id str
    The ID of the Network File Storage share.
    name str
    The name of the Network File Storage share.
    nfs_path str
    Path to the NFS export. The NFS path is the path to the directory being exported.
    quota int
    The quota in MiB for the export. The quota can restrict the amount of data that can be stored within the export. The quota can be disabled using 0.
    uid int
    The user ID that will own the exported directory. If not set, anonymous (512) will be used.
    location str
    The location where the Network File Storage share is located.
    partial_match bool
    clientGroups List<Property Map>
    The groups of clients are the systems connecting to the Network File Storage cluster. Each client group supports the following:
    clusterId String
    The ID of the Network File Storage cluster.
    gid Number
    The group ID that will own the exported directory. If not set, anonymous (512) will be used.
    id String
    The ID of the Network File Storage share.
    name String
    The name of the Network File Storage share.
    nfsPath String
    Path to the NFS export. The NFS path is the path to the directory being exported.
    quota Number
    The quota in MiB for the export. The quota can restrict the amount of data that can be stored within the export. The quota can be disabled using 0.
    uid Number
    The user ID that will own the exported directory. If not set, anonymous (512) will be used.
    location String
    The location where the Network File Storage share is located.
    partialMatch Boolean

    Supporting Types

    GetShareClientGroup

    Description string
    Optional description for the clients groups.
    Hosts List<string>
    A singular host allowed to connect to the share. The host can be specified as IP address and can be either IPv4 or IPv6.
    IpNetworks List<string>
    The allowed host or network to which the export is being shared. The IP address can be either IPv4 or IPv6 and has to be given with CIDR notation.
    Nfs List<Ionoscloud.GetShareClientGroupNf>
    The NFS configuration for the client group. Each NFS configuration supports the following:
    Description string
    Optional description for the clients groups.
    Hosts []string
    A singular host allowed to connect to the share. The host can be specified as IP address and can be either IPv4 or IPv6.
    IpNetworks []string
    The allowed host or network to which the export is being shared. The IP address can be either IPv4 or IPv6 and has to be given with CIDR notation.
    Nfs []GetShareClientGroupNf
    The NFS configuration for the client group. Each NFS configuration supports the following:
    description String
    Optional description for the clients groups.
    hosts List<String>
    A singular host allowed to connect to the share. The host can be specified as IP address and can be either IPv4 or IPv6.
    ipNetworks List<String>
    The allowed host or network to which the export is being shared. The IP address can be either IPv4 or IPv6 and has to be given with CIDR notation.
    nfs List<GetShareClientGroupNf>
    The NFS configuration for the client group. Each NFS configuration supports the following:
    description string
    Optional description for the clients groups.
    hosts string[]
    A singular host allowed to connect to the share. The host can be specified as IP address and can be either IPv4 or IPv6.
    ipNetworks string[]
    The allowed host or network to which the export is being shared. The IP address can be either IPv4 or IPv6 and has to be given with CIDR notation.
    nfs GetShareClientGroupNf[]
    The NFS configuration for the client group. Each NFS configuration supports the following:
    description str
    Optional description for the clients groups.
    hosts Sequence[str]
    A singular host allowed to connect to the share. The host can be specified as IP address and can be either IPv4 or IPv6.
    ip_networks Sequence[str]
    The allowed host or network to which the export is being shared. The IP address can be either IPv4 or IPv6 and has to be given with CIDR notation.
    nfs Sequence[GetShareClientGroupNf]
    The NFS configuration for the client group. Each NFS configuration supports the following:
    description String
    Optional description for the clients groups.
    hosts List<String>
    A singular host allowed to connect to the share. The host can be specified as IP address and can be either IPv4 or IPv6.
    ipNetworks List<String>
    The allowed host or network to which the export is being shared. The IP address can be either IPv4 or IPv6 and has to be given with CIDR notation.
    nfs List<Property Map>
    The NFS configuration for the client group. Each NFS configuration supports the following:

    GetShareClientGroupNf

    Squash string
    The squash mode for the export. The squash mode can be: none - No squash mode. no mapping, root-anonymous - Map root user to anonymous uid, all-anonymous - Map all users to anonymous uid.
    Squash string
    The squash mode for the export. The squash mode can be: none - No squash mode. no mapping, root-anonymous - Map root user to anonymous uid, all-anonymous - Map all users to anonymous uid.
    squash String
    The squash mode for the export. The squash mode can be: none - No squash mode. no mapping, root-anonymous - Map root user to anonymous uid, all-anonymous - Map all users to anonymous uid.
    squash string
    The squash mode for the export. The squash mode can be: none - No squash mode. no mapping, root-anonymous - Map root user to anonymous uid, all-anonymous - Map all users to anonymous uid.
    squash str
    The squash mode for the export. The squash mode can be: none - No squash mode. no mapping, root-anonymous - Map root user to anonymous uid, all-anonymous - Map all users to anonymous uid.
    squash String
    The squash mode for the export. The squash mode can be: none - No squash mode. no mapping, root-anonymous - Map root user to anonymous uid, all-anonymous - Map all users to anonymous uid.

    Package Details

    Repository
    ionoscloud ionos-cloud/pulumi-ionoscloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ionoscloud Terraform Provider.
    ionoscloud logo
    IonosCloud v0.2.2 published on Monday, May 12, 2025 by ionos-cloud
    ionos-cloud/pulumi-ionoscloud