Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
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).
Note: Network File Storage is currently available on a request basis and will be initially available only in German data centers. To access this product, please contact your sales representative or IONOS Cloud Support.
For more information about:
VMs, see Cubes or Compute Engine.
VDCs, see and .
To get answers to the most commonly encountered questions about Network File Storage, see .
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.
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.
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 ( and versions).
IONOS Ltd. – .
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.
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.
Explore the key use cases for implementing Network File Storage.
Get started with creating and managing Network File Storage clusters and shares via the DCD.
Get started with creating and managing Network File Storage clusters and shares via the API.
IONOS Inc. – United States and Canada.
You can also integrate it with Kubernetes clusters to provide persistent storage for containerized workloads.
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.
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:
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.
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.
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:
Log in to the DCD with your username and password.
Go to Menu > Storage > Network File Storage.
Select an existing cluster and do the following to modify the cluster settings:
To delete a Network File Storage cluster, follow these steps:
Log in to the DCD with your username and password.
Go to Menu > Storage > Network File Storage. You will find a list of all the Network File Storage clusters.
Click in the OPTIONS column and select Delete Cluster.
To delete a share from a Network File Storage cluster, follow these steps:
Log in to the DCD with your username and password.
Go to Menu > Storage > Network File Storage.
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.
Usage mode
Shared
Minimum and maximum cluster size
2 TiB – 42 TiB
Maximum bandwidth
300 MB/s per 4 TiB with a 1 MiB block size
Maximum Read IOPS
24.000 IOPS per 4 TiB with a 4 KiB block size
Maximum Write IOPS
18.000 IOPS per 4 TiB with a 4 KiB block size
To set user privileges via the Cloud API to access and manage shares and Network File Storage clusters, follow these steps:
Authenticate to the Cloud API using your API credentials.
Create a user using the POST /cloudapi/v6/um/users endpoint.
Set the following required parameters for the user: user's name, email address, and password.
Create a group using the POST /cloudapi/v6/um/groups endpoint.
Set accessAndManageNFS privilege to true.
Assign the user to the created group using POST /cloudapi/v6/um/groups/{groupId}/users endpoint.
Result: The user has the privilege to access and manage Network File Storage.
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.
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.
RESULT: A message confirms that the cluster update is successful.
Alternatively, you can also click on the NAME of the cluster and choose Delete Cluster on the Cluster Details window.
Select Delete in the dialog box to confirm deletion.
Result: The STATUS of the respective Network File Storage cluster is set to DESTROYING before it is completely deleted.
Click in the ACTIONS column and select Delete Share in the Manage Shares window.
Select Delete in the dialog box to confirm deletion.
Result: The STATE of the respective share within the Network File Storage cluster is set to DESTROYING before it is completely deleted.
You can grant appropriate privileges via the User Manager, so your users can create and manage shares and Network File Storage clusters. Without necessary privileges, they have read-only access and cannot provision changes.
To allow users to create and manage shares, follow these steps:
Log in to DCD with your username and password.
Go to Menu > Management, and select Users & Groups under Users.
Select Groups tab in the User Manager window.
or select an existing group to assign relevant privileges.
In the Privileges tab, select Access and manage Network File Storage to allow the group members to create and use Network File Storage.
In the Members tab, add users to the group that you wish to authorize to use Network File Storage.
Result: Appropriate privilege is granted to the group and the users in the respective group.
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:
Log in to the DCD with your username and password.
Go to Menu > Storage > Network File Storage.
Result: A list of all clusters are displayed: — NAME: Displays the name of the cluster. Select the name to view its details in the window. — STATE: Displays the state of the respective cluster: — BUSY: When the cluster is in the creation mode or it is being updated. — AVAILABLE: When the cluster is available and healthy. — DESTROYING: When the cluster is being deleted. — FAILED: When the cluster is not accessible due to an error. — SIZE: Displays the size of the respective cluster. — CREATION DATE: Displays the date of creation of the cluster. — OPTIONS: Select to perform the following: — View Cluster: Displays the cluster settings. The Change cluster settings window is displayed. You can change the Cluster Name and its Size. Click Save to save the settings. — Edit Cluster: Modify and manage the cluster settings. — Manage Shares: Manage the shares that are associated with the respective cluster. — x Delete Cluster: Delete the chosen cluster. In the dialog box that appears, select Delete to confirm deletion. For more information, see .
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:
Log in to the DCD with your username and password.
Go to Menu > Storage > Network File Storage.
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.
Result: A list of all shares associated with the respective cluster are displayed. You can view the following details: — NAME: Displays the name of the share. Select the name to view its details. — QUOTA: Displays the respective share's quota in MiB. — GID: Displays the respective share owner's group ID. — UID: Displays the respective share owner's user ID. — CLIENT GROUPS: Displays the number of client groups that are associated with the respective share. — ACTIONS: Select to perform the following: — View/Edit Share: Select the option to either view or edit its or via the View / Edit Share window. Click Save to save the updates. — Copy ShareId: Select the option to copy the corresponding share ID. — x Delete Share: Select the option to delete the chosen share and select Delete in the dialog box to confirm deletion. For more information, see .
You can delete a specific cluster using its clusterId.
Use the regional endpoints to delete a cluster:
https://nfs.de-txl.ionos.com/clusters/{clusterId}
https://nfs.de-fra.ionos.com/clusters/{clusterId}
To make authenticated requests to the API, the following fields are mandatory in the request header:
A 202 message confirms that the specified cluster has been successfully deleted.
Network File Storage has its own set of limitations. For more information, see Technical Specifications and Limitations.
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.
A cluster represents a directory with individual file systems, called shares, within the Network File Storage cluster.
Only contract administrators, owners, and users with Access and Manage Network File Storage privilege are allowed to create a cluster. You can set the privilege via the DCD group privileges. For more information, see .
Detailed file-level access and performance telemetry.
Learn how to manage a Network File Storage cluster.
Learn how to delete a Network File Storage cluster.
Learn how to create shares within a Network File Storage cluster.
Learn how to view and manage shares that are associated with a Network File Storage cluster.
Learn how to delete a share from a Network File Storage cluster.
Below is the list of mandatory path parameter:
clusterId
string
The ID (UUID) of the Cluster.
e69b22a5-8fee-56b1-b6fb-4a07e4205ead
Authorization
yes
string
You can use Basic Authentication or a Bearer token. For more information, see Authentication.
Content-Type
yes
string
Set this to application/json.
curl -X 'DELETE' \
'https://nfs.de-txl.ionos.com/clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead' \
-H 'accept: application/json'
-H 'Authorization: Basic <auth-token>'To create a Network File Storage cluster, follow these steps:
Log in to the DCD with your username and password.
Go to Menu > Storage > Network File Storage.
Select Create Cluster to create a new cluster.
Enter the following details in the Create Cluster window:
Click Save to create the cluster.
Result: Your Network File Storage Cluster is created and is currently in a BUSY state.
To define cluster properties, specify the following:
Cluster Name: Enter an appropriate name for your cluster.
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.
Size: Select the size of the Network File Storage cluster in TiB using the slider. The size determines the billing fees.
File System Version: By default, the cluster supports the latest NFS protocol version NFSv4.2.
You can also follow the steps mentioned in the Finding your Private IP address section on the right side to retrieve an IP address.
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.
Datacenter LAN: Select a LAN to which the Network File Storage cluster must be connected in the data center.
Private IPv4 IP: Enter a private IP address or the subnet using the available Private IPs.
Learn how to retrieve all clusters of a Network File Storage.
Learn how to update a cluster via the API.
Learn how to delete a cluster via the API.
Learn how to create a share within a cluster.
Learn how to retrieve a specific share.
Learn how to retrieve all shares of a cluster.
Learn how to update a specific share via the API.
Learn how to delete a share from within the cluster via the API.
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
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: [email protected]:password.
Token Authentication: Provide a header value as Bearer followed by your token.
Important: From March 15, 2024, the Basic Authentication option will only be accessible if the 2-factor Authentication (2FA) is disabled for your account.
Learn how to set user privileges for Network File Storage via the API.
Learn how to create a cluster for Network File Storage.
Learn how to retrieve a specific cluster.
You can retrieve the information about a specific cluster using its clusterId.
Use the regional endpoints to retrieve a specific cluster:
https://nfs.de-txl.ionos.com/clusters/{clusterId}
https://nfs.de-fra.ionos.com/clusters/{clusterId}
To make authenticated requests to the API, the following fields are mandatory in the request header:
A 200 message confirms that the specific cluster information is successfully retrieved.
A share represents individual file systems within the Network File Storage cluster. Each cluster can contain multiple shares within it.
Only contract administrators, owners, and users with Access and Manage Network File Storage privilege are allowed to create shares. You can set the privilege via the DCD group privileges. For more information, see .
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.
Below is the list of mandatory path parameter:
clusterId
string
The ID (UUID) of the Cluster.
e69b22a5-8fee-56b1-b6fb-4a07e4205ead
Authorization
yes
string
You can use Basic Authentication or a Bearer token. For more information, see Authentication.
Content-Type
yes
string
Set this to application/json.
curl -X 'GET' \
'https://nfs.de-txl.ionos.com/clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead' \
-H 'accept: application/json'{
"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
}
} ```To create a share within a Network File Storage cluster, follow these steps:
Log in to the DCD with your username and password.
Go to Menu > Storage > Network File Storage.
Select a cluster from the list of clusters and select Manage Shares from the OPTIONS column.
Select Create Share in the Manage shares window and enter the following details:
Click Save to create a share.
Result: A share is created within the selected Network File Storage Cluster.
To define share properties, specify the following details:
Name: Enter an appropriate name for the share.
(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.
(Optional) GID: The ID of the group that owns the exported share. The default value is 512.
(Optional) UID: The ID of the user who owns the exported directory. The default value is 512.
Multiple VMs from within a VDC can be connected to shares of a Network File Storage's cluster via a private LAN.
(Optional) Description: Enter necessary information about the client group.
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.
Hosts: Select + Add Host to add the number of VMs that is allowed to access the share. Example: 10.234.62.123.
NFS Squash Mode: Select a squash mode for export. For more information, see . 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.
Use the regional endpoints to retrieve all shares:
https://nfs.de-txl.ionos.com/clusters/{clusterId}/shares
https://nfs.de-fra.ionos.com/clusters/{clusterId}/shares
To make authenticated requests to the API, the following fields are mandatory in the request header:
Authorization
yes
string
You can use Basic Authentication or a Bearer token. For more information, see .
Content-Type
yes
string
Set this to application/json.
Below is the list of mandatory path parameter:
A 200 message confirms that all shares from within the specific cluster are successfully retrieved.
Use the regional endpoints to delete a specific share:
https://nfs.de-txl.ionos.com/clusters/{clusterId}/shares/{shareId}.
https://nfs.de-fra.ionos.com/clusters/{clusterId}/shares/{shareId}
To make authenticated requests to the API, the following fields are mandatory in the request header:
Authorization
yes
string
You can use Basic Authentication or a Bearer token. For more information, see .
Content-Type
yes
string
Set this to application/json.
Below is the list of mandatory path parameters:
A 202 message confirms that the specified share has been successfully deleted.
You can retrieve the information about a specific share using its clusterId and shareId.
Use the regional endpoints to retrieve a specific share:
https://nfs.de-txl.ionos.com/clusters/{clusterId}/shares/{shareId}
https://nfs.de-fra.ionos.com/clusters/{clusterId}/shares/{shareId}
To make authenticated requests to the API, the following fields are mandatory in the request header:
A 200 message confirms that the information of the specific share from within the cluster has been successfully retrieved.
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.
Use the regional endpoints to retrieve all clusters:
https://nfs.de-txl.ionos.com/clusters
https://nfs.de-fra.ionos.com/clusters
To make authenticated requests to the API, the following fields are mandatory in the request header:
A 200 message confirms that a list of clusters is fetched.
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.
Use the regional endpoints to create a share:
https://nfs.de-txl.ionos.com/clusters/{clusterId}/shares
https://nfs.de-fra.ionos.com/clusters/{clusterId}/shares
To make authenticated requests to the API, the following fields are mandatory in the request header:
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.
You can append or update the content of an existing share within your Network File Storage using the PUT API request.
Use the regional endpoints to update a share:
https://nfs.de-txl.ionos.com/clusters/{clusterId}/shares/{shareId}
https://nfs.de-fra.ionos.com/clusters/{clusterId}/shares/{shareId}
To make authenticated requests to the API, the following fields are mandatory in the request header:
A 200 message confirms that the corresponding share within the specified cluster has been successfully updated.
To create a Network File Storage cluster via the API, perform a POST request with the name and description of the cluster.
curl -X 'GET' \
'https://nfs.de-txl.ionos.com/clusters/e69b22a5-8fee-56b1-b6fb-4a07e4205ead/shares?offset=0&limit=100' \
-H 'accept: application/json'{
"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"
}
} ```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'clusterId
string
The ID (UUID) of the Cluster.
e69b22a5-8fee-56b1-b6fb-4a07e4205ead
clusterId
string
The ID (UUID) of the cluster.
e69b22a5-8fee-56b1-b6fb-4a07e4205ead
shareId
string
The ID (UUID) of the share.
7b1ef56d-dfc6-51fe-aff0-7af2d6747868
Below is the list of mandatory path parameters:
clusterId
string
The ID (UUID) of the cluster.
e69b22a5-8fee-56b1-b6fb-4a07e4205ead
shareId
string
The ID (UUID) of the share.
7b1ef56d-dfc6-51fe-aff0-7af2d6747868
Authorization
yes
string
You can use Basic Authentication or a Bearer token. For more information, see Authentication.
Content-Type
yes
string
Set this to application/json.
Authorization
yes
string
You can use Basic Authentication or a Bearer token. For more information, see Authentication.
Content-Type
yes
string
Set this to application/json.
Below is the list of mandatory path parameter:
clusterId
string
The ID (UUID) of the Cluster.
e69b22a5-8fee-56b1-b6fb-4a07e4205ead
Authorization
yes
string
You can use Basic Authentication or a Bearer token. For more information, see Authentication.
Content-Type
yes
string
Set this to application/json.
Authorization
yes
string
You can use Basic Authentication or a Bearer token. For more information, see Authentication.
Content-Type
yes
string
Set this to application/json.
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'{
"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"
}
}
]
}
} ```curl -X 'GET' \
'https://nfs.de-txl.ionos.com/clusters?offset=0&limit=100' \
-H 'accept: application/json'{
"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"
}
} ```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"
}
}
]
}
}'{
"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"
}
}
]
}
} ```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"
}
}
]
}
}'{
"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"
}
}
]
}
}https://nfs.de-fra.ionos.com/clusters/{clusterId}
To make authenticated requests to the API, the following fields are mandatory in the request header:
Authorization
yes
string
You can use Basic Authentication or a Bearer token. For more information, see .
Content-Type
yes
string
Set this to application/json.
A 200 message confirms that the specified cluster is successfully updated.
Use the regional endpoints to create a cluster:
https://nfs.de-txl.ionos.com/clusters
https://nfs.de-fra.ionos.com/clusters
To make authenticated requests to the API, the following fields are mandatory in the request header:
Authorization
yes
string
You can use Basic Authentication or a Bearer token. For more information, see .
Content-Type
yes
string
Set this to application/json.
Below is the list of mandatory body parameters:
A 201 message confirms that the cluster creation is successful.
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
}
}'{
{
"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"
}
}
} ```curl -X 'POST' \
'https://nfs.de-txl.ionos.com/clusters' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"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
}
}'{
"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
}
} ```string
The LAN to which the NFS cluster should be connected.
1
ipAddress
string
The IP address and prefix of the NFS cluster. The IP address can be either IPv4 or IPv6. The IP address must include the CIDR notation.
10.254.64.1/24
name
string
The human-readable name of your cluster.
NFS cluster
datacenterId
string
The ID of the data center where the NFS cluster is located in.
e69b22a5-8fee-56b1-b6fb-4a07e4205ead
lan