CTERA Portal Administrator Guide Datacenter Edition PDF

Download as pdf or txt
Download as pdf or txt
You are on page 1of 430

Administrator Guide

CTERA Portal
Datacenter Edition
November 2013
Version 4.0

Copyright 2009-2013 CTERA Networks Ltd.


All rights reserved. No part of this document may be reproduced in any form or by any
means without written permission from CTERA Networks Ltd.
Information in this document is subject to change without notice and does not represent a
commitment on part of CTERA Networks Ltd.
CTERA, C200, C400, C800, P1200, CloudPlug, NEXT3, Cloud Attached Storage, and Virtual
Cloud Drive are trademarks, service marks, or registered trademarks of CTERA Networks Ltd.
All other product names mentioned herein are trademarks or registered trademarks of their
respective owners.
The products described in this document are protected by U.S. patents, foreign patents, or
pending applications.
Tip

For legal information and for the end user license agreement, refer to Legal
Information (on page 407) in this guide.

Contents
Introduction---------------------------------------------------------------------------------------------- 1
About the CTERA Portal --------------------------------------------------------------------------------- 2
CTERA Provisioning------------------------------------------------------------------------------------- 10
About This Guide --------------------------------------------------------------------------------------- 12
Contacting Technical Support ----------------------------------------------------------------------- 12

Getting Started ---------------------------------------------------------------------------------------- 13


Browser Requirements -------------------------------------------------------------------------------- 13
Logging in to the CTERA Portal ---------------------------------------------------------------------- 14
Using the CTERA Portal-------------------------------------------------------------------------------- 19
The Navigation Pane ----------------------------------------------------------------------------------- 20
The Main Frame ---------------------------------------------------------------------------------------- 20
The Status Bar ------------------------------------------------------------------------------------------- 23
Navigating between Virtual Portals ---------------------------------------------------------------- 23
Accessing the Global Administration View ------------------------------------------------------- 23
Accessing Online Help --------------------------------------------------------------------------------- 24
Logging Out ---------------------------------------------------------------------------------------------- 24

Configuring Global Virtual Portal Settings ----------------------------------------------------- 25


Configuring Default Settings for Virtual-Portals ------------------------------------------------ 25
Managing the CTERA Portal License --------------------------------------------------------------- 34
Branding the CTERA Portal --------------------------------------------------------------------------- 39
Configuring Global Settings -------------------------------------------------------------------------- 43
Configuring Global Mail Server Settings ---------------------------------------------------------- 45
Managing Certificates --------------------------------------------------------------------------------- 47
Customizing Global Email Notification Templates---------------------------------------------- 60

Configuring Virtual Portals ------------------------------------------------------------------------- 67


Overriding the Global Virtual Portal Settings ---------------------------------------------------- 67
Overriding Global Branding Settings --------------------------------------------------------------- 68

Managing User Accounts --------------------------------------------------------------------------- 73


Accessing the User Account Manager ------------------------------------------------------------- 74
Adding and Editing User Accounts ----------------------------------------------------------------- 75
Viewing User Accounts -------------------------------------------------------------------------------- 77

Contents

Configuring Group Membership for User Accounts ------------------------------------------- 80


Provisioning User Accounts in Reseller Portals-------------------------------------------------- 81
Provisioning User Accounts in Team Portals ----------------------------------------------------- 85
Managing Devices for User Accounts-------------------------------------------------------------- 87
Managing Folder Groups for User Accounts ----------------------------------------------------- 88
Configuring User Accounts' Advanced Settings ------------------------------------------------- 89
Managing Projects Owned by User Accounts --------------------------------------------------- 92
Configuring User Alerts ------------------------------------------------------------------------------- 93
Viewing User Account Details ----------------------------------------------------------------------- 95
Generating Monthly Reports ------------------------------------------------------------------------ 96
Enabling/Disabling User Accounts------------------------------------------------------------------ 97
Exporting User Accounts to Excel------------------------------------------------------------------- 97
Applying Provisioning Changes---------------------------------------------------------------------- 98
Deleting User Accounts ------------------------------------------------------------------------------- 99
Using Directory Services ------------------------------------------------------------------------------ 99
Managing User Groups ------------------------------------------------------------------------------- 113

Managing Administrators ------------------------------------------------------------------------- 119


Accessing the Staff Administrator Manager ---------------------------------------------------- 120
Adding and Editing Staff Administrators --------------------------------------------------------- 121
Configuring Staff Administrator Alerts ----------------------------------------------------------- 122
Viewing Staff Administrators ----------------------------------------------------------------------- 124
Importing Staff Administrators from a File ------------------------------------------------------ 124
Deleting Staff Administrators----------------------------------------------------------------------- 125
Accessing the Global Administrator Manager -------------------------------------------------- 126
Adding and Editing Global Administrators ------------------------------------------------------ 127
Configuring Global Administrator Alerts --------------------------------------------------------- 128
Viewing Global Administrators --------------------------------------------------------------------- 128
Deleting Global Administrators -------------------------------------------------------------------- 129
Configuring an IP-Based Access Control List ---------------------------------------------------- 129
Importing Global Administrators from a File --------------------------------------------------- 131
Customizing Administrator Roles ------------------------------------------------------------------ 132

Managing Device Configuration Templates -------------------------------------------------- 137


Accessing the Configuration Template Manager ---------------------------------------------- 138
Adding and Editing Device Configuration Templates ----------------------------------------- 139
Viewing Device Configuration Templates ------------------------------------------------------- 140
Working with Backup Sets--------------------------------------------------------------------------- 140
Selecting Applications for Backup ----------------------------------------------------------------- 152
Scheduling Automatic Cloud Backup ------------------------------------------------------------- 153
Restricting Throughput------------------------------------------------------------------------------- 155

Contents

Selecting CTERA Portal Cloud Folders for Synchronization---------------------------------- 157


Marking a Firmware Image as the Current Firmware Image ------------------------------- 158
Configuring Automatic Firmware Updates ------------------------------------------------------ 159
Configuring the Automatic Template Assignment Policy ------------------------------------ 160
Setting the Default Device Configuration Template ------------------------------------------ 163
Duplicating Configuration Templates------------------------------------------------------------- 164
Deleting Device Configuration Templates ------------------------------------------------------- 164

Managing Devices ----------------------------------------------------------------------------------- 167


Accessing the Device Manager --------------------------------------------------------------------- 168
Editing Device Settings ------------------------------------------------------------------------------- 169
Viewing Devices ---------------------------------------------------------------------------------------- 171
Remotely Managing Devices and Their Files ---------------------------------------------------- 180
Remotely Performing Cloud Backup Operations on Devices ------------------------------- 180
Exporting Devices to Excel -------------------------------------------------------------------------- 182
Deleting Devices --------------------------------------------------------------------------------------- 182

Managing Folders and Folder Groups ---------------------------------------------------------- 185


Accessing the Folder Manager --------------------------------------------------------------------- 187
Adding and Editing Folders -------------------------------------------------------------------------- 188
Viewing Folders ---------------------------------------------------------------------------------------- 189
Managing Folder Contents -------------------------------------------------------------------------- 193
Changing Passphrases for Accessing Backup Folder Contents ----------------------------- 201
Exporting Folders to Excel --------------------------------------------------------------------------- 202
Deleting Folders---------------------------------------------------------------------------------------- 202
Accessing the Folder Group Manager ------------------------------------------------------------ 203
Adding and Editing Folder Groups----------------------------------------------------------------- 204
Viewing Folder Groups ------------------------------------------------------------------------------- 207
Managing Home Folders for Folder Groups ---------------------------------------------------- 207
Managing Backup Folders for Folder Groups --------------------------------------------------- 208
Changing Passphrases for Accessing Folder Group Contents ------------------------------- 209
Exporting Folder Groups to Excel ------------------------------------------------------------------ 210
Deleting Folder Groups ------------------------------------------------------------------------------ 210

Managing Collaboration Projects---------------------------------------------------------------- 211


Enabling Project Collaboration for the Virtual Portal ----------------------------------------- 211
Defining Project Management Permissions----------------------------------------------------- 212
Adding Collaboration Projects ---------------------------------------------------------------------- 214
Editing Collaboration Projects ---------------------------------------------------------------------- 218
Viewing Collaboration Project Contents --------------------------------------------------------- 220
Exporting a List of Collaboration Projects to Excel -------------------------------------------- 221

Contents

Deleting Collaboration Projects -------------------------------------------------------------------- 221

Managing Subscription Plans --------------------------------------------------------------------- 223


Understanding Snapshot Retention Policies ---------------------------------------------------- 224
Adding and Editing Subscription Plans ----------------------------------------------------------- 228
Viewing Subscription Plans-------------------------------------------------------------------------- 234
Setting/Removing the Default Subscription Plan ---------------------------------------------- 236
Exporting Subscription Plans to Excel ------------------------------------------------------------ 236
Applying Provisioning Changes--------------------------------------------------------------------- 236
Deleting Subscription Plans ------------------------------------------------------------------------- 237

Managing Add-ons ---------------------------------------------------------------------------------- 239


Adding and Editing Add-ons ------------------------------------------------------------------------ 239
Viewing Add-ons --------------------------------------------------------------------------------------- 244
Exporting Add-ons to Excel-------------------------------------------------------------------------- 244
Applying Provisioning Changes--------------------------------------------------------------------- 245
Deleting Add-ons -------------------------------------------------------------------------------------- 245

Managing Vouchers --------------------------------------------------------------------------------- 247


Adding Vouchers--------------------------------------------------------------------------------------- 248
Viewing Vouchers ------------------------------------------------------------------------------------- 249
Sending Vouchers by Email ------------------------------------------------------------------------- 250
Exporting Vouchers to Excel ------------------------------------------------------------------------ 251
Deleting Vouchers ------------------------------------------------------------------------------------- 251

Managing Email Invitations ----------------------------------------------------------------------- 253


Configuring Email Invitation Settings ------------------------------------------------------------- 254
Viewing Active Email Invitations ------------------------------------------------------------------- 255
Deleting Active Email Invitations ------------------------------------------------------------------ 255

Managing Virtual Portals -------------------------------------------------------------------------- 257


Accessing the Virtual Portal Manager ------------------------------------------------------------ 258
Adding and Editing Virtual Portals----------------------------------------------------------------- 259
Viewing Virtual Portals ------------------------------------------------------------------------------- 260
Assigning Virtual Portals to Global Plans -------------------------------------------------------- 262
Adding Global Add-ons to Virtual Portals ------------------------------------------------------- 263
Exporting Virtual Portals to Excel ------------------------------------------------------------------ 265
Deleting Virtual Portals ------------------------------------------------------------------------------ 265

Managing Servers ----------------------------------------------------------------------------------- 267


Accessing the Server Manager --------------------------------------------------------------------- 268

Contents

Editing Server General Settings -------------------------------------------------------------------- 269


Configuring a Server as a Catalog Node ---------------------------------------------------------- 271
Editing Server SMTP Settings ----------------------------------------------------------------------- 271
Viewing Connected Devices------------------------------------------------------------------------- 273
Monitoring Server Activity -------------------------------------------------------------------------- 275
Viewing Server Tasks --------------------------------------------------------------------------------- 276
Viewing Servers' Statuses --------------------------------------------------------------------------- 279
Restarting Servers ------------------------------------------------------------------------------------- 280

Managing Firmware Images ---------------------------------------------------------------------- 281


Uploading Firmware Images ------------------------------------------------------------------------ 282
Viewing Firmware Images --------------------------------------------------------------------------- 283
Marking a Firmware Image as the Current Firmware Image ------------------------------- 283
Deleting Firmware Images -------------------------------------------------------------------------- 284
Viewing Devices that Use a Specific Firmware Image ---------------------------------------- 284

Managing Storage Nodes -------------------------------------------------------------------------- 287


Adding and Editing Storage Nodes ---------------------------------------------------------------- 287
Viewing Storage Nodes ------------------------------------------------------------------------------ 317
Deleting Storage Nodes ------------------------------------------------------------------------------ 318

Importing and Exporting Folders (Seeding) --------------------------------------------------- 321


Importing Folders Over NFS------------------------------------------------------------------------- 321
Exporting Folders -------------------------------------------------------------------------------------- 334

Monitoring the CTERA Portal --------------------------------------------------------------------- 337


Viewing the Status Dashboard --------------------------------------------------------------------- 337
Viewing Reports --------------------------------------------------------------------------------------- 341
Configuring Logging ----------------------------------------------------------------------------------- 356
Viewing Logs -------------------------------------------------------------------------------------------- 359
Clearing Logs -------------------------------------------------------------------------------------------- 375
Using CTERA Portal Email Notifications ---------------------------------------------------------- 375
Using Email Alerts ------------------------------------------------------------------------------------- 382

Recovering CTERA Appliances after Hard Drive Failures ---------------------------------- 387


Recovering from Hard Drive Failures ------------------------------------------------------------- 388
Recovering from Appliance Failures -------------------------------------------------------------- 392
Recovering from Total Loss of an Appliance ---------------------------------------------------- 398

Legal Information ------------------------------------------------------------------------------------ 407


CTERA End User License Agreement -------------------------------------------------------------- 407

Contents

GNU GENERAL PUBLIC LICENSE -------------------------------------------------------------------- 411


Apache License ----------------------------------------------------------------------------------------- 414

Index ---------------------------------------------------------------------------------------------------- 417

1
Introduction
This chapter introduces the CTERA Portal and this guide.

In This Chapter
About the CTERA Portal --------------------------------------------------------------------------------------------- 2
CTERA Provisioning ------------------------------------------------------------------------------------------------- 10
About This Guide --------------------------------------------------------------------------------------------------- 12
Contacting Technical Support ----------------------------------------------------------------------------------- 12

CTERA Portal Datacenter Edition Administrator Guide

Introduction

About the CTERA Portal


CTERA Portal DataCenter Edition is a scalable cloud service delivery platform that you install
at your own datacenter and use to create, deliver and manage cloud storage applications,
including file sharing and sync, backup, and mobile collaboration. CTERA Portal is compatible
with cloud storage infrastructure from multiple vendors, including EMC, HDS, IBM and AWS.
CTERA Portal DataCenter Edition enables you to extend cloud services to remote sites and
mobile users, via CTERA appliances, CTERA Agents, and CTERA Mobile. The portal ensures
data consistency, maintains version history and facilitates file sharing amongst users,
regardless of their access method.
CTERA employs both global source-based de-duplication and data compression. This ensures
that only incremental data changes are transferred for storage in the cloud, and that data
blocks are stored only once, which dramatically reduces storage capacity needs and overall
network traffic.
CTERA Portal DataCenter Edition enables you to create one or more tenants, called Virtual
Portals, on a single set of physical servers. Virtual Portals are accessed by end users and
management staff via web-based interfaces.
CTERA Appliances and end-point agents are remotely managed with CTERA Portal using a
single web-based console. Template-based management, centralized monitoring, customized
alerting and remote software and firmware upgrade capabilities make it easy to manage
appliances of various types and sizes as well as individual end-point agents up to tens of
thousands of connected devices with no need for on-site IT presence in remote locations.

CTERA Portal Datacenter Edition Administrator Guide

Introduction

Management Features
With the CTERA Portal, you control all aspects of Cloud Attached Storage, including:
Service Provisioning
Create customer subscription plans that include cloud storage volume, pricing, number of
devices per account, user self-provisioning, and time limits. Add-ons can be used to
supplement existing accounts with additional services, and vouchers allow the creation of
one-off promotions and pre-paid subscription plans.
User Management
Manage anywhere from tens to tens of thousands of subscribers. Control user access,
subscription plans, and add-ons per user account, and view real-time storage usage and
account status.
Remote Device Management and Monitoring
Manage CTERA appliances and agents remotely. This enables you to view the appliance
status in detail, including logged events, network status, storage volumes, and recent
backups, as well as to set firmware upgrades, associated backup folders, and more.
Real-Time Event Monitoring
Centrally monitor and audit all events pertaining to the cloud service.
Reporting
Run and export detailed reports on a variety of usage parameters, including storage
usage, bad files, snapshot status, and more. Generate user reports that are automatically
emailed as PDF attachments.
Private Branding
Brand all aspects of the end-user experience, customizing it to your own corporate
identity. This includes the CTERA Portal user interface and all automated email
notifications.

Virtual Portals
Installed at the CTERA Portal owners datacenter, the CTERA Portal Datacenter Edition allows
a CTERA Portal owner to create one or more virtual CTERA Portals on a single set of physical
servers.
The following types of virtual portal are supported:
Reseller portal

CTERA Portal Datacenter Edition Administrator Guide

Introduction

Designed for the needs of a reseller, this type of portal includes support for
reseller-oriented features such as add-ons, plans, vouchers, and self-registration. The end
users in the portal are the reseller's subscribers.
Reseller portals are managed by staff administrators in the Staff Control Panel. For
information on the Staff Control Panel, see CTERA Portal Interfaces and Users (on page
7).
By default, each user uses a private folder group, enabling cooperative de-duplication
between all devices owned by the user. Furthermore, when the cloud drive feature is
used, each user receives a private cloud drive that is not accessible to other users.
When multiple reseller portals are created, the CTERA Portal owner can rent each portal
to a different reseller, as part of a multi-tenant or hierarchical business model. Each
reseller can log in to their own virtual portal, manage their subscribers, and define
subscription plans, branding, and pricing models. In contrast, the CTERA Portal owner can
access and manage the contents of any reseller portal, as well as manage global settings
across all virtual portals.
Team portal
This type of portal is designed for the needs of a company or team with multiple
members, and as such do not include support for reseller-oriented features. The users in
the portal are the team members.
Team portals are managed by team administrators, who are team members with the
"Administrator role. These users can manage their team portal via the Administration
tab in their End User Portal. For information on the End User Portal, see CTERA Portal
Interfaces and Users (on page 7).
All users in the team portal share, by default, a single folder group, enabling cooperative
de-duplication between all members of the group. Furthermore, when the cloud drive
feature is used, each user receives a private home folder, as well as access to a public
folder that is visible to all the users in the portal. Users can create projects to collaborate
with other team members.
When multiple team portals are created, the CTERA Portal owner can assign each team
portal to a different organizational unit within the company or team. Each organizational
unit can log in to their own virtual portal and manage their settings. In contrast, the
CTERA Portal owner can access and manage the contents of any team portal, as well as
manage global settings across all virtual portals.

CTERA Portal Datacenter Edition Administrator Guide

Introduction

Both reseller portals and team portals can be defined within a single CTERA Portal
installation.
Tip

The CTERA Portal is also available in the SaaS Edition. Run by CTERA as a cloud
service, the SaaS Edition allows CTERA Portal owners to offer managed cloud
services, with no upfront investment. For further information, contact CTERA
support.

Storage Clients
As part of the CTERA Cloud Attached Storage architecture, CTERA Portal can deliver cloud
services to desktop, server, and mobile endpoints and to on-premises storage hardware.
CTERA Portal connects to the following storage clients:
CTERA Appliances (on page 5)
CTERA Agents (on page 6)
CTERA Mobile (on page 6)
Throughout this guide, the term "device" refers generically to CTERA Appliances and CTERA
Agents.

CTERA Appliances
CTERA's cloud storage gateways are hybrid appliances that seamlessly combine local storage,
cloud storage, data protection functionality and collaboration capabilities in a single,
cost-effective package. Ideal for SMBs as well as enterprise branches and remote offices,
CTERA's appliances can replace legacy file servers and tape backup in a single solution with
significant cost savings.
The appliances feature a full set of Network Attached Storage (NAS) capabilities and
comprehensive backup functionality, utilizing on-premises storage capabilities for speed and
local sharing, while taking advantage of cloud storage for off-site backup, universal access,
file sharing, and folder synchronization.
CTERA cloud storage gateways are managed remotely by CTERA Portal. Template-based
management and remote firmware upgrades make it possible to manage numerous
appliances while maintaining minimal on-site IT and reducing total cost of ownership.

CTERA Portal Datacenter Edition Administrator Guide

Introduction

CTERA Agents
CTERA Agents are small-footprint software agents that perform both cloud backup and file
sync (FSS) functions. CTERA Agents can connect either directly to the cloud or to a CTERA
hybrid cloud gateway appliance.
CTERA Agents are available for Windows, Linux and Mac platforms, and are licensed for
either laptop/desktop use or for servers. In all cases they provide sync and backup
capabilities, supporting both file backup and disk-level ("bare metal") backup.
CTERA Agents can be managed remotely by CTERA Portal, where all aspects of backup, sync
and agent setup can be monitored and configured from a single console, including software
upgrades.

CTERA Mobile
CTERA Mobile for iOS and Android enables business users to access their files securely, view
them, edit them, and store them in the cloud where they can be shared with colleagues,
partners and customers.
Users can also easily upload files, such as photos and documents, from their mobile device to
their cloud drives.
CTERA Mobile works in tandem with CTERA Portal to provide access to private folders and
team project workspaces, as well as the ability to view and download backup files.

CTERA Portal Datacenter Edition Administrator Guide

Introduction

CTERA Portal Interfaces and Users


The CTERA Portal Datacenter Edition includes the following interfaces:
The End User Portal
This interface is used by end users to manage their devices, backup files, and access
cloud-stored files. End User Portal users are called end users.

CTERA Portal Datacenter Edition Administrator Guide

Introduction

When accessed by team administrators, the End User Portal includes an Administration
tab with controls for managing the contents and settings of the team portal, instead of
the My Account tab.

The Staff Control Panel (available in reseller portals only)


This interface is used by a virtual portal owner's staff to manage the contents and settings
of the reseller portal. Staff Control Panel users are called staff administrators.
Only reseller portals have staff administrators and the Staff Control Panel.

CTERA Portal Datacenter Edition Administrator Guide

Introduction

The Administration Control Panel


This interface is used by a CTERA Portal owner's staff to manage the contents and settings
of all virtual portals in the system.
Administration Control Panel users are called global administrators.

This interface also includes the Global Administration View, a special sub-interface for
managing global settings shared by all the defined virtual portals.

CTERA Portal Datacenter Edition Administrator Guide

Introduction

Tip

It is possible to limit a user or administrator's permissions, so that they cannot


modify some or all of the settings in the relevant interface.

CTERA Provisioning
Provisioning is the process of assigning services and quotas to users or tenants.
CTERA includes two levels of provisioning:
Portal-level provisioning
The CTERA Portal owner provisions each virtual portal owner with services and/or quotas.
For example, it is possible to limit a virtual portal to use a total of up to 100GB of storage
space and 50 workstation agents.
Portal-level provisioning is performed by global administrators in the Global
Administration View.
End-user provisioning
The virtual portal owner provisions end users with services and/or quotas, such as
storage space, number of agents, and more.
In reseller portals, end-user provisioning is performed by staff administrators in the Staff
Control Panel or by global administrators in the Administration Control Panel.
In team portals, end-user provisioning is optional and can be performed by team
administrators in the Administration tab of the End User Portal, or by global
administrators in the Administration Control Panel.

Portal-level Provisioning
The following provisioning methods are available for portal-level provisioning:
Global plans
In order to obtain services, virtual portals are assigned to a global plan which defines a
set of services that the portal will receive, and which will subsequently be used by the
portal's end users. Further, the plan can specify a maximum snapshot retention policy for
the portal (see Understanding Snapshot Retention Policies (on page 224)).

10

CTERA Portal Datacenter Edition Administrator Guide

Introduction

Tip

For reseller portals, the global plan limits the total amount of storage space (and
other resources, such as server agents and workstation agents) allocated to a
reseller portal's end users. That is, if a reseller provisions a 10GB storage quota
to an end user, then 10GB of the reseller's storage space quota is consumed
immediately, regardless of whether the end user actually uses the entire 10GB of
storage space. Likewise, Portal Licenses are consumed when the resources are
provisioned to the end user.
For team portals, the global plan limits the total amount of resources used by
end users. Portal Licenses are consumed immediately, when the team portal is
provisioned.
Global add-ons
In addition to the global plan, one or more "global add-ons" can be added to portals. Each
global add-on defines a set of services that portals will receive in addition to the services
specified in the global plan. For example, an add-on may include an additional 10 GB of
storage space for the number of devices specified in the global plan. Add-ons can be set
to expire after a specified time period and can be stacked as desired. For example, a
portal may have a subscription plan for 100 GB of storage, as well as two add-ons for
10GB of storage and one add-on for 5GB of storage. While the add-ons are valid, the
portal will be entitled to allocate up to 125GB of cloud storage to end users.

End-user Provisioning (Reseller Portals)


User accounts need to be provisioned in order for end users to obtain services. This is done
by setting the subscription plan, or adding add-ons to the user account.
If a subscription plan or add-on is modified, all user accounts assigned to the plan or add-on is
automatically updated with the changes.
The following provisioning methods are available end-user provisioning in reseller portals:
Subscription plans
In order to obtain services, end users can be subscribed to a subscription plan. The
subscription plan includes the list of services provided to the user and the quota for each
service.
The subscription plan also specifies a snapshot retention policy for the user's folders (see
Understanding Snapshot Retention Policies (on page 224)).
Add-ons
In reseller portals, end users can subscribe to more services in addition to their
subscription plan, by adding add-ons to the account. Each add-on defines a set of services
that subscribed users will receive in addition to the services specified in the subscription
plan. For example, an add-on may include an additional 10 GB of storage space for the
number of devices specified in the subscription plan.

CTERA Portal Datacenter Edition Administrator Guide

11

Introduction

Add-ons can be stacked as desired. For example, a user may have a subscription plan for
100 GB of storage, as well as two add-ons for 10GB of storage and one add-on for 5GB of
storage. While the add-ons are valid, the user will be entitled to 125GB of cloud storage.
Vouchers
A reseller portal allows creating vouchers, which are prepaid coupons that encapsulate
specific add-ons and plans. When a device owner redeems a voucher encoding an add-on,
the add-on is added to the users account. When a device owner redeems a voucher
encoding a plan, they are assigned to the subscription plan.
Tip

Vouchers can also contain a hidden plan that is not exposed to end users.
CTERA Portal allows you to mix and match these provisioning methods in order to obtain the
combination that best suits your company's business model and your customer's needs.

End-user Provisioning (Team Portals)


In Team portals, end users must be subscribed to a subscription plan in order to obtain
services. The subscription plan includes the list of services provided to the user and the quota
for each service. Whereas in reseller portals a quota must be specified for each service, in
Team portals, specific quotas can be unlimited, in which case the user account will only be
limited by the quotas of the team portal itself.

About This Guide


This guide explains how to use the CTERA Portal Datacenter Edition. The procedures it
contains are intended for both staff and global administrators, except where otherwise
noted.

Contacting Technical Support


If you require assistance in configuring or using your CTERA Portal, contact technical support
(http://www.ctera.com/support).

12

CTERA Portal Datacenter Edition Administrator Guide

2
Getting Started
This chapter contains all the information you need in order to get started using the CTERA
Portal.

In This Chapter
Browser Requirements -------------------------------------------------------------------------------------------- 13
Logging in to the CTERA Portal ---------------------------------------------------------------------------------- 14
Using the CTERA Portal -------------------------------------------------------------------------------------------- 19
The Navigation Pane ----------------------------------------------------------------------------------------------- 20
The Main Frame----------------------------------------------------------------------------------------------------- 20
The Status Bar ------------------------------------------------------------------------------------------------------- 23
Navigating between Virtual Portals ---------------------------------------------------------------------------- 23
Accessing the Global Administration View ------------------------------------------------------------------- 23
Accessing Online Help --------------------------------------------------------------------------------------------- 24
Logging Out ---------------------------------------------------------------------------------------------------------- 24

Browser Requirements
In order to use the CTERA Portal, you will need the following:
Either Microsoft Internet Explorer 7.0 or later, Mozilla Firefox 3.0 or later, or Google
Chrome 5.0 or later
Adobe Flash Player

CTERA Portal Datacenter Edition Administrator Guide

13

Getting Started

Logging in to the CTERA Portal


Staff administrators are defined within the scope of a single reseller portal, and thus have
access to that portal only. These administrators must log in to the relevant reseller portal via
the Staff Control Panel. See Logging in to the Staff Control Panel (on page 14).
Team administrators are both users and administrators of a single team portal. In the End
User Portal, they can access their personal settings in the My Account tab, as well as
administrative settings in the Administration tab. See Logging in to the End User Portal (on
page 15).
In contrast, global administrators have access to all virtual portals. These administrators may
log in to any virtual portal via the Administration Control Panel. Once logged in, they can
navigate to any other portal. See Logging in to the Administration Control Panel (on page
17).

Logging in to the Staff Control Panel


This task is relevant for reseller portals only.
To log in to the Staff Control Panel
1 Using a Web browser, open http://<PortalDNS>/staff.
Where <PortalDNS> is your CTERA Portal's DNS name. For example, if your portal's DNS
name is "myportal.acme.com", you must open http://myportal.acme.com/staff.
The CTERA Portal opens displaying the Staff Login page.

14

CTERA Portal Datacenter Edition Administrator Guide

Getting Started

2 In the fields provided, type your user name and password.


3 Click Log In.
The Staff Control Panel opens displaying your portal's Main > Dashboard page.

Logging in to the End User Portal


This task is relevant for team portals only.
To log in to the End User Panel
1 Using a Web browser, open http://<PortalDNS>/.
Where <PortalDNS> is your CTERA Portal's DNS name. For example, if your portal's DNS
name is "myportal.acme.com", you must open http://myportal.acme.com/.

CTERA Portal Datacenter Edition Administrator Guide

15

Getting Started

The CTERA Portal opens displaying the Login page.

2 In the fields provided, type your user name and password.


3 Click Log In.
The End User Portal opens. If you are an administrator, the Administration tab is
displayed.

16

CTERA Portal Datacenter Edition Administrator Guide

Getting Started

Logging in to the Administration Control Panel


To log in to the Global Administration View
1 Using a Web browser, open http://global.<PortalSuffix>
Where <PortalSuffix> is the CTERA Portal's DNS suffix.
For example, to log in to the Global Administration View of a portal whose DNS suffix is
"acme.com", you should open http://global.acme.com.
Tip

Alternatively, you can use the IP address of one of the CTERA Portal servers. For
example, to connect to the Global Administration View of a portal whose server
IP address is 192.168.10.10, open http://192.168.10.10. This method
enables you to gain access to the Global Administration View, if the DNS service
is not set up properly.
After connecting, you can switch to any other portal as described in Navigating between
Virtual Portals (on page 23).
The CTERA Portal opens displaying the Administrator Login page.

2 In the fields provided, type your user name and password.


3 Click Log In.

CTERA Portal Datacenter Edition Administrator Guide

17

Getting Started

The Global Administration View opens displaying the Main > Dashboard page.

To log in to the Administration Control Panel for a specific virtual portal


1 Using a Web browser, open http://<PortalAddress>/admin
Where <PortalAddress> is the DNS name of the virtual portal to which you want to
connect.
For example, to connect to a virtual portal whose DNS name is "myportal.acme.com", you
must open http://myportal.acme.com/admin.
After connecting, you can switch to any other portal as described in Navigating between
Virtual Portals (on page 23), or to the Global Administration View as described in
Accessing the Global Administration View (on page 23).
The CTERA Portal opens displaying the Administrator Login page.
2 In the fields provided, type your user name and password.
3 Click Log In.

18

CTERA Portal Datacenter Edition Administrator Guide

Getting Started

The Administration Control Panel opens displaying the Main > Dashboard page.

Using the CTERA Portal


CTERA Portal interfaces consist of the following elements
Navigation pane. Used for navigating between pages in the CTERA Portal.
Main frame. Displays the CTERA Portal pages, each of which contains controls and
information.
Status bar. Displays general and session-specific controls and information.
The following figure displays these elements in the Staff Control Panel:

CTERA Portal Datacenter Edition Administrator Guide

19

Getting Started

The Navigation Pane


The navigation pane includes several menu sections, each of which can be opened to reveal
its contents.
If desired, the navigation pane can be hidden, in order to expand the main frame.

Opening Menu Sections


In order to view the contents of a menu section in the navigation pane, you must open it.
To open a menu section
Do one of the following:
Click on the section's name.
Next to the section's name, click

The section opens, revealing its contents.

The Main Frame


The main frame displays information and controls for the menu section you selected. When
information is displayed in tables, you can sort the table according to a specific column and
choose which columns should appear in the table. In addition, the main frame includes
controls for refreshing its contents and quickly accessing the Home page.

Sorting Tables
You can sort a table according to a specific column, in ascending or descending order.
To sort a table according to a column
1 Click on the desired column's heading.

20

CTERA Portal Datacenter Edition Administrator Guide

Getting Started

The table is sorted according to the column. An arrow in the column's heading indicates
that the table is sorted according to the column. The arrow's direction indicates the sort
order.

In this example, the table is sorted according to the Date column, in ascending order.
2 To reverse the column's sort order, click on the column's heading again.
The sort order is reversed.
3 To select the desired sort order from a list, do the following:
a Mouse-over the column's heading.
An arrow appears in the right side of the column heading.

b Click on the arrow, then click on the desired sort order in the drop-down list.
The column is sorted accordingly.

Navigating between Table Pages


When a table contains multiple pages of data, you can navigate between the pages by using
the controls at the bottom of the screen.
To navigate between pages
Do any of the following:
To navigate to the next page, click
To navigate to the previous page, click

CTERA Portal Datacenter Edition Administrator Guide

.
.

21

Getting Started

To navigate to page 1, click

To navigate to a specific page, in the Page field, type the desired page number.

Searching Tables
If a search box appears above a table, you can search for specific items in the table.
To search for items in a table
1 In the search box at the top-right corner of the main frame, type a string according to
which you want to search.
The CTERA Portal will look in all table columns for items that contain the specified string.
The search is case-insensitive.
For example, searching for "th" in the Users table could return the following results:
JohnSmith, ThomasB, and MatthewJones.
2 If the Search drop-down list appears next to the search box, you can specify the scope of
the search, by doing any of the following:
To limit the search to specific parameters only, click the Search drop-down list, then
select the check boxes next to the desired parameters and clear all other check boxes.
To expand the search to all parameters, click the Search drop-down list, then select
the Select All check box.
3 Click

The search results are displayed.

Refreshing Page Contents


Some of the pages in the main frame contain a button that allows you to refresh the page's
contents.
To refresh a page's contents
At the bottom of the main frame, click

The page's contents are refreshed.

Accessing the Home Page


The main frame contains a shortcut that enables you to quickly access the Home page from
any other page in the CTERA Portal.
To quickly access the Home page
In the top-left corner of the main frame, click

The Home page appears.

22

CTERA Portal Datacenter Edition Administrator Guide

Getting Started

The Status Bar


The status bar includes the following elements:
Your user name
A button for logging out of the CTERA Portal
See Logging Out (on page 24).
A button for accessing online help
The firmware version
A drop-down list for navigating between virtual portals (Administration Control Panel
only)
See Navigating between Virtual Portals (on page 23).

Navigating between Virtual Portals


Global administrators can navigate between virtual portals as needed.
This task can be performed in the Administration Control Panel only.
To navigate between virtual portals
In the status bar, in the Portal drop-down list, select the virtual portal you want to access.
The desired virtual portal's Main > Dashboard page appears.

Accessing the Global Administration View


Global administrators can access to the Global Administration View.
This task can be performed in the Administration Control Panel only.
To access the Global Administration View
In the status bar, in the Portal drop-down list, select Administration.

CTERA Portal Datacenter Edition Administrator Guide

23

Getting Started

The Global Administration View appears displaying the Main > Dashboard page.

Accessing Online Help


To access online help
In the status bar, click Help.

Logging Out
To log out of the CTERA Portal
In the status bar, click Logout.
You are logged out of the CTERA Portal.
Tip

You will be automatically logged out after a period of inactivity.

24

CTERA Portal Datacenter Edition Administrator Guide

3
Configuring Global Virtual Portal
Settings
This chapter explains how to configure global settings. These settings are shared across all
virtual portals.
The tasks in this chapter can be performed in the Global Administration View only.

In This Chapter
Configuring Default Settings for Virtual-Portals------------------------------------------------------------- 25
Managing the CTERA Portal License --------------------------------------------------------------------------- 34
Branding the CTERA Portal --------------------------------------------------------------------------------------- 39
Configuring Global Settings -------------------------------------------------------------------------------------- 43
Configuring Global Mail Server Settings ---------------------------------------------------------------------- 45
Managing Certificates --------------------------------------------------------------------------------------------- 47
Customizing Global Email Notification Templates ---------------------------------------------------------- 60

Configuring Default Settings for Virtual-Portals


You can globally configure the default settings for virtual portals, such as:
Whether end users in reseller portals can open a CTERA Portal account on their own, and
the requirements for doing so
Whether vouchers can be used by end users in reseller portals
Whether the folders of users who have no quota should be automatically deleted after a
period of time
These settings will be inherited by all virtual portals and can be optionally overridden per
virtual portal. For information on overriding these settings on a per-virtual portal basis, see
Overriding Global Portal Settings (see "Overriding the Global Virtual Portal Settings" on
page 67).
This task can be performed in the Global Administration View only.
To configure global virtual portal settings
1 In the navigation pane, click Settings > Virtual Portal Settings.

CTERA Portal Datacenter Edition Administrator Guide

25

Configuring Global Virtual Portal Settings

The Settings > Virtual Portal Settings page appears.

2 Complete the fields using the information in the following table.


3 Click Save.

26

CTERA Portal Datacenter Edition Administrator Guide

Configuring Global Virtual Portal Settings

Table 1: Virtual Portal Settings Fields


In this field...

Do this...

Minimum Password Length

Type the minimum number of characters that must be used in


a CTERA Portal account password.
The default value is 7 characters.

Require password change every

Select this option to require CTERA Portal users to change their


password after a certain number of months, then specify the
desired number of months in the field provided.
When the specified number of months has elapsed, the user's
password will expire, and they will be required to configure a
new password upon their next login.

Support Email

Type the email address to which support requests should be


sent.
This email address will appear in the From field of all email
notifications sent by the CTERA Portal system.

Support URL

Type the URL to which CTERA Portal users should browse for
customer support.
This URL will appear at the bottom screen in the End User
Portal interface, as well as in all email notification templates.

Email Sender's Name

Type the email address that should appear in the From field of
notifications sent to end users and staff by the virtual portals.
For example: "CTERA Customer Service <[email protected]>".

Delete files of zero quota users

Select this option to specify that the storage folders of

after

customers who have no quota (for example, customers with


expired trial accounts) should be deleted automatically after a
certain number of days, then specify the desired number of
days in the field provided.
Enabling this option helps free storage space.
A notification is sent to the customer prior to deletion,
prompting the customer to purchase cloud storage in order to
avoid the scheduled deletion of their files.
Storage folders of over-quota users with a non-zero quota will
not be deleted.
The default value is 14 days.

Reseller Portal Settings

These fields are relevant for reseller portals only.

CTERA Portal Datacenter Edition Administrator Guide

27

Configuring Global Virtual Portal Settings

Allow self-registration

Select this option to allow end users to sign up for a CTERA


Portal account, by surfing to the CTERA Portal and filling in a
form.
If this check box is cleared, the registration form will not appear
in the CTERA Portal, and users will be defined only by an
administrator.
If selected, the Require voucher and Require Email
Confirmation fields are enabled.

Require voucher

Select this option to require end users to supply a valid voucher


code when registering a new CTERA Portal account.

Require email confirmation

Select this option to require end users to confirm their


registration by email, in order for their CTERA Portal account to
be activated.
This is recommended, since it ensures that the user has
entered a valid email address.

Require company

Select this option to require end users to specify their


company, when registering a new CTERA Portal account.

Enable vouchers support

Select this option to enable the use of vouchers in the CTERA


Portal.
If this option is cleared, the Provisioning > Vouchers menu item
will not appear in the navigation pane.
See Managing Vouchers (on page 247).

Team Portal Settings

These fields are relevant for team portals only.

Enable Home Folders

If enabled, a home folder is automatically created for each user


in the team portal.

Enable Projects

If enabled, team portal members can create collaboration


projects.

Default Settings for New Folder


Groups

28

CTERA Portal Datacenter Edition Administrator Guide

Configuring Global Virtual Portal Settings

Use encryption

Select this option to specify that the Encryption check box


should be selected by default in all new folder groups' settings;
that is, data in newly created folder groups will be stored in
encrypted format by default.
If encryption is not needed, and you want to improve
performance, you can disable this option.
Note: This value applies to new folder groups only and cannot
be changed for existing folder groups.
Note: Passphrase protection is only available in encrypted
folders.

Use compression

Select this option to specify that data in newly created folder


groups will be stored in encrypted format by default. The
Compression check box will be selected by default in all new
folder groups' settings.
Clearing this option results in higher performance; however,
more storage space will be used.
Specify the default compression method used by new folder
groups by selecting one of the following from the dropdown
list:
High Compression
High Speed
The default value is High Speed.
Note: This value applies to new folder groups only and cannot
be changed for existing folder groups.

Cloud FS version

Select which cloud storage encoding scheme to use for new


folder groups. In the current version, CloudFS1 is the only
supported cloud storage encoding scheme for folder groups.
Select one of the following:
CloudFS1. Currently, the only supported cloud storage
encoding scheme.
CloudFS2. Experimental and reserved for future use. Do
not use this option without consulting with CTERA Support.
The default value is CloudFS1.

CloudFS1

CTERA Portal Datacenter Edition Administrator Guide

29

Configuring Global Virtual Portal Settings

Average Block Size

Select the average block size used by new folder groups when
cloudFS1 is selected as the default cloud storage encoding
scheme.
The CTERA de-duplication engine splits each stored file into
blocks. Increasing the Average Block Size causes the files to be
split into larger chunks before storage, and results in increased
read/write throughput at the cost of a reduced de-duplication
ratio. Increased block size is useful for workloads that require
high performance, as well as for those that do not gain greatly
from de-duplication (for example, where the stored files consist
mostly of videos, images, and music files that are not
frequently modified).
Decreasing the average block size results in better
de-duplication, since the portal can better identify
finer-grained duplicate data.
Note: Changing this value does not affect existing folder
groups. The new value applies to new folder groups only.
The default value is 512KB.

Average Map File Size

Type the average map file size used by new folder groups when
cloudFS1 is selected as the default cloud storage encoding
scheme.
CTERA Portal uses file maps to keep track of the blocks each file
is made of. The Average Map File Size represents the
maximum size of file that will be represented using a single file
map object. For example, if the average map file size is set to
100MB, files of up to approximately 100 MB will have one file
map, files of up to approximately 200MB will have two file
maps, and so on.
Reducing the average map file size causes more file maps to be
created per file. This may result in smoother and less bursty
streaming of files; however, it will also result in some extra
overhead for creating, indexing, and fetching the additional file
maps.
Note: This value applies to new folder groups only and cannot
be changed for existing folder groups.
The default value is 640000 KB.

30

CTERA Portal Datacenter Edition Administrator Guide

Configuring Global Virtual Portal Settings

Minimum Map File Blocks

Type the minimum number of de-duplication blocks that a file


must contain in order to trigger creation of a mapfile object.
Files with less than this amount will not create a mapfile object,
and instead store the list of blocks directly in the database.
The default value is 4.
Note: For backwards compatibility with firmware versions
earlier than 3.1, set this field's value to 1.

CloudFS2
Average Block Size

Select the average block size used by new folder groups when
cloudFS2 is selected as the default cloud storage encoding
scheme.
The CTERA de-duplication engine splits each stored file into
blocks. Increasing the Average Block Size causes the files to be
split into larger chunks before storage, and results in increased
read/write throughput at the cost of a reduced de-duplication
ratio. Increased block size is useful for workloads that require
high performance, as well as for those that do not gain greatly
from de-duplication (for example, where the stored files consist
mostly of videos, images, and music files that are not
frequently modified).
Decreasing the average block size results in better
de-duplication, since the portal can better identify
finer-grained duplicate data.
Note: Changing this value does not affect existing folder
groups. The new value applies to new folder groups only.
The default value is 512KB.

CTERA Portal Datacenter Edition Administrator Guide

31

Configuring Global Virtual Portal Settings

Average Map File Size

Type the average map file size used by new folder groups when
cloudFS2 is selected as the default cloud storage encoding
scheme.
CTERA Portal uses file maps to keep track of the blocks each file
is made of. The Average Map File Size represents the
maximum size of file that will be represented using a single file
map object. For example, if the average map file size is set to
100MB, files of up to approximately 100 MB will have one file
map, files of up to approximately 200MB will have two file
maps, and so on.
Reducing the average map file size causes more file maps to be
created per file. This may result in smoother and less bursty
streaming of files; however, it will also result in some extra
overhead for creating, indexing, and fetching the additional file
maps.
Note: This value applies to new folder groups only and cannot
be changed for existing folder groups.
The default value is 640000 KB.

Default Settings for New User

Complete these fields for both reseller and team portals.

Interface Language

Select the default language for new users. This language can be
overridden by end users in the End User Portal.
The following languages are supported: English, French,
German, Hebrew, Italian, Polish, and Spanish.

Backup Deduplication Level

Specify the default de-duplication level to use for backup


folders, for all new users. Select one of the following:
User. Create a single folder group for each user account,
containing all of the user account's backup folders.
De-duplication is performed for the user account's folder
group. This is the default value for both reseller and team
portals.
Folder. Create a folder group for each of a user account's
devices, containing all of the device's backup folders.
De-duplication is performed separately for each of the user
account's folder groups.

32

CTERA Portal Datacenter Edition Administrator Guide

Configuring Global Virtual Portal Settings

Cloud Drive Deduplication Level

Specify the default de-duplication level to use for cloud folders,


for all new users. Select one of the following:
User. Create a single folder group for each user account,
containing all of the user account's cloud folders.
De-duplication is performed for the user account's folder
group. This is the default value for reseller portals.
Portal. Create a single folder group for each virtual portal,
containing all of the cloud folders in the portal. This option
is relevant for team portals only. It is the default value for
team portals.
Folder. Create a folder group for each of a user account's
devices, containing all of the device's cloud folders.
De-duplication is performed separately for each of the user
account's folder groups.

Remote Access Settings


Remote Access Redirection

Specify whether Web clients attempting to remotely access a


device should be redirected to communicate directly with the
device, instead of relaying communications through the CTERA
Portal. Select one of the following:
Public IP Redirect. Redirect Web clients to the device's
public IP address.
Private IP Redirect. Redirect Web clients to the device's
private IP address.
No Redirect. Do not redirect communications between
Web clients and the device. Relay all communications
through the CTERA Portal.
The default value is Private IP Redirect.

Use HTTPS for remote access

Select this option to use HTTPS for remotely accessing devices,


using the remote access service.
For example, if a device is named "dev1" and the portal is
names "portal.mycompany.com", then enabling this option will
cause the client's browser to be automatically redirected from
the HTTP URL http://dev1.portal.mycompany.com to the
HTTPS-secured URL
https://portal.mycompany.com/devices/dev1.

CTERA Portal Datacenter Edition Administrator Guide

33

Configuring Global Virtual Portal Settings

Managing the CTERA Portal License


The CTERA Portal license limits the number of CTERA Appliance licenses, CTERA Workstation
Backup licenses, CTERA Server Agent licenses, and Cloud Drive licenses, that can be
provisioned throughout the CTERA Portal.
The CTERA Portal includes a 30-day evaluation license that includes the following:
50 CTERA appliance licenses
10 CTERA Workstation Backup licenses
10 CTERA Server Agent licenses
10 Cloud Drive licenses.
Once this license has expired, or if you require additional licensing, you must install a new
license key.
These tasks can be performed in the Global Administration View only.

How the CTERA Portal License Works


The CTERA Portal license specifies license quotas for each of the following
CTERA Appliance Licenses
This license quota specifies the number of CTERA appliance licenses that can be
provisioned.
CTERA Server Agent Licenses
This license quota specifies the number of CTERA Server Agent licenses that can be
provisioned. A CTERA Server Agent is a CTERA Agent installed on a Windows or Linux
Server.
CTERA Workstation Backup Licenses
This license quota specifies the number of CTERA Workstation Backup licenses that can
be provisioned. A CTERA Workstation Backup allows Cloud Backup of a single desktop or
laptop machine.
Tip

The CTERA Workstation Backup license includes the Cloud Backup Service only.
For file sync and share services, a Cloud Drive license is required.
CTERA Cloud Drive Licenses
This license quota specifies the number Cloud Drive licenses that can be provisioned. Each
CTERA Cloud Drive license allows the enabling of the Cloud Drive service for a single user
account.

34

CTERA Portal Datacenter Edition Administrator Guide

Configuring Global Virtual Portal Settings

This license is subdivided when you allocate quotas to virtual portals, by assigning the virtual
portals to global plans and add-ons. For example, if the CTERA Portal license includes 20
appliance licenses, 20 workstation backup licenses, 20 server agent licenses, and 20 cloud
drive licenses, and there are two virtual portals, you may choose to allocate half of the
appliance, workstation backup, server agent, and cloud drive quotas to each virtual portal. In
this case, each virtual portal will be allocated quotas for 10 appliances, 10 workstation
backups, 10 server agents, and 10 cloud drives.
With each virtual portal, the CTERA Portal license can be further subdivided, when quotas are
allocated to user accounts via plans and add-ons. For example, if a virtual portal is allocated
quotas for 10 appliances, 10 workstation backups, 10 server agents, and 10 cloud drives, and
there are up to ten user accounts, the reseller portal owner may choose to define a plan that
includes quotas for 1 appliance, 1 workstation backup, 1 server agent, and 1 cloud drive.
These quotas are then allocated to the user accounts in the virtual portal. The following
figure shows an example of what a CTERA Portal license might include and how its quotas
might be divided.

How Team Portals and Reseller Portals Differ


Licenses are consumed in team portals and reseller portals in slightly different ways:
In Team Portals: Any licenses provisioned to a specific team portal are immediately
consumed from the Portal License. Within the team portal it is possible to optionally limit
how many licenses or storage each user can consume, by assigning a plan to the user.

CTERA Portal Datacenter Edition Administrator Guide

35

Configuring Global Virtual Portal Settings

In Reseller Portals: It is possible to optionally define a limit on the number of licenses and
amount of storage consumed by each Reseller Portal, by assigning global plans and
add-ons to the portal. However at this stage, no portal licenses are consumed. Portal
licenses are consumed only when specific users within the reseller portal are provisioned
with licenses.

Adding License Keys


This task can be performed in the Global Administration View only.
To add a license key
1 Purchase a new license key from your CTERA authorized reseller, while specifying your
portal's DNS suffix, and the number of required appliance, server agent, and workstation
agent licenses.
You can view your CTERA Portal's DNS suffix, in the Global Administration View's Settings
> DNS page.
You will receive one or more license keys.
2 In the navigation pane, click Settings > License.
The Settings > License page appears.

3 Click Add license key.

36

CTERA Portal Datacenter Edition Administrator Guide

Configuring Global Virtual Portal Settings

The Add License Keys dialog box opens.

4 Copy the license key you received from CTERA, and paste it into the text box.
To add more than one key, paste each key on a new line.
The system verifies and activates the license keys by contacting the CTERA Activation
service. As each license key is activated, it is associated with this installation of CTERA
Portal.
5 (Optional) Add a comment in the Comment field. The comment will be displayed in the
License page. You can use this comment to document the purchase order number
associated with the license, and the like.
6 Click Save.

Removing License Keys


This task can be performed in the Global Administration View only.
To remove a license key
1 In the navigation pane, click Settings > License.
The Settings > License page appears.
2 Select the license key, and then click Remove license key.
A confirmation message appears.
3 Click Yes.
The license key is removed.

CTERA Portal Datacenter Edition Administrator Guide

37

Configuring Global Virtual Portal Settings

Viewing CTERA Portal License Information


This task can be performed in the Global Administration View only.
To view CTERA Portal license information
In the navigation pane, click Settings > License.
The Settings > License page appears with a list of installed license keys. For information
on the fields displayed, see License Key Fields (page 38).
The bottom of the page displays a summary of license usage for all installed keys. For
information on the fields displayed, see License Usage Overview Fields (page 39).
Table 2: License Key Fields
In this field...

Do this...

Key

The license key.

Status

The license key's status. This can be any of the following:


OK. The license is valid.
Expired on date. The license expired on the specified date.
Expires in X days. The license will expire X days from now.

Appliances

The number of CTERA appliance licenses included in the license


key.

You cannot define more than the number of licensed

appliances in the portal.


Server Agents

The number of server agent licenses included in the license key.

Workstation Backups

The number of workstation agent backup licenses included in


the license key. This is the maximum number of workstation
agents running the Cloud Backup service that you can connect
to the portal. Workstation agents using Cloud Drive
synchronization but not using Cloud Backup do not consume
these licenses.

Cloud Drives

The number of cloud drive licenses included in the license key.


Cloud drive licenses are per portal user. There is no limit to the
number of workstation agents that can synchronize to each
user's cloud drive.

Comment

Any comment about the license key that was entered when the
key was added.

38

CTERA Portal Datacenter Edition Administrator Guide

Configuring Global Virtual Portal Settings

Table 3: License Usage Summary Fields


In this field...

Do this...

Installed Licenses

The total number of appliance, server agent, workstation


backup, and cloud drive licenses supported by the installed
license keys.

Usage

The total number of appliance, server agent, workstation


backup, and cloud drive licenses that have been provisioned.

Remaining

The total number of appliance, server agent, workstation


backup, and cloud drive licenses that have not yet been
provisioned.

Exporting License Keys to Excel


You can export the list of installed license keys and their details to a Comma-Separated
Values (*.csv) file on your computer, which you can open in Microsoft Excel.
This task can be performed in the Global Administration View only.
To export license keys
1 In the navigation pane, click Settings > License.
The Settings > License page appears.
2 Click Export to Excel.
The license keys are exported.

Branding the CTERA Portal


You can globally configure default branding settings for all virtual portals, by specifying a
global skin with your company logo and color scheme, as well as a custom Login page.
For information on overriding these settings on a per-virtual portal basis, see Overriding
Global Branding Settings (on page 68).
These tasks can be performed in the Global Administration View only.

Creating Skins
To create a skin
1 Request a basic skin from CTERA support.
2 Extract the ZIP file that you received.
3 Edit the HTML and CSS files as desired.

CTERA Portal Datacenter Edition Administrator Guide

39

Configuring Global Virtual Portal Settings

4 Replace the graphic files as desired.


5 Put the changed files back in the ZIP file.
6 Change the ZIP file's extension to .skin.

Uploading Skins
To upload a global skin
1 In the navigation pane, click Settings > Skins.
The Settings > Skins page appears.

2 Click Upload.
The Skin Upload Wizard appears displaying the Select a file to upload dialog box.

3 Click Upload and browse to the desired *.skin file.

40

CTERA Portal Datacenter Edition Administrator Guide

Configuring Global Virtual Portal Settings

The skin is uploaded.


At the end of the process, the Completing the Skin Upload Wizard screen appears.

4 Click Finish.

Viewing Skins
To view all global skins
In the navigation pane, click Settings > Skins.
The Settings > Skins page appears displaying all skins.
The currently applied global skin is marked with the
virtual portals, expect where locally overridden.

icon. This skin is used on all

The table includes the following columns.


Table 4: Skins Fields
This field...

Displays...

Name

The skin's name.

Custom CSS

Indicates whether the skin includes a custom CSS stylesheet


(Yes/No).

Custom Login Page

Indicates whether the skin includes a custom Login page (Yes/No).

Size

The *.skin file's size.

CTERA Portal Datacenter Edition Administrator Guide

41

Configuring Global Virtual Portal Settings

Applying Skins
When you apply a global skin, it is used as the default skin on all virtual portals.
To apply a global skin to all virtual portals
1 In the navigation pane, click Settings > Skins.
The Settings > Skins page appears.
2 Select the desired skin's row.
3 Click Mark as Current.
The selected skin is applied on all virtual portals in the system, except where locally
overridden. It is marked with the

icon.

Removing the Current Skin Selection


You can remove the current skin selection. This will cause all the virtual portals (for which the
global skin is not overridden) to revert to using the default CTERA Portal branding.
To remove the current skin selection
1 In the navigation pane, click Settings > Skins.
The Settings > Skins page appears.
2 Click Remove Current.
The current skin selection is removed.

Deleting Skins
To delete a global skin
1 In the navigation pane, click Settings > Skins.
The Settings > Skins page appears.
2 Select the desired skin's row.
3 Click Delete.
A confirmation message appears.
4 Click Yes.
The skin is deleted.

42

CTERA Portal Datacenter Edition Administrator Guide

Configuring Global Virtual Portal Settings

Configuring Global Settings


You can configure the DNS suffix that will be appended to each virtual portal's name, in order
to create the virtual portal's DNS name. For example, if a virtual portal's name is "myportal",
and the DNS suffix is "acme.com", then the virtual portal's DNS name will be
"myportal.acme.com".
The DNS name is required in order to connect directly to a virtual portal. For example, in
order to connect directly to a reseller portal whose DNS name is "myportal.acme.com":
An end user must log in at http://myportal.acme.com.
A reseller staff administrator must log in at http://myportal.acme.com/staff.
A global administrator must log in at http://myportal.acme.com/admin. The global
administrator may later switch to a different portal as described in Navigating between
Virtual Portals (on page 23).
If the remote access service is enabled, device users can remotely log in to the device at
http://mydevice.myportal.acme.com.
Tip
If a global administrator connects to the host by IP address and not by DNS name (for
example, http://1.2.3.4/admin), they will be connected to the Global Administration
View. They can then navigate to their virtual portal of choice, as described in Navigating
between Virtual Portals (on page 23).

CTERA Portal Datacenter Edition Administrator Guide

43

Configuring Global Virtual Portal Settings

In addition, you can also configure the CTERA Portal time zone.
These tasks can be performed in the Global Administration View only.
To configure global settings
1 In the navigation pane, click Settings > Global Settings.
The Settings > Global Settings page appears.

2 Complete the fields using the information in the following table.


3 Click Save.
4 If you changed the time zone, restart all the servers in the CTERA Portal cluster, in order
for the change to take effect.
Table 5: Global DNS and Time Zone Settings Fields
In this field...

Do this...

DNS Suffix

Type the global DNS suffix to use for all virtual portals.

Timezone

Select the CTERA Portal's time zone.

System Admin require password

Select this option to require the CTERA Portal administrators to

change every

change their password after a certain number of months, then


specify the desired number of months in the field provided.
When the specified number of months has elapsed, the
administrator's password will expire, and they will be required
to configure a new password upon their next login.

44

CTERA Portal Datacenter Edition Administrator Guide

Configuring Global Virtual Portal Settings

Configuring Global Mail Server Settings


You can configure global mail server settings that will be inherited by all servers. For
information on overriding these settings on a per-server basis, see Editing Server Settings
(see "Editing Server General Settings" on page 269).
This task can be performed in the Global Administration View only.
To configure global mail server settings
1 In the navigation pane, click Settings > Mail Server.
The Settings > Mail Server page appears.ac44538

2 Complete the fields using the information in the following table.


3 Click Save.
4 To validate SMTP mail server settings, click Test Email to send a test email. Verify that you
receive the test mail at the email address defined in your administrator user account.
5 If you changed the SMTP settings, restart the portal servers in order for the changes to
take effect.

CTERA Portal Datacenter Edition Administrator Guide

45

Configuring Global Virtual Portal Settings

Table 6: Mail Server Settings Fields


In this field...

Do this...

Enable Email Sending

Select this option to enable sending email messages from the


CTERA Portal to users.
The SMTP Server, SMTP Port, and Sender Email fields are
enabled.

SMTP Server

Type the outgoing mail server address for sending email


messages from the CTERA Portal to users.

SMTP Port

Type the port number for sending email messages from the
CTERA Portal to users.

Sender Email

Type the email address that should appear in the From field of
notifications sent to global administrators by the global portal.
For example: "CTERA Customer Service <[email protected]>".

Enable TLS

Select this option to use Transport Layer Security (TLS)


encryption for sending email messages from the CTERA Portal
to users.

Server requires authentication

Select this option if the SMTP server requires authentication.


The Username and Password fields are enabled.

Username

Type the user name that the CTERA Portal should use when
authenticating to the SMTP server.

Password

Type the password that the CTERA Portal should use when
authenticating to the SMTP server.

46

CTERA Portal Datacenter Edition Administrator Guide

Configuring Global Virtual Portal Settings

Managing Certificates
Certificates are used as part of the Transport Level Security (TLS) protocol. They enable users'
Web browsers, CTERA appliances, and CTERA Agents to verify that the CTERA Portal server
with which they are communicating is authentic and not spoofed. If the CTERA Portal does
not have a valid certificate installed, CTERA appliances and CTERA Agents will not be able to
connect to it.
You must install an SSL certificate on the CTERA Portal in order to enable devices to connect
to the CTERA Portal, and to prevent a security warning from being displayed when users
attempt to access the CTERA Portal via HTTPS. The certificate must meet the following
requirements:
If multiple virtual portals are configured, then each virtual portal has its own DNS name.
In this case, the SSL certificate should be a wildcard certificate, that is, the DNS name
embedded in the certificate should start with "*". For example, if the CTERA Portal's DNS
name is myportal.com, and there are two virtual portals, portal1.myportal.com and
portal2.myportal.com, you should buy a wildcard certificate for *.myportal.com.
If you have only one portal, and do not intend to configure multiple virtual portals, then it
is sufficient to purchase a regular SSL certificate (not a wildcard certificate). For example,
if your portal's DNS name is portal1.myportal.com, then you can buy a certificate for
portal1.myportal.com.
It is possible to specify multiple alternative names, using the subjectAltName
certificate extension.
The certificate should be in *.zip format and contain certificate files in *.pem format.
You can automatically generate a certificate request to send to any public SSL certificate
authority, such as Godaddy (recommended), Verisign, or Thawte (see Generating a Certificate
Request). Once you have received a certificate from the certificate authority, you must the
install it (see Installing an SSL Certificate (see "Install the Signed Certificate on CTERA Portal"
on page 57)).
Alternatively, you can export a certificate from another portal (see Exporting the Installed
SSL Certificate (on page 59)) and install it on this portal (see Importing an SSL Certificate (on
page 59)).
Tip

When generating a certificate request and installing the received certificate, the
private key is generated on the portal and never leaves it. In contrast, when
exporting and importing certificates, the private key is exported and imported
along with the certificate, and it is therefore important to keep the exported file
confidential.
These tasks can be performed in the Global Administration View only.

CTERA Portal Datacenter Edition Administrator Guide

47

Configuring Global Virtual Portal Settings

Installing an SSL Certificate


Perform the following steps to install a certificate on the CTERA Portal:
1 Note your Portal's DNS Suffix (on page 48)
2 Obtain an SSL Certificate (on page 49)
3 Generate a Certificate Signing Request (on page 51)
4 Sign the Certificate Request (on page 55)
5 Validate and Prepare Certificates for Upload (on page 57)
6 Install the Signed Certificate on CTERA Portal (on page 57)

Note your Portal's DNS Suffix


Note your CTERA Portal's DNS suffix so that you have it for later steps.
To view your portal's DNS suffix
1 In the navigation pane of the Global Administration View, click Settings > Global Settings.
The Settings > Global Settings page appears.

2 The DNS Suffix field displays the CTERA Portal's DNS suffix.

48

CTERA Portal Datacenter Edition Administrator Guide

Configuring Global Virtual Portal Settings

Obtain an SSL Certificate


It is necessary to obtain a valid certificate signed either by a well-known certificate authority,
or by your own internal certificate authority.
Tip

If you intend to generate a signed certificate using your own internal certificate
authority, please contact CTERA Support at http://www.ctera.com/support
beforehand.
The SSL certificate can be either of the following:
A wildcard certificate
A wildcard SSL certificate secures your website's URL and an unlimited number of its
subdomains. For example, a single wildcard certificate for *.ctera.com can secure both
company01.ctera.com and company02.ctera.com.
A wildcard certificate is mandatory if you plan for your service to consist of more than
one virtual portal.

A domain certificate
A domain certificate secures a single domain or subdomain only. For example:
company01.ctera.com.

CTERA Portal Datacenter Edition Administrator Guide

49

Configuring Global Virtual Portal Settings

This option is relevant if you are planning to provision a single virtual portal only.

Tip

To obtain a self-signed certificate for testing and evaluation purposes only,


contact CTERA Support at http://www.ctera.com/support and specify your
CTERA Portal's DNS suffix see Obtain your Portal's DNS Suffix (see "Note your
Portal's DNS Suffix" on page 48)). CTERA will generate a self-signed certificate for
your DNS suffix and provide you with a ZIP file that you can upload to your CTERA
Portal environment.
Tip

The CTERA Portal also supports certificates with Subject Alternative Names (SAN
certificates). This option enables you to secure multiple domain names with a
single certificate.

50

CTERA Portal Datacenter Edition Administrator Guide

Configuring Global Virtual Portal Settings

Generate a Certificate Signing Request


The next step is to generate a certificate signing request (CSR) for your domain using CTERA
Portal. This requires a CTERA Portal Administrator account.
To generate a certificate signing request for your domain
1 In the navigation pane of the Global Administration View, click Settings > SSL Certificate.
The Settings > SSL Certificate page appears.

2 Click Request Certificate.


The Create a Certificate Request Wizard opens.

CTERA Portal Datacenter Edition Administrator Guide

51

Configuring Global Virtual Portal Settings

3 In the Domain Name field, type the domain name for which you would like to request a
certificate.
The value entered must match the type of certificate you chose to use. For example, if
you chose a wildcard certificate, the domain name might be *.acme.com.

In contrast, if you chose a domain certificate, the domain name might be


company01.acme.com, where company01 is the name of your virtual portal.

4 Complete the rest of the fields using the information in the following table.
These fields are optional
5 Click Generate.
A keypair is generated and stored on the portal.

52

CTERA Portal Datacenter Edition Administrator Guide

Configuring Global Virtual Portal Settings

The Download a certificate request screen appears.

6 Click Download.
The certificate request file certificate.req is downloaded to your computer.
The Settings > SSL Certificate page's Certificate Request area indicates that the certificate
request is pending.
If you issued a wildcard certificate request, the area appears as follows:

If you issued a domain certificate request, the area appears as follows:

CTERA Portal Datacenter Edition Administrator Guide

53

Configuring Global Virtual Portal Settings

Warning

When you generated the CSR, a private.key file was registered in the CTERA
Portal. If you now generate a new CSR, it will override the existing private.key
file, and signing the old CSR will result in an error message indicating that the CSR
does not match the private.key file. Therefore, do not generate a new CSR
before installing the signed certificate.
Table 7: Create a Certificate Request Wizard Fields
In this field...

Do this...

Domain Name

Type the domain name for which you would like to request a
certificate.
If multiple virtual portals are configured, each virtual portal has
its own DNS name. In this case, the SSL certificate should be a
wildcard certificate, that is, the DNS name embedded in the
certificate should start with "*".
If you have only one portal, and do not intended to configure
multiple virtual portals, then it is sufficient to purchase a
regular SSL certificate (not a wildcard certificate).
To request a certificate that specifies multiple alternative
names, type the multiple names in this field, separated by
semicolons. The certificate will include the subjectAltName
certificate extension.

Organizational Unit

Type the name of your organizational unit.


This field is optional.

Organization

Type the name of your organization.


This field is optional.

City

Type your city.


This field is optional.

State

Type your state.


This field is optional.

Country

Select your country.


This field is optional.

54

CTERA Portal Datacenter Edition Administrator Guide

Configuring Global Virtual Portal Settings

Sign the Certificate Request


The next step is to sign the certificate request.
To sign the certificate request
1 Send the certificate.req file you generated to your certificate authority for signing.
If the request is successful, the certificate authority will send back an identity certificate
that is digitally signed with the certificate authority's private key.
Tip

The certificate authority should return a base-64 encoded identity certificate.


2 Open the identity certificate and verify that the Issued to field includes the DNS suffix you
provided upon creating the certificate request.

3 Build a certification chain from your identity certificate to your trusted root certificate.
In order to do this, you will need to obtain all of the intermediate certificates, as well as
your root certificate authority's self-signed certificate.
If you are using a well-known certificate authority, the intermediate certificates and the
root certificate authority's self-signed certificate can be downloaded from your certificate
authority website. If you are using your own internal certificate authority, contact the
necessary entity to provide you with the required intermediate and self-signed certificate.

CTERA Portal Datacenter Edition Administrator Guide

55

Configuring Global Virtual Portal Settings

In the above example, the certificate was issued by "Go Daddy Secure Certification
Authority" to "*.ctera.com". In order to build the certification chain, it is necessary to
obtain a certificate issued to "Go Daddy Secure Certification Authority".

This certificate was issued by "Go Daddy Class 2 Certification Authority" to " Go Daddy
Secure Certification Authority". In order to continue the certification chain, it is necessary
to obtain a certificate issued to "Go Daddy Class 2 Certification Authority".

Since this last certificate is a self-signed certificate, (that is, it was issued to and by the
same entity), the certification chain is complete.

56

CTERA Portal Datacenter Edition Administrator Guide

Configuring Global Virtual Portal Settings

Validate and Prepare Certificates for Upload


The next step is to validate and prepare certificates for upload.
To validate and prepare certificates for upload
1 Verify that none of the certificates in the certificate chain are corrupted or using invalid
encoding.
To do so, open each certificate in a program such as Notepad or Word, and verify that it
contains the following:
-------- BEGIN CERTIFICATE ------<CERTIFICATE CONTENT>
-------- END CERTIFICATE -------

2 Change the identity certificate issued to "*.ctera.com" to certificate.crt.


3 Change the file extension of the other certificates in the certificate chain to "crt".
For example, certificate-name.crt.
4 Archive all of the certificates (the identity certificate, the intermediary certificates, and
the root self-signed certificate) in a ZIP file called certificate.zip.
For example:

Install the Signed Certificate on CTERA Portal


Once you have obtained an SSL certificate you must install it on the CTERA Portal. The
certificate must match the pending certificate request and keypair.
To install an SSL certificate
1 In the navigation pane of the Global Administration View, click Settings > SSL Certificate.
The Settings > SSL Certificate page appears.

CTERA Portal Datacenter Edition Administrator Guide

57

Configuring Global Virtual Portal Settings

2 Click Install Signed Certificate.


The Upload Certificate Wizard opens.

3 Click Upload and browse to the the certificate.zip file you created. All the
certificates in the certificate chain must be present in the ZIP file in X.509 format, and
each file must have a ".crt" extension.
The certificate is installed on the CTERA Portal.
4 Click Finish.
5 Restart all the CTERA Portal servers.
See Restarting Servers (on page 280).
6 Verify that the certificate updated successfully, by browsing to your CTERA Portal.
You should receive no security exception messages.

58

CTERA Portal Datacenter Edition Administrator Guide

Configuring Global Virtual Portal Settings

Canceling a Pending Certificate Request


In order to make changes to the current certificate request, you must cancel it as described
below, and then generate a new request as described in Generate a Certificate Signing
Request (on page 51).
To cancel a pending certificate request
1 In the navigation pane, click Settings > SSL Certificate.
The Settings > SSL Certificate page appears.
2 Click Cancel Pending Request.
A confirmation message appears.
3 Click Yes.
The pending certificate request is canceled.

Exporting the Installed SSL Certificate


If desired, you can export the currently installed SSL certificate chain together with the
corresponding private key.
To export the installed SSL certificate
1 In the navigation pane, click Settings > SSL Certificate.
The Settings > SSL Certificate page appears.
2 Click Export.
A ZIP file, including the certificate and private key, is exported.
Warning

This file is security sensitive, and sending it over an insecure link may enable the
server to be compromised.

Importing an SSL Certificate


You can import an SSL certificate from another portal, including the private key.
To import an SSL certificate
1 In the navigation pane, click Settings > SSL Certificate.
The Settings > SSL Certificate page appears.
2 Click Import.

CTERA Portal Datacenter Edition Administrator Guide

59

Configuring Global Virtual Portal Settings

The Import Certificate Wizard opens displaying the Import Certificate dialog box.

3 Click Upload and browse to the ZIP file containing the certificate components.
4 Click Next.
The Completing the Upload Certificate Wizard screen appears.

5 Click Finish.

Customizing Global Email Notification Templates


You can configure email notification templates for the following:
Email notification templates for the global administration portal
These notifications are sent to global administrators.
Default email notification templates for all virtual portals
These notifications are sent to portal administrators and end users.

60

CTERA Portal Datacenter Edition Administrator Guide

Configuring Global Virtual Portal Settings

For information on overriding these settings on a per-portal basis, see Customizing Email
Notification Templates (on page 379).
The email notifications are in HTML format.
This task can be performed in the Global Administration View only.
To customize global email notification templates
1 In the navigation pane, click Settings > Email Templates.
The Settings > Email Templates page appears with a list of email templates. For a
description of each template, see Global Email Notification Templates (page 64).

2 Select the desired email template's row and then click Edit.

CTERA Portal Datacenter Edition Administrator Guide

61

Configuring Global Virtual Portal Settings

The Notification Template Editor opens displaying the Message tab.

If the notification includes a PDF attachment, the Notification Template Editor will
include a PDF tab, as well.
3 Select the Customize Notification Template check box.
4 In the Subject field, type the text that should appear in the notification email's Subject
line.
5 In the Message box, modify the template as desired.
6 To preview your changes, click Preview.
7 To edit a PDF attachment, do the following:
a Click the PDF File tab.

62

CTERA Portal Datacenter Edition Administrator Guide

Configuring Global Virtual Portal Settings

The PDF File tab appears.

b In the PDF box, modify the template as desired.


c To preview your changes, click Preview.
The PDF is downloaded to your computer.
8 To undo your unsaved changes, click Revert.
9 Click Save.

CTERA Portal Datacenter Edition Administrator Guide

63

Configuring Global Virtual Portal Settings

Table 8: CTERA Portal Global Email Notification Templates


In this fields...

Do this...

Portal has reached the license limit A notification sent to global administrators, when one of the
limits specified in the installed CTERA Portal license (that is, the
license installed on the global portal) is reached.
Vouchers issued

A notification sent to end users when a voucher has been


issued to them.

User is over agents limitation

A notification sent to end users when they have exceeded the


licensed number of CTERA Agents. This field is relevant for
reseller portals only.

Storage node full

A notification sent to portal administrators when a storage


node is full.

Storage node nearly full

A notification sent to portal administrators when a storage


node is over 90% full.

Portal license is about to expire

A notification to portal administrators when one of the


portal's license keys will expire in 7 days.

User is over quota limitation

A notification sent to end users when their cloud storage space


is full.

Invoice Notification

A notification sent to end users with an invoice PDF attached.


This template allows customizing both the email message and
the PDF.

Portal is over quota limitation

A notification sent to portal administrators when their cloud


storage space is full.

Addon is about to expire

A notification to end users when an add-on to which they are


subscribed will expire in a certain number of days.
The number of days is configured locally. See Configuring Email
Notifications (on page 376).

Change Email Notification

A notification sent to end users when a request is made to


change their email address.

User is near quota limitation

A notification sent to end users when the amount of cloud


backup storage space used reaches or exceeds a certain
percentage.
The percentage is configured locally. See Configuring Email
Notifications (on page 376).

Password Recovery Notification

A notification sent to end users when a request is made to reset


their password.

64

CTERA Portal Datacenter Edition Administrator Guide

Configuring Global Virtual Portal Settings

Portal is near quota limitation

A notification sent to portal administrators when the amount of


cloud backup storage space used reaches or exceeds 90%.

Device Not Connected

Select this option to send a notification to end users when their


device has not connected to the CTERA Portal for a certain
number of days.
The number of days is configured locally. See Configuring Email
Notifications (on page 376).

User Report

A monthly report sent to end users, which includes the


following information:
Account information
Storage statistics
Usage report
Details of all the user's devices
Information on the status of the user's cloud backups

Trial is about to expire

A notification sent to end users when their trial subscription will


expire in a certain number of days.
The number of days is configured locally. See Configuring Email
Notifications (on page 376).

Registration Confirmation

A notification to end users after registering with the CTERA


Portal, and before activating their account.

Portal Invitation

An email invitation to access shared files or folders.

header

The HTML header that appears at the top of all notifications.

footer

The HTML footer that appears at the bottom of all notifications.

New User Notification

A notification sent to end users when an account has been


created for them by an administrator, inviting them to use the
portal. The email message contains the portal address, as well
as the username and password.

Storage node has failed

A notification sent to portal administrators when a storage


node has failed.

Portal add-on is about to expire

A notification sent to portal administrators when a portal


add-on to which they are subscribed will expire in 7 days.

Portal Administrator Report

A monthly report sent to portal administrators.

System Administrator Report

A monthly report sent to system administrators.

Portal license exceeded

A notification sent to portal administrators when the portal


license has been exceeded.

CTERA Portal Datacenter Edition Administrator Guide

65

Configuring Global Virtual Portal Settings

Storage pool is full

A notification sent to system administrators when a storage


pool is full.
This field is relevant only if the CTERA Portal is installed on the
OpenSolaris platform.

Credit card billing failed

A notification sent to end users when billing their credit card


has failed.

Storage pool is Degraded

A notification sent to system administrators when a storage


pool is degraded.
This notification is supported only if the CTERA Portal is
installed on the OpenSolaris platform.

Project access granted

A notification sent to portal administrators when they have


been granted access to a project.
This field is relevant only for team portals.

Storage pool Failed

A notification sent to system administrators when a storage


pool has failed.
This notification is supported only if the CTERA Portal is
installed on the OpenSolaris platform.

Storage pool is almost full

A notification sent to system administrators when a storage


pool is over 90% full.
This notification is supported only if the CTERA Portal is
installed on the OpenSolaris platform.

Storage pool snapshots are

A notification sent to system administrators when storage pool

overdue

snapshots have not been taken for more than 4 hours.


This notification is supported only if the CTERA Portal is
installed on the OpenSolaris platform.

Device activated

A notification sent to end users when their device has been


activated.

One of the certificates is about to

A notification sent to system administrators when a CTERA

expire

Portal SSL certificate will expire in 30 days.

Catalog database is down

A notification sent to system administrators when the catalog


database on the CTERA Portal server is not been responding.

Test email

A test notification sent to system administrators.

Portal is exceeding its license

A notification sent to portal administrators when the portal is


exceeding any of its license quotas.

66

CTERA Portal Datacenter Edition Administrator Guide

4
Configuring Virtual Portals
This chapter explains how to configure portal-level CTERA Portal settings and branding.

In This Chapter
Overriding the Global Virtual Portal Settings ---------------------------------------------------------------- 67
Overriding Global Branding Settings --------------------------------------------------------------------------- 68

Overriding the Global Virtual Portal Settings


By default, each virtual portal inherits its settings from the global virtual portal settings. If
desired, you can override the global settings for a specific virtual portal, including settings
such as:
Whether reseller portal end users can open a CTERA Portal account on their own, and the
requirements for doing so
Whether vouchers can be used by end users in a reseller portal
Whether the folders of users who have no quota should be automatically deleted after a
period of time

CTERA Portal Datacenter Edition Administrator Guide

67

Configuring Virtual Portals

To override the global virtual portal settings for a specific virtual portal
1 In the navigation pane, click Settings > Virtual Portal Settings.
The Settings > Virtual Portal Settings page appears.

2 Do one of the following:


To override global settings, click Override.
To revert to global settings, click Use global settings.
3 Complete the fields using the information in Virtual Portal Settings Fields (page 27).
4 Click Save.

Overriding Global Branding Settings


By default, each virtual portal inherits its branding settings from the global settings. If
desired, you can override the global branding settings for a specific virtual portal, and brand
your CTERA Portal by applying the following:
A skin with your company logo and color scheme
A custom Login page

Creating Skins
To create a skin
1 Request a basic skin from CTERA support.
2 Extract the ZIP file that you received.
3 Edit the HTML and CSS files as desired.

68

CTERA Portal Datacenter Edition Administrator Guide

Configuring Virtual Portals

4 Replace the graphic files as desired.


5 Put the changed files back in the ZIP file.
6 Change the ZIP file's extension to .skin.

Uploading Skins
To upload a skin
1 In the navigation pane, click Settings > Skins.
The Settings > Skins page appears.

2 Click Upload.
The Skin Upload Wizard appears displaying the Select a file to upload dialog box.

3 Click Upload and browse to the desired *.skin file.

CTERA Portal Datacenter Edition Administrator Guide

69

Configuring Virtual Portals

The skin is uploaded.


At the end of the process, the Completing the Skin Upload Wizard screen appears.

4 Click Finish.

Viewing Skins
To view all skins in the portal
1 In the navigation pane, click Settings > Skins.
The Settings > Skins page appears displaying all skins.
The currently applied skin is marked with the

icon.

The table includes the following columns.


2 To preview a specific skin, do the following:
a Select the desired skin's row.
b Click Preview.
A preview opens in a new window.
Table 9: Skins Fields

70

This field...

Displays...

Name

The skin's name.

Custom CSS

Indicates whether the skin includes a custom CSS (Yes/No).

Custom Login Page

Indicates whether the skin includes a custom Login page (Yes/No).

Size

The *.skin file's size.

CTERA Portal Datacenter Edition Administrator Guide

Configuring Virtual Portals

Applying Skins
To apply a skin to the CTERA Portal
1 In the navigation pane, click Settings > Skins.
The Settings > Skins page appears.
2 Select the desired skin's row.
3 Click Mark as Current.
The selected skin is applied to the CTERA Portal and marked with the

icon.

Removing the Currently Applied Skin


When you remove the currently applied skin, the default CTERA Portal skin is used.
Tip

The removed skin is not deleted from the system.


To remove the currently applied skin
1 In the navigation pane, click Settings > Skins.
The Settings > Skins page appears.
2 Click Remove Current.
The default CTERA Portal skin is applied.

Deleting Skins
To delete a skin
1 In the navigation pane, click Settings > Skins.
The Settings > Skins page appears.
2 Select the desired skin's row.
3 Click Delete.
A confirmation message appears.
4 Click Yes.
The skin is deleted.

CTERA Portal Datacenter Edition Administrator Guide

71

5
Managing User Accounts
End users are registered with the CTERA Portal and have access to the End User Portal. Each
user is represented in the CTERA Portal by a user account.
This chapter explains how to manage the user accounts.

In This Chapter
Accessing the User Account Manager ------------------------------------------------------------------------- 74
Adding and Editing User Accounts ----------------------------------------------------------------------------- 75
Viewing User Accounts -------------------------------------------------------------------------------------------- 77
Configuring Group Membership for User Accounts-------------------------------------------------------- 80
Provisioning User Accounts in Reseller Portals -------------------------------------------------------------- 81
Provisioning User Accounts in Team Portals ----------------------------------------------------------------- 85
Managing Devices for User Accounts -------------------------------------------------------------------------- 87
Managing Folder Groups for User Accounts ----------------------------------------------------------------- 88
Configuring User Accounts' Advanced Settings ------------------------------------------------------------- 89
Managing Projects Owned by User Accounts---------------------------------------------------------------- 92
Configuring User Alerts-------------------------------------------------------------------------------------------- 93
Viewing User Account Details ----------------------------------------------------------------------------------- 95
Generating Monthly Reports ------------------------------------------------------------------------------------ 96
Enabling/Disabling User Accounts ------------------------------------------------------------------------------ 97
Exporting User Accounts to Excel ------------------------------------------------------------------------------- 97
Applying Provisioning Changes ---------------------------------------------------------------------------------- 98
Deleting User Accounts ------------------------------------------------------------------------------------------- 99
Using Directory Services ------------------------------------------------------------------------------------------ 99
Managing User Groups ------------------------------------------------------------------------------------------ 113

CTERA Portal Datacenter Edition Administrator Guide

73

Managing User Accounts

Accessing the User Account Manager


Most tasks related to managing a user account are performed in the User Account Manager.
To access the User Account Manager
1 In the navigation pane, click Users > Users.
The Users > Users page appears, displaying all user accounts.

2 Do one of the following:


Select the desired user account's row and click Edit.
Click on the desired user account's user name.

74

CTERA Portal Datacenter Edition Administrator Guide

Managing User Accounts

The User Account Manager opens displaying the Profile tab.

Adding and Editing User Accounts


Tip

If self-registration is enabled in a reseller portal, a user account is automatically


added, when a user registers; however, it is possible to add user accounts
manually, as well.
To add or edit a user account
1 Do one of the following:
To add a new user account, in the Users > Users page, click New.
To edit an existing user account, access the User Account Manager.
See Accessing the User Account Manager (on page 74).
The User Account Manager opens displaying the Profile tab.
2 Complete the fields using the information in the following table.
3 Click Save.

CTERA Portal Datacenter Edition Administrator Guide

75

Managing User Accounts

Table 10: User Manager Profile Fields


In this field...

Do this...

Username

Type a user name for the user's CTERA Portal account.

Email

Type the user's email address.

First Name

Type the user's first name.

Last Name

Type the user's last name.

Company

Type the name of the user's company.


This field is optional.

Role

Select the user's role. This can be either of the following:


Read/Write Administrator. The user can access the End
User Portal, and can access the Administration tab of the
End User Portal with read-write permissions. For
information about this tab, see CTERA Portal Interfaces
and Users (on page 7). This role is relevant for team portals
only.
Read Only Administrator. The user can access the End User
Portal, and can access the Administration tab of the End
User Portal with read-only permissions. For information
about this tab, see CTERA Portal Interfaces and Users (on
page 7). This role is relevant for team portals only.
End User. The user can access the End User Portal.
Disabled. The user account is disabled. The user cannot
access the End User Portal.
The default value is End User.
Note: In order to access the End User Portal, the user must
have a role other than Disabled, and their status must be
active.

76

CTERA Portal Datacenter Edition Administrator Guide

Managing User Accounts

Status

Select the account status. This can be either of the following:


active. The account is active, and the user can access the
CTERA Portal.
inactive. The account is inactive, and the user cannot
access the CTERA Portal.
The default value for new users created by an administrator is
active.
If email validation is enabled, (see Overriding Global Portal
Settings (see "Overriding the Global Virtual Portal Settings" on
page 67)), the default value for self-registered users is inactive,
until the user activates the account by clicking the link provided
in the email.
If email validation is disabled, the default value for
self-registered users is active.
Note: In order to access the CTERA Portal, the user must have a
role other than Disabled, and their status must be active.

Password / Retype Password

Type a password for the user's CTERA Portal account.


By default, the password must be at least 7 characters long. For
information on configuring the minimum required number of
characters in a password, see Overriding Global Portal Settings
(see "Overriding the Global Virtual Portal Settings" on page
67).

Force password change

Select this option to specify an expiration date for the user


account password, and then click

to select the date.

When the password has expired, the user will be required to


configure a new password upon their next login.
Numeric UID

Type a numeric user ID to assign the user's CTERA Portal


account.
This field is optional.

Billing ID

Type the user's billing ID. This field is relevant for reseller
portals only.

Comment

Type a description of the user account.

Viewing User Accounts


To view all user accounts in the portal
1 In the navigation pane, click Users > Users.
The Users > Users page appears, displaying all user accounts.

CTERA Portal Datacenter Edition Administrator Guide

77

Managing User Accounts

The table includes the following columns.


2 (Optional) To view only a specific type of users, in the Show drop-down list, do one of the
following:
To view only the users of a specific domain, select the domain name.
To view users defined in the local user database, select Local Users.

78

CTERA Portal Datacenter Edition Administrator Guide

Managing User Accounts

Table 11: Users Fields


This field...

Displays...

Username

The user account's user name.


To edit the user, click the user name. For further details, see Adding
and Editing User Accounts (on page 75).

Full Name

The user's full name.

Role

The user's role.

Email

The user's email address.

Company

The name of the user's company.

Subscription Plan

The user account's assigned subscription plan.


To modify the subscription plan, click the plan's name. For further
details, see Adding and Editing Subscription Plans (on page 228).

Subscription Status

The user account's subscription status. This can be any of the


following:
Expired on date. The subscription plan expired on the specified
date.
Expires in days. The subscription plan will expire in the specified
number of days. This status is only relevant when the plan will
expire within 30 days.
Expiration date date. The subscription plan will expire on the
specified date. This status is relevant when the plan will expire in
more than 30 days.
Not Subscribed. The user is not subscribed to a plan.

Add Ons

The number of add-ons for the user account.


To modify the list of add-ons, click on the number. For further
details, see Adding and Editing Add-ons (on page 239).

Storage Usage

A bar graph indicating the amount of storage the user has consumed
out of the total amount provisioned.

Appliance Licenses

The number of appliances associated with the user account out of


the total amount provisioned.

Server Agent Licenses

The number of CTERA Server Agents installed out of the total


amount provisioned.

Workstation Backup

The number of CTERA Workstation Agents installed and using the

Licenses

Cloud Backup service out of the total amount provisioned.

Cloud Drive

Whether or not the user has the Cloud Drive service.

CTERA Portal Datacenter Edition Administrator Guide

79

Managing User Accounts

Status

The user's account status. This can be either of the following:


active. The account is active, and the user can access the CTERA
Portal.
inactive. The account is inactive, and the user cannot access the
CTERA Portal.

Billing ID

The user's billing ID. This field is relevant for reseller portals only.

Configuring Group Membership for User Accounts


You can add user accounts to user groups. For information on user groups, see Managing
User Groups (on page 113).
To configuring group membership for a user account
1 Access the User Account Manager.
See Accessing the User Account Manager (on page 74).
2 Click the Groups tab.
The Groups Membership tab appears.

3 To add the user account to a user group, do the following:


a In the Quick Search field, type a string that appears anywhere within the name of the
desired user group, then click

80

CTERA Portal Datacenter Edition Administrator Guide

Managing User Accounts

A table of user groups matching the search string appears.

b Select the desired user group in the table.


The user group appears in the Quick Search field.
c Click Add.
The user group is added to the list of user groups to which the user account belongs.
You can edit any listed user group, by clicking on its name. See Adding and Editing
User Groups (on page 114).
4 To remove the user account from a user group, in the user group's row, click

The user group is removed from the list.


5 Click Save.

Provisioning User Accounts in Reseller Portals


In reseller portals, you can provision user accounts via subscription plans and add-ons.

Assigning User Accounts to Subscription Plans


To assign a user account to a subscription plan
1 Access the User Account Manager.

CTERA Portal Datacenter Edition Administrator Guide

81

Managing User Accounts

See Accessing the User Account Manager (on page 74).


2 Click the Provisioning tab.
The Provisioning tab appears.

3 In the Subscription Plan field, click

The Select Your Subscription Plan dialog box opens.

82

CTERA Portal Datacenter Edition Administrator Guide

Managing User Accounts

4 In the Subscription Plan drop-down list, select the subscription plan to assign the user
account.
5 In the Subscription Expiration field, click
to specify the date on which the user
account's subscription to the selected plan should expire.
6 Click Save.
The user account is assigned to the subscription plan.

Adding Add-ons to User Accounts


To add an add-on to a user account
1 Access the User Account Manager.
See Accessing the User Account Manager (on page 74).
2 Click the Provisioning tab.
The Provisioning tab appears.
3 To use a voucher for an add-on, do the following:
a Click I have a voucher.
The Voucher Activation Wizard opens.

b Type the voucher code in the fields provided.


c Click Next.

CTERA Portal Datacenter Edition Administrator Guide

83

Managing User Accounts

The Services Activated screen appears with the voucher details.

d Click Next.
The Wizard Completed screen appears.

e Click Finish.
The Manage Add-ons dialog box reappears with the add-on listed.
4 To add an add-on for the user account, do the following:
a In the drop-down list, select the desired add-on.
b Click Add.

84

CTERA Portal Datacenter Edition Administrator Guide

Managing User Accounts

The add-on appears in the list box.

c In the add-on's row in the list box, click in the Valid For column, and then click

A calendar appears.
d Select the date on which the add-on subscription should end.
The Expiration column is updated accordingly.
5 To remove an add-on from the user account, in the add-on's row in the list box, click
.
The add-on is removed.
6 Click Save.
The add-on is added to the user account.

Provisioning User Accounts in Team Portals


By default, team members are assigned to the default subscription plan. If desired, you can
subscribe an individual user to a different subscription plan. You can also unsubscribe the
user account, which deletes all files stored in the account and terminates the account.

Assigning User Accounts to Subscription Plans


To assign a user account to a subscription plan
1 Access the User Account Manager.
See Accessing the User Account Manager (on page 74).
2 Click the Provisioning tab.

CTERA Portal Datacenter Edition Administrator Guide

85

Managing User Accounts

The Provisioning tab appears.

3 In the Subscription Plan field, click

The Select Your Subscription Plan dialog box opens.

4 In the Subscription Plan drop-down list, select the subscription plan to assign the user
account.
5 Click OK.

86

CTERA Portal Datacenter Edition Administrator Guide

Managing User Accounts

Terminating User Accounts


Unsubscribing a user account from a subscription plan terminates the user account and
removes all the files stored in the account.
To terminate a user account:
1 Access the User Account Manager.
See Accessing the User Account Manager (on page 74).
2 Click the Provisioning tab.
The Provisioning tab appears.
3 Click Unsubscribe.
The Account Termination dialog appears.

4 If you are sure you want to proceed, enter your password in the field provided.
5 Click Save.

Managing Devices for User Accounts


You can manage the devices associated with a user account.
To manage devices for a user account
1 Access the User Manager.
See Accessing the User Account Manager (on page 74).
2 Click the Devices tab.

CTERA Portal Datacenter Edition Administrator Guide

87

Managing User Accounts

The Devices tab appears with a table of devices associated with the user account.

3 Perform any of the device management tasks described in Managing Devices, as if you
were working in the Main > Devices page.

Managing Folder Groups for User Accounts


You can manage the folder groups associated with a user account.
To manage folder groups for a user account
1 Access the User Account Manager.
See Accessing the User Account Manager (on page 74).
2 Click the Folder Groups tab.

88

CTERA Portal Datacenter Edition Administrator Guide

Managing User Accounts

The Folder Groups tab appears with a table of folder groups associated with the user
account.

3 Perform any of the folder group management tasks described in Managing Folders and
Folder Groups, as if you were working in the Main > Folder Groups page.

Configuring User Accounts' Advanced Settings


To configure a user account's advanced settings
1 Access the User Account Manager.
See Accessing the User Account Manager (on page 74).
2 Click the Advanced tab.

CTERA Portal Datacenter Edition Administrator Guide

89

Managing User Accounts

The Advanced tab appears.

3 Complete the fields using the information in the following table.


4 Click Save.

90

CTERA Portal Datacenter Edition Administrator Guide

Managing User Accounts

Table 12: User Manager Advanced Fields


In this field...

Do this...

Backup
Deduplication Level

Specify the default de-duplication level to use for new backup


folders. Select one of the following:
User. Create a single folder group for the user account,
containing all of the user account's backup folders.
De-duplication is performed for the user account's folder
group. This is the default value for reseller portals.
Portal. Use a single folder group that is shared by the entire
virtual portal, containing all of the backup folders in the
portal. This option is relevant for team portals only. It is the
default value for team portals.
Folder. Create a folder group for each of the user account's
devices, containing all of the device's backup folders.
De-duplication is performed separately for each of the user
account's folder groups.
If you select User, the Default Folder Group field appears and
must be filled in.

Default Folder Group

Select the default folder group to use for all of the user
account's backup folders. This can be either of the following:
An existing folder group
Automatically Create. Automatically create a new folder
group.
The default value is Automatically Create.

Cloud Drive

CTERA Portal Datacenter Edition Administrator Guide

91

Managing User Accounts

Deduplication Level

Specify the default de-duplication level to use for new cloud


folders. Select one of the following:
User. Create a single folder group for the user account,
containing all of the user account's cloud folders.
De-duplication is performed for the user account's folder
group. This is the default value for reseller portals.
Portal. Use a single folder group that is shared by the entire
virtual portal, containing all of the cloud folders in the
portal. This option is relevant for team portals only. It is the
default value for team portals.
Folder. Create a folder group for each of the user account's
devices, containing all of the device's cloud folders.
De-duplication is performed separately for each of the user
account's folder groups.
If you select User, the Default Folder Group field appears and
must be filled in.

Default Folder Group

Select the default folder group to use for all of the user
account's cloud folders. This can be either of the following:
An existing folder group
Automatically Create. Automatically create a new folder
group.
The default value is Automatically Create.

Cloud Files Folder

Select the folder to act as the user account's private cloud


drive.
The user will be able to access the private cloud drive via the
End User Portal's Cloud Drive tab, for the purpose of viewing,
uploading, and downloading files.

Managing Projects Owned by User Accounts


You can manage projects owned by a team member. This procedure is relevant for team
portals only.
To manage projects owned by a team member
1 Access the User Account Manager.
See Accessing the User Account Manager (on page 74).
2 Click the Projects tab.

92

CTERA Portal Datacenter Edition Administrator Guide

Managing User Accounts

The Projects tab appears.

3 Perform any of the project management tasks described in Managing Collaboration


Projects (on page 211), as if you were working in the Folders > Projects page.

Configuring User Alerts


You can configure CTERA Portal to send alerts to the user upon certain events. This procedure
is relevant for team portals only.
To manage alerts for a user
1 Access the User Account Manager.
See Accessing the User Account Manager (on page 74).
2 Click the Alerts tab.

CTERA Portal Datacenter Edition Administrator Guide

93

Managing User Accounts

The Alerts tab appears.

3 Complete the fields using the information in the following table.


4 Click Save.
Table 13: User Alerts Fields
In this field...

Do this...

Administrator Alerts

Select this option to indicate that the user should receive


administrator alerts, as well as a monthly administrator report.
Administrator alerts are notifications about portal-level
problems. Administrator reports are reports sent via email.

Customer Alerts

Select this option to indicate that the user should receive


customer alerts.
Customer alerts are notifications about device-level problems.

Customer Reports

Select this option to indicate that the user should receive


customer reports.

94

CTERA Portal Datacenter Edition Administrator Guide

Managing User Accounts

Viewing User Account Details


To view a user account's details
1 Access the User Account Manager.
See Accessing the User Account Manager (on page 74).
2 Click the Details tab.
The Details tab appears.

For information on the fields displayed, see the following table.

CTERA Portal Datacenter Edition Administrator Guide

95

Managing User Accounts

Table 14: User Manager Details Fields


This field...

Displays...

Storage Quota

The amount of storage the user has consumed out of the total
amount available in their subscription plan.

Cloud Drive

Whether the user is provisioned to have the Cloud Drive


service.

Workstation Backup Licenses

The number of CTERA Workstation Agents installed and using


the cloud backup service out of the total number available in
the user account's subscription plan.

Server Agent Licenses

The number of CTERA Server Agents installed out of the total


number available in the user account's subscription plan.

Appliance Licenses

The number of appliances associated with the user account out


of the total number available in the user account's subscription
plan.

Account Created

The date and time when the user account was created.

Last Login

The date and time when the user last logged in to the CTERA
Portal.

Generating Monthly Reports


You can trigger the immediate generation and sending of the monthly report for a specific
user account.
To generate a monthly report for the user account
1 Access the User Account Manager.
See Accessing the User Account Manager (on page 74).
2 Click the Details tab.
The Details tab appears.
3 Click Generate.
A report is generated and sent to the user by email.

96

CTERA Portal Datacenter Edition Administrator Guide

Managing User Accounts

Enabling/Disabling User Accounts


If a user signed up for a CTERA Portal account via self-registration, and Require Email
Confirmation is enabled (see Overriding Global Portal Settings (see "Overriding the Global
Virtual Portal Settings" on page 67).), the user will receive an email from the CTERA Portal
containing an activation link. The new user account will remain disabled until the user
confirms the registration by clicking the link. If for some reason the user does not click the
link, you can enable the user account as described in the following procedure.
In addition, you can temporarily disable a user account, and then re-enable it as desired.
To enable a user account
1 Access the User Account Manager.
See Accessing the User Account Manager (on page 74).
2 In the Status field, select active.
3 Click Save.
To disable a user account
1 Access the User Account Manager.
See Accessing the User Account Manager (on page 74).
2 In the Status field, select inactive.
3 Click Save.

Exporting User Accounts to Excel


You can export a list of user accounts and their details to a Microsoft Excel (*.xls) file on your
computer.
To export user accounts to Excel
1 In the navigation pane, click Users > Users.
The Users > Users page appears, displaying all user accounts.
2 Click Export to Excel.
The user accounts are exported.

CTERA Portal Datacenter Edition Administrator Guide

97

Managing User Accounts

Applying Provisioning Changes


CTERA Portal applies changed plan and add-on settings to all users every day at midnight. If
desired, you can use the following procedure to apply all changes immediately.
Tip

If CTERA Portal is integrated with a directory service, applying provisioning


changes will also cause CTERA Portal to synchronize all the users with the
directory.
To apply provisioning changes to all users
1 In the navigation pane, click Users > Users.
The Users > Users page appears, displaying all user accounts.
2 Click Apply Provisioning Changes.
The following things happen:
Provisioning changes are applied to all users, and the Apply Provisioning Changes
window opens displaying Running screen with a progress bar that tracks the
operation's progress.

To stop the process, click Stop. To close the progress bar, while the process continues
in the background, click Continue in Background.
When the operation is complete, the Completed screen appears.

98

CTERA Portal Datacenter Edition Administrator Guide

Managing User Accounts

3 Click Close.

Deleting User Accounts


Deleting a user account from the CTERA Portal cancels the user's subscriptions to plans and
add-ons, and deletes all of the user's folders and folder groups.
To delete a user account
1 Do one of the following:
In the Users > Users page, select the desired user account's row, then click Delete.
Access the User Account Manager, then click Delete.
See Accessing the User Account Manager (on page 74).
A confirmation message appears.
2 Click Yes.
The user account is deleted.

Using Directory Services


The CTERA Portal can be integrated with the following directory services:
Microsoft Active Directory
LDAP directory services:
OpenDS
Oracle Unified Directory
Oracle Directory Server Enterprise Edition
Sun Java System Directory Server

CTERA Portal Datacenter Edition Administrator Guide

99

Managing User Accounts

User accounts will be automatically fetched and refreshed from the directory, and user
authentication will be performed using the directory.
CTERA Portal administrators can define an access control list specifying which directory
service groups and individual users are permitted to access the CTERA Portal, and which user
roles they should be assigned in CTERA Portal.
Tip

Users must have an email address, as well as a first and last name, defined in the
directory service. Users without one of those attributes in the directory service
cannot log in to the CTERA Portal and will cause synchronization to fail.
Tip

Nested groups are not supported.

How Directory Service Synchronization Works


When integrated with a directory service, CTERA Portal fetches user data from the directory
upon the following events:
An administrator can manually fetch specific users from the directory. See Manually
Fetching User Data (on page 111).
If a user attempts to log in, but does not yet have a local CTERA Portal account, their user
account is automatically fetched from the directory.
CTERA Portal automatically re-fetches all previously fetched directory users, every day at
midnight, as part of the daily "Apply provisioning changes" task.
An administrator can force a re-synchronization of all previously fetched directory users,
by running the Apply Provisioning Changes Wizard. See Applying Provisioning Changes
(on page 98).
CTERA Portal handles special cases as follows:
If during the fetch it is determined that a user exists in the local user database but not in
the directory, then the user is assumed to have been deleted, and CTERA Portal deletes
the user from the local user database. The users folders are not deleted.
If the access control list specifies that the user is no longer allowed to access CTERA
Portal, then CTERA Portal changes the user account's role to Disabled. The user account
is not deleted.
Tip

Each virtual portal can optionally be integrated with a different Active Directory or
LDAP directory.

Integrating CTERA Portal with an Active Directory Domain, Tree, or Forest


To integrate a virtual portal with an Active Directory domain, tree, or forest
1 In the navigation pane, click Users > Directory Services.

100

CTERA Portal Datacenter Edition Administrator Guide

Managing User Accounts

The Users > Directory Services page appears.

2 Click Settings.
The Directory Services Wizard appears, displaying the Synchronization Settings dialog
box.

3 Complete the fields using the information in the table following this procedure.
4 Click Next.

CTERA Portal Datacenter Edition Administrator Guide

101

Managing User Accounts

The UID/GID Mappings dialog box appears.

5 To add the other domains in the tree/forest, do the following for each one:
a In the Add domain field, either type the desired domain's name, or select it from the
drop-down list.
b Click Add.
The domain appears in the table.
c Click in the UID/GID Start field, and type the starting number in the range of CTERA
Portal user and group IDs (UID/GID) that should be assigned to users and user groups
from this domain.
d Click in the UID/GID End field, and type the ending number in the range of CTERA
Portal user and group IDs (UID/GID) that should be assigned to users and user groups
from this domain.
6 To re-order the domains, do any of the following:
To move a domain up in the table, click on the desired domain, then click Move Up.
To move a domain down in the table, click on the desired domain, then click Move
Down.
The order in which domains appear in the table represents the order in which the
domains will appear in drop-down lists throughout the CTERA Portal interface.
7 To remove a domain, in their row, click

The domain is removed from the table.

102

CTERA Portal Datacenter Edition Administrator Guide

Managing User Accounts

Click Next.
The Access Control dialog box appears.

8 Add each Active Directory user and user group that should be allowed to access the
virtual portal, by doing the following:
a In the drop-down list, select one of the following:
Users. Search the users defined in Active Directory.
Groups. Search the user groups defined in Active Directory.
b In the Quick Search field, type a string that appears anywhere within the name of the
user or user group you want to add, then click

A table of users or user groups matching the search string appears.


c Select the desired user or user group in the table.
The user or user group appears in the Quick Search field.
d Click Add.
The user or user group is added to the list of users and user groups who should have
access to the virtual portal.
9 To remove a user or user group, in their row, click

The user or user group is removed from the list.


10 In each user and user group's row, click in the Role column, then select the desired user
role from the drop-down list.

CTERA Portal Datacenter Edition Administrator Guide

103

Managing User Accounts

Options include Disabled, End User, Read Only Administrator, and Read/Write
Administrator. For information on these roles, see User Manager Profile Fields (page 76).
The Wizard Completed screen appears.

11 Click Finish. The User data is fetched from Active Directory, and the Apply Changes
window opens displaying Running screen with a progress bar that tracks the operation's
progress.

To stop the process, click Stop. To close the progress bar, while the process continues in
the background, click Continue in Background.

104

CTERA Portal Datacenter Edition Administrator Guide

Managing User Accounts

When the operation is complete, the Completed screen appears.

12 Click Close.
Synchronization with Active Directory is enabled.

CTERA Portal Datacenter Edition Administrator Guide

105

Managing User Accounts

Table 15: Directory Services Wizard Fields


In this field...

Do this...

Enable Directory Synchronization

Select this option to enable integration with an Active Directory


domain.

Directory Type

Select Active Directory as the type of directory with which to


integrate CTERA Portal.

Use SSL

Select this option to connect to the Active Directory domain


using SSL.

Use Kerberos

Select this option to use the Kerberos protocol for


authentication when communicating with the Active Directory
domain. This is useful for achieving Single Sign On (SSO) with
Windows computers. If unchecked, LDAP is used.
Note: Only one virtual portal, per system, can use Kerberos.

Domain

Type the name of Active Directory domain with which you want
to synchronize users.

Username

Type the username that CTERA Portal should use for


authenticating to Active Directory.

Password

Type the password that CTERA Portal should use for


authenticating to Active Directory.

Organizational Unit

Type the name of the organizational unit (OU) within the Active
Directory domain.
This field is optional.

Manually specify domain

Select this option to manually specify the IP address of the

controller addresses

Active Directory domain controller(s). If unchecked, DNS is used


to automatically find the Active Directory domain controller(s).

Primary

If you selected Manually specify domain controller addresses,


type the address of the primary Active Directory domain
controller.

Secondary

If you selected Manually specify domain controller addresses,


type the address of the secondary Active Directory domain
controller.

Integrating CTERA Portal with an LDAP Directory Server


To integrate a virtual portal with an LDAP directory
1 In the navigation pane, click Users > Directory Services.
The Users > Directory Services page appears.

106

CTERA Portal Datacenter Edition Administrator Guide

Managing User Accounts

2 Click Settings.
The Directory Services Wizard appears, displaying the Synchronization Settings dialog
box.

3 Complete the fields using the information in the following table.


4 Click Next.
The Advanced LDAP Mappings dialog box appears.

CTERA Portal Datacenter Edition Administrator Guide

107

Managing User Accounts

5 To configure the portal to match a custom LDAP schema, edit the LDAP mappings by
clicking the LDAP attributes to enter the attributes that map to the corresponding user
properties.
6 Click Next.
The Access Control dialog box appears.

7 Add each LDAP directory user and user group that should be allowed to access the virtual
portal, by doing the following:
a In the Users drop-down list, select one of the following:
Users. Search the users defined in the LDAP directory.
Groups. Search the user groups defined in the LDAP directory.
b In the Quick Search field, type a string that appears anywhere within the name of the
user or user group you want to add, then click

A table of users or user groups matching the search string appears.


c Select the desired user or user group in the table.
The user or user group appears in the Quick Search field.
d Click Add.
The user or user group is added to the list of users and user groups who should have
access to the virtual portal.
8 To remove a user or user group, in their row, click

108

CTERA Portal Datacenter Edition Administrator Guide

Managing User Accounts

The user or user group is removed from the list.


9 In each user and user group's row, click in the Role column, then select the desired user
role from the drop-down list.
Options include Disabled, End User, Read Only Administrator, and Read/Write
Administrator. For information on these roles, see User Manager Profile Fields (page 76).
10 Click Next.
The Wizard Completed screen appears.

Click Finish. User data is fetched from the LDAP directory.


When the operation is complete, the Completed screen appears.

Click Close.

CTERA Portal Datacenter Edition Administrator Guide

109

Managing User Accounts

Synchronization with the LDAP directory is enabled.

Table 16: Directory Services Wizard Fields


In this field...

Do this...

Enable Directory Synchronization

Select this option to enable integration with an LDAP directory


service.

Directory Type

Select LDAP as the type of directory service with which to


integrate CTERA Portal.

LDAP URL

Type the URL for connecting to the LDAP server.

Base DN

Type the base DN of the LDAP server.


This field is optional.

Login DN

Type the distinguished name of a user with full user read rights,
used for binding (authenticating) to the LDAP server (also
known as bind DN).

Password

Type the password to use for binding (authenticating) to the


LDAP server.

User Class

Type the LDAP object class for user objects in the LDAP
directory.

110

CTERA Portal Datacenter Edition Administrator Guide

Managing User Accounts

Manually Fetching User Data


If desired, you can manually fetch user data from an integrated Active Directory or LDAP
directory. This is useful in the following situations:
If you would like to immediately update data in the local user database, instead of waiting
for CTERA Portal to automatically fetch data at midnight.
If you would like to create an account for a user that does not yet exist in the local user
database, before their first login.
To manually fetch user data
1 In the navigation pane, click Users > Directory Services.
The Users > Directory Services page appears.
2 Click Fetch Users.
The Fetch Users Wizard appears, displaying the Select Users and Groups to Fetch dialog
box.

3 Add each user and user group from the directory service for which you would like to fetch
data, by doing the following:
a In the Users drop-down list, select one of the following:
Users. Search the users defined in the integrated directory service.
Groups. Search the user groups defined in the integrated directory service.
b In the Quick Search field, type a string that appears anywhere within the name of the
user or user group you want to add, then click

A table of users or user groups matching the search string appears.

CTERA Portal Datacenter Edition Administrator Guide

111

Managing User Accounts

c Select the desired user or user group in the table.


The user or user group appears in the Quick Search field.
d Click Add.
The user or user group is added to the list of users and user groups for which data
should be fetched.
4 To remove a user or user group, in their row, click

The user or user group is removed from the list.


5 Click Finish.
The following things happen:
User data is fetched from the directory service, and the Apply Changes window opens
displaying Running screen with a progress bar that tracks the operation's progress.

To stop the process, click Stop. To close the progress bar, while the process continues
in the background, click Continue in Background.
When the operation is complete, the Completed screen appears.

6 Click Close.

112

CTERA Portal Datacenter Edition Administrator Guide

Managing User Accounts

Managing User Groups


You can organize user accounts in user groups, and then use these groups when configuring
the automatic template assignment policy or setting project permissions.
Tip

Directory service groups are supported.

Accessing the User Group Manager


Most tasks related to managing a user group are performed in the User Group Manager.
To access the User Group Manager
1 In the navigation pane, click Users > Groups.
The Users > Groups page appears, displaying all user groups.

2 Do one of the following:


Select the desired user group's row and click Edit.
Click on the desired user group's name.

CTERA Portal Datacenter Edition Administrator Guide

113

Managing User Accounts

The User Group Manager opens displaying the General tab.

Adding and Editing User Groups


To add or edit a user group
1 Do one of the following:
To add a new user group, in the Users > Groups page, click New.
To edit an existing user group, access the User Group Manager.
See Accessing the User Group Manager (on page 113).
The User Group Manager opens displaying the General tab.
2 In the Name field, type a name for the group.
3 In the Description field, type a description of the group.
4 Click Save.

114

CTERA Portal Datacenter Edition Administrator Guide

Managing User Accounts

Configuring User Group Members


Tip

User accounts can belong to multiple user groups.


Tip

User accounts can be added to user groups as described in the following


procedure or as described in Configuring Group Membership for User Accounts
(on page 80).
To configure a user group's members
1 Access the User Group Manager.
See Accessing the User Group Manager (on page 113).
The User Group Manager opens displaying the General tab.
2 Click the Members tab.
The Members tab appears with a list of group members.

3 (Optional) To view only a specific type of users, in the Show drop-down list, do one of the
following:

CTERA Portal Datacenter Edition Administrator Guide

115

Managing User Accounts

To view only users from the directory service, select the Active Directory or LDAP
directory name.
To view users defined in the local user database, select Local Users.
4 To add a user account to the user group, do the following:
a In the Quick Search field, type a string that appears anywhere within the name of the
desired user account, then click

A table of user accounts matching the search string appears.

b Select the desired user account in the table.


The user account appears in the Quick Search field.
c Click Add.
The user account is added to the list of group members.
You can edit any listed user account, by clicking on its name. See Adding and Editing
User Accounts (on page 75).
5 To remove a user account from the user group, in the user account's row, click

The user account is removed from the list.


6 Click Save.

116

CTERA Portal Datacenter Edition Administrator Guide

Managing User Accounts

Viewing User Groups


To view all user groups in the portal
1 In the navigation pane, click Users > Group.
The Users > Groups page appears, displaying all user groups.
The table includes the following columns.
2 (Optional) To view only a specific type of user groups, in the View drop-down list, do one
of the following:
To view only users from the directory service, select the Active Directory or LDAP
directory name.
To view groups defined in the local user database, select Local Groups.
Table 17: User Group Fields
This field...

Displays...

Name

The user group's name.

Member Count

The number of user accounts that are members of the user group.

Description

A description of the user group.

Deleting User Groups


Tip

Deleting a user group does not delete the group members.


To delete a user group
1 Do one of the following:
In the Users > Groups page, select the desired user group's row, then click Delete.
Access the User Group Manager, then click Delete.
See Accessing the User Group Manager (on page 113).
A confirmation message appears.
2 Click Yes.
The user group is deleted.

CTERA Portal Datacenter Edition Administrator Guide

117

6
Managing Administrators
You can enable company staff members to manage CTERA Portal settings and contents, by
adding them as any of the following:
Global administrators, who have access to both the Staff Control Panel and the
Administration Control Panel for all virtual portals (including both reseller and team
portals)
Staff administrators, who have access to the Staff Control Panel of a single reseller portal
(relevant for reseller portals only)
Team administrators, who have access to the Administration tab in the End User Portal
(relevant for team portals only)
This chapter explains how to manage both types of administrators. Procedures related to
staff administrators are relevant for reseller portals only.

In This Chapter
Accessing the Staff Administrator Manager --------------------------------------------------------------- 120
Adding and Editing Staff Administrators -------------------------------------------------------------------- 121
Configuring Staff Administrator Alerts ---------------------------------------------------------------------- 122
Viewing Staff Administrators ---------------------------------------------------------------------------------- 124
Importing Staff Administrators from a File ----------------------------------------------------------------- 124
Deleting Staff Administrators ---------------------------------------------------------------------------------- 125
Accessing the Global Administrator Manager ------------------------------------------------------------- 126
Adding and Editing Global Administrators ----------------------------------------------------------------- 127
Configuring Global Administrator Alerts -------------------------------------------------------------------- 128
Viewing Global Administrators -------------------------------------------------------------------------------- 128
Deleting Global Administrators ------------------------------------------------------------------------------- 129
Configuring an IP-Based Access Control List --------------------------------------------------------------- 129
Importing Global Administrators from a File -------------------------------------------------------------- 131
Customizing Administrator Roles ----------------------------------------------------------------------------- 132

CTERA Portal Datacenter Edition Administrator Guide

119

Managing Administrators

Accessing the Staff Administrator Manager


Most tasks related to managing a staff administrator are performed in the Staff Administrator
Manager.
To access the Staff Administrator Manager
1 In the navigation pane, click Users > Staff.
The Users > Staff page appears, displaying all CTERA Portal staff administrators.

2 Do one of the following:


Select the desired administrator's row and click Edit.
Click on the desired administrator's user name.

120

CTERA Portal Datacenter Edition Administrator Guide

Managing Administrators

The Staff Administrator Manager opens displaying the Profile tab.

Adding and Editing Staff Administrators


To add or edit a staff administrator
1 Do one of the following:
To add a new administrator, in the Users > Staff page, click New.
To edit an existing administrator, access the Staff Administrator Manager.
See Accessing the Staff Administrator Manager (on page 120).
The Staff Administrator Manager opens displaying the Profile tab.
2 Complete the fields using the information in the following table.
3 Click Save.

CTERA Portal Datacenter Edition Administrator Guide

121

Managing Administrators

Table 18: Administrator Details Fields


In this field...

Do this...

Username

Type a user name for the administrator's CTERA Portal account.

Email

Type the administrator's email address.

First Name

Type the administrator's first name.

Last Name

Type the administrator's last name.

Company

Type the name of the administrator's company.


This field is optional.

Password / Retype Password

Type a password for the administrator's CTERA Portal account.


The password must be at least 5 characters long.

Force password change

Select this option to specify an expiration date for the


administrator account's password, then click

to select the

date.
When the password has expired, the administrator will be
required to configure a new password upon their next login.
Role

Specify the administrator's role.


For information on the available roles, see Customizing
Administrator Roles (on page 132).

Comment

Type a description of the administrator's CTERA Portal account.

Configuring Staff Administrator Alerts


To configure a staff administrator's alerts
1 Access the Staff Administrator Manager.
See Accessing the Staff Administrator Manager (on page 120).
2 Click the Alerts tab.

122

CTERA Portal Datacenter Edition Administrator Guide

Managing Administrators

The Alerts tab appears.

3 Complete the fields using the information in the following table.


4 Click Save.
Table 19: Administrator Alerts Fields
In this field...

Do this...

Administrator Alerts

Select this option to indicate that the administrator should


receive administrator alerts.
Administrator alerts are notifications about portal-level
problems.

Customer Alerts

Select this option to indicate that the administrator should


receive customer alerts.
Customer alerts are notifications about device-level problems.

Customer Reports

Select this option to indicate that the administrator should


receive customer reports.

CTERA Portal Datacenter Edition Administrator Guide

123

Managing Administrators

Viewing Staff Administrators


To view all staff administrators in the portal
In the navigation pane, click Users > Staff.
The Users > Staff page appears, displaying all staff administrators.
The table includes the following columns.
Table 20: Administrators Fields
This field...

Displays...

Username

The administrator's user name.


To edit the administrator, click the user name. For further details,
see Adding and Editing Staff Administrators (on page 121).

Full Name

The administrator's full name.

Email

The administrator's email address.

Company

The name of the administrator's company.

Role

The administrator's role.

Importing Staff Administrators from a File


You can import a list of staff administrators and their details from a comma separated values
(*.csv) file.
The *.csv file's columns must be in the following order:
1 Username
2 First name
3 Last name
4 Email address
5 Company (Optional)
6 Password
7 Role
8 Plan (Optional)
9 Numeric UID (Optional)
10 External Account ID (Optional)
11 Comment (Optional)

124

CTERA Portal Datacenter Edition Administrator Guide

Managing Administrators

Optional fields can be left blank.


To import staff administrators from a *.csv file
1 In the navigation pane, click Users > Staff.
The Users > Staff page appears.
2 Click Import.
The Import Staff wizard appears.

3 Click Upload. The file is uploaded and the Import Completed screen appears.

4 Click Finish.

Deleting Staff Administrators


To delete a staff administrator
1 Do one of the following:
In the Users > Staff page, select the desired administrator's row, then click Delete.

CTERA Portal Datacenter Edition Administrator Guide

125

Managing Administrators

Access the Staff Administrator Manager, then click Delete.


See Accessing the Staff Administrator Manager (on page 120).
A confirmation message appears.
2 Click Yes.
The administrator is deleted.

Accessing the Global Administrator Manager


Most tasks related to managing a global administrator are performed in the Global
Administrator Manager.
This task can be performed in the Global Administration View only.
To access the Global Administrator Manager
1 In the navigation pane, click Users > Administrators.
The Users > Administrators page appears, displaying all CTERA Portal global
administrators.

2 Do one of the following:


Select the desired administrator's row and click Edit.
Click on the desired administrator's user name.

126

CTERA Portal Datacenter Edition Administrator Guide

Managing Administrators

The Global Administrator Manager opens displaying the Profile tab.

Adding and Editing Global Administrators


This task can be performed in the Global Administration View only.
To add or edit a global administrator
1 Do one of the following:
To add a new administrator, in the Users > Administrators page, click New.
To edit an existing administrator, access the Global Administrator Manager.
See Accessing the Global Administrator Manager (on page 126).
The Global Administrator Manager opens displaying the Profile tab.
2 Complete the fields using the information in Administrator Details Fields (page 122).
3 Click Save.

CTERA Portal Datacenter Edition Administrator Guide

127

Managing Administrators

Configuring Global Administrator Alerts


This task can be performed in the Global Administration View only.
To configure a global administrator's alerts
1 Access the Global Administrator Manager.
See Accessing the Global Administrator Manager (on page 126).
2 Click the Alerts tab.
The Alerts tab appears.

3 Complete the fields using the information in Administrator Alerts Fields (page 123).
4 Click Save.

Viewing Global Administrators


This task can be performed in the Global Administration View only.
To view all global administrators in the system
In the navigation pane, click Users > Administrators.
The Users > Administrators page appears, displaying all global administrators.

128

CTERA Portal Datacenter Edition Administrator Guide

Managing Administrators

The table includes the columns described in Viewing Staff Administrators (on page 124).

Deleting Global Administrators


This task can be performed in the Global Administration View only.
To delete a global administrator
1 Do one of the following:
In the Users > Administrators page, select the desired administrator's row, then click
Delete.
Access the Global Administrator Manager, then click Delete.
See Accessing the Global Administrator Manager (on page 126).
A confirmation message appears.
2 Click Yes.
The administrator is deleted.

Configuring an IP-Based Access Control List


You can configure an IP-based access control list, specifying the IP address ranges from which
administrators can access the CTERA Portal interface.
To configure an IP-based access control list
1 Do one of the following:
To configure an IP-based access list for the virtual portal's Staff Control Panel and/or
Administration Control Panel, in the virtual portal's navigation pane, click Users >
Staff.
The Users > Staff page appears, displaying all staff administrators.
To configure an IP-based access list for the Global Administration View, in Global
Administration View's navigation pane, click Users > Administrators.
The Users > Administrators page appears, displaying all CTERA Portal global
administrators.
2 Click Access Control.

CTERA Portal Datacenter Edition Administrator Guide

129

Managing Administrators

The IP-Based Access Control List dialog box appears.

3 Select the IP-Based Access Control check box.


The list box is enabled.

4 To add an IP address range from which access to the CTERA Portal interface is allowed, do
the following:
a Click New.

130

CTERA Portal Datacenter Edition Administrator Guide

Managing Administrators

A new row is added to the list box.

b Click in the IP Range Start field, and type the starting IP address.
c Click in the IP Range End field, and type the ending IP address.
5 To remove an IP address range, in the IP address range's row, click

The IP address range is removed.


6 Click Save.

Importing Global Administrators from a File


You can import a list of global administrators and their details from a comma separated
values (*.csv) file.
The *.csv file's columns must be in the following order:
1 Username
2 First name
3 Last name
4 Email address
5 Company (Optional)
6 Password
7 Role
8 Plan (Optional)
9 Numeric UID (Optional)

CTERA Portal Datacenter Edition Administrator Guide

131

Managing Administrators

10 External Account ID (Optional)


11 Comment (Optional)
Optional fields can be left blank.
To import administrators from a *.csv file
1 In the navigation pane, click Users > Administrators.
The Users > Administrators page appears.
2 Click Import.
The Import Administrators wizard appears.

3 Click Upload. The file is uploaded and the Import Completed screen appears.
4 Click Finish.

Customizing Administrator Roles


By default, CTERA Portal includes three built-in administrator roles:
Read/Write Administrator. The administrator has read-write permissions throughout the
CTERA Portal.
Read Only Administrator. The administrator has read-only permissions throughout the
CTERA Portal.
Support. The administrator has read/write access to devices, user accounts, folders, and
folder groups, and read-only access to all other settings in the CTERA Portal.
You can customize these roles, adding or removing permissions as desired.
To customize an administrator role
1 Do one of the following:

132

CTERA Portal Datacenter Edition Administrator Guide

Managing Administrators

To customize a role for staff administrators, in the virtual portal's navigation pane,
click Users > Roles.
The Users > Roles page appears, displaying all staff administrator roles.

To customize a role for global administrators, in Global Administration View's


navigation pane, click Users > Roles.
The Users > Roles page appears, displaying all CTERA Portal global administrator
roles.

2 Do one of the following:


Select the desired role's row and click Edit.
Click on the desired role's name.

CTERA Portal Datacenter Edition Administrator Guide

133

Managing Administrators

The Edit Role window opens.

3 Complete the fields using the information in Administrator Role Fields (page 135).
For information on the default permissions for each administrator role, see Default
Permissions per Administrator Role (page 135).
4 Click Save.

134

CTERA Portal Datacenter Edition Administrator Guide

Managing Administrators

Table 21: Administrator Role Fields


In this field...

Do this...

Super User

Select this option to give all permissions to administrators with


this role and to allow administrators with this role to use the
CTERA Portal API to perform Single Sign On on behalf of users.

Access End User Folders

Select this option to allow administrators with this role to


access end users' folders.
If this option is not selected, and an administrator with this role
attempts to access an end user's folder, the administrator will
be prompted to enter the folder owners password.

Modify User Email

Select this option to allow administrators with this role to


modify the email addresses associated with user accounts.

Modify User Password

Select this option to allow administrators with this role to


modify the passwords associated with user accounts.

Modify Portal Settings

Select this option to allow administrators with this role to


modify virtual portal settings.

Modify Roles

Select this option to allow administrators with this role to


modify administrator roles.

Allow Single Sign On to Devices

Select this option to allow administrators with this role to


remotely manage devices for which Remote Access with single
sign on (SSO) is enabled, without entering the username and
password for accessing the device.
For information on remotely managing devices, see Remotely
Managing Devices (see "Remotely Managing Devices and
Their Files" on page 180).

Table 22: Default Permissions per Administrator Role


Permission

Read/Write
Administrator

Read Only
Administrator

Support

Super User

No

No

No

Access End User Folders

Yes

Yes

No

Modify User Email

Yes

No

Yes

Modify User Password

Yes

No

Yes

Modify Portal Settings

Yes

No

No

Modify Roles

Yes

No

No

Allow SSO

No

No

No

CTERA Portal Datacenter Edition Administrator Guide

135

136

Managing Administrators

CTERA Portal Datacenter Edition Administrator Guide

7
Managing Device Configuration
Templates
CTERA Portal enables you to centrally manage device settings, by assign devices to device
configuration templates: When a device is assigned to a template, it inherits the following
settings from that template:
Backup sets and exclude sets
Backup applications (relevant for CTERA Server Agents only)
Backup schedule
Backup throughput control
Installed software and firmware versions
Automatic firmware updates
Tip

Settings inherited from a template can be overridden from the devices Web
interface.
Devices can be assigned to templates in the following ways:
Manually, by editing the device settings.
See Editing Device Settings (on page 169).
Automatic template assignment.
Devices can be assigned to templates based on the automatic template assignment
policy, which specifies a set of criteria for assigning a template (such as device type,
installed operating system, and so on), as well as an optional default template that is
assigned when none of the criteria are met.
See Configuring the Automatic Template Assignment Policy (on page 160).

CTERA Portal Datacenter Edition Administrator Guide

137

Managing Device Configuration Templates

In This Chapter
Accessing the Configuration Template Manager --------------------------------------------------------- 138
Adding and Editing Device Configuration Templates ---------------------------------------------------- 139
Viewing Device Configuration Templates ------------------------------------------------------------------ 140
Working with Backup Sets -------------------------------------------------------------------------------------- 140
Selecting Applications for Backup ---------------------------------------------------------------------------- 152
Scheduling Automatic Cloud Backup ------------------------------------------------------------------------ 153
Restricting Throughput------------------------------------------------------------------------------------------ 155
Selecting CTERA Portal Cloud Folders for Synchronization--------------------------------------------- 157
Marking a Firmware Image as the Current Firmware Image------------------------------------------- 158
Configuring Automatic Firmware Updates ----------------------------------------------------------------- 159
Configuring the Automatic Template Assignment Policy ----------------------------------------------- 160
Setting the Default Device Configuration Template ----------------------------------------------------- 163
Duplicating Configuration Templates------------------------------------------------------------------------ 164
Deleting Device Configuration Templates ------------------------------------------------------------------ 164

Accessing the Configuration Template Manager


To access the Configuration Template Manager
1 In the navigation pane, click Settings > Configuration Templates.
The Settings > Configuration Templates page appears.

2 Do one of the following:


Select the desired template's row and click Edit Template.
Click on the desired template's name.

138

CTERA Portal Datacenter Edition Administrator Guide

Managing Device Configuration Templates

The Configuration Template Manager opens displaying the General tab.

Adding and Editing Device Configuration Templates


To add or edit a device configuration template
1 In the navigation pane, click Settings > Configuration Templates.
The Settings > Configuration Templates page appears.
2 Do one of the following:
To add a new template, in the Settings > Configuration Templates page, click New
Template.
To edit an existing template, access the Configuration Template Manager.
See Accessing the Configuration Template Manager (on page 138).
The Configuration Template Manager opens displaying the General tab.
3 In the Name field, type a name for the template.
4 In the Description field, type a description of the template.
5 Click Save.

CTERA Portal Datacenter Edition Administrator Guide

139

Managing Device Configuration Templates

Viewing Device Configuration Templates


To view all device configuration templates in the portal
In the navigation pane, click Settings > Configuration Templates.
The Settings > Configuration Templates page appears, displaying all templates.
The table includes each template's name and description.

Working with Backup Sets


A backup set represents a group of files with certain file extensions and/or located in certain
folders. For example, a set called "My Music" may include all files with the extensions *.wav
and *.mp3 that are located in the folder My Documents > Music.
There are two types of backup sets:
Included sets. Files that should be included in each backup
Excluded sets. Files that should be excluded from each backup
You can use backup sets to fully customize backup operations. For example, if you did not
select the My Documents folder for backup, but you want to back up all of the PDF files in
this folder, you would define an included set that includes all files that are located in the My
Documents folder and have the file extension *.pdf. Conversely, if you selected the My
Documents folder for backup, but you do not want to back up PDF files in this folder, you
would define an excluded set that includes all files that are located in the My Documents
folder and have the file extension *.pdf.
Tip

For information on the order in which the CTERA Portal processes included sets,
excluded sets, and selected folders, see How Can I Control the Scope of Backup
Operations?.

140

CTERA Portal Datacenter Edition Administrator Guide

Managing Device Configuration Templates

Enabling/Disabling Included Sets


In order for an included set to be used during backup operations, it must be enabled.
To enable an included set
1 In the Configuration Template Manager, click Backup Sets.
The Backup Sets tab appears.

2 Next to the desired included set, in the Enabled column, select the check box.
The included set is enabled.
3 Click Save.
To disable an included set
1 In the Configuration Template Manager, click Backup Sets.
The Backup Sets tab appears.
2 Next to the desired included set, in the Enabled column, clear the check box.
The included set is disabled.
3 Click Save.

CTERA Portal Datacenter Edition Administrator Guide

141

Managing Device Configuration Templates

Adding and Editing Included Sets


To add or edit an included set
1 In the Configuration Template Manager, click Backup Sets.
The Backup Sets tab appears.
2 Do one of the following:
To add a new included set, click New.
To edit an existing included set, click on its name.
The Backup Set Details Wizard opens, displaying the Backup Set Details dialog box.

3 In the Backup Set Name field, type the name of the backup set.
4 In the Comment field, type a description of the backup set.
5 In the If field, do one of the following:
To specify that all of the conditions must be met in order for a file to be included in
the backup set, select all of the conditions are true.
To specify that one or more of the conditions must be met in order for a file to be
included in the backup set, select at least one of the conditions is true.
6 Define the desired conditions for a file to be included in the backup set, by doing the
following for each condition:
a Click Add condition.

142

CTERA Portal Datacenter Edition Administrator Guide

Managing Device Configuration Templates

A row appears in the table.

b Click Select, then select the desired condition parameter from the drop-down list.
c In the second column, click Select, then select the desired condition operator from
the drop-down list.
See Backup Set Condition Operators (page 146).
d Click in the third column, and complete the condition:
If the parameter is File Size, type the desired file size and unit.
If the parameter is File Modified, click

and choose the desired date.

For all other parameters, type the desired free-text value.


For example, if you select File Name as the condition parameter in the first column, select
begins with as the condition operator in the second column, and type "Work-123-" in the
third column, then the backup set will include all files whose names begin with
"Work-123-".
Likewise, if you select File Type as the condition parameter in the first column, select is
one of with as the condition operator in the second column, and type "avi, mov, mpg" in
the third column, then the backup set will include all files with the extension *.avi, *.mov,
and *.mpg.
7 To delete a condition, click

in its row.

8 Click Next.

CTERA Portal Datacenter Edition Administrator Guide

143

Managing Device Configuration Templates

The Select Files or Folders dialog box appears.

9 Specify the files and folders to which this backup set applies, by doing the following for
each file/folder:
a Click Add a file or folder.
A row is added to the table.

b Click in the row, and do one of the following:


Type a variable's name in the field.
Select a variable from the drop-down list.

144

CTERA Portal Datacenter Edition Administrator Guide

Managing Device Configuration Templates

You can use any operating system environment variable defined on the Windows or
Linux machine, for the user account on which the CTERA service is running. If the
specified environment variable is not defined on the machine, this row in the policy is
ignored. In addition, a set of CTERA-specific environment variables can be used. For a
list of supported variables of all types, see Backup Set Environment Variables (page
147).
Wildcards are supported. For example, you can type "$USERS/*/MyFolder" to back up
the MyFolder folder under all users' home directories.
For UNIX/Windows interoperability, backup sets support the use of both slashes and
backslashes. Any slashes or backslashes will be automatically converted to the type
supported by the machine's OS.
When you specify a folder name, all of the files and subfolders in it are automatically
included, and there is therefore no need to add \* at the end of the folder name.
10 Click Next.
The Done screen appears.

11 Click Finish.
12 Click Save.

CTERA Portal Datacenter Edition Administrator Guide

145

Managing Device Configuration Templates

Table 23: Backup Set Condition Operators


Use this operator...

To do this...

equals

Include all files for which the parameter in the first column
matches the string in the third column.
This operator is relevant for the File Name, File Path, and File
Type parameters only.

begins with

Include all files for which the parameter in the first column
begins with the string in the third column.
This operator is relevant for the File Name, File Path, and File
Type parameters only.

ends with

Include all files for which the parameter in the first column ends
with the string in the third column.
This operator is relevant for the File Name, File Path, and File
Type parameters only.

contains

Include all files for which the parameter in the first column
contains the string in the third column.
This operator is relevant for the File Name, File Path, and File
Type parameters only.

is one of

Include all files for which the parameter in the first column is
included in the set specified in the third column.
This operator is relevant for the File Name, File Path, and File
Type parameters only.

less than

Include all files whose size is less than the amount specified in
the third column.
This operator is relevant for the File Size parameter only.

more than

Include all files whose size is more than the amount specified in
the third column.
This operator is relevant for the File Size parameter only.

before

Include all files whose last modification date is before the date
specified in the third column.
This operator is relevant for the File Modified parameter only.

after

Include all files whose last modification date is after the date
specified in the third column.
This operator is relevant for the File Modified parameter only.

146

CTERA Portal Datacenter Edition Administrator Guide

Managing Device Configuration Templates

Table 24: Backup Set Environment Variables


Use this variable...

To specify this...

Common OS Variables

Common operating system variables.

$ALLUSERSPROFILE

The Windows "All Users" profile directory.

$WINDIR

The Windows directory.

$TEMP

The Windows temporary files directory.

$SYSTEMDRIVE

The Windows system drive.

$PROGRAMFILES

The Windows Program Files directory.

User-specific Windows

Variables that are executed separately for each user in the

Environment Variables

system.

$APPDATA

The path to the application data directory. For example:


C:\Documents and
Settings\username\Application Data, where
username is the user's username.

$USERPROFILE

The path to the user profile directory. For example:


C:\Documents and Settings\username, where
username is the user's username.

CTERA Appliance Template

Variables that are defined for CTERA appliances.

Variables
$USERS

The home directories folder on the CTERA appliance.

$AGENTS

The CTERA Agents folder on the CTERA appliance.

$SYNCS

The "Clientless Backup" destination folder on the CTERA


appliance.

$PROJECTS

The projects folder on the CTERA appliance.

$PRIMARYUSER

The profile folder of the local user who connected the CTERA
Agent to the CTERA Portal or appliance.
For example, if the local user who connected the agent to the
portal is "JohnSmith", then $PRIMARYUSER will refer to
C:\Users\JohnSmith.
This variable is relevant for the CTERA Windows Agent only.

CTERA Portal Datacenter Edition Administrator Guide

147

Managing Device Configuration Templates

Deleting Included Sets


To delete an included set
1 In the Configuration Template Manager, click Backup Sets.
The Backup Sets tab appears.
2 Select the desired included set's name and click Delete.
A confirmation message appears.
3 Click Yes.
The included set is deleted.
4 Click Save.

Enabling/Disabling Excluded Sets


In order for an excluded set to be used during backup operations, it must be enabled.
To enable an excluded set
1 In the Configuration Template Manager, click Exclude Sets.
The Exclude Sets tab appears.

2 Next to the desired excluded set, in the Enabled column, select the check box.

148

CTERA Portal Datacenter Edition Administrator Guide

Managing Device Configuration Templates

The excluded set is enabled.


3 Click Save.
To disable an excluded set
1 In the Configuration Template Manager, click Exclude Sets.
The Exclude Sets tab appears.
2 Next to the desired excluded set, in the Enabled column, clear the check box.
The excluded set is disabled.
3 Click Save.

Adding and Editing Excluded Sets


To add or edit an excluded set
1 In the Configuration Template Manager, click Exclude Sets.
The Exclude Sets tab appears.
2 Do one of the following:
To add a new excluded set, click New.
To edit an existing excluded set, click on its name.
The Backup Set Details Wizard opens, displaying the Backup Set Details dialog box.
3 In the Backup Set Name field, type the name of the backup set.
4 In the Comment field, type a description of the backup set.
5 In the If field, do one of the following:
To specify that all of the conditions must be met in order for a file to be included in
the backup set, select all of the conditions are true.
To specify that one or more of the conditions must be met in order for a file to be
included in the backup set, select at least one of the conditions is true.
6 Define the conditions that must be met in order for a file to be included in the backup set,
by doing the following for each condition:
a Click Add condition.
A row appears in the table.
b Click Select, then select the desired condition parameter from the drop-down list.
c In the second column, click Select, then select the desired condition operator from
the drop-down list.
See Backup Set Condition Operators (page 146).

CTERA Portal Datacenter Edition Administrator Guide

149

Managing Device Configuration Templates

d Click in the third column, and complete the condition:


If the parameter is File Size, type the desired file size and unit.
If the parameter is File Modified, click

and choose the desired date.

For all other parameters, type the desired free-text value.


For example, if you select File Name as the condition parameter in the first column, select
begins with as the condition operator in the second column, and type "Work-123-" in the
third column, then the backup set will include all files whose names begin with
"Work-123-".
Likewise, if you select File Type as the condition parameter in the first column, select is
one of with as the condition operator in the second column, and type "avi, mov, mpg" in
the third column, then the backup set will include all files with the extension *.avi, *.mov,
and *.mpg.
7 To delete a condition, click

in its row.

8 Click Next.
The Select Files or Folders dialog box appears.
9 Specify the files and folders to which this backup set applies, by doing the following for
each file/folder:
a Click Add a file or folder.
A row is added to the table.
b Click in the row, and do one of the following:
Type a variable's name in the field.
Select a variable from the drop-down list.
You can use any operating system environment variable defined on the Windows or
Linux machine, for the user account on which the CTERA service is running. If the
specified environment variable is not defined on the machine, this row in the policy is
ignored. In addition, a set of CTERA-specific environment variables can be used. For a
list of supported variables of all types, see Backup Set Environment Variables (page
147).
Wildcards are supported. For example, you can type "$USERS/*/MyFolder" to back up
the MyFolder folder under all users' home directories.
For UNIX/Windows interoperability, backup sets support the use of both slashes and
backslashes. Any slashes or backslashes will be automatically converted to the type
supported by the machine's OS.

150

CTERA Portal Datacenter Edition Administrator Guide

Managing Device Configuration Templates

When you specify a folder name, all of the files and subfolders in it are automatically
included, and there is therefore no need to add \* at the end of the folder name.
10 Click Next.
The Done screen appears.
11 Click Finish.
12 Click Save.

Deleting Excluded Sets


To delete an excluded set
1 In the Configuration Template Manager, click Exclude Sets.
The Exclude Sets tab appears.
2 Select the desired excluded set's name and click Delete.
A confirmation message appears.
3 Click Yes.
The excluded set is deleted.
4 Click Save.

CTERA Portal Datacenter Edition Administrator Guide

151

Managing Device Configuration Templates

Selecting Applications for Backup


Tip

If a selected application is not installed on the target device, it will be ignored.


To select applications for backup
1 In the Configuration Template Manager, click Applications.
The Applications tab appears.

2 Do one of the following:


To manage these settings for all devices assigned to the template, click Manage.
To enable management of these settings in the devices' local administration interface,
click Don't Manage.
3 Expand the tree nodes and select the check boxes next to the applications you want to
back up.
4 Click Save.

152

CTERA Portal Datacenter Edition Administrator Guide

Managing Device Configuration Templates

Scheduling Automatic Cloud Backup


To schedule automatic cloud backup
1 In the Configuration Template Manager, click Backup Schedule.
The Backup Schedule tab appears.

2 Do one of the following:


To manage these settings for all devices assigned to the template, click Manage.
To enable management of these settings in the devices' local administration interface,
click Don't Manage.
3 Complete the fields using the information in the following table.
4 Click Save.

CTERA Portal Datacenter Edition Administrator Guide

153

Managing Device Configuration Templates

Table 25: Backup Schedule Fields


In this field...

Do this...

Periodically

Choose this option to automatically back up files every specified


number of hours.
The Start Every field is enabled, and you must complete it.

Start Every

Type the amount of time between automatic cloud backups, in


hours.
The default value is 24 hours.

Specific Time

Choose this option to automatically back up files according to a


specified daily schedule.
The Start Time, Stop Time, and On Days fields are enabled, and
you must complete them.

Start Time

Select the time at which cloud backup should start.


Note: If a given backup extends past the scheduled time for the
next automatic backup, the next automatic backup will
commence immediately upon completion of the prior backup.

Stop Time

Select the time at which cloud backup must end. This can be
any of the following:
A specific hour
On Completion. The backup operation will only end when
cloud backup is complete.
The default value is On Completion.
Note: If the amount of changed data to back up is large, the
backup process can take several hours or days. Therefore, if a
stop time is configured, the backup process may not be
completed within the time frame. For example, if you specify
that data should be backed up between 12 AM - 2 AM, and the
backup requires 3 hours, the backup will not be completed.

On Days

Select the days on which cloud backup should be performed.


This can be any of the following:
One or more specific days
Every Day. Cloud backup will occur every day.
The default value is Every Day.

154

CTERA Portal Datacenter Edition Administrator Guide

Managing Device Configuration Templates

Restricting Throughput
If desired, you can restrict the amount of bandwidth used for backing up files online.
To restrict throughput
1 In the Configuration Template Manager, click Backup Throughput.
The Backup Throughput tab appears.

2 Do one of the following:


To manage these settings for all devices assigned to the template, click Manage.
To enable management of these settings in the devices' local administration interface,
click Don't Manage.
3 Complete the fields using the information in the following table.
4 Click Save.

CTERA Portal Datacenter Edition Administrator Guide

155

Managing Device Configuration Templates

Table 26: Throughput Fields


In this field...

Do this...

Do not throttle

Choose this option to specify that throughput should not be


restricted.

Throttle the Internet bandwidth

Choose this option to restrict the bandwidth used for cloud

usage

backups.
The rest of the fields on the page are enabled, and you must
complete them.

Limit outgoing bandwidth to

Type the maximum bandwidth to use for cloud backups in


kilobytes per second.

During these hours

Select this option to specify that the bandwidth used for cloud
backups should be restricted only at specific times of the day.
Then use the drop-down lists to specify the time range during
which the bandwidth should be restricted.

On Days

Select to specify that the bandwidth used for cloud backups


should be restricted only on specific days. This can be any of
the following:
One or more specific days
Every Day. Bandwidth used for cloud backup will be
restricted every day.
The default value is Every Day.

156

CTERA Portal Datacenter Edition Administrator Guide

Managing Device Configuration Templates

Selecting CTERA Portal Cloud Folders for Synchronization


You can specify which portal cloud folders should be synchronized with the device.
To select the CTERA Portal cloud folders for synchronization
1 In the Configuration Template Manager, click Backup Cloud Drive.
The Backup Cloud Drive tab appears.

2 Do one of the following:


To manage these settings for all devices assigned to the template, click Manage.
To enable management of these settings in the devices' local administration interface,
click Don't Manage.
3 Expand the tree nodes and select the check boxes next to the portal cloud folders to
synchronize with the device.
4 Click Save.

CTERA Portal Datacenter Edition Administrator Guide

157

Managing Device Configuration Templates

Marking a Firmware Image as the Current Firmware Image


When you mark a firmware image as the current firmware image, all devices that are of the
relevant device platform, assigned to this template, and set to automatically download
firmware images will download this firmware image.
There can only be one current firmware image per device platform.
To mark a firmware image as the current firmware image
1 In the Configuration Template Manager, click Software Updates.
The Software Updates tab appears, displaying all firmware images.

2 Do one of the following:


To override global settings, click Override.
To revert to global settings, click Use global settings.
3 Select the desired firmware image's row.
4 Click Mark as Current.
The selected firmware image becomes the current firmware image and is marked with
the

158

icon.

CTERA Portal Datacenter Edition Administrator Guide

Managing Device Configuration Templates

5 Click Save.

Configuring Automatic Firmware Updates


If desired, you can configure your devices to automatically download and install firmware
updates.
To configure automatic firmware updates
1 In the Configuration Template Manager, click Backup Update Schedule.
The Backup Update Schedule tab appears.

2 Do one of the following:


To manage these settings for all devices assigned to the template, click Manage.
To enable management of these settings in the devices' local administration interface,
click Don't Manage.
3 Complete the fields using the information in the following table.
4 Click Save.

CTERA Portal Datacenter Edition Administrator Guide

159

Managing Device Configuration Templates

Table 27: Automatic Update Schedule Fields


In this field...

Do this...

Download and install updates

Select this option to specify that devices should download and

automatically

install firmware updates automatically.


If you do not select this option, device owners must perform
firmware updates manually.

Restart appliances automatically

Select this option to specify that devices should automatically

after installing new firmware

reboot after installing new firmware updates.


The remaining fields are enabled.

As soon as possible

Choose this option to specify that automatic rebooting should


occur as soon as possible after a firmware update.

During these hours

Select this option to specify that automatic rebooting should


occur only at specific times of the day.
Then use the drop-down lists to specify the time range during
which rebooting should occur.

On Days

Select the days on which automatic rebooting should occur.


This can be any of the following:
One or more specific days
Every Day. Automatic rebooting will occur every day.
The default value is Every Day.

Configuring the Automatic Template Assignment Policy


To configure the automatic template assignment policy
1 In the navigation pane, click Settings > Configuration Templates.
The Settings > Configuration Templates page appears, displaying all templates.
2 Click Auto Assign.

160

CTERA Portal Datacenter Edition Administrator Guide

Managing Device Configuration Templates

The Automatic Template Assignment window opens.

3 Define the desired conditions for a device to be assigned to a template, by doing the
following for each condition:
a Click Add condition.
A row appears in the table.

b Click Select, then select the desired condition parameter from the drop-down list.
c In the second column, click Select, then select the desired condition operator from
the drop-down list.
See Automatic Template Assignment Policy Condition Operators (page 163).

CTERA Portal Datacenter Edition Administrator Guide

161

Managing Device Configuration Templates

d Click in the third column, and complete the condition, by typing the desired free-text
value.
Multiple values must be separated by commas.
For example, if you select Installed Version as the condition parameter in the first
column, select equals with as the condition operator in the second column, and type
"3.0" in the third column, then the condition will be met when the device's installed
firmware version is 3.0.
Another example: If you select Owner Groups as the condition parameter in the first
column, select includes one of as the condition operator in the second column, and
type "groupA, groupB" in the third column, then the condition will be met when the
device owner's user account belongs to user group "groupA" or user group "groupB".
e Click in the Then apply column, and select the template that should be assigned when
the condition is met.
4 To delete a condition, click

in its row.

5 To specify that the policy should include a default device configuration template, do the
following:
a Select the If no match, apply default template check box.
b In the If no match, apply default template drop-down list, select the template to
apply when none of the conditions are met.
6 Click Save.

162

CTERA Portal Datacenter Edition Administrator Guide

Managing Device Configuration Templates

Table 28: Automatic Template Assignment Policy Condition Operators


Use this operator...

To do this...

equals

Include all files for which the parameter in the first column
matches the string in the third column.

begins with

Include all files for which the parameter in the first column
begins with the string in the third column.

ends with

Include all files for which the parameter in the first column ends
with the string in the third column.

contains

Include all files for which the parameter in the first column
contains the string in the third column.

is one of

Include all files for which the parameter in the first column is
included in the set specified in the third column.

includes one of

Include all files for which the parameter in the first column
includes at least one of the comma-delimited set specified in
the third column.

Setting the Default Device Configuration Template


Tip

You can also set the default device configuration template as part of an automatic
template assignment policy. See Configuring the Automatic Template
Assignment Policy (on page 160).
To set a device configuration template as the default
1 In the navigation pane, click Settings > Configuration Templates.
The Settings > Configuration Templates page appears, displaying all templates.
2 Select the desired template's row.
3 Click Set Default.
The selected template is marked with the

icon.

To set no default device configuration template


1 In the navigation pane, click Settings > Configuration Templates.
The Settings > Configuration Templates page appears, displaying all templates.
2 Click Remove Default.
No default template is configured.

CTERA Portal Datacenter Edition Administrator Guide

163

Managing Device Configuration Templates

Duplicating Configuration Templates


You can create a duplicate of an existing configuration template, then edit it as desired. All
settings, except for the template name and description, are copied from the original
template.
To duplicate a configuration template
1 In the navigation pane, click Settings > Configuration Templates.
The Settings > Configuration Templates page appears, displaying all templates.
2 Select the desired template's row.
3 Click Duplicate.
The Configuration Template Manager opens displaying the General tab.
4 In the Name field, type a name for the new template.
5 In the Description field, type a description of the new template.
6 Click Save.

Deleting Device Configuration Templates


When a device configuration template is deleted from the CTERA Portal, the automatic
template assignment policy rules that specify that template are automatically deleted. The
policy is then reapplied to all devices that specify automatic template assignment.
Tip

When deleting device configuration templates, the following restrictions apply:


You may not delete a template that is manually assigned to a device.
You may not delete the default template.

To delete a device configuration template


1 Do one of the following:
In the Settings > Configuration Templates page, select the desired template's row,
then click Delete Template.
Access the Configuration Template Manager, then click Delete.
See Accessing the Configuration Template Manager (on page 138).
A confirmation message appears.
2 Click Yes.
The template is deleted.

164

CTERA Portal Datacenter Edition Administrator Guide

Managing Device Configuration Templates

CTERA Portal Datacenter Edition Administrator Guide

165

8
Managing Devices
The word device refers to both CTERA appliances and CTERA Agents that are connected to the
CTERA Portal. Devices are automatically added to the CTERA Portal, when their owners
connect their CTERA appliances or CTERA Agents to the CTERA Portal.
This chapter explains how to manage the devices belonging to an individual virtual portal, as
well as how to manage all of the devices in the CTERA Portal system from the Global
Administration View.

In This Chapter
Accessing the Device Manager -------------------------------------------------------------------------------- 168
Editing Device Settings ------------------------------------------------------------------------------------------ 169
Viewing Devices --------------------------------------------------------------------------------------------------- 171
Remotely Managing Devices and Their Files --------------------------------------------------------------- 180
Remotely Performing Cloud Backup Operations on Devices ------------------------------------------ 180
Exporting Devices to Excel-------------------------------------------------------------------------------------- 182
Deleting Devices -------------------------------------------------------------------------------------------------- 182

CTERA Portal Datacenter Edition Administrator Guide

167

Managing Devices

Accessing the Device Manager


Most tasks related to managing a device are performed in the Device Manager.
To access the Device Manager
1 In the navigation pane, click Main > Devices.
The Main > Devices page appears, displaying all devices that are managed by the CTERA
Portal.

2 Do one of the following:


Select the desired device's row and click Edit Device.
Click on the desired device's name.

168

CTERA Portal Datacenter Edition Administrator Guide

Managing Devices

The Device Manager opens displaying the status tab.

Editing Device Settings


You can edit the following device settings:
Device name
When a CTERA device is first connected to the CTERA Portal, it is assigned a name based
on the owner's user name, by default. For example, if John Smith's user name is JohnS,
and he adds two devices, the first device will be named JohnS, and the second will be
named JohnS1. If desired, you can edit a device's name.
Template
You can specify whether the device should inherit its settings from a device configuration
template. For information on device configuration templates, see Managing Device
Configuration Templates (on page 137).
Backup folder
If desired, you can change the folder used for the device's backups. This is useful, for
example, if an old device has failed, and you want to restore the old device's backup to a
new device. To do so, delete the old device, then assign the old device's backup folder to
the new device.

CTERA Portal Datacenter Edition Administrator Guide

169

Managing Devices

Software version
You can install a specific firmware on the device.
To edit a device
1 Access the Device Manager.
See Accessing the Device Manager (on page 168).
2 Click the Settings tab.
The Settings tab appears.

3 Complete the fields using the information in the following table.


4 Click Save.

170

CTERA Portal Datacenter Edition Administrator Guide

Managing Devices

Table 29: Device Manager Settings Fields


In this field...

Do this...

Name

Type a new name for the device.

Template

Specify which template to use for the device, by selecting one


of the following:
A specific template
No Template. Do not use a template for this device.
Automatic. Automatically assign a template to this device,
based on the configured automatic template assignment
policy. See Configuring Automatic Template Assignment
(see "Configuring the Automatic Template Assignment
Policy" on page 160).
The default value is Automatic.

Backup Folder

Check/uncheck the box to enable or disable backup operations


for the device.
In the dropdown list, select a specific folder in which all of the
device's backups should be stored.

Software version

Specify which firmware to use for this device, by selecting one


of the following:
A specific firmware
Use Default. Use the default firmware for this device type.

Viewing Devices
The CTERA Portal enables you to view information on all devices, as well as detailed
information on individual devices.

Viewing All Devices


To view all devices in the portal
In the navigation pane, click Main > Devices.
The Main > Devices page appears, displaying all devices.
The table includes the following columns.

CTERA Portal Datacenter Edition Administrator Guide

171

Managing Devices

Table 30: Devices Fields


This field...

Displays...

Name

The device's name.


To edit the device or view its details, click the device name. For
further details, see Editing Device Settings (on page 169) and
Viewing Individual Devices (see "Viewing Individual Devices'
Statuses" on page 173).

Backup Folder

The device's backup folder.


To edit the folder, click the folder name. For further details, see
Adding and Editing Folders (on page 188).

Owner

The user account name of the device's owner.


To edit the user account, click the user account name. For further
details, see Adding and Editing User Accounts (on page 75).
Note: When viewing devices in the User Account Manager, this
column does not appear.

Template

The template assigned to the device.

Type

The device type.

Last Backup

The amount of time that has elapsed since the device's last backup
operation, in hours and minutes.

Status

The device's connection status. This can be either of the following:


Connected
Not Connected

Portal

The virtual portal in which the device is defined.


The field only appears when managing devices in the Global
Administration View.

Running Version

The firmware version currently installed on the device.

Configured Version

The firmware version that the device is configured to download and


install.
Note: Once the device has downloaded and installed the configured
firmware successfully, the running firmware will be the same as the
configured firmware.

Location

The device's location.

Activation

The device's activation status. This can be either of the following:


OK. The device has been activated.
Pending. The device is pending activation.

172

CTERA Portal Datacenter Edition Administrator Guide

Managing Devices

Viewing Individual Devices' Statuses


To view an individual device's status
Access the Device Manager.
See Accessing the Device Manager (on page 168).
The device's connection status is displayed at the top of the screen (Connected / Not
Connected).
The following information is displayed:

CTERA Portal Datacenter Edition Administrator Guide

173

Managing Devices

Table 31: Status Tab Fields


This field...

Displays...

Owner

The full name of the device's owner.


When editing an existing device, you can click on the owner's name
to open the User Account Manager and manage the owner's user
account. For information on managing user accounts, see Managing
User Accounts (on page 73).

Type

The device type.

Running Version

The firmware version currently installed on the device.

Configured Version

The firmware version that the device is configured to download and


install.
Note: Once the device has downloaded and installed the configured
firmware successfully, the running firmware will be the same as the
configured firmware.

Connection

The connection duration in hours and minutes.

Host Name

The device's host name.

MAC Address

The device's MAC address.

IP Address

The device's IP address.

Operating System

The operating system on which the device is installed.


This field is only relevant if the device is a CTERA Agent.

Licensing Status

The device's licensing status (Ok or Unlicensed).


This field is only relevant if the device is a CTERA Agent.

Server Agents Licensing

This area displays information about CTERA Server Agent licensing


for the device. It only appears if the device is a CTERA appliance.

Agents on this device

The number of server agents installed for the device.

Device License

The number of server agent licenses taken from the licenses included
with the device.

From Portal

The number of server agent licenses taken from the quota allocated
to the device owner's CTERA Portal account.

Workstation Backup

This area displays information about CTERA Workstation Backup

Licensing

licensing for the device. It only appears if the device is a CTERA


appliance.

Agents on this device

The number of workstation agents installed for the device.

Device License

The number of workstation agent licenses taken from the licenses


included with the device.

174

CTERA Portal Datacenter Edition Administrator Guide

Managing Devices

From Portal

The number of workstation agent licenses taken from the quota


allocated to the device owner's CTERA Portal account.

Viewing Individual Devices' Backup Status


Tip

Backup status can only be viewed if the device is connected.


To view an individual device's backup status
1 Access the Device Manager.
See Accessing the Device Manager (on page 168).
2 Click the backup tab.
The backup tab appears.

The following information is displayed:

CTERA Portal Datacenter Edition Administrator Guide

175

Managing Devices

Table 32: Backup Tab Fields


This field...

Displays...

Next backup will run in

The amount of time until the next scheduled automatic backup.

The last backup result

The status of the last backup:


Completed successfully
Backup in Progress
The last backup has failed, followed by the reason it failed
If an error occurred during backup, refer to the backup logs for
details. See Viewing Cloud Backup Logs (on page 364).
Mouse-over this icon to view the following information about the last
backup:
The total size of the files that you selected for backup
The total number of files that you selected for backup
The amount of time the backup took
The amount of time since the last backup ended.

Viewing Individual Appliances' Storage Status


Tip

Storage status only appears if the device is a CTERA appliance and connected. It
does not appear if the device is an agent.
To view an individual appliance's storage status
1 Access the Device Manager.
See Accessing the Device Manager (on page 168).
2 Click the storage tab.

176

CTERA Portal Datacenter Edition Administrator Guide

Managing Devices

The storage tab appears.

The following information is displayed:

CTERA Portal Datacenter Edition Administrator Guide

177

Managing Devices

Table 33: Storage Tab Fields


This field...

Displays...

Hard Disk Drives

All disk drives installed on the device.


For each drive, the following information is displayed:
The disk model
The disk size in GB
The name of any array to which the disk belongs, if applicable
The disk status. For a list of possible statuses, see Hard Drive
Statuses (page 178).

Arrays

All arrays defined on the device.


For each array, the following information is displayed:
The array name
The array size in GB
The array status. For a list of possible statuses, see Array Statuses.

Volumes

All volumes defined on the device.


For each volume, the following information is displayed:
The volume name and the storage device on which it is located.
A bar representing of the percentage of the volume currently in use,
followed by the volume size in GB, followed by the percentage of
the volume currently in use.
The volume's status in the format: Mode [Status].
The mode can be Online or Offline. For a list of possible statuses,
see Volume Statuses (page 179).

Table 34: Hard Drive Statuses


This status...

Indicates...

Synchronized

This drive is in a RAID array and is in optimal condition.

OK

The drive is not in a RAID array and is in optimal condition.

FAIL

The hard drive has failed.

Unrecognized

The hard drive contains unrecognized data. You must format the hard
drive before it can be used.

178

Inactive

This drive is in a RAID array, but is currently not in use.

Rebuilding

This drive is in a RAID array that is currently being rebuilt.

In Use

The drive is currently in use.

CTERA Portal Datacenter Edition Administrator Guide

Managing Devices

Table 35: Array Statuses


This status...

Indicates...

Optimal

The array is in optimal condition.

Degraded

The array is accessible and there is no data loss; however, the array type
is RAID1 (Mirroring), and a disk is failed or missing. Performance and
reliability may be reduced. Replace the failed drive as soon as possible.

Fail

The array is not accessible.

Recovering

A degraded array is being repaired. The appliance is currently


synchronizing out-of-sync members of the array, and performance of
the appliance may be reduced. Once the recovery is finished, the array
will return to optimal state.

Scrubbing

Data scrubbing is in progress.

Table 36: Volume Statuses


This status...

Indicates...

Key required

The volume is encrypted and requires a key.

Contains errors

The file system needs to be repaired.

Read only

The file system is incompatible with current firmware.

Corrupted

Failed to read the file system status.

Unknown

No file system was found in the volume.

Ready

The volume is ready for use.

Recovering

The file system is being recovered after a non-clean shutdown.

Mounting

Routine cleanup is being performed after a non-clean shutdown.

Formatting

The volume is being formatted.

Converting

The volume is being converted (from EXT3 to NEXT3, or the opposite).

Resizing

The volume is being resized.

Repairing

The volume is being repaired.

Checking

The volume is being scanned for errors.

Checking Quota

The volume's storage quotas are being recalculated.

CTERA Portal Datacenter Edition Administrator Guide

179

Managing Devices

Remotely Managing Devices and Their Files


You can remotely access a device and the files on it, when the following conditions are met:
A device administrator has enabled remote administration for the device.
A device administrator has assigned you a user name and password for accessing the
device.
To remotely manage a device and its files
1 Access the Device Manager.
See Accessing the Device Manager (on page 168).
2 Click Access Device.
The following things happen:
If Single Sign On is disabled, the Log In window appears.
In the fields provided, type your user name and password for accessing this device,
then click Log In.
The device's management Web interface appears displaying the Configuration tab.
Tip

To use Single Sign On from the Portal to the device, your administrator role must
include Allow SSO permissions (see Default Permissions per Administrator Role
(page 135)), and Allow single sign on from CTERA Portal must be enabled in the
device's Remote Access settings.
In this tab, you can manage device settings. For information, refer to the device's User
Guide.
1 To manage the files on the device, click the Files tab.
The File Manager appears. For information using on this tab, refer to the device's User
Guide.
2 To manage CTERA Agents associated with the device, click the My Computers tab.
The My Computers tab appears. For information using on this tab, refer to the device's
User Guide.

Remotely Performing Cloud Backup Operations on Devices


You can start, stop, suspend, or resume cloud backup directly from the Device Manager,
without logging into the remote device.

180

CTERA Portal Datacenter Edition Administrator Guide

Managing Devices

Manually Starting Cloud Backup


You can manually start cloud backup at any time.
To manually start cloud backup
1 Access the Device Manager.
See Accessing the Device Manager (on page 168).
2 Click the backup tab.
The backup tab appears.
3 Click Backup Now.
A progress bar appears, and the files are backed up to cloud storage.
A success message appears.

Canceling the Current Cloud Backup


You can cancel a running cloud backup.
Tip

Only the current backup will be cancelled. The next automatic backup will occur
as scheduled.
To cancel the current cloud backup
1 Access the Device Manager.
See Accessing the Device Manager (on page 168).
2 Click the backup tab.
The backup tab appears.
3 Click Cancel.
The current backup is canceled.

Suspending the Cloud Backup Service


You can suspend the CTERA Cloud Backup service, including:
The currently running backup
All scheduled automatic backup
To suspend the CTERA Cloud Backup service
1 Access the Device Manager.
See Accessing the Device Manager (on page 168).
2 Click the backup tab.

CTERA Portal Datacenter Edition Administrator Guide

181

Managing Devices

The backup tab appears.


3 Click Suspend.
If a backup is currently running, it is paused. All future automatic backups are suspended.
A message appears, indicating that backup has been suspended.

Resuming the Cloud Backup Service


If the CTERA Cloud Backup service is suspended, you can unsuspend it.
To resume the CTERA Cloud Backup service
1 Access the Device Manager.
See Accessing the Device Manager (on page 168).
2 Click the backup tab.
The backup tab appears.
3 Click Unsuspend.
If a backup was running at the time when backups were suspended, that backup is
resumed.
Otherwise, cloud backup will occur at the next scheduled time.

Exporting Devices to Excel


You can export a list of devices and their details to a Microsoft Excel (*.xls) file on your
computer.
To export devices to Excel
1 In the navigation pane, click Main > Devices.
The Main > Devices page appears, displaying all devices.
2 Click Export to Excel.
The devices are exported.

Deleting Devices
To delete a device
1 Do one of the following:
In the Main > Devices page, select the desired device's row, then click Delete Device.
Access the Device Manager, then click Delete.

182

CTERA Portal Datacenter Edition Administrator Guide

Managing Devices

See Accessing the Device Manager (on page 168).


A confirmation message appears.
2 Do one of the following:
To delete the device including its backup folders, click Delete device including
associated folders.
To delete the device only, click Delete device only.
The device is deleted and disconnected from the CTERA Portal.
If you chose to delete backup folders, the folders are deleted from the CTERA Portal, as
well.

CTERA Portal Datacenter Edition Administrator Guide

183

9
Managing Folders and Folder
Groups
CTERA Portal has three types of cloud folders: backup folders, home folders and projects.
Backup folders are part of the Cloud Backup service. When a user backs up a device, a backup
folder is automatically created in the CTERA Portal, to contain the device's backups.
Home folders and projects are part of the Cloud Drive service, and are collectively called
Cloud Drive folders. A home folder is automatically created when a user account having the
Cloud Drive service is created in the CTERA Portal, to contain the user account's private files.
The folder appears to the user as "myfiles" and is the user's home folder, and it contains
files that can only be viewed and edited by the user.
For each team portal with Cloud Drive service, a project called "public" is automatically
created when the portal is created. By default, this folder has read/write permission for all
users. In addition, any number of project folders can be defined by the users of the portal.
CTERA Portal organizes cloud folders in folder groups, each of which acts as a de-duplication
realm. When files are written to a folder in a folder group, the files' content is compared to
data already stored in other folders in the folder group. Only the data that differs from
existing data in the other folders is stored in the folder group. In other words, similar data will
only be stored once. This accelerates the file transfer, and saves storage space.
De-duplication is configured separately for backup folders and Cloud Drive folders, and is
available at the following levels:
User
If cooperative de-duplication is enabled at the user account level for backup/cloud
folders, then a single folder group is created for each user account, containing all of the
user account's backup/cloud folders. De-duplication is performed for the user account's
folder group. Therefore, if a user owns multiple devices, and the devices back up similar
data, the similar data will only be stored once.
Folder
If cooperative de-duplication is enabled at the folder level for backup/cloud folders, then
a folder group is created for each of a user account's devices, containing all of the device's
backup/cloud folders. De-duplication is performed separately for each of the user
account's folder groups.
Portal

CTERA Portal Datacenter Edition Administrator Guide

185

Managing Folders and Folder Groups

In a team portal, cooperative de-duplication can be enabled at the portal level as well. In
this case, a single folder group is shared by all user accounts in the portal. The folder
group acts as a de-duplication realm that spans the entire portal. In other words, if
different users' devices back up similar data, the similar data will only be stored once.
Tip

All folders in a folder group must use the same encryption key and passphrase.
For information on configuring global default cooperative de-duplication levels for all portals,
see Configuring Virtual-Portal Settings (see "Configuring Default Settings for
Virtual-Portals" on page 25). For information on configuring default cooperative
de-duplication levels for a specific virtual portal, see Overriding Global Portal Settings (see
"Overriding the Global Virtual Portal Settings" on page 67). For information on configuring
cooperative de-duplication levels for a specific user account, see Configuring User Accounts'
Advanced Settings (on page 89).
This chapter explains how to manage backup folders, cloud folders, and folder groups that
have been added to the CTERA Portal.

In This Chapter
Accessing the Folder Manager -------------------------------------------------------------------------------- 187
Adding and Editing Folders ------------------------------------------------------------------------------------- 188
Viewing Folders --------------------------------------------------------------------------------------------------- 189
Managing Folder Contents ------------------------------------------------------------------------------------- 193
Changing Passphrases for Accessing Backup Folder Contents ---------------------------------------- 201
Exporting Folders to Excel -------------------------------------------------------------------------------------- 202
Deleting Folders --------------------------------------------------------------------------------------------------- 202
Accessing the Folder Group Manager ----------------------------------------------------------------------- 203
Adding and Editing Folder Groups ---------------------------------------------------------------------------- 204
Viewing Folder Groups ------------------------------------------------------------------------------------------ 207
Managing Home Folders for Folder Groups ---------------------------------------------------------------- 207
Managing Backup Folders for Folder Groups -------------------------------------------------------------- 208
Changing Passphrases for Accessing Folder Group Contents ------------------------------------------ 209
Exporting Folder Groups to Excel ----------------------------------------------------------------------------- 210
Deleting Folder Groups------------------------------------------------------------------------------------------ 210

186

CTERA Portal Datacenter Edition Administrator Guide

Managing Folders and Folder Groups

Accessing the Folder Manager


Most tasks related to managing a folder are performed in the Folder Manager.
To access the Folder Manager
1 Do one of the following:
To access the Folder Manager for a home folder, in the navigation pane, click Folders
> Home Folders.
The Folders > Home Folders page appears, displaying all home folders.

To access the Folder Manager for a backup folder, in the navigation pane, click
Folders > Backup Folders.
The Folders > Backup Folders page appears, displaying all backup folders.

CTERA Portal Datacenter Edition Administrator Guide

187

Managing Folders and Folder Groups

2 Do one of the following:


Select the desired folder's row and click Edit.
Click on the folder's name.
The Folder Manager opens displaying the General tab.

Adding and Editing Folders


By default, when folders are created in the CTERA Portal, they are assigned a name based on
the device's name. For example, if a device is named JohnS, then this device's files will be
backed up to a folder called JohnS, and its cloud files will be store in a folder called
JohnS-CloudFiles followed by a number. If desired, you can add new folders manually, and
you can edit their properties.
To add or edit a folder
1 Do one of the following:
To create a new home folder, in the Folders > Home Folders page, click New.
To create a new backup folder, in the Folders > Backup Folders page, click New.
To edit an existing folder, access the Folder Manager.
See Accessing the Folder Manager (on page 187).

188

CTERA Portal Datacenter Edition Administrator Guide

Managing Folders and Folder Groups

The Folder Manager opens displaying the General tab.


2 Complete the fields using the information in the following table.
3 Click Save.
Table 37: Folder Manager General Fields
In this field...

Do this...

Folder Name

Type a name for the folder.

Owner

When adding a new folder, select an owner for the folder.


When editing an existing folder, you can click on the owner's
name to open the User Account Manager and manage the
owner's user account. For information on managing user
accounts, see Managing User Accounts (on page 73).

Folder Group

When adding a new folder, select a folder group for the folder.
When editing an existing folder, you can click on the folder
group's name to open the Folder Group Manager and manage
the folder group. For information on managing folder groups,
see Managing Folders and Folder Groups.

Device

Select the device with which this folder is associated.


This field is relevant only for backup folders. It is read-only.

Backup Extended Attributes

Select this option to back up special file permissions and


metadata.

Viewing Folders
The CTERA Portal enables you to view information on all folders, as well as the contents of
individual folders.

Viewing All Backup Folders


To view all backup folders in the portal
In the navigation pane, click Folders > Backup Folders.
The Folders > Backup Folders page appears, displaying all backup folders.
The table includes the following columns.

CTERA Portal Datacenter Edition Administrator Guide

189

Managing Folders and Folder Groups

Table 38: Backup Folders Fields


This field...

Displays...

Name

The folder's name.


To view the folder's contents, click the folder name. For further
details, see Adding and Editing Folders (on page 188).

Owner

The user account name of the folder's owner.


To edit the user account, click the user account name. For further
details, see Adding and Editing User Accounts (on page 75).

Group

The name of the folder group to which the folder belongs.


To edit the folder group, click the folder group's name. For further
details, see Adding and Editing Folder Groups (on page 204).

Size

The current size of the folder in MB.

Total Files

The total number of files in the folder.

State

The folder's state. This can have the following values:


Online. The folder is online, and it is possible to view, modify,
and back up files to it.
Offline. The folder is offline, and it is not possible to view,
modify, and back up files to it. Folders may be taken offline
during some maintenance operations, such as when repairing a
folder using the CTERA Cloud FSCK utility.
Folders inherit their state from the folder group.

Device

The device's name.


To edit the device, click the device name. For further details, see
Editing Device Settings (on page 169).

Is seeding

Indicates whether the folder is currently in the process of loading a


seeding file (Yes/No). While seeding is in progress, backups to this
folder are temporarily suspended.

Viewing All Home Folders


To view all home folders in the portal
In the navigation pane, click Folders > Home Folders.
The Folders > Home Folders page appears, displaying all home folders.
The table includes the following columns.

190

CTERA Portal Datacenter Edition Administrator Guide

Managing Folders and Folder Groups

Table 39: Home Folders Fields


This field...

Displays...

Name

The folder's name.


To view the folder's contents, click the folder name. For further
details, see Adding and Editing Folders (on page 188).

Owner

The user account name of the folder's owner.


To edit the user account, click the user account name. For further
details, see Adding and Editing User Accounts (on page 75).

Group

The name of the folder group to which the folder belongs.


To edit the folder group, click the folder group's name. For further
details, see Adding and Editing Folder Groups (on page 204).

Size

The current size of the folder in MB.

Total Files

The total number of files in the folder.

State

The folder's state. This can have the following values:


Online. The folder is online, and it is possible to view, modify,
and back up files to it.
Offline. The folder is offline, and it is not possible to view,
modify, and back up files to it. Folders may be taken offline
during some maintenance operations, such as when repairing a
folder using the CTERA Cloud FSCK utility.
Folders inherit their state from the folder group.

Viewing Folder Contents


To view a folder's content
Do one of the following:
To view the contents of a home folder, in the Folders > Home Folders page, select the
desired folder's row, then click View Files.
To view the contents of a backup folder, in the Folders > Backup Folders page, select
the desired folder's row, then click View Files.
To view the contents of either type of folder, access the Folder Manager, then click
View Files.
See Accessing the Folder Manager (on page 187).
The following things happen:

CTERA Portal Datacenter Edition Administrator Guide

191

Managing Folders and Folder Groups

If the folder is passphrase-protected, the Passphrase Protected Folder window


appears.

Do the following:
1 In the Folder Passphrase field, type the passphrase for accessing the folder.
2 Click OK.
The File Manager window opens displaying files from the last backup operation or
snapshot.

You can now manage the folder's contents, as described in Managing Folder Contents
(on page 193).

192

CTERA Portal Datacenter Edition Administrator Guide

Managing Folders and Folder Groups

Managing Folder Contents


A folder's contents are displayed in the File Manager, as described in Viewing Folder
Contents (on page 191). Once the File Manager is open, you can manage the folder's content.

Navigating Between Folders


To navigate between folders
Do any of the following:
In the tree pane, expand the nodes and click on the desired folders.
In the upper bar, type the desired file or folder path.
To navigate to the parent folder of the currently displayed folder, in the upper bar,
click

The folder's contents appear in the right pane.

Changing the Right Pane View


The Files tab's right pane offers two views:
Details
This view displays the items in the right pane in a table. You can sort the tables as
described in Sorting Tables (on page 20) and hide/display columns as described in
Displaying and Hiding Columns.
Large Icons
This view displays the items in the right pane as large icons.
To change the right pane view
In the right pane, click View and then select the desired view.

Refreshing the View


To refresh the view
In the upper bar, click

The view is refreshed.

Viewing File or Folder Details


To view a file or folder's details
1 In the File Manager, navigate to the desired file/folder.
See Navigating Between Folders (on page 193).

CTERA Portal Datacenter Edition Administrator Guide

193

Managing Folders and Folder Groups

The file/folder appears in the right pane.


2 In the right pane, click on the file/folder.
The file/folder's details appear at the bottom of the right pane.
If in Details view, the file/folder's details are displayed in the table as well. For
information on changing the view, see Changing the Right Pane View (on page 193).

Downloading Files and Folders


You can download individual files, multiple files, or entire folders.
To download an individual file
1 In the File Manager, navigate to the desired file.
See Navigating Between Folders (on page 193).
2 In the right pane, do one of the following:
If in the Large Icons view, double-click on the file.
If in the Details view, click once on the file name.
For information on changing the view, see Changing the Right Pane View (on page 193).
The file is downloaded to your computer.
To download multiple files or entire folders
1 In the File Manager, navigate to the desired file.
See Navigating Between Folders (on page 193).
2 In the right pane, select the desired files or folder(s).
See Selecting Files and Folders (on page 197).
3 Click Actions, and then click Download.
The selected files/folders are downloaded to your computer in a file called
download.zip.

Uploading Files
This procedure is relevant for cloud folders only.
To upload files
1 In the File Manager, navigate to the desired folder.
See Navigating Between Folders (on page 193).
2 In the right pane, click Upload.

194

CTERA Portal Datacenter Edition Administrator Guide

Managing Folders and Folder Groups

The Upload files window appears.

3 For each file you want to upload, do one of the following:


Click Add files and browse to the desired file.
If using Google Chrome or Mozilla FireFox, drag and drop a file from your computer to
the Upload files window.
The following things happen:
If the file already exists, the following window appears.

To overwrite the file in cloud storage with the file on your computer, choose
Overwrite and click Ok. Otherwise, upload of this file will be canceled.

CTERA Portal Datacenter Edition Administrator Guide

195

Managing Folders and Folder Groups

The file is uploaded, and a progress bar displays the upload progress.

4 To cancel an upload, select the file whose upload you want to cancel, and then click
Cancel.
5 To clear the list of completed uploads, click Clear Completed.
6 When done uploading all desired files, click Close.

Creating New Folders


This procedure is relevant for cloud folders only.
To create a new folder
1 In the File Manager, navigate to the desired parent folder.
See Navigating Between Folders (on page 193).
2 Click Actions and then click New Folder.
The Choose a name dialog box appears.

3 In the field provided, type a name for the new folder.


4 Click OK.

196

CTERA Portal Datacenter Edition Administrator Guide

Managing Folders and Folder Groups

Renaming Files and Folders


This procedure is relevant for cloud folders only.
To rename a file or folder
1 In the File Manager, navigate to the desired file/folder.
See Navigating Between Folders (on page 193).
2 In the right pane, click on the file/folder's row.
3 Click Actions and then click Rename.
The Choose a name dialog box appears.
4 In the field provided, type a new name for the file/folder.
5 Click OK.

Selecting Files and Folders


To select a file or folder
In the File Manager's right pane, do one of the following:
To select a single file/folder, click on the file/folder's row.
To select multiple files, press and hold the CTRL key, while clicking on the desired files
or folders.
To select all items in the current folder, click Actions and then click Select All, or press
CTRL+A.
To select a range of files, press and hold the Shift key, click the file at the start of the
range, and then click on the file at the end of the range.

Deleting Files and Folders


Deleting files and folders is supported for cloud folders only. Deleting files and folders is not
supported for backup folders.
To delete a file or folder
1 In the File Manager, navigate to the desired files/folders.
See Navigating Between Folders (on page 193).
2 Select the desired file or folder.
See Selecting Files and Folders (on page 197).
3 Click Actions and then click Delete.
A confirmation message appears.

CTERA Portal Datacenter Edition Administrator Guide

197

Managing Folders and Folder Groups

4 Click Yes.
The selected items are deleted.

Copying/Moving Files and Folders


This procedure can be used for a backup folder, only if the backup folder belongs to the same
folder group as the user account's cloud folders.
To copy or move files or folders
1 In the File Manager, navigate to the desired files/folders.
See Navigating Between Folders (on page 193).
2 Select the desired file or folder.
See Selecting Files and Folders (on page 197).
3 Do one of the following:
To copy the selected items, click Actions and then click Copy, or press CTRL+C.
To move the selected items, click Actions and then click Cut, or press CTRL+X.
4 Navigate to the target folder.
See Navigating Between Folders (on page 193).
5 Click Actions and then click Paste, or press CTRL+V.
The selected items are copied/moved to the target folder.

Restoring Files and Folders to Devices


This procedure is relevant for backup folders only.
To restore files or folders to a device
1 In the File Manager, navigate to the desired files/folders.
See Navigating Between Folders (on page 193).
2 Select the desired file or folder.
See Selecting Files and Folders (on page 197).
3 Click Actions and then click Restore to Device.

198

CTERA Portal Datacenter Edition Administrator Guide

Managing Folders and Folder Groups

The Restore Files dialog box appears.

4 Specify how to handle files that already exist on the device, by doing one of the following:
To specify that the files on the device should be overwritten by the files in the portal,
choose If the file already exists, overwrite it.
To specify that the files on the device should have the modification date appended to
their name, choose If the file already exists, append the modification date to the
name.
5 Click Next.
The Restore Initiated screen appears.

6 Click Finish.
A progress bar appears, and the files are restored to the device.

CTERA Portal Datacenter Edition Administrator Guide

199

Managing Folders and Folder Groups

Searching for Files


If full text search is enabled on the device, you can search for files containing specific text,
located anywhere in the documents file name.
To search for files
1 In the File Manager's upper bar, in the Find files by name field, type the text you want to
search for.
2 Click

The search results appear.

3 To download a file appearing in the search results, click on its name.


4 To clear the search results, click

Viewing Previous Versions of Files and Folders


To view previous versions of files and folders
1 In the File Manager's upper bar, click

For information on changing the tree pane view, see Changing the Tree Pane View.

200

CTERA Portal Datacenter Edition Administrator Guide

Managing Folders and Folder Groups

The Please select snapshot window opens.

2 Click on the snapshot containing the file/folder versions you want to view.
Latest Version contains the current version of files and folder in cloud backup. The
snapshots are marked according to their type: NEXT3 (

) or cloud (

).

The snapshot contents appear, and you can view and download them. You can also copy
and paste them to the Latest Version.

Changing Passphrases for Accessing Backup Folder Contents


To change a passphrase
1 Do one of the following:
In the Folders > Backup Folders page, select the desired folder's row, and then click
Change Passphrase.
In the File Manager, click Actions, and then click Change Passphrase.
See Viewing Folder Contents (on page 191).
The Change My Passphrase dialog box appears.

CTERA Portal Datacenter Edition Administrator Guide

201

Managing Folders and Folder Groups

2 In the Your Old Passphrase field, type the folder's old passphrase.
3 In the Your New Passphrase and Confirm New Passphrase fields, type a new passphrase.
The Passphrase Strength area displays the passphrase's strength.
4 Click Finish.
5 Do one of the following:
If cooperative de-duplication is disabled, you will need to update the passphrase on
the device associated with this folder, to enable the device to access the folder.
If cooperative de-duplication is enabled (which is the default), you will need to update
the passphrase on all devices using this folder group.

Exporting Folders to Excel


You can export a list of folders and their details to a Comma Separated Values (*.csv) file on
your computer, which you can open in Microsoft Excel.
To export folders to Excel
Do one of the following:
To export home folders, in the Folders > Home Folders page, click Export to Excel.
To export backup folders, in the Folders > Backup Folders page, click Export to Excel.
The folders are exported.

Deleting Folders
To delete a folder
1 Do one of the following:
To delete a home folder, in the Folders > Home Folders page, select the desired
folder's row, then click Delete Folder.
To delete a backup folder, in the Folders > Backup Folders page, select the desired
folder's row, then click Delete Folder.
Access the Folder Manager, then click Delete.
See Accessing the Folder Manager (on page 187).
A confirmation message appears.
2 Click Yes.
The folder is deleted.

202

CTERA Portal Datacenter Edition Administrator Guide

Managing Folders and Folder Groups

Accessing the Folder Group Manager


Most tasks related to managing a folder group are performed in the Folder Group Manager.
To access the Folder Group Manager
1 In the navigation pane, click Folders > Folder Groups.
The Folders > Folder Groups page appears, displaying all folder groups.

2 Do one of the following:


Select the desired folder group's row and click Edit.
Click on the folder group's name.

CTERA Portal Datacenter Edition Administrator Guide

203

Managing Folders and Folder Groups

The Folder Group Manager opens displaying the General tab.

Adding and Editing Folder Groups


When a device first backs up files to the CTERA Portal, and cooperative de-duplication is
enabled for the device's owner, a folder group is automatically created. By default, the folder
group is assigned a name based on the device's name. If desired, you can add new folder
groups manually, and you can edit their properties.
To add or edit a folder group
1 Do one of the following:
To add a new folder group, in the Folders > Folder Groups page, click New.
To edit an existing folder group, access the Folder Group Manager.
See Accessing the Folder Group Manager (on page 203).
The Folder Group Manager opens displaying the General tab.
2 Complete the fields using the information in the following table.
3 Click Save.

204

CTERA Portal Datacenter Edition Administrator Guide

Managing Folders and Folder Groups

Table 40: Folder Group Manager General Fields


In this field...

Do this...

Name

Type a name for the folder group.

State

Select the folder group's state. This can have the following
values:
Online. The folder group is online, and it is possible to
view, modify, and back up files to its member folders.
Offline. The folder group is offline, and it is not possible to
view, modify, and back up files to its member folders.
Folder groups may be taken offline during some
maintenance operations, such as when repairing a folder
using the CTERA Cloud FSCK utility.
All member folders will inherit the folder group's state.

Minimum Map File Blocks

Type the minimum number of de-duplication blocks that a file


must contain in order to trigger creation of a mapfile.
The default value is configured in the virtual portal's settings.
See Configuring Virtual-Portal Settings (see "Configuring
Default Settings for Virtual-Portals" on page 25).

Cloud FS Version

The cloud storage encoding scheme to use for the folder


groups. Currently, the only supported encoding scheme is
Cloud FS1.

Average Block Size

The average block size used by the folder group.


This field is editable, when manually creating a new folder
group. Otherwise, it is read-only, and its value is inherited
from the definition of the selected Cloud FS version in the
virtual portal's settings. See Configuring Virtual-Portal
Settings (see "Configuring Default Settings for
Virtual-Portals" on page 25).
Changing this value for an existing folder group does not affect
blocks already existing in the folder group.

Average Map File Size

The average map file size used by the folder group.


This field is editable, when manually creating a new folder
group. Otherwise, it is read-only, and its value is inherited
from the definition of the selected Cloud FS version in the
virtual portal's settings. See Configuring Virtual-Portal
Settings (see "Configuring Default Settings for
Virtual-Portals" on page 25).

CTERA Portal Datacenter Edition Administrator Guide

205

Managing Folders and Folder Groups

Use Data Compression

This field indicates whether data in this folder group will be


stored in compressed format.
This field is editable, when manually creating a new folder
group. Otherwise, it is read-only, and its value is inherited
from the definition of the selected Cloud FS version in the
virtual portal's settings. See Configuring Virtual-Portal
Settings (see "Configuring Default Settings for
Virtual-Portals" on page 25).

Compression Method

If the Use Data Compression setting is enabled, specify the


default compression method to use for file storage. Select one
of the following:
High Compression
High Speed
The default value is High Speed.
This field is editable, when manually creating a new folder
group. Otherwise, it is read-only, and its value is inherited
from the virtual portal's settings. See Configuring
Virtual-Portal Settings (see "Configuring Default Settings for
Virtual-Portals" on page 25).

Use Encryption

This field indicates whether data in this folder group will be


stored in encrypted format.
This field is editable, when manually creating a new folder
group. Otherwise, it is read-only, and its value is inherited
from the virtual portal's settings. See Configuring
Virtual-Portal Settings (see "Configuring Default Settings for
Virtual-Portals" on page 25).

Passphrase protected

Select this option to specify that the folder group should be


passphrase protected.
This field only appears when manually creating a new folder
group, in which the Use Encryption option is enabled. To
change the passphrase of an existing folder group, see
Changing Passphrases for Accessing Folder Group Contents
(on page 209).

Your New Passphrase / Confirm

Type the passphrase for accessing this folder group.

New Passphrase
Passphrase Strength

206

A bar indicating the passphrase's strength.

CTERA Portal Datacenter Edition Administrator Guide

Managing Folders and Folder Groups

Owner

When adding a new folder group, select an owner for the


folder group.
When editing an existing folder group, you can click on the
owner's name to open the User Account Manager and manage
the owner's user account. For information on managing user
accounts, see Managing User Accounts (on page 73).

Viewing Folder Groups


To view all folders groups in the portal
In the navigation pane, click Folders > Folder Groups.
The Folders > Folder Groups page appears, displaying all folder groups.
The table includes the following columns.
Table 41: Folder Groups Fields
This field...

Displays...

ID

The folder group's name.


To edit the folder group's name, click the folder group name. For
further details, see Editing Folder Group Properties (see "Adding
and Editing Folder Groups" on page 204).

Owner

The user account name of the folder group's owner.


To edit the user account, click the user account name. For further
details, see Adding and Editing User Accounts (on page 75).

Passphrase-protected

Indicates whether the folder group is passphrase-protected or not


(Yes / No).

State

The folder group's state (Online / Offline).

Managing Home Folders for Folder Groups


You can manage the home folders in a folder group.
To manage home folders in a folder group
1 Access the Folder Group Manager.
See Accessing the Folder Group Manager (on page 203).
2 Click the Home Folders tab.

CTERA Portal Datacenter Edition Administrator Guide

207

Managing Folders and Folder Groups

The Home Folders tab appears with a table of home folders in the folder group.

3 Perform any of the folder management tasks described in Managing Folder Contents (on
page 193), as if you were working in the Folders > Home Folders page.

Managing Backup Folders for Folder Groups


You can manage the backup folders in a folder group.
To manage backup folders in a folder group
1 Access the Folder Group Manager.
See Accessing the Folder Group Manager (on page 203).
2 Click the Backups tab.

208

CTERA Portal Datacenter Edition Administrator Guide

Managing Folders and Folder Groups

The Backups tab appears with a table of backup folders in the folder group.

3 Perform any of the folder management tasks described in Managing Folder Contents (on
page 193), as if you were working in the Folders > Backup Folders page.

Changing Passphrases for Accessing Folder Group Contents


Warning

Changing the passphrase for a folder group will cause all devices using folders in
the folder group to be unable to backup files, until the backup service has been
re-configured with the new passphrase in the devices' administration interfaces.
To change a passphrase
1 In the navigation pane, click Folders > Folder Groups.
The Folders > Folder Groups page appears, displaying all folder groups.
2 Select the desired folder group's row.
3 Click Change Passphrase.
The Change My Passphrase dialog box appears.
4 In the Your Old Passphrase field, type the folder group's old passphrase.

CTERA Portal Datacenter Edition Administrator Guide

209

Managing Folders and Folder Groups

5 In the Your New Passphrase and Confirm New Passphrase fields, type a new passphrase.
The Passphrase Strength area displays the passphrase's strength.
6 Click Finish.
7 For each device using a folder in this folder group, do the following:
a Log in to the device's administration interface.
See Remotely Managing Devices (see "Remotely Managing Devices and Their Files"
on page 180).
b Run the Backup Setup Wizard and enter the new passphrase.

Exporting Folder Groups to Excel


You can export a list of folder groups and their details to a Microsoft Excel (*.xls) file on your
computer.
To export folder groups to Excel
1 In the navigation pane, click Folders > Folder Groups.
The Folders > Folder Groups page appears, displaying all folder groups.
2 Click Export to Excel.
The folder groups are exported.

Deleting Folder Groups


To delete a folder group
1 Do one of the following:
In the Folders > Folder Groups page, select the desired folder group's row, then click
Delete.
Access the Folder Group Manager, then click Delete.
See Accessing the Folder Group Manager (on page 203).
A confirmation message appears.
2 Click Yes.
The folder group is deleted.

210

CTERA Portal Datacenter Edition Administrator Guide

10
Managing Collaboration Projects
You can easily share files and folders with fellow workers, by defining collaboration projects.
When project collaboration is enabled in a team portal, users who have project collaboration
permissions can create a project and invite individual users or whole user groups to join the
project as project members. Project members receive an email notification inviting them to
collaborate on the project. They can then view files in the project and/or add files and folders
to the project, depending on their permissions.
This chapter explains how to manage projects. It is relevant for team portals only.

In This Chapter
Enabling Project Collaboration for the Virtual Portal ---------------------------------------------------- 211
Defining Project Management Permissions ---------------------------------------------------------------- 212
Adding Collaboration Projects --------------------------------------------------------------------------------- 214
Editing Collaboration Projects --------------------------------------------------------------------------------- 218
Viewing Collaboration Project Contents -------------------------------------------------------------------- 220
Exporting a List of Collaboration Projects to Excel ------------------------------------------------------- 221
Deleting Collaboration Projects ------------------------------------------------------------------------------- 221

Enabling Project Collaboration for the Virtual Portal


This task can be performed in the Global Administration View only.
To enable project collaboration for a team portal
1 In the navigation pane, click Settings > Virtual Portal Settings.
The Settings > Virtual Portal Settings page appears.
2 Select Enable Projects.
3 Click Save.

CTERA Portal Datacenter Edition Administrator Guide

211

10

Managing Collaboration Projects

Defining Project Management Permissions


You can define which users have permission to create and manage collaboration projects.
You define permissions by adding users and/or user groups to a list and selecting whether to
allow or deny permission to each listed user and user group. By default, the user group "All
Users," which includes all users, is allowed to create and manage collaboration projects. Deny
rules override Allow rules.
To define project collaboration permissions
1 In the navigation pane, click Folders > Projects.
The Folders > Projects page appears, displaying all collaboration projects.

212

CTERA Portal Datacenter Edition Administrator Guide

Managing Collaboration Projects

10

2 Click Settings. The Collaboration Projects Settings dialog appears.

3 To add users and/or user groups and allow or deny permission to them:
a In the Local Users drop-down list, select one of the following:
Local Users. Search the user accounts defined locally on the CTERA Portal.
Local Groups. Search the user groups defined locally on the CTERA Portal.
b In the Quick Search field, type a string that appears anywhere within the name of a
user account or group you want to add, then click

c A table of user accounts matching the search string appears.

CTERA Portal Datacenter Edition Administrator Guide

213

10

Managing Collaboration Projects

d Select the desired user account or group in the table.


The user account or group appears in the Quick Search field.
e Click Add. The selected user account or group appears in the permissions list.

In the Permission column, select Allow or Deny from the dropdown list.

4 To delete a user or user group, click

in the user's or user group's row .

5 Click Save.

Adding Collaboration Projects


To add a collaboration project
1 Do one of the following:
To add a new collaboration project via the Administration tab:
1 In the navigation pane, click Folders > Projects.
The Folders > Projects page appears, displaying all collaboration projects.
2 Click New.
To add a new collaboration project via the Cloud Drive tab:

214

CTERA Portal Datacenter Edition Administrator Guide

Managing Collaboration Projects

10

1 Navigate to the root/projects folder.

2 Click New Project.


The Collaboration Project Details dialog box opens.

2 In the Project Name field, type a name for the project.


3 (Optional) In the Description field, type a description of the project.
4 Specify the project owner, by doing the following in the Owner area:

CTERA Portal Datacenter Edition Administrator Guide

215

10

Managing Collaboration Projects

a In the Local Users drop-down list, select one of the following:


Local Users. Search the user accounts defined locally on the CTERA Portal.
Domain domain Users. Search the user accounts belonging to the domain called
domain.
b In the Quick Search field, type a string that appears anywhere within the name of the
user account you want to add, then click

A table of user accounts matching the search string appears.

c Select the desired user account in the table.


The user account appears in the Quick Search field.
5 In the Group field, select the folder group in which the collaboration project should be
stored.
6 To mark the project as a Quick Access project, check the Quick Access box. Quick access
projects appear directly under the cloud drive's root folder, instead of appearing under
the projects folder.
Tip

You must be an administrator to mark a project as a Quick Access project. The


Quick Access box is only enabled if you are an administrator.
7 To add a project member, do the following in the Project Members area:
a In the Local Users drop-down list, select one of the following:
Local Users. Search the user accounts defined locally on the CTERA Portal.

216

CTERA Portal Datacenter Edition Administrator Guide

Managing Collaboration Projects

10

Domain domain Users. Search the user accounts belonging to the domain called
domain.
Local Groups. Search the user groups defined locally on the CTERA Portal.
Domain domain Groups. Search the user groups belonging to the domain called
domain.
b In the Quick Search field, type a string that appears anywhere within the name of the
user account or user group you want to add, then click

A table of user accounts or user groups matching the search string appears.

c Select the desired user account or user group in the table.


The user account or user group appears in the Quick Search field.
d Click Add.
The user account or user group appears in the Project Member list.
8 In the project member's row, click the Permission field, and do one of the following:
To specify that the member should be able to add, edit, and delete files and folders in
this project, select Read/Write.
To specify that the member should only be able to view files and folders in this
project, select Read Only.
9 To specify an expiration date for a member, do the following:
a In the project member's row, click the Expiration field, and then click

CTERA Portal Datacenter Edition Administrator Guide

217

10

Managing Collaboration Projects

A calendar appears.
b Select the date on which the member's access should end.
The Expiration column is updated accordingly.
10 To delete a project member, click

in the desired project member's row.

11 Click Save.
If the mail server is set up, and email addresses are defined for the user accounts you
added as project members, the CTERA Portal will send email notifications to the new
project members, inviting them to collaborate on the project.
For information on configuring mail server settings, see Configuring Global Mail Server
Settings (on page 45). For information on editing user accounts, see Adding and Editing
User Accounts (on page 75).

Editing Collaboration Projects


To edit a collaboration project
1 Do one of the following:
To edit a collaboration project via the Administration tab:
1 In the navigation pane, click Folders > Projects.
The Folders > Projects page appears, displaying all collaboration projects.
2 Select the desired project's row and then click Edit.
To edit a collaboration project via the Cloud Drive tab:
1 Navigate to the root/projects folder.
2 Select the project and click Manage Project.
The Collaboration Project Details dialog box opens.
2 In the Project Name field, type a name for the project.
3 (Optional) In the Description field, type a description of the project.
4 Specify the project owner, by doing the following in the Owner area:
a In the Local Users drop-down list, select one of the following:
Local Users. Search the user accounts defined locally on the CTERA Portal.
Domain domain Users. Search the user accounts belonging to the domain called
domain.

218

CTERA Portal Datacenter Edition Administrator Guide

Managing Collaboration Projects

10

b In the Quick Search field, type a string that appears anywhere within the name of the
user account you want to add, then click

A table of user accounts matching the search string appears.


c Select the desired user account in the table.
The user account appears in the Quick Search field.
5 To add a project member, do the following in the Project Members area:
a In the Local Users drop-down list, select one of the following:
Local Users. Search the user accounts defined locally on the CTERA Portal.
Domain domain Users. Search the user accounts belonging to the domain called
domain.
Local Groups. Search the user groups defined locally on the CTERA Portal.
Domain domain Groups. Search the user groups belonging to the domain called
domain.
b In the Quick Search field, type a string that appears anywhere within the name of the
user account or user group you want to add, then click

A table of user accounts or user groups matching the search string appears.
c Select the desired user account or user group in the table.
The user account or user group appears in the Quick Search field.
d Click Add.
The user account or user group appears in the Project Member list.
6 In the project member's row, click the Permission field, and do one of the following:
To specify that the member should be able to add, edit, and delete files and folders in
this project, select Read/Write.
To specify that the member should only be able to view files and folders in this
project, select Read Only.
7 To specify an expiration date for a member, do the following:
a In the project member's row, click the Expiration field, and then click

A calendar appears.
b Select the date on which the member's access should end.
The Expiration column is updated accordingly.
8 To delete a project member, click

CTERA Portal Datacenter Edition Administrator Guide

in the desired project member's row.

219

10

Managing Collaboration Projects

9 Click Save.
The CTERA Portal will send email notifications to the new project members, inviting them
to collaborate on the project.
For information on configuring mail server settings, see Configuring Global Mail Server
Settings (on page 45). For information on editing user accounts, see Adding and Editing
User Accounts (on page 75).

Viewing Collaboration Project Contents


You can view all of the files and folders included in a collaboration project.
To view collaboration project contents via the Administration tab
1 In the navigation pane, click Folders > Projects.
The Folders > Projects page appears, displaying all collaboration projects.
2 Select the desired project's row and then click View Files.
The File Manager opens displaying the collaboration project contents.

To view collaboration project contents via the Cloud Drive tab


1 Navigate to the root/projects folder.
2 Double-click on the collaboration project.

220

CTERA Portal Datacenter Edition Administrator Guide

Managing Collaboration Projects

10

The collaboration project's contents appear.

Exporting a List of Collaboration Projects to Excel


You can export a list of collaboration projects and their details to a Comma Separated Values
(*.csv) file on your computer, which you can open with Microsoft Excel.
This procedure can be performed via the Administration tab only.
To export a list of collaboration projects to Excel
1 In the navigation pane, click Folders > Projects.
The Folders > Projects page appears, displaying all collaboration projects.
2 Click Export to Excel.
The collaboration projects are exported.

Deleting Collaboration Projects


To delete a collaboration project via the Administration tab
1 In the navigation pane, click Folders > Projects.
The Folders > Projects page appears, displaying all collaboration projects.
2 Select the desired project's row and then click Delete.
A confirmation message appears.
3 Click Yes.

CTERA Portal Datacenter Edition Administrator Guide

221

10

Managing Collaboration Projects

The project is deleted.


To delete a collaboration project via the Cloud Drive tab
1 Navigate to the root/projects folder.
2 Select the project.
3 Click Actions, and then click Delete.
A confirmation message appears.
4 Click Yes.
The project is deleted.

222

CTERA Portal Datacenter Edition Administrator Guide

11
Managing Subscription Plans
You provision licenses to virtual portals, by assigning the virtual portals to global plans and
add-ons.
When a reseller portal is assigned to a global plan or add-on, it is necessary to provision
licenses to individual user accounts by creating subscription plans and/or add-ons and
assigning the user accounts to the desired plans and packages. Through subscription plans,
users in a reseller portal obtain cloud services for an open-ended period of time with
automatically recurring payments. Through add-ons, users can obtain additional cloud
services for a defined period of time.
In contrast, when a team portal is assigned to a global plan or add-on, CTERA Portal
automatically creates a default subscription plan containing the licenses specified in the
global plan and/or add-ons, and assigns all user accounts in the team portal to this plan. If
desired, you can create alternate subscription plans and assign those to individual user
accounts. Users in a team portal obtain services through their subscription plans for an
open-ended period of time without payment. For more information on subscription plans,
see Understanding CTERA Provisioning.
This chapter explains how to use subscription plans to provision services to users' devices and
how to provision services to virtual portals via global plans.
In order to manage global plans, these tasks must be performed in the Global Administration
View.
For information on creating non-recurring prepaid service packages, see Managing Add-ons
(on page 239).

In This Chapter
Understanding Snapshot Retention Policies --------------------------------------------------------------- 224
Adding and Editing Subscription Plans ---------------------------------------------------------------------- 228
Viewing Subscription Plans ------------------------------------------------------------------------------------- 234
Setting/Removing the Default Subscription Plan --------------------------------------------------------- 236
Exporting Subscription Plans to Excel------------------------------------------------------------------------ 236
Applying Provisioning Changes -------------------------------------------------------------------------------- 236
Deleting Subscription Plans ------------------------------------------------------------------------------------ 237

CTERA Portal Datacenter Edition Administrator Guide

223

11

Managing Subscription Plans

Understanding Snapshot Retention Policies


The CTERA Portal retains previous file versions for each user, by using snapshots. Snapshots
are read-only copies of files as they were at a particular point in time.
The CTERA Portal creates snapshots automatically and retains them according to a
configurable snapshot retention policy that is provisioned via subscription plans. So long as a
snapshot is retained by CTERA Portal, the relevant version of the user data can be retrieved.

What Does a Snapshot Retention Policy Specify?


A retention policy specifies the following:
The number daily snapshots to retain
For example, if daily snapshots are set to 10, then the last 10 daily snapshots will be
retained. If daily snapshots are set to 0, then the daily snapshot will be deleted when the
next day starts.
Tip

A day is defined as starting at 00:00:00 and ending at 23:59:59.


The number of weekly snapshots to retain
A weekly snapshot is the latest snapshot taken during the week.
Tip

A week is defined as starting on Monday and ending on Sunday.

Example 1:
Let's say snapshots were successfully taken every day until the current day, which is
Sunday. The weekly snapshot is the one taken on Sunday, as it is the latest snapshot
taken this week.
Example 2:
Snapshots were successfully taken every day until the current day, except the Saturday
and Sunday snapshots, which were not taken because the device was turned off. The
weekly snapshot is the one taken on Friday, as it is the latest snapshot taken this week.
The number of monthly snapshots to retain
A monthly snapshot is the latest snapshot taken during the month.
Example 1:

224

CTERA Portal Datacenter Edition Administrator Guide

Managing Subscription Plans

11

Let's say snapshots were successfully taken every day until the current date, which is April
30th. The monthly snapshot is the one taken on the 30th, as it is the latest snapshot
taken this month.
Example 2:
Snapshots were successfully taken every day until the current date, except snapshots for
the 25th through the 30th, which were not taken because the device was turned off. The
monthly snapshot is the one taken on the 24th, as it is the latest snapshot taken this
month.
The number of quarterly snapshots to retain
A quarterly snapshot is the latest snapshot taken during the quarter.
Example 1:
Let's say snapshots were successfully taken every day until the current date, which is the
March 31. The quarterly snapshot is the one taken on March 31st, as it is the latest
snapshot taken this quarter.
Example 2:
Snapshots were successfully taken every day until the current date, except snapshots for
March 25 through 31 were not taken because the device was turned off. The quarterly
snapshot is the one taken on March 24th, as it is the latest snapshot taken this quarter.
The number of yearly snapshots to retain
A yearly snapshot is the latest snapshot taken during the year.
Example 1:
Let's say snapshots were successfully taken every day until the current date, which is the
December 31st. The yearly snapshot is the one taken on the 31st, as it is the latest
snapshot taken this year.
Example 2:
Snapshots were successfully taken every day until the current date, except snapshots for
the 25nd through the 31st were not taken because the device was turned off. The yearly
snapshot is the one taken on the 24th, as it is the latest snapshot taken this year.

At What Level Can a Snapshot Retention Policy Be Applied?


Snapshot retention policies can be applied at the following levels:
At the virtual portal level
In this case, the snapshot retention policy will apply to all users in the virtual portal.
A snapshot retention policy can be applied to both reseller portals and team portals.

CTERA Portal Datacenter Edition Administrator Guide

225

11

Managing Subscription Plans

At the user level


It is possible to configure snapshot retention policies for individual users in the virtual
portal.
Tip

Applying a retention policy at the user level in a reseller portal is


supported from v3.2. Applying a retention policy at the user level in a
team portal is supported from v4.0.

What Happens When Both Levels of Snapshot Retention Policy Are Applied?
When a snapshot retention policy is assigned to a portal, the policy will be globally enforced
as a set of maximum values for all users in the portal. Individual users in that portal can be
assigned user-level snapshot retention policies, so long as the values in the user-level policy
do not exceed those of the portal-level policy.
For example, let us assume that a team portal called "acme" is assigned a subscription plan
called "acme-plan", which includes the following snapshot retention policy.
Retain 7 daily snapshots
Retain 4 weekly snapshots
Retain 12 monthly snapshots
Users in the "acme" portal cannot be assigned a snapshot retention policy that exceeds the
values specified in "acme-plan".
Therefore, users in this portal cannot be assigned the following snapshot retention policy:
Retain 10 daily snapshots
Retain 15 weekly snapshots
Retain 17 monthly snapshots
However, they can be assigned the following snapshot retention policy:
Retain 6 daily snapshots
Retain 2 weekly snapshots
Retain 9 monthly snapshots

226

CTERA Portal Datacenter Edition Administrator Guide

Managing Subscription Plans

11

CTERA Portal Snapshot Retention for the Cloud Drive Service


Each user account that uses the Cloud Drive service is assigned a home folder in the CTERA
Portal, upon creation of the user account. The home folder (Cloud Drive) serves as the block
destination for CTERA appliance and CTERA Cloud Agent sync operations.
Each Cloud Drive folder (including home folders and projects) retains previous versions
according to the snapshot retention policy of the folder owner. However,when two
collaborators (portal users) who are working on the same project have different snapshot
retention policies, the project snapshots will be retained according to the project owner's
retention policy.
Snapshots of Cloud Drive folders are taken for each folder once an hour, if there were any
changes in the folder during that hour.

CTERA Portal Snapshot Retention for the Cloud Backup Service.


Each CTERA C Series appliance and CTERA Cloud Agent that uses the Cloud Backup service is
assigned a dedicated backup folder in the CTERA Portal, which serves as the block destination
for the appliance or Cloud Agent.
When a CTERA appliance or CTERA Cloud Agent initiates a Cloud Backup job, the CTERA Portal
automatically creates a snapshot of the appliance's or Cloud Agent's backup folder. The
snapshot's timestamp is the time at which the Cloud Backup job was initiated by the client.

Snapshot Consolidation
The snapshot consolidator is a scheduled job that runs once a day at midnight. It is
responsible for deleting all the snapshots that should not be retained, according to the
retention policy.

CTERA Portal Datacenter Edition Administrator Guide

227

11

Managing Subscription Plans

Adding and Editing Subscription Plans


To add or edit a subscription plan
1 In the navigation pane, click Provisioning > Plans.
The Provisioning > Plans page appears, displaying all subscription plans.

2 Do one of the following:


To add a new subscription plan, click New Plan.
To edit an existing subscription plan, select the desired subscription plan's row and
then click Edit Plan.
The Plan Details Wizard opens displaying the Services dialog box.

228

CTERA Portal Datacenter Edition Administrator Guide

Managing Subscription Plans

11

3 Complete the fields using the information in Plan Services Fields (page 232).
4 Click Next.
The Plan Details dialog box appears.

5 Complete the fields using the information in Plan Details Fields (page 233).
6 Click Next.
The Snapshot Retention Policy dialog box appears.

7 Complete the fields using the information in Snapshot Retention Policy Fields (page 233).
Tip

For an explanation of each policy, see Understanding Snapshot Retention


Policies (on page 224).
8 Click Next.

CTERA Portal Datacenter Edition Administrator Guide

229

11

Managing Subscription Plans

The Plan Name and Description dialog box appears.

9 Complete the fields using the information in Plan Name and Description Fields (page
234).
10 Click Next.
The Quotas dialog box appears.

11 For each item, click in the Amount Included field, and then type the number of item units
to include in the subscription plan.
For example, to include 5GB of storage space, click in the Storage Quota (GB) item's
Amount Included field and type 5.

230

CTERA Portal Datacenter Edition Administrator Guide

Managing Subscription Plans

11

Tip

The specified license quotas must not exceed the number specified in the
license. Otherwise, an error message will appear when you attempt to assign a
virtual portal to this plan.
12 Click Next.
The Wizard Completed screen appears.

13 Click Finish.
If you edited an existing plan, the following things happen:
Provisioning changes are applied to all users, and the Apply Provisioning Changes
window opens displaying Running screen with a progress bar that tracks the
operation's progress.

To stop the process, click Stop. To close the progress bar, while the process continues
in the background, click Continue in Background.

CTERA Portal Datacenter Edition Administrator Guide

231

11

Managing Subscription Plans

When the operation is complete, the Completed screen appears.

14 Click Close.
Table 42: Plan Services Fields
In this field...

Do this...

Cloud Backup Service

Indicates that the Cloud Backup Service is included in the


subscription plan.
This field is read-only.

Seeding Supported

Select this option to include backup seeding in the subscription


plan.

Remote Access

Select this option to include remote access in the subscription


plan.
Remote access includes both access to the device's
management interface via the CTERA Portal and a dedicated
URL, access to the user's files via the CTERA Portal and a
dedicated URL.
Note: Device owners can disable remote access via the device's
management interface.

Cloud Drive

Select this option to include private cloud drives in the


subscription plan. In a team portal, users will be able to access
the private cloud drive in addition to the team cloud drive.
Users will be able to access their cloud drives via the End User
Portal's Files tab, for the purpose of viewing, uploading, and
downloading files.

Cloud Drive Invitations

Select this option to include cloud file sharing in the


subscription plan.
This enables the user to send invitations to view or collaborate
on files stored on the cloud drive.

232

CTERA Portal Datacenter Edition Administrator Guide

Managing Subscription Plans

11

Table 43: Plan Details Fields


In this field...

Do this...

Allow users to join this plan

Select this option to allow users to subscribe to this


subscription plan.
If this option is not selected, the subscription plan is invisible to
end users, and only administrators can assign users to this plan.
This field is relevant for reseller portals only.

Free Trial

Select this option to include a free trial period in the


subscription plan. Then type the desired number of days that
subscribers should receive the subscription plan for free. This
field is relevant for reseller portals only.

Table 44: Snapshot Retention Policy Fields


In this field...

Do this...

Retain daily snapshots

Type the number of daily snapshots that should be retained.

Retain weekly snapshots

Type the number of weekly snapshots that should be retained.

Retain monthly snapshots

Type the number of monthly snapshots that should be


retained.

Retain quarterly snapshots

Type the number of quarterly snapshots that should be


retained.

Retain yearly snapshots

Type the number of yearly snapshots that should be retained.

CTERA Portal Datacenter Edition Administrator Guide

233

11

Managing Subscription Plans

Table 45: Plan Name and Description Fields


In this field...

Do this...

Plan Name

Type a name for the subscription plan.

Display Name

Type the name to use when displaying this subscription plan in


the End User Portal and notifications.

Sort Index

Type an index number to assign the subscription plan, in order


to enable custom sorting of the subscription plans displayed to
end users in the Subscribe to Plan wizard.
This field is optional.

Description

Type a description of the subscription plan.


HTML is supported.

Preview

Click this button to view a preview of the subscription plan


description in a new window.

Viewing Subscription Plans


To view all subscription plans in the portal
In the navigation pane, click Provisioning > Plans.
The Provisioning > Plans page appears, displaying all subscription plans.
If a default subscription plan is defined, it is marked with the

icon.

The table includes the following columns.

234

CTERA Portal Datacenter Edition Administrator Guide

Managing Subscription Plans

11

Table 46: Plans Fields


This field...

Displays...

Name

The subscription plan's name.


To edit the subscription plan, click the subscription plan name. For
further details, see Adding and Editing Subscription Plans (on page
228).

Display Name

The subscription plan's name, as displayed in the End User Portal and
notifications.

Sort Index

An index number assigned to the subscription plan, in order to


enable custom sorting of the subscription plans displayed to end
users in the Subscribe to Plan wizard.

Storage

The amount of storage space included in the plan.

Allow Joining

Indicates whether users can subscribe to this plan from the End User
Portal (Yes/No).
Note: If set to No, an administrator can still assign users to this plan.

Trial

If the plan includes a free trial period, this column displays the
number of days included in the free trial period.
If the plan does not include a free trial period, this column displays
No.

Appliance Licenses

The number of CTERA appliance licenses included in the plan. A


CTERA appliance license is consumed by a CTERA appliance
connected to a CTERA Portal user account.

Server Agent Licenses

The number of CTERA Server Agent licenses included in the plan. A


Server Agent license is consumed by a Server Agent in Cloud Agent
mode using the CTERA Cloud Backup service.

Workstation Backup

The number of CTERA Workstation Backup licenses included in the

Licenses

plan. A workstation backup license is consumed by a CTERA


Workstation Agent in Cloud Agent mode using the CTERA Cloud
Backup service.

Cloud Drive Licenses

The number of CTERA Cloud Drive licenses included in the plan. Each
Cloud Drive license enables one user to connect and sync data to the
CTERA Portal for up to five devices associated with the user account,
including: CTERA Agents (Server or Workstation Backup) and mobile
devices (iPhone, iPad, and so on).

CTERA Portal Datacenter Edition Administrator Guide

235

11

Managing Subscription Plans

Setting/Removing the Default Subscription Plan


The default subscription plan is automatically assigned to all new user accounts.
To set a subscription plan as the default
1 In the navigation pane, click Provisioning > Plans.
The Provisioning > Plans page appears, displaying all subscription plans.
2 Select the desired subscription plan's row.
3 Click Set Default.
The selected subscription plan becomes the default subscription plan and is marked with
the

icon.

To remove a subscription plan from being the default


1 In the navigation pane, click Provisioning > Plans.
The Provisioning > Plans page appears, displaying all subscription plans.
2 Select the default subscription plan's row.
3 Click Remove Default.
The subscription plan is no longer the default, and the

icon is removed.

Exporting Subscription Plans to Excel


You can export subscription plans to a CSV file that can be opened with Microsoft Excel.
To export subscription plans
1 In the navigation pane, click Provisioning > Plans.
The Provisioning > Plans page appears, displaying all subscription plans.
2 Click Export to Excel.
All subscription plans are exported to a CSV file.

Applying Provisioning Changes


CTERA Portal applies changed plan and add-on settings to all users every day at midnight. If
desired, you can use the following procedure to apply all changes immediately.
To apply provisioning changes
1 In the navigation pane, click Provisioning > Plans.

236

CTERA Portal Datacenter Edition Administrator Guide

Managing Subscription Plans

11

The Provisioning > Plans page appears, displaying all subscription plans.
2 Click Apply Provisioning Changes.
The following things happen:
Provisioning changes are applied to all users, and the Apply Provisioning Changes
window opens displaying Running screen with a progress bar that tracks the
operation's progress.
To stop the process, click Stop. To close the progress bar, while the process continues
in the background, click Continue in Background.
When the operation is complete, the Completed screen appears.
3 Click Close.

Deleting Subscription Plans


To delete a subscription plan
1 In the navigation pane, click Provisioning > Plans.
The Provisioning > Plans page appears, displaying all subscription plans.
2 Select the desired subscription plan's row.
3 Click Delete Plan.
A confirmation message appears.
4 Click Yes.
The subscription plan is deleted.

CTERA Portal Datacenter Edition Administrator Guide

237

12
Managing Add-ons
In reseller portals, users can subscribe to add-ons, each of which defines a set of services that
subscribed users will receive in addition to the services specified in the subscription plan, for
a specified period of time. In contrast, all users in a team portal obtain additional services for
specified period of time, when the portal is subscribed to a global add-on. For more
information on add-ons, see Understanding CTERA Provisioning.
This chapter explains how to use add-ons to provision services to user's devices (in reseller
portals), as well as how to provision services to virtual portals (including both reseller and
team portals) via global add-ons.
In order to provision global add-ons, these tasks must be performed in the Global
Administration View.

In This Chapter
Adding and Editing Add-ons ----------------------------------------------------------------------------------- 239
Viewing Add-ons -------------------------------------------------------------------------------------------------- 244
Exporting Add-ons to Excel ------------------------------------------------------------------------------------- 244
Applying Provisioning Changes -------------------------------------------------------------------------------- 245
Deleting Add-ons ------------------------------------------------------------------------------------------------- 245

Adding and Editing Add-ons


Once you have added an end-user add-on to the portal, you can then add the add-on directly
to user accounts, as described in Adding Add-ons to User Accounts (on page 83).
Alternatively, for a "pre-paid" business model, you can create vouchers for the add-on, as
described in Adding Vouchers (on page 248). End users can then redeem the vouchers in
order to add the add-on to their user accounts.
Once you have added a portal-level add-on to the system, you can then add the add-on
directly to a portal, as described in Adding Global Add-ons to Virtual Portals (on page 263).
To add or edit an add-on
1 In the navigation pane, click Provisioning > Add-ons.

CTERA Portal Datacenter Edition Administrator Guide

239

12

Managing Add-ons

The Provisioning > Add-ons page appears, displaying all add-ons.

2 Do one of the following:


To add a new add-on, click New.
To edit an existing add-on, select the desired add-on's row and then click Edit.
The Add-on Wizard opens displaying the Add-on Wizard dialog box.

3 Complete the fields using the information in Add-on Services Fields (page 243).
4 Click Next.

240

CTERA Portal Datacenter Edition Administrator Guide

Managing Add-ons

12

A second Add-on Wizard dialog box appears.

5 Complete the fields using the information in Add-on Details Fields (page 243).
6 Click Next.
The Quotas dialog box appears.

7 For each item, click in the Amount Included field, and then type the number of item units
to include in the subscription plan.
For example, to include 5GB of storage space, click in the Storage Quota (GB) item's
Amount Included field and type 5.
8 Click Next.

CTERA Portal Datacenter Edition Administrator Guide

241

12

Managing Add-ons

The Wizard Complete screen appears.

9 Click Finish.
If you edited an existing add-on, the following things happen:
Provisioning changes are applied to all users, and the Apply Provisioning Changes
window opens displaying Running screen with a progress bar that tracks the
operation's progress.

To stop the process, click Stop. To close the progress bar, while the process continues
in the background, click Continue in Background.
When the operation is complete, the Completed screen appears.

242

CTERA Portal Datacenter Edition Administrator Guide

Managing Add-ons

12

10 Click Close.
Table 47: Add-on Services Fields
In this field...

Do this...

Cloud Backup Service

Indicates that the Cloud Backup Service is included in the


add-on.
This field is read-only.

Seeding Supported

Select this option to include backup seeding in the add-on.

Remote Access

Select this option to include remote access in the add-on.


Remote access includes both access to the device's
management interface via the CTERA Portal and a dedicated
URL, access to the user's files via the CTERA Portal and a
dedicated URL.
Note: Device owners can disable remote access via the device's
management interface.

Cloud Drive

Select this option to include private cloud drives in the add-on.


In a team portal, users will be able to access the private cloud
drive in addition to the team cloud drive.
Users will be able to access their cloud drives via the End User
Portal's Files tab, for the purpose of viewing, uploading, and
downloading files.

Allow Invitations

Select this option to include cloud file sharing in the add-on.


When email invitations are enabled for a device, end users will
be able to invite others to view or collaborate on files stored on
the device.

Table 48: Add-on Details Fields


In this field...

Do this...

Name

Type a name for the add-on.

Display Name

Type the name to use when displaying this add-on in the End
User Portal and notifications.

Expires after

Select this option to define an expiration date for the add-on,


then type the number of days after the add-on has been added
to the user account that the add-on should expire.

CTERA Portal Datacenter Edition Administrator Guide

243

12

Managing Add-ons

Viewing Add-ons
To view all add-ons in the portal
In the navigation pane, click Provisioning > Add-ons.
The Provisioning > Add-ons page appears, displaying all add-ons.
The table includes the following columns.
Table 49: Add-ons Fields
This field...

Displays...

Name

The add-on's name.


To edit the add-on, click the add-on name. For further details, see
Adding and Editing Add-ons (on page 239).

Display Name

The add-on's name, as displayed in the End User Portal and


notifications.

Storage

The amount of storage space included in the add-on.

Expires

The number of days after adding this add-on, that the add-on will
expire.

Appliance Licenses

The number of CTERA appliance licenses included in the add-on.

Server Agent Licenses

The number of CTERA Server Agents included in the add-on.

Workstation Backup

The number of CTERA Workstation Backup licenses included in the

Licenses

add-on.

Cloud Drive Licenses

The number of CTERA Cloud Drive licenses included in the add-on.

Exporting Add-ons to Excel


You can export add-ons to a CSV file that can be opened with Microsoft Excel.
To export add-ons
1 In the navigation pane, click Provisioning > Add-ons.
The Provisioning > Add-ons page appears, displaying all add-ons.
2 Click Export to Excel.
All add-ons are exported to a CSV file.

244

CTERA Portal Datacenter Edition Administrator Guide

Managing Add-ons

12

Applying Provisioning Changes


CTERA Portal applies changed plan and add-on settings to all users every day at midnight. If
desired, you can use the following procedure to apply all changes immediately.
To apply provisioning changes
1 In the navigation pane, click Provisioning > Add-ons.
The Provisioning > Add-ons page appears, displaying all add-ons.
2 Click Apply Provisioning Changes.
The following things happen:
Provisioning changes are applied to all users, and the Apply Provisioning Changes
window opens displaying Running screen with a progress bar that tracks the
operation's progress.
To stop the process, click Stop. To close the progress bar, while the process continues
in the background, click Continue in Background.
When the operation is complete, the Completed screen appears.
3 Click Close.

Deleting Add-ons
To delete an add-on
1 In the navigation pane, click Provisioning > Add-ons.
The Provisioning > Add-ons page appears, displaying all add-ons.
2 Select the desired add-on's row.
3 Click Delete.
A confirmation message appears.
4 Click Yes.
The add-on is deleted.

CTERA Portal Datacenter Edition Administrator Guide

245

13
Managing Vouchers
The CTERA Portal enables you to create vouchers, which are prepaid coupons that
encapsulate specific add-ons and plans. For more information on vouchers, see
Understanding CTERA Provisioning.
This chapter explains how to manage vouchers. It is relevant to reseller portals only.
Tip

In order to use vouchers, vouchers support must be enabled in the CTERA Portal
general settings. See Overriding Global Portal Settings (see "Overriding the
Global Virtual Portal Settings" on page 67).

In This Chapter
Adding Vouchers -------------------------------------------------------------------------------------------------- 248
Viewing Vouchers------------------------------------------------------------------------------------------------- 249
Sending Vouchers by Email ------------------------------------------------------------------------------------- 250
Exporting Vouchers to Excel ----------------------------------------------------------------------------------- 251
Deleting Vouchers ------------------------------------------------------------------------------------------------ 251

CTERA Portal Datacenter Edition Administrator Guide

247

13

Managing Vouchers

Adding Vouchers
To add a voucher
1 In the navigation pane, click Provisioning > Vouchers.
The Provisioning > Vouchers page appears, displaying all vouchers.

2 Click New.
The Create Vouchers opens displaying the Create Vouchers dialog box.

3 Complete the fields using the information in the following table.


4 Click Next.

248

CTERA Portal Datacenter Edition Administrator Guide

Managing Vouchers

13

The Wizard Complete screen appears.

5 Click Finish.
Table 50: Voucher Wizard Fields
In this field...

Do this...

Add-on / Plan

Select the add-on or subscription plan to which this voucher


applies.

Voucher Code

Type the voucher code prefix to use for all vouchers of this
type.
This can be any sequence of five alphanumeric characters. For
example: PKG1Y.

Number of Vouchers to Create

Click the arrows or type in the field, to specify the number of


vouchers of this type to create.
For example: 10.

Comment

Type a description of this voucher.


For example: This voucher can be redeemed for 1 year of
10GB online backup service.

Viewing Vouchers
To view all vouchers in the portal
In the navigation pane, click Provisioning > Vouchers.
The Provisioning > Vouchers page appears, displaying all vouchers.
The table includes the following columns.

CTERA Portal Datacenter Edition Administrator Guide

249

13

Managing Vouchers

Table 51: Vouchers Fields


This field...

Displays...

Voucher Code

The voucher's code.

Add-on / Plan

The add-on or subscription plan to which this voucher applies.

Status

The voucher's status.


Active. The voucher has not yet been redeemed.
Redeemed. The voucher has been redeemed by a user, and is no
longer available to be redeemed by other users.

Redeem Date

The date on which the voucher was redeemed.

Redeemed By

The name of the user account that redeemed the voucher.

Issue Date

The date on which the voucher was created.

Comment

A description of the voucher.

Sending Vouchers by Email


You can send an email message to end users, notifying them that a voucher has been issued
to them.
To send a voucher by email
1 In the navigation pane, click Provisioning > Vouchers.
The Provisioning > Vouchers page appears, displaying all vouchers.
2 Select the desired voucher's row, then click Send by Email.
An email message opens in your email client. The message's content can be edited as
desired.
For information on customizing the message's default content, see Customizing Email
Notification Templates (on page 379).
3 In the To field, type the end user's email address.
4 Click Send.

250

CTERA Portal Datacenter Edition Administrator Guide

Managing Vouchers

13

Exporting Vouchers to Excel


You can export vouchers to a CSV file that can be opened in Microsoft Excel.
To export vouchers
1 In the navigation pane, click Provisioning > Vouchers.
The Provisioning > Vouchers page appears, displaying all vouchers.
2 Click Export to Excel.
All vouchers are exported to a CSV file.

Deleting Vouchers
To delete a voucher
1 In the navigation pane, click Provisioning > Vouchers.
The Provisioning > Vouchers page appears, displaying all vouchers.
2 Select the desired voucher's row.
3 Click Delete.
A confirmation message appears.
4 Click Yes.
The voucher is deleted.

CTERA Portal Datacenter Edition Administrator Guide

251

14
Managing Email Invitations
When subscribed to the Cloud File Sharing service, end users can share files and folders
stored on the cloud drive with other people, by sending them an invitation for the desired
files/folders. Invitation recipients are granted read-only or read-write access to the shared
files/folders.
This chapter explains how to manage email invitations.

In This Chapter
Configuring Email Invitation Settings ------------------------------------------------------------------------ 254
Viewing Active Email Invitations ------------------------------------------------------------------------------ 255
Deleting Active Email Invitations ----------------------------------------------------------------------------- 255

CTERA Portal Datacenter Edition Administrator Guide

253

14

Managing Email Invitations

Configuring Email Invitation Settings


You can require invitation recipients to authenticate to the CTERA Portal using their
username and password, before they can access the shared file/folders. In addition, you can
specify how long invitations should be valid.
To configure email invitation settings
1 In the navigation pane, click Settings > Invitations.
The Settings > Invitations page appears.

2 Click Settings.
The Invitations Settings dialog box opens.

3 To require invitation recipients to authenticate using their username and password,


before they can access the shared file/folders, select the User Authentication check box.
4 In the Invitation is valid for field, type the number of days an invitation is valid.

254

CTERA Portal Datacenter Edition Administrator Guide

Managing Email Invitations

14

5 Click Finish.

Viewing Active Email Invitations


To view active email invitations
1 In the navigation pane, click Settings > Invitations.
The Settings > Invitations page appears.
For each invitation the information in the following table is displayed.
2 To view an individual invitation, select the desired invitation, and then click View
Invitation.
The Send Invitation dialog box opens displaying the invitation.
Table 52: Active Email Invitations Information
This field...

Displays...

User

The name of the user who sent the email invitation.


This field only appears when viewing all email invitations in the
system.

Expires On

The date on which the email invitation expires.

Path

The path to the shared file/folder on the cloud drive.

Access

The type of access granted to the invitation recipient (Read Only or


Read/Write).

Deleting Active Email Invitations


If you delete an active email invitation, the path and/or URL it contains can no longer be used
to access files.
To delete active email invitations
1 In the navigation pane, click Settings > Invitations.
The Settings > Invitations page appears.
2 Select the desired invitation, and then click Delete.
A confirmation message appears.
3 Click Yes.
The email invitation is deleted.

CTERA Portal Datacenter Edition Administrator Guide

255

15
Managing Virtual Portals
The CTERA Portal can be divided into tenants, known as virtual portals, each of which
manages a subset of devices and CTERA Portal user accounts. The following types of virtual
portal are supported:
Reseller portal
This type of portal includes support for reseller-oriented features such as add-ons, plans,
vouchers, and self-registration. The end users in the portal are the reseller's subscribers.
Reseller portals are managed by staff administrators in the Staff Control Panel.
Team portal
This type of portal is designed for the needs of a company or team with multiple
members, and as such do not include support for reseller-oriented features. The users in
the portal are the team members.
Team portals are managed by team administrators, who are team members with the
"Administrator role. These users can manage their team portal via the Administration
tab of their End User Portal.
For more detailed information on the two types of virtual portals, see The CTERA Portal
Datacenter Edition (see "Virtual Portals" on page 3).
This chapter explains how to add, edit, and delete virtual portals, as well as log in to any
virtual portal and manage its contents.
The tasks in this chapter can be performed in the Global Administration View only.

In This Chapter
Accessing the Virtual Portal Manager ----------------------------------------------------------------------- 258
Adding and Editing Virtual Portals ---------------------------------------------------------------------------- 259
Viewing Virtual Portals ------------------------------------------------------------------------------------------ 260
Assigning Virtual Portals to Global Plans-------------------------------------------------------------------- 262
Adding Global Add-ons to Virtual Portals------------------------------------------------------------------- 263
Exporting Virtual Portals to Excel ----------------------------------------------------------------------------- 265
Deleting Virtual Portals------------------------------------------------------------------------------------------ 265

CTERA Portal Datacenter Edition Administrator Guide

257

15

Managing Virtual Portals

Accessing the Virtual Portal Manager


Most tasks related to managing virtual portals are performed in the Virtual Portal Manager.
This task can be performed in the Global Administration View only.
To access the Virtual Portal Manager
1 In the navigation pane, click Main > Portals.
The Main > Portals page appears, displaying all virtual portals in the system.

2 Do one of the following:


Select the desired portal's row and click Edit Portal.
Click on the desired portal's name.

258

CTERA Portal Datacenter Edition Administrator Guide

Managing Virtual Portals

15

The Virtual Portal Manager opens displaying the Profile tab.

Adding and Editing Virtual Portals


This task can be performed in the Global Administration View only.
To add or edit a virtual portal
1 Do one of the following:
To add a new virtual portal, in the Main > Portals page, click New Portal.
To edit an existing virtual portal, access the Virtual Portal Manager.
See Accessing the Virtual Portal Manager (on page 258).
The Virtual Portal Manager opens displaying the Profile tab.
2 Complete the fields using the information in the following table.
3 Click Save.

CTERA Portal Datacenter Edition Administrator Guide

259

15

Managing Virtual Portals

Table 53: Virtual Portal Profile Fields


In this field...

Do this...

Name

Type a name (unique identifier) for the virtual portal.

Type

Select the virtual portal's type.


For information on portal types, see The CTERA Portal
Datacenter Edition (see "Virtual Portals" on page 3).
This field is read-only, when editing an existing virtual portal.

Catalog Node Server

Select the virtual portal's catalog node server. Catalog node


servers are database servers that store metadata. CTERA Portal
supports multiple catalog node servers for scalability.

Status

Select the status of the virtual portal to enabled or disabled.


If you set the status to disabled, the following things happen:
Users cannot log in to the portal, and devices cannot
connect.
Reports and email notifications are not sent from the
portal.
User self-registration is disabled.
Global administrators can still connect to disabled portals via
the Global Administration View.

Billing ID

Optionally use this field to enter the virtual portal owner's


billing ID. This enables integration of the portal with an external
billing system.

Provision quotas for this virtual

This field is relevant for reseller portals only. Deselect this box

portal

to allow a reseller unlimited quotas (subject only to the limits of


the portal license).

Viewing Virtual Portals


This task can be performed in the Global Administration View only.
To view all virtual portals
In the navigation pane, click Main > Portals.
The Main > Portals page appears, displaying all virtual portals in the system.
Reseller portals are indicated by the
icon.

icon, and team portals are indicated by the

The table includes the following columns.

260

CTERA Portal Datacenter Edition Administrator Guide

Managing Virtual Portals

15

Table 54: Virtual Portal Fields


This field...

Displays...

Name

The virtual portal's name.


To edit the virtual portal, click the portal's name. For further details,
see Adding and Editing Virtual Portals (on page 259).

Status

The status of the virtual portal (enabled or disabled).


If the status is disabled, the following are true:
Users cannot log in to the portal, and devices cannot connect.
Reports and email notifications are not sent from the portal.
User self-registration is disabled.
Global administrators can still connect to disabled portals via the
Global Administration View.

Subscription Plan

The global plan to which this virtual portal is assigned.


To modify the plan, click the plan's name. For further details, see
Adding and Editing Subscription Plans (on page 228).

Add Ons

The number of add-ons for the virtual portal.


To modify the list of add-ons, click on the number. For further
details, see Adding and Editing Add-ons (on page 239).

Connected Devices

The number of devices currently connected to the virtual portal.

Storage

The amount of storage in use by the virtual portal, out of the total
provisioned amount.

Appliance Licenses

The number of CTERA appliance licenses in use by the virtual portal,


out of the total provisioned number.

Server Agent Licenses

The number of CTERA Server Agent licenses in use by the virtual


portal, out of the total provisioned number.

Workstation Backup

The total number of CTERA Workstation Backup licenses in use by

Licenses

the virtual portal, out of the total provisioned number.

Cloud Drive

The number of Cloud Drive licenses in use by the virtual portal, out
of the total provisioned number.

Users

The number of user accounts defined in the virtual portal.

Billing ID

The virtual portal owner's billing ID.

Catalog Node Server

The virtual portal's catalog node server. Catalog node servers are
database servers that store metadata. CTERA Portal supports
multiple catalog node servers for scalability.

CTERA Portal Datacenter Edition Administrator Guide

261

15

Managing Virtual Portals

Assigning Virtual Portals to Global Plans


This task can be performed in the Global Administration View only.
To assign a virtual portal to a global plan
1 Access the Virtual Portal Manager.
See Accessing the Virtual Portal Manager (on page 258).
2 If the virtual portal is a reseller portal, select the Provision quotas for this virtual portal
check box.
3 Click the Provisioning tab.
The Provisioning tab appears.

4 In the Subscription Plan field, click

262

CTERA Portal Datacenter Edition Administrator Guide

Managing Virtual Portals

15

The Select Your Subscription Plan dialog box opens.

5 In the Subscription Plan drop-down list, select the global plan to assign the portal.
6 Click OK.
7 In the Subscription Expiration field, you can click
to specify the date on which the
portal's subscription to the selected plan should expire. This field is only relevant for
plans that are defined as time limited trial plans. Otherwise the field is disabled.
8 Click Save.
The virtual portal is assigned to the subscription plan.

Adding Global Add-ons to Virtual Portals


This task can be performed in the Global Administration View only.
To add global add-ons to a virtual portal
1 Access the Virtual Portal Manager.
See Accessing the Virtual Portal Manager (on page 258).
2 If the virtual portal is a reseller portal, select the Provision quotas for this virtual portal
check box.
3 Click the Provisioning tab.
The Provisioning tab appears.
4 To add an add-on for the virtual portal, do the following:
a In the drop-down list, select the desired add-on.
b Click Add.

CTERA Portal Datacenter Edition Administrator Guide

263

15

Managing Virtual Portals

The global add-on appears in the list box.

c In the add-on's row in the list box, click in the Valid For column, then click

A calendar appears.
d Select the date on which the add-on subscription should end.
The Expiration column is updated accordingly.
5 To remove an add-on from the virtual portal, in the add-on's row in the list box, click
.
The add-on is removed.
6 Click Save.
The virtual portal is assigned to the add-ons.

264

CTERA Portal Datacenter Edition Administrator Guide

Managing Virtual Portals

15

Exporting Virtual Portals to Excel


You can export a list of user virtual portals and their details to a Comma Separated Values
(*.csv) file on your computer, which you can open with Microsoft Excel.
This task can be performed in the Global Administration View only.
To export virtual portals to Excel
1 In the navigation pane, click Main > Portals.
The Main > Portals page appears, displaying all virtual portals in the system.
2 Click Export to Excel.
The virtual portals are exported.

Deleting Virtual Portals


Warning

When a virtual portal is deleted, all of its contents are deleted as well. Deleted
portals cannot be recovered.
This task can be performed in the Global Administration View only.
To delete a virtual portal
1 Do one of the following:
In the Main > Portals page, select the desired portal's row, then click Delete Portal.
Access the Virtual Portal Manager, then click Delete.
See Accessing the Virtual Portal Manager (on page 258).
A confirmation message appears.
2 Click Yes.
The virtual portal and all of its contents are deleted.

CTERA Portal Datacenter Edition Administrator Guide

265

16
Managing Servers
Global administrators can manage the servers on which CTERA Portal is installed.
This chapter explains how to manage servers.
The tasks in this chapter can be performed in the Global Administration View only.

In This Chapter
Accessing the Server Manager -------------------------------------------------------------------------------- 268
Editing Server General Settings ------------------------------------------------------------------------------- 269
Configuring a Server as a Catalog Node --------------------------------------------------------------------- 271
Editing Server SMTP Settings ---------------------------------------------------------------------------------- 271
Viewing Connected Devices ------------------------------------------------------------------------------------ 273
Monitoring Server Activity ------------------------------------------------------------------------------------- 275
Viewing Server Tasks -------------------------------------------------------------------------------------------- 276
Viewing Servers' Statuses--------------------------------------------------------------------------------------- 279
Restarting Servers ------------------------------------------------------------------------------------------------ 280

CTERA Portal Datacenter Edition Administrator Guide

267

16

Managing Servers

Accessing the Server Manager


Tasks related to managing and monitoring a server are performed in the Server Manager.
This task can be performed in the Global Administration View only.
To access the Server Manager
1 In the navigation pane, click Main > Servers.
The Main > Servers page appears, displaying all servers.

2 Do one of the following:


Select the desired server's row and click View.
Click on the desired server's name.

268

CTERA Portal Datacenter Edition Administrator Guide

Managing Servers

16

The Server Manager opens displaying the General Settings tab.

Editing Server General Settings


You can edit a server's settings, including configuring a server as a catalog node and/or
application server, setting the public IP address of the server, and the IP address to which
each virtual portal's DNS should resolve. This allows you to restrict specific portals to be
accessible only from a specific network interface.
This task can be performed in the Global Administration View only.
To edit a server's general settings
1 Access the Server Manager.
See Accessing the Server Manager (on page 268).
2 In the Name field, type a unique identifier for the server.
3 To configure the server to act as an application server, select the Act as application
server checkbox. An application server accepts CTTP connections from devices and HTTPS
connections from end users and CTERA Mobile. If the checkbox is unchecked, this server
will not allow any client logins.
4 To configure the server to act as a catalog node, select the Catalog Node checkbox. A
catalog node is a database server used to store file metadata.

CTERA Portal Datacenter Edition Administrator Guide

269

16

Managing Servers

5 To declare that the server's default IP address has a public Network Address Translation
(NAT) address, check the Public NAT Address checkbox and type the public IP address in
the field. This controls the default IP address of this server that is exposed using DNS.
6 By default, the portal listens to virtual portals on the default address. You can optionally
bind specific virtual portals to other interfaces (specified by IP address) of the server,
which will cause this IP address to be published by the DNS server, and will prevent
access to the specified portal via other IP addresses of the server. To set custom address
mappings, do the following:
a Select the Custom Address Mappings check box.
The Custom Address Mappings table is enabled.

b For each virtual portal that should be bound to an IP address of the server, do the
following:
1 In the virtual portal's row, click in the IP Address field, then type the IP address to
be translated. This should be the IP address of the local interface which should
accept connections for clients of the specified virtual portal.
To bind this virtual portal to the default IP address, do not enter a value in this
field.

270

CTERA Portal Datacenter Edition Administrator Guide

Managing Servers

16

2 If NAT is used, and the public IP address of the interface differs from the private IP
address, click in the NAT IP Address field in the virtual portal's row, and then type
the IP address to which the original IP address should be translated. This public
address will be published by the CTERA Portal DNS server.
To specify that the public IP address is equal to the private IP address, do not
enter a value in this field.
7 Click Save.

Configuring a Server as a Catalog Node


CTERA Portal supports multiple catalog nodes (metadata database servers). The Server
Manager enables you to configure a server to act as a catalog node.
To configure a CTERA Portal server to act as a catalog node
1 Access the Server Manager.
See Accessing the Server Manager (on page 268).
2 Select the Catalog Node checkbox.
3 Click Save.

Editing Server SMTP Settings


You can override global mail server settings for the server. For information on global mail
server settings, see Configuring Global Mail Server Settings (on page 45).
This task can be performed in the Global Administration View only.
To edit a server's SMTP settings
1 Access the Server Manager.
See Accessing the Server Manager (on page 268).
2 Click the SMTP Settings tab.

CTERA Portal Datacenter Edition Administrator Guide

271

16

Managing Servers

The SMTP Settings tab appears.

3 Complete the fields using the information in the following table.


4 Click Save.

272

CTERA Portal Datacenter Edition Administrator Guide

Managing Servers

16

Table 55: Server Manager SMTP Settings Fields


In this field...

Do this...

SMTP Settings

Select this option to override global mail server settings.


The remaining fields are enabled.

SMTP Server

Type the outgoing mail server address for sending email


messages from the CTERA Portal to users.

SMTP Port

Type the port number for sending email messages from the
CTERA Portal to users.

Enable TLS

Select this option to enable using Transport Layer Security (TLS)


encryption for SMTP connections.
Your SMTP server must support TLS, in order to use this
feature.

Server requires authentication

Select this option if the SMTP server requires authentication.

Username

Type the user name that the CTERA Portal should use when
authenticating to the SMTP server.

Password

Type the password that the CTERA Portal should use when
authenticating to the SMTP server.

Viewing Connected Devices


You can view information about a server's currently connected devices.
This task can be performed in the Global Administration View only.

To view a server's currently connected devices


1 Access the Server Manager.
See Accessing the Server Manager (on page 268).
2 Click the Clients tab.

CTERA Portal Datacenter Edition Administrator Guide

273

16

Managing Servers

The Clients tab appears.

For information on the Client tab fields, see the following table.
Table 56: Server Clients Fields
This field...

Displays...

Name

The name of the client device.

Owner

The name of the client device's owner.

Total In

The total CTTP traffic sent from the client device to the virtual portal.

Total Out

The total CTTP traffic sent from the virtual portal to the client device.

Average In

The average speed (throughput) of traffic sent from the client device
to the virtual portal in bytes/second.

Average Out

The average speed (throughput) of traffic sent from the virtual portal
to the client device in bytes/second.

In Backup

Indicates whether the client device is currently backing up files to the


CTERA Portal. Devices in backup are marked with the

icon;

otherwise, no icon appears.


Connected Since

274

The date and time of connected.

CTERA Portal Datacenter Edition Administrator Guide

Managing Servers

16

Monitoring Server Activity


You can view charts displaying a server's activity data.
This task can be performed in the Global Administration View only.

To view a server's activity


1 Access the Server Manager.
See Accessing the Server Manager (on page 268).
2 Click the Activity tab.
The Activity tab appears.

For information on the charts displayed, see the following table.

CTERA Portal Datacenter Edition Administrator Guide

275

16

Managing Servers

Table 57: Server Activity Charts


This chart...

Displays...

Load Average

The server's average load over time.


A server's load is the number of currently running processes that are
using, or waiting to use, the CPU.

Java RAM Usage (MB)

The server's Java RAM usage in MB over time.

Storage Traffic In

The incoming storage traffic in KB/second over time.

(KB/Second)
Storage Traffic Out

The outgoing storage traffic in KB/second over time.

(KB/Second)
Storage Operation In

The number of read operations performed by the CTERA Portal on

(IO/Second)

cloud storage nodes.

Storage Operation Out

The number of store operations performed by the CTERA Portal on

(IO/Second)

cloud storage nodes.

CTTP Traffic In (KB/Second)

The incoming CTTP traffic in KB/second over time.

CTTP Traffic Out

The outgoing CTTP traffic in KB/second over time.

(KB/Second)
Blocks Verification Counter

The number of block verifications per minute. Block verifications are

(OPP/Minute)

executed when the portal is executing a consistency check as part of


system maintenance.

Open Database Connections The number of open database connections over time.
Logged In Users

The number of CTERA Portal administrators logged in over time.

Connected Devices

The number of connected client devices over time.

Viewing Server Tasks


You can view the server's currently running tasks and completed tasks.
This task can be performed in the Global Administration View only.

To view a server's tasks


1 Access the Server Manager.
See Accessing the Server Manager (on page 268).
2 Click the Tasks tab.

276

CTERA Portal Datacenter Edition Administrator Guide

Managing Servers

16

The Tasks tab appears.

3 Do any of the following:


To view currently running tasks, clicks the Running Tasks sub-tab.
To view completed tasks, clicks the Recently Completed sub-tab.
To view scheduled tasks that have not yet been started, clicks the Scheduled Tasks
sub-tab.
The relevant information appears. For information on the fields displayed, see the
following table.

CTERA Portal Datacenter Edition Administrator Guide

277

16

Managing Servers

Table 58: Server Tasks Fields


This field...

Displays...

Task

The type of task. This can be any of the following:


Unused block cleaner
Agent licensing refresh
Alert sender
FSCK
Inactive account cleaner
Expired invitations cleaner
Logs Cleaner
Generate user notifications
Notification suppress cleaner
Report generator
Snapshot consolidator
Snapshot cleaner
Storage usage calculator
Certificate update
Update user accounts

Status

The task's status. This can be any of the following:


. Completed successfully.
. In progress.
. Failed.
This field is not relevant for scheduled tasks.

Start

The date and time at which the task started or is scheduled to start.

Duration

The amount of time the task took, or has taken so far.


This field is not relevant for scheduled tasks.

Progress

The task's progress.


This field is not relevant for scheduled tasks.

Message

Additional information about the task.


This field is not relevant for scheduled tasks.

278

CTERA Portal Datacenter Edition Administrator Guide

Managing Servers

16

Viewing Servers' Statuses


You can view the current status of servers.
This task can be performed in the Global Administration View only.

To view servers' statuses


1 In the navigation pane, click Main > Servers.
The Main > Servers page appears, displaying all servers.
The Status column displays the current status of each server (Connected / Not
Connected).
2 Access the Server Manager.
See Accessing the Server Manager (on page 268).
3 Click the Status tab.
The Status tab appears.

For information on the Status tab fields, see the following table.

CTERA Portal Datacenter Edition Administrator Guide

279

16

Managing Servers

Table 59: Server Manager Status Fields


In this field...

Do this...

Storage Pools

The status and amount of free storage on each server storage


pool.
This field appears only if the CTERA Portal is installed on the
OpenSolaris platform.

Address

The server's domain name followed by its IP address.

DB Connected

States whether the DB is connected to the CTERA Portal


application.

Main DB Server

States whether the server is the main DB server of the CTERA


Portal installation.

Operating System

The server's operating system.

RAM

The server's RAM followed by the amount of free space.

Number of CPUs

The number of CPUs on the server.

Portal Version

The CTERA Portal version installed on the server.

Image Version

The version number of the server image.

Uptime

The number of days and hours that the server has been up.

Tomcat Uptime

The number of days and hours that the application server


(Tomcat) has been up.

Restarting Servers
CTERA Portal servers can be restarted from the CTERA Portal web page.
To restart a server
1 Access the Server Manager.
See Accessing the Server Manager (on page 268).
2 Select the server you want to restart.
3 Click Restart.
The server is restarted.

280

CTERA Portal Datacenter Edition Administrator Guide

17
Managing Firmware Images
Each device (CTERA appliance or CTERA Agent) in the CTERA Portal system is installed with a
firmware image that suits the device platform. (For convenience, we refer to CTERA Agent
software packages as a type of "firmware").
This chapter explains how to manage firmware images.
The tasks in this chapter can be performed in the Global Administration View only.

In This Chapter
Uploading Firmware Images ----------------------------------------------------------------------------------- 282
Viewing Firmware Images -------------------------------------------------------------------------------------- 283
Marking a Firmware Image as the Current Firmware Image------------------------------------------- 283
Deleting Firmware Images-------------------------------------------------------------------------------------- 284
Viewing Devices that Use a Specific Firmware Image --------------------------------------------------- 284

CTERA Portal Datacenter Edition Administrator Guide

281

17

Managing Firmware Images

Uploading Firmware Images


This task can be performed in the Global Administration View only.
To upload a firmware image
1 In the navigation pane, click Main > Firmware Repository.
The Main > Firmware Repository page appears, displaying all firmware images.

2 Click Upload.
The Upload Firmware Wizard opens displaying the Upload Firmware dialog box.

3 Click Upload and browse to the desired *.tgz file.


The firmware image is uploaded to the relevant device platform category.

282

CTERA Portal Datacenter Edition Administrator Guide

Managing Firmware Images

17

At the end of the upload process, the Completing the Upload Firmware Wizard screen
appears.

4 Click Finish.

Viewing Firmware Images


This task can be performed in the Global Administration View only.
To view all firmware images in the system
In the navigation pane, click Main > Firmware Repository.
The Main > Firmware Repository page appears.
The firmware images and their device platform categories are displayed in a tree. The
current firmware image for each platform is marked with a
image sizes are specified.

icon, and the firmware

Marking a Firmware Image as the Current Firmware Image


When you mark a firmware image as the current firmware image, all devices of the relevant
device platform that are set to automatically download firmware images will download this
firmware image.
There can only be one current firmware image per device platform.
This task can be performed in the Global Administration View only.
To mark a firmware image as the current firmware image
1 In the navigation pane, click Main > Firmware Repository.
The Main > Firmware Repository page appears, displaying all firmware images.
2 Select the desired firmware image's row.

CTERA Portal Datacenter Edition Administrator Guide

283

17

Managing Firmware Images

3 Click Mark as Current.


The selected firmware image becomes the current firmware image and is marked with
the

icon.

To mark a firmware image as not current


1 In the navigation pane, click Main > Firmware Repository.
The Main > Firmware Repository page appears, displaying all firmware images.
2 Select the desired firmware image's row.
3 Click Remove Current.
The selected firmware image is marked with the

icon.

Deleting Firmware Images


This task can be performed in the Global Administration View only.
To delete a firmware image
1 In the navigation pane, click Main > Firmware Repository.
The Main > Firmware Repository page appears, displaying all firmware images.
2 Select the desired firmware image's row.
3 Click Delete.
A confirmation message appears.
4 Click Yes.
The firmware image is deleted.

Viewing Devices that Use a Specific Firmware Image


You can view all devices that are configured to use a specific firmware.
To view devices with a specific firmware configured
1 In the navigation pane, click Main > Firmware Repository.
The Main > Firmware Repository page appears, displaying all firmware images.
2 Click on the firmware image you want to search for.
3 Click Show devices.
The Main > Devices page appears, displaying the devices that are configured to use the
specified firmware.

284

CTERA Portal Datacenter Edition Administrator Guide

Managing Firmware Images

17

Tip

You can achieve the same results by searching for the desired firmware in the
Main > Device page. See Searching Tables (on page 22).

CTERA Portal Datacenter Edition Administrator Guide

285

18
Managing Storage Nodes
The CTERA Portal stores data on storage nodes. This chapter explains how to manage storage
nodes.
The tasks in this chapter can be performed in the Global Administration View only.

In This Chapter
Adding and Editing Storage Nodes --------------------------------------------------------------------------- 287
Viewing Storage Nodes------------------------------------------------------------------------------------------ 317
Deleting Storage Nodes ----------------------------------------------------------------------------------------- 318

Adding and Editing Storage Nodes


This task can be performed in the Global Administration View only.
To add or edit a storage node
1 In the navigation pane, click Main > Storage Nodes.
The Main > Storage Nodes page appears, displaying all storage nodes.

2 Do one of the following:

CTERA Portal Datacenter Edition Administrator Guide

287

18

Managing Storage Nodes

To add a new storage node, click New.


To edit an existing storage node, select the desired node's row and then click Edit.
The Storage Node Wizard opens displaying the Storage Node Wizard dialog box.

3 Complete the fields using the information in the following table.


4 Click Next.
Do one of the following:
If you selected Amazon S3, continue at Using an Amazon S3 Storage Node (on page
290).
If you selected Caringo Storage, continue at Using a Caringo Storage Node (on page
291).
If you selected Cleversafe, continue at Using a Cleversafe Storage Node (on page
295).
If you selected Cloudian, continue at Using a Cloudian Storage Node (on page 296).
If you selected CTERA Cloud FS, continue at Using a CTERA Cloud FS Storage Node
(on page 298).
If you selected Dell DX, continue at Using a Dell DX Object Storage Platform Storage
Node (on page 299).
If you selected DDN Web Object Scaler, continue at Using a DDN Web Object Scaler
Storage Node (see "Using a DDN Web Object Scaler (WOS) Storage Node" on page
302).
If you selected EMC Atmos, continue at Using an EMC Atmos Storage Node (on page
304).
If you selected Hitachi HCP, continue at Using a Hitachi Content Platform Storage
Node (on page 305).

288

CTERA Portal Datacenter Edition Administrator Guide

Managing Storage Nodes

18

If you selected IBM GPFS, continue at Using an IBM GPFS Storage Node (on page
307).
If you selected MezeoCloud, continue at Using a MezeoCloud Storage Node (on page
309).
If you selected Nirvanix Cloud Storage Network, continue at Using a Nirvanix Cloud
Storage Network Storage Node (on page 310).
If you selected OpenStack Swift, continue at Using an OpenStack Swift Storage Node
(on page 312).
If you selected OpenStack Swift (KeyStone), continue at Using an OpenStack Swift
(KeyStone) Storage Node (on page 313).
If you selected Scality (S3 API), continue at Using a Scality (S3 API) Storage Node (on
page 314).
If you selected Scality RING, continue at Using a Scality RING Storage Node (on page
316).
Table 60: Storage Node Fields
In this field...

Do this...

Type

Select the storage node type.

Storage Node Name

Type a name (unique identifier) for the storage node.

Operation Mode

Choose the desired operation mode for the storage node. This
can be either of the following:
Read / Write. New data blocks can be stored on the
storage node.
Read-Only. New data blocks cannot be stored on the
storage node. Instead, they will be directed to storage
nodes that are in Read/Write mode.
Note: CTERA Portal will delete blocks that are deemed to be no
longer in use, even if the storage node is in Read-Only mode.

Dedicated to Portal

Select the checkbox if you want to dedicate the storage node to


one virtual portal. Select the virtual portal from the dropdown
list.

CTERA Portal Datacenter Edition Administrator Guide

289

18

Managing Storage Nodes

Using an Amazon S3 Storage Node


The Amazon S3 dialog box appears.

1 Complete the fields using the information in the following table.


2 Click Next.
The Wizard Completed screen appears.

3 Click Finish.

290

CTERA Portal Datacenter Edition Administrator Guide

Managing Storage Nodes

18

Table 61: Amazon S3 Fields


In this field...

Do this...

Bucket Name

Type your Amazon S3 bucket.

Access Key ID

Type your Amazon S3 access key ID.

Secret Access Key

Type your Amazon S3 storage node's secret access key.

Endpoint

Type the endpoint name of the S3 service.


The default value is s3.amazonaws.com. Normally, this value
should not be changed.

Use HTTPS

Select this option to use HTTPS to connect with the storage


node.

Using a Caringo Storage Node


The Caringo Storage dialog box appears.

CTERA Portal Datacenter Edition Administrator Guide

291

18

Managing Storage Nodes

1 Complete the fields using the relevant information in the following table.
If you selected Static Members in the Discover mode field, the fields change.

Do the following:
a Add each cluster member's address, by typing the cluster member's address in the
field provided, and then clicking Add.
A row appears in the table.

b To delete a cluster member's address, click

in its row.

2 Click Next.

292

CTERA Portal Datacenter Edition Administrator Guide

Managing Storage Nodes

18

A second Caringo Storage dialog box appears.

3 Complete the fields using the relevant information in the following table.
4 Click Next.
The Wizard Completed screen appears.

5 Click Finish.

CTERA Portal Datacenter Edition Administrator Guide

293

18

Managing Storage Nodes

Table 62: Caringo Storage Fields


In this field...

Do this...

Discovery mode

Select the discovery method to use to detect cluster


members:
Use SCSP Proxy. Use automatic discovery.
Static Members. Specify cluster members manually.

Proxy Address

Type the IP address or DNS name of your Caringo Storage


Node SCSP Proxy Server.

Cluster Name

Type your Caringo Storage Node cluster name.

Use HTTPS only

Select this option to use only HTTPS to connect with the


storage node. If this option is not selected, HTTP will be used
instead.
Note: Enabling HTTPS reduces performance.

Use Named Objects

Select this option to use named objects. This is


recommended if multi-tenancy is required, (that is, if the
Caringo Storage Node cluster is shared by other applications
or portals). If this option is not selected, objects will be
stored as unnamed objects.

Domain

If Caringo Storage Node is segmented into multiple domains,


(each with its own security and authentication and each
subdivided into "buckets"), type the relevant domain's name.

Bucket

Type the name of your Caringo Storage Node bucket.


This field is optional.

294

Username

Type your user ID for accessing Caringo Storage Node.

Password

Type your password for accessing Caringo Storage Node.

CTERA Portal Datacenter Edition Administrator Guide

Managing Storage Nodes

18

Using a Cleversafe Storage Node


The Cleversafe dialog box appears.

1 Complete the fields using the information in the following table.


2 Click Next.
The Wizard Completed screen appears.

3 Click Finish.

CTERA Portal Datacenter Edition Administrator Guide

295

18

Managing Storage Nodes

Table 63: Cleversafe Fields


In this field...

Do this...

Bucket Name

Type your Cleversafe bucket.

Access Key ID

Type your Cleversafe access key ID.

Secret Access Key

Type your Cleversafe storage node's secret access key.

Endpoint

Type the endpoint name of the Cleversafe service.

Use HTTPS

Select this option to use HTTPS to connect with the storage


node.

Using a Cloudian Storage Node


The Cloudian dialog box appears.

1 Complete the fields using the information in the following table.


2 Click Next.

296

CTERA Portal Datacenter Edition Administrator Guide

Managing Storage Nodes

18

The Wizard Completed screen appears.

3 Click Finish.
Table 64: Cloudian Fields
In this field...

Do this...

Bucket Name

Type your Cloudian bucket.

Access Key ID

Type your Cloudian access key ID.

Secret Access Key

Type your Cloudian storage node's secret access key.

Endpoint

Type the endpoint name of the Cloudian service.

Use HTTPS

Select this option to use HTTPS to connect with the storage


node.

CTERA Portal Datacenter Edition Administrator Guide

297

18

Managing Storage Nodes

Using a CTERA Cloud FS Storage Node


When using a CTERA Cloud FS storage node, data blocks are stored in a specific folder in the
primary CTERA Portal server's local file system.
CTERA Portal servers set to secondary mode access the storage node by communicating
through the primary CTERA Portal server.
Tip

When using this type of storage node, it is recommended to set the


de-duplication block size to 512KB or larger.
The CTERA Cloud FS dialog box appears.

1 Complete the fields using the information in the following table.


2 Click Next.
The Wizard Completed screen appears.

298

CTERA Portal Datacenter Edition Administrator Guide

Managing Storage Nodes

18

3 Click Finish.
Table 65: CTERA Cloud FS Fields
In this field...

Do this...

Host Address

Type the host address of the primary server.

Folder Path

Type the path in where files should be stored in the local file
system.

Files per Folder

Type the maximum number of files to store in a folder.


The default value is 1024.

Use fsync

Select this option to specify that blocks of data should be


flushed to disk immediately. Using fsync prevents data loss in
the event of a power failure.

Using a Dell DX Object Storage Platform Storage Node


The Dell DX dialog box appears.

1 Complete the fields using the relevant information in the following table.

CTERA Portal Datacenter Edition Administrator Guide

299

18

Managing Storage Nodes

If you selected Static Members in the Discover mode field, the fields change.

Do the following:
a Add each cluster member's address, by typing the cluster member's address in the
field provided, and then clicking Add.
A row appears in the table.

b To delete a cluster member's address, click

in its row.

2 Click Next.

300

CTERA Portal Datacenter Edition Administrator Guide

Managing Storage Nodes

18

A second Dell DX dialog box appears.

3 Complete the fields using the relevant information in the following table.
4 Click Next.
The Wizard Completed screen appears.

5 Click Finish.

CTERA Portal Datacenter Edition Administrator Guide

301

18

Managing Storage Nodes

Table 66: Dell DX Fields


In this field...

Do this...

Discovery mode

Select the discovery method to use to detect cluster members:


Use SCSP Proxy. Use automatic discovery.
Static Members. Specify cluster members manually.

Proxy Address

Type the IP address or DNS name of your Dell DX SCSP Proxy


Server.

Cluster Name

Type your Dell DX cluster name.

Use HTTPS

Select this option to use HTTPS to connect with the storage


node. If this option is not selected, HTTP will be used instead.
Note: Enabling HTTPS reduces performance.

Use Named Objects

Select this option to use named objects. This is recommended if


multi-tenancy is required, (that is, if the Dell DX cluster is
shared by other applications or portals). If this option is not
selected, objects will be stored as unnamed objects.

Domain

If Dell DX is segmented into multiple domains, (each with its


own security and authentication and each subdivided into
"buckets"), type the relevant domain's name.

Bucket

Type the name of your Dell DX bucket.


This field is optional.

Username

Type your user ID for accessing Dell DX.

Password

Type your password for accessing Dell DX.

Using a DDN Web Object Scaler (WOS) Storage Node


The DDN Web Object Scaler dialog box appears.

302

CTERA Portal Datacenter Edition Administrator Guide

Managing Storage Nodes

18

1 Complete the fields using the information in the following table.


2 Click Next.
The Wizard Completed screen appears.

3 Click Finish.
Table 67: DDN Web Object Scaler Fields
In this field...

Do this...

Primary Node Address

Type the primary node address of your DDN Web Object Scaler
storage node.

Secondary Node Address

Type the secondary node address of your DDN Web Object


Scaler storage node.

Policy Name

Type the policy name of your DDN Web Object Scaler storage
node.

CTERA Portal Datacenter Edition Administrator Guide

303

18

Managing Storage Nodes

Using an EMC Atmos Storage Node


The EMC Atmos dialog box appears.

1 Complete the fields using the information in the following table.


2 Click Next.
The Wizard Completed screen appears.

3 Click Finish.

304

CTERA Portal Datacenter Edition Administrator Guide

Managing Storage Nodes

18

Table 68: EMC Atmos Fields


In this field...

Do this...

Full Token Id

Type your EMC Atmos full token ID.

Access Point

Type the host name of the EMC Atmos storage node.

Shared Secret

Type your EMC Atmos shared secret.

Use HTTPS

Select this option to use HTTPS to connect with the storage


node.

Using a Hitachi Content Platform Storage Node


The Hitachi HCP dialog box appears.

1 Complete the fields using the information in the following table.


2 Click Next.

CTERA Portal Datacenter Edition Administrator Guide

305

18

Managing Storage Nodes

The Wizard Completed screen appears.

3 Click Finish.
Table 69: Hitachi HCP Fields
In this field...

Do this...

Bucket Name

Type the name of your Hitachi HCP bucket.

User

Type your user ID for accessing Hitachi HCP.

Password

Type your password for accessing Hitachi HCP.

Use HTTPS

Select this option to use HTTPS to connect with the storage


node. If this option is not selected, HTTP will be used instead.
Note: Enabling HTTPS reduces performance.

306

CTERA Portal Datacenter Edition Administrator Guide

Managing Storage Nodes

18

Using an IBM GPFS Storage Node


The IBM General Parallel File System (GPFS) is a high-performance cluster file system,
meaning that it provides concurrent access to a single file system or set of file systems from
multiple nodes. These nodes can be all be SAN attached, or a combination of SAN and
network attached. This enables high performance access to a common set of data, in order to
support a scale-out solution or provide a high availability platform.
When using CTERA Portal with IBM GPFS, CTERA Portal servers have active-active access to
the stored data. This means that each CTERA Portal server has equal and independent access
to the data stored by all other CTERA Portal servers. If one CTERA Portal server fails, another
server immediately and transparently takes its place.
In addition, the CTERA Portal database can be stored on the GPFS file system.
Tip

When using this type of storage node, it is recommended to set the


de-duplication block size to 512KB.
The IBM GPFS dialog box appears.

1 Complete the fields using the information in the following table.


2 Click Next.

CTERA Portal Datacenter Edition Administrator Guide

307

18

Managing Storage Nodes

The Wizard Completed screen appears.

3 Click Finish.
Table 70: IBM GPFS Fields
In this field...

Do this...

Storage Path

Type the path in where files should be stored in the GPFS file
system.

Files per Folder

Type the maximum number of files to store in a folder.


The default value is 1024.

Use fsync

Select this option to specify that blocks of data should be


flushed to disk immediately. Using fsync prevents data loss in
the event of a power failure.

308

CTERA Portal Datacenter Edition Administrator Guide

Managing Storage Nodes

18

Using a MezeoCloud Storage Node


The MezeoCloud dialog box appears.

1 Complete the fields using the information in the following table.


2 Click Next.
The Wizard Completed screen appears.

3 Click Finish.

CTERA Portal Datacenter Edition Administrator Guide

309

18

Managing Storage Nodes

Table 71: MezeoCloud Fields


In this field...

Do this...

Bucket Name

Type your Mezeo bucket.

Access Key ID

Type your Mezeo access key ID.

Secret Access Key

Type your Mezeo storage node's secret access key.

Endpoint

Type the host name of the Mezeo storage node.

Use HTTPS

Select this option to use HTTPS to connect with the storage


node.

Using a Nirvanix Cloud Storage Network Storage Node


The Nirvanix Cloud Storage Network dialog box appears.

1 Complete the fields using the information in the following table.


2 Click Next.

310

CTERA Portal Datacenter Edition Administrator Guide

Managing Storage Nodes

18

The Wizard Completed screen appears.

3 Click Finish.
Table 72: Nirvanix Cloud Storage Network Fields
In this field...

Do this...

Bucket Name

Type your Nirvanix Cloud Storage Network bucket.

Username

Type your user ID for accessing Nirvanix Cloud Storage


Network.

Password

Type your password for accessing Nirvanix Cloud Storage


Network.

Application Key

Type your Nirvanix Cloud Storage Network application key.

CTERA Portal Datacenter Edition Administrator Guide

311

18

Managing Storage Nodes

Using an OpenStack Swift Storage Node


The OpenStack Swift dialog box appears.

1 Complete the fields using the information in the following table.


2 Click Next.
The Wizard Completed screen appears.

3 Click Finish.

312

CTERA Portal Datacenter Edition Administrator Guide

Managing Storage Nodes

18

Table 73: OpenStack Swift Fields


In this field...

Do this...

Bucket Name

Type your OpenStack Swift bucket.

Username

Type your user ID for accessing OpenStack Swift.

API Key

Type your OpenStack Swift API key.

Endpoint

Type the endpoint name of the OpenStack Swift service.

Using an OpenStack Swift (KeyStone) Storage Node


The OpenStack Swift (KeyStone) dialog box appears.

1 Complete the fields using the information in the following table.


2 Click Next.
The Wizard Completed screen appears.

CTERA Portal Datacenter Edition Administrator Guide

313

18

Managing Storage Nodes

3 Click Finish.
Table 74: OpenStack Swift (KeyStone) Fields
In this field...

Do this...

Bucket Name

Type your OpenStack Swift (Keystone) bucket.

Tenant

Type your OpenStack Swift (Keystone) tenant.

Username

Type your user ID for accessing OpenStack Swift (Keystone).

Password

Type your password for accessing OpenStack Swift (Keystone).

Authentication URL

Type your OpenStack Swift (Keystone) authentication URL.

Using a Scality (S3 API) Storage Node


The Scality (S3 API) dialog box appears.

1 Complete the fields using the information in the following table.


2 Click Next.

314

CTERA Portal Datacenter Edition Administrator Guide

Managing Storage Nodes

18

The Wizard Completed screen appears.

3 Click Finish.
Table 75: Scality (S3 API) Fields
In this field...

Do this...

Bucket Name

Type your Scality (S3 API) bucket.

Access Key ID

Type your Scality (S3 API) access key ID.

Secret Access Key

Type your Scality (S3 API) storage node's secret access key.

Endpoint

Type the endpoint name of the Scality (S3 API) service.

Use HTTPS

Select this option to use HTTPS to connect with the storage


node.

CTERA Portal Datacenter Edition Administrator Guide

315

18

Managing Storage Nodes

Using a Scality RING Storage Node


The Scality RING storage node is a high-performance cluster file system, meaning that it
provides concurrent access to a single file system or set of file systems from multiple nodes.
These nodes can be all be SAN attached, or a combination of SAN and network attached. This
enables high performance access to a common set of data, in order to support a scale-out
solution or provide a high availability platform.
When using CTERA Portal with Scality RING, CTERA Portal servers have active-active access to
the stored data. This means that each CTERA Portal server has equal and independent access
to the data stored by all other CTERA Portal servers. If one CTERA Portal server fails, another
server immediately and transparently takes its place.
In addition, the CTERA Portal database can be stored on the Scality RING file system.
Tip

When using this type of storage node, it is recommended to set the


de-duplication block size to 512KB.
The Scality RING dialog box appears.

1 Complete the fields using the information in the following table.


2 Click Next.

316

CTERA Portal Datacenter Edition Administrator Guide

Managing Storage Nodes

18

The Wizard Completed screen appears.

3 Click Finish.
Table 76: Scality RING Fields
In this field...

Do this...

Storage Path

Type the path in where files should be stored in the Scality


RING file system.

Files per Folder

Type the maximum number of files to store in a folder.


The default value is 1024.

Use fsync

Select this option to specify that blocks of data should be


flushed to disk immediately. Using fsync prevents data loss in
the event of a power failure.

Viewing Storage Nodes


This task can be performed in the Global Administration View only.
To view all storage nodes in the system
In the navigation pane, click Main > Storage Nodes.
The Main > Storage Nodes page appears, displaying all storage nodes.
The table includes the following columns.

CTERA Portal Datacenter Edition Administrator Guide

317

18

Managing Storage Nodes

Table 77: Storage Nodes Fields


This field...

Displays...

Name

The storage node's name.


To edit the storage node, click the storage node name. For further
details, see Adding and Editing Storage Nodes (on page 287).

Type

The storage node's type.

Bucket

The name of the storage node's bucket.

Operation Mode

The storage node's operation mode. This can be any of the following:
Read/Write
Read Only

Dedicated to

The name of a single virtual portal to which the storage node is


dedicated, if applicable.

Status

The storage node's current status. This can be either of the


following:
Connected
Not Connected
Note: The system will not attempt to store new blocks in storage
nodes that are not connected.

Storage Usage

The amount of storage used, followed by the amount of free space.


This field is relevant for CTERA storage nodes only.
Note: The system will not attempt to store new blocks in storage
nodes that are out of disk space.

Deleting Storage Nodes


This task can be performed in the Global Administration View only.
To delete a storage node
1 In the navigation pane, click Main > Storage Nodes.
The Main > Storage Nodes page appears, displaying all storage nodes.
2 Select the desired storage node's row.
3 Click Delete.
A confirmation message appears.
4 Click Yes.
The storage node is deleted.

318

CTERA Portal Datacenter Edition Administrator Guide

Managing Storage Nodes

CTERA Portal Datacenter Edition Administrator Guide

18

319

19
Importing and Exporting Folders
(Seeding)
This chapter explains how to import and export customer's data to and from the CTERA
Portal.

In This Chapter
Importing Folders Over NFS ------------------------------------------------------------------------------------ 321
Exporting Folders ------------------------------------------------------------------------------------------------- 334

Importing Folders Over NFS


When an end user has a lot of information to back up, the initial backup to the cloud can take
a long time. You can speed up initial backup for your customers by offering a backup seeding
service. Customers who are subscribed to this service can store the files they want to include
in the initial backup on a selected hard drive called a seeding hard drive, and then deliver the
seeding hard drive to you, the CTERA Portal owner.
Tip

The seeding hard drive can optionally be encrypted using strong encryption
(AES-256 + RSA) so even if the drive is lost, there is very little risk to the
customers sensitive information while in transit.
You then perform backup seeding, that is, you create the customer's initial backup by
importing folders directly from the hard drive you received.
The CTERA Portal includes a special utility for performing backup seeding over the NFS
protocol. The import is performed by attaching the seeding hard drive to a seeding station,
which is a CTERA Cloud Attached Storage appliance that is connected to the CTERA Portal's
LAN.
Tip

All CTERA Cloud Attached Storage appliance models are supported.


To import folders over NFS
1 Prepare for seeding.

CTERA Portal Datacenter Edition Administrator Guide

321

19

Importing and Exporting Folders (Seeding)

See Preparing for Seeding (on page 322).


Tip

You only need to perform this step once, in order to prepare the seeding station
and the seeding hard drive(s).
2 Perform seeding at the customer premises.
See Performing Seeding at the Customer Premises (on page 330).
3 Perform seeding import at the CTERA Portal Datacenter.
See Performing Seeding Import at the CTERA Portal Datacenter.

Preparing for Seeding


You only need to perform this step once, in order to prepare the seeding station and the
seeding hard drive(s).
To prepare for seeding
1 Connect the seeding station to the CTERA Portal's LAN.
2 Log in to the seeding station's Web interface.
3 Disable autosharing, by doing the following:
a In the Configuration tab's navigation pane, click Share > Shares.
The Share > Shares page appears.

b Click Autosharing.

322

CTERA Portal Datacenter Edition Administrator Guide

Importing and Exporting Folders (Seeding)

19

The External Volume Autosharing dialog box opens.

c Clear the Automatically share External volumes with these permissions check box.
d Click Finish.
4 Take the seeding hard drive and connect it to the seeding station.
5 Format the seeding hard drive, by doing the following:
a In the Configuration tab's navigation pane, click Storage > Arrays or Storage >
Volumes.
The relevant page appears.
b Click Storage Setup Wizard.
The Easy Storage Setup Wizard opens, displaying the Easy Storage Setup dialog box.

c Click Format next to the seeding hard drive.


A confirmation message appears.

CTERA Portal Datacenter Edition Administrator Guide

323

19

Importing and Exporting Folders (Seeding)

d Click Yes.
The drive is formatted, and all of its contents are erased.
e Click Next.
The Proposed Actions dialog box appears describing the changes.

Click Next.
The Wizard Completed screen appears.

g Click Finish.
6 Rename the new volume to "seeding", by doing the following:
a In the Configuration tab's navigation pane, click Storage > Volumes.

324

CTERA Portal Datacenter Edition Administrator Guide

Importing and Exporting Folders (Seeding)

19

The Storage > Volumes page appears.

b Click on the new volume's name.


The Logical Volume Wizard opens, displaying the Specify Volume Details dialog box.

c Click Next.

CTERA Portal Datacenter Edition Administrator Guide

325

19

Importing and Exporting Folders (Seeding)

The Name this Logical Volume dialog box appears.

d In the Volume Name field, type "seeding".


e Click Next.
The Wizard Completed screen appears.

Click Finish.

7 Create a new NFS-enabled share named "seeding" in the root of the "seeding" volume, by
doing the following:
a In the Configuration tab's navigation pane, click Share > Shares.

326

CTERA Portal Datacenter Edition Administrator Guide

Importing and Exporting Folders (Seeding)

19

The Share > Shares page appears.

b Click New Share.


The Network Share Wizard opens, displaying the Select a Folder to Share dialog box
appears.

c Select the "seeding" folder.


d Click Next.

CTERA Portal Datacenter Edition Administrator Guide

327

19

Importing and Exporting Folders (Seeding)

The Specify the Network Share Name dialog box appears.

e In the Network Share Name field, type "seeding".


f

Click Next.
The Sharing Protocols dialog box appears.

g Click Next.

328

CTERA Portal Datacenter Edition Administrator Guide

Importing and Exporting Folders (Seeding)

19

The NFS (UNIX File Sharing) dialog box appears.

h Select the Enable NFS access check box.


i

Add the CTERA Portal server's IP addresses as NFS clients, by doing the following:
1 Click New.
A row appears in the table.

2 Click in the Host column and type the IP address.


3 Click in the Netmask column and edit the netmask.
4 Click in the Permission column and select the permitted level of access to the
network share via NFS.
j

Click Next.

CTERA Portal Datacenter Edition Administrator Guide

329

19

Importing and Exporting Folders (Seeding)

The Configure Permissions dialog box appears.

k Click Next.
The Wizard Completed screen appears.

Click Finish.
The network share is added.

8 Ship the seeding hard drive to the customer premises.

Performing Seeding at the Customer Premises


To perform seeding at the customer premises
1 Connect the seeding hard drive to the source appliance.
2 Select the files and folders you want to include in the initial backup.
Refer to the appliance User Guide, "Selecting Files and Folders for Cloud Backup".
These files and folders will be written to the seeding drive.

330

CTERA Portal Datacenter Edition Administrator Guide

Importing and Exporting Folders (Seeding)

19

3 Log in to the appliance's Web interface.


4 In the Configuration tab's navigation pane, click Cloud Backup > Control Panel.
The Control Panel page appears.

5 Click Seeding.
The Select seeding destination dialog box appears.

6 Choose the "seeding" volume.


7 To encrypt the seeding drive, select the Use encryption check box.
8 Click Finish.

CTERA Portal Datacenter Edition Administrator Guide

331

19

Importing and Exporting Folders (Seeding)

A confirmation message appears.


9 Click Yes.
The selected files and folders are written to the seeding drive.

Importing the Seeding Drive


You can import a portable seeding hard drive by mounting it on a local NFS server and
running the Seeding wizard.
To import a seeding hard drive
1 Mount your portable seeding hard drive on a locally accessible NFS server.
2 In the navigation pane, click Folders > Seeding.
The Folders > Seeding page appears, displaying all home folders.

3 Click Import. The Seeding wizard appears.

4 In the NFS Server field, enter the NFS Server's IP address or DNS name.
5 In the NFS Path field, enter the path to your seeding drive on the NFS server.

332

CTERA Portal Datacenter Edition Administrator Guide

Importing and Exporting Folders (Seeding)

19

6 Click Next.
The Confirmation screen appears.

7 Click Next.
Files are imported from the seeding hard drive, and the Importing Files window opens
displaying Running screen with a progress bar that tracks the operation's progress.

To stop the process, click Stop. To close the progress bar, while the process continues in
the background, click Continue in Background.
When the operation is complete, the Completed screen appears.

8 Click Close.

CTERA Portal Datacenter Edition Administrator Guide

333

19

Importing and Exporting Folders (Seeding)

Exporting Folders
You can perform large restore operations by exporting folders from the CTERA Portal onto a
portable hard drive or a new device, and delivering it to the customer.
To export folders
1 Mount a hard drive on one of the CTERA Portal servers.
2 In the command line, enter the following command:
telnet localhost
3 Enter the following command:
login admin admin username
Where username is your CTERA Portal global administrator user name.
You are prompted for your password.
4 Enter your password.
5 To export a snapshot of the folder other than the current one, do the following:
a Enter the following command:
snapshot list /portals/portal-name/backups/folder-name
Where:
portal-name is the name of the virtual portal on which the desired backup folder
is located.
folder-name is the name of the backup folder for which you want to view a list of
snapshots.
A list of folder snapshots appears, for example:
1351722386000 - 01.11.2012 12-26-26 AM
1351724574000 - 01.11.2012 1-02-54 AM
1351796267000 - 01.11.2012 8-57-47 PM
1351864966000 - 02.11.2012 4-02-46 PM

b Take note of the ID of the snapshot you want to export.


The snapshot ID is the long number at the beginning of each row.
6 Enter the following command:
export-folder /portals/portal-name/backups/folder-type path destination-path
[snapshot-ID]

334

CTERA Portal Datacenter Edition Administrator Guide

Importing and Exporting Folders (Seeding)

19

Where:
portal-name is the name of the virtual portal on which the desired backup folder is
located.
folder-type is the folder's type: either "backups" or "homeFolders".
path is the path within the cloud folder to export.
All files and subfolders located under this path will be exported. Use a slash "/" to
export the entire cloud folder.
destination-path is the path to the hard drive.
snapshot-ID is the ID of the snapshot you want to export. If you do not include this
parameter, the current snapshot will be exported.
The following things happen:
If the folder is passphrase-protected, you are prompted to enter a passphrase. Enter
you passphrase.
The folder is exported to the selected destination folder.

CTERA Portal Datacenter Edition Administrator Guide

335

20
Monitoring the CTERA Portal
This chapter explains how to use the Status Dashboard, CTERA Portal reports, CTERA Portal
logs, and other means to monitor your CTERA Portal.
In order to monitoring an individual virtual portal, perform these tasks within the desired
portal. In order to monitor all virtual portals in the system, these tasks must be performed in
the Global Administration View.

In This Chapter
Viewing the Status Dashboard -------------------------------------------------------------------------------- 337
Viewing Reports--------------------------------------------------------------------------------------------------- 341
Configuring Logging ---------------------------------------------------------------------------------------------- 356
Viewing Logs ------------------------------------------------------------------------------------------------------- 359
Clearing Logs ------------------------------------------------------------------------------------------------------- 375
Using CTERA Portal Email Notifications --------------------------------------------------------------------- 375
Using Email Alerts ------------------------------------------------------------------------------------------------ 382

Viewing the Status Dashboard


The Status Dashboard provides an overview of the CTERA Portal's current status, including
the following:
The amount of cloud storage provisioned and used
The number of CTERA Agent licenses provisioned and used
The connection status of all device types in the CTERA Portal system
The number of new devices and users in the CTERA Portal system
To view the Status Dashboard
In the navigation pane, click Main > Dashboard.

CTERA Portal Datacenter Edition Administrator Guide

337

20

Monitoring the CTERA Portal

The Main > Dashboard page appears.

For information on the fields displayed, see the following table.


Tip

The data is automatically refreshed, every few seconds.

338

CTERA Portal Datacenter Edition Administrator Guide

Monitoring the CTERA Portal

20

Table 78: Status Dashboard Fields


This field...

Displays...

Cloud Storage (GB)


Limit

The total amount of cloud storage available for this virtual portal in GB,
over the past month. This field does not appear in the Global
Administration View.

Provisioned

The amount of cloud storage space provisioned to portal users in GB,


over the past month.

In Use

The amount of cloud storage space used by portal users in GB, over the
past month.

Users
New (last 30 days)

The number of new users added to the system, over the last 30 days.

New today

The number of new users added to the system today.

Total

The total number of users in the system, over the past month.

Server Agent Licenses


Limit

The total number of CTERA Server Agent licenses available for this
virtual portal, over the past month. This field does not appear in the
Global Administration View.

Provisioned

The number of CTERA Server Agent licenses provisioned to portal users,


over the past month.

In Use

The number of CTERA Server Agent licenses used by portal users, over
the past month.

Workstation Backup
Licenses
Limit

The total number of CTERA Workstation Backup licenses available for


this virtual portal, over the past month. This field does not appear in the
Global Administration View.

Provisioned

The number of CTERA Workstation Backup licenses provisioned to portal


users, over the past month.

In Use

The number of CTERA Workstation Backup licenses used by portal users,


over the past month.

Cloud Drive Licenses


Limit

The total number of CTERA Cloud Drive licenses available for this virtual
portal, over the past month. This field does not appear in the Global
Administration View.

CTERA Portal Datacenter Edition Administrator Guide

339

20

Monitoring the CTERA Portal

Provisioned

The number of CTERA Cloud Drive licenses provisioned to portal users,


over the past month.

In Use

The number of CTERA Cloud Drive licenses used by portal users, over the
past month.

Appliance Licenses
Limit

The total number of CTERA Appliance licenses available for this virtual
portal, over the past month. This field does not appear in the Global
Administration View.

Provisioned

The number of CTERA Appliance licenses provisioned to portal users,


over the past month.

In Use

The number of CTERA Appliance licenses used by portal users, over the
past month.

Devices by Type
Connected

The number of devices that are currently connected to the CTERA


Portal.

Disconnected

The number of devices that are currently not connected to the CTERA
Portal.

Total

340

The total number of devices defined in the CTERA Portal.

CTERA Portal Datacenter Edition Administrator Guide

Monitoring the CTERA Portal

20

Viewing Reports
The CTERA Portal provides the following reports:
Table 79: CTERA Portal Reports
This report...

Is available for...

Folders

Reseller portals, team portals

Folder Groups

Reseller portals, team portals

Devices

Reseller portals, team portals, the CTERA Portal system

Plans

Reseller portals, team portals

Plans by Portal

The CTERA Portal system

Global Plans

The CTERA Portal system

Add-ons

Reseller portals

Add-ons by Portal

The CTERA Portal system

Global Addons

The CTERA Portal system

Storage

The CTERA Portal system

Portals

The CTERA Portal system

To view a report for the CTERA Portal system, you must open the report in the Global
Administration View.

CTERA Portal Datacenter Edition Administrator Guide

341

20

Monitoring the CTERA Portal

Viewing the Folders Report


You can view detailed information about all folders, including deleted ones.
To view the Folders Report
1 In the navigation pane, click Main > Reports.
The Main > Reports page appears displaying the Folders Report.

If a CTERA Portal administrator already ran the Folders Report, the report is displayed,
and the report date appears in the Last run on field. For information on the fields
displayed, see the following table.
2 If the Last run on field displays "Never", or if you would like to update the displayed
report, click Run.
A new report is generated. For information on the fields displayed, see the following
table.

342

CTERA Portal Datacenter Edition Administrator Guide

Monitoring the CTERA Portal

20

Table 80: Folders Report Fields


This field...

Displays...

Name

The folder's name.

Folder Type

The type of folder (Home Folder/Backup Folder)

Owner

The folder's owner.

Deleted

Indicates whether the folder has been deleted (true/false).

Storage Quota Usage

The percentage of storage quota used.

All Snapshots Size

The size of all snapshots of this folder.

Files in Upload Size

The size of files that are currently being uploaded to this folder.

Current Snapshot Files

The number of files in the current snapshot (that is, not including
previous versions that are stored for this folder).

All Snapshots Files

The total number of files in all snapshots (that is, including previous
versions that are stored for this folder).

Files in Upload

The number of files that are currently being uploaded to this folder.

Bad Files

The number of corrupted files in the folder.

Snapshots Number

The number of previous versions currently stored for this folder.

Viewing the Folder Groups Report


You can view detailed information about all folder groups, including deleted ones.
To view the Folder Groups Report
1 In the navigation pane, click Main > Reports.
The Main > Reports page appears.
2 In the Topic drop-down list, select Folder Groups.

CTERA Portal Datacenter Edition Administrator Guide

343

20

Monitoring the CTERA Portal

The Folder Groups Report is displayed.

If a CTERA Portal administrator already ran the Folder Groups Report, the report is
displayed, and the report date appears in the Last run on field. For information on the
fields displayed, see the following table.
3 If the Last run on field displays "Never", or if you would like to update the displayed
report, click Run.
A new report is generated. For information on the fields displayed, see the following
table.

344

CTERA Portal Datacenter Edition Administrator Guide

Monitoring the CTERA Portal

20

Table 81: Folder Groups Report Fields


This field...

Displays...

Name

The folder group's name.

Owner

The folder group's owner.

Deleted

Indicates whether the folder group has been deleted (true/false).

Storage Space

The amount of storage space consumed by this folder group.

Mapfile Overhead

The amount of space consumed by the mapfiles for this folder group.

Uncompressed Files Size

The uncompressed size of the files in folders belonging to this folder


group.

Files in Upload Size

The size of files that are currently being uploaded to folders belonging
to this folder group.

Number of Folders

The number of folders belonging to this folder group.

Uploaded Blocks

The number of uploaded blocks in folders belonging to this folder


group.

In Upload Blocks

The number of blocks currently being uploaded to folders belonging


to this folder group.

In Upload Mapfiles

The number of mapfiles currently being uploaded to folders belonging


to this folder group.

Missing Blocks

The number of missing blocks in folders belonging to this folder


group.

Total Mapfiles

The total number of mapfiles in folders belonging to this folder group.

Missing Mapfiles

The number of missing mapfiles in folders belonging to this folder


group.

Total Files

The total number of files in folders belonging to this folder group.

Files in Upload

The number of files that are currently being uploaded to folders


belonging to this folder group.

Bad Files

The number of corrupted files in folders belonging to this folder


group.

CTERA Portal Datacenter Edition Administrator Guide

345

20

Monitoring the CTERA Portal

Viewing the Devices Report


You can view detailed information about all devices.
To view the Devices Report
1 In the navigation pane, click Main > Reports.
The Main > Reports page appears.
2 In the Topic drop-down list, select Devices.
The Devices Report is displayed.

If a CTERA Portal administrator already ran the Devices Report, the report is displayed,
and the report date appears in the Last run on field. For information on the fields
displayed, see the following table.
3 If the Last run on field displays "Never", or if you would like to update the displayed
report, click Run.
A new report is generated. For information on the fields displayed, see the following
table.

346

CTERA Portal Datacenter Edition Administrator Guide

Monitoring the CTERA Portal

20

Table 82: Devices Report Fields


This field...

Displays...

Device Type

The device type.

Amount

The number of devices of this type.

Connected

The number of devices of this type that are currently connected to the
CTERA Portal.

Not Connected

The number of devices of this type that are currently not connected
to the CTERA Portal.

Total Local Storage

The total amount of local storage space reported by devices of this


type.

Free Local Storage

The amount of local storage space that is currently reported as


unused by devices of this type.

Viewing the Plans, Global Plans, or Plans by Portal Report


You can view detailed information about all plans.
To view the Plans Report
1 In the navigation pane, click Main > Reports.
The Main > Reports page appears.
2 In the Topic drop-down list, select Plans.
The Plans Report is displayed.

If a CTERA Portal administrator already ran the Plans Report, the report is displayed, and
the report date appears in the Last run on field. For information on the fields displayed,
see the following table.
3 If the Last run on field displays "Never", or if you would like to update the displayed
report, click Run.

CTERA Portal Datacenter Edition Administrator Guide

347

20

Monitoring the CTERA Portal

A new report is generated. For information on the fields displayed, see the following
table.

348

CTERA Portal Datacenter Edition Administrator Guide

Monitoring the CTERA Portal

20

Table 83: Plans Report Fields


This field...

Displays...

Portal

The name of the portal. This field is relevant to the Plans by Portal
report only.

Name

The plan's name.

Subscriptions

The number of subscriptions to the plan.

Expired

The number of expired subscriptions to the plan.

Total Storage Space

The total amount of cloud storage space quota included in all


instances of this plan, in GB.
For example, if 10 users are subscribed to a plan with 10GB storage
space, this field will display 100GB.

Server Agent Licenses

The total number of server agent licenses included in all instances of


this plan.
For example, if 10 users are subscribed to a plan with 5 server agent
licenses, this field will display 50.

Workstation Backup

The total number of workstation backup licenses included in all

Licenses

instances of this plan.


For example, if 10 users are subscribed to a plan with 10 workstation
backups, this field will display 100.

Appliance Licenses

The total number of appliance licenses included in all instances of this


plan.
For example, if 10 users are subscribed to a plan with 10 appliance
licenses, this field will display 100.

Cloud Drive Licenses

The total number of Cloud Drive licenses included in all instances of


this plan.
For example, if 10 users are subscribed to a plan with 10 Cloud Drive
licenses, this field will display 100.

CloudPlug

The number of CloudPlug appliances owned by users who are


subscribed to the plan.

C200

The number of C200 appliances owned by users who are subscribed


to the plan.

C400

The number of C400 appliances owned by users who are subscribed


to the plan.

C800

The number of C800 appliances owned by users who are subscribed


to the plan.

CTERA Portal Datacenter Edition Administrator Guide

349

20

Monitoring the CTERA Portal

Cloud Server Agent

The number of server agents in Cloud Agent mode owned by users


who are subscribed to the plan.

Cloud Workstation Backup

The number of workstation agents in Cloud Agent mode owned by


users who are subscribed to the plan.

Viewing the Add-Ons, Global Add-ons, or Add-ons by Portal Report


You can view detailed information about all add-ons.
To view the Add-Ons Report
1 In the navigation pane, click Main > Reports.
The Main > Reports page appears.
2 In the Topic drop-down list, select Add-Ons.
The Add-Ons Report is displayed.

If a CTERA Portal administrator already ran the Add-Ons Report, the report is displayed,
and the report date appears in the Last run on field. For information on the fields
displayed, see the following table.
3 If the Last run on field displays "Never", or if you would like to update the displayed
report, click Run.
A new report is generated. For information on the fields displayed, see the following
table.

350

CTERA Portal Datacenter Edition Administrator Guide

Monitoring the CTERA Portal

20

Table 84: Add-Ons Report Fields


This field...

Displays...

Portal

The name of the portal. This field is relevant to the Add-ons by Portal
report only.

Name

The add-on's name.

Amount in use

The number of add-ons that are currently in use.

Storage Quota

The amount of storage space included in a single instance of this


add-on.

Total Storage Space

The total amount of storage space included in all instances of this


add-on.
For example, if the storage quota of a single instance of this add-on is
10GB, and the add-on is used 15 times, then the total storage space is
150GB.

Server Agent Licenses

The total number of server agent licenses included in all instances of


this add-on.

Workstation Backup

The total number of workstation backup licenses included in all

Licenses

instances of this add-on.

Appliance Licenses

The total number of appliance licenses included in all instances of this


add-on.

Cloud Drive Licenses

The total number of Cloud Drive licenses included in all instances of


this add-on.

CTERA Portal Datacenter Edition Administrator Guide

351

20

Monitoring the CTERA Portal

Viewing the Storage Report


Global administrators can view information about the CTERA Portal storage nodes.

To view the Storage Report


1 In the navigation pane, click Main > Reports.
The Main > Reports page appears displaying the Storage Report.

If a CTERA Portal administrator already ran the Storage Report, the report is displayed,
and the report date appears in the Last run on field. For information on the fields
displayed, see the following table.
2 If the Last run on field displays "Never", or if you would like to update the displayed
report, click Run.
A new report is generated. For information on the fields displayed, see the following
table.

352

CTERA Portal Datacenter Edition Administrator Guide

Monitoring the CTERA Portal

20

Table 85: Storage Report Fields


This field...

Displays...

Location Type

The storage node's type.

Name

The name of the storage node.

Deleted

Indicates whether the storage node has been deleted (true/false).

Storage Space

The amount of storage space available on this storage node.

Mapfile Overhead

The amount of space consumed by the mapfiles for this server.

Uploaded Blocks

The number of uploaded blocks in this storage node.

Missing Blocks

The number of missing blocks in this storage node.

Total Mapfiles

The total number of mapfiles in this storage node.

Missing Mapfiles

The number of missing mapfiles in this storage node.

In Upload Blocks

The number of blocks currently being uploaded to the storage node.

In Upload Mapfiles

The number of mapfiles currently being uploaded to this storage


node.

Viewing the Portals Report


Global administrators can view information about all virtual portals.

To view the Portals Report


1 In the navigation pane, click Main > Reports.
The Main > Reports page appears.
2 In the Topic drop-down list, select Portals.

CTERA Portal Datacenter Edition Administrator Guide

353

20

Monitoring the CTERA Portal

The Portals Report is displayed.

If a CTERA Portal administrator already ran the Portals Report, the report is displayed,
and the report date appears in the Last run on field. For information on the fields
displayed, see the following table.
3 If the Last run on field displays "Never", or if you would like to update the displayed
report, click Run.
A new report is generated. For information on the fields displayed, see the following
table.

354

CTERA Portal Datacenter Edition Administrator Guide

Monitoring the CTERA Portal

20

Table 86: Portals Report Fields


This field...

Displays...

Name

The virtual portal's name.

Deleted

Indicates whether the virtual portal has been deleted (true/false).

Storage Quota

The storage quota allocated to this virtual portal by the global


administrator.
If the quota is unlimited, this field will be empty.

Storage Quota Allocated

For a reseller portal, this field displays the sum of all storage quotas
allocated to users in the portal.
For a team portal, this field displays the sum of all storage quotas
currently being used by users in the portal.

Storage Quota Usage

The amount of storage space used in this virtual portal.

All Snapshots Size

The size of all snapshots of this virtual portal.

Physical Storage

The amount of physical storage used by this virtual portal.

Files in Upload Size

The size of files that are currently being uploaded to this virtual portal.

Current Snapshot Files

The number of files in the current snapshot (that is, not including
previous versions that are stored for this virtual portal).

All Snapshots Files

The total number of files in all snapshots (that is, including previous
versions that are stored for this virtual portal).

Files in Upload

The number of files that are currently being uploaded to this virtual
portal.

Bad Files

The number of corrupted files in the virtual portal.

Snapshots Number

The number of previous versions currently stored for this virtual


portal.

Server Agents (quota)

The quota of server agents allocated to this virtual portal by the global
administrator.
If the quota is unlimited, this field will be empty.

Server Agents (allocated)

For a reseller portal, this field displays the sum of all server agent
quotas allocated to users in the portal.
For a team portal, this field displays the sum of all server agent quotas
currently being used by users in the portal.

Server Agents (used)

The number of server agent licenses used in this virtual portal.

Workstation Backups

The quota of workstation backups allocated to this virtual portal by

(quota)

the global administrator.


If the quota is unlimited, this field will be empty.

CTERA Portal Datacenter Edition Administrator Guide

355

20

Monitoring the CTERA Portal

Workstation Backups

For a reseller portal, this field displays the sum of all workstation

(allocated)

backup quotas allocated to users in the portal.


For a team portal, this field displays the sum of all workstation backup
quotas currently being used by users in the portal.

Workstation Backups (used) The number of workstation backup licenses used in this virtual portal.
Appliances (used)

The total number of appliances defined in the virtual portal.

Cloud Drives (quota)

The quota of cloud drives allocated to this virtual portal by the global
administrator.
If the quota is unlimited, this field will be empty.

Cloud Drives (allocated)

For a reseller portal, this field displays the sum of all cloud drive
quotas allocated to users in the portal.
For a team portal, this field displays the sum of all cloud drive quotas
currently being used by users in the portal.

Cloud Drives (used)

The number of cloud drive licenses used in this virtual portal.

Connected Devices

The number of devices that are currently connected to the virtual


portal.

Total Users

The total number of users defined in the virtual portal.

Exporting Reports to Excel


You can export reports to a CSV file that can be opened in Microsoft Excel.
To export a report
1 View the desired report.
See Viewing Reports (on page 341).
2 Click Export to Excel.
The report is exported to a CSV file.

Configuring Logging
You can configure CTERA Portal Event Log settings, as well as Syslog settings.

356

CTERA Portal Datacenter Edition Administrator Guide

Monitoring the CTERA Portal

20

Configuring Event Log Settings


Global administrators can configure Event Log settings for all virtual portals.
This task can be performed in the Global Administration View only.

To configure Event Log settings


1 In the navigation pane, click Logs & Alerts > Log Settings.
The Logs & Alerts > Log Settings page appears.

2 In the Keep logs for field, type the number of days that the CTERA Portal should store
logs.
The default value is 30 days.
3 In the Log Level drop-down list, select the minimum log level to display in the CTERA
Portal.
For example, if you select Critical, then only Alert, Critical, and Emergency logs will appear
in the CTERA Portal.
The default value is Info.
4 In the Cloud Drive Logging field, select one of the following:
None. Disables logging of reads and writes to the cloud drive.
Reads and Writes. Enables logging of reads and writes to the cloud drive, for auditing
purposes.
Writes Only. Enables logging of only writes to the cloud drive.

CTERA Portal Datacenter Edition Administrator Guide

357

20

Monitoring the CTERA Portal

5 Click Save.

Configuring Syslog Logging


If desired, you can configure the CTERA Portal to send logs to a Syslog server located on your
network or on the Internet.
This task must be performed in the Global Administration View.
Tip

You can obtain free Syslog servers online, such as Kiwi Syslog Daemon
(http://www.kiwisyslog.com/).
To configure Syslog logging
1 In the navigation pane, click Logs & Alerts > Syslog.
The Logs & Alerts > Syslog page appears.

2 Complete the fields using the information in the following table.


3 Click Save.

358

CTERA Portal Datacenter Edition Administrator Guide

Monitoring the CTERA Portal

20

Table 87: Syslog Fields


In this field...

Do this...

Use Syslog

Select this option to enable Syslog logging.


You must complete the rest of the fields.

Minimum Event Severity

Select the minimum log level to send to the Syslog server.


For example, if you select Critical, then only Alert, Critical, and
Emergency logs will be sent to the Syslog server.
The default value is Info.

Server Address

Type the Syslog server IP address.

Syslog Port

Type the Syslog server's port number.


The default value is 514.

Viewing Logs
The CTERA Portal Log Viewer includes the following log categories:
Table 88: Log Categories
This log category...

Displays...

And is available for...

System

All events that do not belong in

Reseller portals, team portals, the

other log categories.

CTERA Portal system

Events related to synchronization

Reseller portals, team portals

Local Backup

operations.
Cloud Backup

Events related to backup or restore Reseller portals, team portals


operations.

Cloud Sync

Events related to cloud drive

Reseller portals, team portals

synchronization operations
Access

Events related to user access to the Reseller portals, team portals, the
CTERA Portal.

CTERA Portal system

Changes to the CTERA Portal

Reseller portals, team portals, the

configuration.

CTERA Portal system

Agents

Events related to CTERA Agents.

Reseller portals, team portals

Accounting

Events related to accounting.

Reseller portals

Audit

Viewing logs for the CTERA Portal system is available in the Global Administration View.

CTERA Portal Datacenter Edition Administrator Guide

359

20

Monitoring the CTERA Portal

Viewing System Logs


To view System logs
In the navigation pane, click Logs & Alerts > Event Log.
The Logs & Alerts > Event Log page appears displaying the System logs.

Tip

If the Log Viewer is already open and a different log category is displayed, in the
Select Topic drop-down list, select System.
The following information is displayed:

360

CTERA Portal Datacenter Edition Administrator Guide

Monitoring the CTERA Portal

20

Table 89: System Log Fields


This field...

Displays...

Type

An icon indicating the log level. See Log Levels (page 361).

Origin Type

The type of entity sent the event log (a virtual portal or a device).

Origin

The entity that sent the event log.


To edit or view details about the entity, click the entity name.

Date

The date and time at which the event occurred.

Portal User

The portal administrator or user who triggered the event.


To edit the administrator or user, click their user name. For further
details, see Managing Administrators (on page 119).

Device User

The user who triggered the event on the device.


This field is relevant only for events where the origin is a device.

Details

A description of the event.

More Info

Additional information about the event.

Table 90: Log Levels


Icon

Log Level
Error
Warning
Info
Debug

Viewing Local Backup Logs


To view Local Backup logs
1 In the navigation pane, click Logs & Alerts > Event Log.
The Logs & Alerts > Event Log page appears displaying the System logs.
2 In the Select Topic drop-down list, select Local Backup.

CTERA Portal Datacenter Edition Administrator Guide

361

20

Monitoring the CTERA Portal

The Local Backup logs appear. For information on the displayed fields, see the following
tables.

3 To view files for which errors occurred during a synchronization operation, click on the
desired operation in the upper pane.
Information about files for which errors occurred appears in the lower pane.

362

CTERA Portal Datacenter Edition Administrator Guide

Monitoring the CTERA Portal

20

Table 91: Local Backup Log Upper Pane Fields


This field...

Displays...

Type

An icon indicating the log level. See Log Levels.

Origin Type

The type of entity sent the event log (a virtual portal or a device).

Origin

The entity that sent the event log.


To edit or view details about the entity, click the entity name.

Start Time

The date and time at which the synchronization operation started.

Name

The name of the sync rule.

Mode

The operation mode, Backup or Restore.

Type

The type of synchronization, manual or scheduled.

Level

The synchronization level, Files or Sync.

Duration

The amount of time the synchronization operation took.

Result

The result of the synchronization operation.

Files

The number of files at the synchronization source.

Size

The total size of the files at the synchronization source in MB.

Transferred Files

The number of files transferred to the synchronization destination.

Transferred Size

The total size of the files transferred to the synchronization


destination in MB.

More Info

Additional information about the synchronization operation.

Table 92: Local Backup Log Lower Pane Fields


This field...

Displays...

Type

An icon indicating that an error occurred during synchronization (


).

File Name

The name of the file for which an error occurred.

Path

The path to the file.

Result

The result of the synchronization operation.

More Info

Additional information about the synchronization operation.

CTERA Portal Datacenter Edition Administrator Guide

363

20

Monitoring the CTERA Portal

Viewing Cloud Backup Logs


To view Cloud Backup logs
1 In the navigation pane, click Logs & Alerts > Event Log.
The Logs & Alerts > Event Log page appears displaying the System logs.
2 In the Select Topic drop-down list, select Cloud Backup.
The Cloud Backup logs appear. For information on the displayed fields, see the following
table.

3 To view additional logging information for a backup operation, click on the desired
operation in the upper pane.
Information about files included in the backup operation appears in the lower pane.

364

CTERA Portal Datacenter Edition Administrator Guide

Monitoring the CTERA Portal

20

Table 93: Cloud Backup Log Upper Pane Fields


This field...

Displays...

Type

An icon indicating the log level. See Log Levels (page 361).

Origin Type

The type of entity sent the event log (a virtual portal or a device).

Origin

The entity that sent the event log.


To edit or view details about the entity, click the entity name.

Start Time

The date and time at which the backup operation started.

Mode

The operation mode, Backup or Restore.

Type

The type of backup, manual or scheduled.

Duration

The amount of time the backup operation took.

Result

The result of the backup operation.

Files

The number of files to be backed up.

Size

The total size of the files to be backed up.

Transferred Files

The number of files transferred to cloud storage during the backup


operation.

Transferred Size

The size of the files transferred to cloud storage during the backup
operation.

Changed Files

The number of files that changed since the last backup operation.

Changed Size

The total size of the files that changed since the last backup
operation.

More Info

Additional information about the event.

Table 94: Cloud Backup Log Lower Pane Fields


This field...

Displays...

Type

An icon indicating whether backup was successful (

Operation

The operation performed (create, delete, modify, or rename).

File Name

The name of the backed up file.

Path

The path to the backed up file.

Duration

The amount of time backup took for the file.

Size

The size of the file.

Transferred Size

The size of the file transferred to cloud storage.

Dedup Ratio

The de-duplication ratio for the file.

CTERA Portal Datacenter Edition Administrator Guide

) or not (

).

365

20

Monitoring the CTERA Portal

Result

The result of the backup operation.

More Info

Additional information about the event.

Viewing Cloud Sync Logs


To view Cloud Sync logs
1 In the navigation pane, click Logs & Alerts > Event Log.
The Logs & Alerts > Event Log page appears displaying the System logs.
2 In the Select Topic drop-down list, select Cloud Sync.
The Cloud Sync logs appear. For information on the displayed fields, see the following
table.

366

CTERA Portal Datacenter Edition Administrator Guide

Monitoring the CTERA Portal

20

Table 95: Cloud Sync Log Fields


This field...

Displays...

Type

An icon indicating the log level. See Log Levels.

Origin Type

The type of entity sent the event log (a virtual portal or a device).

Origin

The entity that sent the event log.


To edit or view details about the entity, click the entity name.

Operation

The synchronization operation performed:


New. A new file or directory was created.
Updated. A file or directory was updated.

Direction

The synchronization operation's direction:


In. From the cloud drive to the local drive.
Out. From the local drive to the cloud drive.

File Name

The name of the file transferred during the synchronization


operation.

Path

The path to the file transferred during the synchronization operation.

Start Time

The date and time at which the synchronization operation started.

Duration

The amount of time the synchronization operation took.

Size

The size of the synchronized file.

Transferred Size

The actual amount of data transferred.

Dedup Ratio

The de-duplication ratio for the file transferred during the


synchronization operation.

Result

The result of the synchronization operation.

More Info

Additional information about the event.

Viewing Access Logs


To view Access logs
1 In the navigation pane, click Logs & Alerts > Event Log.
The Logs & Alerts > Event Log page appears displaying the System logs.
2 In the Select Topic drop-down list, select Access.

CTERA Portal Datacenter Edition Administrator Guide

367

20

Monitoring the CTERA Portal

The Access logs appear.

The following information is displayed:

368

CTERA Portal Datacenter Edition Administrator Guide

Monitoring the CTERA Portal

20

Table 96: Access Log Fields


This field...

Displays...

Type

An icon indicating the log level. See Log Levels (page 361).

Action

The action type (login, logout, rename ...)

Origin Type

The type of entity sent the event log (a virtual portal or a device).

Origin

The entity that sent the event log.


To edit or view details about the entity, click the entity name.

Date

The date and time at which the event occurred.

Portal User

The portal administrator or user who triggered the event.


To edit the administrator or user, click their user name. For further
details, see Managing Administrators (on page 119).

Device User

The user who triggered the event on the device.


This field is relevant only for events where the origin is a device.

Protocol

The protocol used when triggering the event:


GUI
CIFS (Windows File Sharing)
AFP
FTP
NFS
RSync
CTERA Agent
WebDAV

Details

A description of the event.

Client IP

The IP address from which the user triggered the event.

Target

The entity on which the action was performed.

More Info

Additional information about the event.

Viewing Audit Logs


To view Audit logs
1 In the navigation pane, click Logs & Alerts > Event Log.
The Logs & Alerts > Event Log page appears displaying the System logs.
2 In the Select Topic drop-down list, select Audit.

CTERA Portal Datacenter Edition Administrator Guide

369

20

Monitoring the CTERA Portal

The Audit logs appear.

The following information is displayed:


Table 97: Audit Log Fields
This field...

Displays...

Action

The action type. See Action Types (page 371).

Origin Type

The type of entity sent the event log (a virtual portal or a device).

Origin

The entity that sent the event log.


To edit or view details about the entity, click the entity name.

Date

The date and time at which the event occurred.

Portal User

The portal administrator or user who triggered the event.


To edit the administrator or user, click their user name. For further
details, see Managing Administrators (on page 119).

Device User

The user who triggered the event on the device.


This field is relevant only for events where the origin is a device.

Type

The type of setting that was affected by the action.


For example, if CTERA Portal administrator JohnS was deleted, this
column displays "PortalAdmin".

Target

The object that was affected by the action.


For example, if user JohnS was deleted, this column displays
"JohnS".

More Info

370

Additional information about the event.

CTERA Portal Datacenter Edition Administrator Guide

Monitoring the CTERA Portal

20

Table 98: Action Types


Icon

Label

Description

Added

An object was added to the CTERA Portal.

Deleted

An object was deleted from the CTERA Portal.

Modified

An object was modified.

Formatted

A disk was formatted.

Disabled

A setting was disabled.

Enabled

A setting was enabled.

Viewing Agent Logs


To view Agents logs
1 In the navigation pane, click Logs & Alerts > Event Log.
The Logs & Alerts > Event Log page appears displaying the System logs.
2 In the Select Topic drop-down list, select Agents.
The Agents logs appear.

The following information is displayed:

CTERA Portal Datacenter Edition Administrator Guide

371

20

Monitoring the CTERA Portal

Table 99: CTERA Agents Log Fields


This field...

Displays...

Type

An icon indicating the log level. See Log Levels (page 361).

Origin Type

The type of entity sent the event log (a virtual portal or a device).

Origin

The entity that sent the event log.


To edit or view details about the entity, click the entity name.

Date

The date and time at which the event occurred.

Source

The name of the CTERA Agent-installed computer that triggered the


event.

Details

A description of the event.

More Info

Additional information about the event.

Filtering Logs
You can filter the logs in a given log category according to one or more of the following:
Severity. Only those logs with a certain minimum log level will be displayed. This type of
filtering is available for all log categories.
Date. Only those logs on, before, or after a certain date will be displayed. This type of
filtering is available only for System, Access, and Audit log categories.
Origin Type. Only those logs sent by a certain type of entity (device or virtual portal) will
be displayed. This type of filtering is available for all log categories.
Origin. Only those logs sent by a specific entity will be displayed. This type of filtering is
available for all log categories.
User. Only those logs triggered by a specific user will be displayed. This type of filtering is
available only for System logs.
To filter logs
1 View the desired log category.
See Viewing Logs.
2 To filter according to severity, in the Minimum Severity drop-down list, select the
minimum log level to display in this category.
For example, if you select Warning, then only Warning and Error logs will be displayed.
3 To filter according to date:
a Mouse-over the Date column's heading, then click on the arrow that appears.
A drop-down list appears.

372

CTERA Portal Datacenter Edition Administrator Guide

Monitoring the CTERA Portal

20

b Mouse-over Filters, then mouse-over the desired date filter type.


A calendar appears.

c Click the desired date.


4 To filter according to origin type:
a Mouse-over the Origin Type column's heading, then click on the arrow that appears.
A drop-down list appears.
b Mouse-over Filters.
A list of origin types appears.

c Click the desired origin type.


5 To filter according to origin:
a Mouse-over the Origin column's heading, then click on the arrow that appears.
A drop-down list appears.
b Mouse-over Filters.
A field appears.

CTERA Portal Datacenter Edition Administrator Guide

373

20

Monitoring the CTERA Portal

c In the field, type the desired origin.


6 To filter according to user:
a Mouse-over the User column's heading, then click on the arrow that appears.
A drop-down list appears.
b Mouse-over Filters.
A field appears.

c In the field, type the desired name of the desired user's user account.
7 To remove a severity filter, set the Minimum Severity to Info.
8 To remove any other filter:
a Mouse-over the relevant column's heading, then click on the arrow that appears.
A drop-down list appears.
b Clear the Filters check box.
The filter is removed.

Exporting Logs to Excel


You can export logs to a CSV file that can be opened in Microsoft Excel.
To export logs
1 View the desired log category.
See Viewing Logs.
2 Click Export to Excel.
The logs in the current log category are exported to a CSV file.

374

CTERA Portal Datacenter Edition Administrator Guide

Monitoring the CTERA Portal

20

Clearing Logs
Global administrators can clear the logs of all virtual portals.
This task can be performed in the Global Administration View only.

To clear all logs


1 In the navigation pane, click Logs & Alerts > Log Settings.
The Logs & Alerts > Log Settings page appears.
2 Click Clean Now.
Logs are cleared in all virtual portals.

Using CTERA Portal Email Notifications


You can configure the CTERA Portal to automatically send email notifications to end users and
administrators upon certain events.
Tip

In order to use notifications, the Email Sender Name must be configured in the
Settings > General page. See Overriding Global Portal Settings (see "Overriding
the Global Virtual Portal Settings" on page 67).

CTERA Portal Datacenter Edition Administrator Guide

375

20

Monitoring the CTERA Portal

Configuring Email Notifications


To configure CTERA Portal email notifications
1 In the navigation pane, click Settings > Email Notifications.
The Settings > Email Notifications page appears.

2 Complete the fields using the information in the following table.


3 Click Save.

376

CTERA Portal Datacenter Edition Administrator Guide

Monitoring the CTERA Portal

20

Table 100: CTERA Portal Email Notification Fields


In this fields...

Do this...

User is over storage quota

Select this option to send a notification to end users when their


cloud storage space is full.

User is over agents quota

Select this option to send a notification to end users when they


have exceeded the licensed number of CTERA Agents. This field
is relevant for reseller portals only.

Quota is

Select this option to send a notification to end users when the


cloud storage space is a certain percentage full, then type the
desired percentage in the field provided.
The default value is 90%

Add-on is about to expire in

Select this option to send a notification to end users when an


add-on to which they are subscribed will expire in a certain
number of days, then type the desired number of days in the
field provided.
The default value is 7 days. This field is relevant for reseller
portals only.

Trial is about to expire in

Select this option to send a notification to end users when their


trial subscription will expire in a certain number of days, then
type the desired number of days in the field provided.
The default value is 7 days. This field is relevant for reseller
portals only.

Device not connected

Select this option to send a notification to end users when their


device has not connected to the CTERA Portal for a certain
number of days, then type the desired number of days in the
field provided.
The default value is 3 days.

Password Recovery

Select this option to send a notification to end users when a


request is made to reset their password.
This notification is mandatory. It is always enabled and cannot
be disabled.

New User Notification

Select this option to send a notification to end users when an


account has been created for them by an administrator, inviting
them to use the portal. The email message contains the portal
address, as well as the username and password.

CTERA Portal Datacenter Edition Administrator Guide

377

20

Monitoring the CTERA Portal

Registration Confirmation

Select this option to send a notification to end users after


registering with the CTERA Portal, and before activating their
account.
This notification is mandatory. It is always enabled and cannot
be disabled. This field is relevant for reseller portals only.

Email Change Confirmation

Select this option to send a notification to end users when a


request is made to change their email address.
This notification is mandatory. It is always enabled and cannot
be disabled.

Send monthly report on day

Select this option to send a monthly report to end users, which


includes the following information:
Account information
Storage statistics
Usage report
Details of all the user's devices
Information on the status of the user's cloud backups
Then use the arrows to specify the date on which reports
should be sent each month.
The default value is 1.

378

CTERA Portal Datacenter Edition Administrator Guide

Monitoring the CTERA Portal

20

Customizing Email Notification Templates


By default, each virtual portal inherits its email notification templates from the global
settings. If desired, you can customize the email notifications listed in Configuring Email
Notifications (on page 376), as well as the following email notifications:
Table 101: CTERA Portal Email Notification Templates
Notification

Description

Vouchers issued

A notification sent to end users when a voucher has been


issued to them.

Registration Confirmation

A notification sent to end users after registering with the CTERA


Portal, but before activating their account.

Invoice Notification

A notification sent to end users with an invoice PDF attached.


This template allows customizing both the email message and
the PDF.

User is near quota limitation

A notification sent to end users when the amount of cloud


backup storage space used reaches or exceeds the percentage
specified in the Settings > Email Notifications page page's
Quota is field.

header

The HTML header that appears at the top of all notifications.

footer

The HTML footer that appears at the bottom of all notifications.

Device activated

A notification sent to end users when their device has been


activated.

You customize email notifications by modifying their templates. The email notifications are in
HTML format. This procedure is relevant for reseller portals only.
To customize CTERA Portal email notification templates
1 Do one of the following:
To customize configurable notifications only:
1 In the navigation pane, click Settings > Email Notifications.
The Settings > Email Notifications page appears.
2 Next to the desired notification, click Customize.
To customize non-configurable notifications, or both configurable notifications and
non-configurable notifications:
1 In the navigation pane, click Settings > Email Templates.

CTERA Portal Datacenter Edition Administrator Guide

379

20

Monitoring the CTERA Portal

The Settings > Email Templates page appears.

2 Select the desired email template's row and then click Edit.
The Notification Template Editor opens displaying the Message tab.

If the notification includes a PDF attachment, the Notification Template Editor will
include a PDF tab, as well.
2 Select the Customize Notification Template check box.
3 In the Subject field, type the text that should appear in the notification email's Subject
line.

380

CTERA Portal Datacenter Edition Administrator Guide

Monitoring the CTERA Portal

20

4 In the Message box, modify the template as desired.


5 To preview your changes, click Preview.
6 To edit a PDF attachment, do the following:
a Click the PDF File tab.
The PDF File tab appears.

b In the PDF box, modify the template as desired.


c To preview your changes, click Preview.
The PDF is downloaded to your computer.
7 To undo your unsaved changes, click Revert.
8 Click Save.

Reverting to Email Notification Default Settings


If you customized an email template, you can revert the template to its default settings.
To revert to an email notification's default settings
1 Do one of the following:
To revert configurable notifications only:
1 In the navigation pane, click Settings > Email Notifications.
The Settings > Email Notifications page appears.
2 Next to the desired notification, click Customize.
To revert non-configurable notifications, or both configurable notifications and
non-configurable notifications:

CTERA Portal Datacenter Edition Administrator Guide

381

20

Monitoring the CTERA Portal

1 In the navigation pane, click Settings > Email Templates.


The Settings > Email Templates page appears.
2 Select the desired email template's row and then click Edit.
The Notification Template Editor opens displaying the desired template.
2 Clear the Customize Notification Template check box.
3 Click Save.

Using Email Alerts


You can configure the CTERA Portal to automatically send email alerts to end users and
administrators upon certain CTERA Portal log messages.
Tip

In order to use notifications, the Email Sender Name must be configured in the
Settings > General page. See Overriding Global Portal Settings (see "Overriding
the Global Virtual Portal Settings" on page 67).

Adding and Editing Email Alerts


To add or edit an email alert
1 In the navigation pane, click Logs & Alerts > Email Alerts.
The Logs & Alerts > Email Alerts page appears.

2 Do one of the following:


To add a new email alert, click New.
To edit an existing email alert, select the email alert's row and click Edit.

382

CTERA Portal Datacenter Edition Administrator Guide

Monitoring the CTERA Portal

20

The Alert Rule Wizard opens displaying the Event Filter dialog box.

3 Complete the fields using the information in the following table.


4 Click Next.
The Alert Name dialog box appears.

5 In the Alert Name field, type a name for the email alert.
6 In the Description field, type a description of the email alert.
7 Click Finish.

CTERA Portal Datacenter Edition Administrator Guide

383

20

Monitoring the CTERA Portal

Table 102: Alert Rule Event Filter Fields


In this field...

Do this...

Log Topic

Select the category of logs that should trigger the email alert.
For an explanation of the log categories, see Viewing Logs.
Alternatively, select Any to specify that any log category can
trigger the email alert.

Log Name

Select the name of the log that should trigger the email alert.
Alternatively, select Any to specify that any log can trigger the
email alert.

Origin Type

Select the entity from which a log must originate in order to


trigger the email alert.
Alternatively, select Any to specify that any log can originate
from any entity in order to trigger the email alert.

Minimum Severity

Select the minimum severity a log must have in order to trigger


the email alert.
For an explanation of the log severities, see Log Levels (page
361).

Message Contains

Type the text that the log message must contain in order to
trigger the email alert.

Viewing Email Alerts


To view all email alerts
In the navigation pane, click Logs & Alerts > Email Alerts.
The Logs & Alerts > Email Alerts page appears, displaying all email alerts.
The table includes the following columns.
Table 103: Email Alert Fields
This field...

Displays...

Name

The email alert's name.


To edit the email alert, click the alert's name. For further details, see
Adding and Editing Email Alerts (on page 382).

Description

384

A description of the email alert.

CTERA Portal Datacenter Edition Administrator Guide

Monitoring the CTERA Portal

20

Deleting Email Alerts


To delete an email alert
1 In the navigation pane, click Logs & Alerts > Email Alerts.
The Logs & Alerts > Email Alerts page appears, displaying all email alerts.
2 Select the desired email alert's row.
3 Click Delete.
A confirmation message appears.
4 Click Yes.
The email alert is deleted.

CTERA Portal Datacenter Edition Administrator Guide

385

21
Recovering CTERA Appliances after
Hard Drive Failures
This chapter is intended for CTERA Portal administrators. It describes how to replace CTERA
appliances and/or their disks, when a customer reports the following situations:
The appliance's hard disks are not working.
See Recovering from Hard Drive Failures (on page 388).
The appliance is not functioning properly.
See Recovering from Appliance Failures (on page 392).
The appliance is a total loss.
See Recovering from Total Loss (see "Recovering from Total Loss of an Appliance" on
page 398).

In This Chapter
Recovering from Hard Drive Failures ------------------------------------------------------------------------ 388
Recovering from Appliance Failures ------------------------------------------------------------------------- 392
Recovering from Total Loss of an Appliance --------------------------------------------------------------- 398

CTERA Portal Datacenter Edition Administrator Guide

387

22
Recovering from Hard Drive Failures
This chapter explains how to recover from a hard drive failure, while the appliance is
functioning properly.
Overview
The procedure involves verifying the array's status. Then, if the array is degraded, it is
necessary to replace the failed hard drives. If the array has failed, it is necessary to replace
the failed hard drives, add the new hard drives to the array, recreate the lost volumes, and
restore their contents from cloud backup.
To recover from a hard drive failure
1 Log in to the appliance's Web interface.
For instructions, refer to the appliance's user guide.
2 In the Main > Dashboard page, view information on the RAID array and the physical disk's
status.

3 If the RAID array's status is "Degraded", and the status of a few disks is "Failed", replace
those disks. The array will rebuild itself.

CTERA Portal Datacenter Edition Administrator Guide

388

Recovering CTERA Appliances after Hard Drive Failures

22

4 If RAID array's status is "Failed", the data on it was lost. To recover the data, do the
following:
a Remove the disks marked as "Failed" from the appliance.
b Insert new disks.
Tip

If the disks are not new, you can delete all data by formatting them. To do so,
click on the disk once it appears in the Main > Dashboard page, and then click
Format.
c Edit the failed RAID array, by doing the following:
1 In the Storage > Arrays page, click on the name of the failed array.

2 Add the new drives to the failed array.

3 Complete the Array Editor Wizard.

CTERA Portal Datacenter Edition Administrator Guide

389

22

Recovering CTERA Appliances after Hard Drive Failures

d In the Share > Shares page, for each share with the status "Offline", write down the
volume name (listed in the Volume column).
e Create volumes with the same names as those you wrote down in the previous step,
by doing the following for each such volume:
1 In the Storage > Volumes page, click New.

2 In the Logical Volume Wizard, select the new array you created in the Storage
Device field.

3 Complete the Logical Volume Wizard.


f

Restore data from cloud backup, by doing the following:


1 In the Cloud Backup > Control Panel page, click Restore.
2 In the tree pane, select all of the shares that were lost.

390

CTERA Portal Datacenter Edition Administrator Guide

Recovering CTERA Appliances after Hard Drive Failures

22

3 Complete the Restore Files Wizard.

CTERA Portal Datacenter Edition Administrator Guide

391

23
Recovering from Appliance Failures
This chapter explains how to replace an appliance, when there has been a hardware failure
but the hard drives are undamaged, by replacing the appliance with a new one of the same
model while keeping the old hard drives.
Overview
The procedure involves installing the new appliance, moving the old hard drives into the new
appliance, connecting the new appliance to cloud services, recovering the device
configuration from cloud backup, and moving the cloud backup folder from the old appliance
to the new one.
Tip

In C800, the power supplies are user swappable. Before performing this
procedure, try swapping the power supplies.
To recover from an appliance failure
1 Remove the old appliance's disks.
2 Plug in the new appliance.
3 Insert the disks that were removed from the faulty appliance into the new appliance.
The new appliance will automatically recognize the volumes on the disks.
4 In the CTERA Portal, download the old appliance's configuration file, by doing the
following:

CTERA Portal Datacenter Edition Administrator Guide

392

Recovering CTERA Appliances after Hard Drive Failures

23

a In the Folders > Backup Folders page, click on the folder associated with the old
appliance.

b In the Folder Manager, click View files to open the File Manager.

c Navigate to the appliance's configuration file, db.xml, which is located in the path
/Device Configuration.
d Select the configuration file, click Actions, and then click Download.
5 In the new appliance's Web interface, import the downloaded appliance configuration
file, by doing the following:

CTERA Portal Datacenter Edition Administrator Guide

393

23

Recovering CTERA Appliances after Hard Drive Failures

a In the System > Configuration Tools page, click Import.

b Select the downloaded db.xml file and complete the Configuration Import Wizard.

6 In the new appliance's Web interface, connect to the CTERA Portal, by doing the
following:

394

CTERA Portal Datacenter Edition Administrator Guide

Recovering CTERA Appliances after Hard Drive Failures

23

a In the Cloud Services > Status page, click Connect to Services.

b Complete the Connect to Services Wizard.

7 In the CTERA Portal, assign the old device's backup folder to the new appliance, and then
delete the old appliance, by doing the following:
a In the Main > Devices page, click on the new device's name.

CTERA Portal Datacenter Edition Administrator Guide

395

23

Recovering CTERA Appliances after Hard Drive Failures

b In the Device Manager's Settings tab, select the old device's backup folder in the
Backup Folder drop-down list.

c When done, save your changes.


In the Main > Devices page, the new device is listed as using the old device's backup
folder.
d (Optional) If you want to delete the old device, do the following:
1 Select the old device's row, then click Delete Device.
2 Click Delete device only.
8 If the backup folder is passphrase-protected, the Cloud Backup > Control Panel page will
indicate that you need to run the backup wizard again. In this case, do the following:

396

CTERA Portal Datacenter Edition Administrator Guide

Recovering CTERA Appliances after Hard Drive Failures

23

a Click Run the Backup Setup Wizard.

b In the Backup Wizard, enter the passphrase.

c Complete the Backup Wizard.

CTERA Portal Datacenter Edition Administrator Guide

397

24
Recovering from Total Loss of an Appliance
This chapter explains how to replace an appliance, which together with its hard drives is a
total loss, due to a disaster such as theft, fire, or flood.
Overview
The procedure involves installing the new appliances, recreating the lost RAID arrays and
volumes, moving the cloud backup folder from the old appliance to the new one, and
recovering the device configuration and data from cloud backup.
To recover from total loss
1 In the CTERA Portal, download the old appliance's configuration file, by doing the
following:
a In the Folders > Backup Folders page, click on the folder associated with the old
appliance.

CTERA Portal Datacenter Edition Administrator Guide

398

Recovering CTERA Appliances after Hard Drive Failures

24

b In the Folder Manager, click View Files to open the File Manager.

c Navigate to the appliance's configuration file, db.xml, which is located in the path
/Device Configuration.
d Select the configuration file, click Actions, and then click Download.
2 Install the new appliance, skipping the setup wizard.
3 In the new appliance's Web interface, import the downloaded appliance configuration
file, by doing the following:

CTERA Portal Datacenter Edition Administrator Guide

399

24

Recovering CTERA Appliances after Hard Drive Failures

a In the System > Configuration Tools page, click Import.

b Select the downloaded db.xml file and complete the Configuration Import Wizard.

4 In the new appliance's Web interface, create a new RAID array, by doing the following:

400

CTERA Portal Datacenter Edition Administrator Guide

Recovering CTERA Appliances after Hard Drive Failures

24

a In the Storage > Arrays page, click New.

b Complete the Array Editor Wizard.

5 In the new appliance's Share > Shares page, for each share with the status "Offline", write
down the volume name (listed in the Volume column).
6 Create volumes with the same names as those you wrote down in the previous step, by
doing the following for each such volume:

CTERA Portal Datacenter Edition Administrator Guide

401

24

Recovering CTERA Appliances after Hard Drive Failures

a In the Storage > Volumes page, click New.

b In the Logical Volume Wizard, select the new array you created in the Storage Device
field.

c Complete the Logical Volume Wizard.


7 In the new appliance's Web interface, connect to the CTERA Portal, by doing the
following:

402

CTERA Portal Datacenter Edition Administrator Guide

Recovering CTERA Appliances after Hard Drive Failures

24

a In the Cloud Services > Status page, click Connect to Services.

b Complete the Connect to Services Wizard.

8 In the CTERA Portal, assign the old device's backup folder to the new appliance, and then
delete the old appliance, by doing the following:
a In the Main > Devices page, click on the new device's name.

CTERA Portal Datacenter Edition Administrator Guide

403

24

Recovering CTERA Appliances after Hard Drive Failures

b In the Device Manager's Settings tab, select the old device's backup folder in the
Backup Folder drop-down list.

c When done, save your changes.


In the Main > Devices page, the new device is listed as using the old device's backup
folder.
d (Optional) If you want to delete the old device, do the following:
1 Select the old device's row, then click Delete Device.
2 Click Delete device only.
9 If the backup folder is passphrase-protected, the Cloud Backup > Control Panel page will
indicate that you need to run the backup wizard again. In this case, do the following:

404

CTERA Portal Datacenter Edition Administrator Guide

Recovering CTERA Appliances after Hard Drive Failures

24

a Click Run the Backup Setup Wizard.

b In the Backup Wizard, enter the passphrase.

c Complete the Backup Wizard.


10 In the new appliance's Web interface, restore data from cloud backup, by doing the
following:
a In the Cloud Backup > Control Panel page, click Restore Files.
b In the tree pane, select all of the shares that were lost.

CTERA Portal Datacenter Edition Administrator Guide

405

24

Recovering CTERA Appliances after Hard Drive Failures

c Complete the Restore Files Wizard.

406

CTERA Portal Datacenter Edition Administrator Guide

25
Legal Information
This chapter contains important legal information about your CTERA products.

In This Chapter
CTERA End User License Agreement ------------------------------------------------------------------------- 407
GNU GENERAL PUBLIC LICENSE ------------------------------------------------------------------------------- 411
Apache License ---------------------------------------------------------------------------------------------------- 414

CTERA End User License Agreement


This End User License Agreement (the "Agreement") by and between the individual installing and/or using the Software (as such
term is defined below) and any legal entity on whose behalf such individual is acting (collectively, "You" or "you") and CTERA
Networks Ltd. ("CTERA"), governs Your use of the object code format of (i) any software or firmware program embedded or
included in any hardware product supplied by CTERA or its authorized partners, and (ii) any software program supplied by CTERA
or its authorized partners; and (iii) all accompanying manuals and other documentation, and all enhancements, upgrades, and
extensions thereto that may be provided by CTERA or its authorized partners to You from time to time, unless otherwise
indicated by CTERA (the "Software").
PLEASE NOTE: BY DOWNLOADING, INSTALLING, COPYING, ACCESSING, OR USING THE SOFTWARE, OR BY CHOOSING THE "I
ACCEPT" OPTION LOCATED ON OR ADJACENT TO THE SCREEN WHERE THIS AGREEMENT MAY BE DISPLAYED, YOU INDICATE
YOUR ACKNOWLEDGMENT THAT YOU HAVE READ THIS AGREEMENT AND AGREE TO BE BOUND BY AND COMPLY WITH ITS
TERMS. YOUR WRITTEN APPROVAL IS NOT REQUIRED FOR THE VALIDITY OR ENFORCEABILITY OF THIS AGREEMENT. IF YOU ARE
ACCEPTING THESE TERMS ON BEHALF OF ANOTHER PERSON OR A COMPANY OR OTHER LEGAL ENTITY, YOU REPRESENT AND
WARRANT THAT YOU HAVE FULL AUTHORITY TO BIND THAT PERSON, COMPANY, OR LEGAL ENTITY TO THESE SOFTWARE
LICENSE TERMS. IF YOU DO NOT AGREE TO THESE SOFTWARE LICENSE TERMS, DO NOT DOWNLOAD, INSTALL, COPY, ACCESS, OR
USE THE SOFTWARE AND PROMPTLY RETURN THE SOFTWARE, INCLUDING ALL PACKAGING, MEDIA, DOCUMENTATION, AND
PROOF OF PAYMENT, TO THE PARTY FROM WHOM IT WAS OBTAINED FOR A REFUND OF THE AMOUNT PAID, PROVIDED THAT
THE RETURN IS MADE WITHIN TEN (10) DAYS OF THE DATE OF PURCHASE.
1. License to Use Software
1.1 Subject to proper payment to CTERA and Your compliance with the terms and conditions of this Agreement, CTERA hereby
grants You a non-exclusive, non-sublicensable, non-transferable license to install and use the Software, solely for Your internal
business needs, in accordance with the terms set forth in this Agreement and subject to any further restrictions in CTERA
documentation, and solely on the CTERA appliance on which CTERA installed the Software, or, for stand-alone Software, solely
on a single computer running a validly licensed copy of the operating system for which the Software was designed. You agree
that, except for the limited, specific license rights granted in this section 1, You receive no license rights to the Software.

CTERA Portal Datacenter Edition Administrator Guide

407

25

Legal Information

1.2 Unless otherwise authorized in writing by CTERA and to the extent otherwise provided in the applicable license for Free
Programs (as defined below), You undertake not to (and not to allow third parties to) (1) sublicense, lease, rent, loan, or
otherwise transfer the Software to any third party, (2) decompile, disassemble, decrypt, extract or otherwise reverse engineer or
attempt to reconstruct or discover any source code of, or any underlying ideas in, the Software ("Reverse Engineering"), , (3)
modify, enhance, supplement, adapt, or prepare derivative works from the Software, (4) allow others to use the Software and
use the Software for the benefit of third parties, (5) develop any other product containing any of the concepts and ideas
contained in the Software, (6) remove, obscure, or alter CTERA's or any third party's trademarks or copyright or other
proprietary rights notices affixed to or contained within or accessed in conjunction with or through the Software, and (7) make
unauthorized copies of the Software (except as necessary for backup purposes). If, notwithstanding the prohibition set forth in
subsection (2) above, applicable law permits Reverse Engineering, You will, before commencing or permitting any Reverse
Engineering (A) inform CTERA of the planned Reverse Engineering, (B) conduct or allow such Reverse Engineering only to achieve
interoperability between the Software and other computer programs, (C) request from CTERA the information necessary to
achieve such interoperability, (D) provide CTERA ample opportunity to supply the information necessary to achieve
interoperability.
1.3 CTERA has no obligation to provide support, maintenance, upgrades, modifications, or new releases of the Software under
this Agreement. You may contact CTERA or its authorized resellers to determine the availability of such support, maintenance,
distribution or upgrade of the Software, and the fees, terms and conditions applicable thereto.
2. Intellectual Property
2.1 You acknowledge that CTERA or other third parties own all right, title and interest, including all intellectual property rights, in
and to the Software, portions thereof, or software or content provided through or in conjunction with the Software. Except for
the license granted in accordance with Section 1
of this Agreement, all rights in and to the Software are reserved, no licenses,
implied or otherwise, are granted by CTERA, You are not authorized to use CTERAs trademarks, service marks, or trade dress,
and You agree not to display or use them in any manner.
2.2 If You have comments on the Software or ideas on how to improve it, please contact us. By doing so, You also grant CTERA a
perpetual, royalty-free, irrevocable, transferable license, with right of sublicense, to use and incorporate Your ideas or comments
into the Software (or third party software, content, or services), and to otherwise exploit Your ideas and comments, in each case
without payment of any compensation.
3. GPL License
The Software makes use of free and open source programs (the "Free Programs"), licensed under the following license
agreements: GNU General Public License (GPL), version 2 or later: www.gnu.org/ licenses/gpl.html, GNU Lesser General Public
License (LGPL), version 2.1 or later: www.gnu.org/ licenses/lgpl.html, Apache License, Version 2.0 or later:
www.apache.org/licenses/LICENSE-2.0. It is Your responsibility to review and adhere to all licenses to Free Programs.
Notwithstanding anything to the contrary in this Agreement, You may redistribute the Free Programs and/or modify them under
the terms of the corresponding license agreement. The Free Programs are distributed in the hope that they will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
To obtain the source code for the Free Programs subject to the terms of the corresponding license agreement, please send a
request by mail to: Open Source Requests, CTERA Networks Ltd, Imber 24, Petach Tikva, Israel.
4. Third Party Software
Software licensed to CTERA by third parties for direct or indirect distribution to end users (Third Party Software) may be
embedded in the Software and sublicensed directly to You. Third Party Software is provided to You subject to separate licenses
directly between You and the third party licensor, available from CTERA at Your request. You will have no recourse against CTERA
unless CTERA is the stated licensor and then only to the extent provided in such license. You will be responsible to do whatever is
necessary or required by the third party licensor for the licenses and related terms to take effect (e.g. online registration). You
are also accepting the terms and conditions of the licenses applicable to any Third Party Software (including any open source
software) included with the Software.
5. Acceptable Use and Conduct
You shall use the Software in compliance with all applicable laws, ordinances, rules and regulations, shall not violate or attempt
to violate CTERAs system or network security, and shall not misuse the Software in any way. You shall be responsible for Your
conduct while using the Software.

408

CTERA Portal Datacenter Edition Administrator Guide

Legal Information

25

6. Term and Termination


CTERA shall have the right to terminate this Agreement at any time due to Your breach of this Agreement by providing You with
a written notice. Upon CTERA's termination of this Agreement, You shall not be entitled to any compensation, reimbursement or
damages of any kind. You shall have the right to terminate this Agreement at any time due to CTERAs breach of this
Agreement by providing CTERA with a written notice. You agree that, upon termination or expiration of this Agreement for any
reason, You will cease using the Software and either destroy all copies of the Software and CTERA documentation or return them
to CTERA. The provisions of this Agreement, other than the license granted in section 1 ("License to User Software"), shall survive
termination.
7. Disclaimer of Warranties
THE SOFTWARE IS PROVIDED AS IS. CTERA AND CTERA'S LICENSORS AND RESELLERS MAKE NO REPRESENTATIONS OR
WARRANTIES OF ANY KIND, WHETHER EXPRESS, IMPLIED, STATUTORY OR OTHERWISE WITH RESPECT TO THE SOFTWARE.
EXCEPT TO THE EXTENT PROHIBITED BY APPLICABLE LAW, CTERA AND ITS LICENSORS AND RESELLERS DISCLAIM ALL
WARRANTIES, INCLUDING, WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, SATISFACTORY QUALITY,
FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, QUIET ENJOYMENT, AND ANY WARRANTIES ARISING OUT OF ANY
COURSE OF DEALING OR USAGE OF TRADE. CTERA AND ITS LICENSORS AND RESELLERS DO NOT WARRANT THAT THE SOFTWARE
WILL FUNCTION AS DESCRIBED, WILL BE UNINTERRUPTED OR ERROR FREE, OR FREE OF HARMFUL COMPONENTS, OR THAT THE
DATA YOU STORE BY USING THE SOFTWARE WILL BE SECURE OR NOT OTHERWISE LOST OR DAMAGED. NO ADVICE OR
INFORMATION OBTAINED BY YOU FROM CTERA OR FROM ANY THIRD PARTY OR THROUGH THE SOFTWARE SHALL CREATE ANY
WARRANTY NOT EXPRESSLY STATED IN THIS AGREEMENT. YOU UNDERSTAND AND AGREE THAT YOU USE THE SOFTWARE, AND
ALL THIRD PARTY SOFTWARE OR SERVICES MADE AVAILABLE IN CONJUNCTION WITH OR THROUGH THE SOFTWARE, AT YOUR
OWN DISCRETION AND RISK AND THAT YOU WILL BE SOLELY RESPONSIBLE FOR ANY DAMAGES TO YOUR COMPUTER SYSTEM OR
LOSS OF DATA THAT RESULTS FROM THE USE OF THE SOFTWARE AND SUCH THIRD PARTY SOFTWARE AND SERVICES. SOME
STATES OR OTHER JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO THE ABOVE EXCLUSIONS MAY
NOT APPLY TO YOU. YOU MAY ALSO HAVE OTHER RIGHTS THAT VARY FROM STATE TO STATE AND JURISDICTION TO
JURISDICTION. THIS SECTION CONSTITUTES A CONTRACT FOR THE BENEFIT OF EACH OF CTERA'S LICENSORS, RESELLERS AND
DISTRIBUTORS.
8. Limitation of Liability
NEITHER CTERA NOR ANY OF ITS LICENSORS AND RESELLERS SHALL BE LIABLE TO YOU FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, CONSEQUENTIAL OR EXEMPLARY DAMAGES (EVEN IF CTERA ITS LICENSORS OR RESELLERS HAVE BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES) IN CONNECTION WITH THIS AGREEMENT, INCLUDING, WITHOUT LIMITATION, ANY SUCH
DAMAGES RESULTING FROM: (i) THE USE OR THE INABILITY TO USE THE SOFTWARE; (ii) THE COST OF PROCUREMENT OF
SUBSTITUTE GOODS AND SERVICES; OR (iii) UNAUTHORIZED ACCESS TO OR ALTERATION OF YOUR CONTENT. IN ANY CASE AND
WITHOUT DEROGATING FROM THE ABOVE, TO THE EXTENT THAT THE AFOREMENTIONED LIMITATION OF LIABILITY SHALL NOT
BE ENFORCEABLE, CTERA'S AGGREGATE LIABILITY UNDER THIS AGREEMENT AND ANY OTHER AGREEMENT BETWEEN CTERA AND
YOU SHALL BE LIMITED TO THE LOWER OF (I) THE AMOUNT ACTUALLY PAID BY YOU TO CTERA FOR THE SOFTWARE WHICH IS
THE SUBJECT MATTER OF THE CLAIM, OR (II) US$1,000,000. THE SOFTWARE IS NOT INTENDED FOR USE IN CONNECTION WITH
ANY INHERENTLY DANGEROUS APPLICATION. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF CERTAIN WARRANTIES
OR THE LIMITATION OR EXCLUSION OF LIABILITY FOR INCIDENTAL OR CONSEQUENTIAL DAMAGES. ACCORDINGLY, SOME OR ALL
OF THE ABOVE EXCLUSIONS OR LIMITATIONS MAY NOT APPLY TO YOU, AND YOU MAY HAVE ADDITIONAL RIGHTS. THIS SECTION
CONSTITUTES A CONTRACT FOR THE BENEFIT OF EACH OF CTERA'S LICENSORS, RESELLERS AND DISTRIBUTORS.
9. Indemnification by You
9.1 You shall indemnify, defend and hold CTERA, its affiliates and licensors, each of its and their business partners and each of its
and their respective employees, officers, directors and representatives, harmless from and against any and all claims, losses,
damages, liabilities, judgments, penalties, fines, costs and expenses (including reasonable attorney fees), arising out of or in
connection with any claim arising out of (i) Your use of the Software in a manner not authorized by this Agreement, and/or in
violation of the applicable restrictions and/or applicable law, (ii) Your violation of any term or condition of this Agreement or any
applicable additional policies, or (iii) Your or Your employees or personnels negligence or willful misconduct.

CTERA Portal Datacenter Edition Administrator Guide

409

25

Legal Information

9.2 CTERA shall promptly notify You of any claim subject to indemnification; provided that CTERA's failure to do so shall not
affect Your obligations hereunder, except to the extent that CTERA's failure to promptly notify You materially delays or
prejudices Your ability to defend the claim. At CTERA's option, You will have the right to defend against any such claim with
counsel of Your own choosing (subject to CTERA's written consent) and to settle such claim as You deem appropriate, provided
that You shall not enter into any settlement without CTERA's prior written consent and provided that CTERA may, at any time,
elect to take over control of the defense and settlement of the claim.
10. Indemnification by CTERA
Notwithstanding CTERAs disclaimer of any warranty of non-infringement as set forth in Section 7 above, in special
circumstances, in CTERAs sole discretion, CTERA may choose to indemnify You in accordance with the provisions of this Section
10.
10.1 Indemnification. CTERA may defend or settle, at its option and expense, any action brought by a third party against You,
only to the extent such action arises from any third party claim brought against You alleging that the Software infringes any
patent, copyright, trademark, trade secret, or other intellectual property right of any third party (the "IP Claim"), and may pay all
costs, liabilities, damages and legal fees finally awarded against You in, or paid in settlement of, such action.
10.2 Remedy by CTERA. In the event that any Software or portion thereof is held, or in CTERAs reasonable opinion may be
held, to constitute an infringement, CTERA, at its option and expense, may either (i) obtain for You the right to continue to use
such Software as contemplated herein, (ii) modify such Software so that it becomes non-infringing, but without materially
altering its functionality, (iii) replace such Software with a functionally equivalent non infringing Product, or (iv) terminate this
Agreement and provide you with a refund of the amount paid for the infringing Software.
10.3 Exceptions. The foregoing does not apply to claims to the extent arising from: (i) the combination of a Software with other
products not supplied by or on behalf of CTERA where such claim would not have arisen from the use of the Software standing
alone, (ii) compliance by CTERA with Your specifications, (iii) any modification of the Software not made by or on behalf of
CTERA, where such claim would not have arisen but for such modification, or (iv) where You continue an activity where such
claim would not have arisen but for such activity after having received and had a commercially reasonable time to install
modifications from CTERA that would have completely avoided the activity.
10.4 Entire Liability. This section 10 states the entire liability of CTERA and Your exclusive remedy for any proceedings or claims
that the Software infringes or misappropriates a third party's intellectual property, in respect of which CTERA chooses to provide
indemnification.
10.5 Requirements for Indemnity. You agrees to provide CTERA with (i) prompt written notice of the IP Claim giving rise to
CTERAs indemnity option hereunder, (ii) sole control over the defense or settlement of such claim or action, if CTERA so
requests (provided that CTERA shall not, without Your prior written consent, settle any such claim or action if such settlement
contains a stipulation to or admission or acknowledgment of any liability or wrongdoing on Your part), and (iii) reasonable
information and assistance in the defense and/or settlement any such claim or action at CTERAs option and expense.
11. Miscellaneous Provisions
11.1 The Software may be subject to export control laws of the State of Israel and/or may be subject to additional export control
laws applicable to You or in Your jurisdiction. You shall not ship, transfer, or export the Software into any country, or make
available or use the Software in any manner, prohibited by law. You warrant and agree that You are not: (i) located in, under the
control of, or a national or resident of Cuba, Iran, North Korea, Syria or Sudan, or (ii) on the U.S Treasury Department list of
Specially Designated Nationals or the U.S. Commerce Department's Table of Deny Orders.
11.2 This agreement will be governed by and construed in accordance with the laws of the State of Israel, without giving effect to
any conflict of laws and provisions that would require the application of the laws of any other jurisdiction. The parties hereby
expressly reject any application to this Agreement of (a) the United Nations Convention on Contracts for the International Sale of
Goods; and (b) the 1974 Convention on the Limitation Period in the International Sale of Goods, as amended by that certain
Protocol, done at Vienna on April 11, 1980.
11.3 All disputes arising out of this Agreement will be subject to the exclusive jurisdiction of the competent courts of Tel Aviv,
Israel, and the parties agree and submit to the personal and exclusive jurisdiction and venue of these courts, except that nothing
will prohibit CTERA from instituting an action in any court of competent jurisdiction to obtain injunctive relief or protect or
enforce its intellectual property rights.

410

CTERA Portal Datacenter Edition Administrator Guide

Legal Information

25

11.4 The failure of CTERA to exercise or enforce any right or provision of this Agreement does not constitute a waiver of such
right or provision. If for any reason a court of competent jurisdiction finds any provision or portion of this Agreement to be
unenforceable, the remainder of this Agreement will continue in full force and effect.
11.5 This Agreement constitutes the entire agreement between CTERA and You with respect to the subject matter hereof and
supersedes and replaces all prior or contemporaneous understandings or agreements, written or oral, regarding such subject
matter. Any waiver of any provision of this Agreement will be effective only if in writing and signed by CTERA.
11.6 You may not assign or transfer any of Your rights or obligations under this Agreement to a third party without the prior
written consent of CTERA. CTERA may freely assign this Agreement. Any attempted assignment or transfer in violation of the
foregoing will be void.

GNU GENERAL PUBLIC LICENSE


Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General
Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all
its users. This General Public License applies to most of the Free Software Foundation's software and to any other program
whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Lesser General
Public License instead.) You can apply it to your programs, too.
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make
sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive
source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you
know you can do these things.
To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the
rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights
that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so
they know their rights.
We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission
to copy, distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for
this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they
have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations.
Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a
free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made
it clear that any patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

CTERA Portal Datacenter Edition Administrator Guide

411

25

Legal Information

0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be
distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a
"work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work
containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language.
(Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on
the Program (independent of having been made by running the Program). Whether that is true depends on what the Program
does.
1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all
the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of
this License along with the Program.
You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in
exchange for a fee.
2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy
and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these
conditions:
a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or
any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License.
c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive
but does not normally print such an announcement, your work based on the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the
Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do
not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of
a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose
permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is
to exercise the right to control the distribution of derivative or collective works based on the Program.
In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the
Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.
3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the
terms of Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms
of Sections 1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost
of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you received the program in object code or executable form with such
an offer, in accord with Subsection b above.)

412

CTERA Portal Datacenter Edition Administrator Guide

Legal Information

25

The source code for a work means the preferred form of the work for making modifications to it. For an executable work,
complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus
the scripts used to control compilation and installation of the executable. However, as a special exception, the source code
distributed need not include anything that is normally distributed (in either source or binary form) with the major components
(compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies
the executable.
If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any
attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights
under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses
terminated so long as such parties remain in full compliance.
5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to
modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License.
Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this
License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license
from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not
impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing
compliance by third parties to this License.
7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent
issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this
License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously
your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the
Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who
receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain
entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is
intended to apply and the section as a whole is intended to apply in other circumstances.
It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of
any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is
implemented by public license practices. Many people have made generous contributions to the wide range of software
distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he
or she is willing to distribute software through any other system and a licensee cannot impose that choice.
This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces,
the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation
excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this
License incorporates the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time.
Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies
to it and "any later version", you have the option of following the terms and conditions either of that version or of any later
version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may
choose any version ever published by the Free Software Foundation.
10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to
the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free
Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the
free status of all derivatives of our free software and of promoting the sharing and reuse of software generally.

CTERA Portal Datacenter Edition Administrator Guide

413

25

Legal Information

NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT
PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER
PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT
NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE
RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE,
YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY
OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR
DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR
INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this
document.
"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under
common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause
the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of
the outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications, including but not limited to software source code,
documentation source, and configuration files.
"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not
limited to compiled object code, generated documentation, and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by
a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for
which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of
authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link
(or bind by name) to the interfaces of, the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright
owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this
definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its
representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue
tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a
Contribution."

414

CTERA Portal Datacenter Edition Administrator Guide

Legal Information

25

"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by
Licensor and subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a
perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative
Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object
form.
3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a
perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to
make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those
patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of
their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any
entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the
Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that
Work shall terminate as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or
without modifications, and in Source or Object form, provided that You meet the following conditions:
a. You must give any other recipients of the Work or Derivative Works a copy of this License; and
b. You must cause any modified files to carry prominent notices stating that You changed the files; and
c. You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative
Works; and
d. If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain
to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the
Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display
generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file
are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative
Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional
attribution notices cannot be construed as modifying the License.
You may add Your own copyright statement to Your modifications and may provide additional or different license terms and
conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided
Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in
the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or
conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement
you may have executed with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of
the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the
content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT,
MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of
using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as
a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

CTERA Portal Datacenter Edition Administrator Guide

415

25

Legal Information

9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to
offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent
with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility,
not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any
liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional
liability.

416

CTERA Portal Datacenter Edition Administrator Guide

Index
A
About the CTERA Portal 2
About This Guide 11
Accessing Online Help 24
Accessing the Configuration Template
Manager 138, 139, 164
Accessing the Device Manager 167, 169,
173, 175, 176, 180, 181, 182, 183
Accessing the Folder Group Manager 203,
204, 207, 208, 210
Accessing the Folder Manager 187, 188, 191,
202
Accessing the Global Administration View
18, 23
Accessing the Global Administrator Manager
126, 127, 128, 129
Accessing the Home Page 22
Accessing the Server Manager 267, 269, 271,
273, 275, 276, 279, 280
Accessing the Staff Administrator Manager
120, 121, 122, 125
Accessing the User Account Manager 73, 75,
80, 82, 83, 85, 87, 88, 89, 92, 93, 95, 96, 97,
99
Accessing the User Group Manager 113,
114, 115, 117
Accessing the Virtual Portal Manager 258,
259, 262, 263, 265
Adding Add-ons to User Accounts 83, 239
Adding and Editing Add-ons 79, 239, 244,
261
Adding and Editing Device Configuration
Templates 139
Adding and Editing Email Alerts 379, 381
Adding and Editing Excluded Sets 149

CTERA Portal Datacenter Edition Administrator Guide

Adding and Editing Folder Groups 190, 191,


204, 207
Adding and Editing Folders 172, 188, 190,
191
Adding and Editing Global Administrators
127
Adding and Editing Included Sets 141
Adding and Editing Staff Administrators 121,
124
Adding and Editing Storage Nodes 287, 318
Adding and Editing Subscription Plans 79,
227, 235, 261
Adding and Editing User Accounts 75, 79,
116, 172, 190, 191, 207, 218, 220
Adding and Editing User Groups 81, 114
Adding and Editing Virtual Portals 259, 261
Adding Collaboration Projects 214
Adding Global Add-ons to Virtual Portals
239, 263
Adding License Keys 36
Adding Vouchers 239, 247
Apache License 410
Applying Provisioning Changes 98, 100, 236,
245
Applying Skins 41, 71
Assigning User Accounts to Subscription Plans
81, 85
Assigning Virtual Portals to Global Plans 262
At What Level Can a Snapshot Retention
Policy Be Applied? 225

B
Branding the CTERA Portal 39
Browser Requirements 13

417

Index

C
Canceling a Pending Certificate Request 58
Canceling the Current Cloud Backup 181
Changing Passphrases for Accessing Backup
Folder Contents 201
Changing Passphrases for Accessing Folder
Group Contents 206, 209
Changing the Right Pane View 193, 194
Clearing Logs 372
Configuring a Server as a Catalog Node 271
Configuring an IP-Based Access Control List
129
Configuring Automatic Firmware Updates
158
Configuring Default Settings for Virtual-Portals
25, 186, 205, 206
Configuring Email Invitation Settings 253
Configuring Email Notifications 63, 64, 373,
376
Configuring Event Log Settings 354
Configuring Global Administrator Alerts 128
Configuring Global Mail Server Settings 44,
218, 220, 271
Configuring Global Settings 42
Configuring Global Virtual Portal Settings 25
Configuring Group Membership for User
Accounts 80, 115
Configuring Logging 354
Configuring Staff Administrator Alerts 122
Configuring Syslog Logging 356
Configuring the Automatic Template
Assignment Policy 137, 160, 163, 171
Configuring User Accounts' Advanced Settings
89, 186
Configuring User Alerts 93
Configuring User Group Members 115
Configuring Virtual Portals 67
Contacting Technical Support 12
Copying/Moving Files and Folders 198
Creating New Folders 196
Creating Skins 39, 68

418

CTERA Agents 5, 6
CTERA Appliances 5
CTERA End User License Agreement 403
CTERA Mobile 5, 6
CTERA Portal Interfaces and Users 4, 6, 76
CTERA Portal Snapshot Retention for the
Cloud Backup Service. 227
CTERA Portal Snapshot Retention for the
Cloud Drive Service 227
CTERA Provisioning 9
Customizing Administrator Roles 122, 132
Customizing Email Notification Templates
60, 250, 376
Customizing Global Email Notification
Templates 59

D
Defining Project Management Permissions
212
Deleting Active Email Invitations 255
Deleting Add-ons 245
Deleting Collaboration Projects 221
Deleting Device Configuration Templates
164
Deleting Devices 182
Deleting Email Alerts 382
Deleting Excluded Sets 151
Deleting Files and Folders 197
Deleting Firmware Images 284
Deleting Folder Groups 210
Deleting Folders 202
Deleting Global Administrators 129
Deleting Included Sets 147
Deleting Skins 42, 71
Deleting Staff Administrators 125
Deleting Storage Nodes 318
Deleting Subscription Plans 237
Deleting User Accounts 99
Deleting User Groups 117
Deleting Virtual Portals 265
Deleting Vouchers 251
Downloading Files and Folders 194

CTERA Portal Datacenter Edition Administrator Guide

Index

Duplicating Configuration Templates 164

E
Editing Collaboration Projects 218
Editing Device Settings 137, 169, 172, 190
Editing Server General Settings 44, 269
Editing Server SMTP Settings 271
Enabling Project Collaboration for the Virtual
Portal 211
Enabling/Disabling Excluded Sets 148
Enabling/Disabling Included Sets 140
Enabling/Disabling User Accounts 97
End-user Provisioning (Reseller Portals) 10
End-user Provisioning (Team Portals) 11
Exporting a List of Collaboration Projects to
Excel 221
Exporting Add-ons to Excel 244
Exporting Devices to Excel 182
Exporting Folder Groups to Excel 210
Exporting Folders 334
Exporting Folders to Excel 202
Exporting License Keys to Excel 39
Exporting Logs to Excel 372
Exporting Reports to Excel 354
Exporting Subscription Plans to Excel 236
Exporting the Installed SSL Certificate 46, 58
Exporting User Accounts to Excel 97
Exporting Virtual Portals to Excel 265
Exporting Vouchers to Excel 250

F
Filtering Logs 370

G
Generate a Certificate Signing Request 47,
49, 58
Generating Monthly Reports 96
Getting Started 13
GNU GENERAL PUBLIC LICENSE 407

H
How Directory Service Synchronization Works
100

CTERA Portal Datacenter Edition Administrator Guide

How Team Portals and Reseller Portals Differ


35
How the CTERA Portal License Works 34

I
Importing an SSL Certificate 46, 58
Importing and Exporting Folders (Seeding)
321
Importing Folders Over NFS 321
Importing Global Administrators from a File
131
Importing Staff Administrators from a File
124
Importing the Seeding Drive 332
Install the Signed Certificate on CTERA Portal
46, 47, 56
Installing an SSL Certificate 47
Integrating CTERA Portal with an Active
Directory Domain, Tree, or Forest 100
Integrating CTERA Portal with an LDAP
Directory Server 106
Introduction 1

L
Legal Information 2, 403
Logging in to the Administration Control Panel
14, 17
Logging in to the CTERA Portal 14
Logging in to the End User Portal 14, 15
Logging in to the Staff Control Panel 14
Logging Out 23, 24

M
Management Features 3
Managing Add-ons 223, 239
Managing Administrators 119, 359, 367, 368
Managing Backup Folders for Folder Groups
208
Managing Certificates 46
Managing Collaboration Projects 93, 211
Managing Device Configuration Templates
137, 169
Managing Devices 167

419

Index

Managing Devices for User Accounts 87


Managing Email Invitations 253
Managing Firmware Images 281
Managing Folder Contents 192, 193, 208,
209
Managing Folder Groups for User Accounts
88
Managing Folders and Folder Groups 185
Managing Home Folders for Folder Groups
207
Managing Projects Owned by User Accounts
92
Managing Servers 267
Managing Storage Nodes 287
Managing Subscription Plans 223
Managing the CTERA Portal License 34
Managing User Accounts 73, 174, 189, 207
Managing User Groups 80, 113
Managing Virtual Portals 257
Managing Vouchers 28, 247
Manually Fetching User Data 100, 111
Manually Starting Cloud Backup 181
Marking a Firmware Image as the Current
Firmware Image 157, 283
Monitoring Server Activity 275
Monitoring the CTERA Portal 337

N
Navigating Between Folders 193, 194, 196,
197, 198
Navigating between Table Pages 21
Navigating between Virtual Portals 17, 18,
23, 43
Note your Portal's DNS Suffix 47, 49

O
Obtain an SSL Certificate 47, 48
Opening Menu Sections 20
Overriding Global Branding Settings 39, 68
Overriding the Global Virtual Portal Settings
25, 67, 77, 97, 186, 247, 373, 379

420

P
Performing Seeding at the Customer Premises
322, 330
Portal-level Provisioning 10
Preparing for Seeding 322
Provisioning User Accounts in Reseller Portals
81
Provisioning User Accounts in Team Portals
85

R
Recovering CTERA Appliances after Hard Drive
Failures 383
Recovering from Appliance Failures 383, 388
Recovering from Hard Drive Failures 383,
384
Recovering from Total Loss of an Appliance
383, 394
Refreshing Page Contents 22
Refreshing the View 193
Remotely Managing Devices and Their Files
135, 180, 210
Remotely Performing Cloud Backup
Operations on Devices 180
Removing License Keys 37
Removing the Current Skin Selection 42
Removing the Currently Applied Skin 71
Renaming Files and Folders 197
Restarting Servers 57, 280
Restoring Files and Folders to Devices 198
Restricting Throughput 155
Resuming the Cloud Backup Service 182
Reverting to Email Notification Default
Settings 378

S
Scheduling Automatic Cloud Backup 152
Searching for Files 200
Searching Tables 22, 285
Selecting Applications for Backup 151
Selecting CTERA Portal Cloud Folders for
Synchronization 156

CTERA Portal Datacenter Edition Administrator Guide

Index

Selecting Files and Folders 194, 197, 198


Sending Vouchers by Email 250
Setting the Default Device Configuration
Template 163
Setting/Removing the Default Subscription
Plan 236
Sign the Certificate Request 47, 53
Snapshot Consolidation 227
Sorting Tables 20, 193
Storage Clients 5
Suspending the Cloud Backup Service 181

T
Terminating User Accounts 87
The Main Frame 20
The Navigation Pane 20
The Status Bar 23

U
Understanding Snapshot Retention Policies
10, 11, 224, 229
Uploading Files 194
Uploading Firmware Images 281
Uploading Skins 40, 69
Using a Caringo Storage Node 288, 291
Using a Cleversafe Storage Node 288, 295
Using a Cloudian Storage Node 288, 296
Using a CTERA Cloud FS Storage Node 288,
298
Using a DDN Web Object Scaler (WOS) Storage
Node 288, 302
Using a Dell DX Object Storage Platform
Storage Node 288, 299
Using a Hitachi Content Platform Storage
Node 288, 305
Using a MezeoCloud Storage Node 289, 309
Using a Nirvanix Cloud Storage Network
Storage Node 289, 310
Using a Scality (S3 API) Storage Node 289,
314
Using a Scality RING Storage Node 289, 316
Using an Amazon S3 Storage Node 288, 290

CTERA Portal Datacenter Edition Administrator Guide

Using an EMC Atmos Storage Node 288, 304


Using an IBM GPFS Storage Node 289, 307
Using an OpenStack Swift (KeyStone) Storage
Node 289, 313
Using an OpenStack Swift Storage Node 289,
312
Using CTERA Portal Email Notifications 373
Using Directory Services 99
Using Email Alerts 379
Using the CTERA Portal 19

V
Validate and Prepare Certificates for Upload
47, 56
Viewing Access Logs 365
Viewing Active Email Invitations 254
Viewing Add-ons 244
Viewing Agent Logs 369
Viewing All Backup Folders 189
Viewing All Devices 171
Viewing All Home Folders 190
Viewing Audit Logs 367
Viewing Cloud Backup Logs 176, 361
Viewing Cloud Sync Logs 364
Viewing Collaboration Project Contents 220
Viewing Connected Devices 273
Viewing CTERA Portal License Information
38
Viewing Device Configuration Templates 140
Viewing Devices 171
Viewing Devices that Use a Specific Firmware
Image 284
Viewing Email Alerts 381
Viewing File or Folder Details 193
Viewing Firmware Images 283
Viewing Folder Contents 191, 193, 201
Viewing Folder Groups 207
Viewing Folders 189
Viewing Global Administrators 128
Viewing Individual Appliances' Storage Status
176

421

Index

Viewing Individual Devices' Backup Status


175
Viewing Individual Devices' Statuses 172,
173
Viewing Local Backup Logs 359
Viewing Logs 357
Viewing Previous Versions of Files and Folders
200
Viewing Reports 341, 354
Viewing Server Tasks 276
Viewing Servers' Statuses 279
Viewing Skins 41, 70
Viewing Staff Administrators 123, 129
Viewing Storage Nodes 317
Viewing Subscription Plans 234
Viewing System Logs 358
Viewing the Add-Ons, Global Add-ons, or
Add-ons by Portal Report 349
Viewing the Devices Report 345
Viewing the Folder Groups Report 343
Viewing the Folders Report 341
Viewing the Plans, Global Plans, or Plans by
Portal Report 346
Viewing the Portals Report 352
Viewing the Status Dashboard 337
Viewing the Storage Report 350
Viewing User Account Details 94
Viewing User Accounts 77
Viewing User Groups 117
Viewing Virtual Portals 260
Viewing Vouchers 249
Virtual Portals 3, 257, 260

W
What Does a Snapshot Retention Policy
Specify? 224
What Happens When Both Levels of Snapshot
Retention Policy Are Applied? 226
Working with Backup Sets 140

422

CTERA Portal Datacenter Edition Administrator Guide

You might also like