0% found this document useful (0 votes)
55 views

HYCU UserGuide

Uploaded by

AMJAD KHAN
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
55 views

HYCU UserGuide

Uploaded by

AMJAD KHAN
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 95

USER GUIDE

Backup and Recovery


for Nutanix

Version: 2.0.0
Product release date: December 2017
Document release date: December 2017
Legal notices
Copyright notice
© 2017 Comtrade Software. All rights reserved.

This document contains proprietary information, which is protected by copyright. No part


of this document may be photocopied, reproduced, distributed, transmitted, stored in a
retrieval system, modified or translated to another language in any form by any means,
without the prior written consent of Comtrade Software (Comtrade).

Trademarks
Comtrade Software and HYCU logos, names, trademarks and/or service marks and
combinations thereof are the property of Comtrade or its affiliates. Other product names
are the property of their respective trademark or service mark holders and are hereby
acknowledged.

Acropolis and Nutanix are trademarks of Nutanix, Inc. in the United States and/or other
jurisdictions.

Azure®, Internet Explorer®, Microsoft®, Microsoft Edge™, and Windows® are either
registered trademarks or trademarks of Microsoft Corporation in the United States and/or
other countries.

Linux® is the registered trademark of Linus Torvalds in the U.S. and other countries.

Red Hat Enterprise Linux is a registered trademark of Red Hat, Inc. or its subsidiaries in the
United States and other countries.

Disclaimer
The details and descriptions contained in this document are believed to have been accurate
and up to date at the time the document was written. The information contained in this
document is subject to change without notice.

Comtrade Software provides this material "as is" and makes no warranty of any kind,
expressed or implied, including, but not limited to, the implied warranties of
merchantability and fitness for a particular purpose. Comtrade shall not be liable for errors
and omissions contained herein. In no event shall Comtrade be liable for any direct,
indirect, consequential, punitive, special or incidental damages, including, without
limitation, damages for loss and profits, loss of anticipated savings, business interruption,
or loss of information arising out of the use or inability to use this document, or any action
taken based on the information contained herein, even if it has been advised of the
possibility of such damages, whether based on warranty, contract, or any other legal
theory.

2
The only warranties for Comtrade Software products and services are set forth in the
express warranty statements accompanying such products and services. Nothing herein
should be construed as constituting an additional warranty.

Notice
This document is provided in connection with Comtrade Software products. Comtrade may
have copyright, patents, patent applications, trademark, or other intellectual property rights
covering the subject matter of this document.

Except as expressly provided in any written license agreement from Comtrade Software,
the furnishing of this document does not give you any license to these patents, trademarks,
copyrights, or other intellectual property on Comtrade Software products. Use of
underlying Comtrade Software product(s) is governed by their respective Software License
and Support Terms.

Important: Please read Software License and Support Terms before using the
accompanying software product(s).

Comtrade Software
www.comtradesoftware.com

3
Contents
1 About HYCU 8
HYCU key features and benefits 9

HYCU backup environment overview 9

2 Deploying the HYCU virtual appliance 11


Sizing your backup infrastructure for HYCU 12

Firewall settings 13

Uploading the HYCU virtual appliance image to a Nutanix cluster 14

Uploading the HYCU virtual appliance image to a Nutanix cluster running on


AHV 14

Uploading the HYCU virtual appliance image to a Nutanix cluster running on


ESXi 15

Creating a virtual machine for HYCU deployment 15

Creating a virtual machine for HYCU deployment on a Nutanix cluster


running on AHV 16

Creating a virtual machine for HYCU deployment on a Nutanix cluster


running on ESXi 16

Configuring HYCU on the virtual machine 17

Logging on to HYCU 18

3 Establishing a backup environment 19


Specifying Nutanix clusters 20

Setting up backup targets 20

How to set up an AWS S3/Compatible target 21

How to set up an Azure target 22

How to set up an NFS target 23

How to set up an SMB target 24

How to set up an iSCSI target 26

Defining your backup policy strategy 27

Applying a predefined backup policy 28

Using a backup window 29

Creating a data archive 30

4
Creating a backup policy 32

Setting a default backup policy 35

4 Protecting data 36
Enabling access to data 38

Assigning credentials to virtual machines 39

Assigning credentials to applications 40

Backing up virtual machines 40

Backing up applications 41

Performing a manual backup 43

5 Restoring data 44
Restoring entire virtual machines 44

Restoring individual files 46

Restoring whole applications 48

Restoring application items 51

6 Protecting the HYCU backup controller 53


Backing up the HYCU backup controller 53

Recovering the HYCU backup controller 54

7 Performing daily tasks 57


Using the HYCU dashboard 57

Checking the status of jobs 59

Viewing events 60

Viewing virtual machine and application details 60

Viewing the backup status of VMs and APPs 61

Filtering data in panels 62

Filtering options in the Applications panel 63

Filtering options in the Virtual Machines panel 63

Filtering options in the Policies panel 64

Filtering options in the Targets panel 65

Filtering options in the Jobs panel 65

Filtering options in the Events panel 66

Filtering options in the Self-Service panel 66

5
Managing backup targets 67

Viewing backup target information 67

Editing a backup target 68

Activating or deactivating a backup target 68

Increasing the size of an iSCSI backup target 69

Deleting a backup target 69

Managing backup policies 69

Viewing backup policy information 70

Editing a backup policy 70

Deleting a backup policy 71

Expiring backups manually 71

Adjusting the HYCU virtual machine resources 71

8 Managing HYCU accounts 73


Setting up accounts 74

Activating or deactivating an account 74

Setting ownership for virtual machines 75

Assigning owners to virtual machines 75

Removing owners from virtual machines 75

9 Administering 76
Licensing 77

Creating a license request 77

Requesting and retrieving licenses 78

Activating licenses 79

Upgrading HYCU 79

Changing network settings 80

Changing the HYCU listening port number 81

Configuring the SSL certificate 81

Creating a new self-signed certificate 81

Importing a CA certificate 82

Configuring FIPS-compliant mode for HYCU 82

Enabling FIPS-compliant mode for HYCU 83

6
Disabling FIPS-compliant mode for HYCU 83

Setting the iSCSI Initiator secret 83

Configuring backup target encryption 84

Setting power options 84

Setting up logging 84

Accessing the HYCU backup controller virtual machine by using SSH 85

Using the command-line interface 87

Using the HYCU REST API Explorer 87

Removing HYCU 87

A Customizing HYCU configuration settings 89


How to customize HYCU configuration settings 89

Email notification settings 90

Snapshot settings 91

Utilization threshold settings 91

Display settings 92

Scheduler settings 92

SQL Server application settings 92

Settings for aborting jobs 92

7
Chapter 1

About HYCU
HYCU is a high performing backup and recovery solution for Nutanix. It is the first data
protection solution that is fully integrated with Nutanix, and makes data protection easy to
deploy and simple to use.

Figure 1–1: Introduction to HYCU

8
1 About HYCU

HYCU key features and benefits


The following features make HYCU a solution that can transform your business, achieving
complete compliance and data protection:
l Protects against data loss
Delivers native and reliable data protection for mission-critical applications and data in
hyperconverged environments, while ensuring data consistency and easy
recoverability.
l Simplifies deployment
Deployment of the HYCU virtual appliance is performed through the Nutanix Prism web
console.
l Provides new-found visibility
Discovery solution provides new-found visibility into virtual machines, pinpointing
where each application is running.
l Protects data in a few minutes
Data protection of virtual machines and applications can be enabled in a few minutes
after the deployment.
l Delivers predefined policies and provides opportunities for customization
Predefined backup policies (Gold, Silver, and Bronze) that come with HYCU simplify the
data protection implementation. However, if the needs of the backup environment
require, a wide range of opportunities to customize backup policies is provided.
l Schedules backups based on RPOs
Automatic backup scheduling provides data protection based on your recovery point
objectives (RPOs).
l Discovers and protects applications
In-built application awareness provides application discovery and application-specific
backup and restore flow, and ensures that the entire application data is protected and
recovered to a consistent state.
l Lets you choose targets and hypervisors
Using data storage targets and hypervisors is the administrator's choice.
l Provides an at-a-glance overview of your environment
The HYCU dashboard helps you identify potential problems and bottlenecks to improve
the performance of your data protection environment.

HYCU backup environment overview


The HYCU backup environment is a set of components that discover, analyze, and protect
the specified data on Nutanix clusters, and present it in the web-based console. The HYCU
environment consists of the following parts:

9
1 About HYCU

A virtual machine hosted by a Nutanix cluster where HYCU


resides. The HYCU backup controller processes the data
HYCU backup controller collected in the Nutanix environment and presents it in the
web user interface. HYCU provides data protection of the
Nutanix clusters critical data.

A system from which you access HYCU. It also provides


administration tools to adjust the environment to your needs.
HYCU interface The HYCU interface has an established connection to the
HYCU backup controller. You can use the HYCU web user
interface or command-line interface (hyCLI).

Storage locations that HYCU uses for storing the protected


HYCU targets
data.

A backup environment for which HYCU provides data


Nutanix clusters
protection.

The following diagram shows the HYCU environment and its components:

Figure 1–2: HYCU architecture

10
Chapter 2

Deploying the HYCU virtual


appliance
The HYCU virtual appliance is a preconfigured HYCU software solution that you can easily
deploy by using the Nutanix Prism web console (for Nutanix clusters running on AHV) or
VMware vSphere client (for Nutanix clusters running on ESXi). The virtual appliance is
distributed as a virtual disk image.

The process of deploying the HYCU virtual appliance consists of several tasks. You must size
the backup infrastructure for HYCU, upload the HYCU virtual machine image to a Nutanix
cluster, create a virtual machine for your HYCU deployment, and configure HYCU on the
virtual machine, as shown in the following flowchart:

11
2 Deploying the HYCU virtual appliance

Figure 2–1: Overview of HYCU deployment tasks

Complete the following tasks to successfully deploy HYCU:

To deploy HYCU, I
Procedure
need to...

Before you start deploying the HYCU virtual appliance, size the
Prepare a backup backup infrastructure according to the requirements. For
infrastructure for HYCU. details, see “Sizing your backup infrastructure for HYCU”
below.

Upload the HYCU virtual appliance image to a Nutanix cluster.


Upload the HYCU virtual
For details, see “Uploading the HYCU virtual appliance image
appliance image.
to a Nutanix cluster” on page 14.

Create a virtual machine for HYCU deployment. For details,


Create a virtual machine. see “Creating a virtual machine for HYCU deployment” on
page 15.

Configure HYCU on the Configure HYCU on the created virtual machine. For details,
virtual machine. see “Configuring HYCU on the virtual machine” on page 17.

After you successfully deploy the HYCU virtual appliance, you can access HYCU by using a
supported web browser. For details on how to log on to HYCU, see “Logging on to HYCU”
on page 18.

Sizing your backup infrastructure for HYCU


Before you start deploying the HYCU virtual appliance, size the backup infrastructure
according to the following requirements:
l HYCU backup controller:
o Network connection
Make sure that you reserve an IP address for your virtual machine.
o System requirements
For HYCU backup controller deployment and configuration, at least 4 GB of RAM is
required.
Ensure that your environment meets the following sizing requirements:

Number of
Size Storage Cores Memory
VMs

Small 100–200 20 GB–40 GB 4–6 4 GB

Medium 200–500 100 GB–200 8–12 6–8 GB

12
2 Deploying the HYCU virtual appliance

Number of
Size Storage Cores Memory
VMs

GB

Large Contact Comtrade Software Support.

l HYCU web user interface:


For a list of web browsers that you can use to access the HYCU web user interface, see
the HYCU Compatibility Matrix.

n Note HYCU is designed to work with a screen resolution of at least 1280 × 720
pixels.

l HYCU backup targets:


o Make sure that destinations you want to use for storing your protected data are
available and accessible.

Firewall settings
If a firewall is configured in your network infrastructure, make sure that the required ports
are open on the following systems:

System Port number Description

For accessing the HYCU web user interface.


8443 (TCP)
HYCU backup For accessing the HYCU virtual machine by using
22 (TCP)
controller SSH.
445 (TCP)
For a file or application restore.

2049 (TCP/UDP) For accessing an NFS backup target.


HYCU backup
445 (TCP) For accessing an SMB backup target.
target
3260 (TCP) For accessing an iSCSI backup target.

Nutanix clusters 9440 (TCP) For accessing Nutanix REST API v3.

Virtual For accessing Windows virtual machines and


5985–5986 (TCP)
machines applications (by using WinRM) for discovery.

13
2 Deploying the HYCU virtual appliance

Uploading the HYCU virtual appliance image


to a Nutanix cluster
The procedure of uploading the HYCU virtual appliance image differs for the Nutanix
cluster running on AHV and the Nutanix cluster running on ESXi. Depending on your
hypervisor, follow the procedure:
l “Uploading the HYCU virtual appliance image to a Nutanix cluster running on AHV”
below
l “Uploading the HYCU virtual appliance image to a Nutanix cluster running on ESXi” on
the next page

Uploading the HYCU virtual appliance image to a


Nutanix cluster running on AHV
To upload the HYCU virtual appliance image to a Nutanix cluster, follow these steps:
1. Log on to the Nutanix Prism web console by using your Nutanix logon credentials.

2. In the menu bar, click , and then select Image Configuration.

3. In the Image Configuration dialog box, click Upload Image.

4. In the Create Image dialog box, provide the following information:


a. Enter the HYCU image name in the format that should correspond to that of the
HYCU image file you are uploading. Optionally, enter an annotation.

i Important Make sure to leave out the .qcow2 extension when entering
the HYCU image name.
If you enter the HYCU image name in a different format, you will not be able to use
this image for an upgrade.
b. From the Image Type drop-down menu, select DISK.
c. From the Storage Container drop-down menu, select a container for the image to
be uploaded.
d. In the Image Source section, select one of the following:
l From URL
Specify the location of the image file by using a URL.
l Upload a file
Specify the location of the image file saved on your file system.
5. Click Save.
6. Click Close after the image is successfully uploaded.

14
2 Deploying the HYCU virtual appliance

Uploading the HYCU virtual appliance image to a


Nutanix cluster running on ESXi
To upload the HYCU virtual appliance image to a Nutanix cluster, follow these steps:
1. Log on to the VMware vSphere Web client.
2. Click the Datastore tab and select the datastore where you want to upload the HYCU
virtual appliance image. Click the Upload a file to the Datastore icon. In the dialog
box that appears, select the HYCU virtual appliance image file, and then click Open.
3. For VMware vSphere 6.x, perform the following additional steps:
a. Establish an SSH connection to the ESXi server.
b. In the SSH console, navigate to the datastore where you uploaded the HYCU virtual
appliance image file. To find the uploaded file, run the following command:

find /vmfs/volumes –name "hycu-*.vmdk"

c. To clone the image file, run the following command:

vmkfstools -i <original_path>/<original_image_name>.vmdk -d thin


<new_path>/<cloned_image_name>.vmdk

In this instance, <original_path> is the directory where you uploaded the HYCU
virtual appliance image file and <new_path> is the directory where you want to
clone the image file.
After the image is successfully cloned, close the SSH connection.

Creating a virtual machine for HYCU


