Snap Enterprise Data Replicator™ Administrator Guide V.5.2.2

Transcript

Snap Enterprise Data Replicator™ Administrator Guide v.5.2.2 COPYRIGHT Copyright © 2007,Adaptec, Inc. All rights reserved worldwide. Information in this document is subject to change without notice and does not represent a commitment on the part of Adaptec or any of its subsidiaries. The software described in this document is furnished under a license agreement. The software may be used only in accordance with the terms of the license agreement. It is against the law to copy the software on any medium. No part of this manual may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying and recording, for any purpose without the express written permission of Adaptec, Inc. TRADEMARKS Adaptec, the Adaptec logo, Snap Server, the Snap Server logo, GuardianOS, SnapOS, Snap Disk, Snap EDR and Snap Enterprise Data Replication are trademarks or registered trademarks of Adaptec, Inc. in the U.S.A. and other countries. Products mentioned herein are for identification purposes only and may be registered trademarks or trademarks of their respective companies. Windows, Windows NT, Internet Explorer, and Active Directory are registered trademarks of Microsoft Corporation. Java and Solaris, are registered trademarks of Sun Microsystems, Inc. Netscape is a registered trademark of Netscape Communications Corp. AppleShare, AppleTalk, Macintosh, and MacOS are registered trademarks of Apple Computer. BakBone and NetVault are trademarks of BakBone Software. AIX is a registered trademark of IBM Corporation. OpenView and HP-UX are trademarks or registered trademarks of Hewlett-Packard Company. BrightStor, Unicenter TNG, ARCserve, eTrust, and Unicenter are trademarks or registered trademarks of Computer Associates, Inc. Smart UPS and APC are registered trademarks of American Power Conversion Corporation. UNIX is a registered trademark of The Open Group. XFS is a trademark of Silicon Graphics, Inc. Backup Exec, VERITAS NetBackup BusinessServer, and VERITAS NetBackup DataCenter are trademarks or registered trademarks of VERITAS Software Corporation. Legato NetWorker is a trademark of Legato Systems, Inc. Linux is a registered trademark of Linus Torvalds. SCO Open Server and UnixWare are trademarks of the SCO Group. All other brand names or trademarks are the property of their respective owners. REVISIONS Adaptec, Inc. provides this publication “as is” without warranty of any kind, either express or implied, including but not limited to the implied warranties of merchantability or fitness for a particular purpose. Adaptec and its subsidiaries reserve the right to revise this publication and to make changes in the content hereof without the obligation of Adaptec to notify any person of such revision or changes. END USER LICENSE AGREEMENT (EULA) FOR USE OF ADAPTEC STORAGE SOLUTIONS AND RELATED INSTALLATION UTILITIES SNAP IP, ASSIST, AND SNAP SERVER MANAGER (INSTALLATION UTILITIES); THE SYSTEM SOFTWARE EMBEDDED IN THE SNAP ENTERPRISE DATA REPLICATOR (EMBEDDED SOFTWARE); SOFTWARE MARKETED BY ADAPTEC OR THAT IS EMBEDDED IN OR OTHERWISE CONSTITUTES A PART OF ADAPTEC COMPUTER HARDWARE PRODUCT(S) (SOMETIMES REFERRED TO COLLECTIVELY HEREIN, TOGETHER WITH THE INSTALLATION UTILITIES AND THE EMBEDDED SOFTWARE, AS THE LICENSED SOFTWARE), EXCEPT WHERE EXPRESSLY PROVIDED OTHERWISE, ARE PROPRIETARY COMPUTER SOFTWARE BELONGING TO ADAPTEC, INC. OR ITS LICENSORS. UNITED STATES COPYRIGHT AND OTHER FEDERAL AND STATE LAWS AND INTERNATIONAL LAWS AND TREATIES PROTECT THE INSTALLATION UTILITIES AND EMBEDDED SOFTWARE. USE OF THE SNAP ENTERPRISE DATA REPLICATOR (SERVER) OR THE INSTALLATION UTILITIES IMPLIES YOUR AGREEMENT TO THE TERMS AND CONDITIONS OF THIS LICENSE AGREEMENT. BY USING THE INSTALLATION UTILITIES OR THE SERVER, YOU ARE ENTERING INTO A BINDING CONTRACT WITH ADAPTEC, INC. IF YOU DO NOT AGREE TO BE BOUND BY THESE TERMS AND CONDITIONS, YOU MAY NOT USE THE INSTALLATION UTILITIES, THE EMBEDDED SOFTWARE, OR THE SERVER AND SHOULD PROMPTLY RETURN THIS ENTIRE PACKAGE, INCLUDING THE INSTALLATION UTILITIES AND SERVER, TO THE PLACE WHERE YOU PURCHASED IT FOR A FULL REFUND. Ownership and Copyright. The Installation Utilities and Embedded Software are licensed, not sold to you, for use only as permitted by the terms and conditions of this Agreement. Adaptec reserves any rights not expressly granted to you. The Licensed Software is composed of multiple, separately written and copyrighted modular software programs. Various Licensed Software programs (the ‘Public Software’) are copyrighted and made available under the GNU General Public License or other licenses that permit copying, modification and redistribution of source code (which licenses are referred to as ‘Public Licenses’). The Public Software is licensed pursuant to (i) the terms of the applicable Public License located in the related software source code file(s), and/or in its on-line documentation; and (ii) to the extent allowable under the applicable Public License. The GPL and source code are available at oss.snapserver.com. To receive a copy of the GNU General Public License, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. Various Public Software programs are copyrighted by the Regents of the University of California and are derived from material licensed to the University of California by its contributors, to which the following disclaimer applies: THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ‘AS IS’ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. All other Licensed Software programs (the Restricted Software) are copyrighted by Adaptec or its licensors and are licensed pursuant to all of the terms of this Agreement. Copying of the Licensed Software, unless specifically authorized in writing by Adaptec, is prohibited by law. You may not use, copy, modify, sell, lease, sublease, or otherwise transfer the Installation Utilities or Embedded Software, or any copy or modification, in whole or in part, except as expressly provided in this Agreement. PROVISIONS APPLICABLE TO RESTRICTED SOFTWARE ONLY (ARTICLES 2 - 7): License. In consideration of the premises of this License Agreement, your payment of any applicable license fee for Restricted Software, and/or your purchase of a Snap Server that the Licensed Software accompanies, for the term of intellectual property protection inhering in the Licensed Software, Adaptec hereby grants to you a limited, personal, and non-exclusive license to install and execute (‘Use’) the Restricted Software solely under the terms and conditions of this Agreement and only on the Server in connection with which Adaptec originally provided such Restricted Software. You are given a non-exclusive license to use the Installation Utilities and Embedded Software in conjunction with a Server, make one copy of the Installation Utilities for archival and backup purposes only, and/or transfer your Server and copies of the Installation Utilities and the accompanying documentation to a third party provided that you provide Adaptec written notice of the transfer within 30 days after the transfer date and you do not retain any copy of the transferred software. Any such transfereeís rights and obligations with respect to the transferred software and documentation are as set forth in this Agreement. Reproduction of Proprietary Notices. You may not sublicense, distribute, rent, lease, lend, or otherwise convey the Restricted Software or any portion thereof to anyone, and under no circumstance may you use or allow the use of the Restricted Software in any manner other than as expressly set forth herein. Copies of the Installation Utilities must be labeled with the Adaptec copyright notice and other proprietary legends found on the original media. Protection of Trade Secrets. The Licensed Software contains trade secrets, and in order to protect them, you agree that you will not reverse assemble, decompile or disassemble, or otherwise reverse engineer any portion of the Restricted Software, or permit others to do so, except as permitted by applicable law, but then only to the extent that Adaptec (and/or its licensors) is not legally entitled to exclude or limit such rights by contract. Except with respect to online documentation copied for backup or archival purposes, you may not copy any documentation pertaining to the Licensed Software. You agree that your use and possession of the Licensed Software is permitted only in accordance with the terms and conditions of this Agreement. Ownership of Restricted Software. You agree and acknowledge that, (i) Adaptec transfers no ownership interest in the Restricted Software, in the intellectual property in any Restricted Software or in any Restricted Software copy, to you under this Agreement or otherwise, (ii) Adaptec and its licensors reserve all rights not expressly granted to you hereunder, and (iii) the Restricted Software is protected by United States Copyright Law and international treaties relating to protection of copyright, and other intellectual property protection laws of the U.S. and other countries. Termination. If you fail to fulfill any of your material obligations under this Agreement, Adaptec and/or its licensors may pursue all available legal remedies to enforce this Agreement, and Adaptec may, at any time after your default of this Agreement, terminate this Agreement and all licenses and rights granted to you hereunder. You agree that any Adaptec suppliers referenced in the Restricted Software are thirdparty beneficiaries of this Agreement, and may enforce this Agreement as it relates to their intellectual property. You further agree that, if Adaptec terminates this Agreement for your default, you will, within thirty (30) days after any such termination, deliver to Adaptec or render unusable all Restricted Software originally provided to you hereunder and any copies thereof embodied in any medium. Government End Users. The Installation Utilities, Embedded Software, and accompanying documentation are deemed to be ‘commercial computer software’ and ‘commercial computer software documentation,’ respectively, pursuant to DFAR Section 227.7202, Commercial Computer Software-Restricted Rights at 48 CFR 52.227-19, and FAR Section 12.212, and successor provisions thereof, as applicable. Any use modification, reproduction release, performance, display, or disclosure of the Installation Utilities or Embedded Software and accompanying documentation by the U.S. Government shall be governed solely by the terms of this Agreement and shall be prohibited except as expressly permitted by the terms of this Agreement. PROVISIONS APPLICABLE TO RESTRICTED SOFTWARE AND, SUBJECT TO SECTION1, TO PUBLIC SOFTWARE (ARTICLES 8 - 15): Export Laws. Notwithstanding any provision of any Public License to the contrary, Adaptec shall have no duty to deliver or otherwise furnish source code of any Public Software if it cannot establish to its reasonable satisfaction that such delivery or furnishing will not violate applicable US laws and regulations. You hereby assure that you will not export or re-export any Licensed Software except in full compliance with all applicable laws, regulations, executive orders, and the like pertaining to export and/or re-export, including without limitation USA versions of the same. No Licensed Software may be exported or re-exported into (or to a national or resident of) any country to which the U.S. embargoes goods, or to anyone on the U.S. Treasury Departmentís list of Specially Designated Nationals or the U.S. Commerce Departmentís Table of Denial Orders. You agree to ascertain necessary licensing procedures and obtain required licenses before exporting or re-exporting either. You also agree to indemnify Adaptec and assume all financial responsibility for any losses it may suffer if you do not comply with this paragraph. Disclaimer of Warranties. THE INSTALLATION UTILITIES AND EMBEDDED SOFTWARE ARE LICENSED ‘AS IS’ WITHOUT WARRANTY OF ANY KIND. ADAPTEC HEREBY DISCLAIMS ALL WARRANTIES, EXPRESS AND IMPLIED, RELATING TO THE INSTALLATION UTILITIES AND THE EMBEDDED SOFTWARE INCLUDING, WITHOUT LIMITATION, ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT. Limitation of Liability. IN NO EVENT WILL ADAPTEC OR ITS LICENSORSÍ LIABILITY UNDER THIS AGREEMENT EXCEED THE PRICE THAT YOU PAID FOR THE INSTALLATION UTILITIES AND EMBEDDED SOFTWARE. FURTHERMORE, IN NO EVENT WILL ADAPTEC OR ITS LICENSORS BE LIABLE FOR ANY LOST PROFITS, LOST DATA, COST OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR ANY SPECIAL, CONSEQUENTIAL, INCIDENTAL, INDIRECT, OR PUNITIVE DAMAGES ARISING OUT OF OR UNDER THIS AGREEMENT OR THE APPLICABLE PUBLIC LICENSE. The limitation of liability set forth in this paragraph will apply whether or not Adaptec or its licensor was advised of the possibility of the loss, liability, or damages and notwithstanding any failure of essential purpose of any limited remedy. Since some states do not allow exclusions or limitations of liability for consequential or incidental damages, this provision may not apply to you. Waiver. No delay or failure of Adaptec to exercise any right under this Agreement, nor any partial exercise thereof, shall be deemed to constitute a waiver of any rights granted hereunder or at law. Unlawful Provision(s). If any provision of the Agreement is held to be unenforceable for any reason, all other provisions of this Agreement shall nevertheless be deemed valid and enforceable to the fullest extent possible. Applicable Law. Except with respect to any Public Software program for which the applicable Public License contains provisions expressly stating the applicable governing law (with respect to which the law so specified shall govern all aspects of such agreement, including the provisions incorporated into such Public License hereunder), the terms of this Agreement (including, to the extent allowable under the Public License, all software governed by a Public License which does not specify a governing law) will be governed by the laws of the State of California, without reference to its choice of law rules, and the United States, including U.S. Copyright laws. Entire Agreement. This Agreement and all applicable Public Licenses supersede all proposals, negotiations, conversations, discussions, all other agreements, oral or written, and all past course of dealing between you and Adaptec relating to the Licensed Software or the terms of its license to you, and may only be modified in writing signed by you and Adaptec. Contractor/Manufacturer. Adaptec, Inc._ 691 South Milpitas Boulevard_ Milpitas, CA 95035. Contents Preface ...................................................................................... v Snap EDR Express .......................................................................................v Snap EDR ......................................................................................................v Snap EDR Advanced ................................................................................ vi How This Guide is Organized ................................................................vi Product Architecture .............................................................................vii Licensing Information ........................................................................... viii Other Information Sources ................................................................... viii Technical Support ..................................................................................ix Chapter 1Management Console Installation and Configuration .............................1 Installing and Configuring the Snap EDR Management Console ................ 1 Logging Into the Management Console.................................................... 2 Management Console Overview ............................................................. 3 Importing Data Management Tools ......................................................... 4 Management Console Preferences .......................................................... 4 Changing the User Password.................................................................. 5 Setting the Time Zone............................................................................. 5 Changing User Properties ...................................................................... 6 Chapter 2Agent Administration ...........................................................................7 Installing Snap EDR Agents .................................................................... 8 Downloading the Snap EDR Agent Information File .................................. 9 Installing the Agent Software on Windows-Based Systems ...................... 10 Prerequisites ...............................................................................................10 Installation Procedure ..............................................................................11 Installing the Agent Software on UNIX or Linux Systems.......................... 11 Verify that the Agent is Properly Configured .......................................... 12 Unsuccessful Agent Installation ............................................................. 13 Revoking an Agent’s Certificate ............................................................ 13 Uninstalling Agents.............................................................................. 15 Snap EDR Administrator Guide i Uninstalling an Agent from a Snap Server ............................................15 Uninstalling an Agent from Windows ...................................................15 Uninstalling an Agent from UNIX or Linux .........................................16 Configuration Notes.............................................................................16 Installation Location .................................................................................16 Port Requirements ....................................................................................17 Re-Sync with Management Console Button .........................................17 Certificate Validity Inconsistent Between Management Console and Agents ..............................................................................17 Warning Messages ....................................................................................17 Volume Deletion .......................................................................................17 Snapshot Rollback .....................................................................................18 Configuring User Accounts for the Windows Agent Service .............18 Chapter 3Data Management Tools .................................................................... 19 Aggregate Data Management Tool .......................................................19 Default Functionality ................................................................................19 Creating an Aggregate Job .......................................................................20 Distribute Data Management Tool .........................................................27 Default Functionality ................................................................................27 Creating a Distribute Job ..........................................................................28 Replicate Data Management Tool..........................................................30 Default Functionality ................................................................................30 Creating a Replicate Job ...........................................................................31 Monitoring, Editing and Copying Jobs...................................................32 Chapter 4Monitoring Jobs................................................................................. 33 Editing a Job .......................................................................................33 Copying a Job.....................................................................................34 Deleting a Job .....................................................................................34 Viewing Job Statistics ...........................................................................34 Viewing the Job Log Files .....................................................................36 Filtering Log Information.......................................................................37 Downloading a Job Log File..................................................................39 Manually Starting a Job .......................................................................40 Stopping a Running Job .......................................................................40 Checking a Job’s Running Status ...........................................................41 ii Snap EDR Administrator Guide Chapter 5Reporting...........................................................................................43 Report Types ....................................................................................... 43 Stats Summary Report.......................................................................... 44 Detail Report ....................................................................................... 46 Custom Query Report .......................................................................... 48 Generating a Report from a Template ................................................... 49 Scheduling a Report from a Template.................................................... 50 Chapter 6Maintenance ......................................................................................51 Trimming Manager Database Logs ....................................................... 51 Viewing Transfer Logs.......................................................................... 53 Appendix AExit Codes.......................................................................................67 Index.......................................................................................71 Contents iii iv Snap EDR Administrator Guide Preface The Snap EDRTM Management Console and Agents automate the secure flow of data between systems. This technology provides ready-to-use advanced file transfer and security features, and a scalable and flexible framework for remote data movement and management. There are three products in the Snap EDR family: Snap EDR Express, Snap EDR and Snap EDR Advanced. Each agent requires a separate license, and the licenses are sold by product, available from the Snap Server Web site at http://www.snapserver.com/Products/EDR.shtml. For more information on licensing, see the Snap EDR Quick Start Guide. Snap EDR Express Snap EDR Express supports replication between only two GuardianOS Snap Servers, one of which is the Agent installed by default on the Management Console, and includes the Replicate tool. The Replicate tool enables users to schedule a job to replicate files between two systems. Snap EDR Express does not include the Distribute and Aggregate tools. Snap EDR Express is not available for Windows, Linux or Unix agents. Snap EDR Snap EDR enables you to do the following: • Use the Replicate solution to schedule a job to replicate files between any two systems including Windows, Linux, and Unix Agents. • Use the Distribute solution to schedule a job where files are transferred from one source host to one or more target hosts. • Use the Aggregate solution to schedule a job to transfer files from multiple hosts to a single target host, and store the files on a local disk or locally-attached storage device. Snap EDR allows these transfers between Windows, Unix/Linux and/or GuardianOS systems. Administrator Guide v How This Guide is Organized Snap EDR Advanced Snap EDR Advanced provides all of the features of Snap EDR, and adds the Inventory, Archive, Backup and Restore tools to the product. Snap EDR Advanced allows you to do the following: • Use the Inventory remote data management tool to schedule a job to specify criteria to report on file systems (such as when files were last accessed, last modified, the size of files, and so on). The inventory information collected can assist users in determining archive policies. • Use the Backup remote data management tool to schedule a job to back up data from remote hosts to a central host with locally-attached storage. • Use the Restore remote data management tool to schedule a job to restore backup data from a central storage location, on a per host basis, to the remote hosts from which the data was originally retrieved. • Use the Archive remote data management tool to schedule a job to archive files that satisfy a user-defined set of criteria. How This Guide is Organized This document provides information and procedures describing the use of the Snap Enterprise Data Replicator (EDR) Management Console to perform the following tasks: • Configure, schedule, and monitor the Distribute, Aggregate and Replicate data management tools • Generate reports on data transfer activities • Change the user password, set the time zone, and perform Management Console maintenance tasks including viewing and trimming the database logs • Configure user rights, e-mail alerts, and agent administration All of the procedures in this document also apply to Snap EDR Express, except for the procedures that describe how to use the Distribute and Aggregate data management tools. These tools are not available with Snap EDR Express. For information on the tools associated with Snap EDR Advanced, see the Snap EDR Advanced Data Management Suite Guide. This document is intended for experienced information technology (IT) personnel. The information in this guide is divided into the following sections: • The Preface describes the Snap EDR Administrator Guide, other sources of information, and the basic architecture of the software. vi Administrator Guide Product Architecture • Management Console Installation and Configuration describes how to install the Snap EDR Management Console component. • Agent Administration provides information on how to install and uninstall an agent on the GuardianOS, Windows, UNIX and Linux. It also discusses how to revoke an agent’s certificate. (Note that with Snap EDR Express, agents are available only on GuardianOS.) • Data Management Tools provides information for scheduling aggregate, distribute and replicate data transfer jobs. (Note that the Aggregate and Distribute tools do not apply to Snap EDR Express.) • Monitoring Jobs provides information on editing and copying jobs, viewing log files and other ways that users can monitor the status of data management jobs. • Reporting provides information on how to generate reports on the data management system. • Maintenance provides information on viewing and trimming database logs. • Exit Codes provides troubleshooting information and potential resolutions for exit codes generated during data replication or migration tasks. Product Architecture The following diagram is an example of the Snap EDR system. Work Station with GUI interface 650 ...1001011101010110... 0... 011 101 10 11 ...1 00 101 110 101 011 0... ... ...1 00 10 11 10 10 10 11 0 ... Windows Clients UNIX 01 11 010 101 520 10... ... 10 10 10 10 01 10 11 00 01 01 10... 01 0100 11 0101 00 0111 01 1100 ...0 1100 1010 ...101 ...01010110110001110101110101010... ...11 0100 1000 1110 1010 0100 1100 1100 ... 10 01 01 01 11 01 10... 0101 1 00 1101 0101 ...10 ...1 1 00 ...1 ...1001011101010110... ...10 01 0 410 Misc. Clients The Snap EDR consists of a Management Console and a collection of Agents. vii Licensing Information The Management Console is installed on a central Snap Server and coordinates and logs the data transfer activities carried out by the distributed Agents. An Agent is also installed on the Management Console host. The Agents are responsible for the actual transfer of data. Snap EDR Express supports replication between only two GuardianOS Snap Servers, one of which is the Agent installed by default on the Management Console. Licensing Information Snap EDR installs with a 45-day trial period, after which it is necessary to obtain a license key from http://www.snapserver.com/Products/EDR.shtml (or through your Snap Server distributor) to continue use of Snap EDR’s functionality. There are three licenses you can choose to purchase: • Snap EDR Express allows only replication between two GuardianOS Snap servers, one of which is the Agent installed by default on the Management Console. This product does not include the Aggregate or Distribute tools. • Snap EDR includes the Aggregate, Distribute and Replicate tools, licensed for a specific number of agents on Windows, Unix/Linux or GuardianOS. • Snap EDR Advanced Data Management Suite includes all the features of Snap EDR, with the addition of the Inventory, Archive, Backup and Restore tools. Other Information Sources For more information about installing Snap EDR on a Snap Server, see the following document: • Snap Enterprise Data Replicator (Snap EDR) Quick Start Guide includes software installation procedures and information about system requirements and installation options. For more information on Snap EDR Advanced, refer to the Snap EDR Advanced Data Management Suite Guide. In addition, online help is available when you are working within the Management Console by clicking the help icon (?) in the user interface. viii Administrator Guide Technical Support Technical Support To obtain additional service or technical support for your Snap Server, call the following numbers or visit http://www.snapserver.com/support/. North America: Monday - Friday (except holidays) 3:00 AM - 5:00 PM U.S. Pacific Time 408-934-7274 or 321-207-2000 Asia: +65 62457478 Australia: +61 2 9503 1555 Europe English language: Monday - Friday (except holidays) 10:00 - 18:00 CET +49-89-43 66 55 44 French language: Monday - Friday (except holidays) 9:00 - 17:00 CET +49-89-43 66 55 33 German language: Monday - Friday (except holidays) 9:00 - 17:00 CET +49-89-43 66 55 22 ix Technical Support x Administrator Guide Chapter 1 Management Console Installation and Configuration Installing and configuring the Snap EDR Management Console involves the procedures outlined in this section. Installing and Configuring the Snap EDR Management Console You should install only one Management Console to handle all of the Agents in your Snap EDR system. 1 Connect to the browser-based Administration Tool for the Snap Server, logging in as the administrator. 2 Navigate to the Maintenance->OS Update screen (known as Update in releases prior to GuardianOS v4.0). 3 Use the Browse button to select the upgrade file SnapEDR.gsu. You can find this file on the Snap EDR CD located in the Guardian_OS subdirectory, or you can obtain the latest upgrade file from http://www.snapserver.com/support/. 4 Click the Update button. 5 Once the update is applied, you will be prompted to reboot the server. Click Reboot to complete the installation process. 6 After the system has rebooted, connect to the browser-based Administration Tool for the Snap Server, logging in as the administrator. 7 For users running GuardianOS v4.0 or higher, click on the SnapExtensions icon in the upper right hand corner of any page. For any release prior to GuardianOS v4.0, navigate to the Maintenance->Add-on Features screen. Administrator Guide 1 Logging Into the Management Console 8 Click on the Snap EDR Configuration option and then click on the Configure as the Management Console button to configure Snap EDR. Once the configuration is complete, a screen appears with a number of options, as described in the following table: Button Description Stop Service Stops all Snap EDR services. Restart Service Restarts all Snap EDR services. Warning: Use only if you have encountered a problem, and customer support advises you to restart the service. Any jobs currently running will stop and will not resume when you restart the service. Disable Service on By default, when a user reboots the Snap Server, services System Boot automatically restart. Select Disable Service on System Boot if you do not want the Snap EDR service to start-up upon reboot. Note that the Enable Service on System Boot option appears when the disable service option is selected. This allows users to turn on the enable option. Uninstall Service Removes all of the components of the Snap EDR service. Click Here to configure jobs Clicking on this link opens the Management Console UI where users can schedule the Aggregate, Distribute and Replicate jobs. Logging Into the Management Console The first time you connect to the Management Console, you use the default username snap and password snap (all lowercase). After connecting for the first time, you should change the password. For information on how to do this, refer to “Changing the User Password” on page 5. 2 Administrator Guide Management Console Overview To connect to the Management Console: 1 Connect to the browser-based Administration Tool for the Snap Server, logging in as the administrator. 2 For Users running GuardianOS v4.0 or higher, click on the SnapExtensions icon in the upper right hand corner of any page. For all other users, navigate to the Maintenance > Add-on Features screen. 3 Click Snap EDR Console. 4 In the Login screen, enter the username snap and password snap (all lowercase) and click Login. 5 Change the user password. Management Console Overview The web-based Management Console enables users to manage the rules that govern data transfer activity, and deploy the Agent software on UNIX, Linux, and Windows platforms. (Note that with Snap EDR Express, you can deploy the Agent software only on two GuardianOS Agents, one of which is the Agent installed by default on the Management Console. Also, the Distribute and Aggregate tools do not appear in the Management Console interface, as only the Replicate tool is available with Snap EDR Express.) Management Console Chapter 1 Management Console Installation and Configuration 3 Importing Data Management Tools By navigating menus and sub-menus, the Console displays the features and functions administrators utilize to create an automated data transfer system. The following table lists the menus that appear in the Console. Menu Description Jobs Displays the Aggregate, Distribute and Replicate job data management tools. Also displays the Reports menu that allows users to create various reports on the system. (Aggregate and Distribute do not appear with Snap EDR Express.) Agent Administration Displays a list of Snap EDR Agents. Allows users to install Agents on Windows, UNIX, and Linux platforms. (Does not apply to Snap EDR Express.) Manager Administration Allows users to license Agents, run Management Console log maintenance jobs, view transfer logs and add customized tools. Preferences Allows users to change their user password, set the time zone and change user properties. Importing Data Management Tools Snap EDR gives you the ability to import pre-designed data transfer tools. These solutions may exit on CD or another computer. Before you can use the solution, you must ensure that it is located on a computer to which you have access, and you must import it into the Snap EDR database. To import a solution, follow these steps: 1 Obtain the solution. 2 Logon to the Management Console. 3 Expand the Manager Administration menu, and click Add Solution. 4 Use the browse button to navigate directories and select the desired file. 5 Click Install/Upgrade Solution. The results of the import appear. 6 Repeat for each solution you want to import. Management Console Preferences Users can configure a number of items related to the appearance and use of the Management Console, including the following: • changing the user password • setting the time zone • changing user properties 4 Administrator Guide Changing the User Password Changing the User Password To change your user password: 1 Expand the Preferences menu and click Change Password. 2 In the Current Password field, type your current password. 3 Type the new password in the New Password and Confirm New Password fields. The password must be at least 6 characters long. 4 Click Change. Setting the Time Zone You may want to change the time zone display to reflect the time zone in which you are working. Setting the time zone in the Management Console changes it only in the pages displayed in the Management Console. It does not change the time zone of the Management Console host (the default of which is the time zone of the host on which the Management Console component is installed). The times displayed in the Management Console are generated as an offset of Greenwich Mean Time (GMT)/Universal Time Code (UTC). To set the time zone: 1 Expand the Preferences menu and click Set Time Zone. 2 In the table, click on the desired Time Zone ID. Note To position the screen at the desired time zone, you can also select a value from the “Jump to Time Zones Relative to GMT/UTC” drop-down list and choose a value. This list displays values that are offsets of GMT/UTC (such as 5 hours west, 13 hours east, etc.) The screen will scroll to the time zone that meets the selected criteria. Chapter 1 Management Console Installation and Configuration 5 Changing User Properties Changing User Properties The properties area allows you to change user information such as the first and last name, e-mail address, title, phone, fax or cell number. To change any of this user information: 1 Expand the Preferences menu and click Properties. 2 Change the information you want to change by typing in the appropriate fields. The first name, last name and e-mail address fields are required. 3 Click Apply. 6 Administrator Guide Chapter 2 Agent Administration Agent administration involves the following tasks: • “Installing Snap EDR Agents” on page 8 • “Installing the Agent Software on Windows-Based Systems” on page 10 • “Installing the Agent Software on UNIX or Linux Systems” on page 11 • “Revoking an Agent’s Certificate” on page 13 • “Uninstalling Agents” on page 15 • “Configuring User Accounts for the Windows Agent Service” on page 18 This chapter describes how to install a Snap EDR Agent on GuardianOS, Windows, UNIX, and Linux. How to revoke an Agent’s certificate and uninstall an Agent are also described. NOTE: With Snap EDR Express, you can install only two Agents, one of which is the Agent installed by default on the Management Console, and only on the GuardianOS (see “Installing Snap EDR Agents” on page 8). If you turn on "NETWORK SETTINGS - WEB - REQUIRE WEB VIEW AUTHENTICATION" on the machine with the Snap EDR Management console, Snap EDR will NOT work and you will receive a 401 Authentication error. This chapter concludes with important notes on the installation and requirements of Snap EDR. Administrator Guide 7 Installing Snap EDR Agents Installing Snap EDR Agents Before installing an Agent, check your system to see if it meets the system requirements for Windows, UNIX/Linux Agents: Item Description Operating System AIX 4.3, 5.1, 5.2 Solaris 5.7, 5.8 HP-UX 11.x, 11i RedHat Linux 7.2/7.3, Enterprise Linux 2.1 or 3.0 or SUSE LINUX 8.2 and 9.0 Windows 2000 (with SP2 or higher), Windows Server Appliance Kit (SAK) 2.01, or Windows XP System Memory 128 MB or more Disk Space Windows systems: 5 MB or more UNIX systems: 5 MB or more Installation directory: 100 MB, 20MB free in /tmp on all platforms Network Connection 100 Mbit/sec. Ethernet or faster To install a Snap EDR Agent on a Snap Server: 8 1 Connect to the browser-based Administration Tool for the Snap Server, logging in as the administrator. 2 Navigate to the Maintenance->OS Update screen (known as Update in releases prior to GuardianOS v4.0). 3 Use the Browse button to select the upgrade file SnapEDR.gsu. You can find this file on the Snap EDR CD located in the Guardian_OS subdirectory, or you can obtain the latest upgrade file from http://www.snapserver.com/ support/. 4 Click the Update button. 5 Once the update is applied, you will be prompted to reboot the server. Click Reboot to complete the installation process. 6 For Users running GuardianOS v4.0 or higher, click on the SnapExtensions icon in the upper right hand corner of any page. For all other users, navigate to the Maintenance > Add-on Features screen. 7 Click Snap EDR Configuration. Administrator Guide Downloading the Snap EDR Agent Information File 8 Type the Name or IP address of the Management Console in the Name/IP of Management Console field. Note that the name of the Management Console must be resolvable from the Agent. 9 Click Configure as an Agent. Once the configuration is complete, a screen appears with a number of options, as described in the following table: Button Description Stop Service Stops all replicator services Restart Service Restarts all Snap EDR services. Warning: Use only if you have encountered a problem, and customer support advises you to restart the service. Any jobs currently running will stop and will not resume when you restart the service. Disable Service on System Boot By default, when a user reboots the Snap Server, services automatically restart. Select Disable Service on System Boot if you do not want the Snap EDR service to start-up upon reboot. Note that when the disable service option is selected, the Enable Service on System Boot option appears, allowing users to turn on the disabled option. Uninstall Service Removes all the components of the Snap EDR Agent. Downloading the Snap EDR Agent Information File NOTE: This procedure does not apply to Snap EDR Express, or installing an agent on the GuardianOS. Before installing an Agent on Windows, Linux or UNIX, you must first download the Snap EDR Agent Information file (called sigsetup.inf). The following procedure describes how to do this. Also before installing an Agent, check the table in “Installing Snap EDR Agents” on page 8 for the system requirements for Windows and UNIX/Linux Agents. To download the Snap EDR Agent installation information file to a Windows or UNIX/Linux environment: 1 From the computer on which you want to install the agent, log into the Management Console. 2 In the Agent Administration menu, click Install. 3 Click the Click here... link. 4 Choose Save Target As... Chapter 2 Agent Administration 9 Installing the Agent Software on Windows-Based Systems 5 Follow the instructions in the dialog to download the information file to your Agent software directory (for example: /tmp/snapagent for UNIX/Linux-based hosts or C:\temp\snapagent for Windows-based hosts). 6 Insert the Snap EDR CD in the CD-ROM drive. 7 Navigate to the installation file for your operating system using the ReadMeFirst.html file on the CD. 8 Select the installation file appropriate to your operating system. 9 Follow the instructions in the dialog to download the setup program to the same Agent software directory you used earlier for the installation information file (for example: /tmp/snapagent for UNIX/Linux-based hosts or C:\temp\snapagent for Windows-based hosts). See the Windows and UNIX/Linux installation procedures in the following sections: “Installing the Agent Software on Windows-Based Systems” on page 10 and “Installing the Agent Software on UNIX or Linux Systems” on page 11. Note If your browser opens the information file instead of displaying the dialog, navigate back to the Installation Downloads page, right-click Click here and then save the file in your Agent software directory. You must place the installation information file and the setup software in the same directory. Installing the Agent Software on Windows-Based Systems NOTE: This installation does not apply to Snap EDR Express. Prerequisites • Make sure that the host system has a valid fully qualified domain name, system time and date, and time zone. The date, time, and time zone MUST be accurate before installing the Agent. The digital certificates for the Agents use the fully qualified host name and have their certificate validity period determined by time and date. • Hosts using the Agent software should have IP addresses that do not change (for example: statically assigned IP addresses, or DHCP address reservations). In general, changes to IP addresses require reconfiguration of the Agents. • You must have already installed and configured the Snap EDR Management Console on a Snap Server. • Make sure you have downloaded the Snap EDR Agent Installation Information file, as described in “Downloading the Snap EDR Agent Information File” on page 9. 10 Administrator Guide Installing the Agent Software on UNIX or Linux Systems Installation Procedure To install the Agent software on Windows: 1 Login to your system as Administrator or as a user with equivalent administration privileges. 2 Insert the Snap EDR CD into the host workstation or download the Agent installer from the Snap Server Web site. 3 On the CD or in the folder where you downloaded the Agent software and installation configuration file (for example: C:\temp\snapagent), double-click the downloaded executable file (for example: sig_client_x86-wnt.exe). The Welcome to Snap Enterprise Data Replicator screen appears. 4 Fill in the information on the screens, using Back and Next to move through the setup program screens. You need to click in the Accept radio button to accept the license agreement. If the setup program does not find the sigsetup.inf file in the installation directory, you are prompted to specify its location. The Agent connects to the Management Console to request a digitally-signed certificate. 5 To exit the setup program, click Finish. Installing the Agent Software on UNIX or Linux Systems NOTE: This installation does not apply to Snap EDR Express. Before proceeding with a UNIX or Linux installation, make sure that your system has a valid fully qualified host name, system time and date, and time zone. The date, time, and time zone MUST be accurate before installing the Agent. The digital certificates for the Agents use the fully qualified host name and have their certificate validity period determined by time and date. You must have already installed and configured the Snap EDR Management Console on a Snap Server as well. Make sure you have downloaded the Snap EDR Agent Installation Information file as described in “Downloading the Snap EDR Agent Information File” on page 9. The setup program installs the Agent software using native packaging systems such as pkgadd on Solaris systems, swinstall on HP systems, installp on AIX and RPM (RedHat Package Manager) on Linux systems. Chapter 2 Agent Administration 11 Verify that the Agent is Properly Configured To install the Agent software on UNIX or Linux: 1 Login to your host system as a user with root privileges (for example: root). 2 Insert the Snap EDR CD into the host workstation or download the Agent installer from the Snap Server Web site. 3 Change directories to the CD and open the ReadMeFirst.html file appropriate for your OS or navigate to the location where the Agent software was downloaded. For example, % cd /tmp/snapagent 4 Uncompress the downloaded file. For example, % uncompress sig_client_i686-linux.tar.Z 5 Untar the downloaded file. For example, tar -xvf sig_client_i686-linux.tar 6 Run the program using the following command syntax: ./sigsetup The Welcome to Snap Enterprise Data Replicator Setup screen appears. Follow the instructions in the setup program screens to select installation options, and navigate through the program screens by typing N (next). You need to click in the Accept radio button to accept the license agreement. If the setup program does not find the sigsetup.inf file in the installation directory, you are prompted to specify its location. The setup program completes the certificate generation process. 7 You can view any installation errors in the Agent installer log file (/tmp/ sigsetup.log). 8 Type Y to see the Read Me file, or type N to exit the setup program. Verify that the Agent is Properly Configured To verify that the Agent is properly configured, run a simple replication job of a small set of data. For information on how to run a replication job, see “Creating a Replicate Job” on page 31. Note that you need to have at least two Agents installed to run a replication job. 12 Administrator Guide Unsuccessful Agent Installation Unsuccessful Agent Installation In some instances, the Agent installation might fail. The following table describes why an agent installation might have failed, and possible resolutions to the problem : Problem Resolution An agent may have already been installed and then uninstalled without having the certificate revoked before re-installation. Revoke the certificate for the host and rerun the installation. Proceed to the next section for instructions on revoking the certificate. The host may not have connectivity to the network. Correct connectivity problem and rerun the installation. The Management Console may not be reachable from the host (due to routing problems, physical problem, the fact that the Management Console is down). Since the Management Console coordinates and logs the transfer activities carried out by the distributed Agents, a Snap EDR Agent must be able to connect to the Management Console. Correct reachability problem and rerun the installation. There may be insufficient drive space on the Correct the drive space problem and rerun host for the installation files. the installation. Note If an Agent installation fails, the installer will generate a .req.pem file, and save it to the dds/security directory. This file can be deleted as it is not used by Snap EDR after an installation failure. Revoking an Agent’s Certificate The Snap EDR Management Console issues a digital certificate when you install the Agent software. Snap EDR uses the digital certificate for the identification and creation of secure communication channels among the data transfer Agents and the Management Console. You need to revoke an Agent’s certificate when you delete an Agent, otherwise it will not be possible to reinstall the same Agent should you wish to in the future. If you delete an Agent without revoking its certificate and then attempt to reinstall the Agent, an error message appears that indicates the Agent already has a valid certificate. Receipt of the certificate is part of the configuration of the Agent during the installation; when an unrevoked certificate exists, the Management Console generates the error message and does not send a certificate to the installer. With no certificate received during the installation, the Agent cannot be properly configured and is not recognized by the Management Console as part of the Snap EDR system. Revoking an Agent's certificate does not remove the Agent software from the Agent, since these are two separate procedures. For information on uninstalling the Agent software, see “Uninstalling an Agent from a Snap Server” on page 15, Chapter 2 Agent Administration 13 Revoking an Agent’s Certificate “Uninstalling an Agent from Windows” on page 15 or “Uninstalling an Agent from UNIX or Linux” on page 16. Once you revoke an Agent's certificate, the only way the Agent can take part in transfers again is to re-install the Agent. To revoke an Agent's certificate: 1 Expand the Agent Administration menu, and click Revoke Certificate. A list of Agents to which the user has access appears. 2 In the display area, click the Agent whose certificate you want to revoke. 3 Make sure a check appears in the Remove Agent from database box if you want to permanently delete the Agent from the system. Leaving the box unchecked means that the Agent is still identified in the database (and any jobs with which it is associated). Make sure you uncheck the box if you are planning to reinstall the same Agent (for example, your Agent machine had a technical problem and needed to have Snap EDR reinstalled). Keeping the Agent in the database while you reinstall the Snap EDR Agent software on it means that the Agent will still appear in any jobs in which it is involved. If you delete the Agent from the database, it will also be removed from any jobs with which it is associated. You would then have to manually add the re-installed Agent to all the jobs with which you want it associated. However, if you are not planning to re-install the Agent you are deleting, you may want to remove it from the database. If you do not delete it from the database, it will be included in the Agent counts when evaluating license keys. License keys specify how many Snap EDR Agents you can have in your Snap EDR installation. If the deleted Agent still appears in the database, then you will be unable to install a new agent to take its place (since the Management Console believes the agent still exists and that you have installed your Agent quota as specified in the license key). 4 Click Revoke Certificate. Revoking an Agent’s certificate adds the Agent to a list of revoked certificates that Agents check periodically for security, to ensure that a user does not install more Agents on the system than are allowed by the product license. 14 Administrator Guide Uninstalling Agents Uninstalling Agents Either before or after uninstalling an Agent, you must revoke the Agent’s certificate. If you do not revoke the Agent’s certificate, you will be unable to reinstall the agent at a future date, since the Management Console believes the agent still has a valid certificate. For more information on revoking an Agent certificate, see “Revoking an Agent’s Certificate” on page 13. Uninstalling an Agent from a Snap Server To uninstall a Snap EDR Agent: 1 Connect to the browser-based Administration Tool for the Snap Server, logging in as the administrator. 2 For Users running GuardianOS v4.0 or higher, click on the SnapExtensions icon in the upper right hand corner of any page. For all other users, navigate to the Maintenance > Add-on Features screen. 3 Click Snap EDR Configuration. 4 Click Uninstall Service. A prompt appears to confirm the uninstall. 5 Click OK. Note that the uninstall removes all of the components associated with the software, including the configuration screen. Therefore you will not see an OK or successful uninstallation message screen once the uninstall completes. 6 Once the uninstall is complete, close the window. Uninstalling an Agent from Windows To uninstall the Agent from Windows: 1 Choose Start > Settings > Control Panel. 2 Choose Add/Remove Programs. 3 Locate the Snap Enterprise Data Replicator entry in the list, and click on it. 4 Click Change/Remove. 5 In the Welcome screen, click Next. 6 In the Software Detected screen, click the Uninstall button and click Next. 7 In the Uninstallation Complete screen, click Finish. 8 Close the Add/Remove Programs screen. Chapter 2 Agent Administration 15 Configuration Notes Uninstalling an Agent from UNIX or Linux To uninstall the Agent from a UNIX or Linux system: 1 Login as root. 2 Change directories to where the Agent software is installed. For example, /usr/snap/dds/bin 3 Type ./siguninstall. The uninstall opening screen appears. 4 Type N (for next). The Uninstall program searches for installed packages. 5 Select the packages you want to uninstall (in this case, the Agent) and type N. 6 Verify the directories associated with the Agent software and type N. The summary screen appears. 7 Confirm the information and type N. A prompt appears to confirm that you want to uninstall. 8 Type Y (for yes). Eventually a message appears that the uninstall is complete. 9 Press Enter. (A message appears that the uninstallation is running a cleanup.) 10 Press any key to finish the uninstall and return to the shell. Configuration Notes IT personnel charged with administering data replication and migration tasks with Snap EDR must consider the following information. Note: DNS and name resolution: If there is no DNS in the customer’s network host files can be added on the Snap servers. Installation Location The Snap EDR Management Console will be installed on the Snap Server’s first available volume that has 100 MB of available space. The installed files are not 16 Administrator Guide Configuration Notes visible through the Administration Tool or shares on the volume. The installation path is defined by the installer and is not user configurable. Caution Installing Snap EDR on a Snap Server with no defined volumes will fill the root partition. Installation to the root will cause the GuardianOS to fail, requiring a reinstallation of the OS and data loss. Port Requirements The ports Snap EDR uses to route data traffic are 49221 and 443. To accomplish data replication or migration this port must be enabled along the network path required for the machines to properly transmit the data. MS Windows XP SP2 by default turns on Firewall. Installing an EDR Agent does not damage the firewall. you will need to manually add port 49221 through the firewall to communicate to Windows XP SP2 client. Re-Sync with Management Console Button In rare circumstances, a Management Console name or address change fails to propagate to the agents due to network or server outages. The Re-Sync with Management Console option resynchronizes the Agent with the Management Console and all other Agents associated with the Management Console’s IP address. The Re-Sync option is needed when the Management Console can no longer communicate with an Agent after a name change. This option can be found on the Snap EDR agent post-configuration screen. Certificate Validity Inconsistent Between Management Console and Agents By default, the Snap EDR installation provides a certificate that is valid for one year for the Management Console and two years for the Agents. Warning Messages Some warning messages that appear in the Maintenance Logs may also contain the word “error”. These messages are simply warnings and do not indicate that an error has occurred. Due to formatting issues, some errors do not appear in the Event Log. Volume Deletion You cannot delete a volume on which Snap EDR has been installed via the GuardianOS Administration Tool. The GuardianOS will display an error that the volume cannot be unmounted. You must uninstall Snap EDR from a volume prior to deleting it. Chapter 2 Agent Administration 17 Configuration Notes Snapshot Rollback Rolling-back to a snapshot of a volume that contains the Snap EDR installation can cause unexpected behavior of the rollback operation and the proper functionality of Snap EDR. When restoring data from a snapshot, ensure that only the files are moved back onto the volume. Configuring User Accounts for the Windows Agent Service The Snap EDR agent on Windows platforms normally runs with the identity of a local system account (“NT AUTHORITY\SYSTEM”) so users don’t need to provide a username and password for the agent to access files and locations. However, under some circumstances, when the agent needs to access network locations on other servers (including Snap Servers), the local system account is not considered a valid user by the other servers. In these situations, you may receive a Source Initialization failure: “The share directory specified...cannot be accessed from Source.” This problem can be encountered when specifying the target (a Snap Server) in an Archive Shortcut Solution job, or when using a manually-entered UNC Target path for other types of Snap EDR functions. This is typically limited to Active Directory environments (due to Kerberos authentication), and you will usually not see this problem when the Target is running in Workgroup mode, or when using an IP address (\\ip\sharename) in a manually-entered UNC path (which skips Kerberos in favor of NTLM). As a best practice, you should create a user account to be used specifically for Snap EDR on the Active Directory domain and add it to the Domain Admins group (for example, SnapEDRUser). Then, after the Snap EDR Agent is installed, you can configure the agent service to use this account instead of the system account: 18 1 Open the Services control panel by selecting Start > Settings > Control Panel > Administrative Tools > Services. 2 Scroll down to “Snap Enterprise Data Replicator Process Control Service” and double-click it. 3 In the Properties window, select the Log On tab. 4 Change the “Log on as” radio button to “This account,” and enter the username and password of the EDR-specific domain user account. Administrator Guide Chapter 3 Data Management Tools Snap EDR includes three Data Management Tools to automate the secure flow of data between systems: • The Aggregate data management tool allows you to schedule a job to transfer files from multiple hosts to a single target host, and to store the files on a local disk • The Distribute data management tool allows you to schedule a job where files are transferred from one source machine to one or more target machines • The Replicate data management tool allows you to schedule a job to transfer files between two systems This chapter provides detailed descriptions of each of the data management tools and procedures for creating jobs using them. Snap EDR Express includes only the Replicate data management tool. For information on this tool, see “Replicate Data Management Tool” on page 30. Aggregate Data Management Tool Note This tool is not available for Snap EDR Express. The Aggregate data management tool retrieves files from multiple source Agents to a single target Agent, and stores the files on the target’s local disk or device. The files transferred from the source Agents may be stored on a per Agent basis, or in a single flat namespace on the target Agent’s storage device (either local disk or NAS). This is referred to as a “Pull” file transfer. Default Functionality The Aggregate data management tool has the following default functionality: • File transfer from one or many Agents to single source Agent • Cross platform support (transfers can go from one or more Snap, Windows or UNIX/Linux Agents to a single Snap, Windows or UNIX/Linux Agent) • Store files from source Agents in a single flat namespace, or in a separate namespace on a per source Agent basis • Option to exclude files from the transfer • Option to exclude directories Administrator Guide 19 Aggregate Data Management Tool • Option to remove files transferred from source Agents after sending to the target Agent Users can set information in the following categories: • Source Agent selection • Target Agent selection • Directory and file selection • File transfer options (such as file compression, certified delivery, source and target synchronization, etc.) • Schedule • E-mail notification Creating an Aggregate Job To schedule an Aggregate job: 1 Expand the Jobs menu and click Aggregate. 2 Click Add a Job. If this is the first time you are creating an aggregate job, when you click Aggregate, the scheduling screen appears. You do not have to click Add a Job. 20 Administrator Guide Aggregate Data Management Tool 3 Enter information into the various fields. The following table describes the fields: Field Description Job Name A unique name for this job run. Source Agent(s) Selection Source Agent(s) The Agent(s) from which you are transferring the data. Press shift +click to select multiple consecutive agents or ctrl +click to select multiple non-consecutive Agents. Note that when using multiple sources, they must all be running the same operating system, since the source directory specified in the Source Directory field must exist on all the agents. Directory and File Options Source Directory The directory from which you want to transfer the files. This field is mandatory. The source directory specified may be in the following formats: • Snap Server shares, e.g., /shares/SHARE1 • Windows root drives, e.g., C:\ApplicationData • UNIX root drives, e.g., /home • Windows UNC names, e.g., \\machine1\applicationdata Example entry:e:\databasefiles Use the Browse button to select directories. Click through to the desired directory and click choose this directory. Leave the field empty to use the default Agent directory. Note that when using multiple sources, they must all be running the same operating system, since the source directory specified in the Source Directory field must exist on all the agents. Exclude Sub Directories Allows you to specify sub-directories not to be included in the transfer. File Names/Types to Exclude Allows users to specify the types of files or names of files to exclude. Separate multiple files by commas. For example, if you type *.doc, *.ppt, in the field, these are the types of files that will be excluded. Chapter 3 Data Management Tools 21 Aggregate Data Management Tool Field Description Target Agent Selection Target Agent The Agent to which you are transferring the data. Target Directory Specifies the directory in which to store the data from the source Agents. This field is mandatory. If the directory does not exist it will be created. If specified in the Folder Per Source option (see below), data for each Agent specified is stored on a per Agent basis under this directory. Otherwise, data from all Agents are stored in this directory. The directory specified should be a fully qualified path name. The directory specified may be in the following formats: • Snap Server shares, e.g., /shares/SHARE1 • Windows root drives, e.g., C:\ApplicationData • UNIX root drives, e.g., /home • Windows UNC names, e.g., \\machine1\applicationdata Example entry:e:\remotebackups Use the Browse button to select directories. Click through to the desired directory and click choose this directory. Folder Per Source 4 When selected, a separate folder for each source Agent is created in the specified target directory. All data transferred from that Agent appears in that folder. Click Add Job. The new job appears in the list. 22 Administrator Guide Aggregate Data Management Tool The following table lists the common fields that appear in the Aggregate, Distribute and Replicate data management tools: Field Description File Transfer Options File Ownership Transfer Specifies whether files maintain the source user ID and group ownership after they are transferred, and what method is used. Choose from the following options to preserve ownership: GuardianOS - When transferring between two GuardianOS machines, Permissions are extracted and set using the GuardianOS routines. When transferring between Windows, UNIX, Linux, or GuardianOS, user name matching is always done for the owner and group regardless of the source and target OS type, and for Permissions if the source and target are both Windows. If no match is found, a warning is generated. Permissions without matches are dropped. Owners and groups without matches are replaced with the transfer user (root, system or UID 1). Inherited Permissions are not explicitly copied between Windows machines. For example, a file that inherits its Permissions from a folder on the source is transferred to a folder on the target that has different Permissions. However, the source folder is not transferred. In this case, the file's inherited Permissions on the target will come from the target folder into which it is transferred and not from the source folder. GuardianOS mode is the default mode of transfer. Windows - Preserves Windows SIDs in homogenous Windows environments. A security identifier (SID) is a unique value of variable length that is used to identify a security principal (e.g., user or security group) in Windows 2000. Well-known SIDs are a group of SIDs that identify generic users or generic groups - these do not change from system to system. In this mode, the security stream, and all other alternate data streams, are copied; inherited Permissions are explicitly copied. Use when transferring data between Windows hosts only. Unix - Tries to match the usernames/groupnames found on the source and target systems. Use when transferring between Windows and UNIX hosts. The file ownership transfer capability might not work on some UNIX systems such as HPUX 11 and Solaris 7 that use Orange Book security standards. Off - Do not preserve ownership. Files written to the target are owned by the user ID specified in the target User ID field of this job template. The file will be owned by root on UNIX, NT Authority/System on Windows and admin on GuardianOS. Chapter 3 Data Management Tools 23 Aggregate Data Management Tool Field Description Synchronize Source and Targets Specifies whether the Agent creates identical directory structures on the source and target nodes. If set to Yes, the Agent deletes any files in the target directory structure that do not have a corresponding file in the source directory structure, and transfers any files from the source that do not have a corresponding file in the target directory structure. The default value is No. This option is not available with the Aggregate tool. Transfer File Differences Only If set to Yes, only changed bytes of files will be transferred, not the entire file. Typically used in low bandwidth situations. Generally this feature provides maximum benefit in WAN data transfers where bandwidth is limited. Using this feature may increase CPU usage. Use Compression If set to Yes, the source Agent(s) compresses each file before sending it. The files will be uncompressed automatically on the target Agent(s). The degree of compression depends on the type of data you are transferring. The following are typical rates of compression for different types of data: Plain text: 70-95% TIFF images: 20-40% Binary files: 0-5% Generally this feature provides maximum benefit in WAN data transfers where bandwidth is limited. Using this feature may increase CPU usage. 24 Administrator Guide Aggregate Data Management Tool Field Description Delivery Mode The speed of a transfer can be affected by delivery options such as whether or not the delivery generates a list of files transferred or uses private keys to certify the delivery. Normally, when writing a file on the target, the Agent creates a work file in the destination directory, and renames it to the real target file name after all of the data has been successfully received and written to disk. This methodology ensures that the original file on the target (if any) is not destroyed by the transfer, and that the newly transferred file does not appear with the real name in a partially transferred state. Users can choose from the following delivery options depending on their requirements: Fast - This mode suppresses the renaming of the target work file. When this option is selected, no work file is used on the target, instead the new data causes the original file to be emptied, and the file is incomplete until all of the data has been received. For small files this can boost the performance by as much as 40% over the ‘normal’ mode. Normal - This mode creates a work file in the destination directory and renames it to the real target file name after all of the data has been successfully received and written to disk. This is the default mode. Log File Name - Creates a list of the files transferred, but does not certify them. Certify File Content - The source and target Agents use their private keys to sign hashes separately for each file they transfer. (A hash is an algorithm that creates a message digest for authentication.) Comparing these hashes determines whether the file transfers complete with no change to the data. Once a job template with this option runs, the log server creates a certified delivery log file on the Management Console, in the delivery_logs subdirectory of the Management Console log directory. Action If “File In Use” Allows users to specify whether a file that is in use during a transfer is skipped or generates an error message. If “Error” is selected, and a file is in use during the transfer, the transfer fails and generates an error. If “Skip” is selected, and a file is in use during the transfer, the transfer continues, skipping the file. Generating an Error message in no way affects or modifies the file. This option is not available with the Replicate solution. Chapter 3 Data Management Tools 25 Aggregate Data Management Tool Field Description Job Options Bandwidth Throttle Limit this job to the amount of bandwidth specified. You set this limit in bytes, kilobytes or megabytes per second to a maximum of whatever the CPU can handle, or a percentage of a selected network connection (for example, 75% of 128 Kbps). Note that bandwidth limiting is done on each stream connection, so a value specified here is passed to the controlling Agent for each job that runs, and divided among the streams as follows: 1 It is divided by the number of streams the Agent will use for each remote Agent (typically four). 2 It is further divided by the potential number of concurrent remote Agents. This will be the lesser of the maximum allowed number of concurrent Agents, and the number of remote Agents specified in the job. Encryption Level Allows users to specify the encryption level from the following values: High, Medium, Low or No Encryption. Job Log Detail Level The type of logging information for this job. Choose from Error, Warn (warning), Info (Information) or Debug. Debug provides the greatest level of detail while Error provides the least. Scheduling Parameters Job Start Date/ Time The date and time at which you want the job to run. Frequency 26 None Use none when you have a job that needs to be scheduled, but is run only at irregular, user-defined times. Hourly, Daily, Weekly Monthly, Yearly Run the job once every selected interval. Monthend Run the job once every last day of the month. Once Run the job only once at start time. Every x interval Run the job every x interval, the first of which is the “start job at” time. Intervals may be minutes, hours, days, weeks, months or years. X of the month Run the job on a certain day every month. Administrator Guide Distribute Data Management Tool Field Description Time Zone Specifies the time zone in which the displayed times are set in the job. For example, if a user in an Eastern Time zone specifies a start time of 9:00 am and a time zone of PST, the job runs at 9:00 am Pacific Standard Time or noon Eastern Standard Time. Clicking the Change button displays the time zone selection screen. Email Notification Email Notification To The e-mail address of the person who you want to receive the logging report. Separate multiple addresses with a comma. Email Subject Text that appears in the subject field of the e-mail notification message. Distribute Data Management Tool Note This tool is not available for Snap EDR Express. The Distribute data management tool allows users to schedule a job where files are transferred from one source machine to one or more target machines. As an example, the target Agent can start up to four independent TCP streams (i.e., up to four files will be transferred simultaneously). During a data transfer, the target Agent indicates that it is receiving data by the presence of #work#{filename} and #check#{filename} files. These represent a file that is partially received, and a file and the checkpoint data for an incoming file respectively. In the case of an incremental data transfer, the target Agent generates checksum information for the file. (A checksum is a numeric value used to verify the integrity of a block of data.) The target Agent sends this checksum information back to the source. When byte level differences are encountered, the source begins sending the differences to the target and the target starts creating a new file by making a copy of the “older” file and applying the byte level differences. Default Functionality The Distribute data management tool has the following default functionality: • File transfer from one source to one or many target Agents • Cross platform support • Option to exclude files from transfer • Option to exclude directories from transfer Chapter 3 Data Management Tools 27 Distribute Data Management Tool By default, any files which are in use during the transfer will be skipped without error. This allows users to transfer common files from a central repository. Users can set information in the following categories: • Source Agent selection • Target Agent selection • Directory and file selection • File transfer options (such as file compression, certified delivery, source and target synchronization, etc.) • Schedule • E-mail notification Creating a Distribute Job To schedule a Distribute job: 1 Expand the Jobs menu and click Distribute. 2 Click Add a Job. If this is the first time you are creating a distribute job, when you click Distribute, the scheduling screen appears. You do not have to click Add a Job. 3 Enter information into the various fields. The following table describes the fields: Field Description Job Name A unique name for this job run. Source Agent Selection Source Agent The Agent from which you want to transfer the files. Source Directory The directory from which you want to transfer files. This field is mandatory. The source directory specified may be in the following formats: • Snap Server shares, e.g., /shares/SHARE1 • Windows root drives, e.g., C:\ApplicationData • UNIX root drives, e.g., /home • Windows UNC names, e.g., \\machine1\applicationdata Example entry:e:\databasefiles Use the Browse button to select directories. Navigate to the desired directory and click choose this directory. 28 Administrator Guide Distribute Data Management Tool Field Description Directory and File Options Exclude Sub Directories Allows users to specify which sub-directories to exclude during the transfer. Separate multiple directories by a comma. File Names/Types to Exclude Allows users to specify which files are transferred by filtering on the names or types to exclude. Separate multiple filters by commas. For example, if you type *.doc, *.ppt, in the field, the transfer will not include files with the doc and power point extensions. However, *.txt files, for example, would be included. Target Agent(s) Selection Target Agent(s) The Agent(s) to which you want to transfer the files. Press shift +click to select multiple consecutive agents or ctrl +click to select multiple non-consecutive Agents. Note that when using multiple targets, they must all be running the same operating system, since the source directory specified in the Source Directory field must exist on all the agents. Target Directory Specifies the directory in which to store the data from the source Agent. This field is mandatory. If the directory does not exist it will be created. The directory specified should be a fully qualified path name. The directory specified may be in the following formats: • Snap Server shares, e.g., /shares/SHARE1 • Windows root drives, e.g., C:\ApplicationData • UNIX root drives, e.g., /home • Windows UNC names, e.g., \\machine1\applicationdata Example entry:e:\restorefiles Use the Browse button to select directories. Click through to the desired directory and click choose this directory. Leave the field empty to use the default Agent directory. Note that when using multiple targets, they must all be running the same operating system, since the source directory specified in the Source Directory field must exist on all the agents. For information on the fields in the File Transfer Options, Job Options, Scheduling Parameters and Email notification sections of the screen, see the table “File Transfer Options” on page 23. 4 Click Add Job. The new job appears in the list. Chapter 3 Data Management Tools 29 Replicate Data Management Tool Replicate Data Management Tool The Replicate data management tool allows users to schedule a simple one-to-one transfer where files are transferred from one source machine to one target machine. Default Functionality The Replicate data management tool has the following default functionality: • File transfer from one source to one target host • Cross platform support • Option to exclude files from transfer • Option to exclude directories from transfer • Option to synchronize target host directory structure with source host directory structure • Option to transfer changed bytes only, or entire file contents By default, any files which are in use during the transfer will be skipped without error. This allows users to transfer common files from a central repository. During a data transfer, the target Agent indicates that it is receiving data by the presence of #work#{filename} and #check#{filename} files. These represent a file that is partially received, and a file and the checkpoint data for an incoming file respectively. In the case of an incremental data transfer, the target Agent will generate checksum information for the file. (A checksum is a numeric value used to verify the integrity of a block of data.) The target Agent will send this checksum information back to the source. When byte level differences are encountered, the source will begin sending the differences to the target and the target will start creating a new file by making a copy of the “older” file and applying the byte level differences. Users can set information in the following categories: • Source host selection • Directory and file options • Target host selection • File transfer options • Job options • Scheduling parameters • E-mail notification 30 Administrator Guide Replicate Data Management Tool Creating a Replicate Job To schedule a Replicate job: 1 Expand the Jobs menu and click Replicate. 2 Click Add a Job. If this is the first time you are creating a replicate job, when you click Replicate, the scheduling screen appears. You do not have to click Add a Job. 3 Enter information into the various fields. The following table describes the fields: Field Description Job Name A unique name for this job run. Source Agent Selection Source Agent The Agent from which you want to transfer the files. Source Directory Directory from which you want to transfer files. This field is mandatory. The source directory specified may be in the following format: • Snap Server shares, e.g., /shares/SHARE1 • Windows root drives, e.g., C:\ApplicationData • UNIX root drives, e.g., /home • Windows UNC names, e.g., \\machine1\applicationdata Example entry:e:\databasefiles Use the Browse button to select directories. Click through to the desired directory and click choose this directory. Chapter 3 Data Management Tools 31 Monitoring, Editing and Copying Jobs Field Description Directory and File Options Exclude Sub Directories Allows users to specify which sub-directories to exclude during the transfer. Separate multiple directories by a comma. File Names/Types to Exclude Allows users to specify which files are transferred by filtering on the names or types to exclude. Separate multiple filters by commas. For example, if you type *.doc, *.ppt, in the field, the transfer will not include files with the doc and power point extensions. However, *.txt files, for example, would be included. Target Agent Selection Target Agent The Agent to which you want to transfer the files. Target Directory Specifies the directory to store the data from the source Agent. This field is mandatory. If the directory does not exist it will be created. The directory specified should be a fully qualified path name. The directory specified may be in the following formats: • Snap Server shares, e.g., /shares/SHARE1 • Windows root drives, e.g., C:\ApplicationData • UNIX root drives, e.g., /home • Windows UNC names, e.g., \\machine1\applicationdata Example entry:e:\restorefiles Use the Browse button to select directories. Click through to the desired directory and click choose this directory. Leave the field empty to use the default Agent directory. For information on the fields in the File Transfer Options, Job Options, Scheduling Parameters and Email notification sections of the screen, see the table “File Transfer Options” on page 23. 4 Click Add Job. The new job appears in the list. Monitoring, Editing and Copying Jobs Once you create an Aggregate, Distribute or Replicate job, there are a number of tasks you may want to perform on the job including viewing the job logs or editing and copying the job. For information on these topics, see “Monitoring Jobs” on page 33. 32 Administrator Guide Chapter 4 Monitoring Jobs Once you create Distribute, Aggregate and Replicate jobs, there are a number of tasks you can perform including the following: • “Editing a Job” on page 33 • “Copying a Job” on page 34 • “Deleting a Job” on page 34 • “Viewing the Job Log Files” on page 36 • “Filtering Log Information” on page 37 • “Downloading a Job Log File” on page 39 • “Manually Starting a Job” on page 40 • “Stopping a Running Job” on page 40 Editing a Job This procedure describes how to change information (such as the source directory or schedule) for a Distribute/Aggregate/Replicate job. To edit a Distribute/Aggregate/Replicate job: 1 Expand the Jobs menu and click Distribute/Aggregate/Replicate. 2 In the job list, click the name of the job you want to edit. 3 In the left menu, click Edit. Note Instead of clicking on the job name, you can click the word edit that appears beside the job name. 4 Change the information you want to edit and click Save. Administrator Guide 33 Copying a Job Copying a Job Copying a job allows you to use the copy as a template for creating a new job. To copy a Distribute/Aggregate/Replicate job: 1 Expand the Jobs menu and click Distribute/Aggregate/Replicate. 2 In the job list, click the name of the job you want to edit. 3 In the left menu, click Copy. 4 Change the information you wish to change to create a new job and click Save. Note that the job name becomes _copy (for example, Distribute_copy). You can change this name by typing in the Job Name field. Deleting a Job To delete a job: 1 Expand the Jobs menu and click Distribute/Aggregate/Replicate. 2 In the job list, click the name of the job you want to edit. 3 In the left menu, click Delete. Note Instead of clicking on the job name, you can click the word delete that appears beside the job name. 4 When the confirmation prompt appears, click OK. Viewing Job Statistics When you view a scheduled job's statistics, you see information such as the start and end time of the job and whether or not the job ran successfully. The Scheduled Job View screen also allows access to Console functions where other tasks can be performed with the scheduled job. These tasks include manually running a job and viewing past log files. 34 Administrator Guide Viewing Job Statistics To view statistics for a scheduled job: 1 Expand the Jobs menu and click Distribute/Aggregate/Replicate. 2 In the job list, click the name of the job whose statistics you want to view. The Job View appears. 3 In the display area, click More if you want to see extra information about the job including job description, who created the job and the number of successful or failed runs of the job. Click Less to view less information. A list of previous runs of the job also appears in the display area. To view the log file for any of the past job runs, click view beside the previous run whose log you want to see. Users can also download the file (see “Downloading a Job Log File” on page 39). Users can also click on the exit codes or the word Error (if it appears) for more information on the exit codes and errors that may have occurred. 4 In the actions area, click List All Jobs to return to the Job screen. Chapter 4 Monitoring Jobs 35 Viewing the Job Log Files Viewing the Job Log Files Whenever you run a scheduled job, the Management Console generates a log file. The display area shows log files for the most recent run and up to ten previous job runs. If there are more than ten job runs of the job, the oldest joblog is deleted to allow space for the newest job log. To view the most recent job log file: 1 Expand the Jobs menu and click Distribute/Aggregate/Replicate. 2 In the job list, click the name of the job whose log file you want to view. A list of runs appears, with the most recent run log first in the list. 3 Click view beside the run you want to look at. You can click Filter to change the type of log information that appears (see “Filtering Log Information” on page 37). Users can also download the file (see “Downloading a Job Log File” on page 39). Note Exit codes appear in the Exit Code column in the list of job runs. An exit code indicates whether or not a job completed successfully, and if there was an error, the type of error that occurred. A “0” exit code indicates the job completed successfully. For a description of what each non-zero exit code means, click more info beside the exit code in the Exit Code column of the job screen. A list of exit codes and their meaning appears in “Exit Codes” on page 67. 36 Administrator Guide Filtering Log Information Filtering Log Information Log files display a large amount of information. Users may choose to set parameters to display only certain types of information in the log file. The following is a sample log file: The following shows the filtering section of the log file screen: Chapter 4 Monitoring Jobs 37 Filtering Log Information The following table describes the fields on which users can filter: 38 Field Description Agent Prefix The initial letters of the hostname. Category Prefix The initial letters of the category name (e.g., Application, Network, Configuration). Job Template Name Prefix The initial letters of the job template name. Message ID A number associated with a text description in the message catalog. A user could filter on all of the messages with a specific ID number. Users can also excluded a specific message ID by typing ! and clicking Filter. (For example, !31015.) All the messages with that number will not appear in the display. Minimum Priority Filters on the priority level of the messages, showing only messages that have the selected priority and lower. Choose from ERROR, WARN (warning), INFO (information) or DEBUG (debugging message). For example, if one chooses DEBUG (the highest level) one will see all of the messages. If one chooses WARN, one will see errors and warning messages. Show Date & Time When checked, displays a column of date and times. When unchecked, the dates and times do not appear. Show Severity When checked, displays a column of severity levels (Error, Warning, Information, Debug). When unchecked, the severity levels do not appear. Show Category When checked, displays a column of the type of message generated (such as Application, Network, Configuration, etc.). When unchecked, the categories do not appear. Show Msg ID When checked, displays a column of message identification numbers. Clicking these numbers links to additional help on the message. When unchecked, the message IDs do not appear. Show Message Source When checked, displays a column that identifies the component that generated the message (such as transport manager, command control Agent, target execution command, etc.). When unchecked, the message sources do not appear. Show Agent When checked, displays a column of hostnames. When unchecked, the hostnames do not appear. Show Job Template When checked, displays a column of job template names. When unchecked, the job template names do not appear. A job template is the building block that allows users to define transfers between Agents. Administrator Guide Downloading a Job Log File Note For large log files, users may want to download the log and open it in another program for more detailed search functionality. For information on how to download the log file, see “Downloading a Job Log File” on page 39. To filter log information: 1 Expand the Jobs menu and click Distribute/Aggregate/Replicate. 2 In the job list, click the name of the job whose log you want to view. 3 Click view beside the run you want to look at. 4 Type the information on which you want to filter, or choose values from the drop-down, or place a check in the appropriate check box. 5 Click Filter. The filtered log appears. Note You can click Refresh to update the screen with the latest information. 6 Close the window to return to the Job View. Downloading a Job Log File Downloading a job log file allows you to save the file to your local machine where you can load the file into different programs (for searching, printing and so on). The log file is a plain text file. To download a job log file: 1 Expand the Jobs menu and click Distribute/Aggregate/Replicate. 2 In the job list, click the name of the job whose log you want to download. 3 In the list of job runs, click download beside the name of the run whose log you want to view. 4 Follow the directions on the screens to save the log file to your local machine. Note You may need to right-click on “download” to save the file. 5 Open the downloaded file in your preferred program. Chapter 4 Monitoring Jobs 39 Manually Starting a Job Manually Starting a Job Manually starting a job allows you to run a job immediately without waiting for its scheduled time. To manually start a job: 1 Expand the Jobs menu and click Distribute/Aggregate/Replicate. 2 In the job list, click the name of the job you want to run immediately. 3 In the actions area, click Run Now. A prompt appears asking if you want to run the job. 4 Click OK. Note To stop the job while it is running, click Kill. Stopping a Running Job Use the Kill feature to stop a job that is running. This option appears only when the job is running. To stop a running job: 1 Expand the Jobs menu and click Distribute/Aggregate/Replicate. 2 In the job list, click the name of the job you want to stop. 3 In the actions area, click Kill. A prompt appears asking if you want to kill the job. 4 40 Click OK. Administrator Guide Checking a Job’s Running Status Checking a Job’s Running Status While a job is running, you can check statistics such as what percentage of the job is complete, or unrecoverable errors. To check a job’s running status: 1 Expand the Jobs menu and click Distribute/Aggregate/Replicate. 2 The Job View appears, similar to the following: The State field displays the status of the job, using one of the following: State Description Running The job is currently running. Scheduled Job has been scheduled and has not run yet. Error Job has run and finished with an error (non-zero exit code). Completed Job has run and finished with no errors (an exit code of zero). Suspended Indicates the job’s schedule has been suspended (i.e., the job will not run at its next scheduled time unless a user clicks Resume). Pending A multiple push or pull transfer has been configured and there are more Agents to push to than currently can be handled, so those that are in the queue waiting to be serviced will have a status of pending. (The maximum number of Agents is eight.) You will also see a pending record at the startup of a transfer before any data starts to get transferred, but it will appear only briefly. You will see pending records only when you look at the job details for a transfer. The Completed column displays what percentage of the job is complete. 3 Click on the job name to display statistics from the selected job. 4 Click Refresh to update the screen. Note You can ensure the information displayed in the status screen is current by setting the refresh rate to 30 or 60 seconds. Click the number 30 or 60 to set the refresh rate to these times. Chapter 4 Monitoring Jobs 41 Checking a Job’s Running Status 42 Administrator Guide Chapter 5 Reporting The Management Console creates at least one statistics record for each completed job run and stores it in the Rules Database. Report Types Using the Management Console, you can generate the following types of reports: Report Type Description Stats Summary Report Provides a summary and totals of the data from all jobs in the selected job group (all Distribute, Aggregate and Replicate jobs are in the Published_Solutionss job group), based on how the user chooses to group the data (by month, day etc.). Detail Report Provides a detailed record of the data from the selected job group (all Distribute, Aggregate and Replicate jobs are in the Published_Solutions job group). Note that the number of records the report displays depends on the number of Agents on which the job runs. The report displays a record for every Agent on which the job runs. Custom Query Report Provides a customized query of detail records from the job name within a selected job group (all Distribute, Aggregate and Replicate jobs are in the Published_Solutions job group). Note that the number of records the report displays depends on the number of Agents on which the job runs. The report displays a record for every Agent on which the job runs. When you create a report, you can assign a template name to it. The template appears in the Report view. Report templates allow you to generate reports without having to change the parameters you initially set up. Templates are especially useful if you plan to generate the same type of report on a regular basis. You can Run, Edit, Remove or Schedule a report by clicking on the appropriate word beside the report template. Click Schedule to run reports daily, weekly or monthly at specific times. Administrator Guide 43 Stats Summary Report Stats Summary Report A Stats Summary Report provides a summary and totals of the data from all jobs in the selected job group, based on how the user chooses to group the data (by month, day and so on). To create a stats summary report: 1 Expand the Jobs menu and click Reports. 2 Click New Stats Summary Report. The Stats Summary Report screen appears: 3 In the Select a Job Group list, click the job group for which you want to generate the report (all Distribute, Aggregate and Replicate jobs are in the Published_Solutions job group). 4 Choose the roll up value from the drop-down list. (The value by which the report will break down the data. Choose from none, day, month or year.) 5 In the Report In drop-down list, choose the unit in which you want the statistics to appear. (Choose from bytes, kilobytes, megabytes or gigabytes.) 6 Choose the output format by clicking in the HTML radio button or the CSV radio button. CSV stands for Comma Separated Variable. You can load and save this type of file in a spreadsheet. 44 Administrator Guide Stats Summary Report 7 In the Select Columns to Group Data By area, click the appropriate check boxes to specify the column types in which you want to group the data. 8 In the Select Columns to Include area, click in the check boxes beside the type of information you want to include in the report. 9 In the Select a Date Range area, type the start and end date of the time period for which you want to generate the report. 10 In the Generate Report field, type a name for the template of this report. This template will appear in the Reports view, so that you can simply click on it to run a new report. Note If the overwrite template check box appears below the template name, uncheck the box if you do not want to overwrite the previous template. This will create a new, second template. You need to change the name for the new template. 11 Click Generate Report. The Stats Summary Report appears, looking similar to the following: 12 Close the report window to return to the report setup window, or use your browser’s print command to print the report. Chapter 5 Reporting 45 Detail Report Detail Report The Detail Report provides a detailed record of the data from the selected job group. Note that the number of records the report displays depends on the number of Agents on which the job(s) runs. The report displays a record for every Agent on which the job(s) runs. To generate a detail report: 1 Expand the Jobs menu and click Reports. 2 Click New Detail Report. The Detail Report screen appears: 3 In the Job Group list, click the job group for which you want to generate the report (all Distribute, Aggregate and Replicate jobs are in the Published_Solutions job group). 4 In the Report In drop-down, choose the unit in which you want the statistics to appear. (Choose from bytes, kilobytes, megabytes or gigabytes.) 5 Choose the output format by clicking in the HTML radio button or the CSV radio button. CSV stands for Comma Separated Variable. You can load and save this type of file in a spreadsheet. 46 Administrator Guide Detail Report 6 In the Select Columns to Include area, click the appropriate check boxes to specify the data you want to include in the report. 7 In the Select a Date Range area, type the start and end date of the time period for which you want to generate the report. 8 In the Generate Report field, type a name for the template of this report. This template will appear in the Report view, so that you can simply click on it to run a new report. Note If the overwrite template check box appears below the template name, uncheck the box if you do not want to overwrite the previous template. This will create a new, second template. You need to change the name for the new template. 9 Click Generate Report. The Detail Report appears, similar to the following: 10 Close the report window to return to the report setup screen, or use your browser’s print command to print the report. Chapter 5 Reporting 47 Custom Query Report Custom Query Report The Custom Query report provides a customized query of detail records from a combination of job name within a selected job group. Note that the number of records the report displays depends on the number of Agents on which the job runs. The report displays a record for every Agent on which the job runs. To create a custom query report: 1 Expand the Jobs menu and click Reports. 2 Click New Custom Query Report. The Custom Query Report screen appears: 3 In the Job Group drop-down list, click the job group for which you want to generate a report. 4 In the Job Name drop-down list, click the name of the job for which you want to generate a report. 5 In the Report In drop-down, choose the unit in which you want the statistics to appear. (Choose from bytes, kilobytes, megabytes or gigabytes.) 6 Choose the output format by clicking in the HTML radio button or the CSV radio button. CSV stands for Comma Separated Variable. You can load and save this type of file in a spreadsheet. 48 Administrator Guide Generating a Report from a Template 7 Set the search parameters by choosing one of the following radio buttons: • all (to generate a report only if all the search criteria are found) • any criteria (to generate a report if any of the search criteria are found) 8 In the Select Columns to Include area, click the appropriate check boxes to specify the data you want to include in the report. 9 In the Select a Date Range area, type the start and end date of the time period for which you want to generate the report. 10 In the Generate Report field, type a name for the template of this report. This template will appear in the Reports view so that you can simply click on it to run a new report. Note If the overwrite template check box appears below the template name, uncheck the box if you do not want to overwrite the previous template. This will create a new, second template. You need to change the name for the new template. 11 Click Generate Report. The Custom Query Report appears, similar to the following: 12 Close the report window to return to the report setup window. Generating a Report from a Template When you create a report, you can assign a template name to it. The template appears in the Report view. Each template is associated only with the user who creates it. Templates appear in the Report view only if you create a template. Report templates allow you to generate reports without having to change the parameters you initially set up. Templates are especially useful if you plan to generate the same type of report on a regular basis. You can also edit templates if you decide you do want to change some of the parameters. Chapter 5 Reporting 49 Scheduling a Report from a Template To generate a report from a report template: 1 Expand the Jobs menu and click Reports. 2 Click Run beside the name of the template you want to use to generate a report. The report you generated appears. 3 Close the window to return to the Reports menu. Note To edit a report template, click Edit beside the template you want to change. Note that if you want to keep the same template name, make sure a check appears in the overwrite template check box. To delete a report template, click Remove beside the template you want to delete. You are prompted to confirm that you want to delete the template. Click OK. Scheduling a Report from a Template When you create a report, you can assign the report a template name. The template appears in the Report view. Report templates allow you to generate reports without having to change the parameters you initially set up. Templates are especially useful if you plan to generate the same type of report on a regular basis. You can schedule a report to run on a daily, weekly or monthly basis. The scheduled report is e-mailed to the recipient(s) you specify in the schedule. Note that the report appears within the text of the e-mail and not as an attachment. To schedule a report from a report template: 1 Expand the Jobs menu and click Reports. 2 Click Schedule beside the name of the template you want to schedule. The Schedule Report screen appears. 3 In the frequency drop-down, choose how often you want to generate the report (choose from daily, weekly or monthly). 4 In the start at field, type the time at which you want the first report to be generated. 5 In the E-mail report to field, type the e-mail address(es) of anyone who you want to receive the report. Separate multiple e-mail addresses with a comma. 6 Click Add Job. Note You cannot edit the schedule of a scheduled report. In order to change the schedule, you must click Remove. The report template appears, but is no longer scheduled. You have an option to click on Schedule to reschedule the report with new parameters. 50 Administrator Guide Chapter 6 Maintenance By default, Snap EDR creates a number of functions you can schedule to view and trim the Management Console logs. The procedures in this chapter describe how to automate these maintenance tasks, and how to view log files. Trimming Manager Database Logs The Management Console restricts the amount of disk space used for logging by running a daily Log Maintenance job that limits the log directory threshold size to 500 megabytes. Periodically deleting logs is especially important for the delivery logs written to the transfer log directory on the Management Console (these logs are not in the database). A delivery log is generated every time a data transfer occurs and the accumulated logs can quickly take up a substantial amount of disk space. A default Log Maintenance job is configured and scheduled to run daily. However, users can change the default values in the existing log maintenance job to specify values suitable to their own environment. It is recommended that users schedule the log maintenance job to run once a day (which is the default value). For information on the values users can specify in the Log Maintenance job and the default values with which the job is configured, see the table in the procedure below. Administrator Guide 51 Trimming Manager Database Logs To schedule the template to trim the log and statistics: 52 1 Expand the Manager Administration menu and click Log Maintenance. 2 In the actions area, click Add a Job. 3 The following screen appears: 4 Set information in the fields. The following table lists the fields in the Log Maintenance screen: Field Description Keep stats and web audit logs in database for A drop-down list that allows users to specify the number of days stats and logs generated by the Management Console are kept in the database. Default value is 365 days. Log directory threshold size The maximum size (in megabytes) for the log directory. Default value is 500 megabytes. Rotate logs when they grow larger than The maximum size (in megabytes) the log files can reach before they are rotated. Default value is one megabyte. Administrator Guide Viewing Transfer Logs Field Description Number of rotated logs to keep The number of logs that have been rotated that you want to keep. Default value is seven. Keep Certified Delivery Logs for The length of time (in days) to keep certified delivery logs. Default value is 365 days. 5 Change the scheduling parameters, if desired. 6 In the Mail failure notification area, type the e-mail address of the person you want to receive notification if this job fails. Separate multiple e-mail addresses with a comma. Note If you do not want to receive any e-mail notifications, delete any e-mail addresses from the notification fields. 7 Click Add Job. Viewing Transfer Logs The Viewing Transfer Logs menu displays data transfer logs generated by the Management Console during each transfer. Users can click on the logs listed to view them. If the job runs with certified delivery turned on, the log server creates a certified delivery log file on the Management Console. With certified delivery, the source and target Agents use their private keys to sign hashes separately for each file they transfer. (A hash is an algorithm that creates a message digest for authentication.) Comparing these hashes determines whether the file transfers complete with no change to the data. When a user clicks on a certified delivery log file, the Management Console runs dds_delver which parses the log and displays it in a more user-readable format. To view transfer logs: 1 Expand the Manager Administration menu and click Transfer Logs. The Transfer Logs appear. 2 Click on the logs to download and view the details. Chapter 6 Maintenance 53 Viewing Transfer Logs 54 Administrator Guide Appendix A Exit Codes The following tables describe the scheduled job run exit codes, along with possible causes for error codes and steps that can be taken to correct any problems. Full List of Exit Codes Exit Code Cause Possible Resolution 0 Job completed with no errors Not applicable. 5 Fault Message Received The job may have been killed by one user, when another is requesting the 'status' of the job. May be caused by the following: - An invalid or unexpected request was sent to the Management Console - A critical server-side memory shortage caused request to be preempted Check that the database is up and responding. Clear some system memory by stopping unnecessary running processes. - A critical server-side database connection problem caused the request to be preempted 6 Syntax Error Message Received An invalid protocol message was received by the Management Console. Indicates that the Management Console and client Agents may be out of sync. 8 Wrong State Result Received The scheduled job's state is incompatible with the requested command. 9 Invalidation Request Message Received Scheduled job's state was assigned to INVALID during execution of the requested directive due to incorrect scheduling parameters or due to a corrupted internal state. Corrective action and re-evaluation are required to restore the job and deassert the execution blocking condition. Internal error. Requires engineering level resolution. A user has issued a command against a job that is incompatible with the state of the job (e.g., suspend command used against an already suspended job). Internal error. Requires engineering level resolution. Administrator Guide 67 Exit Code Cause 10 Parameter Error An incorrectly formatted command was sent to the Management Console. Possible Resolution Internal error. Requires engineering level resolution. 11 Initialization error Internal error. Requires engineering level resolution. 12 Memory Allocation Error Internal error. Requires engineering level resolution. Insufficient memory is available to run the Management Console. 15-18 Authentication Error/Prompt Error/Missing File Error/Node Definition Error Internal error. Requires engineering level resolution. 20 Quit Requested Verify that the operator is not manually stopping the process. 21 Abort Requested Verify that the operator is not manually stopping the process. 22 Internal Error Internal error. Requires engineering level resolution. 23 Process Start Error There was a problem on the Manager allocating resources to start this job. Try running this job again. 24 Prepackage Error Contact support. 25 Prepackage Error Contact support. 26 Transfer Error Contact support. 27 Rollback Cleanup Error Contact support. 28 Template In Use Contact support. 29 Session In Use Contact support. 30 Session Dead Contact support. 31 Password Error Contact support. 68 Administrator Guide Exit Code Cause 32 Transfer Errors Occurred These errors may be caused by, but are not limited to, the following: • Misconfigured or invalid grants. Possible Resolution Check the Manager's log by selecting View beside the most recent job listed in the jobs summary screen, and correct any errors indicated. • Incorrect source or target parent directory specified (e.g., directory does not exist, or transfer user does not have access to the directory). • One or more hosts are unavailable. • A syntax or logic error in one of the template's commands. 33-48 Miscellaneous errors Internal error. Requires engineering level resolution. 139 Segmentation Fault The running process produced a segmentation fault. 69 70 Administrator Guide Index Index Symbols E .req.pem 13 editing a job 33 email notification 27 A enable service on start-up 2 errors aggregate installation, viewing 12 creating job 20 aggregate data management tool 19 AIX 11 F file transfer options 23 C forcing changing the user password 5 frequency 26 job to run 40 copying a job 34 creating stats custom query report 48 G stats detail report 46 generating report from template 50 D data management tool aggregate 19 H help, online viii distribute 27 replicate 30 deleting a job 34 I delivery log 51 installation directory and file options 29, 32 information file distribute location on agent installation host 10 Transfer Agent creating job 28 distribute data management tool 27 documentation viii log file, UNIX 12 on UNIX-based systems 11 Snap Server Administrator Guide 71 on Windows-based systems 11 transfer agent errors, viewing (UNIX) 12 preferences 4 time zone 5 user properties 6 J O job options 26 online help viii jobs checking status 41 copying 34 P deleting 34 port 17 downloading log files 39 port requirements 17 editing 33 preferences 4 forcing a job to run 40 published_solution stopping 40 aggregate 19 viewing logs 36 distribute 27 viewing statistics 34 K kill 40 R replicate creating job 31 report L custom query 48 log file generating from a template 49 scheduled job 36 log Maintenance 52 logs trimming 51 viewing transfer 53 detail 43, 46 generating from template 50 scheduling from a template 50 stats custom query report 43, 44 stats summary 43 types 43 restart service 2 M re-sync 17 re-sync with management console 17 management console installing 1 logging in 2 S overview 3 scheduled job password 5 72 Snap Server Administrator Guide forcing 40 stop service 2 log file 36 viewing statistics 34 scheduling parameters 26 T Snap EDR Agents target host selection 22, 29, 32 downloading 9 technical support ix installing 8 template installing Linux 11 installing UNIX 11 generating report 50 transfer logs 53 installing Windows 10 revoking certificates 13 uninstalling 15, 18 U uninstalling from a Snap Server 15 uninstall service 2 uninstalling from UNIX 16 uninstalling uninstalling from Windows 15, 16 UNIX 16 unsuccessful installation 13 Windows 15 Snap EDR Express 3, 4, 7, 9, 10, 11, 19 snapshots 18 statistics viewing scheduled job 34 stats custom query report 43 creating 48 stats detail report creating 46 stats summary report 43 V viewing job log file 36 scheduled job statistics 34 viewing job statistics 34 volume deletion 17 Index 73 74 Snap Server Administrator Guide