Date post: | 10-Mar-2016 |
Category: |
Documents |
Upload: | luis-bello |
View: | 257 times |
Download: | 2 times |
LaserVault Backup Suite 3
Installation and Usage Guide 3.2
Table of Contents
What’s new in version 3 3
Installing LaserVault Backup 5
Installing LaserVault Backup AS/400 Library 6
Upgrading LaserVault Backup from version 2 to 3 8
System Configuration 10
Server Instance Configuration 14
Manage Catalog 18
Process Info 21
LVB Transfer Command Line Options 22
Customizing Backup Reports and E-Mail Notifications 23
Replaceable Tokens 25
Configuration of LaserVault Backup Library 30
LaserVault Backup AS/400 Commands 33
GO LASERVAULT/LVBMENU 33
BGNGRPLV - Begin Sav Group for LaserVault 34
CFGLV - Configure LaserVault 35
CHKSTSLV – Check Status to LaserVault 36
CNLRQSLV - Cancel Request to LaserVault 37
ENDGRPLV - End Sav Group for LaserVault 38
JOBLOGLV - Send Joblog to LaserVault 39
RSTCFGLV - Restore Configuration from LaserVault 40
RSTDLOLV - Restore DLO from LaserVault 42
RSTLIBLV - Restore Library from LaserVault 44
RSTLV - Restore IFS Object from LaserVault 46
RSTOBJLV - Restore Object from LaserVault 48
RSTUSRLV - Restore User from LaserVault 50
RTVVOLLV - Retrieve Vol# from LaserVault 52
SAVCFGLV - Save Config to LaserVault 54
SAVDLOLV - Save DLO to LaserVault 56
SAVLIBLV - Save Library to LaserVault 59
SAVLV - Save IFS to LaserVault 62
SAVOBJLV - Save Object to LaserVault 65
SAVSECLV - Save Security to LaserVault 69
WRKCFGLV - Work with LaserVault Configurations 71
WRKGRPLV - Work with Groups on LaserVault 72
WRKVOLLV - Work with Volume on LaserVault 73
SAVLIBTST - Save Library to Test API 75
TCPSPDTST - TCP Speed Test 77
What’s new in Version 3 This is a major release.
A complete revamp of system architecture was done. The system is now comprised of 4 major components.
LVBManager Service:
This service manages all server instances and file locking.
LVBConfig:
This is the configuration console for configuring system settings, server settings and working with catalogs and
other system information.
LVBServer:
This component communicates with the AS/400 for all backup, restore, and catalog requests.
LVBTransfer:
This component handles compressing, encrypting, transfering, sending e-mail, deleting expired entries and
purging old log files.
All configuration information is now stored in a single xml file.
You can define one or more server instances that can each listen on a specified IP address and port. This can
allow the software to receive and transmit data on multiple network adapters.
The system is no longer limited to 20 server instances on the PC side. You can run as few as needed or as
many as system resources will allow.
You can specify how the compress/encrypt and transfer options are performed. Compression and encryption
can be performed during the download, immediately after the download, or at a later scheduled time via the
task scheduler.
The transfer process to transfer data from the 1st backup path to the 2nd can be set to run immediately after
the download or at a later scheduled time.
There is now an option to enable or disable HTML backup logs. You can also specify the path where backup
logs are stored.
There are options to send backup notifications for single files or for backup groups. You can specify a custom
subject line for each. You can use replacable tokens in the subject line to include data from the backup as part
of the subject line. You can also customize the HTML backup report that is sent and saved to disk by editing
the template files.
A low disk space notification option has been added. The system can be configured to send an e-mail when
disk space gets below a certain threshold on path 1 or path 2.
The system will now check authorization against each NIC installed in the computer rather than just the
primary.
A system logging level option was added that can be set to high or normal detail logging.
The e-mail options now include an SMTP authorization method setting. The system was changed to place e-
mails to be sent in to a Mail Queue folder. The LVBTransfer program must be run to send the e-mails. There
are command line switches that allow you to run LVBTransfer and tell it to only process e-mail. This can be set
as a scheduled task to run every minute.
A bug was fixed where the system was getting an invalid un-compressed size when host side compression
was enabled. This would affect the reported compression ratio.
The LVBTransfer program can now be run from a command line as part of a batch file or scheduled task. This
allows scheduling of the various tasks.
The process that deletes expired catalog entries must now be run from the command line or a scheduled task
using the LVBTransfer program.
In the LVBConfig console there is an option to view all LaserVault Backup related processes and see the
details of each.
The default installation now installs the software to C:\LaserVault\LVBackup3. Installing into a location other
than Program Files will eliminate problems with UAC file virtualization. All config files and system logs will be
written to the installation path. We do not recommend installing into the Program Files or Program Files (x86)
folders.
All inter-process communication was changed to use named pipes. The older version used out of process
COM components (ActiveX Exe) but this proved to be troublesome when certain processes were running as a
service.
Installing LaserVault Backup
For most cases, you can take the default prompts that the installer provides. You may wish to change the drive
letter or path that it installs into.
In version 3 the suite installs into C:\LaserVault\LVBackup3 by default. We no longer recommend installing into
the C:\Program Files or C:\Program Files(x86) folders due to UAC file redirection issues that can arise.
The installation program will attempt to stop any running LVBackup services.
After installation you will need to reboot the system.
If you are upgrading from version 2 do not install version 3 into the same folder that version 2 was installed in
See the next section for instructions on upgrading the configuration files.
If this is a new installation, you may want to change the account for the “LaserVault Backup Manager Service”
in the services control panel. You will probably also want to change the start up type from Manual to Automatic
so that the service will start automatically when the machine boots.
If you change the user account for the service be sure to give that user account read/write/modify permissions
to the folder where LaserVault Backup was installed and to any paths where you wish to store backup data.
Installing LaserVault Backup AS/400 Library
There are two methods for installing the LaserVault Backup AS/400 library.
Option 1:
Use the FTP Client on the AS/400 to load the library from the LaserVault Backup FTP Server.
Run the following commands on your AS/400 or System I:
CRTSAVF QTEMP/MYTEST
FTP WWW.LASERVAULTBACKUP.COM
Enter Login ID (QSECOFR): ===> lvb
Enter Password: ===> demo
Enter an FTP subcommand: ===> binary
Enter an FTP subcommand: ===> get laservault.savf qtemp/mytest (replace
(Note: The replace command has a single left parenthesis before the “r” and no right parenthesis)
After the transfer completes successfully, enter quit at the ftp command prompt.
Then enter the following command:
RSTLIB SAVLIB(LASERVAULT) DEV(*SAVF) SAVF(QTEMP/MYTEST)
Option 2:
Use the FTP Client on the PC to upload the save file to the AS/400. The FTP Service must be running on the
AS/400 to use this method.
On the AS/400:
Sign on as QSECOFR
CRTSAVF QGPL/LVBACKLIB
If the save file already exists then clear it with the following command:
CLRSAVF QGPL/LVBACKLIB
On the PC:
Click Start, Run, FTP and press enter.
This should start the windows FTP client.
At the FTP prompt type:
Open followed by the IP address or name of your AS/400.
When prompted for the user name and password, sign on as QSECOFR.
At the FTP Prompt type LCD (path where LaserVault Backup was installed)
Example: LCD “C:\LaserVault\LVBackup3”
Next enter the following commands:
CD QGPL
BIN
PUT LASERVAULT.SAVF LVBACKLIB
BYE
Finally on the AS/400 command prompt enter:
RSTLIB SAVLIB(LASERVAULT) DEV(*SAVF) SAVF(QGPL/LVBACKLIB)
When the restore is finished you may delete the LVBACKLIB save file from QGPL.
Upgrading LaserVault Backup from Version 2 to 3
Version 3 was designed to be able to be installed along side version 2. Running both version 2 and version 3
simultaneously is not supported however you can run one at a time. This will allow you to revert back to
version 2 if needed. The backup data and catalog files have not changed.
After installation, run LVB3Upgrade.exe. The installer creates a shortcut in the start menu called “Upgrade V2
Configuration Files to V3”.
This program will attempt to read your older version 2 configuration files and copy the settings over. When you
start the program it will pre-load the paths where it thinks the configuration files should be. Enter the correct
paths if the defaults are wrong.
Click the upgrade button to create the new configuration files.
This program will leave your old configuration files in place in case you need to revert back to version 2.
After installation, be sure to set the version 2 service entry in the services control panel to manual start so that
it will not interfere with version 3. The name of the service in version 3 is “LaserVault Backup Manager
Service”. You may need to change the user account for the new service if you were using an account other
than system for the old service.
If you are changing the user account for the service, be sure to give permissions to the folder where you
installed LaserVault Backup.
System Configuration
To configure LaserVault Backup, run the LVBConfig.exe program. The installer creates a shortcut on the start
menu under “LaserVault Backup 3” named “LaserVault Backup Configuration”.
After the configuration console starts click the “System Configuration” link.
This will display the system configuration dialog:
SMTP Server Information:
This section defines the settings for the SMTP Server connection. If you would like the system to be able to
send e-mail notifications when backups complete enter the settings in this section. Enter the name of your
SMTP Mail server. Port 25 is the default for SMTP traffic. Enter a user account and password to use for
sending mail if your mail server requires authentication. Generally selecting Auto for the authorization method
is the best choice.
Contact Information for Error Reporting:
The contact information is used by our automated error reporting feature. If an error occurs in the LaserVault
Backup program, it creates an error report including the log files, the job log from the 400 if applicable, and
your configuration file. This is then zip compressed, AES encrypted and posted to a web server at
LaserVault.com. We then decrypt the message and e-mail it internally to our support department. Support will
contact you using the contact information from this section. If you do not wish to have the program submit error
reports, leave this section blank.
Authorization:
To request an authorization key, copy and paste the hard drive serial number and one of the MAC addresses
into an e-mail and send it to [email protected]. After you have your authorization key, enter it into the
authorization key field in this section.
Logging:
Use the logging section to define the detail level of the log files and the number of days to keep logs. In most
cases normal logging and keeping 30 days of logs files is more than sufficient. In certain cases you may need
to set the logging level to high if tech support is working with you to resolve a technical issue.
Click OK to save the changes.
Note: After saving changes to the configuration you will need to stop and re-start the LaserVault
Backup Manager Service in the services control panel.
Server Instance Configuration
You can define the properties for one or more server instances by clicking the “Add” or “Edit” link on the main
configuration screen.
This will display the server properties dialog.
Note: After saving changes to the configuration you will need to stop and re-start the LaserVault
Backup Manager Service in the services control panel.
Each instance of a LaserVault Backup Server can be set to listen on a specific TCP/IP Port and IP Address.
This allows you to make use of multiple network adapters. The IP address and Port combination for each
server instance must be unique. No two server instances can listen on the same IP/Port combination. Each
server instances runs as a separate process. You can define as many as system resources will allow. Each
instance uses approximately 10 to 15 megabytes of RAM.
Multiple server instances can share the same catalog paths.
Server Settings:
In this section you can define the basic server settings.
Server Name – This is used to identify this server instance. By default the system assigns a numeric value, but
you can modify this to use any name you wish.
IP Address – If you have more than one IP address defined on the system you can select which one you want
the server instance to use. Select one from the list or type in the IP address.
TCP/IP Port – This defines the port the server instance will listen on. By default the system starts with port
12345 and tries to auto increment the port setting each time you define a new server. Be sure no other
processes on the system are using the IP address and port combination. You can use the netstat -a command
from a command prompt to see which IP/Port combinations are in use.
TCP/IP Read Size – This setting define the maximum amount of data the program will attempt to read at one
time from the TCP/IP socket. Set to 512,000 for V5R3 and lower. Set to 4000000 for V5R4 and higher.
Copy Settings From – This can be used to help speed up the configuration process if you are defining a large
number of server instances. After you have defined one server instance, you can copy the settings from that
instance into the current one. All settings other than the server name, IP, and Port will be copied.
Make (n) additional copies – This can be used to help speed up the configuration process if you are defining
a large number of server instances. After you have set the properties in the current dialog the system will
create the specified number of additional copies of the configuration. It will auto increment the TCP/IP Port
setting for each new server instance starting with the current one.
Paths:
In this section you can define the paths where the backup data is stored. If you are saving data to a network
location, be sure to use the UNC (\\servername\sharename) naming convention. The LaserVault Backup
servers are running under a service account which may not have drives mapped.
Path1 is the only required field. If you wish to have a copy of the data made to another path, then enter a
directory name for Path2. During the download data is only saved to Path1. Data will be copied to Path2 either
immediately after the download or at a scheduled time depending on what option you select in the “Transfer
Process Options” section.
Compress/Encrypt Process Options:
In this section you can define options for compression and encryption.
Compress Data – Click this checkbox to have LaserVault Backup ZLIB compress the data. This will normally
compress host libraries by a factor of 4 to 12. Database and source files will compress to a smaller size than
program objects.
Encrypt Data – Click the checkbox to encrypt the data. If you encrypt your files, we suggest that you compress
them also since they cannot be compressed later. The encryption will be much faster on a smaller compressed
file as well.
Encryption Pass Phrase – Each backup file is encrypted with a one-time session key that is unique. That
session key is then obfuscated and encrypted with your pass phrase.
The pass phrase is encrypted with AES encryption and a pass phrase known only to LaserVault and stored in
your configuration file. Please keep a copy of this file offsite for disaster recovery purposes.
Immediately After Download – This option will cause the LVBServer process to run LVBTransfer to perform
the compression/encryption immediately after the file is downloaded.
During Download – This option will cause LVBServer to perform compression/encryption during the
download. This may slow the download as the program has to compress/encrypt each block of data as it’s
received.
Scheduled – This option is specified if you plan to schedule the compression/encryption of files at a certain
time. If you choose this option you will need to run LVBTransfer with the appropriate command line switches
either manually or from some sort of task scheduler such as the windows task scheduler. See the section later
in this documentation for the LVBTransfer command line switches.
Transfer Process Options:
These options are used to control the process of transferring backup files from Path1 to Path2.
Immediately After Download – This will option will cause the LVBServer instance to run LVBTransfer
immediately after the download to copy the file to the second path.
Scheduled – Select this option if you wish to transfer the files at a later scheduled time. If you choose this
option you will need to run LVBTransfer with the appropriate command line switches either manually or from
some sort of task scheduler such as the windows task scheduler. See the section later in this documentation
for the LVBTransfer command line switches.
Skip Encryption/Compression on Path 2 – Check this option to skip compression and encryption for files
saved to path 2. This is a special feature for use with de-duplication servers such as EMC/Data Domain,
ExaGrid, GreenBytes etc. De-duplication servers perform their own specialized compression across several
days’ backups. They need data that is not already compressed. In some cases the de-duplication server will be
the primary and only catalog if you are using the de-duplication server’s offsite replication feature.
At this time the option to skip compression on Path2 will not work if you have the option to Compress/Encrypt
during download enabled. This is because the system does not un-compress/un-encrypt the data just for the
purpose of copying it to path 2. If you want the files on path 2 un-compressed/un-encrypted select either
scheduled, or immediately after download.
De-duplication Preprocess – Check this option to have the LVBServer peform De-duplication Stream
Enhancement. This can help improve your de-duplication ratios for EMC/Data Domain style servers.
Delete Expired Save Files – Check this option if you want to have the LVBTransfer process remove expired
save files from the catalog. With this option enabled you must run the LVBTransfer process with the
/DeleteExpired command line switch. See the section later in this documentation for the LVBTransfer
command line switches.
Backup Logs:
This section contains options for generating HTML backup logs
Create HTML Backup Logs – Check this option if you wish to have the system create HTML backup logs.
Backup logs contain either a detail or summary listing of the objects that were saved. You can customize these
logs. See the section later in the documentation on customizing the backup logs and notifications.
Log Path – This specifies where the HTML backup logs will be stored.
Backup Notifications:
This section allows you to define options for sending e-mail notifications after each save operation. Note: When
an e-mail notification is generated it is saved in a Mail Queue folder. The LVBTransfer process must be run
with a command line switch to tell it to process the mail queue. This is done so that the process can re-try if it
fails to connect to the SMTP Server.
Send a notification after each backup – Check this option to send a notification and then enter one or more
e-mail addresses separated by comma or semi-colon.
Subject for Backup Notification – This defines the data that will appear in the subject line. You can use
replaceable tokens to have the system use data about the backup as part of the subject line. For example you
can enter #Label# and that value will be replaced with the library or object name. See the section on
replaceable tokens for the entire list. If this field is left blank the system will use a default subject of:
[LVBACKUP] #SaveDate# #VolumeSerialNumber# #Label# #Description#
Send Only Summary – Check these options to receive only summary information for the various save
operations. Some of these save operations can result in listings of thousands of files or objects. In those cases
you may only wish to receive the summary information rather than the details for every object.
Group Backup Notifications:
This section is used to define e-mail notification options for backup groups.
Send a notification after each backup group – Check this option and then enter one or more e-mail
addresses separated by comma or semi-colon.
Send Only Summary Information – Check this option if you only wish to receive summary information about
the backup group.
Disk Space Notifications:
In this section you can define e-mail notifications to be sent if disk space gets below a certain threshold.
Send a Notification when disk space gets below – Check this option to have an e-mail notification sent
whenever disk space gets below the specified threshold. Enter the value for each path in megabytes and then
enter one or more e-mail addresses separated by comma or semi-colon.
Manage Catalog
To manage a catalog for a server instance, select the server instance from the list on the main configuration
screen and click the catalog link. This will display the manage catalog dialog box.
On this screen you can view the entries in the catalog. Each row in the grid in the Catalog Entries section
represents a save file. When you click on a row in the Catalog Entries grid the system will load the object listing
in the Listing section.
You can view the catalog from Path1, Path2, or an export path if you have exported entries.
To search for items you can enter text criteria in the label and description fields in the “Filter Catalog Entries”
section. To see items between a certain date-range, enter a starting and ending date. Enter start/end dates in
normal date format such as mm/dd/yy. To search for items by expiration date enter the date in the format
YYMMDD.
You can delete, change expiration dates, or export selected items. To select items either click the Select All
button, or hold down the control or shift key while clicking the record selector in the Catalog Entries grid. The
record selector is the grey box on the left of the grid where the current record arrow is displayed.
To delete selected catalog entries, click the “Allow Delete” check box, then click the “Delete Catalog Entries”
button.
To change the expiration date for the selected catalog entries, click the “Change Expiration Date” button. This
will display the Change Expiration Date dialog.
Select one of the pre-defined expiration dates, or manually enter a date in the format YYMMDD or *PERM to
keep indefinitely.
To export catalog entries, enter an export path or click the button to the right to browse for a folder. Select the
option to add or replace and then click the export button.
Process Info
Click the Process Info link to display the Server Process Info dialog.
This dialog displays all the LaserVault Backup related processes and status information for each one. Click a
process on the left and the status information will be loaded on the right.
LVB Transfer Command Line Options
The LVBTransfer application handles various utility tasks such as compressing and encrypting data after a
download, transferring data to the 2nd catalog path, processing the mail queue, and deleting expired entries.
All these command line options can be used in different combinations to suite your needs. You may want to set
up several scheduled tasks that each perform a different function, or create one task that performs all the
tasks.
The options to DeleteExpired, Compress/Encrypt, and Transfer can be fairly time consuming and potentially
processor and network bandwidth intensive. You may wish to scheduled those during off peak hours.
The following command line options are available:
/ServerName=[Server Instance Name]
Example:
/ServerName=001
This parameter tells LVBTransfer to only process for a specified server instance. If this is not specified then all
server instances are processed.
/VolumeSerialNumber=[Volume Serial Number]
Example:
/VolumeSerialNumber=134
This parameter tells LVBTransfer to only process a specific Volume Serial Number. You should use this in
conjunction with the /ServerName command line parameter if you only want to process a certain catalog
record.
/CompressEncrypt
This parameter tells LVBTransfer to perform the compress/encrypt functions for any save files that have not
already been compressed or encrypted.
/Transfer
This parameter tells LVBTransfer to perform the transfer process and copy the save files and catalog from
Path1 to Path2.
/ProcessMailQueue
This parameter tells LVBTransfer to process the mail queue. It will attempt to send any mail messages left in
the mail queue. If you are using the e-mail notification functionality you should create a scheduled task in the
windows task scheduler that will run LVBTransfer.exe /ProcessMailQueue every few minutes or at an interval
that makes sense for your situation.
/DeleteExpired
This parameter tells LVBTransfer to delete expired catalog entries.
Customizing Backup Reports and E-Mail Notifications
The system ships with a set of default E-Mail notification templates. These can be found in the
HTMLTemplates folder where LaserVault Backup was installed.
There are 4 templates:
Default-GroupBackupReport.htm – This template is used for backup groups.
Default-SAVDLOBackupReport.htm – This template is used for the SAVDLOLV command.
Default-SAVIFSBackupReport.htm – This template is used for the SAVLV command.
Default-SAVLIBBackupReport.htm – This template is used for SAVLIBLV, SAVOBJLV, SAVSECLV, and
SAVCFGLV.
To customize one of these backup reports, Make a copy and change the word default to “Custom”.
For Example: Custom-SAVLIBBackupReport.htm.
Then use an HTML or text editor to modify the file.
Inside the HTML file are custom tags named <SummarySection></SummarySection>,
<DetailsSection></DetailsSection>, <DetailsHeader></DetailsHeader>, and <DetailsRecord></DetailsRecord>
The system looks for these tags and then looks for replaceable tokens between the start and end tag and
replaces the tokens with the appropriate values from the save operation. Items in the details section are only
included if the option to send summary information is unchecked. See the next section for a list of replaceable
tokens.
Replaceable Tokens
Replaceable tokens are used in the HTML backup reports and in the subject line of the E-Mail notifications.
Standard Backup Notification Subject Line
For the standard backup notification subject line the following tokens can be used:
#VolumeSerialNumber# - Serial number of the catalog entry.
#SaveDate# - Date of the save file.
#ExpirationDate# - Date of the save files expiration.
#SystemName# - The name of the system the save file was created on.
#FileName# - The PC file name of the save file.
#SaveType# - The type of save operation (SAVLIBLV, SAVDLOLV etc)
#SavedRelease# - The OS release for the save.
#TargetRelease# - The target OS release for the save.
#ASP# - The Auxiliary storage pool number.
#Label# - Generally the library or object name.
#Description# - The description of the saved file or object.
#ObjectsSaved# - The number of objects saved.
#ObjectsInError# - The number of objects not saved.
#SaveWhileActive# - Yes/No flag if save while active was used.
#UncompressedSize# - The size of the data uncompressed.
#CopmressedSize# -The size of the data compressed.
#CompressionRatio# - The compression ratio achieved.
Backup Group Notification Subject Line
For the Backup Group notification subject line the following tokens can be used:
#GroupStartTime# - The time the backup group was started.
#GroupEndTime# - The time the backup group ended.
#SystemName# - The name of the system the backup group came from.
#Description# - The description of the backup group.
#GroupSaveCount# - The number of saved items in the backup group.
#UncompressedSize# - The size of the data uncompressed.
#CopmressedSize# -The size of the data compressed.
#CompressionRatio# - The compression ratio achieved.
SAVLIB HTML Report Summary Section
This section also applies to SAVOBJLV, SAVSECLV, and SAVCFGLV
For the SAVLIB Report Summary Section, the following tokens can be used:
#VolumeSerialNumber# - Serial number of the catalog entry.
#SaveDate# - Date of the save file.
#ExpirationDate# - Date of the save files expiration.
#SystemName# - The name of the system the save file was created on.
#FileName# - The PC file name of the save file.
#SaveType# - The type of save operation (SAVLIBLV, SAVDLOLV etc)
#SavedRelease# - The OS release for the save.
#TargetRelease# - The target OS release for the save.
#ASP# - The Auxiliary storage pool number.
#Label# - Generally the library or object name.
#Description# - The description of the saved file or object.
#ObjectsSaved# - The number of objects saved.
#ObjectsInError# - The number of objects not saved.
#SaveWhileActive# - Yes/No flag if save while active was used.
#UncompressedSize# - The size of the data uncompressed.
#CopmressedSize# -The size of the data compressed.
#CompressionRatio# - The compression ratio achieved.
SAVLIB HTML Report Details Section
For the SAVLIB Report Details Section, the following tokens can be used:
#Object# - The name of the object saved
#Member# - The name of the member.
#ObjectType# - The type of object.
#Description# - The text description for the object.
#Attributes# - The attributes of the object.
#Size# - The size of the object on the AS/400.
#Saved# - Yes/No flag if the object was saved.
#Omitted# - Yes/No flag if the object was omitted.
SAV (IFS) HTML Report Summary Section
For the SAV report summary section, the following tokens can be used:
#VolumeSerialNumber# - Serial number of the catalog entry.
#SaveDate# - Date of the save file.
#ExpirationDate# - Date of the save files expiration.
#SystemName# - The name of the system the save file was created on.
#FileName# - The PC file name of the save file.
#SaveType# - The type of save operation (SAVLIBLV, SAVDLOLV etc)
#SavedRelease# - The OS release for the save.
#TargetRelease# - The target OS release for the save.
#ASP# - The Auxiliary storage pool number.
#Label# - Generally the library or object name.
#Description# - The description of the saved file or object.
#ObjectsSaved# - The number of objects saved.
#ObjectsInError# - The number of objects not saved.
#SaveWhileActive# - Yes/No flag if save while active was used.
#UncompressedSize# - The size of the data uncompressed.
#CopmressedSize# -The size of the data compressed.
#CompressionRatio# - The compression ratio achieved.
SAV HTML Report Details Section
For the SAV report details section, the following tokens can be used:
#Folder# - The folder where the object was saved from.
#File# - The file name of the object.
#ObjectType# - The type of object.
#Authority# - The authority associated with the object.
#Size# - The size of the object on the AS/400
#Saved# - Yes/No flag if the item was saved.
SAVDLO HTML Report Summary Section
For the SAVDLO report summary section the following tokens can be used:
#VolumeSerialNumber# - Serial number of the catalog entry.
#SaveDate# - Date of the save file.
#ExpirationDate# - Date of the save files expiration.
#SystemName# - The name of the system the save file was created on.
#FileName# - The PC file name of the save file.
#SaveType# - The type of save operation (SAVLIBLV, SAVDLOLV etc)
#SavedRelease# - The OS release for the save.
#TargetRelease# - The target OS release for the save.
#ASP# - The Auxiliary storage pool number.
#Label# - Generally the library or object name.
#Description# - The description of the saved file or object.
#ObjectsSaved# - The number of objects saved.
#ObjectsInError# - The number of objects not saved.
#SaveWhileActive# - Yes/No flag if save while active was used.
#UncompressedSize# - The size of the data uncompressed.
#CopmressedSize# -The size of the data compressed.
#CompressionRatio# - The compression ratio achieved.
SAVDLO HTML Report Details Section
For the SAVDLO report details section the following tokens can be used:
#Folder# - The folder where the object was saved.
#Name# - The name of the document
#SystemName# - The system name of the document
#Type# - The type of the document.
#Authority# - The authority associated with the object.
#Size# - The size of the object on the AS/400.
#Saved# - Yes/No flag if the object was saved.
Configuration of LaserVault Backup Library
All of the host commands support a SERVER parameter, which is optional with a default value of 1, the first
server. The virtual devices use ports sequentially, starting with a default value of 12345. If you want to use
more than one server, you will need to configure the host to recognize each port, using the following:
First step is to add the LaserVault Library to your user library list:
Now type WRKCFGLV to enter the LaserVault configuration setting screen.
Now hit “F6” to create LaserVault configuration 001. Then hit “Enter”
This command allows you to specify the configuration information required by the LaserVault Backup software.
The information maintained by this command is:
1) The host name or IP address of the LaserVault Backup server.
2) The port number used by the LaserVault Backup software on the server.
3) The timeout value in seconds for the TCP/IP communications involving the LaserVault Backup server.
4) The number of days to use when *CALC is specified for the EXPDATE parameter on save commands.
5) Set an option to determine whether the LaserVault commands will remove excess messages from the job log that are deemed to not necessarily be needed for problem determination.
6) Set an option to determine whether LaserVault save and restore commands will automatically send a
job log to the LaserVault Backup server when an error is detected during the save or restore operation.
LaserVault Backup AS/400 Commands
These are brief descriptions of the commands available with LaserVault Backup on the AS400. For more
complete descriptions for most of the command parameters, please refer to the documentation for the
equivalent IBM supplied commands.
GO LASERVAULT/LVBMENU
Executing this command will allow you to easily run LaserVault SAV and WRK commands from one screen.
BGNGRPLV - Begin Sav Group for LaserVault
This command allows you to specify the beginning of a group of saves that you want to be associated together,
such as a nightly or monthly save set. All of the saves to be included in the save group must be executed from
the same job as this command.
Command Parameters:
SERVER - LaserVault Server: Specifies the LV server number to communicate with.
Valid values are 1-999.
Default value is 1.
TEXT - Text 'description': Specifies the text that briefly describes the save group. Special value of *GEN will
create a description consisting of the job name and user name.
Default value is *GEN.
CFGLV - Configure LaserVault
This command allows you to specify the configuration information required by the LaserVault Backup software.
The information maintained by this command is:
1) The host name or IP address of the LaserVault Backup server.
2) The port number used by the LaserVault Backup software on the server.
3) The timeout value in seconds for the TCP/IP communications involving the LaserVault Backup server.
4) The number of days to use when *CALC is specified for the EXPDATE parameter on save commands.
5) Set an option to determine whether the LaserVault commands will remove excess messages from the joblog that are deemed to not necessarily be needed for problem determination.
6) Set an option to determine whether LaserVault save and restore commands will automatically send a
joblog to the LaserVault Backup server when an error is detected during the save or restore operation.
Command Parameters:
SERVER - LaserVault Server: Specifies the LV server number to communicate with.
Valid values are 1-999.
Default value is 1.
CHKSTSLV – Check Status to LaserVault
This command allows you to send a signal to LaserVault Backup server to check for connectivity on any
server. Command will send an error message with message id CPF9898 if the specified LVB server is not
responding.
Command Parameters:
SERVER - LaserVault Server: Specifies the LV server number to communicate with.
Valid values are 1-999.
Default value is 1.
CNLRQSLV - Cancel Request to LaserVault
This command allows you to send a signal to LaserVault Backup save and restore operations that are currently
running to end.
Command Parameters:
SERVER - LaserVault Server: Specifies the LV server number to communicate with.
A maximum of 10 servers can be specified.
Valid values are 1-999.
Default value is 1.
ENDGRPLV - End Sav Group for LaserVault
This command allows you to specify the end of a group of saves that you want to be associated together, such
as a nightly or monthly save set.
Command Parameters:
SERVER - LaserVault Server: Specifies the LV server number to communicate with.
Valid values are 1-999.
Default value is 1.
JOBLOGLV - Send Joblog to LaserVault
This command allows you to send joblogs to the LaserVault Backup server. You may be asked to run this
command in order to help facilitate any technical support that may be required.
Command Parameters:
JOB - Job name, User, Number: Specifies the job whose joblog is to be sent to LV. The job must be either
an active job or a completed job with a QPJOBLOG spool file present on the system at the time this command
is executed. Special value of '*' will send the joblog of the job executing this command. Special value of
‘LVB001’ will send joblog for server 1, ‘LVB002’ will send joblog for server 2, etc… Special value of ‘LVB*’ will
send all server joblogs.
Default value is '*'.
SERVER - LaserVault Server: Specifies the LV server number to communicate with.
Valid values are 1-999.
Default value is 1.
RSTCFGLV - Restore Configuration from LaserVault
This command restores system configuration objects that were saved with the SAVCFGLV command.
Command Parameters:
OBJ - Objects: Specifies the names of one or more objects to restore. Generic names are allowed.
The special value of *ALL will restore all of the device configuration objects depending upon the OBJTYPE
parameter value.
The special value of *SRM will restore the system resource management objects based upon the SRM
parameter value.
A maximum of 300 object names can be specified.
This is a required parameter.
VOLNBR - Volume Number: Specifies the LV volume number containing the objects to be restored. Special
value *FIRST will restore from the oldest LV volume number found. Special value *LAST will restore from the
newest LV volume number found.
This is a required parameter.
OBJTYPE - Object types: Specifies the types of system objects that are restored. The special value of *ALL
will restore all of the device configuration object types that are specified in the OBJ parameter.
A maximum of 10 object types can be specified.
Default value is *ALL.
SRM - System Resource Management: Specifies the type of system resource management information to
be restored. The value of *ALL will restore all information. The value of *NONE will restore none. The value
of *HDW will restore hardware information. The value of *TRA will restore token-ring adapter information.
Valid values are *ALL, *NONE, *HDW, *TRA.
Default value is *ALL.
ALWOBJDIF - Allow object differences: Specifies whether certain differences encountered during a restore
operation are allowed.
Valid values are *ALL, *NONE.
Default value is *NONE.
OMITOBJ - Objects to omit: Specifies the objects to be excluded from the operation.
A maximum of 100 object names can be specified.
Default value is *NONE.
Restriction: This parameter is only available for use in V5R3 or later releases of the operating system.
SERVER - LaserVault Server: Specifies the LV server number to communicate with.
Valid values are 1-999.
Default value is 1.
RSTDLOLV - Restore DLO from LaserVault
This command restores document library objects and folders that were saved with the SAVDLOLV command.
Command Parameters:
DLO - Document library object: Specifies the document library objects to be restored. Special values *ALL,
*MAIL, and *SYSOBJNAM are available.
A maximum of 300 DLO names can be specified.
This is a required parameter.
VOLNBR - Volume Number: Specifies the LV volume number containing the objects to be restored. Special
value *FIRST will restore from the oldest LV volume number found. Special value *LAST will restore from the
newest LV volume number found.
This is a required parameter.
SAVFLR - Saved folder: Specifies the name of the folder the document library objects were saved from.
Special values *ANY and *NONE are available.
A maximum of 10 folder names can be specified.
Default value is *ANY.
RENAME - New object name: Specifies the new user-assigned name for the restored document.
The special value of *SAME restores the documents with the same name they were saved as.
A maximum of 10 folder names can be specified. Default value is *SAME.
RSTFLR - Restore into folder: Specifies the name of the folder in which the restored folders and documents
to be restored will be placed. The special value *SAME will restore the documents and folders into the same
folder they were saved from.
Default value is *SAME.
SYSOBJNAM - System object name: Specifies the system object names of the documents to be restored if
*SYSOBJNAM is specified on the DLO parameter.
A maximum of 10 system object names can be specified.
Default value is *NONE.
NEWOBJ - Object name generation: Specifies whether a new library-assigned name and system object
name are generated for the folders and documents being restored. The value *SAME will keep the names the
same. The value *NEW will generate new names.
Valid values are *NEW, *SAME.
Default value is *SAME.
ALWOBJDIF - Allow object differences: Specifies whether certain differences encountered during a restore
operation are allowed.
Valid values are *ALL, *NONE.
Default value is *NONE.
SERVER - LaserVault Server: Specifies the LV server number to communicate with.
Valid values are 1-999.
Default value is 1.
RSTLIBLV - Restore Library from LaserVault
This command restores a library that was saved with the SAVLIBLV command.
Command Parameters:
SAVLIB - Saved library: Specifies the name of the library to be restored. Special value *ALL can be used
when *LASTGRP is specified for the VOLNBR parameter.
This is a required parameter.
VOLNBR - Volume Number: Specifies the LV volume number containing the objects to be restored. Special
value *FIRST will restore from the oldest LV volume number found. Special value *LAST will restore from the
newest LV volume number found. Special value of *LASTGRP will restore all libraries included in the last save
group (Note: The recommended method of restore group saves is to use WRKGRPLV to restore the libraries
instead, so that it can be verified that the last group is indeed the one wanted.)
This is a required parameter.
OPTION - Option: Specifies how to handle restoring each object.
Valid values are *ALL, *OLD, *NEW, *FREE.
Default value is *ALL.
MBROPT - Data base member option: Specifies, for database files that exist on the system, which members
are restored.
Valid values are *MATCH, *ALL, *OLD, *NEW.
Default value is *MATCH.
ALWOBJDIF - Allow object differences: Specifies whether certain differences encountered during a restore
operation are allowed.
Valid values are *ALL, *FILELVL, *NONE.
Default value is *NONE.
RSTLIB - Restore to library: Specifies whether the library contents are restored to the same library in which
they were saved, or to a different library.
The special value *SAVLIB restores to the same library.
Default value is *SAVLIB.
FRCOBJCVN - Force object conversion: Specifies whether to convert user objects to the format required for
use in the current version of the operating system when the objects are restored.
Default value is *SYSVAL.
OMITLIB - Libraries to omit: Specifies the libraries to be excluded from the operation.
A maximum of 50 library names can be specified.
Restriction: This parameter can only be used when *ALL is specified for SAVLIB parameter.
Default value is *NONE.
OMITOBJ - Objects to omit: Specifies the objects to be excluded from the operation.
A maximum of 100 object names can be specified.
Default value is *NONE.
Restriction: This parameter is only available for use in V5R3 or later releases of the operating system.
SPLFDTA - Spooled file data: Specifies whether to restore spooled file data and attributes.
Valid values are *NEW, *NONE.
Default value is *NEW.
SERVER - LaserVault Server: Specifies the LV server number to communicate with.
Valid values are 1-999.
Default value is 1.
RSTLV - Restore IFS Object from LaserVault
This command restores IFS objects that were saved with the SAVLV command.
Command Parameters:
OBJ - Objects: Specifies the path name of the object to restore.
A maximum of 10 path names can be specified.
This is a required parameter.
VOLNBR - Volume Number: Specifies the LV volume number containing the objects to be restored. Special
value *FIRST will restore from the oldest LV volume number found. Special value *LAST will restore from the
newest LV volume number found.
This is a required parameter.
SUBTREE - Directory subtree: Specifies whether directory subtrees are included in the restore.
Valid values are *ALL, *DIR, *NONE, *OBJ, *STG.
Default value is *ALL.
SYSTEM - System: Specifies whether to process objects that exist on the local system or remote systems.
The value *LCL specifies that only local objects are processed.
The value *RMT specifies that only remote objects are processed.
The value *ALL specifies that both local and remote objects are processed. Valid values are *LCL, *RMT,
*ALL.
Default value is *LCL.
OPTION - Option: Specifies how to handle restoring each object.
Valid values are *ALL, *OLD, *NEW.
Default value is *ALL.
ALWOBJDIF - Allow object differences: Specifies whether certain differences encountered during a restore
operation are allowed.
Valid values are *NONE, *AUTL, *OWNER, *PGP.
A maximum of 3 values can be specified.
Default value is *NONE.
SERVER - LaserVault Server: Specifies the LV server number to communicate with.
Valid values are 1-999.
Default value is 1.
RSTOBJLV - Restore Object from LaserVault
This command restores objects that were saved with the SAVOBJLV or SAVLIBLV command.
Command Parameters:
OBJ - Objects: Specifies the names of one or more objects to restore. Generic names are allowed. The
special value of *ALL will restore all of the objects depending upon the OBJTYPE parameter value.
A maximum of 200 object names can be specified.
This is a required parameter.
SAVLIB - Saved library: Specifies the name of the library to be restored.
This is a required parameter.
VOLNBR - Volume Number: Specifies the LV volume number containing the objects to be restored. Special
value *FIRST will restore from the oldest LV volume number found. Special value *LAST will restore from the
newest LV volume number found.
This is a required parameter.
OBJTYPE - Object types: Specifies the types of system objects that are restored. The special value of *ALL
will restore all of the object types that are specified in the OBJ parameter.
A maximum of 200 object types can be specified.
Default value is *ALL.
OPTION - Option: Specifies how to handle restoring each object.
Valid values are *ALL, *OLD, *NEW, *FREE.
Default value is *ALL.
FILEMBR – Allows for up to 10 files with 10 generic member names each to be specified.
Default value is *ALL
MBROPT - Data base member option: Specifies, for database files that exist on the system, which members
are restored.
Valid values are *MATCH, *ALL, *OLD, *NEW.
Default value is *MATCH.
ALWOBJDIF - Allow object differences: Specifies whether certain differences encountered during a restore
operation are allowed.
Valid values are *ALL, *FILELVL, *NONE.
Default value is *NONE.
RSTLIB - Restore to library: Specifies whether the library contents are restored to the same library in which
they were saved, or to a different library. The special value *SAVLIB restores to the same library.
Default value is *SAVLIB.
FRCOBJCVN - Force object conversion: Specifies whether to convert user objects to the format required for
use in the current version of the operating system when the objects are restored.
Default value is *SYSVAL.
OMITOBJ - Objects to omit: Specifies the objects to be excluded from the operation.
A maximum of 20 object names can be specified.
Default value is *NONE.
Restriction: This parameter is only available for use in V5R3 or later releases of the operating system.
SPLFDTA - Spooled file data: Specifies whether to restore spooled file data and attributes.
Valid values are *NEW, *NONE.
Default value is *NEW.
SERVER - LaserVault Server: Specifies the LV server number to communicate with.
Valid values are 1-999.
Default value is 1.
RSTUSRLV - Restore User from LaserVault
This command restores the basic parts of a user profile or a set of user profiles that were saved with the
SAVSECLV command.
Command Parameters:
USRPRF - User profile: Specifies the user profiles to be restored. Generic names are allowed.
A maximum of 300 user profiles can be specified.
This is a required parameter.
VOLNBR - Volume Number: Specifies the LV volume number containing the objects to be restored. Special
value *FIRST will restore from the oldest LV volume number found. Special value *LAST will restore from the
newest LV volume number found.
This is a required parameter.
ALWOBJDIF - Allow object differences: Specifies whether certain differences encountered during a restore
operation are allowed.
Valid values are *ALL, *NONE.
Default value is *NONE.
OMITUSRPRF - User profiles to omit: Specifies user profiles to be omitted from the restore. Generic names
are allowed. A maximum of 300 user profiles can be specified. Default value is *NONE.
SECDTA - Security data: Specifies whether all authority information or only the private authorities are
restored for the specified user profiles and auxiliary storage. Also specifies whether the password and group
linkages are to be restored for the specified user profiles.
Valid values are *USRPRF, *PVTAUT, *PWDGRP, *DCM.
Default value is *USRPRF.
SERVER - LaserVault Server: Specifies the LV server number to communicate with.
Valid values are 1-999.
Default value is 1.
RTVVOLLV - Retrieve Vol# from LaserVault
This command retrieves the appropriate LaserVault volume number into a CL variable for later use by a restore
command.
Restriction: This command is only valid for use inside a CL program.
Command Parameters:
VOLNBR - CL var for VOLNBR (Char 8): Specifies the name of the CL variable that receives the volume
number. You may set the value of the CL variable to *FIRST or *LAST before executing this command in order
to instruct the command to return either the oldest (*FIRST), or the newest (*LAST) volume found when
multiple volumes are found matching the search values supplied.
This is a required parameter.
TYPE - Type of save: Specifies the type of save data to search for.
Valid values are *CFG, *DLO, *IFS, *LIB, *OBJ, *SECDTA, *GRP.
This is a required parameter.
OBJ - Object: Specifies the object name to search for when a TYPE of *CFG, *LIB, *OBJ, or *SECDTA is
specified. Special values of *ANY and *NONE are available for use.
Default value is *NONE.
SAVLIB - Saved library: Specifies the library name to search for when a TYPE of *LIB or *OBJ is specified.
Special value of *NONE is available for use. Default value is *NONE.
DLO - Document library object: Specifies the DLO to search for when a TYPE of *DLO is specified. Special
values of *ANY and *NONE are available for use.
Default value is *NONE.
SAVFLR - Saved folder: Specifies the folder to search for when a TYPE of *DLO is specified. Special values
of *ANY and *NONE are available for use.
Default value is *NONE.
IFSOBJ - IFS Object: Specifies the object to search for when a TYPE of *IFS is specified. Special values of
*ANY and *NONE are available for use.
Default value is *NONE.
PERIOD - Time period of save: Specifies the date range to search for when the objects were saved.
Default value is *BEGIN and *END.
SYSTEM - System: Specifies the system that objects were saved from to search for. Special value of *ANY
is available for use.
Default value is *ANY.
TEXT - Text 'description': Specifies the text associated with a LaserVault SAV command to search for. The
search will look for any text description that contains this value. Special value of *ANY is available for use.
Default value is *ANY.
SERVER - LaserVault Server: Specifies the LV server number to communicate with.
Valid values are 1-999.
Default value is 1.
SAVCFGLV - Save Config to LaserVault
This command allows you to save all configuration and system resource management objects to LaserVault.
Command Parameters:
TEXT - Text 'description': Specifies the text to be associated with this save operation.
Default value is 'Configuration Data'.
EXPDATE - File expiration date: Specifies the expiration date of the file created by the save operation. The
special value *PERM specifies that there is no expiration date associated with this save operation. The special
value *CALC specifies that the expiration date will be calculated based upon the value specified in the
LaserVault config.
Default value is *CALC.
PRECHK - Object pre-check: Specifies whether objects are checked to see if they can be saved prior to
beginning the actual save operation.
Valid values are *YES, *NO.
Default value is *NO.
DTACPR - Data compression: Specifies whether data is compressed on the AS400 before being sent to
LaserVault. AS400 systems with fast processors may see an improvement in throughput when specifying
*YES, especially on slow networks.
However, the compression performed on the AS400 is typically not as good as that performed on the server
and the space required to store the save data may be more when *YES is specified.
Valid values are *YES, *NO.
Default value is *NO.
SERVER - LaserVault Server: Specifies the LV server number to communicate with.
Valid values are 1-999.
Default value is 1.
SAVDLOLV - Save DLO to LaserVault
This command allows you to save document library objects and folders to LaserVault.
Command Parameters:
DLO - Document library object: Specifies the document library objects to save. To save a folder,
DLO(*ALL) must be specified. Special values of *ALL, *SEARCH, *CHG, *SYSOBJNAM, *DOCL, *MAIL, and
*FLRLVL are available for use.
A maximum of 300 DLO names can be specified.
This is a required parameter.
FLR - Folder: Specifies the name of the folder to save. Generic names are allowed. Special values of *ANy
and *none are available for use.
A maximum of 10 folder names can be specified.
Default value is *ANY.
TEXT - Text 'description': Specifies the text to be associated with this save operation. The value *GEN will
cause the first folder name to be used.
Default value is *GEN.
SRCHTYPE - Search type: Specifies the type of objects for which to search. This parameter is valid only if
*SEARCH is specified on the DLO parameter.
Valid values are *ALL, *DOC.
Default value is *DOC.
CHKFORMRK - Check for mark: Specifies whether documents marked for storage are saved.
Valid values are *YES, *NO.
Default value is *NO.
CHKEXP - Expiration date: Specifies that all documents with an expiration date before the specified date are
to be saved. Special values *NO and *CURRENT are available for use.
Default value is *NO.
CRTDATE - Creation date: Specifies that documents and folders that have a creation date during the time
period specified are to be saved.
Default value is *AVAIL and *BEGIN.
DOCCLS - Document class: Specifies the class of documents being saved.
Default value is *ANY.
OWNER - Owner profile: Specifies the owner of the documents and folders being saved. Special values of
*CURRENT and *ALL is available for use.
Default value is *CURRENT.
REFCHGDATE - Last changed date: Specifies the date after which the folders that are created and the
documents that are changed or created are to be saved.
Default value is *ANY.
REFCHGTIME - Last changed time: Specifies the time, relative to the date specified on the REFCHGDATE
parameter, after which the folders that are created and the documents that are changed or created are to be
saved.
Default value is *ANY.
SYSOBJNAM - System object name: Specifies the system object names of the documents that are saved,
when *SYSOBJNAM is specified on the DLO parameter.
A maximum of 10 names can be specified.
DOCL - Document list: Specifies a list of documents to be saved.
Default value is *NONE.
EXPDATE - File expiration date: Specifies the expiration date of the file created by the save operation. The
special value *PERM specifies that there is no expiration date associated with this save operation. The special
value *CALC specifies that the expiration date will be calculated based upon the value specified in the
LaserVault config.
Default value is *CALC.
TGTRLS - Target release: Specifies the release level of the operating system on which you intend to use the
object being saved.
Valid values are *CURRENT, *PRV.
Default value is *CURRENT.
OMITFLR - Folders to omit: Specifies the names of folders to be excluded from the save operation.
A maximum of 10 folder names can be specified. Default value is *NONE.
CMDCHRID - Command character identifier: Specifies the character identifier (graphic character set and
code page) for the data being entered as DOCCLS parameter values. Special values *DEVD and *SYSVAL
are available for use.
Default value is *SYSVAL.
SAVACT - Save active: Specifies whether an object can be updated while it is being saved.
Valid values are *NO, *YES.
Default value is *NO.
SAVACTWAIT - Save active wait: Specifies the amount of time to wait for a lock on an object, if it is not
available, before continuing the save. Special value of *NOMAX is available for use.
Default value is 120.
STG - Storage: Specifies whether system storage occupied by the document being saved is kept, deleted, or
freed after the save operation ends.
Valid values are *KEEP, *DELETE, *FREE.
Default value is *KEEP.
DTACPR - Data compression: Specifies whether data is compressed on the AS400 before being sent to
LaserVault. AS400 systems with fast processors may see an improvement in throughput when specifying
*YES, especially on slow networks. However, the compression performed on the AS400 is typically not as
good as that performed on the server, and the space required to store the save data may be more when *YES
is specified.
Valid values are *YES, *NO.
Default value is *NO.
SERVER - LaserVault Server: Specifies the LV server number to communicate with.
Valid values are 1-999.
Default value is 1.
SAVLIBLV - Save Library to LaserVault
This command allows you to save libraries to LaserVault.
When multiple libraries are specified, the BGNGRPLV command will be automatically invoked if one is not
already in effect for the current job.
Command Parameters:
LIB - Library: Specifies which libraries are saved. Generic names are allowed. Special values *ALLUSR,
*IBM, and *NONSYS are available for use.
A maximum of 300 library names can be specified.
This is a required parameter.
TEXT - Text 'description': Specifies the text to be associated with this save operation. The value *LIB will
cause the library name to be used.
Default value is *LIB.
EXPDATE - File expiration date: Specifies the expiration date of the file created by the save operation. The
special value *PERM specifies that there is no expiration date associated with this save operation. The special
value *CALC specifies that the expiration date will be calculated based upon the value specified in the
LaserVault config.
Default value is *CALC.
TGTRLS - Target release: Specifies the release level of the operating system on which you intend to use the
object being saved. Valid values are *CURRENT, *PRV. Default value is *CURRENT.
UPDHST - Update history: Specifies whether the save history information of each saved object is changed
with the date, time, and location of this save operation.
Valid values are *YES, *NO.
Default value is *YES.
PRECHK - Object pre-check: Specifies whether objects are checked to see if they can be saved prior to
beginning the actual save operation.
Valid values are *YES, *NO.
Default value is *NO.
SAVACT - Save active: Specifies whether an object can be updated while it is being saved.
Valid values are *NO, *YES, *SYNCLIB, *SYSDFN.
Default value is *NO.
SAVACTWAIT - Save active wait: Specifies the amount of time to wait for a lock on an object, if it is not
available, before continuing the save. Special value of *NOMAX is available for use.
Default value is 120.
SAVACTMSGQ - Save active message queue: Specifies the message queue that the save operation uses
to notify the user that the checkpoint processing for a library is complete.
Default value is *NONE.
ACCPTH - Save access paths: Specifies whether the logical file access paths that are dependent on the
physical files being saved are also saved.
Valid values are *NO, *YES.
Default value is *NO.
SAVFDTA - Save file data: Specifies, for save file objects, whether the description of a save file, or both the
description and the contents of a save file, are saved.
Valid values are *NO, *YES.
Default value is *YES.
SPLFDTA - Spooled file data: Specifies whether to save spooled file data and attributes for output queues
that are saved.
Valid values are *NONE, *ALL.
Default value is *NONE.
Restriction: This parameter is only available for use in V5R4 or later releases of the operating system.
QDTA - Queue data: Specifies, for queue objects, whether the description of a queue, or both the description
and the contents of a queue, are saved.
Valid values are *NONE, *DTAQ.
Default value is *NONE.
Restriction: This parameter is only available for use in V5R4 or later releases of the operating system.
STG - Storage: Specifies whether system storage occupied by the document being saved is kept, deleted, or
freed after the save operation ends. Valid values are *KEEP, *DELETE, *FREE.
Default value is *KEEP.
DTACPR - Data compression: Specifies whether data is compressed on the AS400 before being sent to
LaserVault. AS400 systems with fast processors may see an improvement in throughput when specifying
*YES, especially on slow networks. However, the compression performed on the AS400 is typically not as
good as that performed on the server, and the space required to store the save data may be more when *YES
is specified.
Valid values are *YES, *NO.
Default value is *NO.
OMITLIB - Libraries to omit: Specifies the names of one of more libraries, or the generic names of each
group of libraries, to be excluded from the save operation.
A maximum of 300 library names can be specified.
Default value is *NONE.
OMITOBJ - Objects to omit: Specifies the objects to be excluded from the operation.
A maximum of 100 object names can be specified.
Default value is *NONE.
SERVER - LaserVault Server: Specifies the LV server number to communicate with. Specifying multiple
servers may improve backup times when multiple libraries are to be saved. A special subsystem named LVB
will be started in order to run the multiple jobs necessary to perform a save to multiple servers. A maximum of
10 servers can be specified.
Valid values are 1-999. Default value is 1.
SAVLV - Save IFS to LaserVault
This command allows you to save objects from the IFS to LaserVault.
Command Parameters:
OBJ - Objects: Specifies the path name of the object to save.
A maximum of 20 path names can be specified.
This is a required parameter.
SUBTREE - Directory subtree: Specifies whether directory subtrees are included in the save.
Valid values are *ALL, *DIR, *NONE, *OBJ, *STG.
Default value is *ALL.
TEXT - Text 'description': Specifies the text to be associated with this save operation. The value *GEN will
cause the first object path name to be used.
Default value is *GEN.
SAVACT - Save active: Specifies whether an object can be updated while it is being saved.
Valid values are *NO, *YES, *SYNC.
Default value is *NO.
SAVACTOPT - Save active option: Specifies options to be used with the save while active parameter. Valid
values are *NONE, *ALWCKPWRT.
Default value is *NONE.
SAVACTMSGQ - Save active message queue: Specifies the message queue that the save operation uses
to notify the user that the checkpoint processing for a library is complete.
Default value is *NONE.
EXPDATE - File expiration date: Specifies the expiration date of the file created by the save operation. The
special value *PERM specifies that there is no expiration date associated with this save operation. The special
value *CALC specifies that the expiration date will be calculated based upon the value specified in the
LaserVault config.
Default value is *CALC.
TGTRLS - Target release: Specifies the release level of the operating system on which you intend to use the
object being saved.
Valid values are *CURRENT, *PRV.
Default value is *CURRENT.
CHGPERIOD - Time period for last change: Specifies a date/time range. Objects that were last changed
within that range will be saved. Special value *LASTSAVED saves objects that have changed since the last
time they were saved with UPDHST(*YES) specified. Special value of *ALL specifies that all objects will be
saved. Default value is *ALL.
SYSTEM - System: Specifies whether to process objects that exist on the local system or remote systems.
The value *LCL specifies that only local objects are processed.
The value *RMT specifies that only remote objects are processed. The value *ALL specifies that both local
and remote objects are processed.
Valid values are *LCL, *RMT, *ALL.
Default value is *LCL.
PRECHK - Object pre-check: Specifies whether objects are checked to see if they can be saved prior to
beginning the actual save operation.
Valid values are *YES, *NO.
Default value is *NO.
UPDHST - Update history: Specifies whether the save history information of each saved object is changed
with the date, time, and location of this save operation.
Valid values are *YES, *NO.
Default value is *NO.
DTACPR - Data compression: Specifies whether data is compressed on the AS400 before being sent to
LaserVault. S400 systems with fast processors may see an improvement in throughput when specifying *YES,
especially on slow networks. However, the compression performed on the AS400 is typically not as good as
that performed on the server, and the space required to store the save data may be more when *YES is
specified.
Valid values are *YES, *NO.
Default value is *NO.
SERVER - LaserVault Server: Specifies the LV server number to communicate with.
Valid values are 1-999.
Default value is 1.
SAVOBJLV - Save Object to LaserVault
This command allows you to save objects to LaserVault. When multiple libraries are specified, the BGNGRPLV
command will be automatically invoked if one is not already in effect for the current job.
Command Parameters:
OBJ - Object: Specifies which objects are saved. Generic names are allowed.
A maximum of 300 object names can be specified.
This is a required parameter.
LIB - Library: Specifies which libraries contain the objects that are saved. Generic names are allowed.
Special value *ALLUSR is available for use.
This is a required parameter.
TEXT - Text 'description': Specifies the text to be associated with this save operation. The value *LIB will
cause the library name to be used.
Default value is *LIB.
OBJTYPE - Object types: Specifies the types of objects to save. Default value is *ALL.
CHGPERIOD - Time period for last change: Specifies the reference date. Objects that have been changed
since this date are saved. Specifying a value other than *ALL for this parameter is the equivalent of using the
SAVCHGOBJ command.
Special value of *SAVLIB specifies that objects that have changed since the last SAVLIB command run will be
saved. Special value of *ALL specifies that all objects will be saved.
Default value is *ALL.
EXPDATE - File expiration date: Specifies the expiration date of the file created by the save operation. The
special value *PERM specifies that there is no expiration date associated with this save operation. The special
value *CALC specifies that the expiration date will be calculated based upon the value specified in the
LaserVault config.
Default value is *CALC.
TGTRLS - Target release: Specifies the release level of the operating system on which you intend to use the
object being saved.
Valid values are *CURRENT, *PRV.
Default value is *CURRENT.
UPDHST - Update history: Specifies whether the save history information of each saved object is changed
with the date, time, and location of this save operation.
Valid values are *YES, *NO.
Default value is *YES.
PRECHK - Object pre-check: Specifies whether objects are checked to see if they can be saved prior to
beginning the actual save operation.
Valid values are *YES, *NO.
Default value is *NO.
SAVACT - Save active: Specifies whether an object can be updated while it is being saved.
Valid values are *NO, *YES, *SYNCLIB, *SYSDFN.
Default value is *NO.
SAVACTWAIT - Save active wait: Specifies the amount of time to wait for a lock on an object, if it is not
available, before continuing the save. Special value of *NOMAX is available for use.
Default value is 120.
SAVACTMSGQ - Save active message queue: Specifies the message queue that the save operation uses
to notify the user that the checkpoint processing for a library is complete.
Default value is *NONE.
ACCPTH - Save access paths: Specifies whether the logical file access paths that are dependent on the
physical files being saved are also saved.
Valid values are *NO, *YES.
Default value is *NO.
SAVFDTA - Save file data: Specifies, for save file objects, whether the description of a save file, or both the
description and the contents of a save file, are saved.
Valid values are *NO, *YES.
Default value is *YES.
SPLFDTA - Spooled file data: Specifies whether to save spooled file data and attributes for output queues
that are saved.
Valid values are *NONE, *ALL.
Default value is *NONE.
Restriction: This parameter is only available for use in V5R4 or later releases of the operating system.
QDTA - Queue data: Specifies, for queue objects, whether the description of a queue, or both the description
and the contents of a queue, are saved.
Valid values are *NONE, *DTAQ.
Default value is *NONE.
Restriction: This parameter is only available for use in V5R4 or later releases of the operating system.
STG - Storage: Specifies whether system storage occupied by the document being saved is kept, deleted, or
freed after the save operation ends.
Valid values are *KEEP, *DELETE, *FREE.
Default value is *KEEP.
DTACPR - Data compression: Specifies whether data is compressed on the AS400 before being sent to
LaserVault.
AS400 systems with fast processors may see an improvement in throughput when specifying *YES, especially
on slow networks. However, the compression performed on the AS400 is typically not as good as that
performed on the server, and the space required to store the save data may be more when *YES is specified.
Valid values are *YES, *NO.
Default value is *NO.
OMITLIB - Libraries to omit: Specifies the names of one of more libraries, or the generic names of each
group of libraries, to be excluded from the save operation. A maximum of 300 library names can be specified.
Default value is *NONE.
OMITOBJ - Objects to omit: Specifies the objects to be excluded from the operation. A maximum of 100
object names can be specified.
Default value is *NONE.
SERVER - LaserVault Server: Specifies the LV server number to communicate with. Specifying multiple
servers may improve backup times when multiple libraries are to be saved.
A special subsystem named LVB will be started in order to run the multiple jobs necessary to perform a save to
multiple servers.
Valid values are 1-999.
A maximum of 10 servers can be specified.
Default value is 1.
SAVSECLV - Save Security to LaserVault
This command allows you to save all security information to LaserVault.
Command Parameters:
TEXT - Text 'description': Specifies the text to be associated with this save operation.
Default value is 'Security Data'.
EXPDATE - File expiration date: Specifies the expiration date of the file created by the save operation. The
special value *PERM specifies that there is no expiration date associated with this save operation. The special
value *CALC specifies that the expiration date will be calculated based upon the value specified in the
LaserVault config.
Default value is *CALC.
PRECHK - Object pre-check: Specifies whether objects are checked to see if they can be saved prior to
beginning the actual save operation.
Valid values are *YES, *NO.
Default value is *NO.
DTACPR - Data compression: Specifies whether data is compressed on the AS400 before being sent to
LaserVault.
AS400 systems with fast processors may see an improvement in throughput when specifying *YES, especially
on slow networks. However, the compression performed on the AS400 is typically not as good as that
performed on the server, and the space required to store the save data may be more when *YES is specified.
Valid values are *YES, *NO.
Default value is *NO.
SERVER - LaserVault Server: Specifies the LV server number to communicate with.
Valid values are 1-999.
Default value is 1.
WRKCFGLV - Work with LaserVault Configurations
This command allows you to work with the LaserVault configurations found on your system.
An "L" displayed between the Opt and Server fields indicate that the associated LaserVault server has a lock
on it. You must use option 2 to view the config in order to see what job has the lock, and optionally remove the
lock.
Restriction: This command is only valid in an interactive job.
Command Parameters:
This command does not have any parameters.
WRKGRPLV - Work with Groups on LaserVault
This command allows you to work with the save groups on LaserVault as defined by the use of the
BGNGRPLV and ENDGRPLV commands.
Restriction: This command is only valid in an interactive job.
Command Parameters:
SERVER - LaserVault Server: Specifies the LV server number to communicate with.
Valid values are 1-999.
Default value is 1.
PERIOD - Time period of save: Specifies the date range for when the save operations were performed.
Default value is *BEGIN and *END.
SYSTEM - System: Specifies the system that objects were saved from.
Default value is *ALL.
TEXT - Text 'description': Specifies the text associated with a LaserVault SAV command. The groups
returned will have any text description that contains this value.
Default value is *ALL.
WRKVOLLV - Work with Volume on LaserVault
This command allows you to work with the objects saved to LaserVault.
Restriction: This command is only valid in an interactive job.
Command Parameters:
SERVER - LaserVault Server: Specifies the LV server number to communicate with.
Valid values are 1-999.
Default value is 1.
TYPE - Type of save: Specifies the type of save data to list.
Valid values are *ALL *CFG, *DLO, *IFS, *LIB, *OBJ, *SECDTA.
Default value is *ALL.
LABEL - Label: Specifies the label names to list. For save types *OBJ and *LIB, this will be the library name.
For other save types, it will be the TYPE value.
Default value is *ALL.
PERIOD - Time period of save: Specifies the date range for when the save operations were performed.
Default value is *BEGIN.
SYSTEM - System: Specifies the system that objects were saved from.
Default value is *ALL.
TEXT - Text 'description': Specifies the text associated with a LaserVault SAV command. The groups
returned will have any text description that contains this value.
Default value is *ALL.
ORDER - Sort order for list: Specifies the order in which the list is returned.
Valid values are *DATE, *LABEL, *TYPE, *SYSTEM, *TEXT; and *DESCEND, *ASCEND.
Default value is *DATE and *DESCEND.
SAVLIBTST - Save Library to Test API
This command allows you to perform a mock save of a single library using the QANESAVA API that LaserVault
Backup uses. The data resulting from this backup is not stored anywhere.
This is provided for the purpose of helping you to determine how much of your backup time to LaserVault is a
result of the processing time required on the AS400 system, and how much of your backup time is a result of
the transmission of the data to the LaserVault Backup server.
Command Parameters:
LIB - Library: Specifies which library to be saved.
This is a required parameter.
TGTRLS - Target release: Specifies the release level of the operating system on which you intend to use the
object being saved. Valid values are *CURRENT, *PRV. Default value is *CURRENT.
UPDHST - Update history: Specifies whether the save history information of each saved object is changed
with the date, time, and location of this save operation.
Valid values are *YES, *NO.
Default value is *YES.
PRECHK - Object pre-check: Specifies whether objects are checked to see if they can be saved prior to
beginning the actual save operation.
Valid values are *YES, *NO.
Default value is *NO.
SAVACT - Save active: Specifies whether an object can be updated while it is being saved.
Valid values are *NO, *YES, *SYNCLIB, *SYSDFN.
Default value is *NO.
SAVACTWAIT - Save active wait: Specifies the amount of time to wait for a lock on an object, if it is not
available, before continuing the save. Special value of *NOMAX is available for use.
Default value is 120.
SAVACTMSGQ - Save active message queue: Specifies the message queue that the save operation uses
to notify the user that the checkpoint processing for a library is complete.
Default value is *NONE.
ACCPTH - Save access paths: Specifies whether the logical file access paths that are dependent on the
physical files being saved are also saved.
Valid values are *NO, *YES.
Default value is *NO.
SAVFDTA - Save file data: Specifies, for save file objects, whether the description of a save file, or both the
description and the contents of a save file, are saved.
Valid values are *NO, *YES.
Default value is *YES.
TCPSPDTST – TCP Speed Test
This is a program provided for your use in determining the effective throughput of your network connection to
the LaserVault Backup server. The test will be performed on LaserVault server 1. You invoke it with the
following command:
CALL LASERVAULT/TCPSPDTST