EVault InfoStage 5.6 Oracle Plug-In for Solaris and Windows Installation & Configuration Guide August 2006 This manual describes the installation and configuration of the EVault InfoStage Oracle Plug-In for Solaris and Windows platforms, Version 5.6.
Contents 1 Oracle Plug-In...4 1.1 Overview...4 1.2 Features...5 1.2.1 Limitations...5 1.2.2 Changes...5 1.3 Release Notes and Helps...6 1.4 CentralControl...6 2 Installing the Oracle Plug-In on Solaris...7 2.1 System Requirements...7 2.1.1 Supported Platform Combinations...7 2.2 Installing the Oracle Plug-In on Solaris...8 2.2.1 Before Installing or Upgrading...8 2.2.2 Installing the Plug-In...8 2.2.3 Upgrading the Plug-In...9 2.2.4 Uninstalling the Plug-In...9 2.3 Before you run the Oracle Plug-In...10 2.4 Configuring the Oracle Plug-In with CentralControl...11 2.5 Using the Oracle Plug-In...12 2.6 Before Running the Oracle Plug-In...12 3 Installing the Oracle Plug-In on Windows...13 3.1 System Requirements...13 3.1.1 Supported Platform Combinations...13 3.2 Oracle Plug-In for Windows Installation...13 3.3 Before Running the Oracle Plug-In...13 4 Backups...14 4.1 Table for User Backup information...14 4.2 Performing Backups...15 4.2.1 How the Backup Works...15 4.2.2 Backup Steps...16 5 Restoring the database...17 5.1 Performing Restores...17 5.1.1 Guidelines for Recovery...18 5.1.2 Restore Wizard...18 6 Index...19 Contents Page 2 of 19
Revision: This manual is updated for Version 5.6 (August, 2006). Software Version: 5.6 Copyright 1997-2006 EVault, Inc. All rights reserved. EVault, Inc. makes no representations or warranties with respect to the contents hereof and specifically disclaims any implied warranties of merchantability or fitness for any particular purpose. Furthermore, EVault reserves the right to revise this publication and to make changes from time to time in the content hereof without obligation of EVault to notify any person of such revision of changes. All companies, names and data used in examples herein are fictitious unless otherwise noted. No part of this document may be reproduced, transmitted, transcribed, stored in a retrieval System or translated into any language including computer language, in any form or by any means electronic, mechanic, magnetic, optical, chemical or otherwise without prior written permission of: EVault, Inc. c/o Corporation Trust Center 1209 Orange Street Wilmington, New Castle Delaware 19801 www.evault.com EVault, EVault InfoStage, EVault Protect, and EVault DeltaPro, are registered trademarks of EVault, Inc. All other products or company names mentioned in this document are trademarks or registered trademarks of their respective owners. Acknowledgements: Two encryption methods, DES and TripleDES, include cryptographic software written by Eric Young. The Windows versions of these algorithms also include software written by Tim Hudson. Bruce Schneier designed Blowfish encryption. The EVault InfoStage Agent, EVault InfoStage CentralControl, and EVault InfoStage Director applications (versions 4/5) now have the added encryption option of 128bit AES (Advanced Encryption Standard). Advanced Encryption Standard algorithm (named Rijndael, pronounced Rain Doll ) was developed by cryptographers Dr. Joan Daemen and Dr. Vincent Rijmen. This algorithm was chosen by the National Institute of Standards and Technology (NIST) of the U.S. Department of Commerce to be the new Federal Information Processing Standard (FIPS). AES is not available when connecting to a Vault lower than version 4.1. See:http://csrc.nist.gov/encryption/aes/round2/r2report.pdf for details. The EVault InfoStage Agent and EVault InfoStage Director applications (versions 4/5) also have the added security feature of AES 128 over the wire encryption method for data communications. Over the wire encryption is not available when connecting to a Vault lower than version 4.X Copyright Page 3 of 19
1 Oracle Plug-In 1.1 Overview The Oracle Plug-In has been designed to allow a user to perform a database backup on an Oracle database. The Plug-In is installed with a Windows or Solaris Agent, on the database host, to perform on-demand or scheduled backups. Configures DB Backup and Restore Host (User) CentralControl User Configures Host (DB Server) Database Agent, with Oracle Plug-In LAN / WAN Host (Vault) Director This diagram illustrates the basic product implementation. A user, typically a DBA, will configure the backup via the Web CentralControl, or Windows CentralControl application. CentralControl configures the Agent, which may reside on a different host than CentralControl. The User may schedule a backup of the Database, at which time the Agent, with the aid of the Oracle Plug-In, sends the database information to the Director. Oracle Plug-In Overview Page 4 of 19
1.2 Features The Plug-In performs a hot backup 1 of the whole database instance. o on Oracle 8i (8.1.7), 9i or 10g on Solaris 8, 9 or 10. o on Oracle 9i or 10g on Microsoft Windows 2000 or 2003. The Oracle Plug-In on Windows provides a non-rman hot backup facility. Backs up all non-temporary tablespaces and associated archived redo logs. Can be scheduled as with any other Agent backup and is controlled from the Agent Console (CentralControl or Web CentralControl) as with other backups. Full system restores are performed through normal user managed Oracle restore mechanisms. Backs up instance parameter files (non-instance parameter files such as tnsnames.ora may be backed up with a normal file system backup). All Oracle passwords are encrypted for enhanced security over script-based methods. Oracle backups support UTF-8 for filenames. 1.2.1 Limitations 1.2.2 Changes Backups of Oracle database clusters are not supported by the Plug-In; only individual databases may be backed up. The Agent and the Oracle Plug-In must be running together on the same system (i.e. the system with the Oracle database server). Does not support the backup of raw devices. Must be run with SYSDBA privileges on a database in ARCHIVELOG mode. Oracle Instant Client Support on Windows. Instant Client Support is supplied as a separate component to the Plug-In. It must be installed separately by the user. The installation will provide a warning to install Instant Client Support if it is not installed. Version 5.6 Agents on Windows use the fully qualified Oracle Service Name instead of the Oracle SID (Oracle home is no longer necessary). 1 Oracle Corporation recommends that backups take place in periods of low database activity. Oracle Plug-In Overview Page 5 of 19
1.3 Release Notes and Helps Release notes Release Notes, which are shipped as Release Notes text file with the product, contain up to the minute information on the released product, and contain an overview of new features, any known defect (bug) fixes incorporated since the last release, a description of any known issues, and a section on product support. Online Helps The CentralControl application (GUI) has an online help, which contains information similar to the user manual. The help is accessed from the main pull-down menu, or by using the F1 function key. There is also context sensitive What s This help on each GUI screen. Note: If the F1 Help screen is open (even minimized) the What s This help will not be active. The F1 help must be closed for the What s This help to function properly. 1.4 CentralControl The CentralControl provides a centralized point of control for managing all computers running the Agent software on a large computer network. Within an organization, the configuration and scheduling of Jobs is done through the computer running the CentralControl software. The CentralControl software connects to an organization s computers running the Agent software, activating that computer s Backup Job. The CentralControl software operates on Windows 2000, XP and 2003 Systems. The CentralControl Operations Guide is the main manual used by the customer/user responsible for installing, configuring and using all Agents and the CentralControl software (and any applicable Plug-Ins). The chapters in the manual cover the following topics: Installing the main CentralControl software (GUI). Using the CentralControl GUI Workspace, Agents, Agent Configurations, Jobs, Safesets, Catalogs and Log files. Performing Backups Types, Seeding, Mapped drives and databases, Options, Tape, Retentions, Notification, Expiration, Scheduling and Ad hoc. Report Logs Creating and Managing Log files. Data Security User Authentication and Encryption. Open File Backup Shared files, OTM, and OFM. Troubleshooting and Command Line Interface. The Agent for Unix User s Guide and the "Agent for Microsoft Windows User's Guide" describe Agent Configurations, Performing Backups and Restores, plus Installing the Agent for Solaris and Windows. Oracle Plug-In Overview Page 6 of 19
2 Installing the Oracle Plug-In on Solaris The optional Oracle Plug-In integrates into the existing architecture and provides the user with the ability to backup Oracle databases to the Director vault. The Solaris Agent performs restores, and the data thus restored may be used to recover any Oracle database in need of recovery. Installing the Oracle Plug-In version 5.6 requires that you have previously installed the Solaris Agent application, version 5.6 or later. If your CentralControl application version is previous to 5.60, you must update it to version 5.60 before installing the Oracle Plug-In. The vault must be version 5.27 or 5.52. The Oracle Plug-In program typically comes from your service provider as a tar file, called Oracle-Plugin-Solaris-5.60.tar, although it may be renamed. Note: For functions such as Creating a new Agent, Creating a backup Job, Scheduling Backups, and Disaster Recovery information, refer to the Operations Guides and User Guides for more information on installing, and for using the software. 2.1 System Requirements The backup agent has been tested against Oracle 8i 8.1.7.0.0 and Oracle 9i 9.2.0.1.0. The version of Oracle you have can be determined by querying BANNER from V$VERSION or VERSION from V$INSTANCE: SELECT banner FROM v$version SELECT version FROM v$instance The Oracle Plug-In has the following install requirements for Solaris: Operating System: Solaris 8, Solaris 9, or Solaris 10 Oracle: Oracle 8i, 9i or 10g 2.1.1 Supported Platform Combinations Oracle 9i on Solaris 8 Oracle 9i on Solaris 9 Oracle 8i on Solaris 8 Installing Oracle Plug-In on Solaris Page 7 of 19
2.2 Installing the Oracle Plug-In on Solaris 2.2.1 Before Installing or Upgrading The Solaris Agent and the Oracle Plug-In must be installed on the system with the Oracle database server. Both the Solaris Agent and the Oracle Plug-In should always have the same version number. The Agent must be installed before the Plug-In. The Plug-In requires a separate license, installed through the CentralControl application. See the CentralControl Operations Guide. The Oracle Plug-In has been tested in homogeneous and heterogeneous installations of Oracle 8i and 9i with a single listener. The Oracle Plug-In can only find the TNS name list (tnsnames.ora) in the global location /var/opt/oracle. This may be a copy of or symbolic link to the tnsnames.ora that was used to start the listener. The Oracle Plug-In does not support the resolution of global SID names; if your tnsnames.ora specifies a SID as ORCL.company.com, it should be renamed in the global tnsnames.ora to read as ORCL. 2.2.2 Installing the Plug-In Install the Oracle Plug-In as a root user. 1. Download the file Oracle-Plugin-Solaris-5.60.tar 2. Extract the files from the file. To do so, type the following: # cd /tmp # tar xvf Oracle-Plugin-Solaris-5.60.tar 3. Then, type the following: # cd Oracle-Plugin-Solaris-5.60 4. Run the installation script. #./install.sh (./install.sh s will skip the space check) 5. Follow the installation instructions on the screens. Installing Oracle Plug-In on Solaris Page 8 of 19
2.2.3 Upgrading the Plug-In An upgrade of the Plug-In is performed the same as a new installation. The install script does not stop the Agent prior to the upgrade; it will offer to start the Agent after a successful install and will not start the Agent on a failed install. You must stop (./VVAgent s ) the agent before installing. Upgrade the Oracle Plug-In as a root user. 1. Download the file Oracle-Plugin-Solaris-5.60.tar 2. Extract the files from the file. To do so, type the following: # cd /tmp # tar xvf Oracle-Plugin-Solaris-5.60.tar 3. Then, type the following: # cd Oracle-Plugin-Solaris-5.60 4. Run the installation script. #./install.sh (./install.sh s will skip the space check) 5. Follow the installation instructions on the screens. 2.2.4 Uninstalling the Plug-In Uninstall the Plug-In as a root user. To un-install the Plug-In run the uninstall script: #./uninstallora.sh This script is in the installation directory (typically /usr/local/buagent) After the un-install script, you should stop and start the Agent: #./VVAgent s #./VVAgent d Installing Oracle Plug-In on Solaris Page 9 of 19
2.3 Before you run the Oracle Plug-In The Oracle Plug-In performs what Oracle Corporation deems an inconsistent whole database backup, requiring that the database is running in ARCHIVELOG mode. During a live backup, any changes to the database will be written to archive logs. The DBA should ensure that the database is in ARCHIVELOG mode: SELECT log_mode FROM v$database The value ARCHIVELOG should be returned. If this is not returned, then the normal Oracle procedures for putting the database in ARCHIVELOG mode should be followed. This is typically: > shutdown normal > startup mount > alter database archivelog; > archive log start > alter database open In Oracle 8i, this will be done with the svrmgrl utility. In Oracle 9i this is done directly from SQL*Plus. This may also be done from the Enterprise Manager GUI or other facilities at the DBA s disposal. No tablespaces may be in backup mode before a backup is run. You can verify this with: SELECT d.file_name, b.status FROM dba_data_files d, v$backup b WHERE b.file# = d.file_id; If any files are displayed with status ACTIVE, then the backup will not start. NOTE: The backup Agent leaves Oracle in the appropriate state when a backup completes successfully. Installing Oracle Plug-In on Solaris Page 10 of 19
2.4 Configuring the Oracle Plug-In with CentralControl Before the Solaris Oracle Plug-In may be used to create backup Jobs, the license must be entered from within CentralControl, and the Plug-In s Oracle Home path must be set. These are managed through the Plug-In tab of the Agent Configuration dialog. For a version 5.27 vault only, your service provider will provide the Oracle Plug-In license that must be entered into the license key box on the configuration screen. A version 5.52 vault will obtain a license from the vault directly. Installing Oracle Plug-In on Solaris Page 11 of 19
2.5 Using the Oracle Plug-In The following fields must be entered in the CentralControl when configuring a Job for Oracle backup: Service Name: User Name and Password: The fully qualified Service Name is the unique name for the Oracle database instance. Enter a user with SYSDBA privileges and access to the performance views. This can be SYS but can also be another user whom you have set up with the correct privileges. If you are not sure, then use the SYS user. Note: Version 5.6 Agents use the Oracle Service Name instead of the Oracle SID (Oracle home is no longer necessary). 2.6 Before Running the Oracle Plug-In The Oracle Plug-In performs what Oracle Corporation deems an inconsistent whole database backup, requiring that the database is running in ARCHIVELOG mode. During a live backup, any changes to the database will be written to archive logs. The DBA should ensure that the database is in ARCHIVELOG mode: Installing Oracle Plug-In on Solaris Page 12 of 19
3 Installing the Oracle Plug-In on Windows 3.1 System Requirements The Oracle Plug-In will work in conjunction with an Agent on: MS Windows 2000 Server (SP4) MS Windows 2003 Server R2 MS.NET 1.1 or 2.0 The Oracle Plug-In is used in conjunction with EVault InfoStage Director version 5.27, and 5.52. 3.1.1 Supported Platform Combinations Oracle 9i or Oracle 10g. 3.2 Oracle Plug-In for Windows Installation The Oracle Plug-In for Windows is selected during the installation of the Windows Agent (Agent-Windows-5-60.exe). Instant Client Support is supplied as a separate component to the Plug-In. It must be installed separately by the user. The installation will provide a warning to install Instant Client Support if it is not installed. 3.3 Before Running the Oracle Plug-In The Oracle Plug-In performs what Oracle Corporation deems an inconsistent whole database backup, requiring that the database is running in ARCHIVELOG mode. During a live backup, any changes to the database will be written to archive logs. The DBA should ensure that the database is in ARCHIVELOG mode: Installing Oracle Plug-In on Windows Page 13 of 19
4 Backups 4.1 Table for User Backup information Before performing the Oracle database Backup/Restore process, be sure you have all the information such as names, locations, passwords, etc. that the Wizard will prompt for. The table below is for design considerations, as well as providing a record for future reference. System Requirement Customer/User supplied value Comments New Job name Name = Job used to talk to the Agent with Oracle Plug-In. Vault profile Profile = Profile of an existing (already created) Director. Chosen from a pull-down menu. Backup Source type Type = Choose Oracle from the pulldown menu. Database to be backed up, and account information to that database Database (SN) = User Name = Password = OracleHome = Encryption type Type = Password = Log options Options = Detail level = Copies = Start the backup Immediate = Schedule = Validates the fields, and allows connection to that database. If you select a type, you must supply a password. User defined. Uses the Scheduling Wizard. NOTE: The Options Button on Agent Configuration / Plug-In, is disabled for the Windows Oracle Plug-In. Backups Page 14 of 19
4.2 Performing Backups To back up your Oracle database you need the Agent residing on the same system as the Oracle database server, and then create a new Job (through CentralControl), using Oracle as the type of backup source (see below). Note that the backup should be normally performed after hours, as recommended by Oracle. Otherwise, full blocks will be written to the redo logs causing an increase in archiving activity and an increase in the number of archive logs generated hence causing an increase in the number of archive logs that will have to be restored. 4.2.1 How the Backup Works Once a backup is initiated, all non-temporary tablespace files will be backed up (including those that are ONLINE, OFFLINE, and READONLY). The Archive logs generated during the backup and the current redo log will be backed up. Prior to backing up the Archive log files, the Oracle Plug-In attempts to flush any redo logs that have not yet been written to disk. The control file is backed up to both the trace and binary files backed up by the Agent. The parameter files (init<oracle_sid>.ora and/or spfile<oracle_sid>.ora, depending on the version and configuration of Oracle) and the Oracle password file are backed up. NOTE: tnsnames.ora is not included in the backup. This file and any other common files (such as sqlnet.ora and listener.ora) can be backed up using a normal file based Agent backup on the system. Backups Page 15 of 19
4.2.2 Backup Steps The Backup Wizard will direct the user through the process, but briefly, the steps to perform this include: 1. From the CentralControl GUI program (which communicates with the Agent and the Plug-In), create a new Job. 2. Enter a Director profile where the Job will be targeted. 3. Select the source of the data (i.e.: Oracle) that will be backed up by this Job. 4. Supply the Oracle database connection information Server name (SID), User name, and Password. Only one database at a time is backed up with each Job. But there can be more than one Job doing backups, on different databases. It is not recommended to do multiple Jobs, at the same time, on the same database. 5. If desired, select an encryption type and supply an encryption password. 6. Select logging options and level of detail. 7. Start the backup (immediately), schedule it for later, or exit the Wizard Log files are created on the CentralControl machine, under the installation directory, in directories with the Job name. They are normally viewed from the CentralControl application screen. Backups Page 16 of 19
5 Restoring the database 5.1 Performing Restores Restores may be necessary in these scenarios: Restoring the full database. With no system backup, restoring the system from the ground up ( bare metal ) installing the OS, applications and then the full database, and any transaction logs, onto a new system. If there is an Oracle backup, and a full system backup, restore the system (putting back the contents of ORACLE_HOME, specifically the database installation). You may safely exclude the datafiles and archive logs that are backed up by the Oracle Plug-In. Finally restore the Oracle backup and copy the required components to their appropriate directories, as needed, according to the standard User Managed Oracle recovery procedure outlined in the appropriate OS Oracle Backup and Recovery Guides, available on the Oracle website. Notes on Backups: a) the database files and the archive log files (as well as the current redo log) are backed up; b) these will be restored, possibly to the existing location; c) they are used during restore/recovery as outlined in the Oracle manual for the version of Oracle being backed up; d) the control file is always backed up, but is only needed if the instance was so badly corrupted that a new copy of the control file is needed again. This is also described in the appropriate Oracle manual for backups. An Oracle Restore is performed by a Database Administrator. Briefly, the steps are: e) the database is shut down, f) the files are restored, g) the database may need to have the proper control information set again, h) the database needs to be started and recovered, i) the database needs to be opened for use. Note that the Plug-In does not do table level restores. Restores Page 17 of 19
5.1.1 Guidelines for Recovery Note: these are not recovery steps, just guidelines. The Oracle Plug-in has been tested against Oracle 8i (8.1.7 beta) and Oracle 9i (9.2.0) in several data recovery scenarios. In the case of a full disaster recovery (where the full database instance is being restored), some care must be exercised on recovery of the database as the Oracle Plug-in does not back up any TEMPORARY tablespaces and the control file information kept in the trace file does not include any commands to add a temporary tablespace under Oracle 8.1.7. 1. The database recovery should be initiated with an explicit PFILE or SPFILE reference: SQL> STARTUP PFILE='path-to-pfile\initSIDNAME.ora' 2. It may be necessary to take the temporary tablespace datafiles offline: SQL> ALTER DATABASE DATAFILE 'path-to-datafile' OFFLINE 3. The database should be recovered as normal, but when opening the database after recovery the command should be: SQL> ALTER DATABASE OPEN NORESETLOGS 4. TEMPORARY tablespaces should be dropped, the datafiles for the temporary tablespaces removed, and the TEMPORARY tablespaces should be recreated (this may include the default TEMP tablespace). At this point in the recovery, the database can be closed normally and restarted with RESETLOGS (if that is your organization's policy). 5.1.2 Restore Wizard The Restore Wizard will direct the user through the process, but briefly, the steps to perform this include: 1. From the CentralControl, select the restore function (Wizard). 2. Supply the Director and safeset information. 3. The restore option is set and must be set to alternate location. 4. Select logging options and level of detail. 5. Start the restore process and recover the Oracle database. (See Oracle recovery procedure outlined in the appropriate OS User Managed Oracle Backup and Recovery Guides, available on the Oracle website.) Restores Page 18 of 19
6 Index Agent for Unix User s Guide...6 archive log files...17 archive logs...15 archived redo logs...5 ARCHIVELOG mode...5 backup source...15 Backup Wizard...16 Backup/Restore process...14 bare-metal...17 CentralControl GUI...16 CentralControl Operations Guide...6 control file...17 control information...17 database information...4 DBA...4 Director...4 Director profile...16 Director vault...7 disaster recovery...18 encryption password...16 Encryption type...14 environment variable...14, 15 full blocks...15 Full system restores...5 hot backup...5 instance parameter files...5 logging options...16, 18 low database activity...5 multiple tasks...16 non-rman...5 non-temporary tablespaces...5 Oracle database...18 Oracle database clusters...5 Oracle Instant Client Support...5 Oracle otn website...17, 18 Oracle Plug-In...17 Oracle Service Name...5 Oracle SID...5 ORACLE_HOME...17 ORACLE_SID...12 Oracle-Plugin-Solaris-5.0.tar...7 Password...5, 12 Plug-In...8 ReadMe...6 redo log...17 redo logs...15 Release Notes...6 RESETLOGS...18 restore function...18 Restore Wizard...18 root user...8 safeset...18 Scheduling Wizard...14 security...5 SID...12 Solaris Agent application...7 sysdba privileges...12 SYSDBA privileges...5 table level restores...17 temporary tablespace...18 tnsnames.ora...5 transaction logs...17 uninstall script...9 upgrade...9 User Name...12 UTF-8 for filenames...5 Vault profile...14 version...8 version of Oracle...7 Web CentralControl...4 What s This...6 Windows CentralControl...4 Index Page 19 of 19