deployment
The procedure of creating a virtual machine for HYCU deployment differs for the Nutanix
cluster running on AHV and the Nutanix cluster running on ESXi. Depending on your
hypervisor, follow the procedure:
l “Creating a virtual machine for HYCU deployment on a Nutanix cluster running on AHV”
on the next page
l “Creating a virtual machine for HYCU deployment on a Nutanix cluster running on ESXi”
on the next page

15
2 Deploying the HYCU virtual appliance

Creating a virtual machine for HYCU deployment on a


Nutanix cluster running on AHV
To create a virtual machine for HYCU deployment, do the following in the Nutanix Prism
web console:
1. In the menu bar, click Home, and then select VM.

2. Click Create VM at the upper right of the screen.

3. In the Create VM dialog box, provide the following information:


a. Enter a virtual machine name and, optionally, its description.
b. In the Compute Details section, enter the number of CPUs and cores per CPU, and
a desired amount of RAM.

c. In the Disks section, click Add New Disk, and then, in the Add Disk dialog box,
complete the following information:
i. From the Type drop-down menu, select DISK.
ii. From the Operation drop-down menu, select Clone from Image Service.
iii. From the Bus Type drop-down menu, select SCSI.
iv. From the Image drop-down menu, select the name of the image you uploaded.
v. In the Size (GiB) field, enter the size of the virtual disk.
d. Click Add.
4. In the Network Adapters (NIC) section, click Add New NIC, and then, in the Create NIC
dialog box, provide the following information:
a. From the VLAN Name drop-down menu, select a VLAN.
b. Click Add.
5. Click Save.

Creating a virtual machine for HYCU deployment on a


Nutanix cluster running on ESXi
To create a virtual machine for HYCU deployment, do the following in the VMware vSphere
Web client:
1. Click the VMs tab, and then click the Create a new virtual machine into a host or
cluster icon.
2. In the New Virtual Machine dialog box, click Select creation type, and then select
Create a new virtual machine. Click Next.
3. In the Select a name and folder context, enter a virtual machine name and location.
Click Next.

16
2 Deploying the HYCU virtual appliance

4. In the Select a compute resource context, select the Nutanix cluster running on ESXi.
Click Next.
5. In the Select storage context, select the datastore where the HYCU backup controller
will reside. Click Next.
6. In the Select compatibility context, leave the default values, and then click Next.
7. In the Select a guest OS context, select the Linux guest OS family and the CentOS 7 (64-
bit) guest OS version from the drop-down menus. Click Next.
8. In the Customize hardware context, do the following:
a. Enter the number of CPUs and cores per socket, and a desired amount of RAM.
b. Remove the following hardware: New Hard disk, CD/DVD Drive, and Floppy Drive by
clicking x in the respective string.
c. From the New device drop-down menu, select Existing Hard Disk, and then click
Add. In the Select File dialog box that opens, select the cloned HYCU virtual
appliance image file, and then click OK.
d. In the New Network section, select the network you will use for HYCU.
e. Click Next.
9. In the Ready to complete context, review the settings, and then click Finish.

n Note Creating a HYCU virtual machine may take a few moments.

Configuring HYCU on the virtual machine


To configure HYCU on the created virtual machine, do the following in the Nutanix Prism
web console or VMware vSphere Web client depending on your hypervisor:
1. From the list of virtual machines, select the one you created, and then click Power on.
2. When the virtual machine is turned on, click Launch Console or Open Console. The
HYCU Network Configuration dialog box appears.
3. In the HYCU Network Configuration dialog box, do the following:
a. Enter the values for the following:
l Optional. Host name for the HYCU virtual machine

n Note The default host name is generated automatically during the


HYCU virtual appliance deployment. The host name should begin with a
letter and may contain only letters, numbers, and hyphens ("-").

l IPv4 address (for example, 10.1.100.1)


l Subnet mask (for example, 255.255.0.0)
l Default gateway (for example, 10.1.1.1)
l Optional. DNS server (for example, 10.1.1.5)

17
2 Deploying the HYCU virtual appliance

l Optional. Search domain (for example, domain.com)

n Note The domain name should begin with a letter and contain one or
more periods. It may also contain only letters, numbers, and hyphens ("-").

b. Click OK.
4. The progress of the HYCU backup controller configuration displays. After the HYCU
backup controller is configured, confirm the summary message by clicking OK.

You can start using HYCU immediately with a prebuilt Instant-on license. This license
expires automatically after 60 days and cannot be reused. Therefore, make sure to obtain a
permanent license within this 60-day period. For instructions, see “Licensing” on page 77.

Logging on to HYCU
After you successfully deploy the HYCU virtual appliance, you can access HYCU by using a
supported web browser. For a list of supported web browsers, see the HYCU Compatibility
Matrix.

To log on to HYCU, follow these steps:


1. In a browser, enter the following URL:

https://<server_name>:8443

