Network File Storage is a managed service that uses the Network File System (NFS) protocol to offer shared file storage to numerous Virtual Machines (VMs) within the Virtual Data Center (VDC).

For more information about:

• VMs, see Cubes or Compute Engine.

• VDCs, see Data Center Designer and Basic Tutorials.

Product Overview

Quick Links

Developer Tools

Frequently Asked Questions (FAQs)

To get answers to the most commonly encountered questions about Network File Storage, see FAQs.

Network File Storage uses the NFS protocol to provide shared data storage accessible to your VMs via a private network. It allows fine-grained POSIX permissions at file and directory levels. You can provision a shared Network File Storage using the protocol. It enables easy data sharing between the connected VMs, all while benefiting from the reliability and security of a cloud-based storage solution.

During cluster creation, you must specify an IP address from your LAN for the cluster. The specified IP address is used as a floating IP address for the two VMs that the Network File Storage uses to provide high availability.

As seen in the illustration, you create a cluster within the Network File Storage and create shares within a cluster. Multiple VMs from within a VDC are connected to shares of a Network File Storage's cluster via a private LAN.

Each cluster can contain multiple shares within it. Shares are individual file systems within the storage. For example, you can imagine it as a cluster being a computer and shares are folders within it that are accessed by VMs. An administrator can allow VMs to use specific shares.

VMs on the same private network can connect to the Network File Storage's cluster. In addition, data can be accessed simultaneously from multiple compute instances (for example, VMs, and containers) without compromising data consistency. Multiple VMs from within the VDC can access the data simultaneously.

IONOS manages maintenance operations, such as software updates and hardware replacement, by offering redundant, high-availability cluster services.

You can also integrate it with Kubernetes clusters to provide persistent storage for containerized workloads.

Features

• SSD Storage: Supports swift data retrieval and reliable data storage.

• Storage Size: The minimum cluster size is 2 TiB and the maximum cluster size is 42 TiB. It is a usable space; hence, you do not have to reserve free space for optimal performance.

• NFSv4.2: The latest NFS protocol version, NFSv4.2, allows standard read and write operations directly to storage.

• Encryption at rest: Provides encryption at rest, by default.

• Root squash security: Network File Storage's built-in security mechanism reduces the risk of unauthorized root-level access from the client machine to the NFS server. Enabling this feature prevents superuser privileges to the root user on a client machine. It also prevents potential attacks on the NFS server when the client machine is compromised.

Benefits

• High Performance & Reliability: NFSv4.2 protocol provides high availability and durability and the following benefits:

  • Reduced protocol overhead with compound operations and caching.

  • Efficient file operations with minimal server interaction.

  • Live data movement without interruption.

  • Detailed file-level access and performance telemetry.

• Seamless Management: Benefit from proactive IT infrastructure management and maintenance with IONOS’s managed Network File Storage.

• Efficient Data Sharing: Easily distribute and manage data across multiple VMs within a VDC, with centralized data organization and fine-grained POSIX access control.

The billing for Network File Storage is based on the cluster size. The data transfer between the Network File Storage and VMs is not tracked and free.

The initial cluster size must be between 2 TiB and 42 TiB, increasing in 1 TiB increments. All cluster space is fully usable. After creation, the cluster size can only be increased, not decreased.

Prices are listed in the respective price lists:

• IONOS SE – International, including Austria, France, Germany and Italy (English and German versions).

• IONOS Ltd. – United Kingdom.

• IONOS Inc. – United States and Canada.

The following use cases have been derived to meet your business needs based on the features and benefits of Network File Storage:

• Network File Storage for user home directories: Host user home directories in a networked environment where user data, including home directories, are stored and managed centrally.

• Shared storage for databases and application servers: With Network File Storage—central storage for your databases and application servers—you can enable seamless and secure access to the shared database and application server. It also optimizes storage costs through efficient usage and scaling mechanisms.

• Store web content and serve it to multiple web servers: It provides centralized cloud-based storage for web content accessible by multiple servers, thus simplifying content management and ensuring content uniformity.

