EVault InfoStage IBM i Agent 6.0. User s Guide. November 2008

Transcription

1 EVault InfoStage IBM i Agent 6.0 User s Guide November 2008 This document describes how to install and use the IBM i (iseries) Agent 6.0 for Backups and Restores.

2 Contents 1 INTRODUCTION How the IBM i Agent Works Agent Software Functions of the Agent Software Features of the 6.0 Agent Software Agent Configuration Overview - Names, Passwords, and Permissions Agent Configuration Overview - Functions and Features About This Guide Online Helps Starting the IBM i Agent program Overview of the IBM i Agent Main Menu Commands CONFIGURATION Agent Configuration Menu Work with Vaults Create Vault Configuration Change Vault Configuration Delete Vault Configuration Verify Vault Configuration Re-Register a Vault Work with Retention Schemes Create a Retention Change a Retention Delete a Retention Settings - Details File Overwrite/Rename Options File Overwrite/Rename Option values for an IFS Job File Overwrite/Rename Option values for an OBJ Job Bandwidth Throttling Parameters for Bandwidth Throttling: Encryption Working with Wild Card Exclusions Wild Card Exclusions IFS Backup Wild Card Exclusions OBJ Backup Performance - Multi-Threading and Multi-CPU Disable CRC Option Compression / Decompression Algorithms Backup/Restore Priority Notification Work with Agent Licenses Work with Jobs Create a Job Object Backup IFS Backup SYS Backup...37 Contents Page 2 of 82

3 2.4.2 Customer Command Change a Job Delete a Job Display Safeset Display Logfile Convert.XLOG to.log file - XLOGMAIN Utility Backup, Synchronize, Restore Function Keys Create a new Job Shortcut to Agent Directory Display Running Job Status Work with Schedules Create a Schedule Change a Schedule Delete a Schedule Enable/Release Disable/Hold BACKUP JOBS HOT BACKUP Journaling Triggering AUTOMATIC JOB CREATION Introduction Job Creation Main Menu Library/Job Selection Exclude Libraries Select Libraries Include/Exclude List Retention Schedule Retention Job Selection Job Creation: Create All Jobs Default Parameters RESTORE JOBS For Data Type OBJ: For Data Type IFS: For Data Type SYS: System State Restores RECOVERING THE SYSTEM BARE METAL RESTORE INSTALLATION PROCEDURES Communication / Pre-Installation Requirements Contents Page 3 of 82

4 8.2 Method 1 - Install from CD Method 2 - Agent Installation from FTP Agent Setup Install New Agent Upgrading an Existing Agent Verify Use IBM i Agent Obtain and Install License Agent Uninstall Uninstall (When installed from FTP) Uninstall (When installed from CD) ADDITIONAL INFORMATION Synchronize Delta File Recreation IBM i Best Practices INDEX Contents Page 4 of 82

5 Table of Figures Figure 1. - Main ISAGENT Menu Screen...11 Figure 2. - Agent Configuration Main Menu...13 Figure 3. - Agent Configuration Work with Vault...14 Figure 4. - Agent Configuration F6 Create (Create Vault)...15 Figure 5. - Work with Vault Re-Register with Vault...17 Figure 6. - Agent Configuration Work with Retention Scheme...19 Figure 7. - File Overwrite/Rename - Restore...21 Figure 8. - File Overwrite/Rename Options for IFS...21 Figure 9. - File Overwrite/Rename Options for OBJ...22 Figure Bandwidth Throttling - Use all available Bandwidth...24 Figure Bandwidth Throttling - Parameters...24 Figure Encryption Options...25 Figure Performance - Multi-Threading and Multi-CPU Options...27 Figure Disable CRC Option...28 Figure Compression Option...29 Figure Agent Configuration Optional Settings...29 Figure Agent Configuration Settings...30 Figure Agent Configuration Work with License...31 Figure Work with Jobs Main Menu...32 Figure Work with Job Create New Backup Job...33 Figure Work with Customer Command...38 Figure Work with Job Change...39 Figure Work with Job Display Safeset...40 Figure Work with Job Display Safeset Detail...41 Figure Work with Job Display List of Logs...42 Figure Work with Job Display Log Data...43 Figure Work with Object Links...44 Figure Work with Schedules Main Menu...45 Figure Work with Schedules Create Backup Schedule...46 Figure Work with Schedules Change...48 Figure Run Backup...49 Figure Triggering...52 Figure Job Creation Main Screen...54 Figure Exclude Libraries...55 Figure Select Libraries...56 Figure Adjust Include/Exclude List...57 Figure Include/Exclude List...58 Figure Retention Schedule...59 Figure Retention Job Selection...60 Figure Create Jobs...61 Figure Run Restore...63 Figure Agent Setup...71 Figure Install New Agent...72 Figure Upgrade Existing Agent...73 Figure Uninstall Agent...75 Figure Synchronize...77 Table of Figures Page 5 of 82

6 Revision: This manual is updated for Version 6.0 Software Version: 6.0 (November, 2008) Copyright 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 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. "Part of the software embedded in this product is gsoap software. Portions created by gsoap are Copyright (C) Robert A. van Engelen, Genivia inc. All Rights Reserved. THE SOFTWARE IN THIS PRODUCT WAS IN PART PROVIDED BY GENIVIA INC 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 AUTHOR 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." The EVault InfoStage Agent, EVault InfoStage CentralControl, and EVault InfoStage Director applications (version 4 and above) 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: for details. The EVault InfoStage Agent and EVault InfoStage Director applications (version 4 and above) also have the added security feature of an over the wire encryption method. Over the wire encryption is not available when connecting to a Vault lower than version 4.1 Copyright Page 6 of 82

7 1 Introduction The IBM i (formerly iseries) Agent is an application that performs automatic backups of the IBM i (iseries) data, across a local network, or the Internet, to a secure server called a Vault. The application runs a background program, which, when configured, schedules and runs the Backup automatically. The user directs the scheduling, configuring and monitoring through a 3270 or 5250 screen (or terminal emulator). It is assumed here that the IBM i (iseries) Agent User is knowledgeable in IBM i operation and administration. 1.1 How the IBM i Agent Works The IBM i Agent comprises a data protection software program that securely backs up and restores data from IBM i computers across a network to a remote Data Protection Vault. The application provides an automated (i.e. scheduled) method for protecting your valuable computer data without the need for tape devices or other Backup media. Note: The IBM i Agent cannot be controlled by a Windows or Web CentralControl. Also, the Agent does not get supplied with a license from the Vault, as other types of Agents do Agent Software The Agent software runs on the individual IBM i computers to be backed up. Backups on the Agent computer are configured and scheduled by the IBM i Agent program. The Agent communicates its Backup data directly to the Vault, over the network. Each IBM i computer that needs to be backed up must have the Agent software installed and running, and be connected to the network. A batch Job to do the Backup is initiated from the scheduler, or immediately if the user runs the Backup or Restore command. The setup of Agents, Jobs, scheduling, and monitoring is done from the IBM i Agent Command Line Interface (CLI). The remote Vault has to be previously set up with an account, to receive your Agent s Backup data. Introduction Page 7 of 82

8 Functions of the Agent Software The Agent software is responsible for the following, on the IBM i system: Save/Restore DBFiles, Objects and CommonFiles to/from the Vault, using Delta processing. Synchronize catalog files between the local system and the remote Vault Features of the 6.0 Agent Software Speed and Performance enhancements. Added AES 256 bit encryption. Added Bandwidth throttling capability. Improved multi-cpu/threading capability. Delta File Recreation capability. Improved messaging and authentication. Improved the capability of exclusions. Utility to assist users in creating optimally configured Jobs. Translate XLOG file to LOG file using XLOGMAIN utility. Increased Job Name from 8 to 30 characters. Long Pathname Support to characters (limited to OS support). European Languages Support UTF8 Support. Overwrite rename option. Multilingual messaging. Added IBM LZ1 algorithm for compression / decompression for faster restores. LVR (Logical Vault Replication) aware Agent Configuration Overview - Names, Passwords, and Permissions What is needed? Names, Passwords and Permissions. 1. Each computer to be backed up needs an Agent program running on that computer. 2. You supply a Vault Name, IP address, and User/Password to the Agent. 3. Then, Register the computer on the Vault. (The Agent sends the profile information to the Vault.) Why Register the IBM i computer on a Vault? To be able to Logon to the Vault and establish a connection, the Vault must know that this Agent is valid (has an account on the Vault) and is authorized to perform its functions. Jobs are registered during the creation of the Job, and are used during a Backup. They contain information such as: 1. Which Profile is used? (i.e.: which Vault?) 2. What data is to be backed up? 3. What type of logs? 4. What type of encryption (if any)? 5. When is it scheduled? Introduction Page 8 of 82

9 The IBM i Agent needs a minimum of *ALLOBJ rights, to be able to do backups. That is, the Agent needs enough rights to be able to open/read all libraries and objects. Note: The first Backup is a seed (complete Backup), the next and subsequent ones are deltas (i.e. changes only), but they are equivalent to, and still considered a full Backup. A full Backup means that you can access (and recover) any data completely, whether the data is a single file, library or object, or multiple ones. Depending on how your System is configured, there may be more than one Vault you can connect to. Also, during a Disaster Recovery operation, when you have to recover your system to a new machine, you must Re-Register the new machine to be able to recover the Agent information from the Vault to be able to do Restores. You should always make sure that your scheduled backups have completed properly. Check the (if enabled) and review the log files Agent Configuration Overview - Functions and Features 1. The IBM i Agent has two Hot Backup methods: Journaling and Database Triggers (for database objects only). Both methods incur some overhead (time and cycles) on the system. The user can select either method for backing up open files (hot backups). Triggering will snapshot native data physical files (PF-DTA). With this, the Agent is able to save any database changes made during a Backup. The Agent can also revert those changes back to the time of the start of the Backup. For trigger-based hot backups, only physical database files are supported. Physical source files, logical files, save files and device files are excluded. Supported database files cannot contain these columns: CLOB, BLOB, DBCLOB, ROWID, Data link. 2. Work with Job (WRKTASK): Previous and Post commands are now in Work with Customer Command (WRKCUSTCMD). The Save Active option now has TRIGGER added (the hot Backup feature). Pre and Post command: a) The log file will classify message types. b) There is exception handling for pre- and post- commands. c) Pre/Post commands can run as regular program or batch Jobs. d) Pre- and Post-Backup commands or results are now logged in notifications. e) The Backup continues only when the pre-backup command was successful. 3. Installation: Installing from a save file, as before, is still supported. An ISO image can also be published on a web site. Users can then burn this to a CD on a PC. The Load and Run (LODRUN) system command allows a user to run the install and setup from a media such as a CD. This version of the IBM i setup program handles upgrades from the current version. The upgrade will only allow a limit of one Agent per O/S system. Introduction Page 9 of 82

