version 11 service pack 4 early release - knowledge base · pdf file ·...

Admin Console Version 11 Service Pack 4 Early Release

Published on Tuesday, July 19, 2016

2 Commvault Version 11 Service Pack 4 Early Release - July 19, 2016

Contents

Introduction to the Admin Console 5

Installation 6

System Requirements for the Admin Console .......................................................................... 7 Installing the Stand-Alone Admin Console Package ................................................................. 9

Preinstallation Checklist for the Admin Console ............................................................ 11 Installing the Virtual Server Protection Package .................................................................... 15 Installing the Commvault Edge Server Package ..................................................................... 16

Creating a Custom End-User Endpoint Package ........................................................... 17 Installing the End-User Endpoint Package on a Windows Operating System .................. 18 Installing the End-User Endpoint Package on a Mac Operating System ......................... 19

Installing the Commvault Express Package ........................................................................... 20

Accessing the Admin Console 21

Virtualization 23

Virtual Server Agent (VSA) .................................................................................................. 23 VSA System Requirements .................................................................................................. 24 Getting Started with Admin Console ..................................................................................... 26 Using the Setup Wizard for the Virtualization Application ....................................................... 27 Configuration for Virtualization............................................................................................. 28

Security Configuration for Virtualization ...................................................................... 29 Servers ..................................................................................................................... 31 Collections ................................................................................................................ 35

Backups ............................................................................................................................. 44 Performing a Backup ................................................................................................. 44

Restores ............................................................................................................................. 45 Restoring Guest Files and Folders for VMware ............................................................. 45 Restoring Guest Files and Folders for Hyper-V ............................................................. 46 Restoring Virtual Machine Disk Files ............................................................................ 48 Attaching a Disk to an Existing VM for VMware ............................................................ 48 Restoring Full Virtual Machines for VMware ................................................................. 50 Restoring Full Virtual Machines for Hyper-V ................................................................. 52

Viewing Virtual Machine Information .................................................................................... 53 Reports .............................................................................................................................. 54

Endpoint 55

Getting Started with the Endpoint Application ....................................................................... 55 Using the Setup Wizard for the Endpoint Application ............................................................. 56 Inviting Users and User Groups to Install the End-User Endpoint Package .............................. 57 Devices .............................................................................................................................. 58

Manually Performing a Backup ................................................................................... 58 Restoring Files and Folders ........................................................................................ 59

Commvault Version 11 Service Pack 4 Early Release - July 19, 2016 3

Tracking the Location of a Device ............................................................................... 60 Download Center ................................................................................................................ 61

Accessing the Download Center .................................................................................. 62 Adding a Repository .................................................................................................. 63 Managing Repositories ............................................................................................... 64 Adding a Package ...................................................................................................... 64 Managing Packages ................................................................................................... 65 Package Information Page ......................................................................................... 66 Download Details Page .............................................................................................. 69

Database Agents 71

Introduction to the Admin Console for Oracle Databases ....................................................... 73 Getting Started with the Oracle Admin Console ........................................................... 75 Oracle Configuration .................................................................................................. 77 Oracle Backups ......................................................................................................... 83 Oracle Restores ......................................................................................................... 85

Introduction to the Admin Console for SAP HANA Databases ................................................. 89 Getting Started with the SAP HANA Admin Console ..................................................... 91 SAP HANA Configuration ............................................................................................ 92 SAP HANA Backups .................................................................................................. 101 SAP HANA Restores ................................................................................................. 102

Plans 104

Creating a Server Plan ....................................................................................................... 105 Creating a Laptop Plan ...................................................................................................... 106

Companies 108

Adding a Company ............................................................................................................ 108 Editing Plans for a Company .............................................................................................. 109

Monitoring 110

Alerts ............................................................................................................................... 110 Creating an Alert Definition ...................................................................................... 110 Managing Alerts ...................................................................................................... 110 Alert Information ..................................................................................................... 112

Viewing Events ................................................................................................................. 112 Jobs ................................................................................................................................. 112

Controlling Activities ................................................................................................ 113 Controlling Jobs ....................................................................................................... 113 Viewing Jobs ........................................................................................................... 113 Sending Log Files .................................................................................................... 114 Job Information ....................................................................................................... 115

Storage Targets 117

Configuring a Disk Library as a Storage Target ................................................................... 117 Adding a Mount Path ............................................................................................... 118

Configuring a Cloud Library as a Storage Target ................................................................. 118 Cloud Provider Information ...................................................................................... 119


User Security Settings 122

Users and User Groups ...................................................................................................... 122 Creating a User ....................................................................................................... 122 Managing Users....................................................................................................... 123 Creating a User Group ............................................................................................. 123 Managing User Groups ............................................................................................. 123 Managing User Group Membership ........................................................................... 124

Adding Domains ............................................................................................................... 124 Managing Roles ................................................................................................................ 125 Administrating the Security Associations of a Server ............................................................ 126

System Settings 127

Applying a License ............................................................................................................ 127 Branding the Admin Console .............................................................................................. 128 Creating Global Exceptions ................................................................................................ 128 Creating an Operation Window Rule ................................................................................... 129 Configuring an Email Server .............................................................................................. 129 Registering the Admin Console .......................................................................................... 129

Early Release 131

Index 133


Introduction to the Admin Console The Admin Console is a web-based user interface for administration tasks that provides default configuration values and streamlined procedures for routine data protection tasks. You can use the Admin Console to set

up the data protection environment, to identify content that you want to protect, and to initiate and monitor backups and restores.

Admin Console is available for:

Endpoint (on page 55)

Oracle (on page 71)

SAP HANA (on page 91)

Virtual machine data protection (on page 23) for VMware and Microsoft Hyper-V environments


Installation The installation of the Admin Console differs for new and existing Commvault customers.

The following sections describe installation scenarios to help you select the appropriate installation path.

Existing Customers

Existing customers already have a CommServe computer and other Commvault software installed in their

environment.

If you are an existing customer, proceed to install the Admin Console. For instructions, see Installing the Stand-Alone Admin Console Package (on page 9).

New Customers

Before you can install the Admin Console, the CommServe software must be installed in your environment.

Commvault provides installation packages that adjust to your organization needs. The packages include the CommServe, Admin Console, and other software required to set up your CommCell environment.

Review the following list to select the package that best matches the needs of your organization.

I plan to protect virtual machines.

Install the Virtual Server Protection package (on page 15). This package includes the CommServe, Admin Console, Virtual Server Agent, and other software required to set up your CommCell environment.

I plan to protect laptop computers.

Install the Commvault Edge Server package (on page 16). This package includes the CommServe, Admin Console, File System Agent, and other software required to set up your CommCell environment.

I plan to protect databases and other applications.

Install the Commvault Express package (on page 20). This package includes the CommServe, Admin

Console, Agents, and other software required to set up your CommCell environment.


System Requirements for the Admin Console

The Admin Console requirements vary between new and existing Commvault customers.

If you are an existing customer, read the requirements for stand-alone Admin Console installations.

If you are a new customer, Commvault provides installation packages that includes the necessary

software to set up your CommCell environment. Read the requirements for the installation package that

you want to install: Virtual Server Protection, Commvault Edge Server, or Commvault Express package.

Requirements for Stand-Alone Admin Console Installations

If you plan to install the Admin Console on the CommServe computer, you must have an additional 2 GB of

disk space.

If you plan to install the Admin Console on a different computer, the computer must satisfy the following

requirements:

Operating Systems

Microsoft Windows Server 2012 R2 x64 Editions

Microsoft Windows Server 2012 x64 Editions


Hard Drive 2 GB recommended.

Memory 8 GB RAM minimum required

Processor All Windows-compatible processors supported

Requirements for the Virtual Server Protection (VSP) Package

If you install the VSP package, the computer must satisfy the following requirements:

Operating Systems




Hard Drive

500 GB recommended.

Depending upon the number of virtual machines that you are planning to backup, ensure that the backup server computer has sufficient free space to store all virtual machine data.



IIS IIS must be enabled on the backup server.


Requirements for Commvault Edge Server and Commvault Express Packages

If you install the Commvault Edge Server or Commvault Express package, the computer must satisfy the

following requirements:

Operating Systems




Hard Drive 500 GB recommended.



IIS IIS must be enabled on the computer.

Supported Web Browsers

You can run the Admin Console on the following browsers:

Google Chrome v5 or later

Microsoft Internet Explorer (IE) v10 or later

Mozilla Firefox v2.0.0.3 or later

Safari v2.0.4 or later


Installing the Stand-Alone Admin Console Package

If you already have the CommServe software and other Commvault software installed in your organization,

you can add the Admin Console to your CommCell environment by using the CommCell Console or the

Download Manager application.

Before You Begin

Prepare for the installation by reviewing the following tasks:

Review Commvault requirements and gather the information that you must provide during the

installation. For more information, see Preinstallation Checklist for the Admin Console (on page 11).

If you plan to install the Admin Console by using the Download Manager application, download the latest

version of the application from the Cloud Services (https://cloud.commvault.com/webconsole/downloadcenter/dc.do?ps=10&q=&type=dc&fn=PRODUCT_

VERSION_NAME%252CCATEGORY_NAME&cp=1&fn_PRODUCT_VERSION_NAME_val=11&fn_CATEGOR

Y_NAME_val=v11%20ServicePack/Installer) website. The Download Manager is displayed as V11 SPn Media Kit and Service Pack.

Procedure

Use one of the following methods to install the Admin Console:

Remote Installations

Use the CommCell Console to install the Admin Console remotely on one or more computers.

1. From the CommCell Console ribbon, on the Tools tab, click Add/Remove Software > Install

Software.

The Install Wizard opens.

2. Follow the instructions in the installation wizard.

Local Installations

Use the Download Manager to install the Admin Console locally on a computer.

1. Log on to the computer as an Administrator or as a member of the Administrator group on that computer.

2. Start the Download Manager, select where to extract the installation files, and then click Extract.

3. On the welcome page, select the I Agree check box and proceed to the next page.

4. On the Choose the Installation Type page, click Install packages on this computer and proceed

to the next page.

5. Follow the instructions in the installation wizard.

https://cloud.commvault.com/webconsole/downloadcenter/dc.do?ps=10&q=&type=dc&fn=PRODUCT_VERSION_NAME%252CCATEGORY_NAME&cp=1&fn_PRODUCT_VERSION_NAME_val=11&fn_CATEGORY_NAME_val=v11%20ServicePack/Installer




What to Do Next

Provide the Admin Console URL to backup administrators and other users that might need to access the

console.

To get started with the Admin Console, refer to the getting started instructions for the application that you

want to use. For example, Getting Started with Virtualization (on page 26).


Preinstallation Checklist for the Admin Console

The preinstallation checklist applies for those customers that already have a CommCell environment and

only want to add the Admin Console package to their environment.

Use the preinstallation checklist as a quick reference guide to help you prepare the computer where the

Admin Console will be installed, and to gather the information required during the installation.

Verify System Requirements

Verify that the computer where you plan to install the Admin Console satisfies the minimum requirements

specified in System Requirements (on page 7).

Verify License Requirements

The Admin Console does not require a license.

Determine the Installation Location

Install the Admin Console on the CommServe computer or on a computer that can connect to the

CommServe and Web Server computers.

If you do not choose to install the Admin Console on the CommServe computer, you can install the Admin

Console on a physical computer or a virtual machine.

Determine Whether You Need Additional Commvault Software

The Admin Console requires the Web Server and the Web Console. If these packages are not installed in

your CommCell environment, they must be installed along with the Admin Console.

If you plan to protect VMware virtual machines from the Admin Console, the Virtual Server Agent must

be installed on the CommServe computer.

Gather Installation Data

Refer to the items in this section to gather the information that you will need during the installation. Record the information before you begin installing the software, so you can refer to it during the installation.

You can install the Admin Console using either the CommCell Console or the Download Manager application.

Any item that applies to only one of these installation methods is noted.

Commvault package to install

Install the Admin Console package, which is listed under the Server category.

If you are installing the Admin Console on the CommServe computer, we recommend that you consider the

following steps:

If web services are not set up in your CommCell environment, install the Web Server and the Web

Console.


If you plan to protect VMware virtual machines, install the Virtual Server package, which is listed

under the Virtualization category.

Client computer details

If the File System Agent, or another package, is already installed on the computer, you are not required to

gather all the computer details again. The level of detail depends on how the package you selected is

installed:

For installations using the CommCell Console, the installation program requests only the name of the

client computer.

For installations using the installation package, the installation program reads the details from the

previous installation.

Web Server client name

The name of the client computer where the Web Server is installed. If there is more than one Web Server

client, determine which client you want to use as the Web Server.

Additional information if other Commvault is not installed

If the computer where you plan to install the Admin Console does not have the File System Agent installed, you must also gather the following information as it will be needed during the installation.

Required Information Description

Destination folder for the software installation

By default, the software is installed in C:\Program

Files\Commvault\ContentStore.

You can change the destination folder, but it cannot be on a mapped

network drive.

The installation program uses the C:\%allusersprofile% folder as a

temporary location to copy the installation files. This location does not

change, even if you choose to install the software on a drive other than C.

Firewall services

If there is a firewall between the client computer and the CommServe

computer, gather the following information based on your firewall setup:

Client connects to the CommServe computer (One-Way Firewall)

Select an HTTP or HTTPS port number that can be used to open

tunnel connections to the CommServe computer.

If the client is separated from the CommServe computer by an HTTP

proxy, collect the host name (or IP address) and the port number of the HTTP proxy through which the CommServe computer can be

reached

CommServe computer connects to the client (One-Way Firewall)

Select a local HTTP or HTTPS port number that can be used by the CommServe computer to open tunnel connections towards the client

CommServe computer can be reached only through a Proxy


Collect the following information:

Client name of the Commvault proxy (name is case-sensitive).

HTTP or HTTPS tunnel port number on which the proxy expects connections.

If the CommServe computer is behind a port-forwarding gateway, collect the port number of the gateway instead.

Host name or IP address of the proxy through which the CommServe computer can be reached.

If the CommServe computer is behind a port-forwarding

gateway, collect the host name or IP address of the gateway instead.

Note: If the client is separated from the CommServe computer by an

HTTP proxy, collect the host name (or IP address) and the port number of the HTTP proxy through which the CommServe computer can be

reached.


Client certificates

This information is only applicable to installations using the Download Manager.

If the CommCell environment is in "lockdown" mode, create a temporary certificate to authenticate the client installation.

Note: Installations using the CommCell Console are not supported when

the CommCell is in "lockdown" mode.

CommServe host name

Record the host name of the CommServe computer (fully qualified

domain name or IP address.) The CommServe host name cannot include

