HA-NAS - API Quickstart
223 Views
20.07.2022 
Cloud / NAS-HA
Objective
The OVHcloud HA-NAS service allows you to manage file storage that can be accessed over a network.
This guide provides an overview of how to use your HA-NAS service via the OVHcloud API.
Requirements
- An OVHcloud HA-NAS service
- Consulting the OVHcloud API first steps guide to familiarise yourself with the OVHcloud APIv6
Instructions
All API routes in this guide are available in the section /dedicated/nasha: https://api.ovh.com/console/#/dedicated/nasha.
When using the API, all fields marked with an asterisk (*) are required.
Retrieving information about your service
All your active services can be retrieved by using the following route:
Creating a partition
Use the following route to create a new partition:
| Parameter | Required | Description |
|---|---|---|
serviceName | Yes | The internal name of your HA-NAS service |
partitionDescription | Optional description | |
partitionName | Yes | A name for the partition |
protocol | Yes | NFS, CIFS, or NFS_CIFS for both |
size | Yes | The size of the partition |
Choose NFS as protocol and a size of 10 Gigabytes, for example.
Adding an ACL entry to access the partition
Access is denied by default unless granted via the ACL. Only IP addresses attached to your OVHcloud services can be added.
You can verify the IP addresses that are eligible for access via the following API calls:
| Parameter | Required | Description |
|---|---|---|
serviceName | Yes | The internal name of your HA-NAS service |
partitionName | Yes | Name of the partition |
To create a new ACL entry that will allow you to connect to your partition, use the following route:
| Parameter | Required | Description |
|---|---|---|
serviceName | Yes | The internal name of your HA-NAS service |
partitionName | Yes | Name of the partition |
ip | Yes | The IP address or range to be granted access |
type | Yes | ACL access type for this entry: readonly or readwrite |
Use CIDR notation for IP ranges, for example: 192.0.2.0/24.
Creating a manual snapshot
To add a manual snapshot, use the following route:
| Parameter | Required | Description |
|---|---|---|
serviceName | Yes | The internal name of your HA-NAS service |
partitionName | Yes | Name of the partition |
expiration | An optional expiration date, for example: 2022-06-24 (ISO 8601) | |
name | Yes | A name for the snapshot |
Deleting a partition
Use the following route to delete a partition:
| Parameter | Required | Description |
|---|---|---|
serviceName | Yes | The internal name of your HA-NAS service |
partitionName | Yes | Name of the partition |
Go further
Mount your NAS on Windows Server via CIFS
If you need training or technical assistance to implement our solutions, contact your sales representative or click on this link to get a quote and ask our Professional Services experts for assisting you on your specific use case of your project.
Join our community of users on https://community.ovh.com/en/.
Getting started with a HA-NAS solution
278