In this instance, <server_name> is the fully qualified domain name of the HYCU server
(for example, https://hycu.example.com:8443).
2. On the logon page, enter your logon name and password. You can use the default user
name and password for initial access to HYCU:

User name: admin

Password: admin

For security purposes, it is highly recommended that you change the default password.

n Note The level of access depends on your HYCU account. For details, see “Setting
up accounts” on page 74.
You can now start establishing your backup environment to enable data protection. For
more information, see “Establishing a backup environment” on page 19.

After you log on to the HYCU web user interface, you can configure your environment to
use also the HYCU command-line interface (hycli). For more information, see “Using the
command-line interface” on page 87.

18
Chapter 3

Establishing a backup
environment
After you deploy the HYCU virtual appliance and log on to HYCU, you must establish a
backup environment in which data will be effectively protected. Establishing the backup
environment involves adding Nutanix clusters, setting up backup targets, and, if your
environment requires custom policies, creating them.

The following flowchart explains the tasks you need to perform to establish your backup
environment:

Figure 3–1: Establishing a backup environment

19
3 Establishing a backup environment

The tasks that are required to establish a backup environment can be performed only by
Administrators (including the Built-in Administrator), and are as follows:
l “Specifying Nutanix clusters” below
l “Setting up backup targets” below

You can enable data protection by using the predefined backup policies that come with
HYCU. If you do not want to use any of them, make sure that you create your own backup
policies. For details, see “Creating a backup policy” on page 32.

After the backup environment is established, data protection can be accomplished in


several ways to fulfill the needs of particular business. For detailed information, see
“Protecting data” on page 36.

Specifying Nutanix clusters


A Nutanix environment consists of one or more Nutanix clusters, each of which hosts a
series of virtual machines that run applications. You can specify one or more Nutanix
clusters that host virtual machines you want to include in the backup.

Accessing the Nutanix Cluster dialog box


To access the Nutanix Clusters dialog box, click Administration, and then select
Nutanix Clusters.

To add a Nutanix cluster, follow these steps:


1. In the Nutanix Clusters dialog box, click New. The New dialog box appears.
2. Enter the name of the Nutanix cluster in URL format: https://<server_name>:<port>.
3. Enter the user name and password of the user with cluster administrative rights.
4. Click Save.

You can also edit any of the existing Nutanix clusters (click Edit and make the required
modifications) or delete the ones that you do not need anymore (click Delete).

i Important In Nutanix environments that use VMware ESXi hypervisors, make


sure to configure your Windows virtual machines to not go into sleep mode after a
certain amount of time. Otherwise, the network settings are not recognized, and
consequently such virtual machines cannot be protected by HYCU.

Setting up backup targets


Backup targets are locations where the protected data is stored. HYCU allows you to store
your data to AWS S3 or S3-compatible storage, Azure storage, an NFS share, an SMB share,
and an iSCSI storage device.

20
3 Establishing a backup environment

The approach to set up backup targets is common for different target types. However, there
are specific prerequisites and steps that are required for each target type. Depending on
which backup target you want to set up, see one of the following sections:
l “How to set up an AWS S3/Compatible target” below
l “How to set up an Azure target” on the next page
l “How to set up an NFS target” on page 23
l “How to set up an SMB target” on page 24
l “How to set up an iSCSI target” on page 26

How to set up an AWS S3/Compatible target


Prerequisites
l The target is configured and accessible.
l The bucket is created.

Recommendation
It is recommended that the backup target is dedicated only to a single HYCU backup
controller.

Accessing the Targets panel


To access the Targets panel, in the navigation pane, click Targets.

To set up an AWS S3/Compatible target, follow these steps:


1. In the Targets panel, click New. The New Target dialog box appears.
2. In the General section, do the following:
a. Enter the name of a target and, optionally, its description.
b. In the Size field, enter the maximum storage space that should be reserved for the
backup files (in MB, GB, or TB).
c. In the Concurrent backups field, specify the maximum number of concurrent
backups.
If the backup throughput allows, you can specify that more backup jobs run
concurrently to reduce the duration of backups and the amount of queued backup
jobs.
d. Use the Use for archiving switch if you want this target to be reserved for data
archives.

i Important The target that you use for archiving data cannot be used for
backing up data or storing copies of backup data.

3. In the Target section, do the following:

21
3 Establishing a backup environment

a. From the Type drop-down menu, select AWS S3/Compatible.


b. Enter the service endpoint URL, the bucket name, the access key ID, and the secret
access key. The access key and the secret access key are used to authenticate
Amazon API service calls.
4. Click Save.

The backup target is added to the list of targets. For details on managing backup targets,
see “Managing backup targets” on page 67.

How to set up an Azure target


Prerequisite
The target is configured and accessible.

Recommendation
It is recommended that the backup target is dedicated only to a single HYCU backup
controller.

Accessing the Targets panel


To access the Targets panel, in the navigation pane, click Targets.

To set up an Azure backup target, follow these steps:


1. In the Targets panel, click New. The New Target dialog box appears.
2. In the General section, do the following:
a. Enter the name of a target and, optionally, its description.
b. In the Size field, enter the maximum storage space that should be reserved for the
backup files (in MB, GB, or TB).
c. In the Concurrent backups field, specify the maximum number of concurrent
backups.
If the backup throughput allows, you can specify that more backup jobs run
concurrently to reduce the duration of backups and the amount of queued backup
jobs.
d. Use the Use for archiving switch if you want this target to be reserved for data
archives.

i Important The target that you use for archiving data cannot be used for
backing up data or storing copies of backup data.

3. In the Target section, do the following:


a. From the Type drop-down menu, select Azure.
b. Enter the storage account name, the secret access key, and the container name.

22
3 Establishing a backup environment

n Note If the container does not exist, it is created automatically.


4. Click Save.

The backup target is added to the list of targets. For details on managing backup targets,
see “Managing backup targets” on page 67.

How to set up an NFS target


Prerequisites
l The target is configured and accessible.
l There is enough free space to store the backup data in the target location.
l If deduplication is enabled on the backup target, the backup target is dedicated
exclusively to HYCU backups. By dedicating a backup target exclusively to HYCU
backups, you ensure that accurate storage utilization reports are provided.
l If the target resides on Windows, local permissions (security) are set to Full Control
for Everyone. If you want to limit access to this system only for HYCU, use the HYCU
backup controller IP address for this purpose.

Recommendation
It is recommended that the backup target is dedicated only to a single HYCU backup
controller.

Accessing the Targets panel


To access the Targets panel, in the navigation pane, click Targets.

To set up an NFS backup target, follow these steps:


1. In the Targets panel, click New. The New Target dialog box appears.
2. In the General section, do the following:
a. Enter the name of a target and, optionally, its description.
b. Optional. In the Size field, enter the maximum storage space that should be
reserved for the backup files (in MB, GB, or TB). If your backup target is not
dedicated exclusively to HYCU backups, you must leave this field empty.
When this field is left empty, HYCU retrieves the available amount of storage space
from the backup target itself.

n Note If the target has deduplication enabled, HYCU's estimation of


required storage space on the target may be higher than the actual amount of
space required on the storage media. Therefore, it is recommended to leave
this field empty in such cases.

c. In the Concurrent backups field, specify the maximum number of concurrent


backups.

23
3 Establishing a backup environment

If the backup throughput allows, you can specify that more backup jobs run
concurrently to reduce the duration of backups and the amount of queued backup
jobs.
d. Use the Use for archiving switch if you want this target to be reserved for data
archives.

i Important The target that you use for archiving data cannot be used for
backing up data or storing copies of backup data.

3. In the Target section, do the following:


a. From the Type drop-down menu, select NFS.
b. Enter the NFS server name or IP address and the path to the NFS shared folder
from the root of the server (for example, /backups/HYCU).
c. Use the Target encryption switch if you want the data stored on this target to be
encrypted.
If you enable target encryption, keep in mind the following:
l The deduplication ratio may be affected by it (in cases where the backup target
has deduplication enabled).
l You cannot use this backup target for an internal backup.
4. Click Save.

The backup target is added to the list of targets. For details on managing backup targets,
see “Managing backup targets” on page 67.

How to set up an SMB target


Prerequisites
l The target is configured and accessible.
l There is enough free space to store the backup data in the target location.
l If deduplication is enabled on the backup target, the backup target is dedicated
exclusively to HYCU backups. By dedicating a backup target exclusively to HYCU
backups, you ensure that accurate storage utilization reports are provided.
l The supported SMB version is used. For a list of supported SMB versions, see the HYCU
Compatibility Matrix.

Recommendation
It is recommended that the backup target is dedicated only to a single HYCU backup
controller.

Accessing the Targets panel


To access the Targets panel, in the navigation pane, click Targets.

24
3 Establishing a backup environment

To set up an SMB backup target, follow these steps:


1. In the Targets panel, click New. The New Target dialog box appears.
2. In the General section, do the following:
a. Enter the name of a target and, optionally, its description.
b. Optional. In the Size field, enter the maximum storage space that should be
reserved for the backup files (in MB, GB, or TB). If your backup target is not
dedicated exclusively to HYCU backups, you must leave this field empty.
When this field is left empty, HYCU retrieves the available amount of storage space
from the backup target itself.

n Note If the target has deduplication enabled, HYCU's estimation of


required storage space on the target may be higher than the actual amount of
space required on the storage media. Therefore, it is recommended to leave
this field empty in such cases.

c. In the Concurrent backups field, specify the maximum number of concurrent


backups.
If the backup throughput allows, you can specify that more backup jobs run
concurrently to reduce the duration of backups and the amount of queued backup
jobs.
d. Use the Use for archiving switch if you want this target to be reserved for data
archives.

i Important The target that you use for archiving data cannot be used for
backing up data or storing copies of backup data.

3. In the Target section, do the following:


a. From the Type drop-down menu, select SMB.
b. Optional. Enter the domain and user credentials.
c. Enter the SMB server name or IP address and the path to the SMB shared folder
from the root of the server (for example, /backups/HYCU).
d. Use the Target encryption switch if you want the data stored on this target to be
encrypted.
If you enable target encryption, keep in mind the following:
l The deduplication ratio may be affected by it (in cases where the backup target
has deduplication enabled).
l You cannot use this backup target for an internal backup.
4. Click Save.

25
3 Establishing a backup environment

The backup target is added to the list of targets. For details on managing backup targets,
see “Managing backup targets” on page 67.

How to set up an iSCSI target


Prerequisites
l The target is configured and accessible.
l The target has not been initialized yet.
l The iSCSI storage device is dedicated only to a single HYCU backup controller.

C Caution Disregarding this prerequisite may result in data loss or corruption.


Therefore, make sure to avoid the following scenarios:
o Several HYCU backup controllers are using the same backup target
simultaneously.
o Any appliance other than HYCU and HYCU itself are using the same backup
target simultaneously.

l The HYCU iSCSI Initiator secret is added on the iSCSI server if you want to enable
mutual authentication between HYCU and the iSCSI server.
l For improved backup and restore performance, the iSCSI Data Service IP address is
specified on the Nutanix cluster by using the Prism console ( > Cluster Details).

This automatically enables the Nutanix load balancing feature during backup and
restore, which eliminates heavy I/O load on the Nutanix cluster and containers. For
details, see Nutanix documentation.

Accessing the Targets panel


To access the Targets panel, in the navigation pane, click Targets.

To set up an iSCSI backup target, follow these steps:


1. In the Targets panel, click New. The New Target dialog box appears.
2. In the General section, do the following:
a. Enter the name of a target and, optionally, its description.
b. Optional. In the Size field, enter the maximum storage space that should be
reserved for the backup files (in MB, GB, or TB).
If you leave this field empty, HYCU retrieves the available amount of storage space
from the backup target itself.
c. In the Concurrent backups field, specify the maximum number of concurrent
backups.
If the backup throughput allows, you can specify that more backup jobs run
concurrently to reduce the duration of backups and the amount of queued backup
jobs.

26
3 Establishing a backup environment

d. Use the Use for archiving switch if you want this target to be reserved for data
archives.

i Important The target that you use for archiving data cannot be used for
backing up data or storing copies of backup data.

3. In the Target section, do the following:


a. From the Type drop-down menu, select iSCSI.
b. Enter the target portal IP address (the External Data Service IP address if it is
specified on Nutanix, otherwise, the Nutanix cluster IP) and the target name (the
iSCSI Qualified Name (IQN) or Extended Unique Identifier (EUI) of the iSCSI storage
device that you can acquire on the iSCSI server).

n Note If data from sources other than HYCU resides on the storage device,
such target cannot be set for HYCU backups.

c. Use the Target encryption switch if you want the data stored on this target to be
encrypted.

n Note If you enable target encryption, you cannot use this backup target for
an internal backup.

4. If the iSCSI server requires CHAP authentication, in the CHAP section, do the following:
a. Use the switch to turn the CHAP authentication option on, and then provide a user
name and the target secret (the security key) for the user's account to access the
iSCSI server.
b. Use the Perform mutual authentication switch if you want the iSCSI target to be
authenticated by HYCU. In this case, the HYCU iSCSI Initiator secret must be
specified on the iSCSI server. For details about setting the iSCSI Initiator secret, see
“Setting the iSCSI Initiator secret” on page 83.
5. Click Save.

The backup target is added to the list of targets. For details on managing backup targets,
see “Managing backup targets” on page 67.

Defining your backup policy strategy


HYCU enables you to schedule automatic backups to achieve the optimum level of data
protection based on your recovery point and time objectives, and backup retention
requirements. Backups can be scheduled to start each time the specific number of minutes,
hours, days, weeks, or months has passed.

When defining your backup policy strategy, take into account the specific needs of your
environment and consider the following approaches:

I want to... Procedure

Apply a predefined HYCU provides a set of the predefined backup policies to

27
3 Establishing a backup environment

I want to... Procedure

simplify the data protection implementation. To use the


backup policy predefined backup policies, see “Applying a predefined
backup policy” below.

If you want all backup jobs to run within a specific backup


window to improve effectiveness and avoid overload of your
Use a backup window environment, use a backup window. For details on how to
create a backup window, see “Using a backup window” on the
next page.

If you want your data to be stored for long-term retention,


you can create a data archive and preserve it for future
Create a data archive
reference. For details, see “Creating a data archive” on
page 30.

If the needs of your environment require additional backup


Create a custom backup
policies, create a new backup policy and tailor it to your
policy
needs. For details, see “Creating a backup policy” on page 32.

If you consider one of the predefined or custom backup policies satisfies all data protection
goals of your environment, you can set such a policy as default. This default policy is
assigned to all existing virtual machines and applications that do not have an assigned
policy yet (if there are any), and to all newly discovered virtual machines and applications.
For details, see “Setting a default backup policy” on page 35.

Applying a predefined backup policy


When establishing a backup environment, you can take advantage of the predefined
backup policies that provide a fast and convenient way of enabling data protection, and
cover the most common data protection scenarios.

HYCU comes with the following predefined backup policies that you can select from the list
of policies when backing up a virtual machine or an application:

Type of predefined
Description
backup policy

Gold Data is backed up every 4 hours and restored within 4 hours.

Silver Data is backed up every 12 hours and restored within 12 hours.

Bronze Data is backed up every 24 hours and restored within 24 hours.

If you want to exclude virtual machines or applications from being backed up, you can use
the Excluded backup policy.

28
3 Establishing a backup environment

Using a backup window


HYCU enables you to define a time frame when your backup jobs are allowed to run. You
can use this backup window to improve effectiveness and avoid an overloaded
environment. For example, you can schedule your backup jobs to run on non-production
hours to reduce loads during peak hours.

You can use backup windows with both predefined backup policies and custom backup
policies.

n Note If you use a backup window, the backup jobs run only during the specified
hours. Make sure that the RPO specified in the affected policy can be achieved within
this backup window. If the RPO is shorter than the largest time frame in which backups
do not run, such RPO cannot be achieved during the hours out of the backup window.

Accessing the Policies panel


To access the Policies panel, in the navigation pane, click Policies.

To create a backup window, follow these steps:


1. In the Policies panel, click Backup Window.
2. In the Backup Window dialog box that appears, click New.
3. In the New dialog box that appears, enter a name for your backup window and,
optionally, a description.
4. Select the week days and hours during which you want backups to run. You can click
and drag to quickly select a time frame that includes the days and hours you want to
add.

i Important All scheduled backup jobs are run based on the HYCU backup
controller time zone.
The selected time frames are displayed in the Time Frames field. If you want to delete
any of the selected time frames, click x next to it.
5. Click Save.
6. In the Backup Window dialog box, click Close.

You can later edit any of the existing backup windows (click Edit and make the required
modifications) or delete the ones that you do not need anymore (click Delete).

After you create a backup window, you can do the following:


l Specify a backup window when creating a new policy. For details, see “Creating a
backup policy” on page 32.
l Assign a backup window to the existing backup policy. To do so, select the backup
policy, click Edit, and then make the required modifications.

29
3 Establishing a backup environment

Example
You have selected the Bronze policy and specified the time frame for the backup jobs to
be from Monday to Friday from 6 PM to 6 AM, and from Saturday to Sunday all day long.

In this case, the backup jobs will be run every 24 hours at any point of time within the
specified backup window.

Creating a data archive


HYCU enables you to create an archive of your data and keep it for a longer period of time.
By archiving data, the data is stored for future reference on a weekly, monthly, or yearly
basis. Your data is isolated from current activity and safely stored in a secure local or cloud
archive location.

Prerequisite
The archive target is reserved only for data archives (no backup data is stored on the
archive target).

Accessing the Policies panel


To access the Policies panel, in the navigation pane, click Policies.

To create a data archive, follow these steps:


1. In the Policies panel, click  Archiving.
2. In the Archiving dialog box that appears, click New .
3. In the New dialog box that appears, enter a name for your data archive and, optionally,
a description.

30
3 Establishing a backup environment

4. Add any of the desired archiving options to the list of the enabled options by clicking it.
The following options are available:

Weekly Allows you to create a weekly archive of data.

Monthly Allows you to create a monthly archive of data.

Yearly Allows you to create a yearly archive of data.

5. Specify the hour and the minute when the archive job should begin running.
6. Depending on which archiving options you have enabled, do the following:

Enabled option Procedure

To archive data on a weekly basis, do the following:


a. Select the day of the week on which to archive.
Weekly b. Set a retention period (in weeks) for the archive.
c. From the drop-down menu, select the archive target (the
archive destination you set up).

To archive data on a monthly basis, do the following:


a. Select the day of the month on which to archive.
Monthly b. Set a retention period (in months) for the archive.
c. From the drop-down menu, select the archive target (the
archive destination you set up).

To archive data on a yearly basis, do the following:


a. Select the month of the year and the day of the month on
which to archive.
Yearly
b. Set a retention period (in years) for the archive.
c. From the drop-down menu, select the archive target (the
archive destination you set up).

7. Click Save.

You can later edit any of the existing data archives (click Edit and make the required
modifications) or delete the ones that you do not need anymore (click Delete).

After you create a data archive, you can do the following:


l Specify a data archive when creating a new policy. For details, see “Creating a backup
policy” on the next page.
l Assign a data archive to the existing backup policy. To do so, select the backup policy,
click Edit, and then make the required modifications.

31
3 Establishing a backup environment

Creating a backup policy


If the needs of your environment are not covered with any of the predefined backup policy,
create a new backup policy and tailor it to your needs.

Accessing the Policies panel


To access the Policies panel, in the navigation pane, click Policies.

To create a new backup policy, follow these steps:


1. In the Policies panel, click New. The New Policy dialog box appears.
2. Enter a name and, optionally, a description of your backup policy.
3. Add any of the desired policy options to the list of the enabled options by clicking it. The
following options are available:

Backup Allows you to back up your data (enabled by default).

Backup
Allows you to select a backup window for backup jobs.
window

Allows you to back up virtual machines from their replicas in AHV


remote office/branch office (ROBO) environments. As a prerequisite
for backing up from replicas, you must create a protection domain
that will include the virtual machines that you want to protect and
specify the schedule, retention, and remote sites for replicating the
virtual machines. For details on protecting virtual machines through
the Nutanix Prism web console, see Nutanix documentation.
To be able to back up virtual machines from their replicas, make
sure that the replication retention on the Nutanix cluster is adjusted
to the backup policy's RPO. This allows HYCU to use the Changed
Backup from Block Tracking (CBT) feature to get a list of changed data since the
replica last snapshot and perform an incremental backup. For example, if
the Nutanix schedule interval is two hours and the RPO of the HYCU
backup policy is eight hours, the retention policy for the remote site
must be set to 4 or more snapshots (that is, at least the last four
snapshots must be kept).

i Important The Backup from replica and Fast restore


options exclude each other. Therefore, when you enable the
Backup from replica option, the Fast restore option is either
automatically disabled or you are notified that it will be disabled
and are asked to confirm it (depending on if it is already enabled
or not).

Archiving Allows you to store data for a longer period of time. The data is

32
3 Establishing a backup environment

transferred to an archive and stored there.

Copy Allows you to create a copy of backup data.

Allows you to restore a virtual machine or an application in a fast


Fast restore way by keeping local snapshots on the Nutanix cluster for the
specified retention time.

4. Depending on which policy options you have enabled, do the following:

Enabled
Procedure
option

To back up data, in the Backup section, do the following:


a. In the Backup every field, set the Recovery Point Objective (RPO),
which is the maximum tolerable data loss interval (in months,
weeks, days, hours, or minutes). This is a time period in which
data can be lost after an event that causes a virtual machine or
an application to go offline occurs.
b. In the Recover within field, set the Recovery Time Objective
(RTO), which is the maximum tolerable time of disruption (in
months, weeks, days, hours, or minutes). This is a time period
that is needed before a virtual machine or an application is
brought back online.
c. In the Retention field, set a retention period (in months, weeks,
or days) for the data.
d. From the Targets drop-down menu, select one or more backup
Backup targets that you want to use for storing protected data.
If you want your target to be selected automatically, make sure
the Automatically selected option is selected. In this case, the
HYCU advanced scheduler automatically selects only targets that
can guarantee compliance with the RPO and RTO policy
settings. Backup targets that have their estimated backup time
lower than the RPO and estimated recovery time lower than the
RTO are added to the pool of targets. Based on each virtual
machine or application size, as well as target backup and
restore throughput and queue, the HYCU advanced scheduler
calculates the backup and recovery end time and selects the
target where the backup will complete fastest.

n Note The target for incremental backups can be any


target in the selected pool of targets. To have a single target
for all backups in a backup chain, make sure to select a

33
3 Establishing a backup environment

Enabled
Procedure
option

single target per policy.

To specify a backup window, in the Backup section, from the


Backup window drop-down menu, select a backup window for
backup jobs. If no backup window is available and you want to
Backup create one, see “Using a backup window” on page 29.
window
n Note If you do not select a backup window, the Always
option is shown, which means that your backups are allowed to
run at any time.

To back up virtual machines from their replicas, in the Backup from


Backup from
replica section, from the Central site cluster drop-down menu, select
replica
the cluster on which the replicas of your virtual machines reside.

To archive data, in the Archiving section, from the Data archive drop-
Archiving down menu, select a data archive. If no data archive is available and
you want to create one, see “Creating a data archive” on page 30.

To create a copy of backup data, in the Copy section, do the


following:
a. Set a retention period (in months, weeks, or days) for the copy
of backup data.
b. From the Targets drop-down menu, select one or more backup
targets that you want to use for storing the copy of backup data.
If you want your target to be selected automatically, make sure
Copy the Automatically selected option is selected. The backup
copy target will be different from the backup target for data
safety reasons.

n Note When there are several backup targets available


for storing the copy of backup data and multiple copies of
backup data are being created in parallel, HYCU distributes
these copies accordingly among backup targets based on
the estimated size of queued and running backups on them.

By default, HYCU keeps one snapshot on the Nutanix cluster. With


this option enabled, HYCU will keep more than one snapshot on the
Nutanix cluster (depending on your retention settings), which
Fast restore allows you to restore a virtual machine or an application in a fast
way, reducing downtime.
In the Fast restore section, set a retention period (in months, weeks,

34
3 Establishing a backup environment

Enabled
Procedure
option

days, hours, or minutes) for snapshots. For example, if you set the
RPO to two days and the snapshot retention period to four days,
you will have two snapshots available on the Nutanix cluster.

n Note The snapshot retention period cannot be shorter


than the RPO or longer than the backup retention period.

5. Click Save.

The custom backup policy is created and added to the list of backup policies. For details on
managing backup policies, see “Managing backup policies” on page 69.

Setting a default backup policy


You can select one of the predefined or custom backup policies to be the default backup
policy for your HYCU environment. After you set a default backup policy, it is assigned to all
existing virtual machines and applications that do not have an assigned policy yet (if there
are any), and to all newly discovered virtual machines and applications.

Accessing the Policies panel


To access the Policies panel, in the navigation pane, click Policies.

To set a default backup policy, follow these steps:


1. In the Policies panel, select the policy that you want to set as default, and then click
 Set Default.
2. In the Set Default Policy dialog box that appears, do one of the following:
l Click Yes if you want to assign the default backup policy to all virtual machines and
applications that do not have an assigned policy (that is, existing and newly
discovered ones).
l Click No if you want to assign the default backup policy only to newly discovered
virtual machines and applications.

If you later decide not to use this backup policy as the default one, click  Clear Default.

35
Chapter 4

Protecting data
With the HYCU backup and recovery solution, you can be confident that your business data
is protected, which means that it is backed up in a consistent state, stored, can be restored,
accessed, and is not corrupted.

HYCU enables you to back up virtual machines residing on Nutanix clusters. After you
establish your backup environment (that is, specify the Nutanix clusters, set up the backup
targets, and, optionally, create the backup policies), you can enable data protection. When
you complete the first backup, you can restore the data that is backed up if it becomes
damaged or corrupted.

Because HYCU is application-aware, when you set credentials for virtual machines, it
discovers if any applications are installed and running on them. In addition, it also detects
details about the discovered applications such as their versions, the hosts where individual
components for the discovered application are installed, and the role of each host. To
ensure application consistency, HYCU provides the application-aware backup and restore.

The approach you choose for backing up your data largely depends on the type of restore
you want to perform. You may want to perform the restore at the virtual machine or
application level, or be able to restore only specific files inside the virtual machines. HYCU
provides different levels of data consistency depending on your restore strategy.

36
4 Protecting data

The following flowchart explains the process of enabling data protection:

Figure 4–1: Enabling data protection

The following table explains which approach you should use for protecting your data and
provides quick access to the backup instructions:

What do I want to Which type of backup Which tasks do I need to


restore? should I select? perform?

1. Back up virtual
machines. For
Virtual machine data Basic backup instructions, see
“Backing up virtual
machines ” on page 40.

37
4 Protecting data

What do I want to Which type of backup Which tasks do I need to


restore? should I select? perform?

1. Enable access to data.


For instructions, see
“Enabling access to data”
below.
Individual files within virtual
File-level backup 2. Back up virtual
machine file systems
machines. For
instructions, see
“Backing up virtual
machines ” on page 40.

1. Enable access to data.


For instructions, see
“Enabling access to data”
below.
Application data Application-aware backup 2. Back up applications.
For instructions, see
“Backing up
applications” on
page 41.

Enabling access to data


When the recovery goals of your environment require backing up data inside the virtual
machine file systems, you must enable HYCU to access the files and applications residing on
the virtual machines.

Prerequisites
Before you start enabling access to data, make sure the following prerequisites are met:
l On Windows 7 and 2008 R2, Windows PowerShell 3.0 is installed. For an application-
aware backup, the Windows PowerShell Script Execution Policy (Set-
ExecutionPolicy) is set to RemoteSigned.

l On Windows 7, 8, and 10, and Windows Server 2008 R2, WinRM is enabled and
configured by using the winrm quickconfig command.
l Windows user account with WinRM permissions exists. For an application-aware
backup, this account should have access to the application.
l On Linux, port 22 is open and the SSH daemon is running.
l For the Nutanix cluster running on ESXi: VMware Tools is installed on the client virtual
machine. For detailed information about installing VMware Tools, see VMware
documentation.

38
4 Protecting data

For detailed information, see Microsoft documentation.

To enable access to files and applications residing on the virtual machines, follow these
steps:
1. For a file-level backup, provide access to files inside the virtual machines. For details,
see “Assigning credentials to virtual machines” below.
2. For an SQL Server or Exchange Server application-aware backup, also provide access to
application data if the discovered applications do not use virtual machine credentials.
For details, see “Assigning credentials to applications” on the next page.

Assigning credentials to virtual machines


A file-level backup enables you to back up virtual machines in environments where you
foresee that you will want to restore only specific files inside the virtual machines.

Accessing the Virtual Machines panel


To access the Virtual Machines panel, in the navigation pane, click  Virtual Machines.

To be able to perform a file-level backup, assign credentials to virtual machines:


1. Select which virtual machines you want to back up.
2. Click Credentials. The Credential Groups dialog box appears.
3. Click New.
4. Enter the credentials that are required for accessing the virtual machines.
5. Click Save.
6. Click Assign.

You can also edit any of the existing credentials (click Edit and make the required
modifications) or delete the ones that you do not need anymore (click Delete).

i Important You can unassign or delete credentials from a virtual machine only if
the discovered applications running on it do not have assigned policies or available
restore points. Therefore, before unassigning or deleting credentials, make sure to
unassign policies or mark restore points as expired.

Application discovery
The process of application discovery starts automatically after you assign credentials to
virtual machines. HYCU can discover the following applications that are running on virtual
machines:
l SQL Server
l Active Directory

n Note The following roles are supported for Active Directory: Active Directory
Domain Services, Active Directory Lightweight Directory Services, Active Directory

39
4 Protecting data

Certificate Services, Active Directory Federation Services, and Active Directory Rights
Management Services.

l Exchange Server

For a list of supported application versions, see the HYCU Compatibility Matrix.

When the application discovery job completes, the discovered applications are listed in the
Applications panel.

Assigning credentials to applications


If the virtual machine credentials do not have proper permissions to access any of the
discovered SQL Server or Exchange Server applications that you want to protect, the
Discovery status for these applications in the Application panel is red. For such applications,
you must assign specific credentials with permissions to access them.

Accessing the Applications panel


To access the Applications panel, in the navigation pane, click  Applications.

To assign credentials to applications, follow these steps:


1. Select which applications you want to back up.

n Note You cannot assign any application-specific credentials to the Active


Directory application, because access to it is always granted with the virtual machine
credentials.

2. Click Credentials. The Credentials dialog box appears.


3. Use the switch to enable using operating system credentials with enough permissions
to access the application.
4. Enter the credentials for the user account with WinRM permissions and access to the
application.

i Important SQL Server only. The specified account must have sysadmin role on
the SQL Server application instance. The SQL Server account that connects by using
SQL Server Authentication is not supported.

5. Click Save.

Backing up virtual machines


HYCU provides you with two types of virtual machine backup, a basic backup and a file-level
backup. Both these types enable you to back up your virtual machine data in a fast and
efficient way. The only difference is that for the file-level backup, where the recovery goals of
your environment require backing up data inside the virtual machine file systems, you must
make sure that access to data is provided. For detailed information, see “Enabling access to
data” on page 38.

40
4 Protecting data

Limitation
Only a backup of local fixed disks is supported. When backing up a virtual machine with
remote volumes (for example, iSCSI, disk arrays, mapped network disks), such volumes are
not included in the snapshot and are consequently not backed up.

Accessing the Virtual Machines panel


To access the Virtual Machines panel, in the navigation pane, click  Virtual Machines.

To back up virtual machines, follow these steps:


1. Select the virtual machines that you want to back up.

t Tip You can update the list of virtual machines running in the selected Nutanix
cluster or clusters by clicking  Synchronize. To narrow down the list of displayed
virtual machines, you can use the filtering options described in “Filtering data in
panels” on page 62.

2. Click Policies. The Policies dialog box appears.


3. From the list of policies, select the desired backup policy.
4. Click Assign to assign the backup policy to the selected virtual machines.

After you assign the backup policy, the backup is scheduled according to the values that
you defined for your backup policy.

n Note If required, you can also perform a manual backup at any time. For details,
see “Performing a manual backup” on page 43.

Backing up applications
An application-aware backup allows a consistent backup of the SQL Server, Active Directory,
and Exchange Server applications.

Prerequisites
Before you start backing up applications, the following prerequisites must be met:

l Databases reside on the local disks in the Nutanix environment.


l Credentials are assigned to applications. For detailed information
about assigning credentials to applications, see “Enabling access to
SQL Server data” on page 38.
l If you plan to restore an SQL Server database to a point in time. The
database is online and is set to the full or bulk-logged recovery
model during the backup.

The Nutanix Guest Tools (NGT) software bundle is installed on the


Active Directory client virtual machine. For detailed information about installing NGT,
see Nutanix documentation.

41
4 Protecting data

l The Nutanix Guest Tools (NGT) software bundle is installed on the


client virtual machine. For detailed information about installing
NGT, see Nutanix documentation.
l All databases are mounted.
l Credentials are assigned to applications. For detailed information
about assigning credentials to applications, see “Enabling access to
data” on page 38.
l The Active Directory application is protected.
Exchange Server
Because Exchange Server stores all configuration information in
Active Directory, make sure that you also back up your Active
Directory application so that you can retrieve the information about
the configuration if required. For example, if an entire database is
deleted by accident and you want to restore it, you first need to
restore the Active Directory application, and then you can restore
this database by performing the Exchange Server restore. However,
if only the contents of the database is deleted, you need to restore
only the Exchange Server application.

Limitations
Before you start backing up applications, keep in mind the following application-specific
limitations:

l You can protect data only for stand-alone SQL Servers. Backing up


clustered instances and multiple instances running on the virtual
machine is not supported. Consequently, assigning policies to such
instances is not possible.
l The tempdb SQL Server system database is excluded from all
SQL Server backups.
l Only a full backup of the master, model, and msdb SQL Server
system databases is supported. You can restore an SQL Server
system database only as a whole instance.
l A point-in-time restore of the master, model, msdb, or tempdb
SQL Server system database is not possible.

Active Directory No limitations have been identified.

You can protect data only for stand-alone Exchange Servers. Backing
up an Exchange Server Database Availability Group (DAG) is not
Exchange Server
supported. Consequently, assigning policies to such instances is not
possible.

n Note If Active Directory and Exchange Server applications are running on the same

42
4 Protecting data

virtual machine and you plan to use the same approach for protecting both
applications, you can assign a backup policy only to the Exchange Server application. In
this case, the state of Active Directory application is backup consistent state and it is
backed up together with Exchange Server automatically.
After you make sure that all the prerequisites are met and that you are familiar with all the
limitations, you can continue with backing up applications.

Accessing the Applications panel


To access the Applications panel, in the navigation pane, click  Applications.

To back up applications, follow these steps:


1. In the Applications panel, select the applications that you want to back up.

t Tip To narrow down the list of all displayed applications, you can use the
filtering options described in “Filtering data in panels” on page 62.

2. Click Policies. The Policies dialog box appears.


3. From the list of policies, select the desired backup policy.
4. Click Assign to assign the backup policy to the selected applications.

After you assign the backup policy to the selected applications, the backup is scheduled
according to the values that you defined for your backup policy.

n Note If required, you can also perform a manual backup of any application at any
time. For details, see “Performing a manual backup” below.

Performing a manual backup


HYCU backs up your data automatically after you assign the backup policy to the selected
virtual machines or applications. However, you can also back up your data manually at any
time (for example, for testing purposes or if the backup fails).

To perform a manual backup, follow these steps:


1. In the Virtual Machines or Applications panel, select which virtual machines or
applications you want to back up.
2. Click Backup to start the backup of the selected virtual machines or applications.
3. Click Yes to confirm that you want to perform the manual backup.

t Tip In the navigation pane, click Jobs to check the overall progress of the
backup.

43
Chapter 5

Restoring data
You can start restoring data when at least one successful backup is performed. Depending
on the approach you used for backing up your data, you can perform different types of
restore.

I want to restore... Procedure

Entire virtual machines “Restoring entire virtual machines” below

Individual files within virtual


“Restoring individual files” on page 46
machine file systems

Whole applications “Restoring whole applications” on page 48

Application items “Restoring application items” on page 51

i Important After restoring an Exchange Server or Active Directory application,


reinstall the Nutanix Guest Tools (NGT) software bundle to ensure the successful
backup of application data.

Restoring entire virtual machines


With HYCU, you can restore an entire virtual machine to the original or a new location with
original settings, or a new location with custom settings. In addition, you can restore virtual
machine disk files to a shared location.

Accessing the Virtual Machines panel


To access the Virtual Machines panel, in the navigation pane, click  Virtual Machines.

To restore an entire virtual machine, follow these steps:


1. In the Virtual Machines panel, click the virtual machine that you want to restore to open
the Details section.

i Important The Details section appears only if you click a virtual machine.
Selecting the check box before the name of the virtual machine will not open the
Details section.

2. In the Details section that appears at the bottom of the screen, select the desired
restore point.

44
5 Restoring data

3. Click Restore VM. The VM Restore Options dialog box opens.


4. Depending on how you want to restore the virtual machine, select one of the following
restore options:

I want to... Procedure

To restore the virtual machine to the original location or a new


location with original settings, follow these steps:
a. Click Restore VM, and then click Next.
b. From the drop-down menu, select where you want to
restore the virtual machine.
Restore the virtual c. Use the Power virtual machine on switch if you want to
machine turn the restored virtual machine on or off after the restore.
The original virtual machine is deleted automatically.

i Important If you are restoring the virtual machine to


a new location on another Nutanix cluster, make sure to
add a network adapter to the virtual machine afterward. For
details on how to do this, see Nutanix documentation.

To clone the virtual machine to a new location with custom


settings, follow these steps:
a. Click Clone VM, and then click Next.
b. From the drop-down menu, select where you want to clone
the virtual machine.
c. Specify a new name for the virtual machine.
Clone the virtual d. Use the Power virtual machine on switch if you want to
machine
turn the restored virtual machine on or off after the restore.
If you turn the restored virtual machine on, the original
virtual machine will be turned off automatically.

i Important If you are cloning the virtual machine to a


new location on another Nutanix cluster, make sure to add
a network adapter to the virtual machine afterward. For
details on how to do this, see Nutanix documentation.

To restore virtual machine disk files to a shared location, follow


these steps:

Restore virtual a. Click Restore VM Disk Files, and then click Next.
machine disk files
i Important During the restore of virtual machine
disk files, no additional restores or expiring backups
can be performed for this virtual machine.

45
5 Restoring data

I want to... Procedure

b. From the drop-down menu, select where you want to


restore the disk files, and then provide the required
information:
l NFS
Enter the NFS server name or IP address and the path
to the NFS shared folder from the root of the server (for
example, /backups/HYCU).
l SMB
i. Optional. Enter the domain and user credentials.
ii. Enter the SMB server name or IP address and the
path to the SMB shared folder from the root of the
server (for example, /backups/HYCU).
After the restore is finished, you can upload the disk files to a
Nutanix cluster and create a new virtual machine by using
them. You do not need HYCU to create a virtual machine from
the exported disk image.

n Note Data is restored in the native hypervisor format to


the following location:
/<sharedpath>/<vmname>/<timestamp>/<filename>
In this instance, <sharedpath> is the path to the shared
folder, <vmname> is the virtual machine name, timestamp is
time of restore, and filename is the VM disk UUID.

Keep in mind that due to features such as data resiliency and


provisioning, the disk files may require more space than on the
shared location. Therefore, make sure to reserve enough space
in the Nutanix container. For details about how to do this, see
Nutanix documentation.

5. Click Restore.

n Note Because the minimum RAM required for restoring a virtual machine is 256
MB, any virtual machine with less RAM is automatically set to 256 MB during restore.

Restoring individual files


With HYCU, you can restore individual files to the original or an alternate location on the
original Windows or Linux virtual machine, or to an SMB share.

46
5 Restoring data

Prerequisites
l You have performed a file-level backup. For details, see “Protecting data” on page 36.
l One of the following file systems is used:
On Windows: NTFS, FAT, or FAT32
On Linux: xfs, ext4/ext3/ext2, reiserfs, or btrfs

Limitation
Performing a file-level restore on dual-boot systems is not supported.

Accessing the Virtual Machines panel


To access the Virtual Machines panel, in the navigation pane, click  Virtual Machines.

To restore individual files, follow these steps:


1. In the Virtual Machines panel, click the virtual machine that contains the files that you
want to restore to open the Details section.

i Important The Details section appears only if you click a virtual machine.
Selecting the check box before the name of the virtual machine will not open the
Details section.

2. In the Details section that appears at the bottom of the screen, select the desired
restore point.
3. Depending on whether the snapshot for the selected restore point is online, do one of
the following:
l If the snapshot is online, the Restore Files option is available and you can start
the procedure for restoring the files by clicking it.
l If the snapshot is not online, you first need to prepare the files for the restore:
a. Click Prepare for Restore Files. The Prepare for Restore Files dialog box
appears.
b. Use the Restore with original settings switch if you want to enable or disable
restoring data with original settings.
If you choose to use different settings for restoring data, select a container.
c. Click Prepare.
The Restore Files option becomes available and you can start the procedure for
restoring the files by clicking it.
4. In the Restore Files dialog box, from the list of available files, select the ones that you
want to restore, and then click Next.

t Tip If there are too many files to be displayed on one page, you can move
between the pages by clicking  and .
You can also search for a file or a folder by entering its name and then pressing
Enter in the Search field.

47
5 Restoring data

The Single File Restore dialog box appears.


5. Select where you want to restore the individual files:

To restore the individual files to the original virtual machine,


follow these steps:
a. Click Virtual Machines, and then click Next.
b. Select the location on the virtual machine where you want
to restore the individual files, and provide the required
information:
l Original Location
Select how the restore should save the files when there
is a file with the same name and location on the virtual
machine (overwrite the file, rename the original file, or
rename the restored file).
Original virtual
machine l Alternate Location (on the same VM)
Specify the path to an alternate location on the same
virtual machine in the following format:

C:\<path>

c. Use the Restore ACL switch if you want to enable or disable


restoring the original access control list.

i Important If the original virtual machine is not


accessible due to various reasons (for example, credentials
are not assigned to it, discovery was not successful, or it is
turned off or deleted from the Nutanix cluster), you cannot
select it for restoring the individual files.

To restore the individual files to an SMB share, follow these


steps:
a. Click Fileshares, and then click Next.
SMB share b. Specify the path to a shared folder in the following format:

\\server\<path>

c. Optional. Provide user credentials to access the SMB share.

6. Click Restore.

Restoring whole applications


With HYCU, you can restore a whole application to the original or a new location by
restoring the virtual machine on which the application is running. In addition, you can

48
5 Restoring data

restore the disk files of the virtual machine on which the application is running to a shared
location.

C Caution When you are restoring the application to the original location, the
restored data overrides the data in the original location. To avoid data loss, make sure
that you back up the potentially unprotected data—the data that appeared between the
last successful backup and the restore. To start a manual backup, see “Performing a
manual backup” on page 43.

SQL Server limitation
Restoring the SQL Server application to another SQL Server application instance is
supported only if you are restoring to the same or higher version of the application.

Active Directory limitation


Authoritative restore of Active Directory is not supported.

Accessing the Applications panel


To access the Applications panel, in the navigation pane, click  Applications.

To restore a whole application, follow these steps:


1. In the Applications panel, click the application that you want to restore to open the
Details section. The Details section appears only if you click an application. Selecting the
check box before the name of the application will not open the Details section.
2. In the Details section that appears at the bottom of the screen, select the desired
restore point.

i Important If the backup status for the selected restore point shows that the
backup is crash consistent, you cannot use this restore point for restoring the
application.

3. Click Restore. The APP Restore Options dialog box opens.


4. Select Restore whole application, and then click Next.
5. Depending on how you want to restore the virtual machine on which the selected
application is running, select one of the following restore options:

I want to... Procedure

To restore the virtual machine to the original location or a new


location with original settings, follow these steps:
a. Click Restore VM, and then click Next.
Restore the virtual
b. From the drop-down menu, select where you want to
machine
restore the virtual machine.
c. Use the Power virtual machine on switch if you want to
turn the restored virtual machine on or off after the restore.

49
5 Restoring data

I want to... Procedure

The original virtual machine is deleted automatically.

i Important If you are restoring the virtual machine to


a new location on another Nutanix cluster, make sure to
add a network adapter to the virtual machine afterward. For
details on how to do this, see Nutanix documentation.

To clone the virtual machine to a new location with custom


settings, follow these steps:
a. Click Clone VM, and then click Next.
b. From the drop-down menu, select where you want to clone
the virtual machine.
c. Specify a new name for the virtual machine.
Clone the virtual d. Use the Power virtual machine on switch if you want to
machine
turn the restored virtual machine on or off after the restore.
If you turn the restored virtual machine on, the original
virtual machine will be turned off automatically.

i Important If you are cloning the virtual machine to a


new location on another Nutanix cluster, make sure to add
a network adapter to the virtual machine afterward. For
details on how to do this, see Nutanix documentation.

To restore virtual machine disk files to a shared location, follow


these steps:
a. Click Restore VM Disk Files, and then click Next.

i Important During the restore of virtual machine


disk files, no additional restores or expiring backups
can be performed for this virtual machine.

b. From the drop-down menu, select where you want to


Restore virtual restore the disk files, and then provide the required
machine disk files information:
l NFS
Enter the NFS server name or IP address and the path
to the NFS shared folder from the root of the server (for
example, /backups/HYCU).
l SMB
i. Optional. Enter the domain and user credentials.
ii. Enter the SMB server name or IP address and the

50
5 Restoring data

I want to... Procedure

path to the SMB shared folder from the root of the


server (for example, /backups/HYCU).
After the restore is finished, you can upload the disk files to a
Nutanix cluster and create a new virtual machine by using
them. You do not need HYCU to create a virtual machine from
the exported disk image.

n Note Data is restored in the native hypervisor format to


the following location:
/<sharedpath>/<vmname>/<timestamp>/<filename>
In this instance, <sharedpath> is the path to the shared
folder, <vmname> is the virtual machine name, timestamp is
time of restore, and filename is the VM disk UUID.

Keep in mind that due to features such as data resiliency and


provisioning, the disk files may require more space than on the
shared location. Therefore, make sure to reserve enough space
in the Nutanix container. For details about how to do this, see
Nutanix documentation.

6. Click Restore. During the restore of the application, the original application instance is
offline and not accessible.

Restoring application items


Depending on the type of discovered application, you can restore application items to the
original or a different application instance.

Limitations
l The restore of discovered applications is available for the NTFS, FAT, and FAT32 file
systems.
l Exchange Server application items cannot be restored to a different application
instance.
l Restoring SQL Server application items to another SQL Server application instance is
supported only if you are restoring to the same or higher version of the application.

Accessing the Applications panel


To access the Applications panel, in the navigation pane, click  Applications.

To restore application items, follow these steps:


1. In the Applications panel, click the application whose application items you want to
restore to open the Details section. The Details section appears only if you click an
application. Selecting the check box before the name of the application will not open

51
5 Restoring data

the Details section.


2. In the Details section that appears at the bottom of the screen, select the desired
restore point.

i Important If the backup status for the selected restore point shows that the
backup is crash consistent, you cannot use this restore point for restoring the
application items.

3. Click Restore. The APP Restore Options dialog box opens.


4. Select Restore application items, and then click Next.
5. SQL Server only. From the drop-down menu, select the application instance to which you
want to restore application items.
6. Select the All application items check box if you want to restore the whole application
instance.
If you choose to restore only one or more databases, clear the All application items
check box, and then, from the list of databases, select the ones that you want to
restore.
7. SQL Server only. You can specify a point in time to which you want to restore data. This
means that the application items will be restored to the state they were in at the
specified time.

i Important For a successful point-in-time restore, make sure that the


database recovery model is set to full or bulk-logged.

8. Click Restore.

52
Chapter 6

Protecting the HYCU backup


controller
It is crucial for your HYCU backup environment that the strategy you choose to protect your
HYCU backup controller is highly reliable and assures security and recoverability.

HYCU provides an internal backup as a disaster protection strategy for your HYCU backup
controller virtual machine. If a disaster with the HYCU backup controller occurs (for
example, if it is deleted by accident or if the Nutanix cluster on which it is running goes
down), use this strategy to successfully protect and recover the HYCU backup controller.

n Note HYCU uses synthetic full backups for backing up the HYCU backup controller.
This means that each backup represents a consolidation of the full backup and a
number of incremental backups. After the new backup is created, all old backups are
marked as expired.
To improve protection of your HYCU backup controller and increase its invulnerability, it is
highly recommended to combine the internal backup strategy with the native Nutanix data
protection strategy (for example, by including the HYCU backup controller to the Nutanix
protection domain). For detailed instructions on how to implement data protection for
virtual machines in Nutanix, see Nutanix documentation.

Limitation
For an internal backup, you can use only NFS, SMB, and iSCSI targets that are not
encrypted.

Backing up the HYCU backup controller


After you deploy the HYCU virtual appliance (that is, your HYCU backup controller), perform
an internal backup of your HYCU backup controller by assigning a backup policy to it:
1. In the navigation pane, click  Virtual Machines.
2. From the list of virtual machines, select your HYCU backup controller, and then click
Policies. The Policies dialog box appears.
3. Select the backup policy for your HYCU backup controller.

i Important Make sure that your backup policy has only one backup target

53
6 Protecting the HYCU backup controller

selected (NFS, SMB, or iSCSI) and that it does not have the Archiving and Copy
options enabled. Otherwise, assigning the backup policy to the HYCU backup
controller will not be possible.
For detailed information about backup policies, see “Defining your backup policy
strategy” on page 27.

4. Click Assign to assign the backup policy to the HYCU backup controller.

If you change the backup policy in any of the following ways after assigning it to the HYCU
backup controller, keep in mind the following:
l If you add multiple targets as backup targets to the policy (or automatic selection is
enabled), a new full backup will be performed every time the target changes.
l If you add one or more backup copy targets, every backup copy size will be equal to the
size of the full backup.

In addition, note the following internal backup considerations:


l Backup files are located on the backup target (as specified in the backup policy) in the
following folder:
/bkpctrl/<controllerUuid>/

In this instance, <controllerUuid> is the HYCU backup controller UUID, which you can
see in the Licensing dialog box, in the Controller string. To access the Licensing dialog
box, click Administration, and then select Licensing.

t Tip Keep note of the target and the location of the backup.

l Every time the target is changed, the information in the Events panel is updated and
shows a message about the new location of the backup files.

Recovering the HYCU backup controller


Prerequisite
If you are using the iSCSI backup target, make sure to establish a connection to it.

To recover the HYCU backup controller, follow these steps:


1. Retrieve the HYCU backup controller disk image from the backup target. If you are
using iSCSI, access the HYCU logical volume that is located on it (you can identify the
HYCU logical volume by its hycu_lv prefix).
2. Navigate to the /bkpctrl/<controllerUuid> folder, and then upload the disk image
file to the Nutanix image service. To do so, follow these steps:
a. Log on to the Nutanix Prism web console by using your Nutanix logon credentials.

b. In the menu bar, click , and then select Image Configuration.

c. In the Image Configuration dialog box, click Upload Image.

d. In the Create Image dialog box, provide the following information:

54
6 Protecting the HYCU backup controller

i. Enter a HYCU image name and, optionally, an annotation.


ii. From the Image Type drop-down menu, select DISK.
iii. In the Image Source section, select Upload a file, and then specify the location
of the image file.

t Tip The easiest way for you to locate the disk image file in the
/bkpctrl/controllerUuid folder would be to search for the largest file.

iv. Click Save.


v. Click Close after the image is successfully uploaded.
3. After you upload the disk image, depending on whether the HYCU backup controller is
present in the list of virtual machines, select one of the following procedures:
l HYCU backup controller is present
If the HYCU backup controller is present, but it is corrupted, follow these steps:
a. Log on to the Nutanix Prism web console by using your Nutanix logon
credentials.
b. In the menu bar, click Home, and then select VM.
c. Click Table, and then, from the list of virtual machines, select the HYCU backup
controller virtual machine and click Power Off Actions to shut it down.
d. Click Update. The Update VM dialog box appears.
e. Remove the old disk from the HYCU backup controller.

f. Click Add New Disk, and then do the following:

i. From the Type drop-down menu, select DISK.


ii. From the Operation drop-down menu, select Clone from Image Service.
iii. From the Bus Type drop-down menu, select SCSI.
iv. From the Image drop-down menu, select the name of the image you
uploaded.
v. Click Add.
g. Click Power on to turn on the HYCU backup controller.
l HYCU backup controller is not present
If the HYCU backup controller is not present, follow these steps:
a. Log on to the Nutanix Prism web console by using your Nutanix logon
credentials.
b. Create a new virtual machine. For details, see “Creating a virtual machine for
HYCU deployment” on page 15.
c. Click Power on to turn on the HYCU backup controller.
d. Configure the network settings for the new virtual machine because a new
network card is assigned to it. To do so, follow these steps:

55
6 Protecting the HYCU backup controller

i. Log on to the HYCU backup controller console, and then run the nmtui
command.
ii. In the NetworkManager TUI dialog box, click Edit a connection, select a
currently active connection, and then enter the network properties of the
original HYCU backup controller.

n Note You can check which connection is active by clicking Activate


a connection in the NetworkManager TUI dialog box. In the list of
networks, the active networks are marked with an asterisk (*).

iii. Restart the recovered HYCU backup controller.


e. Assign a backup policy to your new HYCU backup controller as described in
“Backing up the HYCU backup controller” on page 53.

56
Chapter 7

Performing daily tasks


To ensure the secure and reliable performance of the data protection environment, HYCU
provides various mechanisms to support your daily activities.

I want to... Procedure

Get an at-a-glance overview of the data protection


“Using the HYCU dashboard”
environment state, identify eventual bottlenecks, and
below
inspect different areas of the HYCU environment.

Track tasks that are running in my environment and “Checking the status of jobs” on
get an insight into the specific task status. page 59

View all events that occurred in my environment. “Viewing events” on page 60

View the backup status of virtual machines and “Viewing virtual machine and
applications. application details ” on page 60

Narrow down the list of displayed elements in “Filtering data in panels” on


panels. page 62

View backup target information, activate or


“Managing backup targets” on
deactivate a backup target, increase the size of an
page 67
iSCSI backup target, or edit or delete a backup target.

View backup policy information, or edit or delete a “Managing backup policies” on


backup policy. page 69

“Expiring backups manually” on


Mark restore points as expired.
page 71

In case of the recognized problems in the Nutanix environment that can degrade the
efficiency and reliability of data protection (for example, when storage, vCPU, or memory
utilization is exceeded), you can make adjustments to better meet your data protection
goals. For details, see “Adjusting the HYCU virtual machine resources” on page 71.

Using the HYCU dashboard


The HYCU dashboard provides you with an at-a-glance overview of the data protection
status in your environment. This intuitive dashboard enables you to monitor all data

57
7 Performing daily tasks

protection activity and to quickly identify areas that need your attention. You can use this
dashboard as a starting point for your everyday tasks because it enables you to easily
access the area of interest by simply clicking the corresponding widget.

Accessing the Dashboard panel


To access the Dashboard panel, in the navigation pane, click Dashboard.

i Important Your account permissions define which widgets you are allowed to
see and access.

The following table describes what kind of information you can find within each widget:

Dashboard widget Description

Shows the percentage of policies that are compliant, and the exact
number of compliant and incompliant policies. A policy is
considered compliant if all virtual machines and applications
Policies
within this policy are compliant with the policy settings. For
detailed information about policies, see “Defining your backup
policy strategy” on page 27.

Shows the percentage of protected virtual machines in your


environment, and the exact number of protected and unprotected
virtual machines. A virtual machine is considered protected if it has
Virtual Machines an assigned policy and if there is at least one valid backup within
the defined retention period. For detailed information about
protecting virtual machines, see “Backing up virtual machines ” on
page 40.

58
7 Performing daily tasks

Dashboard widget Description

Shows the percentage of protected applications, and the exact


number of protected and unprotected applications. An application
is considered protected if it has an assigned policy and if there is at
Applications
least one valid backup within the defined retention period. For
detailed information about protecting applications, see “Backing
up applications” on page 41.

Backups Shows the backup job success rate for the last seven days.

Shows the number of existing backup targets, overall capacity


utilization, and the utilization per target type. For detailed
Targets*
information about setting up backup targets, see “Setting up
backup targets” on page 20.

Shows the resource information about the virtual machine where


the HYCU backup controller resides (storage, vCPU, and memory).
For details about what to do if any of these values reaches a critical
Controller*
value (that is, if any of the values that are indicated by circles
becomes red), see “Adjusting the HYCU virtual machine resources”
on page 71.

Shows the number of jobs in the HYCU environment in the last 48


hours. It also shows how many jobs succeeded, failed, are in
Jobs
progress or in a queue. For details, see “Checking the status of
jobs” below.

Shows the number of events in the HYCU environment in the last


Events 48 hours. It also shows the number of the events according to
their severity. For details, see “Viewing events” on the next page.

* Built-in Administrator or Administrator only.

Checking the status of jobs


You can use the Jobs panel to check the overall status of jobs.

Accessing the Jobs panel


To access the Jobs panel, in the navigation pane, click Jobs.

In the Jobs panel, you can do the following:


l Check the status of processes that are currently running.
l Check the status of completed and stopped processes.
l Check more details about a specific job in the Details section that appears at the bottom
of the screen after you select the job.

59
7 Performing daily tasks

l Generate a report about a specific job by selecting it, and then clicking Report. To
copy the report to the clipboard, in the Job Report dialog box that opens, click Copy to
clipboard.
l Cancel a currently running job by selecting it, and then clicking Abort Job.

The following table shows the job information:

Job information Description

Name of the job that was performed (for example, adding a


Name
cluster, adding a target, running a backup, and so on).

Current status of a job (for example, Queued, a progress bar


Status
indicating the Executing status, OK, or Error).

Started When a job was started.

Finished When a job finished.

Viewing events
The Events panel enables you to view all events that occurred in your environment, to check
details about the selected event, and to list events that match the specified filter.

Accessing the Events panel


To access the Events panel, in the navigation pane, click Events.

The following information is available for each event:

Level Severity level of the event (Info, Warning, or Error)

Message Description of the event

Category to which the event belongs (for example, Policies, Backup,


Category
Credentials, System in case of an internal event, and so on)

Timestamp Event creation time

To open the Details section where you can find the event summary and more details about
the event, click the desired event.

Viewing virtual machine and application


details
You can view the details about each virtual machine and discovered application in the
Details section of the Virtual Machines or Applications panel. The following details are
available:

60
7 Performing daily tasks

Shows detailed information about the selected virtual machine or


Summary
application.

You can view the following information about each restore point:
l Date and time when the restore point was created.
l Full or Incremental: Shows the type of backup.
Restore point l Snapshot: Visible only if the Nutanix cluster contains a local
snapshot that enables you to perform a fast restore.
l Copy: Visible only if the Copy policy option is enabled.
l Archive: Visible only if the Archiving policy option is enabled.

Shows the compliancy status of the virtual machine or application


(Success, Failure, or Undefined).

By pausing on a compliancy status indicated by a respective icon,


Compliancy additional information about the backup is available. You can see
backup frequency, when the last successful backup was performed,
the time limit you set for a restore, the estimated time required for a
restore, and the number of copies.

Backup status For details, see “Viewing the backup status of VMs and APPs ” below.

Shows a progress bar indicating the progress of the virtual machine or


application data restore.
Restore status
n Note If you double-click a progress bar, you are directed to the
Jobs panel where you can check details about the related job.

Viewing the backup status of VMs and APPs


The backup status of your virtual machine or application determines whether it is possible
to restore it.

Backup status of a VM Can I restore a Can I restore Can I restore an


or an APP VM? VM files? application?

 (Success) h h h
 (Success with warnings) h h ha
 (Success with errors) hb hc hd
 (Error) x x x

a You cannot specify a point in time to which you want to restore data. This backup status

may occur because disk mapping failed or a virtual machine does not have an NIC, or, in

61
7 Performing daily tasks

case of applications, at least one database log backup failed (whereas all other databases
are in a consistent state).
b Because not all virtual machine disk files were backed up successfully, the virtual machine

can be partially restored. It may not be possible to turn it on if one of the system disks was
not backed up.
c Because not all virtual machine disk files were backed up successfully, the individual files

can be partially restored—only the files that are displayed in the Restore Files dialog box
can be restored.
d An application can be partially restored—only the databases that are displayed in the

Restore application items dialog box can be restored.

n Note By pausing on a backup status indicated by a respective icon, additional


information about the backup is available. You can see the backup type, backup
consistency, the duration and size of the backup, which backup target was used, and
the backup UUID.
If you double-click a backup status icon, you are directed to the Jobs panel where you
can check details about the related job.

Filtering data in panels


HYCU enables you to filter data in the panels so you can easily find what you need. Each
panel contains different filtering options and displays only the information that meets the
specified filter criteria (for example, filtering the data in the Virtual Machines panel helps
you to focus only on the virtual machines that you are interested in or responsible for).

To filter data in panels, follow these steps:


1. Click Filters. The Filters side panel opens.
2. Select your filter criteria.
3. Click Apply Filters.

Depending on the panel the contents of which you want to filter, see one of the following
sections for the details about available filtering options:
l “Filtering options in the Applications panel” on the next page
l “Filtering options in the Virtual Machines panel” on the next page
l “Filtering options in the Policies panel” on page 64
l “Filtering options in the Targets panel” on page 65
l “Filtering options in the Jobs panel” on page 65
l “Filtering options in the Events panel” on page 66
l “Filtering options in the Self-Service panel” on page 66

62
7 Performing daily tasks

Filtering options in the Applications panel


In the Filters side panel, select one or more filtering options:

Filtering option Action

Search Enter a search term. You can filter by the name of the application.

From the drop-down menu, select the clusters that host the virtual
Clusters
machines on which the applications are running.

From the drop-down menu, select the backup policies that are
Policies assigned to the virtual machines on which the applications are
running.

From the drop-down menu, select the owners that are assigned to
Owners
the virtual machines on which the applications are running.

Application types From the drop-down menu, select the application types.

Select one or more check boxes to filter by the compliancy status:


l Success: Discovered applications are compliant.
Compliancy
l Failure: Discovered applications are not compliant.
l Undefined: The compliancy status cannot be retrieved.

Select one or more check boxes to filter by the protection status:


l Yes
Protection
l No
l Offline

Select one or more check boxes to filter by the application


discovery status:
l Success: One or more applications are discovered.
l Failure: No applications were discovered.
Discovery
l Warning: Application discovery failed because the virtual
machine is offline or not reachable.
l Undefined: Information about the application discovery status
is not available.

Filtering options in the Virtual Machines panel


In the Filters side panel, select one or more filtering options:

Filtering option Action

Search Enter a search term. You can filter by the virtual machine name,

63
7 Performing daily tasks

Filtering option Action

the HYCU UUID, or the Nutanix UUID.

From the drop-down menu, select the clusters that host the virtual
Clusters
machines.

From the drop-down menu, select the credentials for the virtual
Credential groups
machines.

From the drop-down menu, select the backup policies that are
Policies
assigned to the virtual machines.

From the drop-down menu, select the owners that are assigned to
Owners
the virtual machines.

Select one or more check boxes to filter by the compliancy status:


l Success: Virtual machines are compliant.
Compliancy
l Failure: Virtual machines are not compliant.
l Undefined: The compliancy status cannot be retrieved.

Select one or more check boxes to filter by the application


discovery status:
l Success: One or more applications are discovered.
l Failure: No applications were discovered.
Discovery
l Warning: Application discovery failed because the virtual
machine is offline or not reachable.
l Undefined: Information about the application discovery status
is not available.

Select one or more check boxes to filter by the protection status:


l Yes
Protection
l No
l Offline

Filtering options in the Policies panel


In the Filters side panel, select one or more filtering options:

Filtering option Action

Enter a search term. You can filter by the name of the backup
Search
policy.

Compliancy Select one or more check boxes to filter by the compliancy status:

64
7 Performing daily tasks

Filtering option Action

l Success
l Failure
l Undefined

Filtering options in the Targets panel


In the Filters side panel, select one or more filtering options:

Filtering option Action

Enter a search term. You can filter by the name of the backup
Search
target.

Select one or more check boxes to filter by the target type:


l AWS S3/Compatible
l Azure
Target type
l NFS
l SMB
l iSCSI

Select one or more check boxes to filter by the status of the target:
l Ok
Status l Warning
l Error
l Undefined

Filtering options in the Jobs panel


In the Filters side panel, select one or more filtering options:

Filtering option Action

Enter a search term. You can filter by the job name or the job
Search
UUID.

Select one or more check boxes to filter by the status of the job:
l Ok
l Warning
Status
l Failed
l Queued
l Executing

65
7 Performing daily tasks

Filtering option Action

l Aborted

Filtering options in the Events panel


In the Filters side panel, select one or more filtering options:

Filtering option Action

Enter a text string to filter the list to include only the messages with
Message
the specified string.

Username From the drop-down menu, select the user name.

Enter a text string to filter the list to include only the categories with
Category
the specified string.

Select one or more check boxes to filter by the severity of the


event:

Severity l Success
l Warning
l Failed

Filtering options in the Self-Service panel


In the Filters side panel, select one or more filtering options:

Filtering option Action

Display name Enter the name of the user account.

Username Enter the user name.

Select one or more check boxes to filter by the user role:


l Administrator
Role
l Tenant
l Built-in Administrator

Select one of the following check boxes to filter by the status of the
user (that is, which users are allowed to log on to HYCU and which
Status are not):
l Active
l Inactive

66
7 Performing daily tasks

Managing backup targets


If you have the proper permissions, you can view backup target information, edit backup
target properties, activate or deactivate a backup target, or delete a backup target if you do
not want to use it for storing protected data anymore.

Accessing the Targets panel


To access the Targets panel, in the navigation pane, click Targets.

Viewing backup target information


You can view information about each backup target in the list of backup targets in the
Targets panel. This allows you to have an overview of the general status of the backup
targets. The following information is available for each backup target:

Backup target
Description
information

Name Name of the backup target.

Type Type of backup target (AWS S3/Compatible, Azure, SMB, NFS, or iSCSI).

Health status of the backup target:


l Grey: Shows the initial backup target status before a health test. It
also indicates an inactive backup target.
l Green: The backup target is in a healthy state with backup target
utilization of less than the configured value (by default, 90%).
l Yellow: Backup target utilization is over the configured value (by
default, 90%).
Health
l Red: Backup target utilization is over the configured value (by
default, 95%). It also indicates a backup target error state after a test
task (for example, an I/O error occurred, the backup target is not
accessible, the permission is denied, and so on).

When HYCU checks if there is enough space on the backup target to


perform a backup, it calculates it by using the total provisioned space
of all disks on the virtual machine, regardless of whether the backup is
full or incremental.

Estimation of the amount of storage space that should be reserved for


Size
the backup files (in MB, GB, or TB).

Percentage of the specified backup target size that is already used for
Utilization
storing protected data.

Mode Mode of the backup target:

67
7 Performing daily tasks

Backup target
Description
information

l Read/Write: You can use this backup target for backing up and
restoring data.
l Read Only: You can use this backup target only for restoring data.

Status of the backup target:


l Active: You can use this backup target for backing up and restoring
data.
l Inactive: You cannot use this backup target for backing up and
Status restoring data. This status indicates that the backup target is
deactivated due to maintenance tasks (for example, adding new
disks).

For details on how to change the status of the backup target, see
“Activating or deactivating a backup target” below.

To open the Details section where you can find the backup target summary and more
details about the backup target, click the desired backup target.

Editing a backup target


To edit a backup target, follow these steps:
1. In the Targets panel, select the backup target that you want to edit, and then click
Edit. The Edit Target dialog box appears.
2. Edit the selected backup target as required. For detailed information about backup
target properties, see “Setting up backup targets” on page 20.

C Caution Making any changes to the target location may result in data loss.
Therefore, before specifying a new target location, make sure you have already
moved the existing backup data to this new location on the same or a different
server.

3. Click Save.

Activating or deactivating a backup target


To change the status of a backup target (that is, to activate or deactivate it), follow these
steps:
1. In the Targets panel, select the backup target that you want to activate or deactivate.
2. Change the status of the selected backup target by clicking Activate or
Deactivate.
3. Only if deactivating the backup target. Click Yes to confirm that you want to deactivate the

68
7 Performing daily tasks

selected backup target.


If you deactivate a backup target, this target will not be used for backup and restore
operations anymore.

Increasing the size of an iSCSI backup target


HYCU enables you to increase the size of your iSCSI backup target by extending the HYCU
logical volume.

Prerequisites
l The size of the backup target has been increased on the iSCSI server.
l No backup or restore job is in progress on the selected backup target.
l No other maintenance task is already running on the selected backup target (such as
editing the backup target and updating the iSCSI Initiator secret or resetting mutual
CHAP authentication sessions for the backup targets with CHAP authentication
enabled).
l No other size increase of the selected backup target has already been started.

To increase the size of an iSCSI backup target, follow these steps:


1. In the Targets panel, select the backup target whose size you want to increase.
2. In the Details section that appears at the bottom of the screen, click  Extend.
3. Click Yes to confirm that you want to increase the size of the selected backup target.

You will receive a message that indicates whether increasing the size of the iSCSI backup
target completed successfully.

Deleting a backup target


You can delete a backup target if it does not contain protected data.

i Important After deleting a backup target, no backup or restore actions including


this backup target are possible anymore.
To delete a backup target, follow these steps:
1. In the Targets panel, select the backup target that you want to delete, and then click
Delete.
2. Click Yes to confirm that you want to delete the selected backup target.

Managing backup policies


If you have the proper permissions, you can view backup policy information, edit backup
policy properties, or delete a backup policy if you do not want to use it for protecting data
anymore.

Accessing the Policies panel

69
7 Performing daily tasks

To access the Policies panel, in the navigation pane, click Policies.

Viewing backup policy information


You can view information about each backup policy in the list of backup policies in the
Policies panel. This allows you to have an overview of the general status of the backup
policies. The following information is available for each backup policy:

Backup policy
Description
information

Name Name of the backup policy.

Compliancy status of the backup policy:


l Success
l Failure
Compliancy
l Undefined

A policy is considered compliant if all virtual machines and applications


within this policy are compliant with the policy settings.

Total number of virtual machines that have the particular backup policy
VM Count
assigned to them.

Total number of applications that have the particular backup policy


APP Count
assigned to them.

Description of the backup policy (how often backup and restore jobs
Description
are performed).

To open the Details section where you can find the backup policy summary and more
details about the backup policy, click the desired backup policy.

Editing a backup policy


To edit a backup policy, follow these steps:
1. In the Policies panel, select the backup policy that you want to edit, and then click
Edit. The Edit Policy dialog box appears.
2. Edit the selected backup policy as required. For detailed information about backup
policy properties, see “Creating a backup policy” on page 32.
3. Click Save.

When editing a backup policy that is assigned to several virtual machines, one of which is
the HYCU backup controller, make sure that the backup policy remains applicable for an
internal backup. For details on protecting the HYCU backup controller, see “Protecting the
HYCU backup controller” on page 53.

70
7 Performing daily tasks

Deleting a backup policy


To delete a backup policy, follow these steps:
1. In the Policies panel, select the backup policy that you want to delete, and then click
Delete.
2. Click Yes to confirm that you want to delete the selected backup policy.

Expiring backups manually


If there is a restore point that you do not want to use for data restore anymore, you can
mark it as expired. If the most recent restore point is marked as expired, the next backup
will be a full backup.

Depending on whether you want to expire virtual machine or application backups, access
one of the following panels:

l Accessing the Virtual Machines panel


To access the Virtual Machines panel, in the navigation pane, click  Virtual
Machines.

l Accessing the Applications panel


To access the Applications panel, in the navigation pane, click  Applications.

To mark a restore point as expired, follow these steps:


1. In the Virtual Machines or Applications panel, select the virtual machine or application
for which you want the old backups to be marked as expired.
2. In the Details section that appears at the bottom of the screen, select the restore point
that you want to mark as expired.
3. Click Expire. Keep in mind that an expire action cannot be undone.
4. Click Yes to confirm that you want the selected restore point to be marked as expired.

i Important Any subsequent incremental backups until the next full backup is
performed will also be marked as expired.

After you mark a recovery point as expired, the HYCU cleaning process removes expired
backups from the backup target.

Adjusting the HYCU virtual machine


resources
When storage, vCPU, or memory utilization is exceeded (that is, when the utilization of any
of these resources is greater than 90 percent), their values that are indicated by circles
become red in the Controller widget in the Dashboard panel. To adjust the HYCU virtual
machine resources, follow these steps:

71
7 Performing daily tasks

1. Log on to Nutanix Prism. For details about the Prism web console, see Nutanix
documentation.
2. In the menu bar, click Home, and then select VM.
3. Click the Table tab to display the VM Overview view.
4. From the list of virtual machines, select your HYCU virtual machine, and then click
Power Off Actions to shut down the virtual machine.

i Important Wait a moment for the virtual machine to shut down completely.
5. Click Update, and then, in the Update VM dialog box, modify the configuration as
required, and click Save.
6. Click Power on to turn on the virtual machine.

72
Chapter 8

Managing HYCU accounts


The HYCU account management system provides security mechanisms that help prevent
unauthorized access to backup data. Only HYCU accounts have access to the HYCU
environment and can benefit from all the features that HYCU offers.

There are two kinds of HYCU accounts, the administrator account and the self-service
account. Each of these accounts includes a different type of protection service with a
specified collection of permissions and the scope of available tasks:

Protection
Description
service

An administrator account that can be one of the following:


l Built-in Administrator
Created during the deployment of the HYCU virtual appliance and
cannot be edited or deleted.
l Administrator
Can be created, edited, and deleted by the Built-in Administrator or
any other administrator.

Administrator The administrator has permissions to:


l Perform all configuration tasks in HYCU and all the tasks related to
the backup and restore of virtual machines that are not owned by
any self-service account.
l Create new accounts, edit or delete the existing ones, set the
protection service type for accounts, set ownership for virtual
machines, and enable or disable access to HYCU.

The administrator can monitor virtual machines owned by tenants, but


does not have access to backup resources.

A self-service account that represents a specific customer or


department. An administrator assigns selected virtual machines to a
Tenant tenant who gets access to backup resources and is authorized to
perform backup and restore tasks. Can be created, edited, and deleted
by the Built-in Administrator or an administrator.

73
8 Managing HYCU accounts

Protection
Description
service

i Important If the account belonging to a specific tenant is


deleted, all data that is backed up by this account is deleted from
the database.

Setting up accounts
Setting up accounts enables you to add new accounts, edit the existing ones, delete the
ones that you do not require anymore, and activate or deactivate them.

Accessing the Self-Service panel


To access the Self-Service panel, in the navigation pane, click Self-Service.

To create a new account, follow these steps:


1. In the Self-Service panel, click New. The New Account dialog box appears.
2. Enter a display name.
3. Optional. Enter an email address.
4. Enter a user name and a password.

n Note The minimum password length is six characters.


5. Select one of the following protection service types:
l Tenant
l Administrator
6. Click Save.

You can also edit any of the existing accounts (click Edit and make the required
modifications) or delete the ones that you do not need anymore (click Delete).

If you created a self-service account, you need to assign virtual machines to it. For details,
see “Setting ownership for virtual machines” on the next page.

Activating or deactivating an account


To activate or deactivate an account (that is, enable or disable logging on to HYCU with a
specific account), follow these steps:
1. In the Self-Service panel, check the status of the account that you want to activate or
deactivate.
2. Do one of the following:
l If the status of the selected account is Active and you want to deactivate it, click
Deactivate.

74
8 Managing HYCU accounts

l If the status of the selected account is Inactive and you want to activate it, click
Activate.

Setting ownership for virtual machines


As an administrator, you can set ownership for virtual machines, enabling tenants to access
the virtual machines and backup resources in the HYCU environment, and to perform
backup and restore tasks.

Accessing the Virtual Machines panel


To access the Virtual Machines panel, in the navigation pane, click  Virtual Machines.

Assigning owners to virtual machines


To assign owners to virtual machines, follow these steps:
1. In the Virtual Machines panel, select virtual machines to which you want to assign
owners, and then click Owner. The Accounts dialog box opens.

i Important If a virtual machine or an application has backup or restore jobs


in progress, or a scheduled backup task in the queue, you cannot assign a new
owner to the relevant virtual machine.

2. Select which account you want to assign as an owner of the selected virtual machines,
and then click Assign.

Removing owners from virtual machines


To remove owners from virtual machines, follow these steps:
1. In the Virtual Machines panel, select virtual machines from which you want to remove
owners, and then click Owner. The Accounts dialog box opens.
2. Select which accounts you want to remove as owners of virtual machines, and then
click Unassign.

75
Chapter 9

Administering
After you deploy HYCU, you can perform various tasks to administer and customize HYCU
for your data protection environment.

I want to... Procedure

Obtain a permanent HYCU license. “Licensing” on the next page

Upgrade HYCU to a new available version. “Upgrading HYCU” on page 79

Change network settings. “Changing network settings” on page 80

“Changing the HYCU listening port number”


Change the HYCU listening port number.
on page 81

Configure the SSL certificate. “Configuring the SSL certificate” on page 81

“Configuring FIPS-compliant mode for


Configure FIPS-compliant mode for HYCU.
HYCU” on page 82

“Setting the iSCSI Initiator secret” on


Set the iSCSI Initiator secret.
page 83

“Configuring backup target encryption” on


Configure encryption for backup targets.
page 84

Set power options. “Setting power options” on page 84

Configure log file settings to troubleshoot


problems if HYCU does not perform as “Setting up logging” on page 84
expected.

Access the HYCU backup controller virtual “Accessing the HYCU backup controller
machine by using SSH. virtual machine by using SSH” on page 85

“Using the command-line interface” on


Use hyCLI.
page 87

“Using the HYCU REST API Explorer” on


Use the HYCU REST API to automate tasks.
page 87

76
9 Administering

If for whatever reason you decide that you no longer want to use HYCU for protecting your
data, you can easily remove it from your system. For details, see “Removing HYCU” on
page 87.

Licensing
After you deploy the HYCU virtual appliance, you can start using it immediately with a
prebuilt Instant-on license. This license expires automatically after 45 days and cannot be
reused. Therefore, make sure to obtain a permanent license within this 45-day period.

The HYCU license is linked to the HYCU backup controller and is based on the number of
CPU sockets on all Nutanix clusters. You should determine the total number of CPU sockets
on all the Nutanix clusters that you plan to protect by using HYCU, so that you purchase the
required number of licenses.

n Note If you use HYCU with Nutanix Community Edition (CE) environment, you do
not require to purchase HYCU licenses.
After you purchase the required number of HYCU licenses, perform the following tasks:
1. Buy a needed number of HYCU licenses. To discuss the options, contact your Sales
representative.
2. Create a license request. For details, see “Creating a license request” below.
3. Request and obtain licenses from the web licensing portal. For details, see “Requesting
and retrieving licenses” on the next page.
4. Activate the licenses to start using HYCU. For details, see “Activating licenses” on page 79.

Accessing the Licensing dialog box


To access the Licensing dialog box, click Administration, and then select Licensing.

Creating a license request


To obtain your HYCU licenses, you should submit a request form to the web licensing
portal.

Prerequisites
l You bought the required number of HYCU licenses and have an entitlement order
number.
l You added Nutanix clusters that you want to protect to the HYCU environment. For
instructions, see “Specifying Nutanix clusters” on page 20.

To create a license request, follow these steps:


1. In the Licensing dialog box, click Download Request.
2. Save the license request file to the specified location.

Example

77
9 Administering

license.req license request file:

CN myCompany
PID nutanixbackup
ND C0F90A56-3FCC-4437-A49C-EFBA9B
NRP 3
VER V1N
HSUD FA8A5061C61F6BA5CE5A9B2C007EE
NEXT NODE

Requesting and retrieving licenses


After you create a license request file, you can obtain the licenses from the licensing portal.
Follow these steps:
1. Connect to the web licensing portal at:
https://managementpacks.comtrade.com/mp-licensing/
2. If you already have a licensing portal account, click Sign in, enter your user name and
password, and then click Login. Otherwise, create an account and then sign in with a
newly created user account.
3. Click the License Activation link, and then enter the entitlement order number in the
text box. Click Next.
4. Perform the following:
a. Select HYCU.
b. Browse for the license request file and then click Request License.
Within a few minutes, you should receive an email with a license file license.dat
attached.

Example
license.dat license file:
CN myCompany
PID nutanixbackup
ND C0F90A56-3FCC-4437-A49C-EFBA9BD8FC0F
NRP 3
EXP 02.08.2017
VER V1N
LK D29CB215357FED55304012B02143CA9437ED5D8FC556
NEXT NODE

5. Save the license file locally.

Activating licenses
After you submit your license request for the HYCU licenses to the web licensing portal, you
get an email with a product license file attached. Activate the licenses as follows:

78
9 Administering

1. In the Licensing dialog box, click Upload License.


2. Browse for the license file received by email, and then click Upload.

After the licenses are activated, the licensing related information is updated.

n Note You can always add new licenses for your grown environment. Contact your
HYCU Sales Representative.
You can check the licensing related information at any time. The following license related
information is displayed in the Licensing dialog box:
l License type
l Backup controller ID
l Status
l Actual number of sockets
l Licensed number of sockets

Upgrading HYCU
You can upgrade HYCU when a new software version is available. Because the upgrade
process aborts all currently running jobs, make sure that the jobs you do not want to be
aborted are finished and targets are deactivated before you start the upgrade.

To upgrade HYCU, follow these steps:


1. Upload the HYCU virtual appliance image that you want to use for an upgrade to your
Nutanix cluster. To do so, follow these steps:
a. Log on to the Nutanix Prism web console by using your Nutanix logon credentials.

b. In the menu bar, click , and then select Image Configuration.

c. In the Image Configuration dialog box, click Upload Image.

d. In the Create Image dialog box, provide the following information:


i. Enter the HYCU image name in the format that should correspond to that of the
HYCU image file you are uploading. Optionally, enter an annotation.

i Important Make sure to leave out the .qcow2 extension when


entering the HYCU image name.
If you enter the HYCU image name in a different format, you will not be able to
use this image for an upgrade.
ii. From the Image Type drop-down menu, select DISK.
iii. From the Storage Container drop-down menu, select a container for the image
to be uploaded.
iv. In the Image Source section, select one of the following:

79
9 Administering

i. From URL
Specify the location of the image file by using a URL.
ii. Upload a file
Specify the location of the image file saved on your file system.
e. Click Save.
f. Click Close after the image is successfully uploaded.
2. Log on to HYCU. For details, see “Logging on to HYCU” on page 18.
3. Access the Upgrade Software dialog box. To do so, click Administration, and then
select Upgrade Software.
4. In the Upgrade Software dialog box, check the current version of HYCU and all available
versions.
5. From the list of the available versions, select the one to which you want to upgrade
HYCU, and then click Upgrade.

Changing network settings


This section describes the steps you must perform if you want to change your network
settings.

Accessing the Network dialog box


To access the Network dialog box, click Administration, and then select Network.

To change network settings, follow these steps:


1. In the General tab of the Network dialog box, enter a new host name, the IP address,
the netmask associated with the chosen IP address, and the IP address of the gateway
that HYCU should use.

i Important Make sure that the IP address is set correctly so that it accurately
reflects your network environment.

2. In the DNS Addresses tab, click Add to add a new DNS address.
If you want to delete any DNS address, click Delete to the right of it.
3. In the Domains tab, click Add to add a new domain.
If you want to delete any existing domain, click Delete to the right of it.
4. Click Save.

Changing the HYCU listening port number


This section describes the steps you must perform if you want to change the HYCU listening
port number.

Accessing the Management Port dialog box


To access the Management Port dialog box, click Administration, and then select

80
9 Administering

Management Port.

To change the listening port number of the HYCU web user interface, follow these steps:
1. In the Management Port dialog box, change the existing port number to the desired
one.

i Important Make sure that the port you choose is not used by any other
process.

2. Click Save.

Configuring the SSL certificate


This section describes the steps you must perform if you want to configure the
SSL certificate.

Accessing the SSL Certificate dialog box


To access the SSL Certificate dialog box, click Administration, and then select
SSL Certificate.

In the SSL Certificate dialog box that appears, you can view the information about your SSL
certificate, such as the certificate holder's name, the certificate's expiry date, and the
strength of the certificate keys.

Depending on whether you want to create a new self-signed certificate or import a CA


certificate into HYCU, do one of the following:
l “Creating a new self-signed certificate” below
l “Importing a CA certificate” on the next page

n Note It is recommended that you replace the default self-signed certificate with a
CA signed certificate.

Creating a new self-signed certificate


To create a new self-signed certificate, do the following:
1. Click Regenerate.
2. Click Yes to confirm that you want to regenerate your SSL certificate.

Importing a CA certificate
You can import only CA certificates that are compliant with the PKCS#7 standard and
encoded in the DER or PEM format. The HYCU backup controller holds only one custom
SSL certificate. When you import a new certificate, the previous certificate is discarded.

n Note If the certificate that you want to import uses a wildcard for the Common
Name (CN), make sure that the Certificate Subject Alt Name field exists and contains the

81
9 Administering

list of all possible host names or FQDNs, and their corresponding IP addresses.
Otherwise, the certificate may be recognized as invalid by your browser or hyCLI.
To import a CA certificate, do the following:
1. Click Import. The Import dialog box appears.
2. Browse for the following imported files:
l Private key: Click Browse to select the private key associated with the certificate to
be imported.
The private key should be created by using RSA or DSA algorithm and be compliant
with the PKCS#1 or PKCS#8 standard.
l Public certificate: Click Browse to select the signed public part of the server
certificate corresponding to the private key.
l CA certificate/chain: This field is optional, if the public certificate contains CA
certificate/chain. Click Browse to select the certificate or chain of the signing
authority for the public certificate.
3. Click Import.

i Important Any changes that you make to your SSL certificate will result in an
automatic logoff.

Configuring FIPS-compliant mode for HYCU


HYCU can be configured to operate in a way that is compliant with the Federal Information
Processing Standards (FIPS), which establish security requirements for cryptography
modules (which encryption algorithms and methods for generating encryption keys can be
used).

HYCU employs a FIPS-compliant security provider that uses a cryptographically strong


random number generator (RNG). For the RNG to generate truly random numbers, an
adequate source of entropy is required. Because HYCU is running on a virtual machine, the
amount of entropy that is available to it is limited and therefore an additional hardware
source of entropy is needed. This source is usually provided by the real CPU or chipset. To
enable access to this hardware entropy source, an additional service (rngd.service) is
enabled on the HYCU backup controller.

Depending on the nature of your business, you can either enable or disable FIPS-compliant
mode for HYCU.

Limitation
When FIPS-compliant mode is enabled, you cannot assign credentials to Linux virtual
machines, and consequently restore individual files.

Enabling FIPS-compliant mode for HYCU

82
9 Administering

To enable FIPS-compliant mode for HYCU, as the root user or by using sudo, do the
following:
1. Stop the HYCU web server:

systemctl stop grizzly.service

2. Enable FIPS-compliant mode:

/opt/grizzly/bin/enable_fips.sh

3. Start the HYCU web server:

systemctl start grizzly.service

Disabling FIPS-compliant mode for HYCU


If the nature of your business changes, you can easily disable FIPS-compliant mode. To do
so, as the root user or by using sudo, do the following:
1. Stop the HYCU web server:

systemctl stop grizzly.service

2. Disable FIPS-compliant mode:

/opt/grizzly/bin/enable_fips.sh -d

3. Start the HYCU web server:

systemctl start grizzly.service

Setting the iSCSI Initiator secret


During the HYCU deployment, the HYCU iSCSI client, referred to as the iSCSI Initiator, is set
up so that HYCU can use iSCSI targets for storing data.

If you want to configure mutual CHAP authentication between the iSCSI Initiator and the
iSCSI target, you must specify the iSCSI Initiator secret (the security key). For details on how
to enable mutual authentication, see “Setting up backup targets” on page 20.

Accessing the iSCSI Initiator dialog box


To access the iSCSI Initiator dialog box, click Administration, and then select iSCSI
Initiator.

To set the iSCSI Initiator secret, follow these steps:


1. In the iSCSI Initiator dialog box, enter the secret.
2. Click Save.

83
9 Administering

Configuring backup target encryption


If you enabled backup target encryption when setting up your backup target, you can get
information about which algorithm is used, view a list of currently encrypted backup
targets, and export the encryption key to a file.

Accessing the Encryption dialog box


To access the Encryption dialog box, click Administration, and then select Encryption.

To export the encryption key to a file, in the Encryption dialog box, click Export.

Setting power options


You can set power options for the HYCU backup controller so that its activities are
suspended or resumed.

Accessing the Power Options dialog box


To access the Power Options dialog box, click Administration, and then select Power
Options.

Power option Description

Pauses all HYCU backup controller activities.

All currently running jobs are allowed to complete normally. All jobs
Suspend
that are in the queue will start when the HYCU backup controller is
resumed. While activities are paused, you cannot start any new jobs.

Resume Allows HYCU backup controller activities to continue.

Setting up logging
This section describes the steps you must perform if you want to set up logging to help you
analyze and troubleshoot the entire HYCU operation and the backup and restore
functionality.

Accessing the Logging dialog box


To access the Logging dialog box, click Administration, and then select Logging.

To set up logging , follow these steps:


1. In the Logging dialog box, set the maximum log file size and the number of log files to
keep. The default log file size is 10 MB.
2. Select one of the following log levels:

84
9 Administering

Log level Description

All All activity is recorded to log files.

Errors that affect the immediate operation of HYCU are recorded to


Severe
log files.

Potentially harmful situations that do not represent an immediate


Warning
threat to the operation of HYCU are recorded to log files.

Informational messages about the operation of HYCU are recorded


Informational
to log files.

3. When required, you can download log files by clicking Download Logs. After you
extract the log.zip file, check the log files at the following location:
/opt/grizzly/logs/

4. Click Save.

Accessing the HYCU backup controller virtual


machine by using SSH
You can perform most administrative tasks of the HYCU backup controller by using the
HYCU web user interface or command-line user interface (hyCLI). The only two exceptions
for which you should use SSH are restarting the HYCU web server (the Grizzly server) or the
entire appliance.

i Important Using SSH to perform any tasks other than restarting the HYCU web
server or the entire appliance is not recommended.
After you deploy the HYCU virtual appliance, you can use the following default credentials to
access the HYCU backup controller virtual machine by using SSH:

User name: hycu

Password: hycu/4u

Changing the default SSH password


For security purposes, it is highly recommended that you change the default SSH password.
To do so, follow these steps:
1. Open a remote session to the HYCU backup controller virtual machine:

ssh hycu@<HYCU_backup_controller_IP_address>

When requested, enter the default password.


2. Change the password for the hycu user:

85
9 Administering

passwd

When requested, enter the default password again, and then enter and verify your new
password.

Disabling SSH access


You can disable SSH access at any time. To do so, follow these steps:
1. Open a remote session to the HYCU backup controller virtual machine:

ssh hycu@<HYCU_backup_controller_IP_address>

When requested, enter the password for the hycu user.


2. Shut down the SSH service:

sudo service sshd stop

When requested, enter the password for the hycu user.


3. Disable the SSH service:

sudo chkconfig sshd off

If requested, enter the password for the hycu user.

After performing this procedure, your SSH connection will be disabled. To re-enable SSH,
you need to connect to the HYCU backup controller virtual machine through the Nutanix
Prism web console.

Managing the HYCU web server


To manage the HYCU web server, follow these steps:
1. Open a remote session to the HYCU backup controller virtual machine:

ssh hycu@<HYCU_backup_controller_IP_address>

When requested, enter the password for the hycu user.


2. Perform the desired operation on the HYCU web server:

sudo service grizzly {start | stop | restart}

When requested, enter the password for the hycu user.

Using the command-line interface


You can manage your backup environment also by using the HYCU command-line user
interface (hyCLI). hyCLI provides the functionality comparable to the HYCU web user
interface and enables you to implement scripts for automating certain tasks.

To enable the usage of hyCLI, follow these steps:

86
9 Administering

1. Download the hycli.zip package. To do so, click  at the upper right of the screen,
and then select Download hyCLI.
2. Save and extract the hyCLI.zip file to any location on your system.
3. Add the directory containing the extracted files to the PATH environment variable.

n Note hyCLI log files are located at .Hycu/log in the user's home directory. You can
change logging settings for hyCLI in the logging.properties and log4j.properties
files located in the directory containing the extracted files.
For detailed information about hyCLI, see the README.txt file that you can find in the
directory containing the extracted files.

For more information on the hyCLI structure, commands, and usage, run the hycli help
command.

Using the HYCU REST API Explorer


HYCU provides a REST API that can be used by external applications to interact with the
HYCU backup controller, retrieve information from it, and automate tasks. All functionality
exposed through the HYCU user interface is also available through the HYCU REST API. You
can use the HYCU REST API Explorer to interact with the API and view the expected input
and output formats for each endpoint.

To access the HYCU REST API Explorer, follow these steps:


1. Click  at the upper right of the screen, and then select REST API Explorer. The HYCU
REST API Explorer opens.
2. In the list of functionality groups, you can expand the desired group by clicking List
Operations. A list of API endpoints is displayed.
3. Click any of the endpoints to show the description, the parameters, and the output
format. You can fill in the fields, and then click Try it out! to call an API and get output
data.

Removing HYCU
When you remove HYCU from your environment, you also need to perform additional
cleanup tasks.

To remove HYCU, follow these steps:


1. Log on to HYCU, and then unassign policies from all virtual machines and applications
as follows:
l To unassign virtual machines:
a. In the navigation pane, click  Virtual Machines.
b. Select all virtual machines, and then click Policies. The Policies dialog box
appears.

87
9 Administering

c. Click Unassign. The Unassign Policy prompt appears.


d. Click Yes to confirm that you want to delete the policies assigned to the selected
virtual machines.
l To unassign applications:
a. In the navigation pane, click  Applications.
b. Select all discovered applications, and then click Policies. The Policies dialog
box appears.
c. Click Unassign. The Unassign Policy prompt appears.
d. Click Yes to confirm that you want to delete the policies assigned to the selected
applications.
2. On the HYCU backup controller virtual machine, run the
/opt/grizzly/bin/HycuCleanup.pl script as follows:

sudo perl HycuCleanup.pl -c <Nutanix_cluster> -u <user_name> -p


<password>

In this instance, <Nutanix_cluster> is the name of the Nutanix cluster in URL format:


https://<server_name>:<port>.

i Important By running this command, you will also remove all third-party
snapshots created by using Nutanix REST API v3, not only those created by HYCU.

3. Log on to the Nutanix Prism web console by using your Nutanix logon credentials.
Delete the HYCU backup controller virtual machine as follows:
a. In the menu bar, click Home, and then select VM.
b. Click the Table tab, and then, from the list of virtual machines, select the HYCU
backup controller virtual machine.

c. Click Delete. In the dialog box that appears, click Delete to confirm that you want
to delete the HYCU backup controller virtual machine.

88
Appendix A

Customizing HYCU
configuration settings
You can customize the configuration settings in the config.properties file to meet your
specific HYCU environment needs and provide optimal performance. You can find the
config.properties file in the /opt/grizzly folder on your HYCU backup controller.

Depending on which configuration settings you want to customize, see one of the following
sections:
l “Email notification settings” on the next page
l “Snapshot settings” on page 91
l “Utilization threshold settings” on page 91
l “Display settings” on page 92
l “Scheduler settings” on page 92
l “SQL Server application settings” on page 92
l “Settings for aborting jobs” on page 92

How to customize HYCU configuration


settings
To customize HYCU configuration settings, follow these steps:
1. Open a remote session to the HYCU backup controller virtual machine:

ssh hycu@<HYCU_backup_controller_IP_address>

When requested, enter the password for the hycu user.


For detailed information about accessing the HYCU backup controller virtual machine
by using SSH, see “Accessing the HYCU backup controller virtual machine by using SSH”
on page 85.
2. Use the following command to access and open the config.properties file:

sudo vi /opt/grizzly/config.properties

89
A Customizing HYCU configuration settings

n Note Because you will use the vi console text editor to customize HYCU
configuration settings, basic knowledge of using the editor is required.

3. Edit any of the existing configuration settings as required.


4. Save and exit the config.properties file. To do so, press the Esc key, and then type
the following:

:wq!

5. Restart the HYCU web server (the Grizzly server) for the changes to take effect:

sudo service grizzly restart

Email notification settings


If you want HYCU to send email notifications based on the occurrence of a specific event,
adjust the following settings:

Setting Description

Host name or IP address of the SMTP server from


event.notification.smtp.server
which email notifications are sent.

Port number of the SMTP server from which email


event.notification.smtp.port
notifications are sent (usually set to 25).

If the server from which email notifications are sent


event.notification.smtp.tls uses TLS, set this setting to true. Otherwise, leave
the default false value.

If the server from which email notifications are sent


event.notification.smtp.ssl uses SSL, set this setting to true. Otherwise, leave
the default false value.

User name of the account on the SMTP server from


event.notification.smtp.username
which email notifications are sent.

Password of the account on the SMTP server from


event.notification.smtp.password
which email notifications are sent.

event.notification.sender.email Email from which email notifications are sent.

event.notification.sender.name Display name of the email sender.

event.notification.sender.subject Subject for the sent email.

List of email recipients that will get the Info


notifications. To separate multiple email recipients,
event.notification.green.receiver.list use a comma.

If you leave this setting blank, HYCU will not send

90
A Customizing HYCU configuration settings

Setting Description

email notifications for this severity level of the


event.

List of email recipients that will get the Warning


notifications. To separate multiple email recipients,
event.notification.orange.receiver.list use a comma.
If you leave this setting blank, HYCU will not send
email notifications for this severity level of the
event.

List of email recipients that will get the Error


notifications. To separate multiple email recipients,
use a comma.
event.notification.red.receiver.list
If you leave this setting blank, HYCU will not send
email notifications for this severity level of the
event.

Snapshot settings
You can customize the maximum number of snapshots to be retained by adjusting these
settings:

Setting Description

Maximum number of snapshots that are retained per virtual


max.snapshots.per.vm
machine. The default value is 24.

Maximum number of snapshots that are retained per


max.snapshots.per.cluster
Nutanix cluster. The default value is 2400.

Utilization threshold settings


You can use the following settings to configure the backup target utilization thresholds:

Setting Description

If the HYCU backup controller utilization of the


backup target exceeds the specified value, its
target.utilization.threshold.health.red
health status indicator becomes red. The
default value is 0.95.

If the HYCU backup controller utilization of the


backup target exceeds the specified value, its
target.utilization.threshold.health.yellow
health status indicator becomes yellow. The
default value is 0.90.

91
A Customizing HYCU configuration settings

For detailed information about the health status of the backup target, see “Viewing backup
target information” on page 67.

Display settings
You can use the following settings to customize the maximum number of displayed items:

Setting Description

Maximum number of files that are displayed for each


items.per.directory.in.flr directory when restoring individual files. The default value is
1000.

Maximum number of backups that are displayed for a virtual


max.backups.displayed
machine. The default value is 100.

Scheduler settings
You can use the following setting to customize the behavior of the HYCU scheduler:

Setting Description

If the amount of changed data since the last full


backup is greater than the specified value, the
scheduler.percent.when.switch.to.full scheduler switches from performing an
incremental backup to performing a full backup.
The default value is 0.25.

SQL Server application settings


You can use the following setting to customize the backup of SQL Server applications:

Setting Description

During the backup of an SQL Server application, transaction


log compression is enabled by default (the default value is 1).
sql.translog.compress
If you want to disable it, make sure to set the value for this
setting to 0.

Settings for aborting jobs


You can use the following settings to configure when a job that has the Executing status will
be aborted automatically:

Setting Description

Time (in minutes) within which a job must be completed.


jobs.abort.deadline.minutes
The default value is 1440.

92
A Customizing HYCU configuration settings

Setting Description

Time interval (in minutes) at which all jobs that have the
Executing status are retrieved and stopped if they have
jobs.abort.interval.minutes
been in this status longer than specified in the
jobs.abort.deadline.minutes setting. The default value is 15.

93
Provide feedback
For any suggestions and comments regarding this product or its documentation, send us
an e-mail to:

[email protected]

We will be glad to hear from you!


www.comtradesoftware.com

You might also like