Resilience

VMs are mounted on the POSIX-compliant exported file system inside a local mount point. It provides a fully managed and scalable storage on file level. The service manages all the file storage infrastructure, meaning you can avoid the complexity of deploying, patching, maintaining and scaling complex file system configurations. The service is highly scalable, highly available, and highly durable.

Currently, the Network File Storage is based on the Solid State Drive (SSD) - Standard performance class. Data is stored on two storage servers, providing active-active redundancy. For additional data protection, every storage server is based either on a hardware or a software RAID system.

Performance

Currently, the Network File Storage is based on the SSD Standard performance class, which is recommended for instant data access.

The table below lists the drive types and their specifications:

Security

• Encryption at rest involves encrypting data stored on physical media. It protects data from unauthorized access when the data is not actively being used. Network File Storage is based on Block Storage, and it implements encryption at rest.

• Secure deletion ensures that once data is deleted, it cannot be restored, even with access to the physical media. Network File Storage is based on Block Storage, and it implements secure deletion.

Limitations

• Network File Storage is currently limited to German data centers.

• The cluster size cannot be decreased despite deleting some shares or data within them; the cluster will not shrink.

You can retrieve a list of all Network File Storage clusters in your contract. The number of results displayed on each page depends on the following values:

• limit limits the number of response elements.

• offset specifies the starting point within the collection of resource results returned from the server.

Additionally, you can also use a response filter (filter.datacenterId) to list only the clusters within the specified data center.

Endpoint

Use the regional endpoints to retrieve all clusters:

• Berlin, Germany: https://nfs.de-txl.ionos.com/clusters

• Frankfurt, Germany: https://nfs.de-fra.ionos.com/clusters

• Paris, France: https://nfs.fr-par.ionos.com/clusters

• London, Great Britain: https://nfs.gb-lhr.ionos.com/clusters

• Logroño, Spain: https://nfs.es-vit.ionos.com/clusters

• Las Vegas, United States: https://nfs.us-las.ionos.com/clusters

• Newark, United States: https://nfs.us-ewr.ionos.com/clusters

• Lenexa, United States: https://nfs.us-mci.ionos.com/clusters

The region 'Worcester, GB' will follow shortly.

Request

Response

A 200 message confirms that a list of clusters is fetched.

To create a Network File Storage cluster via the API, perform a POST request with the name and description of the cluster.

Endpoint

Use the regional endpoints to create a cluster:

• Berlin, Germany: https://nfs.de-txl.ionos.com

• Frankfurt, Germany: https://nfs.de-fra.ionos.com

• Paris, France: https://nfs.fr-par.ionos.com

• London, Great Britain: https://nfs.gb-lhr.ionos.com

• Logroño, Spain: https://nfs.es-vit.ionos.com

• Las Vegas, United States: https://nfs.us-las.ionos.com

• Newark, United States: https://nfs.us-ewr.ionos.com

• Lenexa, United States: https://nfs.us-mci.ionos.com

The region 'Worcester, GB' will follow shortly.

Request

Response

A 201 message confirms that the cluster creation is successful.

After creation, you can view the list of Network File Storage clusters or delete an existing one if it is no longer required.

To view a list of the clusters, follow these steps:

1. Log in to the DCD with your username and password.

2. Go to Menu > Storage > Network File Storage.

Quick Links

A cluster represents a directory with individual file systems, called shares, within the Network File Storage cluster.

Create a Cluster

To create a Network File Storage cluster, follow these steps:

1. Log in to the DCD with your username and password.

2. Go to Menu > Storage > Network File Storage.

1. Select Create Cluster to create a new cluster.

1. Enter the following details in the Create Cluster window:

   • Define Cluster Properties

   • Associate a Data Center LAN with the Cluster

2. Click Save to create the cluster.

Define Cluster Properties

To define cluster properties, specify the following:

1. Cluster Name: Enter an appropriate name for your cluster.