10 OS/400 V5R4 compatibility: This version runs on V5R4 (and below). It will support new hardware announced by IBM. 4. Thirty-day trial license. This allows a user to run backups and restores for up to 30 days, after which the user must obtain a permanent license to continue running backups and restores. 5. This release of the IBM i Agent saves the private authority of native and IFS objects. The Agent can also save the additional attributes of IFS files. 6. The IBM i Agent re-directs system job log messages to the Agent log file. All related Agent errors are in one place, in the logs. In the log files the message type of NONE reads SYS (along with other types already there such as BKUP, SCAN, SSET, and UTIL to say where the message is from). 7. Days of Week in "Work with Schedules" include an *ALL type of flag (characteristic) to allow a Backup to occur daily. You don t have to select each day of the week individually to get a complete week. 8. ADDOBJJOB and CHGOBJJOB allow you to save those objects that have sizes smaller than a pre-determined value. This helps the speed of restores that contain many small objects. 9. RESTORE command parameters: IGNSECDTA (YES/NO) allows you to switch on/off the object private authorities granting, after the object has been restored. RSTTHD (1-8) specifies how many threads can run concurrently, to enhance the performance of small static object restores. SYSSTS (ALL, CFG, USRPRF, SYSVAL) specifies the type of system states that are restored. RSTCMD (NO/YES) specifies whether to prompt for the RSTUSRPRF command, to Restore the user profile, or RSTCMD to Restore the configuration objects About This Guide This User s Guide is intended for the Administrator responsible for ensuring that their IBM i computers are configured to be backed up. Different Systems will require different files and directories backed up, on different schedules, depending on what data needs to be secured. Some may require more frequent backing up, depending on how the data changes (i.e. its volatility). This Guide will show the Administrator how to select data to be backed up, how to configure the Agents, and how to schedule the times Online Helps The F1 function key will bring up a general, or specific (field level) help screen, dependent on where you are in the menus. Field level help will appear in screens that show you, or ask you for information. With the cursor on the field in a screen, select F1. Introduction Page 10 of 82

11 1.2 Starting the IBM i Agent program Initial installation of the IBM i Agent is covered in later chapters of this manual. After successfully signing on to the IBM i, accessing the IBM i Agent screen can occur in two ways: a) If a User profile for the Initial Menu parameter is not set to ISAGENT, then type GO LIBRARY/ISAGENT (where LIBRARY is the library name that you installed the Agent to) on the command line of the current screen. Press Enter and the User will be automatically directed to the ISAGENT screen. b) A User profile on the IBM i has the Initial Menu parameter set to ISAGENT. After a successful Sign On to the IBM i, the User is automatically directed to the ISAGENT screen. Figure 1. - Main ISAGENT Menu Screen The main IBM i Agent screen has choices for: Configuration: Agent and Vault, Jobs and Schedules. Data Protection Jobs: Backup and Restore. Synchronization with the Vault. Auto Job Creation. Signoff the IBM i Agent CLI program. Introduction Page 11 of 82

12 1.3 Overview of the IBM i Agent Main Menu Commands The following list briefly describes the functions of the IBM i Agent main menu commands. The choices presented in the ISAGENT main menu screen are selected for ease of use, and order of importance and functionality. For example, to do a simple Backup for the first time, you would follow steps 1, 2, 3, and 4. Further backups can be run automatically (scheduled), or you can run them manually with just step 4. Configuration: 1. Agent Configuration Vault name and address; Retention scheme; Priority and notification; Licensing. You must configure an Agent first, and then create a Job. 2. Work with Jobs Create, Change, Delete Jobs; Display Safeset and Log information. You must have a valid configuration before you can create a Job. 3. Work with Schedules Create, Change, Delete, Enable, and Disable schedules. You must have a valid Job before you can create a schedule. This is the normal way to schedule a Backup to run at a specified time. Backup and Restore Jobs: 4. Backup Enter a Job name and a Destination for the Backup to run immediately (ad hoc). You must have created a valid Configuration and Job first. 5. Restore Enter a Job name as well as where to Restore from and to. You must have done a valid Backup first. Miscellaneous: 9. Synchronize Enter a Job name to synchronize with the Vault. This will get the updated safeset (Backup) information from the Vault. 10. Auto Job Creation Automatic Job Creation can create multiple Jobs for backing up all libraries except for the excluded libraries selected by the user. Creation of multiple Jobs enables effective utilization of CPU cycles, hence faster Backup processing. 90. Signoff Exit from the ISAGENT CLI program. You don t need to keep the IBM i Agent CLI program running after you have configured and scheduled a Job. You may Signoff (or run other IBM i Jobs), and the Job will run as a batch job when scheduled. Introduction Page 12 of 82

13 2 Configuration These steps are described from the point of view of a user with a newly installed IBM i Agent on their System. They will get you going to be able to do a Backup. This configuration menu choice covers both the Agent and Vault configurations. 2.1 Agent Configuration Menu The Agent, which is the program that performs the Backup, must be configured with information such as: Vault names and passwords Which vault to use What data to Backup If an notification should be sent Licensing information Once the configuration is set up properly, the scheduled backups will proceed automatically, through the IBM i Scheduler. Note that Run Backup from the main menu allows you to start a Backup immediately, regardless of its schedule. Figure 2. - Agent Configuration Main Menu The details of Essential Settings (menus 1 and 2) and Miscellaneous Settings (menus 4,5 and 6) are discussed in this chapter. Configuration Page 13 of 82

14 2.1.1 Work with Vaults This is where you can create and use a list of Vaults to receive your backups. The Vault name is a meaningful one that you define. The network address is an IP address, or a DNS name, if Domain Name Services is configured on your system. You need at least one valid Vault connection to do a remote (network) Backup. Figure 3. - Agent Configuration Work with Vault Configuration Page 14 of 82

15 Create Vault Configuration Figure 4. - Agent Configuration F6 Create (Create Vault) Vault Name: Create a name, meaningful to you and unique on this Agent, of 1 to 15 characters for this Vault connection. Note: You may use A to Z, and 0 to 9, but you must NOT start with a number. Special characters _, and $ are also allowed. There is a maximum of 10 connections per Agent. Account Name: Your Vault supplier must give you a valid account number/name (maximum of 40 characters). More than one Agent may use this account. User Name/Password: The User Name (maximum 40 characters) and Password (maximum 31 characters) are supplied by your Vault supplier, and must be valid for the Account. Verify Password: Re-enter the password, to verify that you entered it correctly. This is a double-check, as the password (for security reasons) does not display as you enter it on the screen. Configuration Page 15 of 82

16 Network Address: Enter the network address (IP or DNS name) of the Vault, as supplied by your Vault supplier. Port Number: This is the port on the remote Vault (default is 2546) that the IBM i Agent uses to communicate with the Vault. The port number is set up as supplied to you by the Vault personnel. Your value (here) must match their configuration. Reconnect delay (seconds): This defines the wait time, between 30 seconds and 1800 seconds (i.e.: up to 30 minutes), between repeated attempts to reconnect to the Vault after a communication or session failure. The default is for it to retry every 30 seconds, for the time set in the Retry timeout field. If the reconnection is successful, the Backup will continue with no data loss. If the reconnection is eventually unsuccessful, the Backup will fail, with an error message in the log file (and an , if s are configured). Retry Timeout (seconds): This defines the time, between 60 seconds and seconds (i.e.: up to 12 hours), after which the Agent will stop trying (every time period as set in the Reconnect delay field) to reconnect. The default is 3600 seconds (one hour) after which time the Backup will fail, with an error message in the log file (and an , if s are configured). Note: This value must be greater than the Reconnect Delay period. Over the wire Encryption: You may optionally choose to encrypt and protect your Backup data as it goes from the IBM i to the Vault. This is only necessary if you are using an insecure network, such as the Internet. If you are inside you own secure LAN, you may not need this Change Vault Configuration Allows you to modify values that you entered in Create, for an existing Vault configuration Delete Vault Configuration Allows you to delete (remove) an existing Vault configuration. This does not affect any user data. You will be prompted to confirm the deletion. You would delete a Vault configuration only if it was no longer being used for any backups or restores Verify Vault Configuration Verifies (tests) that the Vault connection is valid and working. You will get a message saying Vault was verified successfully. If not, you should recheck the Vault configuration information, and the hardware and network connections. Configuration Page 16 of 82

17 Re-Register a Vault Re-Registration allows you to recover/restore Job configuration information from the Vault, back to your Agent. You would use this if you have a new Agent, and need to use a previous Job. Or, if you are trying to recover a crashed system you will need the Jobs back at the Agent to be able to perform Restores. The Backup was done from the original system onto the Vault, that is the system that was Registered with the Vault. When you first connected the Agent to the Vault (before the crash), that disk ID and system name was registered to that Vault. Global and Job configuration files (for the IBM i Agent) were stored on the Vault. To be able to recover the global and Job files back to the Agent on the new disk, you must Re-Register this new disk back to the Vault. This tells the Vault (by the Account, User Name and Password combination) that you are authorized to get the old configuration files back. Figure 5. - Work with Vault Re-Register with Vault You must enter the information for Vault, Account and Connectivity. See the section above on Create for more information on these fields. You will be prompted with a message that this will overwrite any existing Jobs on this Agent. You may also perform a DR (disaster recovery) Test with a temporary license. Selecting *YES in the Is This a DR Test field will allow you to perform a DR Test on the target system. In this case a temporary license will be generated and used for the DR. Configuration Page 17 of 82

18 For security reasons, any passwords or system information that might compromise the security of the system are not restored from the Vault during a re-registration. This means that some configuration files may be incomplete. An IFS file, called Register.log is created in the IBM i Agent system log directory (dependent on your installation setup). You will see messages similar to the following, that you will require you to correct the cause of the problem. May12 10:44 PARS-W-0002 Due to a computer registration, configuration file "A" is missing the following information: May12 10:44 PARS-W-0002 Enc_Password (Encryption Password) May12 10:44 PARS-W-0002 please use the Agent Console to re-enter the missing information Configuration Page 18 of 82

19 2.1.2 Work with Retention Schemes A Retention defines how many copies of a Backup (i.e.: a Safeset) you will keep on a Vault before they are automatically deleted, how many days they will be kept (online), and how many days they will be kept archived. There will always be a minimum of the number of online copies and the online days available, even if one is less than the other. This means that if you specify 7 online copies for 7 online days, there will always be 7 copies even if they are more than 7 days old. And there will always be 7 online days, even if more days have gone by. The Vault system will delete the oldest retentions first. You can never delete all your backups. There will always be at least one copy kept, the most recent one (while you still have your valid account on the Vault). Figure 6. - Agent Configuration Work with Retention Scheme Configuration Page 19 of 82

