HA-NAS - API Quickstart

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://ca.api.ovh.com/console/#/dedicated/nasha.

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:

API:

POST /dedicated/nasha/{serviceName}/partition

Parameters:

serviceName *

The internal name of your HA-NAS service

partitionDescription

Optional description

partitionName *

A name for the partition

protocol *

NFS, CIFS, or NFS_CIFS for both

size *

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

You can verify the IP addresses that are eligible for access via the following API calls:

API:

GET /dedicated/nasha/{serviceName}/partition/{partitionName}/authorizableIps

GET /dedicated/nasha/{serviceName}/partition/{partitionName}/authorizableBlocks

Parameters:

serviceName *

The internal name of your HA-NAS service

partitionName *

Name of the partition

To create a new ACL entry that will allow you to connect to your partition, use the following route:

API:

POST /dedicated/nasha/{serviceName}/partition/{partitionName}/access

Parameters:

serviceName *

The internal name of your HA-NAS service

partitionName *

Name of the partition

ip *

The IP address or range to be granted access

type *

ACL access type for this entry: readonly or readwrite

Creating a manual snapshot

To add a manual snapshot, use the following route:

API:

POST /dedicated/nasha/{serviceName}/partition/{partitionName}/customSnapshot

Parameters:

serviceName *

The internal name of your HA-NAS service

partitionName *

Name of the partition

expiration

An optional expiration date, for example: 2022-06-24 (ISO 8601)

name *

A name for the snapshot

Deleting a partition

Use the following route to delete a partition:

API:

DELETE /dedicated/nasha/{serviceName}/partition/{partitionName}

Parameters:

serviceName *

The internal name of your HA-NAS service

partitionName *

Name of the partition

Go further

Mount your NAS via NFS share

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/.