spaces or any of the following characters: \|`~!@#$%^&*()+=<>/?,[]{}:;'"

Note: If there is a firewall between the client computer and the CommServe computer, you also need to record the name of the

CommServe client, as seen in the CommCell Browser (the name is case-sensitive). The installation program requires this information for all

firewall setups, except for environments where only the CommServe can

connect to the client.

Client computer details

For installations using the CommCell Console:

Collect the host name (fully qualified domain name) of the

computers on which you want to install the software. You also need

an administrative account that has access to all the computers. The account details are not required for existing clients.

For installations using the Download Manager:

By default, the installation program uses the local (NetBIOS) name of the computer to configure the client name in the CommServe

database as well as the display name in the CommCell Console.

Optionally, you can use a different display name to represent the client. Do not include spaces in the name.

The installation program also uses the default network interface name (host name) of the computer to communicate with the

CommServe computer. If the computer has multiple network interfaces, select the interface name to use.

Windows Firewall for

Computer Profiles

This information is only applicable to installations using the Download

Manager.

If Windows Firewall is enabled for some profiles (PublicProfile,

DomainProfile, and StandardProfile), decide whether you want to disable

Windows Firewall for all profiles.

Windows Firewall Exclusion

List

If the computer has Windows Firewall turned on, you can add the

Commvault programs and services to the Windows Firewall exclusion list

during the installation. We recommend this configuration which enables CommCell operations across the firewall.


Client Groups If you want the computer to share the same properties of a client group, and client groups are configured in your CommCell environment, select a

client group to use.

Subclient Policy If you have subclient policies configured in your CommCell environment, select a policy to associate to the default subclient.

Storage policy If you have storage policies configured in your CommCell environment,

select a policy to associate to the default subclient.

Installing the Virtual Server Protection Package

Use the Virtual Server Protection package to set up a CommCell environment for protecting virtual machines.

This package includes the following Commvault software: CommServe, Admin Console, Virtual Server Agent,

MediaAgent, CommCell Console, Web Server, Web Console, and Workflow Engine.

Before You Begin

Download the Virtual Server Protection

(https://cloud.commvault.com/webconsole/downloadcenter/dc.do?sp=relDateDesc&sortDir=desc&ps=1

0&q=&type=dc&fn=PRODUCT_VERSION_NAME%252CCATEGORY_NAME%252CSUBCATEGORY_NAME&cp=1&fn_PRODUCT_VERSION_NAME_val=11&fn_CATEGORY_NAME_val=v11%20ServicePack/Installer&

fn_SUBCATEGORY_NAME_val=Virtual%20Server%20Protection) installer from the Cloud Services website.

Verify that the computer where you plan to install the package satisfies the minimum requirements


Procedure

1. Start the Virtual Server Protection installer, select where to extract the installation files, and then click

Extract.


3. On the Choose the Installation Type page, click Install packages on this computer and proceed to the next page.

4. On the Destination Path page, change the default path if you want to install the software on a

different location, and then proceed to the next page.

The installation starts.

5. On the completion page, make a note of the Admin Console URL and then click Finish.

What to Do Next

Provide the Admin Console URL to backup administrators, database administrators, and other users that

might need to access the console.

To get started with the Admin Console, see Getting Started with Virtualization (on page 26).

https://cloud.commvault.com/webconsole/downloadcenter/dc.do?sp=relDateDesc&sortDir=desc&ps=10&q=&type=dc&fn=PRODUCT_VERSION_NAME%252CCATEGORY_NAME%252CSUBCATEGORY_NAME&cp=1&fn_PRODUCT_VERSION_NAME_val=11&fn_CATEGORY_NAME_val=v11%20ServicePack/Installer&fn_SUBCATEGORY_NAME_val=Virtual%20Server%20Protection





Installing the Commvault Edge Server Package

Use the Commvault Edge Server package to set up a CommCell environment for protecting laptop

computers.

This package includes the following Commvault software: CommServe, Admin Console, File System Agent, MediaAgent, CommCell Console, Web Server, Web Console, and Workflow Engine.

Before You Begin

Download the Commvault Edge Server

(https://cloud.commvault.com/webconsole/downloadcenter/dc.do?sp=relDateDesc&sortDir=desc&ps=1

0&q=&type=dc&fn=PRODUCT_VERSION_NAME%252CCATEGORY_NAME%252CSUBCATEGORY_NAME&cp=1&fn_PRODUCT_VERSION_NAME_val=11&fn_CATEGORY_NAME_val=Edge&fn_SUBCATEGORY_NA

ME_val=Server) installer from the Cloud Services website.



Procedure

1. Start the Commvault Edge Server installer, select where to extract the installation files, and then click Extract.


3. On the Choose the Installation Type page, click Install packages on this computer and proceed to the next page.

4. On the Destination Path page, change the default path if you want to install the software on a different location, and then proceed to the next page.

The installation starts.


What to Do Next

If you want to minimize the information your end users must provide during the installation of the end-user Endpoint package, you can create a custom package. For information on creating a custom package, see

Creating an End-User Endpoint Package (on page 17).

To get started with the Admin Console, see Getting Started with Endpoint (on page 55).

https://cloud.commvault.com/webconsole/downloadcenter/dc.do?sp=relDateDesc&sortDir=desc&ps=10&q=&type=dc&fn=PRODUCT_VERSION_NAME%252CCATEGORY_NAME%252CSUBCATEGORY_NAME&cp=1&fn_PRODUCT_VERSION_NAME_val=11&fn_CATEGORY_NAME_val=Edge&fn_SUBCATEGORY_NAME_val=Server





Creating a Custom End-User Endpoint Package

From the Cloud Services website, you can generate custom proxy and end-user Endpoint packages. Creating

a custom package minimizes the information your end users must provide when they install the package on their devices.

Applies To: Windows and Macintosh

Before You Begin

You must have an account on the Commvault Cloud website https://cloud.commvault.com.

Procedure

1. Log on to the Commvault Cloud website https://cloud.commvault.com, and on the Forms page, open

the Custom Install Package Creation

(https://cloud.commvault.com/webconsole/forms/?tab=0&workflowName=Custom Install Package Creation&workflowId=2286) form.

2. On the form, fill in the following information:

In the CS Client Name (case sensitive) box, enter the name of the CommServe. The name that

you enter is case-sensitive and must match the CommServe name in the database.

In the CS Hostname box, enter the host name of the CommServe. You can also use an IP address instead of the host name.

Optional: The proxy computer communicates with laptops that are outside the network. If you are

using a proxy, select the Use Proxy check box to create a proxy package.

Optional: If you want to disable the user authentication prompt during installation, clear the Request end users to enter their credentials during installation check box. By default, user

authentication is enabled.

3. Click Next.

4. Optional: If you selected the Use Proxy check box, fill in the following information:

In the Proxy Client Name (case sensitive) box, enter the name of the proxy computer. The name that you enter must match with the name of the proxy computer in the CommServe.

In the Proxy Hostname box, enter the host name of the proxy computer. You can also use an IP address instead of the host name.

In the Port Number box, enter the port number. This port will be used for incoming connections to the proxy computer, when a firewall is configured.

5. Optional: If you cleared the Request end users to enter their credentials during installation check box, fill in the following information:

In the Username box, enter the user name that the end-user must provide during the silent installation of the package.

In the Password box, enter the password that the end-user must provide during the silent

installation of the package.

6. On the summary page, do either of the following:

Click Edit Advanced Options and click OK. Fill in the following information:

a. Optional: Select the Allow users to enter an install directory check box, so that the end

users can create an install directory. This option is applicable only for Windows laptops.

https://cloud.commvault.com/


https://cloud.commvault.com/webconsole/forms/?tab=0&workflowName=Custom%20Install%20Package%20Creation&workflowId=2286

https://cloud.commvault.com/webconsole/forms/?tab=0&workflowName=Custom%20Install%20Package%20Creation&workflowId=2286


b. Optional: Select the Do not create laptop shortcuts or apps check box if you do not

want the end users to use the Edge Monitor tool.

c. Click Next.

d. Click OK to create the packages.

Click OK to create the packages.

7. Verify the confirmation email.

You will receive an email confirming the package creation request. Subsequently, you will receive

another email with links to the following downloadable packages:

32 bit proxy (if the Use Proxy option was selected)

64 bit proxy (if the Use Proxy option was selected)

32 bit Windows

64 bit Windows

Macintosh Dmg

Macintosh Pkg

8. Using the link provided, download the packages.

What to Do Next

Setup the Download Center and place the end-user Endpoint packages in a Download Center repository so

that your end users can access the packages. For information on setting up the Download Center, see Download Center (on page 61).

Installing the End-User Endpoint Package on a Windows Operating System

After you invite your end users to install the end-user Endpoint package, they will use the following

procedure to do the installation.

Procedure

1. Access the Web Console by doing the following:

If you received an email from your administrator with a link to the package, click on the link in the email.

Open your web browser and type the Web Console URL provided by the administrator in the address bar.

The URL should be in the following format: http://webhost/webconsole, for example: http://client.mydomain.com/webconsole.

2. On the Login screen, enter your active directory login credentials and then click Login to access the Web Console.

3. On the My Applications page, click Download Center.

4. In the Open File - Security Warning dialog box, click Run.

5. On the Download Center page, download the package available for your computer.

If you are unable to download the package, contact your System Administrator.


6. After the download is complete, double click the .exe file.

The Custom Install Package wizard opens.

7. Click Next to continue.

8. On the Extraction Path page, enter the location where you want to extract the package and click

Next.

The installation proceeds silently and may take several minutes to complete.

When the installation finishes, the Process Manager dialog box opens.

9. On the Register Me tab of the Process Manager dialog box, provide the following details:

a. Enter the name of the laptop in the Computer Name box. The computer name might be already

provided.

b. Enter your Web Console credentials in the User Name and Password boxes.

c. Click Register.

Installing the End-User Endpoint Package on a Mac Operating System

After you invite your end users to install the end-user Endpoint package, they will use the following procedure to do the installation.

Procedure

1. Access the Web Console by doing the following:

If you received an email from your administrator with a link to the package, click on the link in the email.

Open your web browser and type the Web Console URL provided by the administrator in the address bar.

The URL should be in the following format: http://webhost/webconsole, for example:

http://client.mydomain.com/webconsole.

2. On the Login screen, enter your active directory login credentials and then click Login to access the

Web Console.

3. On the My Applications page, click Download Center.

4. Download the Commvault.dmg package.

If you are unable to download the package, contact your System Administrator.

5. Double click the Commvault.dmg file that you downloaded.

The installation wizard opens.

6. On the installation wizard, double click the Commvault icon to start the installation:

If the CommServe is configured to authenticate users performing installations in the CommCell, the CommServe Authentication page is displayed. Enter your active directory login credentials and

then click Continue.

If a firewall is enabled on the Macintosh computer, you might be prompted to allow some programs (such as cvd and cvfwd) through the local firewall. To continue the installation, click Allow when

prompted.


7. If your Apple device prompts you for your password to allow the software installation, enter the

password and then click Allow.

During installation, you can use the View menu to monitor the installer log and review the services status, among other operations.

After the installation completes, the Process Manager application is displayed. If the Process Manager is not displayed, you can open it from the Applications window.

8. On the Introduction page of the Process Manager application, click Continue to register.

9. On the Configuration page, provide the following details:

a. In the Computer Name box, enter the name of the device. The name may be already provided.

b. Enter the CommServe host name in the CommServe box, for example, cs.mydomain.mycompany.com. The CommServe name may be already provided.

c. Enter your Web Console credentials in the User Name and Password boxes.

d. Click Continue.

10. On the Summary page, review the information and then click Register.

11. When the Process Manager prompts you for your password to proceed with the registration, enter the password and then click OK.

12. Click Close to exit the laptop registration.

13. On the installation wizard, click Done to exit the wizard.

Installing the Commvault Express Package

Use the Commvault Express package to set up a CommCell environment for protecting databases and other applications.

This package includes the necessary Commvault software to get you started: CommServe, Admin Console, File System Agent, MediaAgent, CommCell Console, Web Server, Web Console, and Workflow Engine.

Before You Begin

Download the Commvault Express

(https://cloud.commvault.com/webconsole/downloadcenter/dc.do?ps=10&q=express&type=dc&fn=CAT

EGORY_NAME%252CSUBCATEGORY_NAME&cp=1&fn_CATEGORY_NAME_val=v11%20ServicePack/Inst

aller&fn_SUBCATEGORY_NAME_val=SMB) installer from the Cloud Services website.



Procedure

1. Start the Commvault Express installer, select where to extract the installation files, and then click

Extract.


3. On the Choose the Installation Type page, click Install packages on this computer and proceed

to the next page.

4. On the Select Packages page, select the check box for the CommServe, MediaAgent, and Admin

Console. Proceed to the next page.

https://cloud.commvault.com/webconsole/downloadcenter/dc.do?ps=10&q=express&type=dc&fn=CATEGORY_NAME%252CSUBCATEGORY_NAME&cp=1&fn_CATEGORY_NAME_val=v11%20ServicePack/Installer&fn_SUBCATEGORY_NAME_val=SMB




Note: The CommCell Console, File System Agent, Web Server, Web Console, and Workflow Engine are

automatically selected.

5. On the Destination Path page, change the default path if you want to install the software on a different location, and then proceed to the next page.

6. On the Database Engine Installation Path page, change the default path if you want to install the Microsoft SQL Server software on a different location, and then proceed to the next page.

7. On the CommServe Database Installation Path page, change the default path if you want to store the CommServe database files on a different location, and then proceed to the next page.

8. On the Disaster Recovery Path page, specify a local or network path to store disaster recovery files,

and then proceed to the next page.

9. On the Configure Proxy Service page, do not make any changes and then proceed to the next page.

10. On the Installation Summary page, review your selections and then proceed to the next page.

11. On the Client Computer Information page, the computer name and host name are automatically

provided. Proceed to the next page.

12. On the Firewall Configuration page, determine whether you want to disable Windows Firewall for all profiles, and then proceed to the next page.

13. On the Database Install Option page, the option to create a new database is automatically selected. Proceed to the next page.

14. On the CommCell Administrator Account page, specify a password for the CommCell administrator as well as an email address. Proceed to the next page.


What to Do Next

Provide the Admin Console URL to backup administrators, database administrators, and other users that

might need to access the console.

To get started with the Admin Console, refer to the getting started instructions for the databases that you

want to protect. For example, for Oracle databases, see Getting Started with the Oracle Admin Console (on

page 75).

Accessing the Admin Console You can access the Admin Console by using the URL that your administrator provides.

Procedure

1. Go to the Admin Console URL that your administrator provided.

The URL format has the following format: http://webhost/adminconsole/login.

2. Type your user name and password, and then click Login.


Result

When you log on, the Servers page is displayed by default. If it is the first time you are logging on and no

servers are assigned to you, the Quick Setup wizard is displayed. Note: Not all agents offer the Quick Setup wizard.

What to Do Next

Refer to the documentation that corresponds to the application that you want to use, for example,

Virtualization (on page 23).

If you want to switch between modules, click the building block icon located at the upper-left corner of

the Admin Console, and then select the module that you want to use.


Virtualization The Admin Console is a web-based interface that administrators can use to protect and recover virtual machines.

You can use the Admin Console to back up virtual machines running on VMware or Microsoft Hyper-V, restore data from virtual machines, and manage protection operations.

To get started quickly, you can perform simple configuration of virtual machine servers, storage, and virtual

machine collections in a few minutes, then initiate protection operations immediately. The Admin Console can be used to initiate backups and restores, provide information about virtual machine protection, and

manage jobs, schedules, alerts, events, and users.

Note: When the Admin Console is added to an existing Commvault deployment, previously configured

entities such as servers are also available in the Admin Console.

Key Features

Protect virtual machines in a VMware vCenter, ESX server, or Hyper-V server.

Quickly configure servers, storage, and collections of virtual machines to back up.

Back up collections of virtual machines immediately or by using a defined schedule.

Restore full virtual machines, disks, and guest files with granular backup and recovery options.

Monitor jobs, events, and alerts.

Virtual Server Agent (VSA)

The VSA is installed on computers that can perform backup and restore operations for a specific hypervisor platform such as VMware and Microsoft Hyper-V.

For VMware support, the VSA is installed on one or more physical computers or virtual machines.

For Microsoft Hyper-V support, the VSA is installed on a standalone Hyper-V server or on all Hyper-V

servers in a cluster.


VSA System Requirements

When installing the Admin Console with an existing Commvault deployment, ensure that the following

requirements are met:

At least one machine must have the Virtual Server Agent installed.

To add Hyper-V servers, the CommServe system must have the Virtual Server Agent installed.

Hyper-V Nodes

For Microsoft Hyper-V, the Virtual Server Agent can be installed on a standalone Hyper-V Server or a node in

the Hyper-V cluster. If the Virtual Server Agent is not installed on a Hyper-V node that is selected as a VSA proxy, the Virtual Server Agent and additional software must be pushed to that machine during Virtualization

setup.

Hyper-V nodes must satisfy the following system requirements:

Operating Systems Microsoft Hyper-V Server 2012 R2 with latest Microsoft HotFixes installed

Hard Drive

100 GB recommended.

If performing backups with the granular recovery option enabled, the location of the Job Results folder should contain additional space to accommodate at least 2% of the total amount of data being backed up.

Memory 16 to 24 GB RAM minimum required beyond the requirements of the operating system and running applications.

Processor Dual Core with minimum of 2.2 GHz required

NTFS volumes The cluster size or the allocation unit size of an NTFS volume in a virtual machine must be a multiple of 1024 bytes. You can set the cluster size before formatting a volume. The default cluster size is 4096 bytes.

Virtual Machines

For Hyper-V environments, the Admin Console supports all guest operating systems supported by Microsoft

Hyper-V.

For VMware environments, the following system requirements apply for virtual machines:

Virtual Machine Host

The following versions are supported for vSphere, vCenter, vCenter Server Appliance, and ESX/ESXi:

4.1 or later, 5.0.x, 5.1.x, 5.5, 5.5.1, 5.5.2, 5.5.3*, 6.0, 6.0.1,

6.0.2

For any ESXi servers, the VADP is not available in the free version of ESXi. The Essentials licensing level or higher is required.


Virtual Machine Hardware Version 4.0, 7.0, 8.0, 9.0, 10.0, 11.0

Virtual Machine Operating Systems All Guest Operating Systems supported by VADP

VMware Tools on Virtual Machines

Install the latest version of VMware Tools supported by the host on each virtual machine. At a minimum, the version of VMware tools on virtual machines must also be supported on the host; unsupported versions must be upgraded.


Getting Started with Admin Console

This topic describes the high-level steps that first-time users must follow to set up the Virtualization

application in the Admin Console.

Step 1: Install the Admin Console

To access the Virtualization application, the administrator must install the Admin Console. For instructions,

see one of the following procedures:

If you have the CommServe computer and other Commvault software installed in your environment, see

Installing the Stand-Alone Admin Console Package (on page 9).

If you do not have a CommCell environment, see Installing the Virtual Server Protection Package (on

page 15).

Step 2: Log onto the Admin Console

Access the Admin Console (on page 21) using the URL that was provided by the administrator.

Step 3: Complete the Wizard for the Virtualization Application

Perform initial configurations to set up the Virtualization application by completing the Virtualization Setup

(on page 27).

During the setup, you will add a server, configure storage, add virtual machines, and perform other

important configurations.

Note: For Hyper-V, when you add a server, you must also include the steps to discover and select nodes. After you add a server, you can add storage and collections. A default collection that includes all virtual

machines is created automatically for Hyper-V, but you should create a collection that includes a smaller

number of virtual machines for initial testing of the backup and restore process.

Step 4: Perform Your First Backup and Restore

For instructions, see the following procedures:

1. Perform a backup (on page 44).

2. Restore full virtual machines or files and folders (on page 45).


Using the Setup Wizard for the Virtualization Application

When you log on to the Admin Console for the first time, a setup wizard guides you through the basic setup

required by the Virtualization application.

Before You Begin


You will need the following information to complete the setup wizard:

The name and port number of your email server

The name, IP address, and user credentials for virtualization servers for VMware or Microsoft Hyper-V

For Hyper-V, one or more nodes on which you will install the VSA to create proxies for backup and restore operations

The location of the disk library to use to store backed up data

About This Task

At any point during the setup wizard, click Finish setup later to leave the wizard. If you leave the setup wizard before it is complete, it will appear the next time you log on.

Procedure

Perform the following steps to configure email, server, storage, and virtual machine information. If other

applications have already been configured, some steps might be skipped.

1. Log on to the Admin Console (on page 21).

2. On the Register product page, register the software using your Commvault Cloud

https://cloud.commvault.com credentials.

3. Click Save.

4. On the Configure email page, type email account information for Admin Console: SMTP server, SMTP port, the email address that is used to send alert notifications, and the name of the alert email address.

For more information, see Configuring an Email Server (on page 129).

5. Click Save.

6. On the Add server page, select the virtualization vendor (VMware or Hyper-V), and then provide a

descriptive name for the server, a fully qualified hostname or IP address (for a vCenter, ESX server, Hyper-V standalone server, Hyper-V cluster, or a node in a Hyper-V cluster), and the user credentials to

provide administrative access to the server or cluster. For more information, see Adding a Server (on

page 31).

For a Hyper-V server:

a. Click Discover nodes.

b. When the Proxies field is populated, select one or more nodes on which to install the Virtual Server

Agent.




Note: You can continue the setup process while the VSA is being installed on Hyper-V nodes, but you

cannot perform backups until that installation is complete.

7. Click Save.

8. On the Add disk library page, type a display name for the storage library, select a MediaAgent, select

Local path or Network path, and type a full path name for the storage location (or browse to a folder). For access to a network-attached storage device, provide user credentials. For more information,

see Storage Targets (on page 117).

9. Click Create library.

10. On the Add server plan page, type a name for the plan, then provide information about storage, retention, and backup schedules. For more information, see Creating a Server Plan (on page 105).

11. Click Save.

12. On the Add collection page, type a descriptive name to identify the collection, and then select virtual machines to be protected. For more information, see Adding a Collection (on page 35).

13. Click Save.

14. To finish, choose one of the following options:

Click Back up Now to perform an immediate backup of the virtual machines in the collection (without requiring confirmation).

The collections page displays with job status information shown under the Backup heading.

Click Go to Servers to save the new setup and continue to the Servers page, where you can explore further or perform additional configuration.

Note: For Hyper-V, the Back up Now option might not be available immediately. You can go to the Servers page.

When VSA installation on proxies is complete, perform a backup (on page 44).

Configuration for Virtualization

The first time you log on you are prompted to add a server, configure storage, and identify collections of virtual machines to back up as described in Using the Virtualization Setup Wizard (on page 27).

To support ongoing operations, you can add servers, collections, storage, and users.


Security Configuration for Virtualization

The Admin Console provides predefined user groups and roles that can be used to manage security for

users, servers, collections, and virtual machines.

User Groups

The following predefined user groups are created by default:

Administrator

Backup operator

Restore operator

View All

Roles

Roles have assigned privileges that enable them to perform actions in the Admin Console. The following

roles are predefined for Admin Console:

Administrator_Role

Alert Creator

Alert Owner

All Users Laptops

Backup operator_Role

Client Admins

Compliance

End Users

Master

MSP Subscription: Only for MSP administrators managing a multi-tenant environment.

Plan Creator Role

Plan Subscription Role

Restore operator_Role

View

Virtualization Requirements

For servers, collections, or virtual machines, you can associate users or groups with roles to determine what actions users can perform. You can also assign users or groups as owners who have management privileges

for those entities.

You can use predefined roles, modify predefined roles to fit your requirements, or create new roles.

Subject to your organization's requirements, the following privileges are required for general administrative

users for virtualization:


All Alert privileges

The following Client privileges are required:

Agent Management

Agent Scheduling

Install Package/Update

Data Protection/Management Operations

Browse

In Place Recover

Out-of-Place Recover

In Place Full Machine Recovery

Out of Place Full Machine Recovery

Overwrite on restore

The following Commcell privileges are required:

License Management

Install Client

The following Global privileges are required:

Administrative Management

Job Management

Alert Management

View

Change security settings

Events Organizer

All Plan privileges

All Schedule Policy privileges

All Storage Management privileges

All User Management privileges

Note: In a multi-tenant environment, all Workflow privileges should also be included for VSA administrators.


Servers

Servers provide hosting for virtual machines. You can include servers for VMware and Microsoft Hyper-V in

the same Admin Console implementation:

For VMware, a server can be a vCenter or a standalone ESX server.

For Hyper-V, a server can be a Hyper-V cluster, a Hyper-V server in a cluster, or a standalone Hyper-V

server.

The main Servers page shows all of the servers in your environment. You can click on any server to get

summary information, or click on a Jobs link in the Actions column to check the status of jobs for a server. Some users may only have access to specific servers for which they are responsible.

For each server, you can define collections of virtual machines that you want to manage separately. For example, you can put virtual machines in different collections so that you can have different backup criteria

or schedules for different classes of virtual machines.

Adding a Server

Add a server to support data protection operations for all virtual machines hosted or managed by the server.

Before You Begin

You will need the following information to add a server:

The name, IP address, and user credentials for a virtualization server for VMware or Microsoft Hyper-V

For Hyper-V, one or more nodes on which you will install the VSA to create proxies for backup and

restore operations

Procedure

1. From the navigation pane, click Servers.

The Servers page appears.

2. Click Add Server.

3. For Select type, select one of the following:

Hyper-V

VMware

4. For Server name, type a descriptive name for the server.

5. For Hostname / IP address, type the fully qualified host name or IP address for the server.

For VMware, the server can be a vCenter or a standalone ESX server.

For Hyper-V, the server can be a Hyper-V cluster, a Hyper-V server in a cluster, or a standalone Hyper-V server.

6. Type the user credentials for the server in the User name and Password boxes. The server user must

have administrative rights and appropriate permissions on the server.

7. Depending on the hypervisor type for the server, perform one of the following actions:


For a VMware server, when adding an additional server to an existing configuration, select a Virtual Server Agent proxy from the Proxy list.

This step is not required when configuring the first server through the Virtualization Setup (on page

27) process.

For a Hyper-V server:

a. Click Discover nodes.

b. When the Nodes field is populated, select one or more nodes on which to install the Virtual Server Agent. For a Microsoft Hyper-V cluster, select all nodes in the cluster.

8. Click Save.

Viewing Server and Collection Details

When you log on or click Servers in the navigation pane, the list of configured servers is displayed. You can use the Servers page to add or view server information, to access collections of virtual machines, or to

check job status.

Servers Page

From the main Servers page, you can perform the following actions:

Click Send log files to collect log information for a support case.

Click Add server to configure a new server.

Click an entry in the Name column to view server details.

Under the Actions column, click the action button in the row for the server and select one of the following options:

Click Jobs to view all jobs.

Click Delete to delete the server (confirmation is required for this action).

Click Send logs to collect log information for a support case.


Server Detail Page

When you select a specific server, you can view details for the server:

The number of virtual machines that are protected (backed up), not protected, backed up with errors, or all VMs. You can click on a bar in the graph to view reports (on page 54).

Whether Data management (backups) and Data recovery are enabled for the server.

What alerts are enabled.

What Virtual Server Agent proxies are available to perform backup and restore operations for the server.

Security associations and virtual machine owners.

What collections of virtual machines are configured.

From the server details page, you can perform the following actions:

Click Jobs at the top right to view all jobs for the server.

Click Edit server details at the top right to change the host name, user name, or password.

Click Delete at the top right to delete this server entry. You are then asked to confirm this action.

Deleting a server also deletes all backups for the server.

Click a bar in the VM status area to display information about virtual machines on the server.

Click the ON or OFF button for Data management or Data recovery to toggle those settings.

Click an alert to view the alert definition, including the list of users who receive the alert.

In the Proxy area, click Reorder to change the sequence that is used to select proxies for jobs, or click

Edit to enable or disable proxies for use with this server.

In the Security area, click Edit to assign roles to users or user groups or to add owners for virtual

machines.

In the Collections area you can perform the following actions:

Click Add collection to create a new collection of virtual machines to back up.

Click a collection name to view or modify collection settings.

Click Restore to recover data from the collection on the same row. The Restore button is only

displayed if a successful backup has been performed for a collection.

Click Jobs to view job information for the collection on the same row.

Under the Actions column for the Collections area, you can click the action button in the row for

the collection and select one of the following options:

Click Delete to remove a collection. You are then asked to confirm this action. Deleting a collection also deletes all backups for the collection. You cannot delete a default collection.

Click Back up now to perform an immediate backup of the virtual machines in the collection.


Collection Detail Page

When you select a collection from the server details page, you can view details for the collection:

Display showing the number of virtual machines for the collection that are protected, unprotected, backed up with errors, or all VMs. You can click on a bar in the graph to view reports (on page 54).

A summary of backup information.

Whether backup jobs are currently running.

The content that is defined for the collection (virtual machines to be backed up).

Security information.

Storage information.

Options for default backup settings, including changed block tracking (CBT), number of readers, and

application or crash consistent backups.

Scheduled backup jobs.

Proxy information.

Alerts enabled for the collection. You can click on an alert to view the alert definition, including the list of

users who receive the alert.

From the collection details page, you can perform the following actions:

Click a bar in the VM status area to display information about virtual machines on the server.

In the Summary area, you can toggle Data management on or off to enable or disable backups and

restores.

In the Backup area, click Jobs to view jobs, or Back up now to perform a backup for the collection.

In the Content area, click Manage to add virtual machines to a collection or change existing content

selections.

Under the Content area, click Show filters to view filters that are defined to exclude virtual machines

from backups.

In the Security area, click Edit to change user security settings or VM ownership.

In the Storage area, click Edit to change the storage library name or the retention period for backup

data.

In the Options area, click Edit to change backup options.

In the Schedules area, click Manage to add or modify a scheduled backup.

In the Proxy area, click Reorder to change the sequence that is used to select proxies for jobs, or click

Edit to enable or disable proxies for use with this server.

In the Alerts area, click an alert entry to view the alert definition.

Editing Server Information

You can change settings for a server by editing the server details.

Procedure




2. Click the name of the server.

The server details page appears.

3. In the top right corner of the page, click Edit server details.

The Edit server details dialog box appears.

4. To point to a different server, type a new value in the Hostname / IP Address box.

5. To change the user account that is used to access the server, complete the following steps:

a. In the New user name box, type the user name.

b. In the New password and Confirm new password boxes, type the password.

6. To change the password for an existing user:

a. In the Current password field, type the old password.

b. In the New password and Confirm new password fields, type the new password.

7. Click Save.

Collections

Collections are sets of virtual machines that can be included in backup or restore operations. Each server

contains at least one default collection, which provides protection for any virtual machines that are not

included in another collection.

You can add additional collections for a server as needed. For example, you can put virtual machines in

different collections so that you can have different backup criteria or schedules for different classes of virtual machines.

Collections for a server are displayed on the details page for the server. You can select a collection to view

summary information, get status, and perform backups and restores.

Adding a Collection

Add a collection to identify a specific set of virtual machines to back up or restore.

Procedure



2. Click the name of the server that hosts the virtual machines.

The server details page appears. The Collections area displays summary information for any existing

collections.

3. Click Add collection.

4. In the Add collection dialog box, provide the following information:

Name: Type a descriptive name for the collection.


Browse and select VMs: Expand the tree below this field to select hosts, specific VMs, or VM storage locations for the collection. Click Select all to quickly select all virtual machines or Clear all

to remove all current selections.

You can select one of the following options from the grouping list to control the browse display:

Group by host: Select this option to view hosts and the VMs running on each host. Select a

host entry to protect all VMs on the host, or expand the tree to select specific VMs.

For Hyper-V, virtual machines are shown directly under the host.

For VMware, the top level of the browse shows all accessible vCenters at the top level, ESX servers under vCenters, and virtual machines under each ESX server.

VMs: Select this option to browse and select specific VMs.

Storage (Hyper-V only): Select this option to view storage containing virtual machine data.

Select the storage entry to protect all VMs on the storage, or expand the tree to select specific VMs.

Group by datastore (VMware only): Select this option to view datastores containing virtual

machine data. The top level of the browse shows all accessible hosts at the top level, with datastores under hosts and virtual machines under each datastore. Select a datastore entry to

protect all VMs on the storage, or expand the tree to select specific VMs.

Plan: Select a plan that specifies the storage, retention, and backup schedule.

5. Click OK to save the collection.

Collections are created with default settings for backup options. To change default settings, see Editing

Collection Options (on page 40).

Managing Collection Content

For an existing collection, you can add virtual machines or modify the content selections.

Procedure





collections.

3. Click the name of an existing collection.

4. Click Manage in the Content area.

The Content tab of the Collection content page shows the currently selected content to be backed up (hosts, specific VMs, or source virtual machine storage).

5. To remove a virtual machine, click in the Actions column of the row for the VM and select Remove.

6. To add collection content, click Add virtual machines.

The Add virtual machines page appears.

7. Select a browse method for the Browse and select VMs list, and then expand the tree below the list

to select hosts, specific VMs, or VM storage locations for the collection, or to clear previous selections.


You can select one of the following options from the list to control the browse display:

Group by host: Select this option to view hosts and the VMs running on each host. Select a host entry to protect all VMs on the host, or expand the tree to select specific VMs.


For VMware, the top level of the browse shows all accessible vCenters at the top level, ESX servers

under vCenters, and virtual machines under each ESX server.


Storage (Hyper-V only): Select this option to view storage containing virtual machine data. Select the storage entry to protect all VMs on the storage, or expand the tree to select specific VMs.

Group by datastore (VMware only): Select this option to view datastores containing virtual machine data. The top level of the browse shows all accessible hosts at the top level, with datastores under hosts and virtual machines under each datastore. Select a datastore entry to

protect all VMs on the storage, or expand the tree to select specific VMs.

8. Click OK after selecting VMs or other objects.

9. To discover virtual machines automatically:

a. Click Add rule.

b. From the Select rule for list, choose one of the following:

Virtual machine name/pattern: Type the display name of the virtual machine or a pattern

using wildcards (for example, Test* to identify VMs for which the VM name begins with

"Test").

Guest DNS hostname: Type a hostname or a pattern to identify a hostname or domain (for

example, myhost.mycompany.com to identify a specific host or *mycompany.com to identify

all hosts on that domain).

Guest OS: Type the exact name of the operating system or a pattern to identify an operating

system group (for example, Microsoft* to identify any virtual machine that has a version of

the Windows operating system).

Host: Type the host name, the IP address of the host, or a host name pattern using wildcards.

When you add a host, all virtual machines on the host are included in the backup.

Notes: Type a pattern to identify virtual machines based on notes text contained in annotations

for the VM summary (for example, Test* to identify VMs with a note that begins with "Test").

Power state: Select the power on status of virtual machines to be included in the subclient

content. You can select one of the following options:

On: to identify VMs that are powered on.

Off: to identify VMs that are powered off.

Other: to identify VMs with a different power on status, such as Suspended.

c. From the Which matches with list, select Equals, Contains, Starts with, or Ends with.

d. In the Name box, type a string to match a VM name or host.

e. Click OK.

10. To edit a rule, click in the Actions column of the row for the VM and select Edit rule.

11. Click Preview to see a list of the virtual machines that will be backed up and the hosts for the VMs.

12. Click OK to save the changes to collection content.


Creating VM Filters

From the Collection content dialog box, you can create filters to exclude virtual machines from backups.

Procedure





collections.



The Collection content dialog box appears.

The Filters tab shows content to be excluded from backups.

5. On the Filters tab, to remove a filter, click in the Actions column of the row for the filter and select Remove.

6. To add filters by browsing, click Add virtual machines.

7. In the Add virtual machines page, select a browse method for the Browse and select VMs list, and

then expand the tree below the list to select hosts, specific VMs, or VM storage locations for the

collection, or to clear previous selections.

You can select one of the following options from the list to control the browse display:

Group by host: Select this option to view hosts and the VMs running on each host. Select a host entry to exclude all VMs on the host, or expand the tree to select specific VMs.


For VMware, the top level of the browse shows all accessible vCenters at the top level, ESX servers under vCenters, and virtual machines under each ESX server.


Storage (Hyper-V only): Select this option to view storage containing virtual machine data. Select the storage entry to exclude all VMs on the storage, or expand the tree to select specific VMs.

Group by datastore (VMware only): Select this option to view datastores containing virtual

machine data. The top level of the browse shows all accessible hosts at the top level, with datastores under hosts and virtual machines under each datastore. Select a datastore entry to

exclude all VMs on the storage, or expand the tree to select specific VMs.

8. Click OK after selecting VMs or other objects.

9. To exclude virtual machines based on different criteria:

a. Click Add filter rule and then provide information for the rule:

b. From the Select rule for list, choose one of the following:


Virtual machine name/pattern: Type the display name of the virtual machine or a pattern

using wildcards (for example, Test* to identify VMs for which the VM name begins with

"Test").

Guest DNS hostname: Type a hostname or a pattern to identify a hostname or domain (for

example, myhost.mycompany.com to identify a specific host or *mycompany.com to identify

all hosts on that domain).

Guest OS: Type the exact name of the operating system or a pattern to identify an operating

system group (for example, Microsoft* to identify any virtual machine that has a version of

the Windows operating system).

Host: Type the host name, the IP address of the host, or a host name pattern using wildcards.

When you add a host, all virtual machines on the host are excluded from the backup.

Notes: Type a pattern to identify virtual machines based on notes text contained in annotations

for the VM summary (for example, Test* to identify VMs with a note that begins with "Test").

Power state: Select the power on status of virtual machines to be excluded from backups. You

can select one of the following options:

On: to identify VMs that are powered on.

Off: to identify VMs that are powered off.

Other: to identify VMs with a different power on status, such as Suspended.

c. From the Which matches with list, choose Equals, Contains, Starts with, or Ends with.

d. In the Name box, type a string to match the type of entity selected for the rule.

e. Click OK.

10. To edit a rule, click in the Actions column of the row for the VM and select Edit rule.


Creating Disk Filters

From the Collection content dialog box, you can create disk filters to exclude virtual machine disks from backups.

Procedure





collections.



The Collection content dialog box appears.

The Disk Filters tab shows disks to be excluded from backups.

5. On the Disk Filters tab, to remove a filter, click in the Actions column of the row for the filter and select Remove.


6. To exclude virtual machine disks, click Add disk filter.

7. In the Add disk filter dialog, provide information for the rule:

a. From the Disk filter type list, choose one of the following:

Hard disk label (VMware only): Select this option to filter disks based on number labels.

Specify the range by typing values in the Hard Disk Number From and Hard Disk Number

To boxes.

Virtual device node: Select this option to filter a specific device node.

For VMware, select the node from the Virtual Device Node list.

For Hyper-V, select a disk controller from the Controller list, and type an integer for the controller channel in the Location box.

VMDK name/pattern (VMware) or Virtual disk name/pattern (Hyper-V): Type a pattern for

the names of disks to filter.

For VMware, you can filter disks with patterns such as VMName.vmdk, *VMName.vmdk,

/**/folder/VM*.vmdk, or [Datastore]*/VM*.vmdk).

For Hyper-V, you can filter disks using patterns such as VMName.vhd or VMName.vhdx.

b. Click OK.

8. To edit a rule, click in the Actions column of the row for the filter and select Edit rule.


Editing Collection Options

For an existing collection, you can modify options that affect backups.

VMware Transport Considerations

Licensing: In vSphere 5.0, the SCSI HotAdd feature is enabled only for vSphere editions Enterprise and higher, which have Hot Add licensing enabled. No separate Hot Add license is available for purchase as an

add-on. In vSphere 4.1, Hot Add was also enabled in the Advanced edition. Customers with vSphere

Essentials or Standard editions are not able to perform proxy-based backup, which relies on SCSI HotAdd. Those customers must use alternate transport modes.

SCSI Controllers: HotAdd relies on the SCSI protocol and does not support IDE disks. Use the LSI SCSI controller. The paravirtual SCSI controller (PVSCSI) is not supported for HotAdd.

Procedure





collections.

3. Click the name of a collection.

The Options area shows settings that are used to back up the virtual machines in the collection.


4. In the Options area, click Edit.

5. In the Edit options dialog box, provide the following information:

Use changed block tracking: Select this option to use changed block tracking (CBT) for backups.

With CBT, backups only write blocks that have changed since the previous backup. For virtual

machines where there is a known issue with CBT, you can turn off CBT to run backups using the

cyclic redundancy check (CRC) method instead.

For Hyper-V, CBT is only available for Hyper-V Server 2012 R2.

No. of readers: Set the number of readers to control how many parallel read operations can be launched during backups.

Virtual machine backup type: Select one of the following options:

File system and application consistent: An application consistent backup quiesces the file

system and applications while performing the backup.

Crash consistent: A crash consistent backup takes a point-in-time snapshot of virtual machine

data without quiescing.

Transport mode for VMware (VMware only): Select one of the following options:

Auto: The transport mode is selected automatically based on the backup environment:

If the datastore is accessible to a physical proxy, SAN is used.

If the datastore is accessible to the ESX server for a virtual proxy, HotAdd is used.

Otherwise, NBD is used.

SAN: For directly connected storage using Fibre Channel (FC) or Internet SCCI (iSCSI) protocols.

The Virtual Server Agent must have access to the datastore LUNs (logical drives) that provide

storage for virtual machine disks. Data is read directly from the storage where virtual machines reside, without going through the ESX host or transferring data over the local area network

(LAN). The ESX host is contacted only to coordinate access to the LUN. SAN transport mode cannot be used if the proxy computer is a virtual machine.

Hot Add: The Virtual Server Agent is installed on a virtual machine residing on an ESX Server. In

HotAdd mode, the data volumes containing the virtual machines to be backed up are

automatically mounted to the proxy, so they can be accessed by the proxy as a local disk. The ESX host the proxy is running on must have access to all datastores for the virtual machine. If

the virtual machine and the proxy are not on the same host, all datastores must be shared between the hosts.

NBD: Data is transferred using the TCP/IP connection between the ESX server and the proxy

computer. The local area network (LAN) can be the production network or a dedicated backup network.

NBD SSL: Similar to NBD mode, but data transfer between the proxy computer and the ESX

server is encrypted. Encryption should be used for sensitive information, even within a private

network.

Datastore freespace check (VMware only): Select this option to ensure that there is sufficient free space on the datastore before performing the backup.

Datastore freespace required (VMware only): Type the percentage of free space that should be available on the datastore before performing the backup.

6. Click Save.


Managing Proxies

Virtual Server Agent (VSA) proxies are used to perform backup and restore operations. Any machine where

the VSA is installed can act as a VSA proxy. Different proxies are used for VMware and Hyper-V.

By default, the first available proxy listed for a collection acts as a coordinator for jobs, distributing

operations to any other proxies that are available for the collection.

You can add or remove proxies for a server or a collection, or change the order in which proxies are listed.

By default, all collections for a server use the proxies for the server, unless a different list is specified for the

collection.

Note: If you select a new Hyper-V node as a proxy for a server, the Admin Console initiates a remote install

to push the Virtual Server Agent, MediaAgent, and VSS provider to the new node. At the collection level, only nodes that are already enabled as VSA proxies are displayed for selection, so no additional installs are

required.

Procedure

Adding or Removing Proxies

1. In the Proxy area for a server or collection, click Edit.

The Edit proxy dialog box lists all proxies that are available for the hypervisor.

In the Hyper-V server details, all Hyper-V nodes are displayed. At the collection level, only nodes that are already enabled as VSA proxies are displayed.

2. In the Edit proxy dialog box, select the check box for each proxy to be used for operations with the

server or collection, and clear the check box for each proxy that should not be used.

3. Click OK.

Changing the Order of Proxies

1. In the Proxy area for a server or collection, click Reorder.

The Reorder option is only displayed if multiple proxies are specified.

2. Click to move a proxy up in the list, or to move a proxy down.

3. Click Save to save the change in sequence.

Managing Schedules

You can create a schedule for periodic backups from a collection of virtual machines for a server.

Procedure





collections.


3. In the Collections area, click the name of the collection that contains the virtual machines to back up.

4. In the Schedules area, click Add schedule.

5. In the Schedules dialog box, provide the following information:

Name: Type a descriptive name for the schedule (for example, Weekly Full Backup).

Backup level:

Incremental: Selected by default. An incremental backup only backs up changes since the last

full backup.

Full: Perform a full backup for a virtual machine that has previously been backed up. A full

backup includes virtual machine configuration files and all virtual machine data disks.

Synthetic full: Create a synthesized backup from the most recent full backup and all

subsequent incremental backups. The resulting synthetic full backup is identical to a full backup

for the collection. Unlike full and incremental, a synthetic full backup does not actually transfer data from a client computer to the backup media, and does not use any resources on the client

computer.

A full backup is always performed for the first backup of any virtual machine.

Enable granular recovery: When this option is selected, file and folder metadata is collected

during backup, enabling you to browse and recover individual files or folders for a virtual

machine. Clear the Enable granular recovery option to skip metadata collection; this results in a faster backup.

Important: Select this option to enable guest file restores for Linux VMs running in Microsoft Hyper-V.

Frequency: Select one of the following options:

Automatic: To run regular backups automatically within a specified time range, select this

option and type values in the Min. job interval and Max. job interval boxes. A backup runs automatically if resources are available when the minimum interval is met or when the

maximum interval is exceeded.

Daily: Select this option and specify a value for the Time settings.

Weekly: After selecting this option, specify a value for the Time settings and select one or

more days of the week.

Monthly: After selecting this option, specify a value for the Time settings; then select On day

and type the day of the month, or select Custom weeks/days and set the desired parameters

for the interval.

For Time settings, click AM or PM to toggle between morning and afternoon.

For daily, weekly, or monthly schedules, you can use the Repeat area to refine the backup

schedule. For example, you can create a daily backup schedule that runs every other day by typing

2 in the Every box, or a backup that runs multiple times each day by selecting Repeat Every and

specifying the interval and end time.

To specify exceptions to the schedule, click Exceptions in the Repeat area. In the Exceptions

dialog box, select On day and select a day of the month, or select Custom weeks/days and select the week and day. Click Save to save the exception and return to the Add schedule dialog

box.

6. Click Save to save the schedule.

To modify an existing schedule, click the schedule on the collection details page.


Backups

You can run a backup from a collection of virtual machines defined for a server. The storage to be used for

backups is configured as part of the collection.

Performing a Backup

You can run an immediate backup to capture complete virtual machine information or to capture information

that has changed since a previous backup.

Procedure




The server details page appears. The Collections area displays summary information for any existing collections.

3. In the Collections area, click the name of the collection that contains the virtual machines to back up.

4. In the Backup area, click Back up now.

5. In the Backup options dialog box:

Backup level: Select the backup type. (A full backup is always performed for the first backup of any virtual machine.)

Full: Perform a full backup for a virtual machine that has previously been backed up. A full

backup includes virtual machine configuration files and all virtual machine data disks.

Incremental: Selected by default. An incremental backup only backs up changes since the last

full backup.

Synthetic full: Create a synthesized backup from the most recent full backup and all

subsequent incremental backups.

An incremental backup is performed first to ensure that the synthetic full backup will be up to date.

The resulting synthetic full backup is identical to a full backup for the collection. Unlike full and

incremental, a synthetic full backup does not actually transfer data from a client computer to the backup media, and does not use any resources on the client computer.

Enable granular recovery: When this option is selected, metadata is collected during backup, enabling you to browse and recover individual files or folders for a virtual machine. Clear the

Enable granular recovery option to skip metadata collection; this results in a faster backup.

Important: Select this option to enable guest file restores for Linux VMs running in Microsoft Hyper-V.

6. Click OK to begin the backup operation.

To schedule periodic backups, see Managing Schedules (on page 42).


Restores

You can restore virtual machines or virtual machine data from a server or collection. Recovery of files and

folders is only supported if metadata was collected during the backup.

Restoring Guest Files and Folders for VMware

You can restore files and folders from a VMware virtual machine backup to the source VM, to another VM, or

to a guest agent.

Procedure





3. In the Collections area, click Restore for the collection that contains the virtual machine.

4. In the Select restore type page, select Guest files to restore files or folders to the source virtual

machine, to another virtual machine, or to a guest agent.

5. In the Restore page, expand the tree on the left and select the objects to be restored on the right. Select an item or click on an entry in the Name column to browse within an item. For hierarchical data

such as files, folders, and disks, you can click an entry in the path listing above the right pane to return to a higher level of the hierarchy.

In the top right corner of the page, a "Showing" message indicates what backup data is being displayed. You can click the down arrow beside this message and select any of the following options:

Show latest backups: Only display data for the most recent backups.

Show backups as of a specific date: Only display data up to the date you specify.

Show backups for a date range: Only display data within the data range you specify.

6. Click Restore.

7. In the Restore options dialog box, specify the destination for recovered files.

By default, files are restored to the source VM, using the same proxy as the backup.

a. To restore in place:

i. Select the radio button for the source VM.

ii. Optional: Change the value in the Proxy box to use a different proxy.

iii. In the Virtual machine login area, type the username and password for the destination VM.

b. To restore to a different VM:


i. Select Other VM.

By default, the same proxy that was used for the backup performs the restore.


iii. If the destination VM resides on another server, select the host name of the server from the

Destination server list, and then browse to select the destination VM.

iv. In the Virtual machine login area, type the username and password for the destination VM.

c. To restore to a guest agent:

i. Select Guest agent.

ii. Select the guest agent from the Destination list.

By default, the Local System account on the destination client is used to perform the restore operation; but you can use the Impersonate user option to provide credentials for another

user account.

iii. Optional: To use the Impersonate user option, type the host name and credentials for the new

destination server.

The user must have permissions to create files in the specified location on the destination.

8. For the Path box, type a full path or click Browse to select a destination folder. (For VMware, this

value is only needed when you are restoring to a guest agent.)

9. To delete an existing file and replace it with the restored file, select Overwrite if it already exists.

10. Click Submit to run the restore job.

Restoring Guest Files and Folders for Hyper-V

You can restore files and folders from a Hyper-V virtual machine backup to the source VM, to another VM, or

to a guest agent.

Before You Begin

To restore to a VM, ensure that the following requirements are met:

The proxy for the restore must be Hyper-V Server 2012 R2 or later.

The guest operating system for the destination VM must be Windows 2008 R2 SP1 or later.

The destination VM must have the latest integration services installed.

Procedure






4. In the Select restore type page, select Guest files to restore files or folders to the source virtual

machine, to another virtual machine, or to a guest agent.


5. In the Restore page, expand the tree on the left and select the objects to be restored on the right.

Select an item or click on an entry in the Name column to browse within an item. For hierarchical data






6. Click Restore.

7. In the Restore options dialog box, provide the requested information:

a. To restore in place:

i. Ensure that the source VM is selected (the default option).


For Hyper-V, all Hyper-V nodes are displayed.

b. To restore to a different VM:

i. Select Other VM.

By default, the same proxy that was used for the backup performs the restore.


The proxy must be Hyper-V Server 2012 R2 or later.

iii. If the destination VM resides on another server, select the host name of the server from the

Destination server list, and then browse to select the destination VM.

The guest operating system for the destination VM must be Hyper-V 2008 R2 SP1 or later, and

the destination VM must have the latest integration services installed.

iv. In the Virtual machine login area, type the username and password for the destination VM.

c. To restore to a guest agent:

i. Select Guest agent.

ii. Select the guest agent from the Destination list.

By default, the Local System account on the destination client is used to perform the restore operation; but you can use the Impersonate user option to provide credentials for another

user account.

iii. Optional: To use the Impersonate user option, type the host name and credentials for the new

destination server.

The user must have permissions to create files in the specified location on the destination.

8. For the Path box, type a full path for the location where files should be restored.

9. To delete an existing file and replace it with the restored file, select Overwrite if it already exists.



Restoring Virtual Machine Disk Files

You can restore virtual machine disk files for VMware or Hyper-V.

Procedure





collections.


4. In the Select restore type page, select Virtual machine files to restore virtual machine

configuration and disk files to the file system of the proxy.


Select an item or click on an entry in the Name column to browse within an item. For hierarchical data such as files, folders, and disks, you can click an entry in the path listing above the right pane to return

to a higher level of the hierarchy.

In the top right corner of the page, a "Showing" message indicates what backup data is being displayed.

You can click the down arrow beside this message and select any of the following options:




6. Click Restore.


a. To restore to a different server, select the server name from the Destination server list.

By default, virtual machine disk files are restored to the original server.

b. Optional: Use the Impersonate user option to provide credentials for another user account.

By default, the Local System account on the destination client is used to perform the restore

operation. The user must have permissions to create files in the specified location on the

destination.

c. For the Path box, type a full path or click Browse to select a destination folder.

d. To delete an existing file and replace it with the restored file, select Overwrite if it already exists.


Attaching a Disk to an Existing VM for VMware

From VMware virtual machine backups, you can restore a virtual machine disk and attach it to an existing

VM.

Procedure







4. On the Select restore type page, select Disk Level to restore individual VMDK files and attach VMDKs

to an existing virtual machine.

5. On the Restore page, expand the tree on the left and select the objects to be restored on the right.

Select an item or click on an entry in the Name column to browse within an item. For hierarchical data






6. Click Restore.


a. Optional: To use a different proxy, select the proxy from the Proxy list.

By default, the virtual machine disk is restored using the same proxy as the backup.

b. To restore to a VM on a different server, select the server name from the Destination server list.

c. To delete an existing virtual disk file and replace it with the restored file, select Overwrite if it already exists.

d. For Disk Provisioning, use the default value (Original) to retain the provisioning method used at the time of backup. Select a value from the Disk Provisioning list to force a specific disk

provisioning method: Thick Lazy Zero, Thin, or Thick Eager Zero.

e. For Transport mode for VMware, select one of the following options:








storage for virtual machine disks. Data is read directly from the storage where virtual machines reside, without going through the ESX host or transferring data over the local area network

(LAN). The ESX host is contacted only to coordinate access to the LUN. SAN transport mode cannot be used if the proxy computer is a virtual machine.



automatically mounted to the proxy, so they can be accessed by the proxy as a local disk. The ESX host the proxy is running on must have access to all datastores for the virtual machine. If

the virtual machine and the proxy are not on the same host, all datastores must be shared between the hosts.


computer. The local area network (LAN) can be the production network or a dedicated backup

network.



network.

f. For each disk you are restoring, click Browse next to Destination VM and select the virtual

machine to which the restored disk should be attached.

g. To use a different datastore for the restored VM disk, select the new datastore from the Datastore

list.


Restoring Full Virtual Machines for VMware

You can restore virtual machines to the original location or to a different location. By default, virtual machines are restored to the original server, using the same proxy as the backup.

Procedure





collections.


4. In the Select restore type page, select Full virtual machine to restore one or more full virtual

machines. (Multi-VM restore is only supported for VMware.)


Select an item or click on an entry in the Name column to browse within an item.


In the top right corner of the page, a "Showing" message indicates what backup data is being displayed.

You can click the down arrow beside this message and select any of the following options:




6. Click Restore.


a. Optional: To use a different proxy, select the proxy from the Proxy list.

b. To restore to a different vCenter, select the server for the vCenter from the Destination server list.

c. Select Power on VMs after restore to start the VM automatically.

d. To delete an existing virtual machine and replace it with the restored VM, select Overwrite if it

already exists.

e. For Disk Provisioning, use the default value (Original) to retain the provisioning method used at

the time of backup. Select a value from the Disk Provisioning list to force a specific disk

provisioning method: Thick Lazy Zero, Thin, or Thick Eager Zero.

f. For Transport mode for VMware, select one of the following options:







storage for virtual machine disks. Data is read directly from the storage where virtual machines

reside, without going through the ESX host or transferring data over the local area network (LAN). The ESX host is contacted only to coordinate access to the LUN. SAN transport mode

cannot be used if the proxy computer is a virtual machine.



automatically mounted to the proxy, so they can be accessed by the proxy as a local disk. The

ESX host the proxy is running on must have access to all datastores for the virtual machine. If the virtual machine and the proxy are not on the same host, all datastores must be shared

between the hosts.


computer. The local area network (LAN) can be the production network or a dedicated backup

network.



network.

g. Type a new virtual machine name in the Change VM display name to box.

If an existing VM with the same name exists on the destination host and you do not select

Overwrite VMs if they already exist, the restore job fails.

h. To restore to a different host, click Browse next to the Destination host box and select the host.

By default, the original server is shown as the destination host.


i. To use a different data store for the restored VM, select the new data store from the Datastore list.

j. To restore to a resource pool, select the destination from the Resource pool list.


Restoring Full Virtual Machines for Hyper-V

You can restore virtual machines to the original location or to a different location. By default, a virtual machine is restored to the original server, using the same proxy as the backup.

Procedure





collections.


4. In the Select restore type page, select Full virtual machine to restore a full virtual machine.


Select an item or click on an entry in the Name column to browse within an item.





6. Click Restore.


a. To restore to a different cluster, select the virtualization client for the cluster from the Virtualization Client list.

b. Select the target host from the Destination Client list.

For Hyper-V, all Hyper-V nodes are displayed.

c. Select Power on VMs after restore to start the VM automatically.

d. To delete an existing virtual machine and replace it with the restored VM, select Overwrite VMs if they already exist.

e. Select Register virtual machine with failover cluster to enable the restored VM to migrate to another node in the cluster.

f. For Restore location, leave the default (Original folder), choose Select a folder, or select

Hyper-V default folder.

g. Type a new virtual machine name in the Change VM display name to box.

This option does not display if you are restoring multiple VMs. If an existing VM with the same name exists on the destination host and you do not select Overwrite VMs if they already exist, the

restore job fails.


h. For Destination folder, click Browse to select a new folder from the list. (Only enabled if you

chose Select a folder.)


Viewing Virtual Machine Information

You can view virtual machines that you own, see the latest backup or jobs that included a virtual machine, or initiate a restore.

Procedure

1. From the navigation pane, click Virtual Machines.

The VMs page shows the VM name, server, backup size, last backup time, host, and the VSA proxy that

performed the backup.

Note: You can click the button at the right side of the VM table header to add or remove columns or

to enable filtering.

2. To view details for a specific VM, click the VM name.

3. From the summary display for a VM, you can perform any of the following tasks:

Last Backup: View the most recent backup job for the VM.

Jobs: View all jobs for the VM.

Restore: Start a restore job for the VM.

The Summary area for a VM includes the following information:

Backup status: PROTECTED, NOT PROTECTED, or BACKED UP WITH ERROR.

Server: The name of the server that hosts the VM.

Collection: The name of the collection that includes the VM.

Proxy: The proxy that performed the last backup. This entry is blank if the last backup was a synthetic

full backup.

VM size: Size of the VM (GBs).

Backup size: The amount of data written during the last backup (GBs).

Last backup time: The date and time when the last backup was performed. This entry is blank if the

last backup was a synthetic full backup.

Guest OS: The guest operating system for the VM.

Guest size: The actual space used on the storage volume where the virtual machine resides.

Host: The name of the server where the Admin Console is running.

Total backup time: The total time used for the most recent backup.

In the Security area, the Associations tab shows users or groups who have rights to the VM, along with their associated roles. The Owners tab shows users who have ownership rights to the VM.

You can click Edit to modify security settings for the VM.


Reports

The details page for a server or collection shows a VM status diagram indicating the number of protected

and unprotected virtual machines. You can click the bar showing the number of VMs to view a report with

additional details.

On the report page, you can perform the following actions to control which virtual machines are included in

the report:

Select a time range and click Submit.

Choose a specific collection or All.

Specify a status: All, Protected, Not protected, or Backed up with error.

Reports for protected or unprotected virtual machines show summary information for each virtual machine:

Name: VM name.

Backup status: Whether the VM is protected.

Size (GB): Size of the virtual machine.

Backup size (GB): The amount of data written during backup.

Collection: The collection to which the VM belongs.

Last backup time: The date and time when the last backup was performed.


Endpoint The Endpoint application in the Admin Console provides a simple web-based user interface for administration tasks, providing streamlined data protection for end-user devices such as laptops.

To get started quickly, you can perform a simple configuration and then initiate protection operations immediately. Use the Admin Console to initiate backups and restores and to manage jobs, schedules, alerts,

events, and users.

Getting Started with the Endpoint Application

The Getting Started procedure describes the steps that first-time users must follow to set up the Endpoint

application in the Admin Console.

Important: The setup for the Endpoint application includes inviting your end users to install the end-user

Endpoint package on their devices.

Before You Begin

If you want to minimize the information your end users must provide during the installation of the end-user

Endpoint package, you can create a custom package. For information on creating a custom package, see Creating an End-User Endpoint Package (on page 17).


To access the Endpoint application, you must install the Admin Console. For instructions, see one of the

following procedures:



If you do not have a CommCell environment, see Installing the Commvault Edge Server Package (on

page 16).

Step 2: Log on to the Admin Console

Access the Admin Console (on page 21) using the URL that was displayed on the installation completion

page.

Step 3: Complete the Setup Wizard

Configure the Endpoint application by completing the Setup Wizard (on page 56).


After end users install the end-user Endpoint package on their devices, you can perform a backup and a

restore. For instructions, refer to the following procedures:

1. Manually perform a backup (on page 58).


2. Restore the files and folders that you backed up (on page 59).

Using the Setup Wizard for the Endpoint Application

When you log on to the Admin Console for the first time, a setup wizard guides you through the basic setup required by the Endpoint application. During the setup, you can email invitations to your users asking them

to install the Endpoint software package on their devices.

Before You Begin


If you want to minimize the information your end users must provide during the installation of the end-

user Endpoint package, you can create a custom package. For information on creating a custom package, see Creating an End-User Endpoint Package (on page 17).

You will need the following information to complete the setup wizard:

The name and port number of your email server

The location of the disk library to use to store backed up data

If there is a gateway connecting the Admin Console to the CommServe computer, the fully qualified domain name of the gateway, for example, gateway.gatewayservices.com

The fully qualified domain name of your domain (name) server

A list of users and user groups who should install the end-user Endpoint package on their devices

About This Task

At any point during the setup wizard, click Finish setup later to leave the wizard. If you leave the setup wizard before it is complete, it will appear the next time you log on.

Procedure

1. Log on to the Admin Console (on page 21).

2. On the Register product tab, register the software using your Commvault Cloud

https://cloud.commvault.com credentials.

3. On the Configure email tab, set up an email server.

After the email server is configured, email notifications can be sent from the Admin Console.

4. On the Add storage tab, configure a disk library as a storage target.

The storage target is where data is stored when it is backed up.

5. If there is a gateway connecting the Admin Console to the CommServe computer, on the Add gateway tab, in the Host Name box, type the fully qualified domain name of the gateway, for example,

gateway.gatewayservices.com.

6. On the Create Plan tab, create a basic plan.

The plan contains the information needed to backup your data, for example, the storage target,

schedules, and the data to backup. After you create a plan by using the setup wizard, you can configure additional options on your plan. For information on creating plans outside of the setup wizard, see

Creating a Laptop Plan (on page 106).

7. On the Add domain tab, enter the information for your domain server.




Users who are members of the domain can log on to the Admin Console with their domain credentials.

8. On the Associate users or groups tab, associate users and user groups with a plan.

The plan controls how the data that belongs to the users and user groups is backed up.

9. Decide if you want to invite users to install the end-user Endpoint package on their devices:

By default, the users and user groups you associate with the plan receive an email inviting them to install the end-user Endpoint package on their devices. The email invitation includes a link to your

Web Console Add Computer page.

To prevent email invitations from being sent, clear the check boxes next to the user names. You can send the email invitations at a later time (on page 57), or you can use your own method to

distribute the end-user Endpoint package to your users.

10. Click Finish.

Result

After the end-user Endpoint package is installed on devices, those devices appear on the Devices page. On

the Devices page, you can see backup information and who owns the device.

Inviting Users and User Groups to Install the End-User Endpoint Package

You can invite users and user groups to install the end-user Endpoint package.

Before You Begin

Users and user groups must be associated with a plan before you can send them an invitation. For

information on creating a plan, see Creating a Laptop Plan (on page 106).

Procedure

From a Plan

1. From the navigation pane, go to Plans.

The Plans page appears.

2. In the Plan name column, click the plan associated with the users you want to invite.

The plan details page appears.

3. Under Associate users or groups, click Edit.

The Associate users or groups dialog box appears.

4. For each user and user group you want to invite, select the check box next to the user or user group

name.

5. Click Save.

From a User or User Group

1. From the navigation pane, go to the user or user group list:

To go to the user group list, go to Security > Users Groups.


The Users groups page appears.

To go to the user list, go to Security > Users.

The Users page appears.

2. In the Actions column for the user or user group, click the action button and click Invite users.

Result

Users receive an email invitation that includes a link to your Web Console Add Computer page.

After the end-user Endpoint package is installed on devices, those devices appear on the Devices page. On

the Devices page, you can see backup information and who owns the device.

Devices

Devices are the end-user laptops or computers that have the end-user Endpoint package installed.

On the Device page, you can view the following information for each device:

The size of that last backup job

When the last backup happened and when the next backup will happen

The end users who own the device

The plans associated with the device

For information on plans, see Creating a Laptop Plan (on page 106).

On the Device page, you can perform the following actions:

Update the software installed on the device

Uninstall the software on the device

Activate (reconfigure) a device whose license was released

Delete the device

On the device details page, you can perform the following actions:

Manually perform a backup

View a list of backup and restore jobs

Add or edit schedules

Manually Performing a Backup

Normally, devices are backed up according to schedules, but you can manually perform a full, incremental or

synthetic full backup job.

Procedure

1. From the navigation pane, click Devices.


The Devices page appears.

2. In the Name column, click the name of the device.

The device details page appears.

3. Under Backup, click Back up now.

4. In the Backup options dialog box, choose the backup options:

Full: A full backup backs up all of the data defined under Content.

Incremental: (default) An incremental backup backs up changes since the last full backup.

Synthetic full: A synthetic full backup is created from the most recent full backup and all subsequent incremental backups. The resulting synthetic full backup is identical to a full backup. A

synthetic full backup does not transfer data from a device to the storage target and does not use

resources on the device.

5. Click OK.

Result

The backup job appears in under Backup. You can monitor the job progress and kill or suspend the job. For

information on monitoring all of the jobs in your CommCell environment, see Jobs (on page 112).

Restoring Files and Folders

You can restore backed up data to the same device or to a different device.

Before You Begin

The device must be backed up. For information on manually backing up a device, see Manually Starting a Backup (on page 58).

Procedure

1. From the navigation pane, click Devices.


2. In the Actions column for the device, click the action button and then click Restore.

The Backup content page appears.

3. Browse for the files and folders you want to restore.

Tip: You can change the backup content you see by using the filter options in the upper right of the page.

4. Select the check box next to each file and folder you want to restore.

5. Click Restore.

6. In the Restore options dialog box, choose how you want to restore the data:

Destination client: The destination is where the data is restored. The default value is the device that was backed up. You can restore the data to the default device or choose a different device.

Restore to original folder: (default) The option to restore data to the folder from where it was backed up. Clear this option if you want to enter a new path in the Destination path box.


Destination path: If you cleared the Restore to original folder check box, click Browse to choose a folder or to create a new folder. The data is restored to the folder you choose or create.

Overwrite if it already exists: The option to overwrite files and folders on the destination client with the files and folders you are restoring.

7. Click Submit.

Result

A restore job is created. You can monitor the job progress and kill or suspend the job. For information on monitoring all of the jobs in your CommCell environment, see Jobs (on page 112).

Tracking the Location of a Device

You can track the location of a laptop client from the Admin Console. The laptop client location is fetched every 24 hours when the device is online. In addition, if the device is behind a firewall, another attempt to

fetch the location takes place every time the device connects through the firewall.

Procedure

1. From the navigation pane, go to Devices.


2. In the Name column, click the device you want to track.

The device details page appears.

Result

Under Last Seen Location, an interactive map marks the latest geographical location of the device.


Download Center

The Download Center is an interface for organizing digital resources, or packages, in your enterprise and

making them available for end-users to download from the Web Console.

After an administrator configures the Download Center, packages can be added to the Download Center from any network location or Web Server (repositories). When packages are added to the Download Center,

metadata is added. End-users search, sort, and filter the list of packages based on the metadata. Packages are stored in their original location, so when a user logs in to the Web Console and downloads a package

from the Download Center, the package is retrieved directly from the repository and downloaded to the user's machine. Although the Download Center is a central location for end-users to obtain digital resources,

there is no need for a central storage location for packages, which eliminates unnecessary data movement

and duplicated data.

Terms

Packages: The digital resources that can be downloaded from Download Center are referred to as packages in this documentation.

Download Center Repository: The Download Center repository is the Web Server or network share where

packages are hosted. Repositories must be added and configured in Download Center before you can upload packages.


Accessing the Download Center

The Download Center is an interface for organizing digital resources, or packages, in your enterprise and

making them available for end-users to download from the Web Console.

Before You Begin

Verify that your end users and administrators have the correct security associations. The following table

contains the CommCell permissions required to perform operations in Download Center:

User Permitted Operations Required Permissions

End-user View the Download Center

application in the Web Console

View packages

Download packages

There are no additional permissions required for

end users to access the Download Center.

End users must be able to log on to the Web

Console and the administrator must give them

access to a package.

Administrator View the Download Center

application in the Web Console

View packages

Download packages

Upload and manage packages

Edit package information

Manage download repositories

CommCell > Download Center

Management

Associate the role containing this permission to the web server. For information on creating

roles, see Managing Roles (on page 125). For information on creating security associations,

see Administrating the Security Associations of a

Server (on page 126).

Procedure

1. Open your web browser and type the Web Console URL provided by the administrator in the address bar.

The URL should be in the following format: http://<HostName>:<Port>/webconsole, for example:

http://client.mydomain.com/webconsole.

2. From the My Applications page, click Download Center.

When you open Download Center for the first time, a welcome page appears.

3. Complete the steps on the Download Center welcome page.

See Adding a Repository (on page 63) and Adding a Package (on page 64).

Result

After completing the steps on the Download Center welcome page, a list of available packages appears

when you open Download Center.


Adding a Repository

A repository is a Web Server or network share that will host the files in the Download Center. You can add

as many repositories as you require.

Before You Begin

You must have the appropriate permissions to perform the operation. For information on the permissions

needed to add a repository, see Accessing the Download Center (on page 62).

Procedure

1. Log on to the Web Console (on page 62).


3. In the upper-right corner, click the Configure Download Center button ( ).

Note: If this is the first time you are configuring Download Center, on the Welcome to Download

Center page, click Create A Download Repository.

4. On the Manage Repositories page, click the Type of Repository list and select a Web Server or

network share.

5. Enter the repository information.

For a Web Server repository, the Network Services account must have full permissions for the specified folder.

For a network repository, the user name that you enter must have full permissions to access the share.

6. For network repositories, click Validate to verify the repository information.

7. Click Save.

Results

The repository appears at the bottom of the page in the Download Repository list.

What to Do Next

Add a package to the Download Center (on page 64).


Managing Repositories

You can view, edit, and delete existing repositories in the Download Center.

Before You Begin

You must have the appropriate permissions to perform the operation. For information on the permissions

needed to manage a repository, see Accessing the Download Center (on page 62).

About This Task

Deleting or editing a repository will remove any associated packages and metadata from the Download

Center. However, deleting a repository does not delete the original package data located on the Web Server or network share.

Procedure



3. In the upper-right corner, click the Configure Download Center button ( ).


Center page, click Create A Download Repository.

4. In the Download Repository list, under the Action column, proceed as follows:

To edit a repository click Edit, make changes to the repository details, and then click Save.

To delete a repository click Delete, and then click OK to confirm.

Adding a Package

Download Center administrators can upload packages to the Download Center.

Before You Begin

You must have the appropriate permissions to perform the operation. For information on the

permissions needed to add a package, see Accessing the Download Center (on page 62).

The package you want to add must be located in a configured repository. For information on adding a

repository, see Adding a Repository to Download Center (on page 63).

If you want to upload a ReadMe file for the package, copy the ReadMe file to the appropriate repository.

Steps



3. In the upper-right corner, click the Add Information About Your Packages button ( ).


Center page, click Add Information About Your Downloads.


4. On the Download Information page, label, classify, and set permissions for downloading the

package.

For information, see Package Information Page (on page 66).

5. To make a package visible to all Download Center users, create a CommCell group named Everyone,

and then add the Everyone group to the Visible To list.

6. When you are finished, click Apply.

What to Do Next

If you do not see your package in the Download Center list, click the refresh button ( ) in the upper-right

corner of the page and check again.

Managing Packages

Administrators can edit information for an existing package from the Download Center page. Administrators can mark a package as deleted in Download Center. Packages marked deleted are visible to the

administrator, but are no longer visible to end-users. Deleted packages are marked deleted in the Download

Center list.

Before You Begin

You must have the appropriate permissions to perform the operation. For information on the permissions needed to manage a packages, see Accessing the Download Center (on page 62).

Procedure

Editing Package Information



3. For the package that you want to edit, click Edit.

4. On the Package Information page, make your changes.

For information, see Package Information Page (on page 66).

5. When you are finished, click Apply.

Deleting a Package



3. For the package that you want to delete, click Delete.

4. In the confirmation box that appears, click OK.

A Deleted label appears under the package icon in the Download Center list. You can still view and

download deleted packages from the Deleted Items category, but end users cannot see them.


Package Information Page

The Package Information Page contains the information that was entered when a package was created.

This information can be edited by Download Center administrators.

Label Your Download

The Label Your Download section of the Package Information page specifies general information

about the package and the location of the package and ReadMe file.

The following table describes the inputs available for this section:

Label Description

Name The name of the package as you want it to appear in the Download Center.

Description (Optional) A description of the package that appears in the Overview section of the package details page.

ReadMe Location

(Optional) The path in the repository where the ReadMe file is hosted. The ReadMe

Location also contains the readme file name. Only readmes in the following formats are supported: DOC, DOCX, PPT, PPTX, TXT, HTM, HTML, and PDF.

Classify Your Download

The Classify Your Download section of the Package Information page specifies additional information used to organize the package on the Download Center page.


Label Description

Category A general group by which you can filter packages. Category filters appear on the Download Center page.

Sub-category A more specific group by which you can filter packages. Sub-category filters appear on

the Download Center page when a category filter is selected.

Vendor (Optional) The company or organization that created the package.

Version The version number of the package.

Rank

(Optional) A number that specifies the order in which packages are displayed on the

Download Center page. A package with a rank of 1 is listed above a package with a rank of 2.

Software Icon (Optional) Specify a custom icon to display next to the package name on the Download

Center page.

Weightage (Optional) Not applicable. Leave the default setting of 0 when uploading a package to Download Center.


From The date when the package will appear in the Download Center for users listed in the Visible to box.

Download Type and Location

The Download Type and Location section of the Package Information page specifies information about the file type, supported platforms, and location of your package.


Label Description

Platform The operating system that is compatible with the package.

Download Type The file type of the package.

Location The path on the repository where the package is hosted.

Save

Used to save the platform-specific download information entered in Download Type

and Location. The download information appears in the package table below. You can save multiple downloads for different platforms to the same package.

Cancel Clears the information entered into the Download Type and Location section.

Share Your Download

The Share Your Download section of the Package Information page specifies the following:

Which users and user groups can view and download the package.

When the package is available for end-users to download.


Label Description

Visible to (Optional) The CommCell users and CommCell user groups that can view and download the package after the date in the From box. If nothing is entered, only the

Download Center administrator will be able to view the package.

Not visible to

(Optional) The CommCell users and CommCell user groups that cannot view the package. The Not visible to box supersedes the Visible to box.

For example, if a user is listed in both the Visible to and Not Visible to boxes, then the user will not be able to view the package in the Download Center.

Early preview

users

(Optional) Users who are permitted to view and download the package as soon as it is

added to Download Center, even if the package will be available to other users on a future date .

Early Preview Users can view packages, even if they are also included in the Not

Visible To box.


Download Details Page

The download details page contains additional information about a specific package. You can view the

package details page by clicking the name of a package in Download Center.

The following information is available in the download details page:

Label Description

Category The category associated to the package in the Package Information page.

Sub-Category The sub-category associated to the package in the Package Information page.

Version The software version number specified for the package in the Package Information page.

Release Date The date the package was added and visible in the Download Center.

Platform The operating system that is compatible with the download.

Download Type The file type extension of the download.

Location The path to the location of the download.

Readme The name of the readme file for the download.

Size The size of the download.

Actions Links to download the package or the package ReadMe file.

Overview A description of the package provided by the administrator.

Related Link Links to other packages that have the same category and sub-category.


Database Agents The Admin Console is a web-based user interface that database administrators can use to protect and recover Oracle and SAP HANA databases.

Note: When the Admin Console is added to an existing Commvault deployment, previously configured entities such as servers are also available in the Admin Console.


Introduction to the Admin Console for Oracle Databases

Use the Admin Console to initiate backups and restores of the Oracle databases.

To get started, you can configure Oracle instances and subclients.

You can configure schedules to ensure that the data is automatically protected.

You can schedule backups, or run them as needed. You can restore to the same host or to a new host in the

case of a disaster.

The Admin Console provides summary information about the Oracle jobs.

Key Features

Configure servers, instance, storage, and subclients.

Back up subclients immediately or on a schedule.

Recover the database, logs or the control file.

Clone the database.



Getting Started with the Oracle Admin Console

Review each of the topics to get started with the Oracle Admin Console.


If the Admin Console application has not been installed by your backup administrator, you must install the

application. For instructions, see one of the following procedures:



If you do not have a CommCell environment, see Installing the Commvault Express Package (on page

20).

Step 2: Obtain Your User Credentials and Database Protection Information

Obtain the following information from your backup administrator:

The Admin Console URL

Your Admin Console user credentials

Note: This user must be an Oracle user that has access to the Oracle executable and binary files.

The Oracle database name

The data storage policy

The log storage policy

The command line storage policy


Access the Admin Console (on page 21) by using the URL that was displayed on the installation completion page, or that you received from your backup administrator.

Step 4: Register the Admin Console

If you have not done so, register your Admin Console (on page 129).

Step 5: Prepare for Your First Backup and Restore

1. Add an Oracle instance (on page 79) for the database that you want to protect.

2. Configure an online database subclient (on page 81).

3. If you want the subclient backups to run on a schedule, create a schedule (on page 82).

4. Determine the alerts that you want the software to trigger.

For information on how to configure alerts, see Managing Alerts (on page 110).


1. Perform an online full backup (on page 79).


2. Perform a restore (on page 85).


Oracle Configuration

Clients and Client Groups

The clients details page displays the following information:

The clients and client groups that you have permission to view and modify

The data protection activity

The client group security

You can perform the following operations on the clients details page:

Send the log files (on page 114).

Clients

Clients are the computers that host the databases.

The client details page displays the following client information:

The client name, the host name, and the CommServe host name.


The client security

The agents that are installed on the client

You can perform the following operations on the client details page:

View the agent job history. For information on the job history, see Jobs (on page 112).

To view the backup history, in the Actions column for the agent, click the action button , and then click Backup History.

To view the restore history, in the Actions column for the agent, click the action button , and then click Restore History.

To add an instance (on page 79), in the Actions column for the agent, click the action button , and then click Add instance.


Agents

The agent details page contains the following information:

The client name

The date that the software was installed

The software version


The instances that are configured on the agent

You can perform the following operations on the agent details page:


To view the backup history, in the upper right of the page, click Backup History.

To view the restore history, in the upper right of the page click Restore History.

Add an instance (on page 79). In the upper right of the page, click Add instance.

Add a subclient (on page 81). In the Actions column for the instance, click the action button , and

then click Add subclient.

Restore the database (on page 85). In the Actions column for the instance, click the action button ,

and then click Restore.

Clone the database (on page 87). In the Actions column for the instance, click the action button ,

and then click Clone.

Instances

Instances are the structures that identify and manage Oracle databases. You must add an instance for each

Oracle database that you want to protect. When you create an Oracle database instance, the software creates a default data and a default log subclient for the instance.

The instance details page contains the following information:

The instance information, for example, the Oracle home directory

The data backup and log backup storage policies

The instance status

The subclients that are configured for the instance

You can perform the following operations on the instance details page:

Add an Oracle subclient (on page 81). In the upper right of the page, click Add subclient.

Modify the instance (on page 79). In the upper right of the page, click Edit instance.

Perform a backup for a subclient. In the Actions column for the subclient, click the action button ,

and then click Backup.

Get the latest instance status. In the Instance Status area, click Refresh.

View the instance job history. For information on the job history, see Jobs (on page 112).



To view the restore history, in the upper right of the page, click Restore History.

Subclients

Subclients contain the Oracle instance data that you want to back up and restore.

The subclient details page displays the following information:

The latest backup information

The date and time of the next backup

The backup schedules


The enabled alerts

The following operations are available on the subclient details page:

Modify the data storage policy. In the Storage targets area, click Edit, from the Data Storage Policy

list choose the storage policy and then click OK.

Contact your backup administrator for the storage policy name.

Add a backup schedule. In the Schedules area, click Add schedule.

View the subclient job history. For information on the job history, see Jobs (on page 112).



Managing Oracle Database Instances

Add or modify an Oracle instance when you need to manage a database.

Tip: If you have access to more than 10 client groups, use the arrow buttons at the lower-left bottom of the page to page through the client groups.

Before You Begin

Make sure that you have the following information:

The Oracle application installation path

The credentials that you use to access the Oracle client

The storage policy to use for log backups

The storage policy to use for command line backups

Procedure

1. You can add an instance from the client details page or the agent details page. You can edit an instance

from the instance details page.

Client details: From the navigation pane, click Clients > client_group > client, in the Actions

column for the subclient, click the action button , and then click Add Instance.


Agent details: From the navigation pane, click Clients > client_group > client > agent. Then, in the upper right of the page, click Add Instance.

The New Oracle Instance dialog box appears.

Instance details: To edit an instance, from the navigation pane, click Clients > client_group > client > agent > instance. Then, in the upper right of the page, click Edit Instance.

The Modify Instance details dialog box appears.

2. In the Instance Name box, type the instance name.

3. In the ORACLE Home box, type the Oracle application installation path.

4. In the OS User Name, type the user that can access the Oracle client.

5. In the Connection String boxes, type the Catalog Connect String to connect to the Oracle database.

Note: If you want to use an account other than 'sys', you must grant the SYSDBA or SYSBACKUP (in

Oracle version 12 or higher) privilege to the user account.

a. Type the database user name in the Connect String first box.

b. Type the database user password in the Connect String second box.

c. Type the Oracle service name in the Connect String third box.

6. From the Command line storage policy list, choose a storage policy that the software uses for the

command line backups.

7. From the Log Storage Policy list, choose a storage policy that the software uses for the log backups.

8. Click Save.

Result

The software creates the instance and a default data and a default log subclient.

What to Do Next

1. On the Oracle database host, edit the oratab file and add an entry for the added instance.

2. Create subclients (on page 81) for the data that you want to protect.


Managing Oracle Subclients

You can add the following content in the subclients:

Data and logs

Data only

Logs only

Data subset, for example tablespaces

Data subset and logs

Use the following criteria when determining the unique data sets:

The data content you want to back up and how you need to restore the data (for example, all tables or

a subset of tables)

The database state when you perform backups

The required schedule for the data

You can create subclients for specific datafiles and tablespaces that frequently change or have a different backup schedule than the entire database.

Before You Begin

1. Add an instance (on page 79) for the Oracle database.

2. Make sure that you have the following information:

The storage policy to use for backups

Procedure

1. You can add a subclient on the agent details page or the instance details page. Choose one of the

options.

Agent details: From the navigation pane, click Clients > client_group > client > agent, in the

Actions column for the instance, click the action button , and then click Add Subclient.

Instance details: From the navigation pane, click Clients > client_group > client > agent > instance. Then, in the upper right of the page click Add Subclient.

The Add Subclient dialog box appears.

2. In the Subclient Name box, type the subclient name.

3. From the Storage policy list, choose the storage policy that the software uses for data backups.

4. In the Number of Data Streams box, type the number of streams that the software uses for backups.

5. Select the data to include in the backup.

To back up an online database, select the Data Backup check box and then select Online Data.

To back up an online database subset, select the Data Backup check box and then select Online

Subset.

To back up an offline database subset, select the Data Backup check box and then select Offline.

To back up the database logs, clear the Data Backup check box and then select the Archive Log Backup check box.


6. If you chose to include the logs in the backup, select the Delete Archive Logs check box to have the

software delete the logs after a successful backup.

7. Click Save.

Administering Schedules

You can schedule jobs to perform data protection operations on a regular basis without user intervention.

You can create an automatic schedule to perform a backup when certain criteria are met.

You can manually run a scheduled job at any time, without re-configuring all the other properties that are

associated with the job. This is helpful when you need to re-run a failed scheduled job.

Leap Year Note: If a monthly job is scheduled to run on a day that a month does not have, the job runs on the last day of that month. For example, jobs scheduled to run on the thirtieth of each month will run on

February 29 in a leap year or February 28 in other years.

Procedure

1. You can add or edit a schedule on the subclient details page.

To add a schedule, from the navigation pane, click Clients > client_group > client > agent >

instance > subclient, in the Schedules area, click Add Schedule.

To edit a schedule, from the navigation pane, click Clients > client_group > client > agent > instance > subclient. Then, in the Schedules area, click the schedule name.

The Add schedule or Edit schedule dialog box appears.

2. If this is a new schedule, in the Name box, type a unique name for the schedule.

3. From the Backup level options, choose the type of backup, for example, Full.

4. From the Frequency options, choose how often the backup is performed:

To use an automatic schedule, click Automatic and set the minimum and maximum time in hours and minutes.

Note: If these values are met, the backup job starts even if the database criteria are not met.

To use a daily schedule, click Daily and set the schedule details.

To use a weekly schedule, click Weekly and set the schedule details.

To use a monthly schedule, click Monthly and set the schedule details.

5. Optional: If you chose a non-automatic option, set the schedule exceptions.

a. Click Exceptions.

The Exceptions dialog box appears.

b. Set the exception details.

c. Click Save.

6. Optional: If you chose a non-automatic option, set how often the software repeats the backup.

Select the Repeat Every check box and set the repeat details.

7. Click Save.


Oracle Backups

You can back up online or offline Oracle databases, log files, or Oracle datafiles and tablespaces. If the

database must be accessible and you have a small backup window, run a series of online backups for different database portions.

You can run backups immediately or configure a schedule for the subclient.

Full Backups

Oracle full backups include the entire database and the control file. A full backup is the most comprehensive

backup and is the baseline for incremental backups. Full backups of online databases include the log files. An offline full backup is a cold backup for Oracle databases.

Incremental Backups

An Oracle incremental backup contains the changed data from the last full backup. Incremental backups use

less media and resources than full backups.

In a cumulative level n backup, only the data that differs from the most recent backup at level n-1 or lower,

is backed up.

What is Backed Up

Oracle database files that include the datafiles and control files

Archived redo logs

Parameter files (SP File)

Oracle Managed Files

What Is Not Backed Up

Oracle application files that are associated with the Oracle installation.

External files, for example, Oracle Wallet, and external tables.


Performing Oracle Backups

You can back up Oracle databases, log files, or Oracle datafiles and tablespaces. You can back up the

database when it is online or offline. If the database must be accessible and you have a small backup window, run a series of online backups for different database portions.

You can perform a full, incremental or cumulative backup.

A full backup includes the database, the log files, and the control file.

An incremental backup contains the changed data from the last successful backup. Incremental backups use

fewer resources than full backups. If you do not have any successful backups and you perform an incremental backup, the incremental backup is considered a full backup and all data is backed up.

Procedure

1. You can perform a backup on the subclient details page or the instance details page.

Subclient details: From the navigation pane, click Clients > client_group > client > agent > instance > subclient. Then, in the upper right of the page, click Backup.

Instance details: From the navigation pane, click Clients > client_group > client > agent >

instance, in the Actions column for the subclient, click the action button , and then click Backup.

The Backup Options dialog box appears.

2. Select the Backup level.

Note: If you select the Cumulative check box, you must type the Oracle incremental number.

3. Click OK.

The Backup options dialog box appears.

4. Optional: View the job details. Click the job ID.

5. Click OK.

What to Do Next

You can control or view the job. For more information, see Jobs (on page 112).


Oracle Restores

A database restore might be necessary when the data area or the log area is damaged, to recover from a

logical error or to copy the database.

Perform a restore operation immediately after your first full backup to understand the process.

Oracle restores fall into the following main categories:

Database restore: This is a restore of all database files, the control file and the server parameter file

Database subset: This is a combination of a restore of any of the following files:

Only archive logs

The Oracle control file

Individual datafiles and tablespaces

Database Archived Redo logs

Database clones: Create a clone so that you can:

Duplicate large databases in a short amount of time

Create test environments

Retrieve data quickly without without intensive resource use on the production environment

Alleviate the load on production servers

Performing Oracle Restores

You can restore the following data:

The database and control file

The database

The control file

Individual tablespaces and the control file

Individual tablespaces

You can restore the database to an instance with the same name as the source instance to the source client, or a different client.

After the restore, you can recover the database to a point other than the current time when the current database is inconsistent.

When you choose the option to recover from the latest backup time or from the latest SCN with a secondary copy, the software only considers the time or SCN from the latest job available on the secondary copy, even

when the primary copy or other copies have a more recent backup job.

Before You Begin


2. Set the database to the correct mode defined in the table.


Control File in the Restore Required Database Mode

Control file is included in the restore NOMOUNT

Control file not included in the restore MOUNT

Procedure

1. You can perform a restore on the agent details or job details page.

Agent details: From the navigation pane, click Clients > client_group > client > agent > instance,

in the Actions column for the instance, click the action button , and then click Restore.

Job details: From the navigation pane, click Jobs > job ID, in the Job summary area, click Restore.

The Backup Content page appears.

2. To restore individual tablespaces, clear the check box next to each tablespace that you do not want to

restore.

3. Click Restore.

The Restore Options dialog box appears.

4. From the Destination list, choose the destination host for the restore.

5. Select the data that you want to restore.

To restore the database or individual tablespaces, select the Database check box and clear the

Control file check box.

To restore the control file, clear the Database check box and select the Control file check box.

To restore the database and control file, select the Database check box and the Control file check box.

6. Select the database recover option.

To recover to the latest backup job completion time, choose Most recent backup.

To recover to a point-in-time, choose Point-in-Time and enter the date and time.

To recover to the System Change Number, choose SCN.

The System Change Number (SCN) tracks the timing of transactions in the Oracle database. The SCNs are stored in the control files and the datafile headers. You can recover the database to the

last existing SCN number in the control file, which is the last consistent database state.

7. Click Submit.

What to Do Next



Cloning an Oracle Database

You can use the cloning feature to do the following:

Duplicate large databases in a short amount of time

Create test environments

Retrieve data quickly without without intensive resource use on the production environment

Alleviate the load on production servers

You can create a clone from an existing data and log volume full backup. When you create a clone, you must specify the reservation period. The system automatically shuts down the clone database and frees up

all resources (including the snapshot clones on the storage array and ASM disk groups) when the reservation period expires.

Schedule clones to run periodically so that the clones are refreshed on a regular basis.

You cannot clone an Oracle 12c container database or pluggable database.

Before You Begin

1. Have the backup administrator configure a subclient for the clone feature.

2. Verify that the Oracle database version on the destination database is the same as the one on the

source database.

3. Verify that the Oracle user in both the source and destination database servers have the same user ID.

4. Install the Oracle Agent and the MediaAgent on the proxy.

5. On the destination client where want to create the clone database, create a directory for the mount path for the database clone files. This directory must be writable by the Oracle user.

6. If the Oracle database version is 11.2.0.3.0, 11.2.0.3.1, or 11.2.0.3.2, install Oracle patch 13366202 or the latest Oracle 11gR2 Patch Set Update on the destination database.

7. If the Oracle database version is Oracle 12c, install a minimum version of Oracle 12.1.0.2 with patch

19404068.

8. Optional: Create an additional instance on the destination client with the same name as of the clone

database so that you can store the clone instance properties (for example, ORACLE_HOME).

9. You can clone a database to the same or different computer. If you clone a database to an instance that

resides on a proxy computer, the following criteria must be met:

The Oracle database version on the proxy computer must be the same as the one in the source database.

The proxy computer must have access to the storage array containing the source database volumes.

The Oracle user in both the source and destination computers must have the same user ID.

The Oracle Agent and the MediaAgent must be installed on the proxy.

You must create a dummy Oracle instance with the same name as of the source database.

10. Perform a full backup (on page 84).

11. Set the database to the correct mode defined in the table.


Control File in the Restore Required Database Mode

Control file is included in the restore NOMOUNT

Control file is not included in the restore MOUNT

Procedure

1. From the navigation page, click Clients > client_group > client > agent, in the Actions column for the

instance, click the action button , and then click Clone.

The Clone Database page appears.

2. On the General tab, provide the destination information.

a. From the Client Name list, choose the client that you want the clone to be on.

b. From the Instance Name list, choose the instance that you want the clone to be on.

c. In the Oracle Home box, type the full path to the destination Oracle home directory.

d. In the User name box, type the user name that has access to the destination client Oracle database.

e. In the PFile box, type the full path to the destination startup parameter file.

f. In the Staging path box, type the full path to the location that the Oracle software uses to stage the clone.

3. On the Options tab, provide the clone options.

a. In the Clone reservation boxes, type the number of days and hours that the software retains the

test environment.

b. In the Copy Precedence box, type the precedence to use for the clone.

c. Select the database recover option.

To recover to the latest backup job completion time, choose Most recent backup.

To recover to a point-in-time, choose Point-in-Time and enter the date and time.

Note: If the time zone is different on the CommServe computer and client, in the Time Zone box, select the client computer time zone.

4. Click Summary to view your selections.

5. Click Submit.

What to Do Next



Introduction to the Admin Console for SAP HANA Databases

Use the Admin Console to initiate backups and restores of the SAP HANA databases.

To get started, you can configure SAP HANA systems and instances.

You can configure schedules to ensure that the data is automatically protected.

You can schedule backups, or run them as needed. You can restore to the same host or to a new host in the

case of a disaster.

The Admin Console provides summary information about the SAP HANA jobs.

Key Features

Configure servers, instance, storage, and subclients.

Back up subclients immediately or on a schedule.

Recover the database or just the data.



Getting Started with the SAP HANA Admin Console

Review each of the topics to get started with the SAP HANA Admin Console.


If the Admin Console application has not been installed by your backup administrator, you must install the

application. For instructions, see one of the following procedures:



If you do not have a CommCell environment, see Installing the Commvault Express Package (on page

20).

Step 2: Obtain Your User Credentials and Database Protection Information

Obtain the following information from your backup administrator:

The Admin Console URL

Your Admin Console user credentials

The storage policy for the database backups

The storage policy for the log backups

The storage policy for the command line backups


Access the Admin Console (on page 21) by using the URL that was displayed on the installation completion

page, or that you received from your backup administrator.

Step 4: Register the Admin Console

If you have not done so, register your Admin Console (on page 129).

Step 5: Prepare for Your First Backup and Restore

1. Add a SAP HANA system (on page 97).

2. If your SAP HANA system contains more than 1 instance, add the instances to the SAP HANA system (on page 98).

3. Add a subclient (on page 100).

4. If you want the subclient backups to run on a schedule, create a schedule (on page 82).

5. Determine the alerts that you want the software to trigger.

For information on how to configure alerts, see Managing Alerts (on page 110).


1. Perform a full backup (on page 101).

2. Perform a restore (on page 102).


SAP HANA Configuration

Clients and Client Groups

The clients details page displays the following information:

The clients and client groups that you have permission to view and modify


The client group security

You can perform the following operations on the clients details page:

Send the log files (on page 114).

Clients

Clients are the computers that host the databases.

The client details page displays the following client information:

The client name, the host name, and the CommServe host name.


The client security

The agents that are installed on the client

You can perform the following operations on the client details page:


To view the backup history, in the Actions column for the agent, click the action button , and then click Backup History.

To view the restore history, in the Actions column for the agent, click the action button , and then click Restore History.


Add a SAP HANA system. In the middle of the page, click Add client, and then click SAP HANA.

Agents

The agent details page displays the following information:

The client name

The data that the client was installed

The software version

The data protection activity setting

The configured SAP HANA instances

You can perform the following operations on the agent details page:


To view the backup history, in the Actions column for the instance, click the action button , and then click Backup History.

To view the restore history, in the Actions column for the instance, click the action button , and then click Restore History.

Add an instance (on page 79). In the upper right of the page, click Add instance.

Perform a restore (on page 102). In the Restore column, click Restore.

Add a subclient (on page 100). In the Actions column for the instance, click the action button , and

then click Add subclient.

Delete the instance. In the Actions column for the instance, click the action button , and then click Delete.

Note: When you delete the instance, the software deletes all of the subclients that are associated with the instance.

Instances

Instances are the structures that identify and manage SAP HANA databases. You must add an instance for each SAP HANA database that you want to protect.

The instance details page displays the following information:

The instance details, for example the instance number

The storage policies

The configured subclients

You can perform the following operations on the instance details page:

View the instance job history. For information on the job history, see Jobs (on page 112).




Add a subclient (on page 100). In the upper right of the page, click Backup History.

Perform a backup (on page 101). In the Actions column for the subclient, click the action button ,

and then click Backup.

Change the storage policy for the data backups and the log backups. In the Storage targets area, click

Edit.

Delete the instance. In the upper right of the page, click Delete.

Note: When you delete the instance, the software deletes all of the subclients that are associated with

the instance.

Subclients

The subclient details page displays the following information:

The latest backup information

The date and time of the next backup

The backup schedules


The enabled alerts

The subclient content

The following operations are available on the subclient details page:

Modify the data storage policy. In the Storage targets area, click Edit. From the Data Storage

Policy list choose the storage policy and then click OK.

Contact your backup administrator for the storage policy name.

Manage a backup schedule (on page 82). In the Schedules area, click Add Schedule.

Perform a backup (on page 101). In the Backup area, click Back up now.

Creating the SAP HANA HDBUSERSTORE KEY

If you want to have the SAP HANA client computer communicate with the SAP HANA Secure User Store, you

must create a SAP HANA HDBUSERSTORE key on the client computer.

Procedure

1. Log on to the client computer with the admin credentials.

2. On the command line, type the following command substituting the key, client computer and port number variables.

hdbuserstore -i set <key> <client_computer>:<port_number> <user_name> <password>

3. On the command line, type the following command to verify the key information.

hdbuserstore LIST


Example

Create the KEY called BACKUPM for the client that is named hana04.

hdbuserstore -i set BACKUPM hana04:30213 system_user Password1234

Creating the SAP HANA Parameter File

You must create a parameter file when you:

Perform a cross-machine restore. This includes a restore for disaster recovery.

Perform a backup or restore for a multi-instance configuration.

Procedure

1. Create the SAP HANA BACKINT parameter file on the host where you installed the SAP HANA Agent in the iDataAgent directory.

2. For information on required and optional parameters, see SAP HANA BACKINT Configuration Parameters

(on page 96).

3. Create the /usr/sap/<SID>/SYS/global/hdb/opt/hdbconfig directory.

4. On the command line, type the following command to link the file to the specified location Substitute param with the name of the parameter file.

ln -s /opt/commvault/iDataAgent/param

/usr/sap/<SID>/SYS/global/hdb/opt/hdbconfig/param

5. In the SAP HANA Studio, set the Backint data and log parameter files to the newly created parameter

file. For information on how to configure the files, see Configure a Third-Party Backup Tool (http://help.sap.com/saphelp_hanaplatform/helpdata/en/0c/88b2a28e60471b8dde8829dcf8196f/frames

et.htm).

Note: Enable the third-party log backup option. Set the option to true.

http://help.sap.com/saphelp_hanaplatform/helpdata/en/0c/88b2a28e60471b8dde8829dcf8196f/frameset.htm

http://help.sap.com/saphelp_hanaplatform/helpdata/en/0c/88b2a28e60471b8dde8829dcf8196f/frameset.htm


SAP HANA BACKINT Configuration Parameters

The following table defines the SAP HANA BACKINT configuration file parameters.

Parameter Example Definition

CvInstanceName

CvInstanceName

instance_name

Example:

CvInstanceName

Instance001

The name of the configured instance.

This parameter is optional.

CV_restCopyPrec

CV_restCopyPrec

copy_precedence

Example:

CV_restCopyPrec

2

The copy precedence for the restore job.

You must set this value to 0 is you restore from a selective copy.

Managing SAP HANA Backup Schedules

You can schedule jobs to perform data protection operations on a regular basis without user intervention.

You can create an automatic schedule to perform a backup when certain criteria are met.

You can manually run a scheduled job at any time, without re-configuring all the other properties that are

associated with the job. This is helpful when you need to re-run a failed scheduled job.

Leap Year Note: If a monthly job is scheduled to run on a day that a month does not have, the job runs on the last day of that month. For example, jobs scheduled to run on the thirtieth of each month will run on

February 29 in a leap year or February 28 in other years.

Procedure

1. You can add or edit a schedule on the subclient details page.

To add a schedule, from the navigation pane, click Clients > client_group > client > agent >

instance > subclient, in the Schedules area, click Add Schedule.

To edit a schedule, from the navigation pane, click Clients > client_group > client > agent > instance > subclient. Then, in the Schedules area, click the schedule name.

The Add schedule or Edit schedule dialog box appears.

2. If this is a new schedule, in the Name box, type a unique name for the schedule.

3. From the Backup level options, choose the type of backup, for example, Full.

4. From the Frequency options, choose how often the backup is performed:

To use an automatic schedule, click Automatic and set the minimum and maximum time in hours and minutes.


Note: If these values are met, the backup job starts even if the database criteria are not met.

To use a daily schedule, click Daily and set the schedule details.

To use a weekly schedule, click Weekly and set the schedule details.

To use a monthly schedule, click Monthly and set the schedule details.

5. Optional: If you chose a non-automatic option, set the schedule exceptions.

a. Click Exceptions.

The Exceptions dialog box appears.

b. Set the exception details.

c. Click Save.

6. Optional: If you chose a non-automatic option, set how often the software repeats the backup.

Select the Repeat Every check box and set the repeat details.

7. Click Save.

Adding a SAP HANA System

Add a SAP HANA system to represent the SAP HANA database instances that you want to protect.

Before You Begin

1. Determine how to connect to the database. If you want to use the SAP HANA Secure User Store, create a key (on page 94).

For information on the SAP Secure User Store, go to the SAP help.sap.com website, hdbuserstore.

2. Make sure that you have the following information about the SAP HANA system:

The data storage policy name

The log storage policy name

The command line storage policy name

The admin user name

The SAP HANA instance SID

The SAP HANA instance number

The SAP HANA primary server

The SAP HANA worker node

The SAP HANA user credentials

The SAP HANA user store key

The directory that contains the SAP HANA hdbsql tools.

To determine the location, log in to the SAP HANA server with the sid admin credentials and type

the following on the command line:

which hdbsql

help.sap.com


Procedure

1. From the navigation pane, click Clients > client_group > client, in the middle of the page, click Add

Client and then click SAP HANA.

The Add SAP HANA system dialog box appears.

2. On the General tab, provide the connection details.

a. In the Pseudo Client name box, type a unique name to identify the SAP HANA system.

b. In the Instance Name box, type the SAP HANA instance SID.

c. In the Instance Number box, type the SAP HANA instance number.

d. In the OS username box, type the admin user name.

e. From the Primary HANA server list, choose the SAP HANA client that is the primary server.

f. In the HDB SQL Location box, type the directory that contains the SAP HANA hdbsql tools.

g. Determine how to connect to SAP HANA.

To use the SAP HANA Secure User Store, choose HDB User Store Key and then type the SAP

HANA Secure User Store key in the box.

To use a database user, choose DB Username and then type the SAP HANA database user

credentials in the boxes.

3. On the Details tab, from the Select a Database Worker Node list, choose the SAP HANA client that is the worker node and then click Add.

4. On the Storage tab, choose the storage policies.

From the Data Storage Policy list, choose the storage policy the software uses for data backups.

From the Log Storage Policy list, choose the storage policy the software uses for log backups.

From the Command Storage Policy list, choose the storage policy the software uses for command line backups.

5. Click Add.

What to Do Next

If there is more than 1 instance in the SAP HANA system, add the instances to the SAP HANA system (on page 98).

Adding a SAP HANA Instance to a SAP HANA System

Add a SAP HANA instance to an existing SAP HANA system.

Before You Begin

1. Add a SAP HANA system (on page 97).

2. Make sure that you have the following information about the SAP HANA system that hosts the instance:

The data storage policy name

The log storage policy name

The command line storage policy name

The admin user name


The SAP HANA instance SID

The SAP HANA instance number

The SAP HANA primary server

The SAP HANA worker node

The SAP HANA user credentials or the SAP HANA Secure User Store key

The SAP HANA user store key

The directory that contains the SAP HANA hdbsql tools.

Procedure

1. From the navigation pane, select Clients > client_group > client, in the Actions column for the agent,

click the action button , and then click Add instance.

The Add SAP HANA instance dialog box appears.

2. On the General tab, provide the connection details.

a. In the Instance Name box, type the SAP HANA instance SID.

b. In the Instance Number box, type the SAP HANA instance number.

c. In the OS username box, type the admin user name.

d. From the Primary HANA server list, choose the SAP HANA system primary system client.

e. In the HDB SQL Location box, type the directory that contains the SAP HANA hdbsql tools.

f. Determine how to connect to SAP HANA system.

To use the SAP HANA Secure User Store, choose HDB User Store Key and then type the SAP

HANA Secure User Store key in the box.

To use a database user, choose DB Username and then type the SAP HANA database user

credentials in the boxes.

3. On the Details tab, from the Select a Database Worker Node list, select the SAP HANA client that is the worker node and then click Add.

4. On the Storage tab, choose the storage policies.

From the Data Storage Policy list, choose the storage policy the software uses for data backups.

From the Log Storage Policy list, choose the storage policy the software uses for log backups.

From the Command Storage Policy list, choose the storage policy the software uses for command

line backups.

5. Click Add.


Managing SAP HANA Subclients

You can configure the subclient properties:

The storage policy that the software uses for backups

The number of data streams that the software uses for backups

Note: The subclient content is fixed and cannot be modified.

Before You Begin

Make sure that you have the following information:

The storage policy to use for backups

Procedure

1. You can add a subclient on the agent details page or the instance details page. Choose one of the

options.

Agent details: From the navigation pane, click Clients > client_group > client > agent, in the

Actions column for instance, click the action button , and then click Add Subclient.

Instance details: From the navigation pane, click Clients > client_group > client > agent > instance. Then, in the upper right of the page, click Add Subclient.

The Add Subclient dialog box appears.

2. In the Subclient Name box, type the subclient name.

3. From the Storage policy list, choose a storage policy name that the software uses for backups.

4. In the Number of Data Streams box, type the number of streams that the software uses for backups.

5. Click OK.


SAP HANA Backups

Full Backups

SAP HANA full backups include all of the database volumes on each node.

You can run backups immediately or configure a schedule for the subclient.

Incremental Backups

An incremental backup contains the changed data from the last full or incremental backup.

A differential backup contains the changed data from the last full backup.

Incremental and differential backups use fewer resources than full backups.

What is Backed Up

All of the database files on each of the nodes

The log files on each of the nodes

The catalog files

What Is Not Backed Up

SAP HANA application files that are associated with the SAP HANA installation.

Performing SAP HANA Backups

You can perform a full, incremental or differential backup of the SAP HANA database.

Before You Begin

The database must be online and all services must be running.

Procedure

1. You can perform a backup on the subclient details page or the instance details page.

Subclient details: From the navigation pane, click Clients > client_group > client > agent > instance > subclient. Then, in the upper right of the page, click Backup.

Instance details: From the navigation pane, select Clients > client_group > client > agent >

instance, in the Actions column for the subclient, click the action button , and then click

Backup.

The Backup Options dialog box appears.

2. Select the Backup level.

3. In the Backup prefix box, type a unique name to identify the backup.

4. Click OK.


The Backup options dialog box appears.

5. Optional: View the job details. Click the job ID.

6. Click OK.

What to Do Next


SAP HANA Restores


logical error or to copy the database.

Perform a restore operation immediately after your first full backup to understand the process.

The SAP HANA database is a combination of services that invoke backint. The SAP HANA software

determines and controls the number of streams to use for the restore by looking at services that are on the SAP HANA database.

You can perform the following types of restores:

Recover to the most recent state: This recovers the most recent backed up data and log files.

Note: You must stop the SAP HANA replication before you restore the most recent backed up data and

log files. If you do not stop the SAP HANA replication, only the latest data will be restored and the latest

log will not be restored.

Recover to a point-in-time: This recovers the backed up data up to the specified time.

Recover to a specific data backup: This recovers the backed up data of the specified backup.

Performing SAP HANA Restores


logical error or to copy the database. You can achieve this by using the data and the log backups that you previously performed.

The SAP HANA software brings the database down before the restore and brings it back up after the restore

completes.

Before You Begin


2. Verify that the restore environment has the same set of nodes and the instance SID name as the backup

environment. If you modified the backup environment, you must make the same modifications on the

restore environment.

3. Verify that the SAP HANA software version on the destination is the same version or higher than the

software version.


Procedure

1. You can perform a restore on the agent details or job details page.

Agent details: From the navigation pane, click Clients > client_group > client > agent, click Restore.

Job details: From the navigation pane, click Jobs > job ID. Then, in the Job summary section, click Restore.

The Restore Options page appears.

2. In the Destination Client list, choose the destination host to use for the restore.

3. In the Destination instance list, choose the destination instance to use for the restore.

4. Choose the database recover option.

To recover the database, select Recover Database.

To recover to the latest backup job completion time, choose Current time.

To recover to a point-in-time, choose Point in Time and type the date and time.

To recover only the data, choose Recover data only and in the Backup prefix box, type the backup prefix for the data that you want to recover.

5. To verify that all the backups required for the recovery operation are available, select the Check

Access check box.

6. To initialize the log area after the restore, select the Initialize log area check box.

7. Click Submit.

What to Do Next



Plans You create plans to protect your data. The plan is where you define what should be backed up and how often to run the backup job. In the Admin Console there are predefined plan types that include the data

protection parameters that apply to the type of data you want to protect.

Plan type Parameters Applies To

Server The storage target

The retention period in days

Predefined schedules

A daily incremental backup that is set to run every day at 9 P.M. and is

set for granular recovery

A monthly full backup that is set to run on the last Saturday at 8 P.M.

A weekly synthetic full backup that is set to run on Friday at 8 P.M.

Virtualization

agents

Endpoint The allowed features: laptop, Edge Drive, DLP (data loss protection)

The Edge Drive to use

The index server to use

The folders to include in the backups

The filters to use for the backup

The option to enable the backup quota and the quota limit

Predefined schedules:

An automatic incremental backup

An automatic synthetic full backup

The throttling to use for sending and receiving the data

The storage target

The retention period in days

Alerts for no backups performed within the last four days and failed

restore jobs

Laptop agents

File System agents

When you create a plan in the Admin Console, the software creates a schedule policy and a storage policy with the values that you entered.

Available Options

You can perform the following operations on the Plans page:

Add a server plan

Add a laptop plan

Delete a server plan

Delete a laptop plan


Associate users or groups with a laptop plan

View the plan details

Creating a Server Plan

You can create a server plan to specify the following:

The storage target that stores the backup data

The data retention period

The schedules to use to automatically back up the data

Before You Begin

Create a storage target. For information on storage targets, see Storage Targets (on page 117).

Procedure

1. From the navigation pane, click Plans.

2. On the Plans page, in the upper right of the page, click Create plan.

3. If you are in the All agents application, click Create Server Plan.

4. In the Add server plan dialog box, in the Plan name box, type the name of the plan.

5. In the Primary Storage list, click the storage target.

6. In the Retention period box, type the number of days that the software will retain the data.

7. Optional: To add an additional schedule, under Schedule, click Add schedule.

8. Click Save.

Result

The software creates a plan and a storage policy.

The storage policy has the following parameters:

The storage policy name is the plan name appended with Lib_x_Ret_y, where x is a system-generated

number and y is the value entered in the Retention period box.

A primary copy with the following values:

The default library is the Primary Storage list selection.

The MediaAgent is the one associated with the storage target.

The Retain For value is the value entered in the Retention period box.

What to Do Next

You can assign the storage policy to subclients and data collections.


Creating a Laptop Plan

You can create a laptop plan to specify the following:

The data to back up

The storage target that stores the backup data

The data retention period

The schedules to use to automatically back up the data

Before You Begin

Create a storage target. For information on storage targets, see Storage Targets (on page 117).

Procedure

1. From the navigation pane, click Plans.

2. On the Plans page, in the upper right of the page, click Create plan.

3. If you are in the All agents application, click Create Laptop Plan.

The Create Laptop Plan page appears.

4. Under General, fill in the following plan information:

a. In the Plan name box, type the name of the plan.

b. Select the check box for the features that the plan covers:

Laptop

DLP (data loss prevention)

Edge Drive

c. If you selected Edge Drive, under Edge Drive Settings, in the Index Server box, click the index

server to use with Edge Drive.

5. Click Next.

6. Under Backup content, define the content to backup:

a. On the Windows, Mac, or Unix tab, next to Content to backup, click Add.

b. In the Add Content dialog box, browse for content to back up, or click Add custom content to

type a path or pattern, for example, *.docx.

c. Click Save.

d. Repeat these steps until content is added for each operating system that you want the plan to support.

7. Optional: To exclude content from being backed up, under Backup content, define the exclusions:

a. On the Windows, Mac, or Unix tab, next to Exclude these files/folders/patterns, click Add.

b. In the Add exclusions dialog box, browse for content to exclude, or click Add custom content to

type a path or pattern, for example, *.docx.

c. Click Save.


d. Repeat these steps until exclusions are added for each operating system that you want the plan to

support.

8. Optional: To limit the amount of data that can be backed up by using this plan, under Backup content, set the quota:

a. Select the Enable quota check box.

b. In the GB box, type the maximum number of gigabytes that can be backed.

9. Click Next.

10. Optional: To add additional schedules, under Laptop backup schedule, click Add schedule.

Note: Laptop plans have default schedules: Incremental Automatic schedule and Space

Reclamation. You can delete or modify these schedules.

11. Optional: To throttle the transfer speed of data, under Network resources, clear the infinite check

boxes, and in the Kbps boxes, enter the maximum kilobits per second.

12. Click Next.

13. Under Options, in the Storage target list, click the storage target that should store the data that is

backed up.

14. Optional: Under Options, change the default retention for deleted items or disable the default alerts.

15. Click Finish.


Companies In a multi-tenant environment, a Managed Service Provider (MSP) administrator can set up companies and control access to servers and other entities for each company. When multi-tenant support is enabled, the

Companies option is displayed in the Admin Console navigation pane, providing the ability to add companies and define data protection plans for each company.

The MSP administrator can associate servers to users or assign users as owners of servers, enabling the

environment for each company to be customized so that the users in each company have access to their own resources, but cannot view or modify resources for other companies.

An MSP administrator can see and modify all resources in the Admin Console.

Depending on user roles and the applications being used, tenants can see servers, virtual machines, jobs,

alerts, events, plans, security, and system settings.

The main Companies page shows company names and contacts. You can perform the following actions:

Click Add company to create a new account.

Click a company name to display information for the company.

Under the Actions column, click the action button in the row for the company and select Delete

company to remove an account.

After displaying information for a specific company, you can click Edit in the Plans section to modify data

protection plans.

Adding a Company

Add a company to provide basic information about an account.

Procedure

1. Select Companies in the navigation pane.

2. In the Companies page, click Add company.

3. In the Add company dialog box, provide the following information:

Company: Name of the company.

Email: Email address for the primary contact at the company.

The primary user has administration capabilities for all of the resources for the company.

Contact name: Name of the primary contact at the company.

Plans: Select one or more data protection plans to be available for the company.

To assign multiple plans, click the Plans list again to select each new plan.

4. Click Save.


When the company is created, the primary user receives an email with the URL for the Admin Console and a

temporary. The user must change the temporary password after the initial when accessing the Admin

Console for the first time.

Editing Plans for a Company

You can edit plan information for a company to select or remove predefined plans.

Procedure

1. Select Companies in the navigation pane.

2. In the Companies page, click a company name.

3. In the Plans section of the company page, click Edit.

4. In the Edit plan dialog box, select the plans that should be available for the company.

You can select Show selected to display only the currently selected plans, or filter plans by the plan

name or type.

5. Click Save.


Monitoring You can monitor activity in the Admin Console by creating alert definitions, viewing events, and viewing and controlling jobs.

Alerts

Alerts provide automatic notification about operations, such as failed jobs. Alerts are displayed on the

Triggered Alerts page. Users defined in the alert definition receive an email notification when an alert is

triggered.

Creating an Alert Definition

You can create alert definitions to provide automatic notification about operations, such as failed jobs. An alert is triggered when conditions within the entity meet the criterion selected for the alert.

Procedure

1. From the navigation pane, click Alerts.

2. On the Triggered alerts page, in the upper right click Alerts definitions.

The Add alert definition page appears.

3. In the Alert name box, type the name of the alert.

4. In the Alert type list, click the type of alert you want to create, for example, Backup Job Failed.

5. If the alert type has a variable in it, in the Value for X box, enter a value for the variable.

For example, you must define the value for X for the Backup Delay by X Hrs alert type.

6. Under Entities, select the entities the alert definition should apply to.

7. Under Users, for each user who should receive notifications for the alert, do one of the following:

Type the user email address.

Type the user or user group name, and from the generated list, click the user or user group name.

8. Click Add.

9. Click Save.

Managing Alerts

You can manage alerts and alert definitions.

Procedure

Viewing

To view alerts, from the navigation pane, click Alerts.

On the Triggered alerts page, alerts triggered from your alert definitions are listed.


To see the alert details, on Triggered Alerts page, in the Alert info column, click the descriptive link.

To view alert definitions, from the navigation pane, go to Alerts, and click Alert definitions.

Deleting

From the navigation pane, click Alerts, and on Triggered Alerts page, delete alerts:

To delete individual alerts, select the check box for the alert and click Delete.

To delete all of the alerts, select the check box in the table header and click Delete.

Note: If there are pinned alerts in the list, they are deleted.

Updating Alerts Definitions

1. From the navigation pane, click Alerts, and click Alert definitions.

2. To enable or disable an alert, in the Enabled column, select or clear the check box.

3. To view the definition page for an alert, in the Name column, click the name.

4. To make changes to the users and user groups who receive notifications for the alert, do the following:

a. On the definition page, under User or groups to notify, click Edit.

b. In the Add new user or group dialog box, do one of the following:

Type the user email address.

Type the user or user group name, and from the generated list, click the user or user group

name.

c. Click Add.

d. Click Save.


Alert Information

The Triggered alert page provides the following information:

Field Description

Severity Valid values are:

Major: Indication that a major function is compromised and needs

remediation.

Critical: Indication that an error occurred and needs remediation.

Information: Non-critical information that does not require immediate action.

Detected criterion Brief description of the issue.

Type Type of event that caused the alert as listed in the alert definition, for example,

Data Protection or Data Recovery.

Detected time Date and time when the system detected the alert condition.

Computer name Identifies the entity to which the alert applies.

Alert info Name of the alert. Click to view additional information about the alert.

Pin Click to save the alert notification and prevent it from being pruned.

Viewing Events

The Events page provides information about jobs and other significant events detected in the Admin

Console. In some cases, events can trigger alerts to notify users of events (such as job failures).

Procedure

1. From the navigation pane, click Events.

The Events page appears.

2. To view details for an event, in the Event ID column, click the event ID.

Jobs

On the Jobs page, you can control active jobs and view completed jobs. By default, all jobs run in the last

24 hours are available. You can use the Showing and for lists to filter the jobs, for example, you can view jobs that finished in the last seven days. The Jobs page includes jobs that you ran, for example a backup

job, and jobs that the software automatically ran, for example pruning jobs. For information on the Jobs

page columns, see Job Information (on page 115).

On the Severs page, you can disable and enable entire job categories in your CommCell environment.


Controlling Activities

You can disable and enable job categories in your CommCell environment. For example, you can disable all

data management (back up) jobs.

Procedure


2. Under Activity Control, click the toggle key next to the type of activity you want to disable or enable:

All Job Activity

Data Management (back up)

Data Recovery (restore)

Data Aging (pruning)

Auxiliary Copy

Scheduler

Offline Content Indexing

Controlling Jobs

You can control active jobs. For example, you can suspend a job.

Procedure

1. From the navigation pane, click Jobs.

The Jobs page appears.

Tip: You can change the jobs you see by using the filter options in the upper right of the page.

2. In the Actions column for the job, click the action button and choose your action:

To kill the job, click Kill.

To suspend the job, click Suspend.

To resume a suspended job, click Resume.

Viewing Jobs

You can view jobs for the entities in your application. For example, you can view jobs for servers or devices.

Procedure

All Jobs

1. From the navigation pane, click Jobs.

The Jobs page appears.

Tip: You can change the jobs you see by using the filter options in the upper right of the page.

2. To view the job details, in the Job ID column, click the job ID.


For a Specific Entity

1. From the navigation pane, click the entity. For example, select Servers.

2. From the list of available entities, in the Name column, click the entity name.

3. In the upper right of the entity details page, click Jobs.

Note: Some entities have links to view specific types of jobs. For example, on the device details page, click Restore jobs to view the restore jobs for the device.

Sending Log Files

You can use log files to analyze and diagnose problems within the Admin Console. The log files contain the

operation processing details.

About This Task

The default options for sending the logs are selected based on where you initiate the operation. For

example, if you initiate the operation from the Jobs page, the Send log files dialog box is prepopulated with the job ID.

Procedure

1. From the navigation pane, go to the page from where you want to send the logs:

Servers page: Click Servers and click Send log files in the upper right of the page.

Jobs page: Click Jobs, in the Actions column for the job, click the action button , and select Send logs.

Job details page: Click Jobs > job ID and click Send logs in the upper right of the page.

2. In the Send log files dialog box, on the Computers tab, select the logs to send:

To send the log files for a specific job, click Job ID and enter the job ID.

To send the log files for a specific set of computers, click Computers and choose the computers.

3. On the Information tab, select the type of logs that you want to include, for example, Database logs.

4. On the Output tab, select the Upload check box and browse for a storage location.

5. On the Notifications tab, select the users who should receive an email about the logs.

By default, logs are sent to Commvault support.

6. Click Send Logs.


Job Information

The Jobs page and Job Details page provide the following information:

Field Description Pages

Job ID The system generated ID for the job. Click the job ID to open the Job

Details page.

Job

Job Details

Operation

The job type, for example, Backup.

Note: If you perform a backup or restore by a using third-party

command line interface, for example, RMAN, "3RD" is appended to the operation type.

Job

Job Details

Status This indicates the job status description. Job

Job Details

Size The amount of data that the job is processing or processed.

Job

Job Details

Server The server that performed the job. Job

Job Details

Collection This is the collection of data, or subclient that the software used for

the job.

Job

Job Details

Start time The time that the software started the job. Job

Job Details

Elapsed Time The total time that the job ran. Job

Job Details

Logs The option to send or view the logs.

Job

Job Details

JPR The job pending reason. When the job failed, a code is displayed. Point to the code to see the complete failure description.

Job

Job Details

Progress

The job status.

Valid values are:

Job

Job Details


In progress

Completed

Failed

Job started by The user that started the job. Job Details

Job started

from

This is how the job was started.

For jobs that the software automatically starts, the value is

"Scheduled."

For third party command line jobs, the value is "Third Party."

Job Details

iDataAgent The agent type, for example SAP HANA. Job Details

Instance For database jobs, this is the instance that the job used. Job Details

Transfer time The time that it took for the software to transfer the data. Job Details

End Time The time that the job ended. Job Details

Software

Compression

The software compression that the job used.

Valid values are:

Off

Storage Policy

MediaAgent

Job Details


Storage Targets A storage target is a cloud library or a disk library that you associate with one or more mount paths. A mount path is a set of partitioned disks or arrays that is associated with a file system. A mount path can be

a local disk or networked attached storage on the disk library MediaAgent. This is where data is stored when it is backed up.

The Storage Targets page lists the name, status, manufacturer, and model of the storage targets you add.

Available Operations

You can perform the following operations on the Storage Targets page:

Add a storage target.

Delete a storage target.

To delete the storage target, in the Actions column, click the action button and click Delete.

View the storage target details.

To view the storage target details, click the storage target name.

Configuring a Disk Library as a Storage Target

You can configure a disk library as a storage target. You must assign a mount path to a disk library. A mount path can be:

A local disk drive associated with the MediaAgent

A disk drive that is on networked-attached-storage (NAS) associated with the MediaAgent

Procedure

1. From the navigation pan, click Storage targets.

The Storage targets page appears.

2. Click Add library in the upper right of the page and select Disk.

3. In the Add disk library dialog box, enter the disk library details:

a. In the Name box, type the name of the library.

b. From the MediaAgent list, select the MediaAgent that will write the data to the disk.

4. To use a local disk as the mount path, click Local path and in the Path box, type the full path name to the storage location.

5. To use a network drive as the mount path, provide the following information:

a. Click Network path.

b. In the User name and Password boxes, type the credentials for a user who has write access to

the network device.

c. In the Path box, type the full path name to the storage location.



Result

The disk library is available. You can associate the disk library with a plan.

Related Topics

Adding a Mount Path (on page 118)

Adding a Mount Path

On the Storage Target Details page, you can view the storage capacity and free space for a storage

target. The information is the sum of all of the mount paths. If you need additional mount paths, you can add mount paths to the storage target.

Procedure

1. From the navigation pane, go to Storage Targets > storage_target and in the upper right of the page, click Add disk.

The Add path dialog box is displayed.

2. In the Name box, type the name of the mount path.

3. From the MediaAgent list, select the MediaAgent that will write the data to the disk.

4. To use a local disk as the mount path, click Local path and in the Path box, type the full path name to

the storage location.

5. To use a network drive as the mount path, provide the following information:

a. Click Network path.

b. In the User name and Password boxes, type the credentials for a user who has write access to the network location.

c. In the Path box, type the full path name to the storage location.

6. Click Add path.

Result

The mount path is added to the library.

Configuring a Cloud Library as a Storage Target

You can configure a cloud library as a storage target.

Procedure

1. From the navigation pane, click Storage targets.

The Storage targets page appears.

2. Click Add library in the upper right of the page and select Cloud.

3. In the Add cloud library dialog box, enter the cloud library details:


a. In the Name box, type the name of the library.

b. From the Type list, select the cloud library vendor.

c. From the MediaAgent list, select the MediaAgent that will write the data to the disk.

d. The Commvault software populates the Server Host box and credentials boxes with the default

values for each vendor, for example, Token_ID.

e. Provide the cloud library credentials.

For information on the cloud credentials, see Cloud Provider Information (on page 119).


Results

The cloud library is now available. You can associate the cloud library with a plan.

Cloud Provider Information

When you add a cloud storage library, enter the required information for the selected cloud provider.

Cloud Provider Options Description

Common options

MediaAgent The MediaAgent that writes the data

to the cloud library.

Server Host The IP address, fully qualified domain name, or URL for the cloud library.

AliCloud Object Storage

Service

Access_Key_ID Access key for the account.

Secret_Access_Key Secret key for the account.

Bucket Container for VM or instance volumes (disks).

AmazonS3



Bucket Container for VM or instance volumes

(disks).

AT&T Synaptic Storage

Root_Folder Root folder for the account.

Token_ID Token ID for the account.

Shared_Secret Secret associated with the account.

China Mobile oNest




Container Container for instance volumes (disks).

EMC Atmos

Token_ID Token ID for the account.

Shared_Secret Secret associated with the account.

Root_Folder Root folder for the account.

Google Cloud Storage



Bucket Container for instance volumes

(disks).

HDS Hitatchi Content

Platform

Username Name of the user account to access the cloud library.

Password Password for the user account to

access the cloud library.

Namespace Container for VM or instance volumes

(disks).

Google Cloud Storage



Bucket Container for instance volumes (disks).

Microsoft Azure Storage

Account Name Subscription ID for the account.

Access Key Access key for the account.

Container Container for VM or instance volumes (disks).

OpenStack Object Storage

Username Name of the user account to access

the cloud library.

API_Key Password for the user account to




Oracle Storage Cloud Archive

Service




Container Container for VM or instance volumes

(disks).

Oracle Storage Cloud Service





Rackspace Cloud Files

Username Name of the user account to access

the cloud library.

API_Key Key for the Rackspace account.

Container Container for VM or instance volumes

(disks).

Verizon_Cloud



Bucket Container for VM or instance volumes

(disks).


User Security Settings You can select the Security option in the navigation pane to configure users, user groups, and roles.

Users and User Groups

Users

You can create, edit, and delete users, and you can control the features the user has access to by making

security associations between the user, a role, and entities.

Commvault supports Admin Console users and external users.

User Groups

User groups are a collection of users that make it easy to control a large number of users. Properties and security associations selected for the user group apply to all of the users in the group.

The following user groups are automatically created when the software is installed:

Master

View All

Creating a User

You create users to enable access to the Admin Console. When you create a user, you assign the user to a

user group that has properties and security associations assigned to it.

Before You Begin

Create a user group (on page 123).

Procedure

1. From the navigation pane, go to Security > Users.


2. In the upper right of the page, click Add user.

3. In the Add user dialog box, provide the user information.

4. To assign this user to a user group, from the User group list, select the user group.

5. To allow this user to access the Admin Console, select the Enabled check box.

6. Click Save.


Managing Users

You can edit or delete users you created in the Admin Console. You cannot edit or delete domain users.

Procedure

1. From the navigation pane, go to Security > Users.


2. Decide if you want to edit or delete a user:

To edit a user, click the user name, click Edit, and in the Edit user dialog box, update the user information.

To delete a user, in the Actions column for the user, click the action button and click Delete.

3. If you edited the user, click Save.

Creating a User Group

A user group is a set of users who perform the same tasks. Create user groups to simplify the administration of the CommCell environment.

Procedure

1. From the navigation pane, go to Security > Users Groups.


2. In the upper right of the page, click Add user group.

3. In the Add user group dialog box, provide the user group information.

4. To specify the amount of data that members of the user group can back up, do the following:

a. Select the Quota enabled check box.

b. In the Quota limit box, type the maximum number of gigabytes that members of the group can

back up.

5. To allow users to inherit the group permissions and associations, select the Enabled check box.

6. Click Save.

Managing User Groups

You can edit or delete user groups.

Procedure



2. Decide if you want to edit or delete a user group:

To edit a user group, click the user group name, click Edit user group, and in the Edit user group dialog box, update the user group information.


To delete a user group, in the Actions column for the user group, click the action button and click Delete.

3. If you edited the user group, click Save.

Managing User Group Membership

You can add or remove users from a user group. After a user is added to the user group, properties and

security associations selected for the user group apply to all of the users in the group.

Procedure



2. Click the user group name.

The user group details page appears.

3. Decide if you want to add or remove a user from the user group:

To add a user, under Users, click Add users, select the box next to the user name, and click Add.

To remove a user, in the Actions column, click the action button , click Remove, and then click Yes in the confirmation dialog box.

Adding Domains

You can add a domain (name) server so that users who are members of the domain can log on to the Admin

Console with their domain credentials.

You can configure the Admin Console to authenticate users through a single sign-on configuration with

Active Directory.

Before You Begin

If you want to use single sign-on, configure LDAP on the Active Directory Server.

Procedure


The Add Name Server dialog box is displayed.

2. Decide if you want to create, edit, or delete a domain (name) server:

To create a domain (name) server, click Add name server.

To edit a domain (name) server, click the domain name, and click Edit name server.

To delete a domain (name) server, in the Actions column for the server, click the action button

and click Delete.

3. In the Add Name Server or Edit Name Server dialog box, provide the following information:

a. In the NETBIOS name box, type the fully qualified domain name that you use to identify this network resource, for example, my.domain.example.com.


b. In the Domain Name box, type the fully qualified domain name, for example,

my.domain.example.com.

c. In the User name and Password boxes, type the credentials for a user who has at least read permission for the domain.

d. To allow users to automatically log on, select the Enable SSO check box.

4. Click Save.

5. If you selected the Enable SSO check box, restart the Tomcat services on the Admin Console computer.

Managing Roles

A role is a collection of permissions that defines the level of access granted to a user or a user group. Permissions allow users to perform tasks such as performing backup, restore, and administrative operations

(for example, license administration) on entities. To use role-based security, you must create a security association between users or user groups, a role, and entities.

A role can be a part of as many security associations as needed, but each security association can only have

one role.

Commvault offers predefined roles that address typical security needs and can be customized by the

administrator:

Alert Creator

Alert Owner

Client Admins

Compliance

End User

Master

View

Tip: Instead of creating a new role, you can update a predefined role.

Procedure

1. From the navigation pane, go to Security > Roles.

The Roles page appears.

2. Decide if you want to create or edit a role:

To create a role, click Add Role.

To edit a role, click the role name.

3. In the Add role or Edit role dialog box, add or remove permissions:

To add a permission, select the check box next to the permission.

To remove a permission, clear the check box next to the permission.

4. Click Save.


Administrating the Security Associations of a Server

You can associate users, user groups, and roles to a server to control the operations that the users can

perform on the server.

Procedure

1. From the navigation pane, go to Servers.

A page listing the servers appears.

2. Under Servers, click the server.

The server details page appears.

3. Under Security, click Edit.

The Security dialog box appears.

4. On the Associations tab, in the user box, type the user or user group name, and from the generated list, click the user or user group name.

5. In the role box, select the role and then click Add.

6. Repeat steps 4 and 5 for each user and user group and role you want to include in the security

association.

7. Click Save.

Results

The users and user groups can perform actions on the server based on the permissions defined in the role.


System Settings From the Settings option on the navigation pane, you can access system-level information and settings. For example, you can view license information, register your software, brand the Admin Console, and configure

your email server.

Applying a License

You can update your CommCell license from the Admin Console. The CommCell license validates the

products and features that you use in your CommCell environment.

You might need to apply a new license in the following scenarios:

You are using an evaluation version of the license and the license is about to expire.

Evaluation licenses are valid for 30 days. You can choose to extend the expiration date or to obtain a permanent license.

You want to add more Commvault products to your CommCell environment.

You want to change the branding settings of the Admin Console. For example, display your company

name and logo in the console.

Before You Begin

Obtain the new license from your software provider.

To contact your software provider, send an email to [email protected]. Make sure to include your CommCell ID, which can be found in the License and Registration page of the Admin Console. For

instructions on how to access the license page, see the steps in the Procedure.

Procedure

1. From the navigation pane, go to Settings > License.

2. On the License and Registration page, click Update license.

3. In the Update License dialog box, click Select license file and locate the license file.

4. Click Apply.


Branding the Admin Console

You can add a logo to the Admin Console and change the color of the interface.

Before You Begin

Your logo must meet the following requirements:

JPG, JPEG, PNG or GIF format

200 x 50 pixels

Maximum file size of 10 KB

Procedure

1. From the navigation pane, go to Settings > Customization.

The Customization page appears.

2. To change the color of the interface, either type the hex color code or select a color from the color box.

3. To add a logo, click Select File, click the file, and click Open.

4. Click Save.

Creating Global Exceptions

Global Exceptions are exclusions that filter out data from backup operations. You can create Windows and

UNIX exceptions. Global Exceptions support the use of regular expressions (or wildcards).

Procedure

1. From the notification pane, go to Settings > Global Exceptions.

The Global exceptions page appears.

2. Open the Enter path dialog box:

If this is the first exception in your Admin Console, click Add windows exception or Add unix exception.

If exceptions exist in your Admin Console, under either Windows global exceptions or Unix

global exceptions, click Edit.

3. In the Enter path dialog box, type the path to the file or folder you want to exclude from the backup operation.

4. To add multiple paths, press Enter before adding the next path.

5. Click Save.


Creating an Operation Window Rule

By default, all operations in the Admin Console run for 24 hours without restriction. To prevent operations

from running during certain time periods, define operation window rules. When operation window rules are

configured, operations that would start within the operation window go into a queued (as opposed to pending) state. After the operation window ends, the queued operations resume automatically.

Procedure

1. From the navigation pane, go to Settings > Operation Window.

2. On the Operation window page, click Add operations.

3. In the Operation rule dialog box, enter the operation rule.

4. Click Save.

Configuring an Email Server

To send email messages from the Admin Console, you must set up an email server. For example, when you

send log files, you can send email notifications to users.

Procedure

1. From the notification pane, go to Settings > General > Configure email.

The Configure email page appears.

2. Enter the details for the email server:

a. In the SMTP server box, type the name of the mail server, for example, smtp.mailservername.com.

b. In the SMTP Port box, type the mail server port. The default port is 25.

c. In the Sender email box, type an email address.

d. In the Sender name box, type the sender name.

3. Click Save.

Registering the Admin Console

Register your software so that you can monitor your environment by using the Worldwide dashboard and

the Health report available on the Commvault Cloud website https://cloud.commvault.com.

Before You Begin


Procedure

1. From the navigation pane, go to Settings > License.

2. On the License and Registration page, under Registration details, click Register.

3. In the Register product dialog box, type your email address and password.




4. Click Save.

Result

Your Commvault Cloud account is linked to your Admin Console.


Early Release The Admin Console is an Early Release feature. You can use the Admin Console in a controlled environment that meets the necessary requirements that are validate by Commvault.

RECOMMENDED

If you are interested in using an early release feature, deploy it only in a controlled environment. If you

require support while using an early release feature, contact us at [email protected], and we

can assist you in customizing and troubleshooting it for your environment.

You can also provide feedback and enhancement suggestions for early release features by contacting us at

[email protected].


Index

A

Accessing the Admin Console - 21, 26, 27, 55, 56,

75, 91

Accessing the Download Center - 62, 63, 64, 65

Adding a Collection - 28, 35

Adding a Company - 108

Adding a Mount Path - 118

Adding a Package - 62, 63, 64

Adding a Repository - 62, 63, 64

Adding a SAP HANA Instance to a SAP HANA

System - 91, 98

Adding a SAP HANA System - 91, 97, 98

Adding a Server - 27, 31

Adding Domains - 124

Administering Schedules - 75, 79, 82, 91, 94

Administrating the Security Associations of a Server -

62, 126

Alert Information - 112

Alerts - 110

Applying a License - 127

Attaching a Disk to an Existing VM for VMware - 48

B

Backups - 26, 28, 44

Branding the Admin Console - 128

C

Cloning an Oracle Database - 78, 87

Cloud Provider Information - 119

Collections - 35

Companies - 108

Configuration for Virtualization - 28

Configuring a Cloud Library as a Storage Target -

118

Configuring a Disk Library as a Storage Target - 117

Configuring an Email Server - 27, 129

Controlling Activities - 113

Controlling Jobs - 113

Creating a Custom End-User Endpoint Package - 16,

17, 55, 56

Creating a Laptop Plan - 56, 57, 58, 106

Creating a Server Plan - 28, 105

Creating a User - 122

Creating a User Group - 122, 123

Creating an Alert Definition - 110

Creating an Operation Window Rule - 129

Creating Disk Filters - 39

Creating Global Exceptions - 128

Creating the SAP HANA HDBUSERSTORE KEY -

94, 97

Creating the SAP HANA Parameter File - 95

Creating VM Filters - 38

D

Database Agents - 5, 71

Devices - 58

Download Center - 18, 61

Download Details Page - 69

E

Early Release - 131

Editing Collection Options - 36, 40

Editing Plans for a Company - 109

Editing Server Information - 34

Endpoint - 5, 55

G

Getting Started with Admin Console - 10, 15, 26

Getting Started with the Endpoint Application - 16,

55

Getting Started with the Oracle Admin Console - 21,

75

Getting Started with the SAP HANA Admin Console

- 5, 91

I

Installation - 6

Installing the Commvault Edge Server Package - 6,

16, 55

Installing the Commvault Express Package - 6, 20,

75, 91

Installing the End-User Endpoint Package on a Mac

Operating System - 19

Installing the End-User Endpoint Package on a

Windows Operating System - 18

Installing the Stand-Alone Admin Console Package -

6, 9, 26, 55, 75, 91

Installing the Virtual Server Protection Package - 6,

15, 26

Introduction to the Admin Console - 5

Introduction to the Admin Console for Oracle

Databases - 73

Introduction to the Admin Console for SAP HANA

Databases - 89

Inviting Users and User Groups to Install the End-

User Endpoint Package - 57

J

Job Information - 112, 115

Jobs - 59, 60, 77, 78, 79, 84, 86, 88, 92, 93, 102, 103,

112

M

Managing Alerts - 75, 91, 110


Managing Collection Content - 36

Managing Oracle Database Instances - 75, 77, 78, 79,

81, 93

Managing Oracle Subclients - 75, 78, 80, 81

Managing Packages - 65

Managing Proxies - 42

Managing Repositories - 64

Managing Roles - 62, 125

Managing SAP HANA Backup Schedules - 96

Managing SAP HANA Subclients - 91, 93, 94, 100

Managing Schedules - 42, 44

Managing User Group Membership - 124

Managing User Groups - 123

Managing Users - 123

Manually Performing a Backup - 55, 58, 59

Monitoring - 110

O

Oracle Backups - 83

Oracle Configuration - 77

Oracle Restores - 85

P

Package Information Page - 65, 66

Performing a Backup - 44

Performing Oracle Backups - 78, 84, 85, 87

Performing Oracle Restores - 76, 78, 85

Performing SAP HANA Backups - 91, 94, 101, 102

Performing SAP HANA Restores - 91, 93, 102

Plans - 104

Preinstallation Checklist for the Admin Console - 9,

11

R

Registering the Admin Console - 75, 91, 129

Reports - 33, 34, 54

Restores - 26, 45

Restoring Files and Folders - 56, 59

Restoring Full Virtual Machines for Hyper-V - 52

Restoring Full Virtual Machines for VMware - 50

Restoring Guest Files and Folders for Hyper-V - 46

Restoring Guest Files and Folders for VMware - 45

Restoring Virtual Machine Disk Files - 48

S

SAP HANA BACKINT Configuration Parameters -

95, 96

SAP HANA Backups - 101

SAP HANA Configuration - 92

SAP HANA Restores - 102

Security Configuration for Virtualization - 29

Sending Log Files - 77, 92, 114

Servers - 31

Storage Targets - 28, 105, 106, 117

System Requirements for the Admin Console - 7, 11,

15, 16, 20

System Settings - 127

T

Tracking the Location of a Device - 60

U

User Security Settings - 122

Users and User Groups - 122

Using the Setup Wizard for the Endpoint Application

- 55, 56

Using the Setup Wizard for the Virtualization

Application - 26, 27, 28, 32

V

Viewing Events - 112

Viewing Jobs - 113

Viewing Server and Collection Details - 32

Viewing Virtual Machine Information - 53

Virtual Server Agent (VSA) - 23

Virtualization - 5, 22, 23

VSA System Requirements - 24

©2016 Commvault Systems, Inc. All rights reserved. Commvault, Commvault and logo, the "CV" logo,

Commvault Systems, Solving Forward, SIM, Singular Information Management, Simpana, Simpana OnePass, Commvault Galaxy, Unified Data Management, QiNetix, Quick Recovery, QR, CommNet,

GridStor, Vault Tracker, Innervault, QuickSnap, QSnap, Recovery Director, CommServe, CommCell, IntelliSnap, ROMS, Commvault Edge, and Commvalue, are trademarks or registered trademarks of

Commvault Systems, Inc. All other third party brands, products, service names, trademarks, or registered

service marks are the property of and used to identify the products or services of their respective owners. All specifications are subject to change without notice.

Visit documentation.commvault.com for more information about Commvault products.

version 11 service pack 4 early release - knowledge base · pdf file ·...

Documents