2. Location: This product is currently available in the German data centers. The value is set to Germany / Berlin, by default. Select a value from the drop-down list to change the data center.

3. Size: Select the size of the Network File Storage cluster in TiB using the slider. The size determines the billing fees.

4. File System Version: By default, the cluster supports the latest NFS protocol version NFSv4.2.

Associate a Data Center LAN with the Cluster

You can also follow the steps mentioned in the Finding your Private IP address section on the right side to retrieve an IP address.

1. Datacenter: Select a data center from the drop-down list to associate it with the cluster. The datacenter indicates the location of the Network File Storage cluster. The available data centers in the drop-down list vary according to the chosen Location. For more information, see Define cluster properties. Currently, the product is available only in the data centers in Germany.

2. Datacenter LAN: Select a LAN to which the Network File Storage cluster must be connected in the data center.

3. Private IPv4 IP: Enter a private IP address or the subnet using the available Private IPs.

To delete a Network File Storage cluster, follow these steps:

1. Log in to the DCD with your username and password.

2. Go to Menu > Storage > Network File Storage. You will find a list of all the Network File Storage clusters.

3. Click in the OPTIONS column and select Delete Cluster.

Alternatively, you can also click on the NAME of the cluster and choose Delete Cluster on the Cluster Details window.

1. Select Delete in the dialog box to confirm deletion.

A share represents individual file systems within the Network File Storage cluster. Each cluster can contain multiple shares within it.

Create a Share

To create a share within a Network File Storage cluster, follow these steps:

1. Log in to the DCD with your username and password.

2. Go to Menu > Storage > Network File Storage.

3. Select a cluster from the list of clusters and select Manage Shares from the OPTIONS column.

1. Select Create Share in the Manage shares window and enter the following details:

   • Define Share Properties

   • Add Client Groups

1. Click Save to create a share.

Define Share Properties

To define share properties, specify the following details:

1. Name: Enter an appropriate name for the share.

2. (Optional) Quota: Specify the quota in MiB to restrict the amount of data that can be stored within the export file. Set the value to zero, if you want to disable the quota for export.

3. (Optional) GID: The ID of the group that owns the exported share. The default value is 512.

4. (Optional) UID: The ID of the user who owns the exported directory. The default value is 512.

Add Client Groups

Multiple VMs from within a VDC can be connected to shares of a Network File Storage's cluster via a private LAN.

1. (Optional) Description: Enter necessary information about the client group.

2. IP Networks: Select + Add IP Network to add an IP address with the mask CIDR notation. The specified network therefore becomes an authorized network while restricting access to all other networks. Example: 127.0.0.1/24.

1. Hosts: Select + Add Host to add the number of VMs that is allowed to access the share. Example: 10.234.62.123.

2. NFS Squash Mode: Select a squash mode for export. For more information, see Root squash security. You can choose one of the following:

   • None: Select if you do not want a squash mode. For security reasons, we do not recommend setting the mode to None.

   • Root Anonymous: Select to map a root user to an anonymous user.

   • All Anonymous: Select to map all users to anonymous user.

After creation, you can view the list of Network File Storage clusters, modify the settings, or delete an existing cluster if it is not required.

To manage clusters, follow these steps:

1. Log in to the DCD with your username and password.

2. Go to Menu > Storage > Network File Storage.

3. Select an existing cluster and do the following to modify the cluster settings:

   • click on the NAME of the cluster and select the Change cluster settings option in the Cluster Details window which will redirect you to the Change cluster settings window.

   • select Edit Cluster from the OPTIONS column and the Change cluster settings window is displayed.
4. Make the necessary modifications in the Change cluster settings window. You can only update the Cluster Name and its Size.

Additionally, you can click the Manage Shares tab to update the shares. To delete the respective cluster, click x Delete Cluster. For more information, see Delete a Network File Storage Cluster.

You can retrieve the information about a specific cluster using its clusterId.

Endpoint

Use the regional endpoints to retrieve a specific cluster:

• Berlin, Germany: https://nfs.de-txl.ionos.com/clusters/{clusterId}

