1. Packages
  2. Ionoscloud Provider
  3. API Docs
  4. getNfsCluster
ionoscloud 6.7.6 published on Monday, Apr 14, 2025 by ionos-cloud

ionoscloud.getNfsCluster

Explore with Pulumi AI

ionoscloud 6.7.6 published on Monday, Apr 14, 2025 by ionos-cloud

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

By ID

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

const example = ionoscloud.getNfsCluster({
    id: "cluster-id",
    location: "location",
});
Copy
import pulumi
import pulumi_ionoscloud as ionoscloud

example = ionoscloud.get_nfs_cluster(id="cluster-id",
    location="location")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ionoscloud/v6/ionoscloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ionoscloud.LookupNfsCluster(ctx, &ionoscloud.LookupNfsClusterArgs{
			Id:       pulumi.StringRef("cluster-id"),
			Location: "location",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ionoscloud = Pulumi.Ionoscloud;

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

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ionoscloud.IonoscloudFunctions;
import com.pulumi.ionoscloud.inputs.GetNfsClusterArgs;
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 = IonoscloudFunctions.getNfsCluster(GetNfsClusterArgs.builder()
            .id("cluster-id")
            .location("location")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: ionoscloud:getNfsCluster
      arguments:
        id: cluster-id
        location: location
Copy

Using getNfsCluster

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 getNfsCluster(args: GetNfsClusterArgs, opts?: InvokeOptions): Promise<GetNfsClusterResult>
function getNfsClusterOutput(args: GetNfsClusterOutputArgs, opts?: InvokeOptions): Output<GetNfsClusterResult>
Copy
def get_nfs_cluster(id: Optional[str] = None,
                    location: Optional[str] = None,
                    name: Optional[str] = None,
                    partial_match: Optional[bool] = None,
                    opts: Optional[InvokeOptions] = None) -> GetNfsClusterResult
def get_nfs_cluster_output(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,
                    opts: Optional[InvokeOptions] = None) -> Output[GetNfsClusterResult]
Copy
func LookupNfsCluster(ctx *Context, args *LookupNfsClusterArgs, opts ...InvokeOption) (*LookupNfsClusterResult, error)
func LookupNfsClusterOutput(ctx *Context, args *LookupNfsClusterOutputArgs, opts ...InvokeOption) LookupNfsClusterResultOutput
Copy

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

public static class GetNfsCluster 
{
    public static Task<GetNfsClusterResult> InvokeAsync(GetNfsClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetNfsClusterResult> Invoke(GetNfsClusterInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetNfsClusterResult> getNfsCluster(GetNfsClusterArgs args, InvokeOptions options)
public static Output<GetNfsClusterResult> getNfsCluster(GetNfsClusterArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ionoscloud:index/getNfsCluster:getNfsCluster
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Location This property is required. string
The location where the Network File Storage cluster is located.
Id string
ID of the Network File Storage cluster.
Name string
Name of the Network File Storage cluster.
PartialMatch bool
Whether partial matching is allowed or not when using the name filter. Defaults to false.
Location This property is required. string
The location where the Network File Storage cluster is located.
Id string
ID of the Network File Storage cluster.
Name string
Name of the Network File Storage cluster.
PartialMatch bool
Whether partial matching is allowed or not when using the name filter. Defaults to false.
location This property is required. String
The location where the Network File Storage cluster is located.
id String
ID of the Network File Storage cluster.
name String
Name of the Network File Storage cluster.
partialMatch Boolean
Whether partial matching is allowed or not when using the name filter. Defaults to false.
location This property is required. string
The location where the Network File Storage cluster is located.
id string
ID of the Network File Storage cluster.
name string
Name of the Network File Storage cluster.
partialMatch boolean
Whether partial matching is allowed or not when using the name filter. Defaults to false.
location This property is required. str
The location where the Network File Storage cluster is located.
id str
ID of the Network File Storage cluster.
name str
Name of the Network File Storage cluster.
partial_match bool
Whether partial matching is allowed or not when using the name filter. Defaults to false.
location This property is required. String
The location where the Network File Storage cluster is located.
id String
ID of the Network File Storage cluster.
name String
Name of the Network File Storage cluster.
partialMatch Boolean
Whether partial matching is allowed or not when using the name filter. Defaults to false.

getNfsCluster Result

The following output properties are available:

Connections List<GetNfsClusterConnection>
A list of connections for the Network File Storage cluster. You can specify only one connection. Each connection supports the following:
Id string
The ID of the Network File Storage cluster.
Location string
The location where the Network File Storage cluster is located.
Name string
The name of the Network File Storage cluster.
Nfs List<GetNfsClusterNf>
The NFS configuration for the Network File Storage cluster. Each NFS configuration supports the following:
Size double
The size of the Network File Storage cluster in TiB. Note that the cluster size cannot be reduced after provisioning. This value determines the billing fees. Default is 2. The minimum value is 2 and the maximum value is 42.
PartialMatch bool
Connections []GetNfsClusterConnection
A list of connections for the Network File Storage cluster. You can specify only one connection. Each connection supports the following:
Id string
The ID of the Network File Storage cluster.
Location string
The location where the Network File Storage cluster is located.
Name string
The name of the Network File Storage cluster.
Nfs []GetNfsClusterNf
The NFS configuration for the Network File Storage cluster. Each NFS configuration supports the following:
Size float64
The size of the Network File Storage cluster in TiB. Note that the cluster size cannot be reduced after provisioning. This value determines the billing fees. Default is 2. The minimum value is 2 and the maximum value is 42.
PartialMatch bool
connections List<GetNfsClusterConnection>
A list of connections for the Network File Storage cluster. You can specify only one connection. Each connection supports the following:
id String
The ID of the Network File Storage cluster.
location String
The location where the Network File Storage cluster is located.
name String
The name of the Network File Storage cluster.
nfs List<GetNfsClusterNf>
The NFS configuration for the Network File Storage cluster. Each NFS configuration supports the following:
size Double
The size of the Network File Storage cluster in TiB. Note that the cluster size cannot be reduced after provisioning. This value determines the billing fees. Default is 2. The minimum value is 2 and the maximum value is 42.
partialMatch Boolean
connections GetNfsClusterConnection[]
A list of connections for the Network File Storage cluster. You can specify only one connection. Each connection supports the following:
id string
The ID of the Network File Storage cluster.
location string
The location where the Network File Storage cluster is located.
name string
The name of the Network File Storage cluster.
nfs GetNfsClusterNf[]
The NFS configuration for the Network File Storage cluster. Each NFS configuration supports the following:
size number
The size of the Network File Storage cluster in TiB. Note that the cluster size cannot be reduced after provisioning. This value determines the billing fees. Default is 2. The minimum value is 2 and the maximum value is 42.
partialMatch boolean
connections Sequence[GetNfsClusterConnection]
A list of connections for the Network File Storage cluster. You can specify only one connection. Each connection supports the following:
id str
The ID of the Network File Storage cluster.
location str
The location where the Network File Storage cluster is located.
name str
The name of the Network File Storage cluster.
nfs Sequence[GetNfsClusterNf]
The NFS configuration for the Network File Storage cluster. Each NFS configuration supports the following:
size float
The size of the Network File Storage cluster in TiB. Note that the cluster size cannot be reduced after provisioning. This value determines the billing fees. Default is 2. The minimum value is 2 and the maximum value is 42.
partial_match bool
connections List<Property Map>
A list of connections for the Network File Storage cluster. You can specify only one connection. Each connection supports the following:
id String
The ID of the Network File Storage cluster.
location String
The location where the Network File Storage cluster is located.
name String
The name of the Network File Storage cluster.
nfs List<Property Map>
The NFS configuration for the Network File Storage cluster. Each NFS configuration supports the following:
size Number
The size of the Network File Storage cluster in TiB. Note that the cluster size cannot be reduced after provisioning. This value determines the billing fees. Default is 2. The minimum value is 2 and the maximum value is 42.
partialMatch Boolean

Supporting Types

GetNfsClusterConnection

DatacenterId This property is required. string
The ID of the datacenter where the Network File Storage cluster is located.
IpAddress This property is required. string
The IP address and prefix of the Network File Storage cluster. The IP address can be either IPv4 or IPv6. The IP address has to be given with CIDR notation.
Lan This property is required. string
The Private LAN to which the Network File Storage cluster must be connected.
DatacenterId This property is required. string
The ID of the datacenter where the Network File Storage cluster is located.
IpAddress This property is required. string
The IP address and prefix of the Network File Storage cluster. The IP address can be either IPv4 or IPv6. The IP address has to be given with CIDR notation.
Lan This property is required. string
The Private LAN to which the Network File Storage cluster must be connected.
datacenterId This property is required. String
The ID of the datacenter where the Network File Storage cluster is located.
ipAddress This property is required. String
The IP address and prefix of the Network File Storage cluster. The IP address can be either IPv4 or IPv6. The IP address has to be given with CIDR notation.
lan This property is required. String
The Private LAN to which the Network File Storage cluster must be connected.
datacenterId This property is required. string
The ID of the datacenter where the Network File Storage cluster is located.
ipAddress This property is required. string
The IP address and prefix of the Network File Storage cluster. The IP address can be either IPv4 or IPv6. The IP address has to be given with CIDR notation.
lan This property is required. string
The Private LAN to which the Network File Storage cluster must be connected.
datacenter_id This property is required. str
The ID of the datacenter where the Network File Storage cluster is located.
ip_address This property is required. str
The IP address and prefix of the Network File Storage cluster. The IP address can be either IPv4 or IPv6. The IP address has to be given with CIDR notation.
lan This property is required. str
The Private LAN to which the Network File Storage cluster must be connected.
datacenterId This property is required. String
The ID of the datacenter where the Network File Storage cluster is located.
ipAddress This property is required. String
The IP address and prefix of the Network File Storage cluster. The IP address can be either IPv4 or IPv6. The IP address has to be given with CIDR notation.
lan This property is required. String
The Private LAN to which the Network File Storage cluster must be connected.

GetNfsClusterNf

MinVersion This property is required. string
The minimum supported version of the NFS cluster. Default is 4.2
MinVersion This property is required. string
The minimum supported version of the NFS cluster. Default is 4.2
minVersion This property is required. String
The minimum supported version of the NFS cluster. Default is 4.2
minVersion This property is required. string
The minimum supported version of the NFS cluster. Default is 4.2
min_version This property is required. str
The minimum supported version of the NFS cluster. Default is 4.2
minVersion This property is required. String
The minimum supported version of the NFS cluster. Default is 4.2

Package Details

Repository
ionoscloud ionos-cloud/terraform-provider-ionoscloud
License
Notes
This Pulumi package is based on the ionoscloud Terraform Provider.
ionoscloud 6.7.6 published on Monday, Apr 14, 2025 by ionos-cloud