| title | excerpt | updated |
|---|---|---|
Configuring HYCU Backup |
Installing HYCU Backup on a Nutanix cluster |
2025-01-31 |
HYCU for Nutanix is a backup software available for Nutanix.
Find out how to install, configure and use HYCU on a Nutanix cluster with Object Storage storage provided by OVHcloud.
Warning
OVHcloud provides services for which you are responsible, with regard to their configuration and management. It is therefore your responsibility to ensure that they work properly.
This guide is designed to assist you as much as possible with common tasks. However, we recommend reaching out to the OVHcloud Professional Services team or a specialized provider if you encounter difficulties or have doubts regarding the administration, use, or setup of a service on a server.>
- A valid HYCU for OVHcloud license in your OVHcloud account (the first step of this guide will detail the procedure to follow) or a HYCU license purchased from a third-party provider.
- A Nutanix on OVHcloud cluster in your OVHcloud account.
- Access to your OVHcloud Control Panel.
- Access to the cluster via Prism Central.
- A Public Cloud project with a High Performance Object Storage type storage bucket, with a user with read and write permissions for this bucket. You can find more information on how to create a Public Cloud project and how to use the High Performance Object Storage service on the following pages:
- 60 GB of storage, 8 GB of memory, and 8 cores on your Nutanix Cluster for the HYCU Instance/Appliance.
- Order a HYCU for OVHcloud license
- Install and configure HYCU
- HYCU update
- Configure backups in HYCU
- Check the backup status
- Restore from HYCU
We offer different license packs based on the number of virtual machines (VMs) used by your Nutanix workloads.
[!success] For more information, visit our HYCU for OVHcloud page.
[!primary] You already have a HYCU license?
Continue reading this guide at the Install and configure HYCU step.
Log in to the OVHcloud Control Panel and navigate to Hosted Private Cloud{.action} and Storage and Backup{.action}.
Click on HYCU{.action} then All My Licenses{.action}.
{.thumbnail}
Click the Get Started{.action} button to choose and order a HYCU for OVHcloud pack.
Once your order is complete, you will receive a confirmation email and your subscription will appear in the All My Licenses{.action} dashboard.
Click on your license to proceed with activation.
Warning
This step requires that you have the HYCU software already installed and configured on your Nutanix cluster.
If you have not already done so, please read the Install and configure HYCU step of this guide before following the HYCU license activation step below.
/// details | Activate the HYCU license
When you click on a license in your dashboard, a menu will appear allowing you to rename, activate, renew, or cancel your HYCU for OVHcloud license.
Click the Activate License{.action} button (in the Shortcuts box).
{.thumbnail}
A window will open to upload the license request file.
{.thumbnail}
To obtain your license request file, log in to your Hybrid Cloud HYCU instance/appliance and go to the Licensing{.action} menu.
{.thumbnail}
Click Download Request{.action} and download the file.
{.thumbnail}
Back in the OVHcloud Control Panel, drag and drop the downloaded file into the open window, then click Activate{.action}.
{.thumbnail}
After verification, the status of your license will change to Active.
{.thumbnail}
Once the license is active, click the Download License{.action} button (at the bottom of the General Information box).
Return to the Licensing{.action} menu of your Hybrid Cloud HYCU instance/appliance and upload the license you just downloaded from the OVHcloud Control Panel.
{.thumbnail}
A window will inform you that your license has been validated.
{.thumbnail}
///
If your HYCU technical configuration has changed, you will need to make a new request to obtain a new license file compatible with your HYCU controller.
/// details | Regenerate a HYCU for OVHcloud license
Log in to the OVHcloud Control Panel and navigate to Hosted Private Cloud{.action} and Storage and Backup{.action}. Click on HYCU{.action}.
Once in your license dashboard, click the Regenerate License{.action} button (in the Shortcuts box).
{.thumbnail}
As with the activation of your license, download and upload your license request.
Then follow the same process as for license activation:
- Download the license key.
- Upload the license key to your Hybrid Cloud instance/appliance.
///
/// details | How to cancel a HYCU for OVHcloud subscription
Log in to the OVHcloud Control Panel and navigate to Hosted Private Cloud{.action} and Storage and Backup{.action}. Click on HYCU{.action}.
Once in your license dashboard, click Cancel License{.action} in the Subscription box.
{.thumbnail}
Then confirm the cancellation by typing TERMINATE in the provided box, then click Cancel{.action}.
{.thumbnail}
///
To upgrade your offer, you must first cancel your current HYCU for OVHcloud subscription (see above) and then order a new subscription with the required virtual machines pack.
Log in to Prism Central.
For more information on how to connect to the cluster, refer to the Go further section of this guide.
From the main menu, click Images{.action} from the Compute & Storage menu{.action}.
{.thumbnail}
Click Add Image{.action}.
{.thumbnail}
Choose URL{.action} as the source type, enter the URL https://download.hycu.com/ec/v4.X.X/hycu-4.X.X-XXXX.qcow2 in Enter Image URL, and click Upload file{.action}.
[!primary]
The URL used for the download is the latest version available on the HYCU website.
{.thumbnail}
Remove the .qcow2 extension behind the name and leave hycu-4.X.X-XXXX. Enter a description and click Next{.action}.
Warning
It is important to remove the extension in the name to facilitate the HYCU configuration process.
{.thumbnail}
Click Save{.action} to import the image.
{.thumbnail}
On the Prism Central dashboard, click the cluster name{.action} in the Cluster Quick Access section to go to the Prism Element.
{.thumbnail}
Go to the settings by clicking on the gear icon{.action}.
{.thumbnail}
Click Cluster Details{.action}.
{.thumbnail}
Enter an unused local IP address in Virtual IP and click Save{.action}.
{.thumbnail}
Check your choice and click Yes{.action}.
{.thumbnail}
The IP address is displayed in virtual IP.
{.thumbnail}
Click the gear to go to the Prism Element configuration.
{.thumbnail}
Scroll down the menu and click Local User Management{.action}.
{.thumbnail}
Click New User{.action}.
{.thumbnail}
Enter these values:
- Username:
svc_hycu - First Name:
HYCU - Last Name:
HYCU - Email:
[email protected] - Password:
password
[!primary] This information is provided as an example, the email address is mandatory but is not used.
Select the Cluster Admin{.action} checkbox and click Save{.action}.
{.thumbnail}
The user is then created.
{.thumbnail}
Go to Prism Central.
In the main menu, click VMs{.action} from the Compute & Storage{.action} menu.
{.thumbnail}
Click Create VM{.action}.
{.thumbnail}
Name the virtual machine and change the properties of the virtual machine with these settings:
- CPU:
4 vCPU - Cores Per CPU:
2 Cores - Memory:
8GB
Click Next{.action}.
{.thumbnail}
Click Attach Disk{.action}.
{.thumbnail}
Enter these values:
- Type:
Disk - Operation:
Clone from Image - Image:
hycu-4.X.X-XXXX
Click Save{.action}.
{.thumbnail}
Click Attach Disk{.action}.
{.thumbnail}
Choose these options:
- Type:
Disk - Operation:
Allocate on Storage Container - Image:
default-container - Capacity:
32Gib
Click Save{.action}.
{.thumbnail}
Click Attach to Subnet{.action}.
{.thumbnail}
Select the infra{.action} network from the Subnet drop-down menu, select Connected{.action} in the Network Connection State drop-down menu. Then click Save{.action}.
{.thumbnail}
Click Next{.action}.
{.thumbnail}
Create a yaml file by editing these values:
- < IP address >: The local IP address of the virtual machine with the subnet mask as XX.XX.XX.XX/XX.
- < GATEWAY >: Local gateway for the virtual machine to access the Internet.
- < DNS >: DNS used on the Internet.
#cloud-config
bootcmd:
- /opt/grizzly/bin/cloud_init_setup.sh hycubc < IP address > < GATEWAY > < DNS > `hycu.local,ntnx.local`Modify Guest Customisation options by selecting Cloud-init (Linux){.action} in the Script Type drop-down menu. Select Custom Script{.action} in the Configuration Method drop-down menu.
Copy the contents of the yaml script and paste it to the field below Clear Script. Then click Next{.action}.
{.thumbnail}
Click Create VM{.action}.
{.thumbnail}
Select the virtual machine created by using the checkbox{.action} to the right of the virtual machine.
{.thumbnail}
Click Power On{.action} in the Actions menu.
{.thumbnail}.
The virtual machine is started and has the IP address defined in cloud-init.
{.thumbnail}
In this section, we will configure a redirection so that you can configure HYCU using the web interface from outside your cluster.
In the OVHcloud Control Panel, select Bare Metal Cloud{.action}, then click on your Load Balancer{.action} in the menu bar on the left-hand side.
In the Server clusters{.action} tab, click Add a server cluster{.action}.
{.thumbnail}
Name your server cluster, then select TCP{.action} and enter this information:
- Port:
8443 - Datacenter:
ALL - Private network:
nutanix
Click Add{.action} to confirm the server farm creation.
{.thumbnail}
Click Add a server{.action}.
{.thumbnail}
Enter these values:
- Name (optional):
VM-HYCU - IPv4 address:
ipaddresshycu - Port:
8443
Click Add{.action} to confirm the cluster creation.
{.thumbnail}
Next, click on the Front-ends{.action} tab, and Add a front-end{.action}.
{.thumbnail}
Name your front-end, choose the TCP{.action} protocol, and modify these values:
- Port:
8443 - Datacenter:
ALL - Default server cluster:
HYCU (TCP)
Click Add{.action}.
{.thumbnail}
Click Apply configuration{.action}.
{.thumbnail}
Select the Datacenter{.action} and click Apply configuration{.action}.
{.thumbnail}
In the Tasks{.action} tab, you can track the progress of applying the changes.
{.thumbnail}
For more information on the OVHcloud Load Balancer, please refer to the Go further section of this guide.
Connect with a web browser to the HYCU administration interface, which should be similar to https://nutanixfqdncluster:8443. The fqdn variable corresponds to the URL provided when the Nutanix cluster was created.
Enter the default password and click Sign In{.action}.
{.thumbnail}
Change the login password for more security.
Click Change Password{.action} in the admin{.action} menu in the top right-hand corner of the interface.
{.thumbnail}
Enter the default password in the OLD PASSWORD field, the new password in the PASSWORD and CONFIRM PASSWORD fields.
Then click Save{.action}.
{.thumbnail}
We will now connect HYCU to the Nutanix cluster.
Click the Administration{.action} gear icon in the top right corner and choose Sources{.action}
{.thumbnail}
Enter information about Prism Element:
- URL:
https://url_prism_element_local:9440 - USERNAME:
Prism Element user - PASSWORD:
Prism Element user password
Click Next{.action}.
{.thumbnail}
Enter this information about Prism Central:
- URL:
https://url_prism_central_local:9440 - USERNAME:
Prism Central user - PASSWORD:
Prism Central password
Click Next{.action}.
{.thumbnail}
The VALIDATION SUCCESSFUL information appears to indicate that the entered information is correct. Click Save{.action}.
{.thumbnail}
Click Close{.action}.
{.thumbnail}
Select Targets{.action} in the menu on the left and click + Add{.action} in the top right of the interface.
{.thumbnail}
Enter the configuration settings and authentication keys for your Object Storage user with read/write access to the Object Storage bucket used as explained below:
- name Name
- Size: Storage size
- Type:
AWS S3/Compatible
Warning
OVHcloud High Performance Object Storage service has no storage limits and is billed on a per-use basis. In the HYCU software configuration, it is necessary to set a size as in the example below. You can of course choose another value.
Enable ENABLE COMPRESSION{.action} and scroll down through the window.
{.thumbnail}.
Complete the information:
- SERVICE ENDPOINT:
Object Storage URL - BUCKET NAME:
Bucket name - ACCESS KEY ID:
Object Storage User Access Key - SECRET ACCESS KEY:
Object Storage User Secret Key
Enable TARGET ENCRYPTION{.action} and click Save{.action}.
{.thumbnail}.
The target is enabled for Nutanix cluster backups.
{.thumbnail}.
HYCU regularly provides updates for which we detail the process below.
From the Prism Central main menu, click Images{.action} from the Compute & Storage{.action} menu.
{.thumbnail}
Click Add Image{.action}.
{.thumbnail}
Select URL{.action}.
Enter the URL for the qcow2 image of the latest version of HYCU, such as:
https://download.hycu.com/ec/v4.X.X/hotfixes/4.X.X-XXXX/hycu-4.X.X-XXXX.qcow2
[!primary]
The URL used for the download is the latest version available on the HYCU website.
Click Upload file{.action}.
{.thumbnail}
Remove the extension .qcow2 behind the name hycu-'4.X.X-XXXX, enter a description and click Next{.action}.
Warning
It is important to remove the extension in the name to facilitate the HYCU update process.
{.thumbnail}
Click Save{.action} to import the image.
{.thumbnail}
Log in via the URL provided when you created the Nutanix cluster, replacing the port https://fqdnclusternutanix:8443.
Go to the HYCU configuration by clicking the Administration{.action} gear icon and choose Power Options{.action}.
{.thumbnail}
Select Suspend All{.action}, check AUTO RESUME AFTER{.action} and leave the Hours field at 1{.action}, then click Save{.action}.
{.thumbnail}
Click Software Upgrade{.action} from the Administration{.action} gear menu.
{.thumbnail}
Choose the latest version from the AVAILABLE VERSIONS drop-down menu and click Software Upgrade{.action}.
{.thumbnail}
Click Yes{.action} to start the update process.
{.thumbnail}
A backup copy is made during the update process so that it can be restored if there are any issues.
{.thumbnail}
Log in to the HYCU administration interface.
Click the gear icon and click Power Options{.action}.
{.thumbnail}
Uncheck Suspend All{.action} and click Save{.action}.
{.thumbnail}
Virtual machine login passwords enable backup of applications such as a Microsoft SQL database or Exchange server.
Log in via the Virtual Machines{.action} menu on the left and click the key-shaped Credentials{.action} button at the top right of the interface.
{.thumbnail}
Click the +{.action} sign.
{.thumbnail}
Enter these values:
- NAME: password storage name
- PROTOCOL:
AUTOMATIC - USERNAME: virtual machine user account
- PASSWORD: password
Click Save{.action}.
{.thumbnail}
Click the +{.action} sign to add another account.
{.thumbnail}
Enter these values:
- NAME: password storage name
- PROTOCOL:
AUTOMATIC - USERNAME: virtual machine user account
- PASSWORD: password
Click Save{.action}.
{.thumbnail}
Click Close{.action}.
{.thumbnail}
Select the virtual machines that will use a password by ticking the box to the right of the virtual machine, then click the credentials{.action} key button.
{.thumbnail}
Select the password you want to use and click Assign{.action}.
{.thumbnail}
Select another virtual machine that will use a password by ticking the box to the right of the virtual machine, then click the credentials{.action} key button.
{.thumbnail}
Select the password you want to use and click Assign{.action}.
{.thumbnail}
Go to the policies{.action} menu on the left and click the +{.action} button in the top right corner.
{.thumbnail}
Enter this information:
- NAME:
HYCU VM - BACKUP EVERY:
4 hours - BACKUP THRESHOLD:
42
Leave the BACKUP{.action} option checked and use the scroll bar on the right.
{.thumbnail}
Click Save{.action}.
{.thumbnail}
This policy is created for the HYCU virtual machine.
In the policies menu, click the +{.action} button in the top right corner.
{.thumbnail}
Set the policy name BACKUP to Object Storage OVHcloud and local SNAPSHOTS{.action} in the NAME field.
Check the FAST RESTORE{.action} option, leave the BACKUP{.action} option checked.
Change the backup options in Backup and change the BACKUP THREESHOLD value to 25{.action}. Then scroll down the page.
{.thumbnail}
Edit the Fast restore option with your settings and click Save{.action}.
{.thumbnail}
This strategy makes a backup on OVHcloud Object Storage and also takes snapshots inside the Nutanix cluster, allowing for faster recovery.
Select all VMs via the check box next to NAME, then click the shield-shaped Policies{.action} button in the top right to assign a policy to all VMs.
{.thumbnail}
Choose the Exclude{.action} policy and click Assign{.action}.
{.thumbnail}
Select the HYCU virtual machine by selecting the check box next to it, then click the Policies{.action} button to assign a policy to this virtual machine.
{.thumbnail}
Choose the HYCU VM{.action} policy and click Assign{.action}.
{.thumbnail}
Select four virtual machines and click the Policies{.action} button to assign a policy.
{.thumbnail}
Choose the BACKUP to Object Storage and local SNAPSHOTS{.action} policy and click Assign{.action}.
{.thumbnail}
Go to the Dashboard{.action} menu on the left to view the dashboard and view the backup status.
{.thumbnail}
Open the Jobs{.action} menu on the left to view the job status.
{.thumbnail}
Use the Virtual Machines{.action} menu and click a backed up virtual machine.
{.thumbnail}
Click the Restore VM{.action} button in the bottom right-hand corner.
{.thumbnail}
Select Restore VM{.action} and click Next{.action}.
{.thumbnail}
Leave the default options and click Restore{.action}.
{.thumbnail}
The virtual machine is fully restored.
Click the Restore files{.action} button in the bottom right-hand corner.
{.thumbnail}
Leave AUTOMATIC{.action} in the RESTORE FROM drop-down menu and click Next{.action}.
{.thumbnail}
Select the file to restore and click Next{.action}.
{.thumbnail}
Leave the default options and click Next{.action}.
{.thumbnail}
Choose Rename restored{.action} and click Restore{.action}.
{.thumbnail}
The restored file is located inside the virtual machine with a new name so as not to delete the old file.
Click the Applications{.action} menu and then choose an application to restore by clicking an application below Name.
{.thumbnail}
Click the Restore{.action} button in the bottom right-hand corner.
{.thumbnail}
Select Restore Databases{.action} and click Next{.action}.
{.thumbnail}
Choose a database and click Next{.action}.
{.thumbnail}
Disable OVERWRITE EXISTING DATABASES{.action} and click Restore{.action}.
{.thumbnail}
The database is restored into a new database.
Nutanix on OVHcloud - High-level documentation
Object Storage - Managing object immutability with Object Lock (WORM)
OVHcloud Load Balancer documentation
Our OVHcloud Object Storage solutions
If you need training or technical assistance for implementing our solutions, contact your sales representative or click this link to get a quote and request a personalized analysis of your project from our Professional Services team experts.
Join our community of users.