• Frankfurt, Germany: https://nfs.de-fra.ionos.com/clusters/{clusterId}

• Paris, France: https://nfs.fr-par.ionos.com/clusters/{clusterId}

• London, Great Britain: https://nfs.gb-lhr.ionos.com/clusters/{clusterId}

• Logroño, Spain: https://nfs.es-vit.ionos.com/clusters/{clusterId}

• Las Vegas, United States: https://nfs.us-las.ionos.com/clusters/{clusterId}

• Newark, United States: https://nfs.us-ewr.ionos.com/clusters/{clusterId}

• Lenexa, United States: https://nfs.us-mci.ionos.com/clusters/{clusterId}

The region 'Worcester, GB' will follow shortly.

Request

Response

A 200 message confirms that the specific cluster information is successfully retrieved.

To delete a share from a Network File Storage cluster, follow these steps:

1. Log in to the DCD with your username and password.

2. Go to Menu > Storage > Network File Storage.

3. Select Manage Shares in the OPTIONS column of the cluster to delete shares. You will find a list of all the shares within the respective Network File Storage cluster.

1. Select Delete in the dialog box to confirm deletion.

Network File Storage APIs allow contract owners, administrators, and authenticated users with the required permissions to create clusters and shares within the storage system via the API.

Quick Links

Endpoint

Use the regional endpoints to interact with Network File Storage:

• Berlin, Germany: https://nfs.de-txl.ionos.com

• Frankfurt, Germany: https://nfs.de-fra.ionos.com

• Paris, France: https://nfs.fr-par.ionos.com

• London, Great Britain: https://nfs.gb-lhr.ionos.com

• Logroño, Spain: https://nfs.es-vit.ionos.com

• Las Vegas, United States: https://nfs.us-las.ionos.com

• Newark, United States: https://nfs.us-ewr.ionos.com

• Lenexa, United States: https://nfs.us-mci.ionos.com

The region 'Worcester, GB' will follow shortly.

Authentication

The API uses the following two authentication methods:

• Basic Authentication: Ensure that the string containing your username and password is base64-encoded and separated by a colon: username@domain.tld:password.

• Token Authentication: Provide a header value as Bearer followed by your token.

After creation, you can view the list of shares that are associated with a Network File Storage cluster. You can also delete an existing one if it is no longer required.

To view the list of shares, follow these steps:

1. Log in to the DCD with your username and password.

2. Go to Menu > Storage > Network File Storage.

3. Select Manage Shares from the OPTIONS column to view the shares associated with the respective cluster.

Alternatively, you can also click on the cluster's NAME and select the Manage Shares tab in the Manage shares window.

Here is a pivotal use case you can implement after configuring the Network File Storage via the DCD or the API:

Mount an NFS Volume on Debian-based Systems

What are the current limitations of Network File Storage?

Network File Storage has its own set of limitations. For more information, see Technical Specifications and Limitations.

What are the benefits of the NFSv4.2 protocol compared to NFSv3?

Currently, IONOS supports NFSv4.2, which is the latest version of the NFS protocol for Network File Storage. It allows standard Linux users to read and write directly to storage, scaling performance linearly for both IOPS and throughput, maximizing the limits of storage and network infrastructures. Some of its benefits are as follows:

• Reduced protocol overhead with compound operations and caching.

• Efficient file operations with minimal server interaction.

• Enhanced performance with multiple parallel network connections.

• Live data movement without interruption.

• Detailed file-level access and performance telemetry.

Overview

This tutorial will guide you through the process of mounting an Network File System (NFS) volume on Debian-based systems. It is intended for administrators who want to learn how to mount this type of volume. The configuration in the tutorial is specific to self-managed NFS 4.2 servers.

By the end of this tutorial, you will be able to mount an NFS volume on Debian-based Systems.

Pre-requisites

Ensure that:

• you have the appropriate access rights to mount NFS volumes.

• you have the following details: IONOS_TOKEN and NFS_CLUSTER_UUID. You can retrieve them from the DCD or using the API.

