EMC Avamar 6.1 Extended Retention User Guide P/N 300-013-366 REV 04
Copyright 2001-2012 EMC Corporation. All rights reserved. Published in the USA. Published December, 2012 EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without notice. The information in this publication is provided as is. EMC Corporation makes no representations or warranties of any kind with respect to the information in this publication, and specifically disclaims implied warranties of merchantability or fitness for a particular purpose. Use, copying, and distribution of any EMC software described in this publication requires an applicable software license. EMC 2, EMC, and the EMC logo are registered trademarks or trademarks of EMC Corporation in the United States and other countries. All other trademarks used herein are the property of their respective owners. For the most up-to-date regulatory document for your product line, go to the technical documentation and advisories section on the EMC online support website. 2 EMC Avamar 6.1 Extended Retention User Guide
CONTENTS Preface Chapter 1 Chapter 2 Chapter 3 Introduction Overview... 14 Capabilities and limitations... 15 Avamar 6.1 is required... 15 Avamar extended retention is intended for long-term retention... 15 Partial imports are not supported... 15 Exports and imports can take a significant amount of time... 15 A single physical or virtual tape library is supported... 15 Standalone tape drives are not supported... 15 Important terms and definitions... 16 Operational best practices... 17 Creating an administrative user account... 17 Exporting backups to tape... 17 Labeling tape volumes... 18 Creating disaster recovery images... 18 Clearing the browser cache before logging in for the first time... 18 Getting Started Supported browsers... 20 What to do the first time you use Avamar extended retention... 20 Logging in for the first time... 20 Login failures... 22 Session timeouts... 23 The Administration workspace... 23 Accessing available workspaces... 24 Adding and removing springboards... 25 Moving springboards within a workspace... 26 Displaying springboards in a workspace... 26 Hiding springboards in a workspace... 26 The Avamar Extended Retention workspace... 27 Customizing My Workspace... 27 Copying springboards from other workspaces to My Workspace... 27 Adding springboards to the Springboards list in My Workspace... 28 Removing springboards from the Springboards list in My Workspace... 29 Using online help... 29 Avamar Extended Retention online help... 29 Springboard and page-level help... 30 Logging out... 30 Using the Administration Workspace User management... 32 The User Management springboard... 32 Searching for a user... 32 Creating a user account... 33 Editing a user account... 34 Disabling a user account... 35 Unlocking a user account... 35 EMC Avamar 6.1 Extended Retention User Guide 3
Contents Role management... 36 The Role Management springboard... 36 Types of roles... 36 Editing a user s roles... 37 Generating a user role report... 39 User profile management... 39 The My Profile springboard... 39 Changing a user name or email address... 40 Changing a password... 40 Changing email message settings... 41 System configuration... 42 The Framework Configuration springboard... 42 Configuring system settings... 42 Enabling and disabling message settings... 43 Enabling SNMP... 44 System events... 45 The Event Summary springboard... 45 Viewing event details in the Event Viewer... 45 Tasks... 51 The Task Summary springboard... 51 Viewing task details in the Task Viewer... 51 Security events... 55 The Security Events springboard... 55 Viewing event details in the Security Event Viewer... 56 Log information... 60 The Log Information springboard... 60 Viewing detailed log information in the Log Viewer... 61 Saving log files... 62 Chapter 4 Using the Avamar Extended Retention Workspace Opening Avamar Extended Retention springboards... 64 The Media Management springboard... 65 The Scheduled Exports springboard... 65 The Import & Restore springboard... 65 The Configuration springboard... 66 The Recent Events springboard... 67 The Task Monitoring springboard... 68 The Import & Export Job History springboard... 70 Managing library media... 71 The Media Management page... 71 Working with custom tape pools... 72 Working with custom retention periods... 77 Labeling volumes... 81 Relabeling volumes to a different tape pool (not recommended)... 84 Viewing library details... 86 Viewing the tape volumes in the library... 87 Viewing the backups on a tape volume... 88 Ejecting tape volumes... 89 Inventorying the contents of the library... 90 Exporting Avamar backups to tape... 91 The Export Policy Management page... 91 Creating an export policy... 93 Editing an export policy... 104 Disabling an export policy... 105 Deleting an export policy... 105 4 EMC Avamar 6.1 Extended Retention User Guide
Contents Performing on-demand exports... 105 Viewing export job details for active policies in the Task Viewer... 107 Browsing and importing Avamar backups... 109 Restore limitations... 109 The Backup Browse/Import Page... 109 Locating exported backups... 111 Importing backups from tape... 112 Customizing columns in the Backup panel... 113 Editing backup retention periods... 114 Resetting the Import Server... 115 Restoring imported backups to a client... 115 Generating an import and export job history report... 116 Chapter 5 Chapter 6 Chapter 7 Administration Customizing drop-down text in the login dialog box... 120 Configuring the maximum value for parallel jobs... 120 Configuring SNMP traps... 121 Configuring Avamar server traps... 121 Configuring tape management system traps... 122 The Management Information Base... 124 Configuring the system to use an ACSLS library... 128 Viewing current software versions... 131 Shutting down the Media Access node... 131 Disaster Recovery Definition of a disaster... 134 Creating a disaster recovery image... 134 Recovering the Avamar extended retention server... 135 Install Avamar extended retention... 135 Set up the lockbox password and the superuser account... 135 Apply the Avamar extended retention disaster recovery image... 136 Recover the bootstrap... 137 Troubleshooting Modifying software components caveats... 140 Import server issues... 140 The Import server does not display in the GUI... 140 The Import server appears to be offline in the GUI... 142 External Avamar server issues... 143 Avamar servers incorrectly appear offline in the GUI... 143 Avamar servers do not appear in the GUI... 144 Avamar server performance is being affected by extended retention activities... 146 Import failures... 146 An import failed and was not displayed in the Avamar MC Activity Monitor. 146 An import failed and can be seen in the Import server's Avamar MC... 146 Backups do not appear in the Backup Browse/Import page... 147 An Avamar client does not appear in the Backup Browse/ Import page 147 Export failures... 148 Exports are failing in general... 148 Exports do not appear in the Avamar MC and they fail in extended retention 149 An export failed and appears in the MC Activity Monitor... 150 EMC Avamar 6.1 Extended Retention User Guide 5
Contents Not all exports were written to tape, but the export task completed... 150 The Event Viewer indicates that an export event was skipped... 150 An export worked but the client is not in the import list... 150 Jobs take a long time to run... 151 Library issues... 151 The library does not appear in the GUI... 151 The library appears as UNKNOWN in the GUI... 151 An eject tape request failed... 152 A task failed or completed with exceptions... 153 The file index is reporting that it is full... 153 JavaScript errors... 153 Timeout messages... 153 Index 6 EMC Avamar 6.1 Extended Retention User Guide
PREFACE As part of an effort to improve its product lines, EMC periodically releases revisions of its software and hardware. Therefore, some functions described in this document might not be supported by all versions of the software or hardware currently in use. The product release notes provide the most up-to-date information on product features. Contact your EMC representative if a product does not function properly or does not function as described in this document. Note: This document was accurate at publication time. New versions of this document might be released on the EMC online support website. Check the EMC online support website to ensure that you are using the latest version of this document. Purpose Audience This document describes how to use the Avamar extended retention feature. This document is intended for system administrators who will be using the Avamar extended retention feature. EMC Avamar 6.1 Extended Retention User Guide 7
Revision history The following table presents the revision history of this document. Table 1 Revision history Revision Date Description 04 December 7, 2012 03 October 25, 2012 Updates for version 6.1 Service Pack 1: Changed "hydrated" to "re-hydrated" in Overview on page 14. Removed specific browser versions in Supported browsers on page 20. Updates for version 6.1 Service Pack 1: Updated screen shots of the user interface that have changed for Service Pack 1. The changes occurred on the Avamar Extended Retention workspace main page, in the "Create a New Export Policy Wizard," and on the Media Management, and Backup Browse/Import pages. Added the new section, Working with custom tape pools on page 72. Added the new section, Working with custom retention periods on page 77. Added the new section, Relabeling volumes to a different tape pool (not recommended) on page 84. Updated the section, Creating an export policy on page 93, with the new Pool Name and Backup Retention configuration options in Service Pack 1. Added Chapter 5, Administration. This chapter contains some new features in Service Pack 1, including: Configuring SNMP traps on page 121. Configuring the system to use an ACSLS library on page 128. 02 July 31, 2012 Updated Where to get help on page 10 in the Preface. Changed occurrences of "dataset" to "backup." A01 April 11, 2012 First release of Avamar Extended Retention 6.1. Related documentation The following EMC publications provide additional information: EMC Avamar 6.1 Extended Retention Release Notes EMC Avamar 6.1 Extended Retention Security Guide EMC Avamar 6.1 Media Access Node Customer Hardware Installation Guide EMC Avamar Compatibility and Interoperability Matrix EMC Avamar Data Store Gen4 Customer Service Guide EMC Avamar Data Store Site Prep Technical Specifications Conventions used in this document EMC uses the following conventions for special notices: DANGER indicates a hazardous situation which, if not avoided, will result in death or serious injury. 8 EMC Avamar 6.1 Extended Retention User Guide
WARNING indicates a hazardous situation which, if not avoided, could result in death or serious injury. CAUTION, used with the safety alert symbol, indicates a hazardous situation which, if not avoided, could result in minor or moderate injury. NOTICE is used to address practices not related to personal injury. Note: A note presents information that is important, but not hazard-related. IMPORTANT An important notice contains information essential to software or hardware operation. Typographical conventions EMC uses the following type style conventions in this document: Normal Used in running (nonprocedural) text for: Names of interface elements, such as names of windows, dialog boxes, buttons, fields, and menus Names of resources, attributes, pools, Boolean expressions, buttons, DQL statements, keywords, clauses, environment variables, functions, and utilities URLs, pathnames, filenames, directory names, computer names, links, groups, service keys, file systems, and notifications Bold Used in running (nonprocedural) text for names of commands, daemons, options, programs, processes, services, applications, utilities, kernels, notifications, system calls, and man pages Used in procedures for: Names of interface elements, such as names of windows, dialog boxes, buttons, fields, and menus What the user specifically selects, clicks, presses, or types Italic Used in all text (including procedures) for: Full titles of publications referenced in text Emphasis, for example, a new term Variables Courier Used for: System output, such as an error message or script URLs, complete paths, filenames, prompts, and syntax when shown outside of running text Courier bold Used for specific user input, such as commands Courier italic Used in procedures for: Variables on the command line User input variables < > Angle brackets enclose parameter or variable values supplied by the user EMC Avamar 6.1 Extended Retention User Guide 9
[ ] Square brackets enclose optional values Vertical bar indicates alternate selections; the bar means 'or' { } Braces enclose content that the user must specify, such as x or y or z... Ellipses indicate nonessential information omitted from the example Where to get help The Avamar support page provides access to licensing information, product documentation, advisories, and downloads, as well as how-to and troubleshooting information. This information may enable you to resolve a product issue before you contact EMC Customer Service. To access the Avamar support page: 1. Go to https://support.emc.com/products. 2. Type a product name in the Find a Product box. 3. Select the product from the list that appears. 4. Click the arrow next to the Find a Product box. 5. (Optional) Add the product to the My Products list by clicking Add to my products in the top right corner of the Support by Product page. Documentation The Avamar product documentation provides a comprehensive set of feature overview, operational task, and technical reference information. Review the following documents in addition to product administration and user guides: Release notes provide an overview of new features and known limitations for a release. Technical notes provide technical details about specific product features, including step-by-step tasks, where necessary. White papers provide an in-depth technical perspective of a product or products as applied to critical business issues or requirements. Knowledgebase The EMC Knowledgebase contains applicable solutions that you can search for either by solution number (for example, esgxxxxxx) or by keyword. To search the EMC Knowledgebase: 1. Click the Search link at the top of the page. 2. Type either the solution number or keywords in the search box. 3. (Optional) Limit the search to specific products by typing a product name in the Scope by product box and then selecting the product from the list that appears. 4. Select Knowledgebase from the Scope by resource list. 5. (Optional) Specify advanced options by clicking Advanced options and specifying values in the available fields. 6. Click the search button. 10 EMC Avamar 6.1 Extended Retention User Guide
Live chat To engage EMC Customer Service by using live interactive chat, click Join Live Chat on the Service Center panel of the Avamar support page. Service Requests For in-depth help from EMC Customer Service, submit a service request by clicking Create Service Requests on the Service Center panel of the Avamar support page. Note: To open a service request, you must have a valid support agreement. Contact your EMC sales representative for details about obtaining a valid support agreement or with questions about your account. To review an open service request, click the Service Center link on the Service Center panel, and then click View and manage service requests. Facilitating support EMC recommends that you enable ConnectEMC and Email Home on all Avamar systems: ConnectEMC automatically generates service requests for high priority events. Email Home emails configuration, capacity, and general system information to EMC Customer Service. Your comments Your suggestions help us to continue to improve the accuracy, organization, and overall quality of the user publications. Send your opinions of this document to: BSGDocumentation@emc.com Please include the following information: Product name and version Document name, part number, and revision (for example, 01) Page numbers Other details that will help us address the documentation issue EMC Avamar 6.1 Extended Retention User Guide 11
12 EMC Avamar 6.1 Extended Retention User Guide
CHAPTER 1 Introduction The following topics provide a high-level overview of the Avamar extended retention feature, which is included in version 6.1 of the core Avamar software product. The extended retention feature is a long-term retention solution intended for exporting Avamar backup data to a physical or virtual tape library. Overview... 14 Capabilities and limitations... 15 Important terms and definitions... 16 Operational best practices... 17 Introduction 13
Introduction Overview The Avamar extended retention feature is a solution that exports backup data from an Avamar server to a tape library (physical or virtual) for long-term retention purposes. This backup data can be imported (or restored) from tape as needed. The Avamar extended retention feature, which is included in version 6.1 of the core Avamar software product, is hosted on a dedicated server called the Media Access node. A tape device can be connected directly to the node via fiber-optic cable. The Avamar extended retention feature fully automates the execution of customer-defined export policies, which specify the Avamar backups to be exported, the schedules on which those backups are exported, and the retention periods for which the backups and information about them will remain on tape. Avamar extended retention streams the backups directly to tape, in re-hydrated format, without staging the data during the export process. When the backups are imported from tape, they are staged onto an instance of the Avamar server software that is installed on the Media Access node. The Avamar extended retention feature allows users to browse backups that have been exported to tape before selecting specific backups for import. The feature also provides exception alerting and historical reporting. The following figure illustrates the processes for exporting Avamar backups to tape through the Media Access node, and for restoring them to an Avamar client. Backup data is exported from either an Avamar or a Data Domain server, and is streamlined through the Media Access node and written to tape in a physical or virtual tape library. Data that has been exported to tape can be imported back to the Avamar server on the Media Access node, and then restored directly to a compatible Avamar client. 14 EMC Avamar 6.1 Extended Retention User Guide
Introduction Capabilities and limitations The Avamar extended retention feature provides a number of capabilities and benefits to customers, including: Allowing customers to put Avamar backups on tape Lowering the cost of storage for Avamar long-term retention of backups Producing transportable media for storing off-site Producing transportable media for restoring at an alternative site Avamar 6.1 is required Limitations associated with the extended retention feature are described in the following topics. The Avamar extended retention feature is included in the Avamar 6.1 release. Customers must also upgrade the Avamar grids that will be used by the extended retention feature to Avamar 6.1. Avamar extended retention is intended for long-term retention Partial imports are not supported Avamar extended retention is to be used for long-term retention of data, and is not intended for operational recovery purposes. Administrators can use this feature to initiate the import of backups that have been exported to tape. However, the feature is not intended for end-users to perform their own imports. The feature is also not suitable for use as an alternative to replication or for use as a complete disaster recovery solution. Avamar extended retention supports full imports of complete backups on a machine-by-machine basis. The feature does not support partial imports of directories, files, or any subset of a backup. Exports and imports can take a significant amount of time Exports and imports may take a long time depending upon the amount of data that is involved. A single physical or virtual tape library is supported Standalone tape drives are not supported Currently, Avamar extended retention can export Avamar backups to a single physical or virtual tape library. The use of multiple libraries is not supported. Avamar extended retention requires the use of a tape library with a robotic arm, or an equivalent virtual tape library. Standalone tape drives are not supported. Avamar extended retention must also have exclusive control of the tape library and all drives that are allocated to it. The first release of the feature has not been designed to coordinate access with any other tape management implementation. Capabilities and limitations 15
Introduction Important terms and definitions The following terms are used throughout this guide. Avamar extended retention agent The Avamar extended retention software component, which transforms a backup data stream from Avamar format into a proprietary format (during export) and vice versa (during restore). The agent is one of several distinct components that collectively make up the extended retention feature. Avamar extended retention application The Avamar extended retention software component where the overall extended retention capability is administered. The Avamar extended retention application maintains schedules and policies, kicks off jobs accordingly and drives the extended retention user interface. Backup An object that contains all the data that an Avamar client or plug-in stores about a filesystem or application at the time a backup is created. The Avamar term is Dataset. Backup metadata Attributes of the backups that have been exported by Avamar extended retention, such as the host machine it was taken from, the date/time it was taken, and the tape(s) it was exported to. Eject The action of unloading a tape from a tape drive or off-line storage slot (library) for the purpose of physically relocating the media to another location. Export The action of transporting (extracting) a backup from an Avamar server and ultimately writing it onto long-term storage media. External Avamar servers The Avamar servers (also known as grids) whose backups will be exported to tape. In this guide, these servers are referred to as external to distinguish them from the import server. Export policy Defines the schedule on which a group of client backups will be exported to tape by Avamar extended retention. The export policy defines the group of clients that share a common schedule and retention periods for backup metadata and file-level metadata. Import The first phase of performing a restore operation, during which backups are transferred from tape to the internal Avamar server instance residing on the Media Access node. Import server The Avamar server that is installed on the Media Access node. Backups are imported from tape to this server. Media Access node A 7.8 TB, Gen4 node that has an HBA port, which allows a tape device to be connected directly to the node via fiber-optic cable. Avamar extended retention and an instance of Avamar run on this node. 16 EMC Avamar 6.1 Extended Retention User Guide
Introduction Operational best practices Creating an administrative user account Exporting backups to tape Restore The action of recovering a backup from long-term storage media to a target client machine such that the data is returned to its original state at the time the backup was taken by the original Avamar server. Retention periods Configurable options for backups and the files contained in the backups. The retention period specifies how long the backups and files can be browsed in the system. Springboard A control feature that displays in a workspace. Springboards allow you to view status and schedule information, to configure system settings, to view events, logs, and tasks, to manage users, and to open additional web pages in which you can perform key configuration and administrative tasks within Avamar extended retention. Storage Management System The Avamar extended retention software component that manages the library and tape media. Workspace A web page in the Avamar extended retention user interface that contains springboards that are used to perform specific tasks. Currently, the user interface provides three workspaces: Administration, Avamar Extended Retention, and My Workspace. The following best practices provide tips for helping to ensure the most efficient operation of the Avamar extended retention system. The first time you log in to the Avamar Extended Retention application, you have to provide credentials for the super user account, suser. This account should be reserved for performing administrative activities only, such as dealing with emergencies and lockouts. We recommend that, after you have logged in as suser, you immediately create a new user account and assign all available roles to the user with the exception of the EMC Support role, which is for internal purposes only. Instructions for creating user accounts and assigning roles are provided in Creating a user account on page 33 and in Editing a user account on page 34. Make sure that the export policy schedules line up with the Avamar backups in such a way that exports to tape happen only once after a backup is executed. Instructions for creating export policies are provided in Creating an export policy on page 93. After you create an export policy, run it once manually, and verify that the expected number of jobs are running. Operational best practices 17
Introduction Labeling tape volumes To verify the expected number of jobs: 1. Open the Task Viewer. Creating disaster recovery images 2. When the export policy shows as being in Active state, click the information bubble icon next to it and make sure that the number of jobs running and waiting match what you expect. If the number is not what you expect, one option is to increase the number of maximum jobs that can run in parallel. This setting is under System Properties in the Media Access node tab on the Configuration springboard. However, be aware that increasing this number directly impacts the performance of the external grids. Do not run exports during maintenance or blackout windows that are scheduled on the external Avamar servers. Always make sure that the library has labeled media available for exports. Label at least two tape volumes as bootstrap tapes. Instructions for labeling bootstrap tapes are provided in Labeling volumes on page 81. Labeling tapes can take time. After initiating a request to label a tape, verify that it has been labeled as follows: 1. Open the Event Viewer and wait for the Successfully labeled volume xxx event to appear. 2. In the Media Management page, make sure that the newly labeled tape shows as being labeled in the Volumes panel. (Volumes that have not been labeled have unlabeled in the Volume Name column.) Ask the administrator to set up a cron job to create a disaster recovery image automatically when the system is not busy with other tasks, such as exports and imports. Recovery images should be created regularly to ensure that the most current data possible can be recovered when needed. Instructions for creating a recovery image are provided in Creating a disaster recovery image on page 134. Clearing the browser cache before logging in for the first time If you have re-installed Avamar extended retention, delete the browser cache before logging in to the new installation for the first time. 18 EMC Avamar 6.1 Extended Retention User Guide
CHAPTER 2 Getting Started The following topics describe how to log in to the Avamar Extended Retention user interface. They also describe the workspaces that are available, what they are for, and how to access them: Supported browsers... 20 What to do the first time you use Avamar extended retention... 20 Logging in for the first time... 20 The Administration workspace... 23 Customizing My Workspace... 27 The Avamar Extended Retention workspace... 27 Using online help... 29 Logging out... 30 Getting Started 19
Getting Started Supported browsers The Avamar extended retention application has been tested using the following web browsers: Windows Internet Explorer Mozilla Firefox Google Chrome Refer to the EMC Avamar Compatibility and Interoperability Matrix for supported browser versions. What to do the first time you use Avamar extended retention Logging in for the first time The first time you use the Avamar extended retention feature, perform the following tasks in the order shown below: 1. Create a disaster recovery image of the Avamar extended retention system as described in Creating a disaster recovery image on page 134. 2. Log in to the Avamar Extended Retention framework, and set up the lockbox password and the framework administrator account as described in Logging in for the first time. 3. In the Administration workspace, create at least one user and assign administrator roles to the user as described in Creating a user account on page 33 and in Editing a user s roles on page 37. 4. Access the Avamar Extended Retention workspace, and open springboards as described in The Avamar Extended Retention workspace on page 27 and in Opening Avamar Extended Retention springboards on page 64. 5. Label volumes in the library as described in Labeling volumes on page 81. 6. Create an export policy as described in Creating an export policy on page 93. After you have created export policies and the exports are running, you can begin monitoring events and tasks, and browsing and importing Avamar backups. To log in to the Avamar extended retention: 1. Open a web browser and access the following URL: https//:media_access_node_ip_address:7443/imf.action where media_access_node_ip_address is the IP address of the Media Access node on which the Avamar extended retention feature is running. The first time you log in to the extended retention feature, you must set up the lockbox password and create the framework administrator account. 20 EMC Avamar 6.1 Extended Retention User Guide
Getting Started 2. In the Setup Lockbox Password dialog box, type a lockbox password. 3. Type the password again to confirm it, and click Save Lockbox Changes. The Create Framework Admin Account dialog box appears. 4. In the Create Framework Admin Account dialog box, type the name, email address, and password for the Avamar extended retention framework administrator account, suser. The administrator, suser, will use this password to log in to the Avamar extended retention application. Additional users can be created from within the Administration workspace. 5. Click Save Administrator Account. The EMC Avamar Extended Retention login screen appears. Logging in for the first time 21
Getting Started 6. In the EMC Avamar Extended Retention login screen, type suser in the User Name box, and the password that was specified in step 4 in the Password box. 7. Click Login. The Administration workspace appears. See The Administration workspace on page 23 for instructions on using the workspace. Login failures If you enter incorrect login information, the following Error appears. Click OK and type the correct password in the Password box. If you exceed three login tries without entering the correct login information, an Error dialog box is displayed. Click OK, and contact the administrator to unlock the account. Each failed login attempt creates a warning security event. 22 EMC Avamar 6.1 Extended Retention User Guide
Getting Started Session timeouts The Administration workspace The amount of time a logged-in session remains active depends upon the session timeout setting. (The default setting is 45 minutes.) No notification is displayed when a session times out; however, you will not be able to interact with the user interface after it has timed out. If the session times out, you must log back in to the Avamar extended retention application. After you login, you see the Administration workspace in the EMC Avamar Extended Retention page. The Administration workspace initially contains the springboards that are displayed by default as shown in the following figure. The Administration workspace 23
Getting Started The Administration workspace also contains two tabs stacked vertically along the left side: The WORKSPACES tab contains Avamar Extended Retention, My Workspace, and Administration. The TOOLBAR tab displays an icon of the active workspace and a checklist of available springboards. When you select a springboard in the list, it is displayed in the workspace. Accessing available workspaces The list of springboards available on the TOOLBAR tab depends on the roles assigned to the user. The WORKSPACES tab opens and closes horizontally by clicking it. The WORKSPACES tab contains icons for My Workspace, Administration, and Avamar Extended Retention. Administration workspace Avamar Extended Retention workspace A workspace provides screen real estate for placing springboards. You can customize workspaces by adding or removing springboards, or by copying springboards to My Workspace. The Administration workspace contains springboards that let you perform a number of administrative tasks. The springboards and the tasks that you can perform are described in detail in Using the Administration Workspace on page 31. The Avamar Extended Retention workspace contains springboards that let you perform all of the tasks associated with managing the library media, and exporting and importing Avamar backups. The springboards and the tasks that you can perform are described in detail in Using the Avamar Extended Retention Workspace on page 63. 24 EMC Avamar 6.1 Extended Retention User Guide
Getting Started My Workspace My Workspace is a user-defined workspace. Initially, My Workspace contains three rectangles, which represent drop zones for springboards. My Workspace provides an area for you to organize frequently-used springboards for easy access. Adding and removing springboards The TOOLBAR tab opens and closes horizontally when you it. When the TOOLBAR tab is open, it displays the icon for the active workspace and the Springboards list. The Springboards list enables you to add or remove springboards to or from a workspace. The roles for the current user determine what springboards are available in the Springboards list. To add a springboard to a workspace: 1. Select the WORKSPACES tab, and click a workspace. 2. In the workspace, expand the TOOLBAR tab, and click the checkbox preceding the springboard that you want to use. The springboard is added to the workspace. To remove a springboard from a workspace: 1. Select the WORKSPACES tab, and click a workspace. 2. In the workspace, select the TOOLBAR tab, and clear the checkbox preceding the springboard that you want to remove. The springboard is removed from the workspace. The Administration workspace 25
Getting Started Moving springboards within a workspace You can move a springboard to another location within a workspace by dragging and dropping it onto another springboard or onto a valid drop zone. (Drop zones are represented by dotted-line rectangles.) To move a springboard: Displaying springboards in a workspace 1. Click and hold the mouse cursor on the springboard's title bar. 2. Drag the springboard to a valid drop zone and drop it by releasing the mouse button. The springboard appears as a transparent rectangle as it is moved, and the mouse cursor changes to a icon to indicate an invalid drop zone. You can display any number of available springboards in a workspace. The list of available springboards is located in the TOOLBAR tab. To add the springboard back to a workspace: 1. Click the TOOLBAR tab. Hiding springboards in a workspace 2. Click the checkbox next to the springboard that you want to display. The springboard appears in the workspace. The springboards in each workspace contain a hide from workspace right corner. icon in the top To hide a springboard in a workspace: 1. Open the workspace in which you want to hide a springboard. 2. Click the hide from workspace icon. The springboard no longer displays in the workspace. 26 EMC Avamar 6.1 Extended Retention User Guide
Getting Started The Avamar Extended Retention workspace The Avamar Extended Retention workspace is where you manage the library media, and export and import Avamar backup data to and from tape. Detailed instructions for using this workspace are provided in Using the Avamar Extended Retention Workspace on page 63. To access the Avamar Extended Retention workspace: 1. Click the WORKSPACES tab. The WORKSPACES tab slides out. 2. In the WORKSPACES tab, click Avamar Extended Retention. The Avamar Extended Retention workspace appears. Customizing My Workspace By default, the Import & Restore, Media Management, and Scheduled Exports springboards are already open. 3. Click the TOOLBAR tab, and select other springboards that you want to view in the workspace. You can customize My Workspace by copying springboards from other workspaces, and by adding springboards to the Springboards list. Copying springboards from other workspaces to My Workspace Each springboard in the Administration and Avamar Extended Retention workspaces contains a house icon in the upper right corner. The Avamar Extended Retention workspace 27
Getting Started To copy a springboard to My Workspace, click the house icon on the springboard. The springboard now appears in both my My Workspace and in the active workspace. Adding springboards to the Springboards list in My Workspace To display springboards in My Workspace: 1. Select the WORKSPACES tab, and then click My Workspace. The My Workspace screen appears. 2. Select the TOOLBAR tab. 3. Below Springboards, click [edit]. The My Workspace Springboards dialog box appears. 4. In the Workspace list, select Administration or Avamar extended retention. A list of springboards available for the selected workspace appears in the Available Springboards panel. 5. Select or clear checkboxes next to the springboard names: To include a springboard in the workspace's Springboards list, select the checkbox preceding the springboard name. To exclude a springboard from the workspace's Springboards list, clear the checkbox preceding the springboard name. 6. Repeat steps 4 and 5 to edit the Springboards list for the other workspace, or if finished, continue to step 7. 28 EMC Avamar 6.1 Extended Retention User Guide
Getting Started 7. Click OK to save the changes, or click Cancel to quit. The Springboards list is updated accordingly. Removing springboards from the Springboards list in My Workspace To remove springboards from the Springboards list for My Workspace: 1. Select the WORKSPACES tab, and then click My Workspace. The My Workspace screen appears. 2. Select the TOOLBAR tab. 3. In the Springboards list, click the X icon next to the springboard. Using online help An Alert dialog box appears. Avamar Extended Retention online help 4. Click OK to remove the springboard from the Springboards list, or click Cancel to quit. Online help for Avamar extended retention is available in the user interface. You can open the entire help system, or you can open help topics that are specific to each springboard and page. To view the entire Avamar Extended Retention online help system: 1. Click the question mark icon located in the upper right corner of the workspace. Using online help 29
Getting Started The menu shown in the following figure opens. Springboard and page-level help 2. Select an option from the menu: The Avamar Extended Retention Help link opens the online help for the application. The About EMC Avamar Extended Retention link opens a dialog box that contains copyright and version information about Avamar extended retention. To view springboard and page-level online help: Click the question mark icon in the upper right corner of a springboard to see a help topic that describes that springboard. Click the question mark icon in the upper right corner of a page (for example, the Export Policy Management page), and select the page name to display a topic that explains how to perform the tasks that are available on that page. Logging out To log out of the Avamar Extended Retention interface, click the door icon located in the upper right corner of the workspace. 30 EMC Avamar 6.1 Extended Retention User Guide
CHAPTER 3 Using the Administration Workspace The following topics describe the tasks that you can perform in the Administration workspace: User management... 32 Role management... 36 User profile management... 39 System configuration... 42 System events... 45 Tasks... 51 Security events... 55 Log information... 60 Using the Administration Workspace 31
Using the Administration Workspace User management The User Management springboard This topic describes how to manage Avamar extended retention users. The User Management springboard enables an administrator (a user with the Administrator role) to create, edit, and disable user accounts. An administrator also uses the User Management springboard to unlock user accounts for users, who fail to log in after three tries. Searching for a user The User Management springboard allows you to search for specific users. The users who match the search criteria are displayed in the User Management springboard. To search for a user: 1. Begin typing the user's last name in the Name box. Only those users whose last names match what you are typing are displayed in the User Management springboard. 2. If you want to include the first name, type a comma and a space after the last name, and begin typing the first name. Only those users whose last and first names match the criteria are displayed in the User Management springboard. 32 EMC Avamar 6.1 Extended Retention User Guide
Using the Administration Workspace Creating a user account To create a user account: 1. In the User Management springboard, click Create User. The Create User dialog box appears. Note: Red asterisks indicate required information. 2. In the User Name box, type a unique name. Maximum length is 32 alphanumeric characters. Do not use special characters, or leading or trailing spaces. The username is case insensitive. 3. In the First Name box, type the user's last name. Maximum length is 32 alphanumeric characters. Do not use special characters, or leading or trailing spaces. 4. In the Last Name box, type user's last name. Maximum length is 32 alphanumeric characters. Do not use special characters, or leading or trailing spaces. 5. In the Email Address box, type the user's email address in the standard email format: username@example.com Valid email addresses contain 5 to 64 characters. 6. For Status, select Active to enable the user account, or Inactive to disable it. 7. In the Password box, type a password from 8 to 32 characters. The password must contain at least 8 characters including uppercase and lowercase characters, one numeric character, and one special character from the following characters:! @ # $ % ^ & * ( )? _ < > " : ; ',. / Do not use any of the following characters in a password: Leading or trailing spaces Minus (-), plus (+), or equal (=) The password is case sensitive. Note: For security, passwords are masked by asterisks. 8. In the Confirm Password box, type the password again to confirm it. User management 33
Using the Administration Workspace Editing a user account 9. Click OK to create the user account, or Cancel to quit. The new user account appears in the list box. By default, all new user accounts are assigned the User role. To edit a user account: 1. In the User Management springboard, type the user's last name or a portion of it in the Name box. The framework tries to match the characters you type to existing last names. 2. Select the user from the list of names. 3. Click Edit User. The Edit User dialog box appears. Note: Red asterisks indicate required information. The table in Creating a user account on page 33 includes descriptions for each text box. 4. Edit the information. Note: For security, the password field displays a dummy password. 5. Click OK to continue with the edit, or Cancel to close the Edit User dialog box without saving changes. 34 EMC Avamar 6.1 Extended Retention User Guide
Using the Administration Workspace Disabling a user account You cannot delete a user account from within the application. You can only disable an account. To disable a user account: 1. In the User Management springboard, type the user's last name or a portion of it in the Last Name text box. The framework tries to match the characters you type to existing last names. 2. Select the user from the list of names. 3. Click Edit User. The Edit User dialog box appears. 4. Select Inactive. Unlocking a user account 5. Click OK to disable the user, or Cancel to close the Edit User dialog box without saving changes. The framework locks a user's account after the user fails to log in after three attempts. The fourth login attempt and all subsequent logins result in an error message. When this happens, an administrator must unlock the account. To unlock a user account: 1. In the User Management springboard, type the user's last name or a portion of it in the Name box. The framework tries to match the characters you type to existing last names. 2. Select the user from the list of names. 3. Click Edit User. The Edit User dialog box appears with an additional option, Login Status. User management 35
Using the Administration Workspace 4. Click the Locked icon next to Login Status. The locked icon changes to an unlocked icon. Role management The Role Management springboard 5. Click OK to unlock the user account, or Cancel to close the Edit User dialog box without saving changes. The Login Status option only appears in the Edit User dialog box when a user's account is locked. After an administrator unlocks the user account, the framework no longer displays the Login Status option in the Edit User dialog box. This topic describes how to manage Avamar extended retention user account roles. The Role Management springboard enables an administrator to add or delete roles to or from a user account. Types of roles Roles enable a user to access components and functionality within the application. The types of roles a user is assigned determine which springboards and events the user can access. The following table contains a one-to-one relationship between Avamar extended retention functions and the required roles. Table 2 Avamar extended retention functions and required roles (Sheet 1 of 2) Required roles Functions Administrator Auditor User Create or edit users Yes No No Create or apply images Yes No No Edit configuration options Yes No No Edit user roles Yes No No Launch Event Viewer Yes No Yes Launch Security Event Viewer No Yes No Launch Task Viewer Yes No Yes 36 EMC Avamar 6.1 Extended Retention User Guide
Using the Administration Workspace Table 2 Avamar extended retention functions and required roles (Sheet 2 of 2) Required roles Functions Administrator Auditor User Make changes from My Profile springboard Yes Yes Yes View Framework Configuration springboard Yes No No View Event Summary springboard Yes No Yes View Log Information springboard Yes No No View My Profile springboard Yes Yes Yes View Role Management springboard Yes No No View Security Events springboard Yes Yes Yes View Task Summary springboard Yes No Yes View tasks in Task Viewer Yes No Yes View threat level Yes Yes Yes View User Management springboard Yes No No Editing a user s roles Only users with the Administrator role can edit a user s roles. You can edit the roles a user has for the framework and for Avamar Extended Retention. To edit a user s role: 1. In the Role Management springboard, select the user whose roles you want to edit. 2. Click Edit User Roles. The Edit Role Assignments dialog box appears in the Framework view, which displays the Framework roles that are available. Role management 37
Using the Administration Workspace Note: The EMC Support role is to be used by EMC Support only. Do not select this role. 3. Select the component, either Framework or Avamar Extended Retention. The roles for Avamar Extended Retention are shown in the following figure. 4. Select or clear checkboxes as needed to edit the user s roles. When you clear a checkbox, the role is removed from the user. 5. Click OK to add or delete the roles for the selected user, or Cancel to close the Edit Role Assignments dialog box without saving changes. 38 EMC Avamar 6.1 Extended Retention User Guide
Using the Administration Workspace Generating a user role report The User Role Report displays user information, including the roles that are assigned to each user. To generate a user role report, click Generate Role Report in the Role Management springboard. The report opens in a new browser tab if you are using tabs or in a new browser window if you are not. An example report is shown below. User profile management The My Profile springboard This topic describes how to manage a user's profile. To manage a user s profile, you must be logged in as that user. The My Profile springboard enables you to make changes to a user's profile. Note: You must be logged in to the specific user account to make changes to a user's profile. User profile management 39
Using the Administration Workspace Changing a user name or email address To change a user's name or email address: 1. In the My Profile springboard, select Change information. The Change Information dialog box appears. Changing a password Note: Red asterisks indicate required information. 2. In the First Name box, type the first name. Do not use special characters, or leading or trailing spaces. Maximum length is 32 alphanumeric characters. 3. In the Last Name box, type the last name. Do not use special characters, or leading or trailing spaces. Maximum length is 32 alphanumeric characters. 4. In the Email Address box, type the email address in the standard email format: username@example.com Valid email addresses contain 5 to 64 characters 5. Click OK to commit the changes, or Cancel to close the Change Information dialog box without saving changes. To change a password: 1. In the My Profile springboard, select Change password. The Change Password dialog box appears. Note: Red asterisks indicate required information. 2. Type the old password in the Old Password text box. 3. Type a new password in the New Password text box. The password must contain 8 to 32 characters, including one numeric character, lowercase and uppercase characters, and one special character from the following character set:! @ # $ % ^ & * ( )? _ < > " : ; ',. / 40 EMC Avamar 6.1 Extended Retention User Guide