20 Create a Retention Retention Name Define (create) a new name (maximum of 32 characters, using A to Z and 0 to 9, but do not start with a number.) The underscore character ( _ ), the dollar sign ( $ ), pound sign ( # ) and ampersand ) are also allowed. Maximum of 10 names allowed per Agent. This name is used in the Job configuration, to relate back to this retention scheme. Online days (1-9999) specifies the number of days a safeset is kept on the Vault before expiring. Once the expiry date is reached, a safeset is automatically deleted. There will always be at least the number of online copies (below), regardless of the setting for online days. Online copies (1-999) specifies the minimum number of copies of a particular safeset (as defined by a Job) that will be maintained online. It functions in a first in, first out manner. Once the number of copies is exceeded, the oldest copy will be deleted. The safesets will always stay for at least online number of days (above), even if the setting for online copies is lower than online days. Archive Backup YES/NO if YES, you can choose a value from 365 to 9999 days that the system will keep your backups (archived). Archiving is an optional function of the Vault operation. Users may choose to have their on-line data moved off-line (usually to tape) for cheaper storage. Restoring from off-line storage requires a longer time frame than online storage Change a Retention Retention Name Display only here. The following items may be changed. See the Create for definitions of the values. On-line copies (1-999) Select a new value. On-line days (1-9999) Select a new value. Archive Backup YES/NO If YES, select a new value Delete a Retention You would optionally delete a Retention when it is no longer used by (i.e.: associated with) any Jobs. You are prompted to be able to delete this Retention. Configuration Page 20 of 82

21 2.2 Settings - Details File Overwrite/Rename Options Note: The IBM i Agent supports Overwrite/Rename Options for both IFS & OBJ Backups. IFS and OBJ overwrite rename parameter values are different and are discussed separately in sections and Figure 7. - File Overwrite/Rename - Restore File Overwrite/Rename Option values for an IFS Job F4 on File Overwrite/Rename Option will display the 5 available values for an IFS Job. Figure 8. - File Overwrite/Rename Options for IFS Configuration Page 21 of 82

22 1. Overwrite Existing Files (OVRWRT) The OVRWRT option will overwrite all existing file in libraries after a Restore. If a user is sure that changes were made in the library for an existing file, then this option is not advisable since all changes will be lost. 2. Prompt Before Overwrite Existing Files (PMTOVRT) The PMTOVRT option will prompt a user before overwriting an existing file with incoming Restore file. If a user enters No to all, then the Restore option will not overwrite the existing file but if the user enters Yes To All then Restore option will overwrite all existing files with the incoming Restore files. 3. Do not overwrite Existing Files (NOOVRWRT) The NOOVRWRT option will not overwrite an existing file in a library with the incoming file (which is coming through Restore). 4. Rename Incoming (RNMINC) The RNMINC option will rename an incoming Restore file with a unique number (0001, 0002) appended with the file name if that file exists in the library. 5. Rename Existing (RNMEXT) The RNMEXT option will rename an existing file (which exists in the library) with a unique number (0001,0002) appended with the file name if an incoming Restore file has the same name as the existing file File Overwrite/Rename Option values for an OBJ Job F4 on File Overwrite/Rename Option will display the 3 available values for an OBJ Job. Figure 9. - File Overwrite/Rename Options for OBJ 1. Overwrite Existing file (OVRWRT) Configuration Page 22 of 82

23 The OVRWRT option will overwrite all existing files in libraries after a Restore. If the user is sure that changes were made in the library for an existing file then this option is not advisable since all changes will be lost. 2. Prompt Before Overwrite Existing Files (PMTOVRT) The PMTOVRT option will prompt a user before overwriting an existing file with incoming Restore file. If a user enters No to all, then the Restore option will not overwrite the existing file but if the user enters Yes To All then the Restore option will overwrite all existing files with the incoming Restore files. 3. Do not overwrite Existing Files (NOOVRWRT) The NOOVRWRT option will not overwrite an existing file in the library with the incoming Restore file Bandwidth Throttling The IBM i 6.0 Agent supports data communication bandwidth throttling. The user can select to use all the available bandwidth present on the network for Backups and Restores, or "throttle back" and restrict bandwidth usage by a percentage of available bandwidth (i.e.: in Kb/sec). Depending on the priority of Job or amount of network communication traffic, the user can decide on the amount of bandwidth that a particular Job can use during the Backup/Restore Job. From the main menu, under Configuration, choose number 1 for Agent Configuration then press 6 for Advanced Configuration to see the Bandwidth Throttling screen Parameters for Bandwidth Throttling: Use all available Bandwidth (ALLWBW): The ALLWBW option is selected by default. During backups, you have a choice of using all available Bandwidth on the network, or throttling back for all Jobs on an Agent. This is available so that the network is not overwhelmed with Backup data, leaving other users with very little bandwidth for their daily tasks. Typically you would want a Restore to happen as fast as possible, by disabling Bandwidth Throttling for a Restore. But, you can also use only the Bandwidth allocated in Agent Configuration for a Restore. If the Use all available Bandwidth option is not selected, then the user can limit the bandwidth usage. The user can specify the amount of bandwidth that is to be used for all Job. The user has the option to select ALLDAY or limit the Bandwidth Throttling for particular hours in the day. By default all the days of the week are selected but user has the option of selecting specific days of the week. Configuration Page 23 of 82

24 Figure Bandwidth Throttling - Use all available Bandwidth Bandwidth Throttling can be set to start and end at specific times of the day by entering the start time (Start Hours, Start Minutes) and the end time (End Hours, End Minutes) for Bandwidth Throttling to occur. Job activity outside these times will not be throttled back. The following screen with the available options is displayed when the user does not select Use all available Bandwidth. Figure Bandwidth Throttling - Parameters Configuration Page 24 of 82

25 2.2.3 Encryption Encryption secures your Backup data on the Vault so that it cannot be read without decrypting. You can choose your strength of encryption type (or none) from the following Encryption Options. *NONE *DES56 *BLOWFISH65 *BLOWFISH128 *TRIPLEDES112 *AES128 - Advanced Encryption Standard *AES256 - Advanced Encryption Standard (strongest) Figure Encryption Options Note: You must remember your encryption password if you chose to encrypt your data. You data is not recoverable without your encryption password Working with Wild Card Exclusions The IBM i Agent supports Wildcard Exclusions for both IFS and OBJ Backup based on prefix and postfix wildcards Wild Card Exclusions IFS Backup Wildcard Rules for Folders 1. In this case once a folder has been excluded the contents of that folder would not be backed up. The following are valid exclusion formats: FOLDER* *FOLDER *FOLDER* Configuration Page 25 of 82

26 2. Only the last path element of the selection can contain a wildcard: * Supported: /Projects/A* * NOT Supported: /Projects*/Active 3. A path element of a selection can only contain a wildcard: * Supported: /Projects* * NOT Supported: /P*j* 4. The Wildcard can appear anywhere in the path element: * Supported: /Projects* * Supported: /*rojects 5. The Agent supports one path element with a wildcard per selection: * Supported: /Projects/User* * NOT Supported: /P*/U* Wildcard Rules for Files When a file is mentioned on an excluded list, this means that file will not be backed up even if that file exists in the folder to be backed up. The wildcard exclusion patterns allowed are FILE*, *FILE and *FILE* Wild Card Exclusions OBJ Backup When an object is mentioned on an exclude list, this means that object will not be backed up even if that object exists in the library to be backed up. The wildcard exclusion patterns allowed are OBJECT*, *OBJECT and *OBJECT* Performance - Multi-Threading and Multi-CPU If the Agent is on a multi-cpu system, you can use multi-threading to improve the performance of backups and restores of files larger than 32KB. There are three threading models available: Single threading. All the data processing is handled by a single thread. Combined threading. Data processing is divided up between two threads. Block Processor threading. Data processing is spread across four or more threads. Configuration Page 26 of 82

27 Figure Performance - Multi-Threading and Multi-CPU Options Threading Model User Options: Default: With this option the Agent will check both Backup settings and current hardware to determine which model it should use. This is the default setting used by the Agent. On a single CPU system, the Single threading model will be used. On a multi-cpu system the threading model used will depend on Backup settings. If compression and/or encryption are turned ON, the Block Processor threading model will be used, otherwise the Combined threading model will be used. Single: A Single threading model will be used. Combined: The Combined threading model will be used. Block Processor: The Block Processor threading model will be used with up to four processing threads. Maximum Block Processor: The Block Processor threading model will be used with up to five processing threads Disable CRC Option You can choose to disable CRC to improve the performance of backups and restores. If the CRC has been disabled during Backup then it would also remain disabled during a Restore irrespective of the option selection (Disable CRC = *YES / *NO) on the Restore screen. Configuration Page 27 of 82

28 Figure Disable CRC Option Compression / Decompression Algorithms To reduce the data transmitted and the data size at the Vault you can choose a compression type from the following: *NONE *DEFAULT *STANDARD *NORMAL *MINIMUM *BETTER *MAXIMUM *FASTERRST (IBM LZ1) The IBM LZ1 algorithm for compression / decompression will improve the performance of restores, but at the cost of (almost 2.5 times) slower backups. On the task creation screen, for the parameter Compression, specify the value FASTERRST in order to use the IBM LZ1 compression / decompression algorithm. Note: *BETTER is the default compression setting. Configuration Page 28 of 82

29 Figure Compression Option Backup/Restore Priority (1-9), where 1 is High and 9 is Low, for the Backup or Restore Job to run on the system. Figure Agent Configuration Optional Settings Configuration Page 29 of 82

30 Notification The Agent can be configured to send an to one or more addresses, to notify the recipients if a Job failed or succeeded. This is a system wide function that affects all Agent Jobs. It cannot be selected for only certain Jobs. (None, All, Success, Fail). A Backup or Restore Job will either be successful, or not. You may want to know if it was successful, and/or if it was not successful. None will not send any notifications. All will send notifications for a Success or Fail. From Address the From address that will show on the . SMTP Server address of the Simple Messaging Transport Protocol Server for sending the s. Recipients list of one or more addresses, separated with commas. Figure Agent Configuration Settings Configuration Page 30 of 82

31 2.3 Work with Agent Licenses Figure Agent Configuration Work with License The information on the top part of the screen is informational and cannot be changed. Enter your License Key, as supplied to you by your Service supplier. The key is of the form XXX-XXXXXXXX-XXXXXXXX-XXXXXXXX (in upper-case characters, for a total, including hyphens, of 30). The Server information from your machine (the Model, Processor Feature, Serial Number and Software Group which are shown in this diagram are examples) must have been supplied to your Service provider earlier, to produce a unique License Key for this machine only. When you first install the Agent you will have a 30-day trial license, with the expiry date showing at the top of the screen. You must get and enter the License Key before the expiry date. You cannot do Backups or Restores after this without a license. Other functions, such as creating Vault Configurations, Retention Schemes, Jobs and Schedules will still work. Configuration Page 31 of 82

32 2.4 Work with Jobs From the main menu, under Configuration, choose number 2 to Work with Jobs. You must create a Job to be able to do a Backup. You may create as many Jobs as you need. A Job can be one of many, used to do different types of Backups (i.e.: OBJ, IFS or SYS), in different ways, at different times. Figure Work with Jobs Main Menu From this screen you can create a new Job, or change or delete an existing Job. If you are just starting the Agent after installation, you will not have any Jobs in the list yet. You can also display information about a safeset, or a log file associated with a Job. Run Backup, Synchronize, and Run Restore are commands available to you here that are also available on the main IBM i Agent menu. They are not described (duplicated) here, but under separate sections, in chapters 3 and 4 of this Guide. Configuration Page 32 of 82

33 2.4.1 Create a Job Figure Work with Job Create New Backup Job Job Name A new definition, unique on this Agent, of up to 30 characters. Note: You may use A to Z, and 0 to 9, but you must NOT start with a number. Special characters _ (underscore) and $ (dollar sign) are also allowed. Vault Name (1 to 15 characters) Enter one defined earlier in Work with Vaults. Note: F4 will display a list of all current Vaults. Data Type Select one of the types of data included in the Job configuration: *OBJ, *IFS, *SYS OBJ Libraries and objects in native system. IFS Folders and stream files in Integrated File System. SYS System state data that contains system security data (SAVSECDTA), configuration objects (by SAVCFG command) and system values. Each of these three Data Types is described in the sections below. Configuration Page 33 of 82

34 Note: Other than *SYS (System State), regular system objects include *ALLUSR and *IBM. With *ALLUSR, all user libraries are saved. This includes some libraries that IBM has supplied, but they typically contain user data that changes frequently, so are considered User Libraries as well. *IBM saves all system (IBM) libraries, which are considered System Libraries. In the following descriptions, these definitions apply: Recursive: Take all libraries and all their contents (objects). Save Savefile data: Take contents of Savefile, or just the header information. Save Active: SYSDFN (System Define) - Save in the current state. If NO, specify a wait time. Or specify a Trigger for database backups. Save Active/Backup wait time: How long to wait before SYSDFN is available to be backed up. Deferring: If the Backup Job does not complete in your specified length of time (15 to 2880 minutes), it will pause and continue at the next scheduled Backup time. Encryption: Secures your Backup data on the Vault, so that it cannot be read without decrypting. You choose your strength of encryption type (or none) Object Backup Include Objects Object name: This list can be up to 128 items (use + for more values). You may choose a single name, or *ALL, *ALLUSR, *IBM or use a generic name. *ALL - All the objects in the specified library are saved. *ALLUSR - All objects in user libraries are saved. QSYS becomes the only legal library name. If *ALLUSR is included in more than one entry, all the other entries will be removed. *IBM - Saves all objects in system (IBM) libraries. QSYS becomes the only legal library name. If *IBM is included in more than one entry, all the other entries will be removed. generic* - Specify generic name of a group of objects in the specified library to be saved. A generic name is a character string that contains one or more valid characters followed by an asterisk (*). Library: Either name the library, or use QSYS for all libraries. Type: Choose a specific type from the list (with F4), or *ALL for all types. Exclude Objects Object name: This list can be up to 128 items (use + for more values). You may choose a single name, or *ALL, *ALLUSR, *IBM or use a generic name. Note that a generic (partial) name will start with one or more valid characters, followed by an * (the wildcard). Library: Either name the library, or use QSYS for all libraries. Type: Choose a specific type from the list (with F4), or *ALL for all types. (See section for details on working with Wildcard Exclusions.) Configuration Page 34 of 82

35 Recursive YES or NO. Take all libraries and all their contents (objects). Small Object Size (KB) Specifies the size limit for objects to be backed up via save files. Objects bigger than a user-defined value set value will be backed up with an IBM API. Backing up small objects via save files drastically improves Restore times. Save Savefile data YES or NO. Save Active NONE, SYSDFN, or TRIGGER Save Active/Trigger Wait Time up to seconds, or NOMAX (wait forever). Default is 120 seconds. This is the time that the trigger will wait for a quiet period of no database activity, before the Backup starts. Trigger Retry Period up to seconds, or NOMAX (wait forever). Default is 3600 seconds. The trigger will retry for the active/backup wait time for this retry period. If it does not succeed, the Backup will not start, and an error message will be entered into the log file. Threading Model If the Agent is on a multi-cpu system, you can use multi-threading to improve Backup and Restore performance. Choose DEFAULT, SINGLE, COMBINED, BLOCK PROCESSOR, or MAXIMUM BLOCK PROCESSOR. (See section 2.2.5) If you select F10 you will get more options: Encryption (Type and Password) NONE, DES56, BLOWFISH56, BLOWFISH128, TRIPLEDES112, AES128, AES256. (If you use encryption, you will be prompted for a password and to verify that password.) NOTE: If you lose your Encryption Password, your data is NOT recoverable! Compression To reduce the data transmitted and the data size at the Vault you can choose a compression type. Choose NONE, DEFAULT, STANDARD, NORMAL, MINIMUM, BETTER, MAXIMUM or FASTERRST. (See section 2.2.7) Deferring (Disable and Minutes) NO or YES. If NO, enter a time of 15 to 2880 minutes, or NODEFER to keep the Backup going until finished. Quick File Scanning YES or NO. Do you want to Backup any objects that have not changed since the last Backup. Update History YES or NO. (Suppress Archive bit.) If YES, the time/date of the Backup data will be changed. Log Detail This option specifies the amount and type of Backup details to be included in the log files. Choose FILE, NONE, SUMMARY, or DIRECTORY. Disable CRC YES or NO. You can choose to disable CRC to improve the performance of backups and restores. (See section 2.2.6) Configuration Page 35 of 82

36 IFS Backup Include IFS stream files - Specifies a list of up to 128 entries of IFS paths that you want to Backup. Absolute path - specifies the absolute path name of the stream files. File - The files in the specified directory are being saved. Recursive - Specifies whether sub-directories are included in the Backup. Exclude IFS stream files - Specifies a list of up to 128 entries of IFS stream files that you don't want to Backup. Threading Model If the Agent is on a multi-cpu system, you can use multi-threading to improve Backup and Restore performance. Choose DEFAULT, SINGLE, COMBINED, BLOCK PROCESSOR, or MAXIMUM BLOCK PROCESSOR. (See section 2.2.5) If you select F10 you will get more options: Encryption (Type and Password) NONE, DES56, BLOWFISH56, BLOWFISH128, TRIPLEDES112, AES128, AES256. (If you use encryption, you will be prompted for a password and to verify that password.) NOTE: If you lose your Encryption Password, your data is NOT recoverable! Compression To reduce the data transmitted and the data size at the Vault you can choose a compression type. Choose NONE, DEFAULT, STANDARD, NORMAL, MINIMUM, BETTER, MAXIMUM or FASTERRST. (See section 2.2.7) Deferring (Disable and Minutes) NO or YES. If NO, enter a time of 15 to 2880 minutes, or NODEFER to keep the Backup going until finished. Quick File Scanning YES or NO. Do you want to Backup any objects that have not changed since the last Backup. Update History YES or NO. (Suppress Archive bit.) If YES, the time/date of the Backup data will be changed. Log Detail This option specifies the amount and type of Backup details to be included in the log files. Choose FILE, NONE, SUMMARY, or DIRECTORY. Disable CRC YES or NO. You can choose to disable CRC to improve the performance of backups and restores. (See section 2.2.6) Configuration Page 36 of 82

37 SYS Backup A System State Backup includes the following IBM i System items: System Values (WRKSYSVAL *ALL) with system API User Profiles, Authorities List (SAVSECDTA) o User Profiles o Authorization Lists o Authority Holders Configuration Objects (SAVCFG) o Line descriptions o Controller descriptions o Device descriptions o Mode descriptions o Class-of-service descriptions o Network interface descriptions o Network server descriptions o NetBIOS descriptions o Connection lists Configuration lists o Hardware resource data o Token-ring adaptor data Threading Model If the Agent is on a multi-cpu system, you can use multithreading to improve Backup and Restore performance. Choose DEFAULT, SINGLE, COMBINED, BLOCK PROCESSOR, or MAXIMUM BLOCK PROCESSOR. (See section 2.2.5) Encryption (Type and Password) NONE, DES56, BLOWFISH56, BLOWFISH128, TRIPLEDES112, AES128, AES256. (If you use encryption, you will be prompted for a password and to verify that password.) NOTE: If you lose your Encryption Password, your data is NOT recoverable! Deferring (Disable and Minutes) NO or YES. If NO, enter a time of 15 to 2880 minutes, or NODEFER to keep the Backup going until finished. Compression To reduce the data transmitted and the data size at the Vault you can choose a compression type. Choose NONE, DEFAULT, STANDARD, NORMAL, MINIMUM, BETTER, MAXIMUM or FASTERRST. (See section 2.2.7) Log Detail This option specifies the amount and type of Backup details to be included in the log files. Choose FILE, NONE, SUMMARY, or DIRECTORY. Disable CRC YES or NO. You can choose to disable CRC to improve the performance of backups and restores. (See section 2.2.6) Configuration Page 37 of 82

38 2.4.2 Customer Command You may want to execute a user-defined command before or after a Backup Job. This option lets you set up your own command for a Backup Job. For example, you can use the previous command (*PRE) to shutdown a subsystem before a Backup, and start it after the Backup is finished using a post command (*POST). Figure Work with Customer Command Job Name Create a name for this Job to set up your own command for a Backup Job. Command Class *PRE (before) or *POST (after) the Backup is run. For example, you may use *PRE to shutdown a subsystem before a Backup, and start it after the Backup is finished using *POST. Command A single, valid OS command. This can be a batch file (script). Configuration Page 38 of 82

39 2.4.3 Change a Job Figure Work with Job Change This allows you to modify an existing OBJ, IFS or SYS Job. See the Create section for a description of all the options. Note: Job ID is new in the display, and is for reference only. The top three items (highlighted) are read-only, and cannot be changed here. Also, for Object Backups, a Backup Database Type of IO or API was chosen when a new Backup Job was created (see section 2.2.1). As of Agent version 5.3x, this setting can be changed. For a Restore, the Agent knows how the Backup was saved (by API or direct IO). Note: If suppress archive bit processing is modified within the Job, the Agent forces QFS (quick file scanning) off for the next Backup. For *OBJ Jobs on the IBM i, this parameter is shown as "Update History". Due to QFS being forced off, the Backup can run much longer than expected. Configuration Page 39 of 82

40 2.4.4 Delete a Job You may want to delete a Job if you no longer need it, and it is not associated with any Agents or Vaults. This only deletes the Job information from your local Agent. It does not delete any existing safesets (backed up data). Select the Delete choice. You will be prompted for confirmation of the deletion Display Safeset Every time a Job does a Backup, the data is kept on the vault in a safeset. The safesets are numbered sequentially each time a Backup occurs. The location is only meaningful to the vault. The data of the Backup (processed time) is also kept, so that you can choose a particular version of a safeset by the time/date. Status Online, Work Area or Archived. A Status of Online means that the safeset is available for a Restore. Work Area status means the data is in transition to Online status. You can either wait for the system to change the status, or you can perform (run) a Synchronize command. Archived status means the safeset is stored off-line from the vault. Figure Work with Job Display Safeset Select one of the safesets, and use 5 (Display) to show the safeset information. Configuration Page 40 of 82

41 Figure Work with Job Display Safeset Detail The details shown are from the choices that the user has defined for this Backup. They are display only. You cannot make changes here. Definitions: Job Name The name of the user defined Job that created this Backup safeset. Catalog Number The sequential number assigned by the system to this safeset. Location The name/address of the Vault where this safeset is kept. Status Current status of this safeset (Online, Work Area, Archived). Backup Time The date and time this safeset was created. Backup Type Full, or Full-Delta (both are recognized as full backups). Storage Size: The size of the Backup in its original, deltized and compressed forms. Original Size of the original data backed up. Deltized The amount of deltized data (zero for the initial seed). Compressed Size of the data stored on the Vault. Retention: Days Number of days this safeset will be kept. Copies Number of copies of backups kept. Archived Days Number of days an archive copy will be kept. Encrypted Was the data encrypted by the user, or not. Compressed Yes. Media Type The safeset is stored on a Vault disk. Configuration Page 41 of 82

42 Expiry When will this safeset be deleted, depending on Retention Days and Copies Display Logfile Each Backup, Synchronize or Restore has a logfile associated with it. This shows if a Job was successful or not. It also shows the date/time, and what objects were backed up or restored. The verboseness of the log files depends on your choice of log detail, when you created the Job. Backup logs are named after the safeset numbering ( LOG, LOG, etc.). The Synchronize log (SYNCH.LOG) is always the latest one, and Restore logs are named RSTYYYYMMDD-HHMMSS. You may choose to manually delete any logfiles. Figure Work with Job Display List of Logs Log files contain information about the status of the Job, as well as what data was backed up or restored, as well as times and any error messages. Select a particular log file to display it. Configuration Page 42 of 82

43 Figure Work with Job Display Log Data The type of log file (FILE, NONE, SUMMARY, or DIRECTORY) is specified when you create a Job. The default is Summary. You can Page Up and Page Down, to view the file. Or, use B or T to go to the Bottom or Top of the file Convert.XLOG to.log file - XLOGMAIN Utility You can convert an.xlog file to a.log file with the XLOGMAIN utility. The command for the XLOGMAIN utility is CALL PGM(XLOGMAIN) PARM('/file.XLOG' '/file.log'). It is required that the.xlog file be present in the specified location. The output.log will be generated by the XLOGMAIN tool. Providing the complete path is necessary Backup, Synchronize, Restore Run Backup, Synchronize, and Run Restore are commands available to you here that are also available on the main IBM i Agent menu. See Section 9.1 Synchronize. A Synchronize can be run ad hoc, or Scheduled, but it run automatically after every Backup or Restore. (Refer to Work with Jobs - Main Menu, for choices 7, 8, and 9) Configuration Page 43 of 82

44 2.4.8 Function Keys Create a new Job F6 Create a new Job. (See Section Create A Job for more details.) Shortcut to Agent Directory F7 Shortcut to Agent directory. Figure Work with Object Links The following are IBM i Commands, and are not described here. Edit Copy Remove Display (usually just this one is used to display the contents of a file.) Rename Display Attributes Change Current Directory Display Running Job Status F10 Display running Job status in AGENT subsystem. Configuration Page 44 of 82

45 2.5 Work with Schedules A Job (for example, a Backup or Synchronize, but not a Restore) can be run at predetermined (scheduled) times. All Jobs can also be run manually (ad-hoc, or unscheduled) when desired. Note: Do not use IBM Advanced Scheduler for submitting Agent Jobs. The Agent uses the standard job scheduler, which requires multi-threading. IBM Advanced Scheduler uses RCLRSC command internally, which is not compatible with multi-threaded applications. Figure Work with Schedules Main Menu The IBM i Agent needs a minimum of *ALLOBJ rights, to be able to do backups. That is, the Agent needs enough rights to be able to open/read all libraries and objects. Options: Create, Change, Delete, Disable/Hold Enable/Release. Status: SCD (Scheduled), or HLD (Hold). Configuration Page 45 of 82

46 2.5.1 Create a Schedule Figure Work with Schedules Create Backup Schedule Command Backup, Synchronize, Custom Fields for Backup: Job Name Select a Job name that you have previously defined. Retention Name Select a Retention that you have previously defined. Command Cycle Weekly, or Monthly. Minutes/Hours Time to start. Days of week Which days the Job will run. Quick File Scanning YES or NO. Do you want to Backup any objects that have not changed since the last Backup. Deferring: Disable NO or YES Times 15 to 2880 minutes (i.e.: up to 48 hours). If the Backup Job does not complete in this length of time, it will pause and continue at the next scheduled Backup time. Note: If you have the Defer option enabled, and the Backup does not complete in the allotted time, the system will stop the Backup, and complete it during the next Backup time. To be able to stop the Backup, the operating system must abnormally stop the Backup Job (the Backup API). This will create errors in the Backup.log, but they are normal in this case. The log will also have a message similar to: Configuration Page 46 of 82

47 BKUP-W-0363 Backup window expired, intra-file defer. All object related errors after this line may be safely ignored, since the object that was deferred will be backed up during the following Backup. Fields for Synchronize: Job Name Select a Job name that you have previously defined. Command Cycle Weekly, or Monthly. Minutes/Hours Time to start. Days of week Which days the Job will run. Fields for Custom: Job Name Select a Job name that you have previously defined. Custom Command - <enter an IBM i command> Command Cycle Weekly, or Monthly. Minutes/Hours Time to start. Days of week Which days the Job will run. Configuration Page 47 of 82

48 2.5.2 Change a Schedule Figure Work with Schedules Change These fields are the same as Create Delete a Schedule You may want to delete a schedule if it is no longer being used, or is associated with any existing Jobs Enable/Release This turns off the Disable/Hold function and allows a Job to become active in the IBM i job queue Disable/Hold A scheduled Backup may be paused by holding it in the queue. You may want to do this depending on your system status, or its activity, or if there are known problems or conditions which would cause the Backup to not be successful. It will stay disabled until you release it. Configuration Page 48 of 82

49 3 Backup Jobs Once all the Agent Configuration information has been entered, and a schedule set up, as in the previous chapter, the Backups will take place automatically. Note: The initial Backup is a seed. This first time, the Backup will copy everything that you had selected (in a compressed format) to the vault. The next Backup time (with the same files and directories) it will only copy the parts that have changed. Each time that it does this, the vault knows which parts are new, and which haven t changed, so that when you do a Restore, it supplies everything back to you, and it is all up to date. This functionality means that you don t waste time and bandwidth copying data that has not changed. You can see the results of this in the Backup log file, where the actual data copied is less than the data in the files. On occasion, you may need to run a one-time Backup for a special reason. You can either use an existing Agent and Job (and modify it) or create one specifically for this Backup. Figure Run Backup Job Name Choose an existing (previously configured) name. Retention Scheme Choose an existing (previously configured) name. Quick File Scanning NO or YES. This option is used to reduce the amount of data read during the Backup process. Any file streams that are deemed unchanged since the last Backup are skipped over. *YES is highly recommended, and is selected by default. Disable Deferring NO or YES. If the Backup takes longer than the Backup window time frame, it can be deferred (paused) until the next scheduled Backup period. Disable Deferring NO. The Backup will run until the Defer after time is reached. The Backup will pause until the next scheduled Backup time. You would use this, for Backup Jobs Page 49 of 82

50 example, for a large Backup (i.e.: an initial seed) that might take several scheduled periods, and you do not want the Backup to run during times when the machine is needed for regular work. Disable Deferring YES. The Backup will run until it finishes, even if it runs into the time period of the next scheduled Backup. If you use Yes here, you will not see the Defer after option. Defer after Choose a value from 15 to 2880 minutes, with the default being 480. After this time expires, and if the Backup is not finished, the Backup will pause until the next scheduled Backup time. Backup Jobs Page 50 of 82

51 4 Hot Backup There are two methods for Hot Backups provided in this release of the IBM i Agent: Journaling and Triggers. These are outlined in the following sections. 4.1 Journaling Note: Refer to the IBM i user guide to setup journaling on the database if the database is not currently journalled. It is recommended to create a single journal per library to be backed up to simplify administration and place the journal and receivers in that library. Create the main Job to Backup all user objects and data and specify two exclusions for *JRN and *JRNRCV object types. Specify *SYSDFN in the save active parameter. Create two additional Jobs: one for *JRN and one for *JRNRCV object types. The proper sequence for running the Jobs is very important. Thus, they should be submitted to a job queue that allows only one active Job. Backup The Backup sequence is: First, run the main Backup Job Second, run the *JRN Job Third, run the *JRNRCV Job If this sequence is not done correctly, and updates occur to data while the Backup is running, then some journal receivers might not contain all the required data for point in time recovery. Restore The Restore is performed in the reverse order of Backup: First, run the *JRNRCV Job Second, run the *JRN Job Third, run the main Restore Job If this sequence is not followed, then some objects might not be journalled after the Restore. Hot Backup Page 51 of 82

52 4.2 Triggering The version 6 IBM i Agent supports hot Backup features to snapshot native data physical file (PF-DTA) by using triggers. Under this feature, the Agent is able to save database changes that were made while the Backup is running, and also can revert those changes back to the point of Backup startup. Triggering Setup When you choose the save active *TRIGGER setting in Job configuration, Backup triggers will be added to PF-DTA objects which are contained in the Job include list. During creation or changing an *OBJ Job with the *TRIGGER setting, a confirm screen will be shown. Figure Triggering In this screen you would see a list of objects with trigger status. The F7 function key can let you switch the screen to show all affected objects or those that will be changed in the current operation. Trigger Status: To be applied: Trigger will be applied to the object. Applied: Attempting to apply trigger to which has been applied in previous operation. To be removed: Trigger will be removed from the object. Hot Backup Page 52 of 82

53 Removed: Attempting to remove trigger from which has been removed in previous operation. Users can choose YES to confirm the changes, or press F3 to exit the configuration. Restrictions 1. Only physical database files are supported. Physical source file, logical file, save file and device file are excluded. 2. Supported database files cannot contain the following columns: a. CLOB b. BLOB c. DBCLOB d. ROWID e. Data link Hot Backup Page 53 of 82

54 5 Automatic Job Creation 5.1 Introduction Automatic Job Creation can create multiple Jobs for backing up all libraries except for the excluded libraries selected by the user. Creation of multiple Jobs enables effective utilization of CPU cycles, hence faster Backup processing. The Automatic Job Creation Tool is used by customers who wish to perform a Backup of the entire IBM i system. The Jobs created by the Automatic Job Creation Tool have the capability to Backup any libraries that may be created in future. The Automatic Job Creation Tool is a one-time use tool. Once used for creating the most appropriate Jobs, the tool cannot be used for a second time. 5.2 Job Creation Main Menu Figure Job Creation Main Screen 1. Create Database: This creates the Job Creation Database, which contains the information about all the libraries and objects inside the libraries present in the system, and also the size and count of the objects that reside in each library. 2. Library/Job Selection: This allows the user to exclude libraries and select/assign the libraries to different Jobs to be created by Job creation. Automatic Job Creation Page 54 of 82

55 3. Retention Schedule: This allows the user to schedule the retention schemes like weekly, monthly etc. Also, the options for deferring and quick file scanning can be specified here. 4. Retention Job Selection: This allows the user to assign the defined multiple retention schemes to Jobs created by Job Creation and create auto scheduler entries for Backup. 5. Create Jobs: This allows the user to select the vault and create the Jobs with default parameters. 5.3 Library/Job Selection Exclude Libraries Figure Exclude Libraries This is the first screen of the Job Creation Tool. You can enter the libraries to be excluded from the Jobs. The excluded Libraries are not shown as selected on the Libraries selection screen. F2: Saves the libraries to be excluded. F3: Exits from Exclude Libraries screen. F6: Displays the select libraries screen. Notes: 1. If the libraries are not saved, they will not be excluded from the library selection. Automatic Job Creation Page 55 of 82

56 2. Wild card characters e.g. A*, B* etc. are not supported while specifying the library names Select Libraries Figure Select Libraries The above grid displays the Jobs as column headers and the list of all libraries as row headers. Symbol _ indicates the particular library is not included in the respective Job. Symbol X indicates the particular library is included in the respective Job. For example, in the above screen #COBLIB library is included in Job J1. 1. Job Limit: Indicates approximate Jobs to be created by the Job Creation Tool. This parameter can be changed by the user, as required. By default the value will be number of CPUs (including LPAR CPUs) X 4. In case the number of CPUs is not retrievable, it is defaulted to 1 by the Job creation. 2. Object Size/Job: This is the optimal object size per Job as calculated by the Job Creation Tool. There can be instances where the size of the Job can be greater or less than calculated value of object size/job. 3. Object Count/Job: This is the optimal object count as calculated by the Job Creation Tool. This is shown in multiples of There could be instances where the count of the objects is greater or less than the calculated value of object count/job. 4. Include Libraries: Here the user can enter X against the libraries that need to be included during Backup. By default all the libraries will be selected. However the libraries starting with Q except QSYS, QGPL, and QUSRSYS will not be selected. If other such libraries are selected those will be included. Automatic Job Creation Page 56 of 82

57 5. Total Object Size: This is the size of all the Libraries (Including the objects inside libraries), which have been selected for Job creation. 6. Total Object Count: This is the count of all the objects, which have been selected for Jobs. This is shown in multiples of You have an option to edit exclusions and inclusions on this screen. Figure Adjust Include/Exclude List Upon pressing F6, the above screen appears. When the Include/Exclude count of one or more Jobs exceeds 128, the user is prompted to choose whether to let the Job Creation Tool reshuffle the libraries in order to limit the include/exclude list. By providing Y you can let the system reshuffle the include/exclude count. By providing N you can come back to the original screen and increase/decrease the number of Jobs in order to bring the include/exclude count to less than 128. There could be instances where even the system will not be able to make the Include/Exclude count lesser than 128. In such cases, the user can manually decrease the count of Jobs and retry. F2: saves the changes made on the current screen. F3: Exit from the screen. F4: Recalculates the parameters and arrangement of libraries and Jobs. F5: Replaces the current screen with original arrangement of libraries and screen values. F6: Creates Include and Exclude list for the Job creation. F7: Previous screen to see previous Jobs F8: Next screen to see more Jobs Automatic Job Creation Page 57 of 82

58 F9: Sorts the Jobs alphabetically. F10: Sorts the Jobs on size in descending order. F11: Displays the list of Job names with their include/exclude count. Notes: 1. The changes in library selection must be saved on the same screen itself. 2. Once the user changes any of the first three parameters mentioned above, pressing F4 recalculates the other two parameters and the arrangement of libraries and Jobs. 3. In case of Include or Exclude count goes beyond 128 the system throws an error. The user can change the input criteria, recalculate and create new list or Job Creation Tool can reshuffle the library/job selection to reduce the Include/exclude count to Object size/job when adjusted, is truncated to a lower integer. e.g. 0.22, 0.45, 0.9 etc. are shown as 0 1.3, 1, 7, 1.9 etc are shown as Object count/job, when adjusted, is truncated to a lower integer. e.g. 0.3, 0.5, 0.9 etc. are shown as 0 1.2, 1, 5, 1.8 etc are shown as Unless the database is created, the user cannot work with this option Include/Exclude List Figure Include/Exclude List The above screen shows the Job names. The Job names are formed with the first character of the include/exclude library names. Libraries starting with A will be included where the maximum number of libraries starting with an A are found and so is the case for all other libraries except Q. Libraries Automatic Job Creation Page 58 of 82

59 starting with Q will not be included as generic Q*. The Exclude list does not support the use of generic library names like A*. Notes: 1. All the special #, $, / are replaced by $ in Job names. 2. If the user manually deselects all the libraries from the Job, that Job will be listed as blank on this screen. 3. Once the user finalizes the include/exclude list, he/she has to go to auto Job menu by pressing F3 thrice. 4. Considering the Backup of future libraries the generic include for A* to #*, $* and /* except Q* will be added in different Jobs. 5.4 Retention Schedule Figure Retention Schedule Once the user creates the Jobs, he/she can proceed with Retention Scheduling. All the retentions are retrieved from the Agent repository (Global.vvc) file. Retention: Retrieves the retentions from the Agent repository (Global.vvc) file. Period: Period will be *WEEKLY or *MONTHLY Days/Month (MTWTFSS/1-31): This can be any day from Monday to Sunday or the dates from 1 st to 31 st and also*first, *Last. Example: If you want to run the Jobs on Tuesday, Thursday and Sunday, you should enter _T_T S. Time: The time in Hour and minute. The Hour is in 24 hours format HH:MM. Quick Scan: This can be *YES or *NO. *YES for any file streams/objects that are deemed unchanged since last Backup are skipped over. Automatic Job Creation Page 59 of 82

60 *NO for all the objects will be considered for back up. Defer Disable: This can be *YES or *No. *YES: The back up will run until it finishes. *NO: The Backup will run until the Defer after time is reached. The Backup will pause until the next scheduled back up time. Defer Time: This can be any number in minutes. You can choose a value form 15 to 2880 minutes. After the specified time expires and if the Backup is not finished, the Backup will pause until the next scheduled Backup time. If Disable Defer is *YES, this time is not required. F2: Saves the entire retention schedule with the input parameters. F3: Exit from Retention Schedule screen. Notes: 1. If retentions are deleted from the Agent, the deleted retention will still be shown on the Retention Schedule screen. 2. The retention length shown here is of 31 characters, although the maximum Retention length allowed is of 32 characters. 3. You cannot work with this option while the database creation is in progress. 5.5 Retention Job Selection Figure Retention Job Selection After creating the Jobs, the user needs to select a retention for the Jobs. For this, the user should enter X in order to select a retention type for a particular Job. In the Retention Selection screen the user assigns the retention schemes to the Jobs that are created. Automatic Job Creation Page 60 of 82

61 Retention (Ret): This screen shows a matrix with the retention schemes as the rows. Job: On the screen matrix s columns header are Jobs.J1-J99 F2: Saves the current configuration for the selected Retentions F7: Moves to the previous page. F8: Moves to the next page. F9: Creates Scheduler F12: Cancels the Retention selection. The current changes after last Save (F2) will not be saved. F3: Exit from Retention Selection screen. Notes: 1. The configuration on each page should be saved before moving to next page or previous page. 2. The screen shows only first ten characters of the retention name (due to lack of space). 3. Unless the Jobs are created, the user cannot work with this option. 4. The limitation of the screen is to show only first 10 characters out of 32 characters of retentions (due to lack of space). Note: Adding a retention and deleting a retention: If you have created a retention (after database creation) and then delete the retention, the deleted retention will still be displayed (option 3). 5.6 Job Creation: Create All Jobs Figure Create Jobs Automatic Job Creation Page 61 of 82

62 Here, the user can create the Jobs that were formed in the Select Libraries screen. In this screen you have to select the vault that you need to Backup the data to. By pressing F4, the screen for entering the vault name is displayed. The user can get the list of the available vaults by pressing F4 again Default Parameters Recursive (*YES): Take all libraries and all their contents (objects). Save savefile data (*YES): Take contents of save file or just header information Save active: *NONE (specify a wait time.) Save active /trigger wait time (120): The trigger will retry for active/backup wait time for this retry period. Trigger retry period (3600): The trigger will retry for active/backup wait time for this retry period. Encryption (Type and Password): Encryption Type and Password details. Encryption type: *NONE New password: (Blank) New password (to verify): (Blank) F2: Saves the user s selection. F3: Exit from the Create Jobs screen. F5: Refreshes the screen. F6: Creates the Jobs with current parameters. This will take some time (5-10min) F11: Shows Display Job name screen, which shows the Job names along with their include/exclude count. F12: Cancel. Notes: 1. The vault name that is provided must be correct because once the tool runs, even though Job creation fails, the user cannot come back to this screen to re-create the Jobs. 2. Unless the database is created, the user cannot work with this option. 3. The behavior of Jobs created by the Auto Job Creation Tool, for which a Backup has not yet been run, will be the same as normal Jobs after re-registration. Automatic Job Creation Page 62 of 82

63 6 Restore Jobs Figure Run Restore After a Backup (scheduled or ad hoc) you can check the results for success, or any possible errors. Note that you may have chosen, in Agent Configuration, to be notified by of successful and/or failed Backups. Job Name This name will show in the batch queue. Safeset Number , or *LASTONLINE. LASTONLINE represents the latest (most recent) Backup. Data Type Select one of the types of data included in the Job configuration: *OBJ, *IFS, *SYS OBJ Libraries and objects in native system. IFS Folders and stream files in Integrated File System. SYS System state data that contains system security data (SAVSECDTA), configuration objects (by SAVCFG command) and system values. Restore Jobs Page 63 of 82

64 6.1 For Data Type OBJ: Include objects - Specifies a list of up to 128 entries of native objects that you want to Restore. Name - Object name. Generic* and *ALL can also be used to group a set of objects. Library - Specific library name, or use QSYS to include all libraries in native system. Type - Specifies the types of system objects to save. *ALL means all types of object will be restored. File member - Specifies the database file members that are restored. Generic* and *ALL can also be used to group a set of members, or *NONE to Restore the file object only. Exclude objects - Specifies a list of up to 128 entries of native object that you don't want to Restore. Name - Object name. Generic* and *ALL can also be used to group a set of objects. Library - Specific library name or use QSYS to include all libraries in native system. Type - Specifies the types of system objects to save. *ALL means all types of object will be excluded. File member - Specifies the database file members that are being excluded. Generic* and *ALL can also be used to group a set of members, or *NONE to exclude the file object only. Restore Library You can Restore to the original source library, or a different one. Note: Restore Database Performance. When restoring a database, performance will be enhanced if the database does not already exist in the destination location, as the replace operation is more time consuming. Note: When restoring database files, the user MUST specify *FILE in the type field and the object name itself should be a specific name (not a wildcard name). In other words, the include should be something like /QSYS.LIB/SOMELIB.LIB/./SOMEFILE.FILE. The Agent will then automatically append the following line in the vpr file to restore the members: /QSYS.LIB/SOMELIB.LIB/SOMEFILE.FILE/*.MBR. The Vault does not support wildcards at the folder level. Overwrite/Rename Includes File Overwrite and Rename options for existing objects. See section Ignore security data Allows you to switch on or off the granting of private authorities on an object after it is restored. *YES here means the security data would be ignored, and the GRTOBJAUT command would not execute. *YES is recommended when doing DR to improve Restore performance. Private authorities would be set at the end, when the user runs the RSTAUT command. Restore threads Specifies how many threads/jobs (1 to 8) to run concurrently for restoring objects that were saved via save files. A higher value will improve Restore times, as more objects can be restored concurrently. This parameter is related to the "Small Object Size" parameter. Log Detail This option specifies the amount and type of Backup details to be included in the log files. Choose File, None, Summary, or Directory. Restore Jobs Page 64 of 82

65 6.2 For Data Type IFS: Include IFS stream files - Specifies a list of up to 128 entries of IFS paths that you want to Restore. Absolute path - specifies the absolute path name of the stream files saved on the vault. File - The files in the specified directory are restored. Recursive - Specifies whether sub-directories are included in the Restore. Exclude IFS stream files - Specifies a list of up to 128 entries of IFS paths that you don't want to Restore. Absolute path - specifies the absolute path name of the stream files saved on the vault. File - The files in the specified directory are being excluded. Recursive - Specifies whether sub-directories are also excluded in the Restore. Destination - You can Restore to the original *SOURCE directory, or a different one. Only an absolute path is allowed. Create sub-file - Selecting *YES will recreate the restored file structure like the Backup structure. Selecting *NO will put everything into the top level, with no sub-files. Log Detail This option specifies the amount and type of Backup details to be included in the log files. Choose File, None, Summary, or Directory. 6.3 For Data Type SYS: System states - Specifies the type(s) of system data to Restore: *ALL, *CFG, *USRPRF, *SYSVAL (*SYSVAL in this case means the actual system values). Note: If you use RSTUSRPRF and RSTCFG commands to individually Restore *USRPRF and *CFG data, and you Restore a non-existing user profile, the new (restored) profile is created without its password or group connection. You must reset them. Prompt RSTxxx command - When set to *YES the Agent will prompt for individual Restore commands. This is useful when doing DR to different hardware, and you need to exclude certain configuration objects and/or user profiles. For *NO, the Agent would Restore all selected data without prompting. Note: With *YES, if you do not input the correct parameters in the system commands, the commands will fail. For example, if you input an incorrect or non-saved User Name, the RSTUSRPRF command will exit with an error in the log file. Log Detail This option specifies the amount and type of Backup details to be included in the log files. Choose File, None, Summary, or Directory. Restore Jobs Page 65 of 82

66 6.4 System State Restores 1. Note that an OBJ or IFS Restore can be done from a terminal session. A SYS Restore must be done from the console in Restricted state. 2. The user does not need to put the system into "Restricted" state manually. If the Agent is run from the server console, the application will put the server into "Restricted" state automatically and then proceed with the system Restore. 3. Once the system state Restore completes, the user needs to manually re-start the subsystems. 4. After a system state Restore, a special log file is generated (for example: SYS ). If a user wants to check the errors reported in this log, the errors are present in the spool file (using the command WRKSPLF). Restore Jobs Page 66 of 82

67 7 Recovering the System Bare Metal Restore In the event of a system disaster (crash) where the source (IPL) disk is lost, you will need to recover/rebuild the system, from the ground up. The steps in this are: 1. Re-install the O/S and licensed internal code on the new hardware/system from CD s or SAVSYS tape. 2. Load any recent PTF s if there is no recent SAVSYS tape. 3. Create TCP/IP connectivity to the LAN/WAN. TCP/IP is generally included in the OS/400 install, but if TCP/IP is not included, a separate TCP/IP utility installation is necessary. 4. Install the IBM i Agent. 5. Re-Register the new Agent with the Vault to recover the global and Job files back to the Agent on the new system. This tells the Vault (by the Account, User Name and Password combination) that you are authorized to get the old configuration files back. Note: If this is the same system as before the old license will be valid, however if this is a different system, a new license is required. Contact your Service Provider for a new license. 6. Restore the *SYS Backup (System State) if there is no recent SAVSYS tape. 7. Restore *IBM 8. Restore *ALLUSR 9. Restore user data. Run RSTAUT command to apply private authorities. Recovering the System Bare Metal Restore Page 67 of 82

68 8 Installation Procedures There are two methods to obtain and install the IBM i Agent. Install from a CD Download from the FTP site and unzip the Agent 8.1 Communication / Pre-Installation Requirements There is an IBM OS bug on the network interface where the 100 Mbit interface can degrade to 0.4 Mbps. WORKAROUND: Use *AUTO on the DUPLEX parameter on the CHGLINETH command to solve the problem. Please perform a FTP transfer test to and from the IBM i to a local PC and ensure the network is running optimally. We also recommend the following values for optimal network performance. On the Ethernet line desc (description) set these values: GENTSTFRM(*NO) LINKSPEED(100M) LINESPEED(100M) DUPLEX(*AUTO) On TCP/IP interface: TOS(*MAXTHRPUT) On TCP/IP Route: TOS(*MAXTHRPUT) Note: System requirements: Install the latest cumulative, hyper, and group PTF's (program temporary fix) from IBM. 8.2 Method 1 - Install from CD Installing the Agent from a CD: 1. Download the CD image files from the Service Provider s website. 2. Unzip file to temp folder. Note that the extracted from zip file is AS400AGENT.iso. 3. Create install CD from AS400AGENT.iso file. (Refer to 3 rd party CD burner document.) 4. Insert CD into IBM i CD-ROM 5. LODRUN DEV(Optical-device). Be sure the optical device is active. 6. A setup screen will appear. Advance to section 8.4 Agent Setup Installation Procedures Page 68 of 82

69 8.3 Method 2 - Agent Installation from FTP This section describes the steps required to obtain and install the IBM i Agent from the FTP site. Step 1: Download From an Internet browser, access your Service Provider s web site, and find and download the Agent file(s). Download the following to PC-location: (example C:\ or C:\Temp) AS400AGENT.zip IBM i Agent Agent_IBM_i.pdf User s Guide Agent_IBM_i.txt Release Notes Step 2: Unzip WinZip or similar software would be required to unzip the file. WinZip can be downloaded from: Unzip the AS400AGENT.zip to C:\ or C:\Temp or some easily accessible location. The next step is to FTP the file to the IBM i from command line so you don t want to use long path names. Note that the file extracted from the zip file is AS400AGENT with no extension. This file contains the IBM i binary save file data. An IBM i save file is similar to a ZIP file on a PC, in that it is a binary file that contains many other objects. Step 3: Create Temporary Install Library on IBM i Logon to IBM i using 5250 terminal session (a.k.a. Green Screen command line) with QSECOFR or equivalent user ID. If you don t have QSECOFR level authority then ask the system administrator to run the following steps. Create a library on the IBM i to contain the save file with following command: CRTLIB EVSAVE (note that the library can be called anything up to 10 characters: system limit) Step 4: FTP In Windows, open an ftp window by clicking on Windows > Start and then click on Run Type FTP x.x.x.x (where x.x.x.x is your IBM i IP address) in the input box for Open: and then click on the OK button. You will be prompted for user id. Type your IBM i user id and press enter. Next, the password prompt will appear. Type your IBM i password and press enter. Type BIN and press enter. Type LCD C:\Temp (or wherever the AS400AGENT file was unzipped too) and press enter. Type put AS400AGENT /QSYS.LIB/EVSAVE.LIB/AS400AGENT.SAVF and press enter. Note that this is the IFS format name and.lib is added to the Installation Procedures Page 69 of 82

70 EVSAVE library that was created earlier. If the library created is named differently, then you need to add the.lib here for the command to work. When the ftp completes, you can type quit and press enter to close the window. Step 5: Restore Objects Return to the IBM i terminal session. Execute the following command. Replace EVSAVE with the library name you have created and press enter to run the command. RSTOBJ OBJ(*ALL) SAVLIB(TESETUP) DEV(*SAVF) SAVF(EVSAVE/AS400AGENT) MBROPT(*ALL) ALWOBJDIF(*ALL) RSTLIB(EVSAVE) (and press enter). Move the cursor to the message at the bottom of the terminal screen, press F1 then F10 to jump to the Display All Messages screen. If the command executed successfully, then you will see the message XX objects restored. 0 not restored to EVSAVE below the RSTOBJ command. Step 6: Run Setup Execute the following command. Replace EVSAVE with the library name you have created and press enter to run the command. CALL EVSAVE/ISSETUP (and press enter). Note that EVSAVE is user defined. As shown (next page: Figure 26), a setup screen will appear. Replace EVSAVE with the library name you have created. You may use the default product library and directory, or change it if you prefer to use other names. Advance to section 8.4 Agent Setup Installation Procedures Page 70 of 82

71 8.4 Agent Setup Figure Agent Setup If installing from SAVF, the user must call the ISSETUP program through the command line. But the if user installs from the CD, the LODRUN command will call the ISSETUP program automatically. Through the ISSETUP program, the user is able to install the new Agent, upgrade or remove an existing Agent. The F1 function key can lead the user into the help panel. Installation Procedures Page 71 of 82

72 8.4.1 Install New Agent On the setup screen, the F6 function key is used to install a new Agent. On the Install Agent screen, the user can input the expected Agent library and directory, or press enter to install the Agent into the default BUAGENT library and /BUAgent directory, or press F3 to go back to the setup screen. Note: The New installation is only permitted on a system that does NOT currently have an IBM i Agent. F6 will be prohibited if another Agent has been installed on the current system. Figure Install New Agent Installation Procedures Page 72 of 82

73 8.4.2 Upgrading an Existing Agent The ISSETUP program will list all of the existing Agent(s) on the system. Option 6 is used to upgrade an existing Agent. The user is allowed to perform an upgrade if the current system contains only one Agent. If more than one Agent has been previously installed in system, option 6 will be prevented. (for example, trying to run two Agents). Figure Upgrade Existing Agent Note: You may see install program errors when you upgrade an Agent using Agent profile. You cannot use the Agent profile during an upgrade. You must logon with "QSECOFR" level user ID to upgrade the Agent. Installation Procedures Page 73 of 82

74 8.5 Verify After the SETUP has occurred, check the following items: Check that the product library (for BUAGENT or Client defined name) exists. o Example: WRKOBJ *ALL/BUAGENT would list BUAGENT *LIB on the Work with Objects screen. (Page Down if the list is long). Check that the product directory (for /buagent or Client defined name) exists and that the Global.vvc file is in that directory. o Example: WRKLNK /BUAGENT would list BUAGENT DIR on the Work with Object Links screen. Type option 5 to display Global.vcc STMF within the BUAGENT directory. Check that the user profile AGENT exists. o Example: WRKUSRPRF AGENT would list AGENT on the Work with User Profiles screen. Check that the subsystem AGENT is available. o Example: WRKSBS would list AGENT on the Work with Subsystems screen. (Page Down if the list is long). Type WRKACTJOB to work with active Jobs and see if the subsystem AGENT is displayed, meaning it s active. 8.6 Use IBM i Agent Type GO BUAGENT/ISAGENT and press enter to invoke the main menu of the IBM i Agent. If you change the BUAGENT name in the previous SETUP routine, then replace BUAGENT with the name you used. User Profile AGENT is included in the installation. After a successful setup, AGENT can be used as both a User ID and as a password. This allows the User to be automatically directed to the IBM i Agent main menu screen. Changing your password can significantly increase protection against unauthorized use of your User ID. It is strongly recommended that if the password for the AGENT User ID is also AGENT, then the password should be changed as soon as possible to enhance security. 8.7 Obtain and Install License The Agent does require a license to function properly, after the thirty-day trial expires. To back up to, and Restore data from a Data Protection Vault, a valid account, username, and password are also required. Contact your Service Provider to obtain the required information. To obtain the license you will require the following information: IBM i Serial Number Software Group (i.e. P20) This information can be obtained from the Work with Agent Licenses menu. Upon obtaining your license, you must also input and validate the license key from the Work with Licenses screen. Press enter to validate your license. Installation Procedures Page 74 of 82

75 8.8 Agent Uninstall The uninstall differs slightly depending on whether you have installed the Agent from a CD or downloaded from the FTP site Uninstall (When installed from FTP) CALL Restore-library/ISSETUP User-Defined Library Program Note: The User-Defined Library here is the one you used for setup. (For example, see section 8.3, where it was called EVSAVE.) Option 4 is used to perform an uninstall of existing Agent components. Once the user enters option 4, a remove confirm screen will be shown to make sure the user does really want to remove the selected Agent. The user must key in YES to confirm the operation. Figure Uninstall Agent Installation Procedures Page 75 of 82

76 The uninstall operation removes the following components: Product library (i.e. BUAGENT or other name from client). Product directory (i.e. /BUAgent or other name from client). Scheduled Jobs (i.e. Agent associated scheduled Jobs if it s the only existing Agent). Applied triggers (i.e. Agent associated triggers). AGENT subsystem AGENT user profile (if it s the only existing Agent) Uninstall (When installed from CD) As the EVSAVE library is not defined by the user during the install process, it is not needed. Before the uninstall, the user should run the same command as for the installation of the Agent from CD: "LODRUN DEV(optical_device)", instead of "CALL Restore-library /ISSETUP". The other steps that follow are the same for uninstallation. See the steps above in section Installation Procedures Page 76 of 82

77 9 Additional Information 9.1 Synchronize What does Synchronize do? It compares and updates (synchronizes) the remote Vault files to the local safeset catalog files. It can also delete any catalog files, which are no longer required/used. Typically, a user would run the Synchronize command to ensure that the latest Backup is available for an immediate Restore. Figure Synchronize The Synchronize Job is submitted to the Agent System with the message: Synchronize Job <name> has been submitted to the AGENT system. F4 will show a list of all your existing Jobs Delta File Recreation Delta file recreation allows the user to rebuild a DTA (delta) file by using Job Synchronization. Originally (before delta recreation), if the Backup detected that the required DTA file was missing or corrupt, the Backup was forced to reseed. With the delta recreation feature, on a missing or corrupt delta file the Job fails and logs a message. Then the user is able to rebuild the DTA file through Job Synchronization or alternately by CLI. One method to recreate a DTA file is to re-register the Agent and then Synchronize the Job. This should recreate the DTA file so a Backup can be run. Additional Information Page 77 of 82

78 In case of a failure in rebuilding a delta file, the alternative approach to rebuild the delta file is by reseeding. The parameter will only apply to CLI. The UI will not be affected. With this parameter, if the Vault supports delta recreation, and the recreated file is unusable, then the Backup will be forced to reseed (forcereseed). The syntax of this parameter is: VV Backup job1 /param=job1.vpb /forcereseed Note: Delta files can only be recreated if a Backup was done by a version 6 Agent to a version 6 Vault. If you Backup a safeset using a version 6 Agent to a version 5 Vault, and then upgrade the Vault to version 6, any delta information cannot be recreated. If you Backup a safeset using a version 5 Agent to a version 6 Vault, and then upgrade the Agent to version 6, any delta information cannot be recreated. In these cases it will report errors in the Restore log that the DTA recreation failed, on the version 5 files. The Restore itself will still function properly. In this case you can use the forcereseed option to create new delta files that are compatible with the version 6 Vault. 9.2 IBM i Best Practices Typical IBM i users run system save 21 (full system save) once a week or once a month for DR purposes, which can cause the system to be down for several hours. After switching to Agent Backup, we recommend doing system save 22 (system data only) instead. As, save 22 only saves the OS and license programs, it runs much faster than the save 21. Also, because the Agent saves system state information (security data, configuration data and system values) and can do so while the system is running, one would only need to run the save 22 when ever PTF s are loaded. Following these recommendations, system down time can be reduced from a couple of hours per week, to maybe one hour every 3 or 6 months, depending when PTF s are loaded. The IBM i Agent supports *IBM special value to Backup licensed programs. However, if save 22 is performed to Backup the OS and licensed programs, then it is not needed to create a Job to Backup *IBM since save 22 already includes this. The IBM i Agent does support *ALLUSR special value to Backup all user libraries. However, because the Agent is not limited to a single device, it is recommended to divide up user libraries into several Jobs to get the best performance. The general recommendations are: Create 3 or more Jobs per available cpu. In general for *OBJ Jobs try to keep total object count per Job below 10,000. Create separate Jobs for volatile objects like databases, journals receivers, etc and for non-volatile objects like programs, service programs etc. (even if they reside in the same library). This is easy to do with the include and exclude features of the Agent. Additional Information Page 78 of 82

79 If using Save 22 then ensure QUSRSYS and QGPL is saved and Restore from tape before starting the Agent. It is recommended to exclude QMPGDATA (Performance Data Library) from *ALLUSR Job in backups/restores. Sample of *ALLUSR Restore log when library not excluded: July28 14:22 DISK-W-0002 Error 3029 trying to lock mutex July28 14:22 DISK-W-0002 Error 3027 unlocking mutex July28 14:23 REST-W-0002 CPF3761 Cannot use FILE QAPMETH in QMPGDATA. July28 14:23 REST-E-0003 CPF3770 No objects saved or restored for library QMPGDATA. July28 14:23 NONE-E-0003 Command exception occurred using QaneRsta API. July28 14:23 DISK-F-0052 error closing file /QSYS.LIB/QMPGDATA.LIB/QAPMETH.FILE, ThreadApi failed to close ec28 14:23 REST-I-0367 original name /QSYS.LIB/QMPGDATA.LIB/QAPMETH.FILE July28 14:23 REST-I-0016 created /QSYS.LIB/QMPGDATA.LIB/QAPMETH.FILE 24,592 July28 14:23 DISK-E-0003 Error CPF3156 clearing data member July28 14:23 DISK-F-0049 error opening file /QSYS.LIB/QMPGDATA.LIB/QAPMETH.FILE/Q MBR for output July28 14:23 DISK-W-0002 Error 3029 trying to lock mutex July28 14:23 DISK-W-0002 Error 3027 unlocking mutex July28 14:24 REST-W-0002 CPF3761 Cannot use FILE QAPMHDWR in QMPGDATA. July28 14:24 REST-E-0003 CPF3770 No objects saved or restored for library QMPGDATA. It is recommended NOT to run *SYS Backup and *ALLUSR backups at the same time. If *SYS Backup and *ALLUSR backups are running at the same time, you may receive various mutex errors in the *ALLUSR Backup log as some objects may be locked while the other process times out. Note that *SYS only runs a few minutes and can be run first. Additional Information Page 79 of 82

80 10 Index #COBLIB...56 *ALL...34 *ALLUSR...34 *IBM...34.XLOG to.log file Account Name...15 ad hoc...45, 63 Adjust Include/Exclude List...57 Administrator...10 Advanced Encryption Standard...25 AES128 encryption...35, 36, 37 AES Agent Configuration...63 errors...10 log file...10 software...7 ALLOBJ rights...9, 45 Archive Backup...20 Archived status...41 AS/400 Agent...7 Authorities List...37 Automatic Job Creation...12, 54 Backup data...7 Database Type...39 forced to reseed...78 logs...42 Time...41 Type...41 window expired...47 Backup.log...46 Backup/Restore Priority...29 Bandwidth Throttling...23 batch Job...7 Block Processor threading...26 BLOWFISH encryption...35, 36, 37 BLOWFISH Catalog files...77 Number...41 CLI...12 Combined threading...26 Command Cycle...46, 47 CommonFiles...8 Compressed...41 Compression Types...28, 35, 36, 37 Configuration Objects...37 convert.xlog file...43 Create Database...54 Create sub-file...65 Custom Command...47 Data Protection Vault... 7 Type... 33, 63 Database Triggers... 9 Days of week... 46, 47 DBFiles... 8 Default Parameters Defer Disable Deferring...35, 36, 37, 46 Delta after seed... 9 file missing or corrupt recreation Delta File Recreation DES , 36, 37 Destination Disable CRC Option Disaster Recovery... 9 disk ID and system name DNS name Do not overwrite Existing Files (NOOVRWRT) 22 DTA file addresses notification... 30, 63 Encrypted safeset detail encryption on backups...35, 36, 37 type... 8 Encryption (Type and Password) Encryption Options Essential Settings Exclude IFS stream files... 36, 65 Objects Exclude Libraries Expiry F1 function key FASTERRST Compression Field level help Forcereseed From Address generic name Global and Job configuration files help screen HLD Hot Backup... 9 IBM Advanced Scheduler IBM LZ1 Compression Ignore security data Include IFS stream files... 36, 65 Objects Include Libraries increase the Restore speed Internet... 7 IO or API Index Page 80 of 82

81 IP address...8, 14 IPL...67 ISAGENT...11 iseries Agent...7 ISO image...9 Job ID 39 Name...33, 41, 46, 47, 49, 63 Synchronization...77 Job Creation Database...54 Job Creation Tool...54 Job Creation: Create All Jobs...61 Job Limit...56 Journaling...9 Library/Job Selection...54 License Key...31 Load and Run...9 Location...41 Log detail...42 Detail...37, 64, 65 Log Detail...35, 36 logfile display...42 main menu...12 Maximum Block Processor Threading...27 Media Type...41 Minutes/Hours...46, 47 Miscellaneous Settings...13 multi-threading...45 Multi-Threading and Multi-CPU...26 Network Address...16 no database activity...35 Object Backups...39 name...34 Object count/job...56 Object Size/Job...56 Objects save/restore...8 Online copies...20 days...20 Helps...10 status...40 Optional Settings...21 overwrite any existing Jobs...17 Overwrite Existing Files (OVRWRT)...22 Overwrite/Rename Options...21 password Backup encryption...35, 36, 37 Verify Password...15 Performance...26 Permissions...8 Port Number...16 Pre and Post command...9 private authority...10 Prompt RSTxxx command...65 Prompt Before Overwrite Existing Files (PMTOVRT)...22 QSYS...34 Quick File Scanning... 35, 36 Quick Scan RCLRSC command Rebuild a delta file Recipients Reconnect delay seconds Register... 8 Register.log Rename Existing (RNMEXT) Rename Incoming (RNMINC) Re-Register...9, 17, 67 reshuffle the include/exclude count Restore Database Performance Jobs Library logs Restore log delta recreation failed Restricted Retention Name safeset detail Scheme... 46, 49 Retention Job Selection... 55, 60 Retention Schedule... 55, 59 Retention Selection Retry Timeout seconds safeset number numbering version Save active Save active /trigger wait time (120) Save Active/Trigger Wait Time Savefile data SCD seed... 9 Select Libraries Server information Service provider Signoff Signon simple Backup Single threading Small Object Size SMTP Server special characters standard job scheduler Status... 40, 41 Storage Size Suppress Archive bit... 35, 36 Synch log Synchronize ad hoc or Scheduled catalog files... 8 command definition SYS Restore System log directory Index Page 81 of 82

82 State...37, 65 Values...37 terminal session...66 Thirty-day trial license...10 Total Object Count...57 Total Object Size...57 Trigger Retry Period...35, 36, 37 Trigger retry period (3600)...62 TRIPLEDES112 encryption...35, 36, 37 unscheduled...45 Update History...35, 36 Use all available Bandwidth (ALLWBW)...23 User Name...15 Password...8 Profiles Vault Name supplier verboseness Wild Card Exclusions Wild Card Exclusions IFS Backup Wild Card Exclusions OBJ Backup Wildcard Rules for Files Wildcard Rules for Folders Work Area with Customer Command... 9 with Job... 9 XLOGMAIN utility Index Page 82 of 82