Procedure

export NFS_CLUSTER_IP=`curl -s -X GET -H 'accept: application/json' -H "Authorization: Bearer ${IONOS_TOKEN}" https://nfs.de-txl.ionos.com/clusters/${NFS_CLUSTER_UUID} | jq .properties.connections[].ipAddress | cut -c2- | cut -d'/' -f 1` 

export NFS_SHARE=`curl -s -X GET -H 'accept: application/json' -H "Authorization: Bearer ${IONOS_TOKEN}" https://nfs.de-txl.ionos.com/clusters/${NFS_CLUSTER_UUID}/shares | jq .items[].metadata.nfsPath | cut -d'"' -f2` 

Summary

In this tutorial, you have learned how to successfully mount an NFS volume and share on Debian-based Systems.

You can delete a specific cluster using its clusterId.

Endpoint

Use the regional endpoints to delete a cluster:

• Berlin, Germany: https://nfs.de-txl.ionos.com/clusters/{clusterId}

• Frankfurt, Germany: https://nfs.de-fra.ionos.com/clusters/{clusterId}

• Paris, France: https://nfs.fr-par.ionos.com/clusters/{clusterId}

• London, Great Britain: https://nfs.gb-lhr.ionos.com/clusters/{clusterId}

• Logroño, Spain: https://nfs.es-vit.ionos.com/clusters/{clusterId}

• Las Vegas, United States: https://nfs.us-las.ionos.com/clusters/{clusterId}

• Newark, United States: https://nfs.us-ewr.ionos.com/clusters/{clusterId}

• Lenexa, United States: https://nfs.us-mci.ionos.com/clusters/{clusterId}

The region 'Worcester, GB' will follow shortly.

Request

curl -X 'DELETE' \
  'https://nfs.de-txl.ionos.com/clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead' \
  -H 'accept: application/json'
  -H 'Authorization: Basic <auth-token>'

Response

A 202 message confirms that the specified cluster has been successfully deleted.

You can append a cluster, or update the content of an existing cluster within your Network File Storage using the PUT API request.

Endpoint

Use the regional endpoints to update a cluster:

• Berlin, Germany: https://nfs.de-txl.ionos.com/clusters/{clusterId}

• Frankfurt, Germany: https://nfs.de-fra.ionos.com/clusters/{clusterId}

• Paris, France: https://nfs.fr-par.ionos.com/clusters/{clusterId}

• London, Great Britain: https://nfs.gb-lhr.ionos.com/clusters/{clusterId}

• Logroño, Spain: https://nfs.es-vit.ionos.com/clusters/{clusterId}

• Las Vegas, United States: https://nfs.us-las.ionos.com/clusters/{clusterId}

• Newark, United States: https://nfs.us-ewr.ionos.com/clusters/{clusterId}

• Lenexa, United States: https://nfs.us-mci.ionos.com/clusters/{clusterId}

The region 'Worcester, GB' will follow shortly.

Request

curl -X 'PUT' \
  'https://nfs.de-fra.ionos.com/clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "id": "e69b22a5-8fee-56b1-b6fb-4a07e4205ead",
  "metadata": {},
  "properties": {
    "name": "Cluster 1",
    "connections": [
      {
        "datacenterId": "123e4567-e89b-12d3-a456-426614174001",
        "lan": "1",
        "ipAddress": "10.254.64.1/24"
      }
    ],
    "nfs": {
      "minVersion": "4.2"
    },
    "size": 8
  }
}'

Response

A 200 message confirms that the specified cluster is successfully updated.

