Admin Console Here
Admin Console Here
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
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
2 Commvault Version 11 Service Pack 4 Early Release - July 19, 2016
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
Index 133
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.
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.
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:
If you install the VSP package, the computer must satisfy the following requirements:
If you install the Commvault Edge Server or Commvault Express package, the computer must satisfy the
following requirements:
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
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.
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).
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 that the computer where you plan to install the Admin Console satisfies the minimum requirements
specified in System Requirements (on page 7).
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.
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.
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.
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 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.
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.
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.
Note: Installations using the CommCell Console are not supported when
the CommCell is in "lockdown" mode.
CommServe host name 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.
If the computer has Windows Firewall turned on, you can add the
Windows Firewall Exclusion Commvault programs and services to the Windows Firewall exclusion list
List during the installation. We recommend this configuration which enables
CommCell operations across the firewall.
This package includes the following Commvault software: CommServe, Admin Console, Virtual Server Agent,
MediaAgent, CommCell Console, Web Server, Web Console, and Workflow Engine.
Procedure
1. Start the Virtual Server Protection installer, select where to extract the installation files, and then click
Extract.
2. On the welcome page, select the I Agree check box and proceed to the next page.
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).
This package includes the following Commvault software: CommServe, Admin Console, File System Agent,
MediaAgent, CommCell Console, Web Server, Web Console, and Workflow Engine.
Procedure
1. Start the Commvault Edge Server installer, select where to extract the installation files, and then click
Extract.
2. On the welcome page, select the I Agree check box and proceed to the next page.
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
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).
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.
Commvault Version 11 Service Pack 4 Early Release - July 19, 2016 17
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).
Procedure
Procedure
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.
Procedure
1. Start the Commvault Express installer, select where to extract the installation files, and then click
Extract.
2. On the welcome page, select the I Agree check box and proceed to the next page.
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.
20 Commvault Version 11 Service Pack 4 Early Release - July 19, 2016
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.
15. 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, 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).
Procedure
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.
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
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.
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.
Operating Systems Microsoft Hyper-V Server 2012 R2 with latest Microsoft HotFixes installed
100 GB recommended.
Hard Drive 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.
The cluster size or the allocation unit size of an NTFS volume in a virtual machine must
NTFS volumes 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:
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,
Virtual Machine Host
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 Operating Systems All Guest Operating Systems supported by VADP
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
VMware Tools on Virtual Machines
machines must also be supported on the host; unsupported versions must
be upgraded.
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).
Access the Admin Console (on page 21) using the URL that was provided by the administrator.
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.
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.
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).
To support ongoing operations, you can add servers, collections, storage, and users.
User Groups
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:
Note: In a multi-tenant environment, all Workflow privileges should also be included for VSA administrators.
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.
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
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.
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.
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.
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.
Procedure
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
Collections are created with default settings for backup options. To change default settings, see Editing
Collection Options (on page 40).
Procedure
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.
36 Commvault Version 11 Service Pack 4 Early Release - July 19, 2016
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 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.
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.
Procedure
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 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 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:
10. To edit a rule, click in the Actions column of the row for the VM and select Edit rule.
11. Click OK to save the changes to collection content.
Procedure
5. On the Disk Filters tab, to remove a filter, click in the Actions column of the row for the filter and
select Remove.
Commvault Version 11 Service Pack 4 Early Release - July 19, 2016 39
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.
9. Click OK to save the changes to collection content.
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
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
Managing Schedules
You can create a schedule for periodic backups from a collection of virtual machines for a server.
Procedure
To modify an existing schedule, click the schedule on the collection details page.
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
Procedure
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
Procedure
Procedure
1. From the navigation pane, click Servers.
Procedure
Procedure
Procedure
Note: You can click the button at the right side of the VM table header to add or remove columns or
to enable filtering.
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.
On the report page, you can perform the following actions to control which virtual machines are included in
the report:
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.
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.
Important: The setup for the Endpoint application includes inviting your end users to install the end-user
Endpoint package on their devices.
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 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 Commvault Edge Server Package (on
page 16).
Access the Admin Console (on page 21) using the URL that was displayed on the installation completion
page.
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:
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
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.
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.
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:
On the device details page, you can perform the following actions:
Procedure
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).
The device must be backed up. For information on manually backing up a device, see Manually Starting a
Backup (on page 58).
Procedure
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.
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).
Procedure
Result
Under Last Seen Location, an interactive map marks the latest geographical location of the device.
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.
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:
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.
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
Results
The repository appears at the bottom of the page in the Download Repository list.
What to Do Next
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).
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
Adding a Package
Download Center administrators can upload packages to the Download Center.
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 ( ).
Note: If this is the first time you are configuring Download Center, on the Welcome to Download
Center page, click Add Information About Your Downloads.
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.
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
Deleting a Package
1. Log on to the Web Console (on page 62).
2. From the My Applications page, click Download Center.
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.
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.
(Optional) A description of the package that appears in the Overview section of the
Description
package details page.
(Optional) The path in the repository where the ReadMe file is hosted. The ReadMe
ReadMe Location Location also contains the readme file name. Only readmes in the following formats
are supported: DOC, DOCX, PPT, PPTX, TXT, HTM, HTML, and PDF.
The Classify Your Download section of the Package Information page specifies additional information
used to organize the package on the Download Center page.
The following table describes the inputs available for this section:
Label Description
A general group by which you can filter packages. Category filters appear on the
Category
Download Center page.
A more specific group by which you can filter packages. Sub-category filters appear on
Sub-category
the Download Center page when a category filter is selected.
(Optional) A number that specifies the order in which packages are displayed on the
Rank Download Center page. A package with a rank of 1 is listed above a package with a rank
of 2.
(Optional) Specify a custom icon to display next to the package name on the Download
Software Icon
Center page.
(Optional) Not applicable. Leave the default setting of 0 when uploading a package to
Weightage
Download Center.
The Download Type and Location section of the Package Information page specifies information
about the file type, supported platforms, and location of your package.
The following table describes the inputs available for this section:
Label Description
Platform The operating system that is compatible with the package.
Cancel Clears the information entered into the Download Type and Location section.
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.
The following table describes the inputs available for this section:
Label Description
(Optional) The CommCell users and CommCell user groups that can view and
Visible to 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.
(Optional) The CommCell users and CommCell user groups that cannot view the
package. The Not visible to box supersedes the Visible to box.
Not visible to
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.
(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
Early preview future date .
users
Early Preview Users can view packages, even if they are also included in the Not
Visible To box.
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.
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.
Related Link Links to other packages that have the same category and sub-category.
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.
Related Link Links to other packages that have the same category and sub-category.
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.
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
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 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 Commvault Express Package (on page
20).
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.
If you have not done so, register your Admin Console (on page 129).
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).
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:
Clients
The client name, the host name, and the CommServe host name.
The data protection activity
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.
You can perform the following operations on the agent 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 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.
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 backup history, in the upper right of the page, click Backup History.
Subclients
Subclients contain the Oracle instance data that you want to back up and restore.
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).
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.
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.
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.
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.
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.
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.
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
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
Oracle application files that are associated with the Oracle installation.
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).
Perform a restore operation immediately after your first full backup to understand the process.
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
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.
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
You can control or view the job. For more information, see Jobs (on page 112).
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.
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.
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
You can control or view the job. For more information, see Jobs (on page 112).
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
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 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 Commvault Express Package (on page
20).
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.
If you have not done so, register your Admin Console (on page 129).
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:
Clients
The client name, the host name, and the CommServe host name.
The data protection activity
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.
Agents
You can perform the following operations on the agent 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 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.
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).
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.
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
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.
Procedure
Create the KEY called BACKUPM for the client that is named hana04.
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.
CvInstanceName
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. 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
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).
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.
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.
100 Commvault Version 11 Service Pack 4 Early Release - July 19, 2016
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
SAP HANA application files that are associated with the SAP HANA installation.
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.
Commvault Version 11 Service Pack 4 Early Release - July 19, 2016 101
The Backup options dialog box appears.
5. Optional: View the job details. Click the job ID.
6. Click OK.
What to Do Next
You can control or view the job. For more information, see Jobs (on page 112).
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.
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.
The SAP HANA software brings the database down before the restore and brings it back up after the restore
completes.
102 Commvault Version 11 Service Pack 4 Early Release - July 19, 2016
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
You can control or view the job. For more information, see Jobs (on page 112).
Commvault Version 11 Service Pack 4 Early Release - July 19, 2016 103
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.
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 Laptop agents
Predefined schedules:
File System
An automatic incremental backup
agents
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
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
104 Commvault Version 11 Service Pack 4 Early Release - July 19, 2016
Associate users or groups with a laptop plan
View the plan details
Create a storage target. For information on storage targets, see Storage Targets (on page 117).
Procedure
Result
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.
Commvault Version 11 Service Pack 4 Early Release - July 19, 2016 105
Creating a Laptop Plan
You can create a laptop plan to specify the following:
Create a storage target. For information on storage targets, see Storage Targets (on page 117).
Procedure
106 Commvault Version 11 Service Pack 4 Early Release - July 19, 2016
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.
Commvault Version 11 Service Pack 4 Early Release - July 19, 2016 107
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:
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
108 Commvault Version 11 Service Pack 4 Early Release - July 19, 2016
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.
Procedure
Commvault Version 11 Service Pack 4 Early Release - July 19, 2016 109
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.
Procedure
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.
110 Commvault Version 11 Service Pack 4 Early Release - July 19, 2016
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.
Commvault Version 11 Service Pack 4 Early Release - July 19, 2016 111
Alert Information
The Triggered alert page provides the following information:
Field Description
Severity Valid values are:
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.
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
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.
112 Commvault Version 11 Service Pack 4 Early Release - July 19, 2016
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
Controlling Jobs
You can control active jobs. For example, you can suspend a job.
Procedure
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.
Commvault Version 11 Service Pack 4 Early Release - July 19, 2016 113
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.
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.
114 Commvault Version 11 Service Pack 4 Early Release - July 19, 2016
Job Information
The Jobs page and Job Details page provide the following information:
Job
Status This indicates the job status description.
Job Details
Job
Size The amount of data that the job is processing or processed.
Job Details
Job
Server The server that performed the job.
Job Details
Job
This is the collection of data, or subclient that the software used for
Collection
the job.
Job Details
Job
Start time The time that the software started the job.
Job Details
Job
Elapsed Time The total time that the job ran.
Job Details
Job
Logs The option to send or view the logs.
Job Details
Job
The job pending reason. When the job failed, a code is displayed.
JPR
Point to the code to see the complete failure description.
Job Details
Commvault Version 11 Service Pack 4 Early Release - July 19, 2016 115
In progress
Completed
Failed
Job started by The user that started the job. Job Details
Job started For jobs that the software automatically starts, the value is
Job Details
from "Scheduled."
For third party command line jobs, the value is "Third Party."
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
116 Commvault Version 11 Service Pack 4 Early Release - July 19, 2016
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:
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.
Procedure
The disk library is available. You can associate the disk library with a plan.
Related Topics
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
Procedure
118 Commvault Version 11 Service Pack 4 Early Release - July 19, 2016
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).
4. Click Create library.
Results
The cloud library is now available. You can associate the cloud library with a plan.
Commvault Version 11 Service Pack 4 Early Release - July 19, 2016 119
Container for instance volumes
Container
(disks).
120 Commvault Version 11 Service Pack 4 Early Release - July 19, 2016
Name of the user account to access
Username
the cloud library.
Commvault Version 11 Service Pack 4 Early Release - July 19, 2016 121
User Security Settings
You can select the Security option in the navigation pane to configure users, user groups, and roles.
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.
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.
Procedure
122 Commvault Version 11 Service Pack 4 Early Release - July 19, 2016
Managing Users
You can edit or delete users you created in the Admin Console. You cannot edit or delete domain users.
Procedure
Procedure
Procedure
Commvault Version 11 Service Pack 4 Early Release - July 19, 2016 123
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.
Procedure
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.
If you want to use single sign-on, configure LDAP on the Active Directory Server.
Procedure
124 Commvault Version 11 Service Pack 4 Early Release - July 19, 2016
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
Commvault Version 11 Service Pack 4 Early Release - July 19, 2016 125
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
Results
The users and user groups can perform actions on the server based on the permissions defined in the role.
126 Commvault Version 11 Service Pack 4 Early Release - July 19, 2016
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 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.
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
Commvault Version 11 Service Pack 4 Early Release - July 19, 2016 127
Branding the Admin Console
You can add a logo to the Admin Console and change the color of the interface.
Procedure
Procedure
128 Commvault Version 11 Service Pack 4 Early Release - July 19, 2016
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
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.
Procedure
Commvault Version 11 Service Pack 4 Early Release - July 19, 2016 129
4. Click Save.
Result
130 Commvault Version 11 Service Pack 4 Early Release - July 19, 2016
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].
Commvault Version 11 Service Pack 4 Early Release - July 19, 2016 131
Creating the SAP HANA Parameter File - 95
Index
Creating VM Filters - 38
D
A Database Agents - 5, 71
Devices - 58
Accessing the Admin Console - 21, 26, 27, 55, 56, Download Center - 18, 61
75, 91 Download Details Page - 69
Accessing the Download Center - 62, 63, 64, 65
Adding a Collection - 28, 35 E
Adding a Company - 108 Early Release - 131
Adding a Mount Path - 118
Editing Collection Options - 36, 40
Adding a Package - 62, 63, 64
Editing Plans for a Company - 109
Adding a Repository - 62, 63, 64
Editing Server Information - 34
Adding a SAP HANA Instance to a SAP HANA Endpoint - 5, 55
System - 91, 98
Adding a SAP HANA System - 91, 97, 98 G
Adding a Server - 27, 31
Adding Domains - 124 Getting Started with Admin Console - 10, 15, 26
Administering Schedules - 75, 79, 82, 91, 94 Getting Started with the Endpoint Application - 16,
Administrating the Security Associations of a Server - 55
62, 126 Getting Started with the Oracle Admin Console - 21,
Alert Information - 112 75
Alerts - 110 Getting Started with the SAP HANA Admin Console
Applying a License - 127 - 5, 91
Attaching a Disk to an Existing VM for VMware - 48
I
B Installation - 6
Backups - 26, 28, 44 Installing the Commvault Edge Server Package - 6,
Branding the Admin Console - 128 16, 55
Installing the Commvault Express Package - 6, 20,
C 75, 91
Installing the End-User Endpoint Package on a Mac
Cloning an Oracle Database - 78, 87 Operating System - 19
Cloud Provider Information - 119 Installing the End-User Endpoint Package on a
Collections - 35 Windows Operating System - 18
Companies - 108
Installing the Stand-Alone Admin Console Package -
Configuration for Virtualization - 28
6, 9, 26, 55, 75, 91
Configuring a Cloud Library as a Storage Target -
Installing the Virtual Server Protection Package - 6,
118 15, 26
Configuring a Disk Library as a Storage Target - 117 Introduction to the Admin Console - 5
Configuring an Email Server - 27, 129
Introduction to the Admin Console for Oracle
Controlling Activities - 113
Databases - 73
Controlling Jobs - 113
Introduction to the Admin Console for SAP HANA
Creating a Custom End-User Endpoint Package - 16, Databases - 89
17, 55, 56 Inviting Users and User Groups to Install the End-
Creating a Laptop Plan - 56, 57, 58, 106 User Endpoint Package - 57
Creating a Server Plan - 28, 105
Creating a User - 122 J
Creating a User Group - 122, 123
Creating an Alert Definition - 110 Job Information - 112, 115
Creating an Operation Window Rule - 129 Jobs - 59, 60, 77, 78, 79, 84, 86, 88, 92, 93, 102, 103,
Creating Disk Filters - 39 112
Creating Global Exceptions - 128
Creating the SAP HANA HDBUSERSTORE KEY -
M
94, 97 Managing Alerts - 75, 91, 110
Commvault Version 11 Service Pack 4 Early Release - July 19, 2016 133
Managing Collection Content - 36 System Requirements for the Admin Console - 7, 11,
Managing Oracle Database Instances - 75, 77, 78, 79, 15, 16, 20
81, 93 System Settings - 127
Managing Oracle Subclients - 75, 78, 80, 81
Managing Packages - 65 T
Managing Proxies - 42 Tracking the Location of a Device - 60
Managing Repositories - 64
Managing Roles - 62, 125 U
Managing SAP HANA Backup Schedules - 96
Managing SAP HANA Subclients - 91, 93, 94, 100 User Security Settings - 122
Managing Schedules - 42, 44 Users and User Groups - 122
Managing User Group Membership - 124 Using the Setup Wizard for the Endpoint Application
Managing User Groups - 123 - 55, 56
Managing Users - 123 Using the Setup Wizard for the Virtualization
Manually Performing a Backup - 55, 58, 59 Application - 26, 27, 28, 32
Monitoring - 110 V
O Viewing Events - 112
Oracle Backups - 83 Viewing Jobs - 113
Oracle Configuration - 77 Viewing Server and Collection Details - 32
Oracle Restores - 85 Viewing Virtual Machine Information - 53
Virtual Server Agent (VSA) - 23
P Virtualization - 5, 22, 23
VSA System Requirements - 24
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
134 Commvault Version 11 Service Pack 4 Early Release - July 19, 2016
©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.