{
 {
  "id": "ed17eb1f-ac43-5670-9e63-8be33c475449",
  "type": "collection",
  "href": "/clusters",
  "items": [
    {
      "id": "e69b22a5-8fee-56b1-b6fb-4a07e4205ead",
      "type": "cluster",
      "href": "/clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead",
      "metadata": {
        "createdDate": "2020-12-10T13:37:50+01:00",
        "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "lastModifiedDate": "2020-12-11T13:37:50+01:00",
        "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
        "status": "AVAILABLE",
        "statusMessage": null
      },
      "properties": {
        "name": "Cluster 1",
        "connections": [
          {
            "datacenterId": "123e4567-e89b-12d3-a456-426614174001",
            "lan": "1",
            "ipAddress": "10.254.64.1/24"
          }
        ],
        "nfs": {
          "minVersion": "4.2"
        },
        "size": 8
      }
    }
  ],
  "offset": 0,
  "limit": 42,
  "_links": {
    "prev": "http://PREVIOUS-PAGE-URI",
    "self": "http://THIS-PAGE-URI",
    "next": "http://NEXT-PAGE-URI"
  }
}
} ```

You can retrieve the list of all shares from within a cluster using its clusterId. The number of results displayed on each page depends on the following values:

• limit limits the number of response elements.

• offset specifies the starting point within the collection of resource results returned from the server.

Endpoint

Use the regional endpoints to retrieve all shares:

• Berlin, Germany: https://nfs.de-txl.ionos.com/clusters/{clusterId}/shares

• Frankfurt, Germany: https://nfs.de-fra.ionos.com/clusters/{clusterId}/shares

• Paris, France: https://nfs.fr-par.ionos.com/clusters/{clusterId}/shares

• London, Great Britain: https://nfs.gb-lhr.ionos.com/clusters/{clusterId}/shares

• Logroño, Spain: https://nfs.es-vit.ionos.com/clusters/{clusterId}/shares

• Las Vegas, United States: https://nfs.us-las.ionos.com/clusters/{clusterId}/shares

• Newark, United States: https://nfs.us-ewr.ionos.com/clusters/{clusterId}/shares

• Lenexa, United States: https://nfs.us-mci.ionos.com/clusters/{clusterId}/shares

The region 'Worcester, GB' will follow shortly.

Request

curl -X 'GET' \
  'https://nfs.de-txl.ionos.com/clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead/shares?offset=0&limit=100' \
  -H 'accept: application/json'

Response

A 200 message confirms that all shares from within the specific cluster are successfully retrieved.

{
  "id": "ce834630-97f2-56a7-bc99-4427e61d4714",
  "type": "collection",
  "href": "/clusters/{clusterId}/shares",
  "items": [
    {
      "id": "7b1ef56d-dfc6-51fe-aff0-7af2d6747868",
      "type": "share",
      "href": "/clusters/{clusterId}/shares/7b1ef56d-dfc6-51fe-aff0-7af2d6747868",
      "metadata": {
        "createdDate": "2020-12-10T13:37:50+01:00",
        "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "lastModifiedDate": "2020-12-11T13:37:50+01:00",
        "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
        "status": "AVAILABLE",
        "statusMessage": null,
        "nfsPath": "/data/example-export"
      },
      "properties": {
        "name": "example-export",
        "quota": 512,
        "clientGroups": [
          {
            "ipNetworks": [
              "10.234.50.0/24"
            ],
            "hosts": [
              "10.234.62.123"
            ],
            "nfs": {
              "squash": "all-anonymous"
            }
          }
        ]
      }
    }
  ],
  "offset": 0,
  "limit": 42,
  "_links": {
    "prev": "http://PREVIOUS-PAGE-URI",
    "self": "http://THIS-PAGE-URI",
    "next": "http://NEXT-PAGE-URI"
  }
} ```

You can retrieve the information about a specific share using its clusterId and shareId.

Endpoint

Use the regional endpoints to retrieve a specific share:

• Berlin, Germany: https://nfs.de-txl.ionos.com/clusters/{clusterId}/shares/{shareId}

• Frankfurt, Germany: https://nfs.de-fra.ionos.com/clusters/{clusterId}/shares/{shareId}

• Paris, France: https://nfs.fr-par.ionos.com/clusters/{clusterId}/shares/{shareId}

• London, Great Britain: https://nfs.gb-lhr.ionos.com/clusters/{clusterId}/shares/{shareId}

• Logroño, Spain: https://nfs.es-vit.ionos.com/clusters/{clusterId}/shares/{shareId}

• Las Vegas, United States: https://nfs.us-las.ionos.com/clusters/{clusterId}/shares/{shareId}

• Newark, United States: https://nfs.us-ewr.ionos.com/clusters/{clusterId}/shares/{shareId}

• Lenexa, United States: https://nfs.us-mci.ionos.com/clusters/{clusterId}/shares/{shareId}

The region 'Worcester, GB' will follow shortly.

Request

curl -X 'GET' \
  'https://nfs.de-txl.ionos.com/clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead/shares/7b1ef56d-dfc6-51fe-aff0-7af2d6747868' \
  -H 'accept: application/json'

Response

A 200 message confirms that the information of the specific share from within the cluster has been successfully retrieved.

{
  "id": "7b1ef56d-dfc6-51fe-aff0-7af2d6747868",
  "type": "share",
  "href": "/clusters/{clusterId}/shares/7b1ef56d-dfc6-51fe-aff0-7af2d6747868",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2020-12-11T13:37:50+01:00",
    "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
    "status": "AVAILABLE",
    "statusMessage": null,
    "nfsPath": "/data/example-export"
  },
  "properties": {
    "name": "example-export",
    "quota": 512,
    "clientGroups": [
      {
        "ipNetworks": [
          "10.234.50.0/24"
        ],
        "hosts": [
          "10.234.62.123"
        ],
        "nfs": {
          "squash": "all-anonymous"
        }
      }
    ]
  }
} ```

You can append or update the content of an existing share within your Network File Storage using the PUT API request.

Endpoint

Use the regional endpoints to update a share:

• Berlin, Germany: https://nfs.de-txl.ionos.com/clusters/{clusterId}/shares/{shareId}

• Frankfurt, Germany: https://nfs.de-fra.ionos.com/clusters/{clusterId}/shares/{shareId}

• Paris, France: https://nfs.fr-par.ionos.com/clusters/{clusterId}/shares/{shareId}

• London, Great Britain: https://nfs.gb-lhr.ionos.com/clusters/{clusterId}/shares/{shareId}

• Logroño, Spain: https://nfs.es-vit.ionos.com/clusters/{clusterId}/shares/{shareId}

• Las Vegas, United States: https://nfs.us-las.ionos.com/clusters/{clusterId}/shares/{shareId}

• Newark, United States: https://nfs.us-ewr.ionos.com/clusters/{clusterId}/shares/{shareId}

• Lenexa, United States: https://nfs.us-mci.ionos.com/clusters/{clusterId}/shares/{shareId}

The region 'Worcester, GB' will follow shortly.

Request

curl -X 'PUT' \
  'https://nfs.de-txl.ionos.com/clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead/shares/7b1ef56d-dfc6-51fe-aff0-7af2d6747868' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "id": "7b1ef56d-dfc6-51fe-aff0-7af2d6747868",
  "metadata": {},
  "properties": {
    "name": "example-export",
    "quota": 512,
    "clientGroups": [
      {
        "ipNetworks": [
          "10.234.50.0/24"
        ],
        "hosts": [
          "10.234.62.123"
        ],
        "nfs": {
          "squash": "all-anonymous"
        }
      }
    ]
  }
}'

Response

A 200 message confirms that the corresponding share within the specified cluster has been successfully updated.

{
  "id": "7b1ef56d-dfc6-51fe-aff0-7af2d6747868",
  "type": "share",
  "href": "/clusters/{clusterId}/shares/7b1ef56d-dfc6-51fe-aff0-7af2d6747868",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2020-12-11T13:37:50+01:00",
    "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
    "status": "AVAILABLE",
    "statusMessage": null,
    "nfsPath": "/data/example-export"
  },
  "properties": {
    "name": "example-export",
    "quota": 512,
    "clientGroups": [
      {
        "ipNetworks": [
          "10.234.50.0/24"
        ],
        "hosts": [
          "10.234.62.123"
        ],
        "nfs": {
          "squash": "all-anonymous"
        }
      }
    ]
  }
}

To create a share within the Network File Storage's cluster, via the API, perform a POST request with the clusterId. The request automatically creates a share within the respective cluster.

Endpoint

Use the regional endpoints to create a share:

• Berlin, Germany: https://nfs.de-txl.ionos.com/clusters/{clusterId}/shares

• Frankfurt, Germany: https://nfs.de-fra.ionos.com/clusters/{clusterId}/shares

• Paris, France: https://nfs.fr-par.ionos.com/clusters/{clusterId}/shares

• London, Great Britain: https://nfs.gb-lhr.ionos.com/clusters/{clusterId}/shares

• Logroño, Spain: https://nfs.es-vit.ionos.com/clusters/{clusterId}/shares

• Las Vegas, United States: https://nfs.us-las.ionos.com/clusters/{clusterId}/shares

• Newark, United States: https://nfs.us-ewr.ionos.com/clusters/{clusterId}/shares

• Lenexa, United States: https://nfs.us-mci.ionos.com/clusters/{clusterId}/shares

The region 'Worcester, GB' will follow shortly.

Request

curl -X 'POST' \
  'https://nfs.de-txl.ionos.com/clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead/shares' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "metadata": {},
  "properties": {
    "name": "example-export",
    "quota": 512,
    "clientGroups": [
      {
        "ipNetworks": [
          "10.234.50.0/24"
        ],
        "hosts": [
          "10.234.62.123"
        ],
        "nfs": {
          "squash": "all-anonymous"
        }
      }
    ]
  }
}'

Response

A 201 message confirms that the share creation is successful. Your values will differ from those in the sample code. It may contain different IDs, timestamps etc.

{
  "id": "7b1ef56d-dfc6-51fe-aff0-7af2d6747868",
  "type": "share",
  "href": "/clusters/{clusterId}/shares/7b1ef56d-dfc6-51fe-aff0-7af2d6747868",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2020-12-11T13:37:50+01:00",
    "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
    "status": "AVAILABLE",
    "statusMessage": null,
    "nfsPath": "/data/example-export"
  },
  "properties": {
    "name": "example-export",
    "quota": 512,
    "clientGroups": [
      {
        "ipNetworks": [
          "10.234.50.0/24"
        ],
        "hosts": [
          "10.234.62.123"
        ],
        "nfs": {
          "squash": "all-anonymous"
        }
      }
    ]
  }
} ```

You can delete a specific share from within a cluster using its clusterId and shareId.

Endpoint

Use the regional endpoints to delete a specific share:

• Berlin, Germany: https://nfs.de-txl.ionos.com/clusters/{clusterId}/shares/{shareId}

• Frankfurt, Germany: https://nfs.de-fra.ionos.com/clusters/{clusterId}/shares/{shareId}

• Paris, France: https://nfs.fr-par.ionos.com/clusters/{clusterId}/shares/{shareId}

• London, Great Britain: https://nfs.gb-lhr.ionos.com/clusters/{clusterId}/shares/{shareId}

• Logroño, Spain: https://nfs.es-vit.ionos.com/clusters/{clusterId}/shares/{shareId}

• Las Vegas, United States: https://nfs.us-las.ionos.com/clusters/{clusterId}/shares/{shareId}

• Newark, United States: https://nfs.us-ewr.ionos.com/clusters/{clusterId}/shares/{shareId}

• Lenexa, United States: https://nfs.us-mci.ionos.com/clusters/{clusterId}/shares/{shareId}

The region 'Worcester, GB' will follow shortly.

Request

curl -X 'DELETE' \
  'https://nfs.de-fra.ionos.com/clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead/shares/7b1ef56d-dfc6-51fe-aff0-7af2d6747868' \
  -H 'accept: application/json'

Response

A 202 message confirms that the specified share has been successfully deleted.