UPSTREAM Parameters
Overview
As for the Configurator, UPSTREAM allows you to set parameters in several prioritized ways. Each priority level higher overrides the value of a lower value. If two parameters are set the same way, then the newer overwrites the older. The ways from lowest to highest are:
Default
Used if a default is known and it is acceptable.
Parameter File
This is a value that is obtained from the default parameter file (UPSTREAM.DAT) or a parameter file specified from a higher priority. For example, in UPSTREAM.DAT you see a line like:
DISPLAY YEnvironment
These are values set using the DOS SET=<name> command. These values can be set from the command line or from a batch file. For example, you could add a line to your AUTOEXEC.BAT that would say:
SET PARAMETER=”C:\Program Files\Innovation Data Processing\UPSTREAM\US1.DAT”Command Line
When running US.EXE, add the parameter on the same line, parameters separated by spaces. For example, to start UPSTREAM:
uscmd PARAMETER=”C:\Program Files\Innovation Data Processing\UPSTREAM\US1.CFG”User (dialog)
When you enter parameters from a dialog, these values are ALWAYS used.
Set a parameter using a keyword (upper and lower case can be mixed), followed by a separator (a blank or an equal sign) followed by the value. Parameters from the environment and the command line must use an equal sign as the separator.
If using the dialogs in the UPSTREAM local program or the UPSTREAM Director and saving the parameters to a parameter file, you can print out the results to see how parameters can be specified.
Non-Repeating Parameters
The following describes the all the overall parameters. These parameters do not repeat and are listed before the first SPECNUMBERparameter.
ACCEPTPCREMOTE
Y - Accept and process remote requests originating from a PC (not a z⁄OS batch job).
N - Reject remote requests from PCs.
Default: Y.
ACCEPTREMOTE
Y - Accept and process remote requests.
N - Reject (but look for) remote requests.
Default: N.
ACTION
The function to be performed:
0 - Restore (or workstation receive file transfer).
1 - Backup (or workstation send file transfer).
2 - As of...Restore.
3 - Wait for remote initiate.
4 - Restart only.
5 - Run a job.
6 - Kill last restartable backup.
7 - Run host report.
8 - Restart restores only.
9 - Kill restartable restore.
10 - Submit a host job.
11 - Migration.
12 - Inquire Versions.
13 - Performance test.
14 - Physical disk/FDRSOS restore.
15 - Physical disk backup.
16 - Delete backup.
17 - Register target name.
18 - Inquire files.
19 - UPSTREAM/SOS Local Backup Disk Report.
20 - Director report.
21 - Restart service (must be idle)
22 - Restart service (will kill any active processing)
Default: 1.
ACTIVATEONENTRY
(DOS only)
Y - Activate the session on startup.
N - Do not start APPC on US.EXE start.
Default: Y.
ASCTOEBC
When specified, the user loadable ASCII-to-EBCDIC translation table gets loaded.
Default: USATOE.TAB.
ASRBACKUP
Describes whether ASR recovery files are generated:
0 - Do not generate ASR recovery files
1 - Generate the ASR files to disk.
2 - Generate the ASR files and create the diskette while performing the backup.
Default: 1.
ATTENDED
This parameter is ignored when it is received from remote systems; only used in UPSTREAM parameter files.
Y - It is assumed that there is a user present to make prompted decisions.
N - Unattended mode. It is recommended that you also specify a MESSAGETIMELIMIT as well.
Default: Y.
AUTHORITATIVE
(Windows 2000/XP/2003) Controls how a replicated resource such as a domain controller’s Active Directory and SYSVOL or a cluster’s database should be handled.
Default: N.
BACKUPPROFILE
The profile name used for backups, restores, and as of...restores. You can specify up to 8 characters.
Default: NONE.
BACKUPPROFILE2
Used internally
Default: NONE.
BACKUPVERIFY
Only used for full-merge backups with z⁄OS Storage Server. If Y, UPSTREAM reads and compresses the data, but not send it to the Storage Server. A checksum of the data is compared against a checksum on the Storage Server. If a mismatch occurs, the file is transmitted. As it degrades performance, it is only recommended with slow lines when you wish to verify non-file data.
Default: N.
BLANKTRUNC
(File Transfer only) (Only used if LINEBLOCK=Y.)
Y - Trailing blanks at the end of each record are removed.
N - Trailing blanks are retained.
Default: Y.
CALCDASDSIZE
N - If you are performing a sequential disk backup the amount of space allocate on z⁄OS for the backup depends on the amount of file data found.
Y - If you are performing a sequential disk backup the amount of space allocated on z⁄OS depends on the amount of file and non-file data found.
Default: N.
COMPRESSLEVEL
(Backups only) Specifies the compression level:
0 - No compression.
1 - Fast compression.
2 - High compression 1.
3 - High compression 2.
4 - High compression 3.
5 - zLib compression. To use zLib hardware compression on z/OS Unix you must give the UPSTREAM client user READ access to the FPZ.ACCELERATOR.COMPRESSION SAF facility. There are no specific requirements on other systems.
Default: 1 for most systems, 0 for USS or z/Linux.
CONTROLFILE
If USECONTROLFILE is active, the name of the control file/pipe for controlling UPSTREAM functions from an outside program.
Default: None.
DASDOVERRIDE
Allows you to override the amount of space (bytes) requested on a sequential disk backup. 4 forms:
+<number> - Add the given number of bytes to the total calculated.
-<number> - Subtract the given number of bytes from the total calculated.
<number>% - Use the given percentage to calculate the total.
<number> - Use the given number to override any calculated value. If specified for a local backup restore, can be used to increase the space allocated for the restore. Can only be specified as a hard number in this mode (+,-,% are disallowed).
Default: 100%.
DIRONLYRESTOREOK
Allows you to specify whether the inability to restore any files should fail the restore, if it runs to completion.
Default: Y
DISASTERRECOVERY
Should be “N”, unless you are restoring a dead system (possibly with different hardware).
Default: N.
DISPLAY
Y - Backup or restore status information continually updated.
N - No status display during the backup or restore.
Default: Y.
DUALCOPY
Not used.
Default: N.
Default:
EBCTOASC
When specified, the user loadable EBCDIC-to-ASCII translation table gets loaded.
Default: USETOA.TAB.
ENCRYPT
Whether to encrypt the data (Y - and separate license required) or not (N).
Default: N
ENCRYPTLEVEL
If encryption is enabled the level.
0 - AES128
1 - AES192
2 - AES256
Default: 0
ENVFILE
A file to look for environment variables in (in addition to usenv.dat)
EXCLUDELISTNAME
Enter an exclude list file name, formatted as described in the Exclude List section.
Default: None.
FAILIFSKIP
If set to “Y” for a backup and there are skipped files, the backup runs almost to completion but is failed so that both sides are aware of the skipped files and can take appropriate action.
Default: N.
FAILJOB
If specified, this job is run if the current function fails and UPSTREAM is in unattended or Storage Server initiated mode.
Default: None.
FILETRANSFER
Y - This is a file transfer (the ACTION parameter controls whether it is a send or a receive).
N - This is a backup or restore.
Default: N.
GETREMOTEFILES
(Backups only) Whether the “Show” check-box is checked in the backup dialog.
Default: Y.
HARDLINKDB
If set to “Y”, a database of hard links is built on the local system that notes if a hard link is moved by a compaction or other process.
Default: Y.
HOLDTAPE
If “Y”, UPSTREAM holds the tape for 2-3 minutes after a tape backup waiting for another one for the same profile to come in. This is primarily used for DataTools backups.
Default: N.
HOLDUSERDIRS
If specified as “Y”, all user home directories are accessed and held throughout the duration of the backup. Particularly useful for IBMZ Unix full system backups where the auto-mounter is used to mount user’s file systems.
Default: Y for System z Unix, N for all other system types.
HOSTFILENAME
(File Transfer only) If specified the name of the z⁄OS Storage Server file. If not specified, the z⁄OS Storage Server generates a name for workstation sends, or uses the latest recorded file transfer for workstation receives.
Default: None.
HOSTRECORD
(File Transfer workstation sends only)
Y - Transferred files are recorded in the z⁄OS Storage Server database for easy retrieval.
N - Transferred files are not recorded in the z⁄OS Storage Server database.
Default: Y.
HOSTSORT
Y - You wish the Storage Server sort utility used for restores or the backups sorted by file name.
N - You do not wish the Storage Server sort utility used for restores or the backups sorted by file name.
Default: N.
INCRDB
If set to “Y”, UPSTREAM maintains a local database of files backed up in the work path.
Default: N.
INCRDBARCHIVEBIT
Y - The archive bit is used along with modification date/time and size to see if a file has changed.
N - The archive bit is ignored when determining if a file has changed.
Default: N.
INCRDBDELETEDFILES
Y - UPSTREAM detects and transmits to the Storage Server when a file is deleted during merge incremental backups.
N - Incremental backups do not detect deleted files.
Default: Y.
INQOPTIONS
(Merge Inquiries and Restores) (New value) A bit map of options used during an inquiry and restore:
0 - Inquiries and restores only show normal files and the highlighted backup.
1 - Inquires show migrated files as well as normal files.
2 - Inquires and restores use “Highlighted back to full”. This option must be on for “Highlighted back to FDRSOS” (32).
4 - Inquires operate from the currently highlighted backup to the first version “Highlighted back to oldest”
8 - (not used).
16 - Only display migrated files in an inquiry.
32 - Restore “Highlighted back to FDRSOS”. You must also have value 2 on as well “Highlighted back to full”.
64 - Expiration date is displayed for migrated files.
128 - Force directories to be sent first.
Default: 2.
IGNOREPLUGINSFORRESTORE
If specified as “Y”, a file (or logical file) backed up with a PlugIn can be restored to a regular file. This method is turned on only when you do a restore of a PlugIn controlled file from the “Restore and Inquiry (old)” panel.
Default: N.
JOBOPTIONS
(Request job) A bit map of options used when a job is requested and started:
0 - Start job and immediately terminate UPSTREAM.
1 - Start job and do not terminate UPSTREAM.
2 - Wait for job to be terminated.
4 - Kill the job if it runs longer than the JOBWAITTIMELIMIT number of milliseconds or when UPSTREAM terminates. Also sets value 2.
8 - No job, terminate the current UPSTREAM program. Terminates the parent as well if running in automatic attach manager mode.
16 - (UNIX) Run the job using exec() (Internal use only).
32 - Write the STDOUT and STDERR output from the job to the UPSTREAM log and back to the Storage Server (if CONV=WAIT and value 1 is specified above). Implicitly sets value 2 above.
Default: 35 (start job, wait for it to complete, and report all output).
JOBRETURNCODEMAP
(Request job) For CONV=WAIT jobs, a mapping between the workstation return code and the Storage Server job return code. You can specify multiple mappings (including workstation return code ranges), the “?” used for all unassigned workstation return codes.
Default: 0:0 ?:8.
JOBWAITTIMELIMIT
(Request job) The number of milliseconds that UPSTREAM should wait for the job to complete.
Default: 0.
KEEPALIVE
For FDRSOS Local Backups, this parameter allows you to tune how often (in seconds) “Keep Alives” are transmitted to the Storage Server. Keep Alives are used to tell the Storage Server how much data the PC has written and allows the Storage Server to read the data from the disk as the PC is writing it.
Default: 2.
LANINTERFACE
(No longer used)
Default: 0.
LANWSNAME
(No longer used)
Default: NONE.
LANWSPASSWORD
(No longer used)
Default: NONE.
LATESTVERSION
(Restores only)
Y - You wish to restore the latest backup available for the backup profile (VERSIONDATE ignored).
N - You specify a specific backup with VERSIONDATE.
Default: Y.
LINEBLOCK
(File Transfer only)
Y - Records are separated by CR/LF (LF only for UNIX) for workstation sends; CR/LF (LF for UNIX) is added at the end of each record for workstation receives.
N - All records are separated by the record size (workstation sends).
Default: Y.
LINETRUNC
(File Transfer only) (Only used if LINEBLOCK=Y for workstation sends).
Y - Data exceeding the record size is truncated.
N - Data exceeding the record size is sent as a separate record.
Default: Y.
LISTENFORREMOTE
Y - Your system listens for remote requests.
N - Your system does not listen for remote requests (should only be “N” if you NEVER receive a Storage Server or remote PC request or you are running in attended mode).
Default: N. (Y for uscmd).
LOCALBACKUP
0 - Storage Server storage is used exclusively for backups and restores.
1 - Whether during a backup files should be stored locally as well as the Storage Server; during a restore whether files should be taken from local storage whenever possible.
2 - Local backups are stored on shared EMC FDRSOS Local Backup disks.
Default: 0.
LOCALBACKUPDIR
If local backups are enabled to:
- 117_List2_Bullet_1068579 – Disk (LOCALBACKUP=1) the name of the directory where the local backup files are stored.
- 117_List2_Bullet_1068583 – FDRSOS (LOCALBACKUP=2) the internal UPSTREAM name of the disk where the data is stored.
Default: None.
LOCALBACKUPMAX
(Backups only) The maximum number of local backup files (each backup is one file) stored on a workstation.
Default: 3.
LOCALBACKUPMAXFILESIZE
(Backups only) The largest file that is stored locally if local backups are enabled.
Default: 10000000.
LOCALBACKUPMAXSIZE
(Backups only) The largest that a local backup file grows.
Default: 100000000.
LOCALPASSWORD
The password of the remote user who wishes to logon to this system.
Default: None.
LOCALRESTORE
(UPSTREAM SOS Restores)
Y - UPSTREAM SOS restores flow entirely through the local backup disk, with little network overhead. This entails creating a new “backup” to hold the data which does not currently exist on the disk.
N - UPSTREAM SOS restores use the data on the local backup disk if it currently is stored there. All other data flows through the network.
Default: Y.
LOCALUSER
The local user name of the remote user that wishes to logon to this system.
Default: None.
LOGJOBDETAILS
Whether elapsed and CPU times should be logged with completed backups and restores.
Default: N
LOGNONFATAL
0 (or “N”) - Nonfatal errors during a backup or restore are not logged or displayed.
1 (or “Y”) - Nonfatal errors during a backup or restores are logged and displayed.
2 - Only messages during a backup that result in a skipped file are transmitted to the Storage Server.
Default: 2.
MAXBACKUPFILESFAIL
The maximum number of files backed up successfully in a backup before the backup fails for being too large. Keeps backups from running away with too many files to be backed up in a reasonable amount of time. 0 indicates no maximum number of files.
Default: 0.
MAXBACKUPTIME
The number of minutes before a backup or migration terminates due to excessive time. 0 indicates no termination for time.
Default: 0.
MAXKFILESIZE
Allows you to exclude files which are larger than the specified size (in 1024 byte multiples). 0 indicates no file size exclusion.
Default: 0.
MAXLOGDAYS
If non-zero, clears out old log file entries after a backup. Specifies the number of days worth of log information to preserve.
Default: 0.
MAXRESTOREFILESFAIL
The maximum number of files restored successfully in a restore before the restore fails for being too large. Keeps restores from running away with too many files to be restored in a reasonable amount of time. 0 indicates no maximum number of files.
Default: 0.
MAXRESTORETIME
The number of minutes before a restore terminates due to excessive time. 0 indicates no termination for time.
Default: 0.
MAXRPTDAYS
The number of days to keep in the current report file. 0 prevents clearing.
Default: 0.
MERGE
(Backups/Migrations) The backup type:
0 - No merge used (for migration: simple migration).
1 - Full merge (for migration: full merge migration).
2 - Incremental merge (for migration: not defined).
3 - First-time merge backup (for migration: migration end-set).
Default: 0.
MINCOMPRESSSIZE
The smallest a file can be (in bytes) to be eligible for compression
Default: 65536
MINIMIZE
Allows UPSTREAM, when running unattended, to start minimized.
Default: N.
MODIFYFILE
Y - Incremental backups are determined by the last date/time UPSTREAM was run (stored in the modification file).
N - Incremental backups are determined by the archive bit.
Default: Y (UNIX) N (all others)
NEWFILECOMPARE
(Windows only) If set to “Y”, UPSTREAM uses more advanced wild-carding, such as honoring multiple dots.
Default: N (Y for WinSS).
NOPOINTRESTORE
(Restore only) If set to “Y”, the restore searches through the tape sequentially rather than directly, significantly slowing the restore. Should only be set under the direction of BMC Support.
Default: N.
NOSPECINHERITANCE
Y - UPSTREAM disables the inheritance of file specification parameters from spec to spec.
N - All file specification parameters are inherited from spec to spec.
Default: N.
NOTIFYEVENTS
If a NOTIFYTARGETS parameter is specified, the conditions in which a notification occurs. This is a bit map, where you add the notification values:
1 - Notify if the action failed.
2 - Notify if the action succeeded.
4 - Notify for any errors.
8 - Notify for any warnings.
16 - Notify for any informational messages.
256 - Attach the log if the action failed and value 1 is specified.
512 - Attach the report if the action failed, value 1 is specified and reporting is enabled.
1024 - Attach the log if the action succeeded and value 2 is specified.
2048 - Attach the report if the action succeeded, value 2 is specified and reporting is enabled.
Default: 769 (action failed + attach log + attach report).
NOTIFYFAILUREATTACHMENT
The file name to send if a file should be attached on operation failure. You must also specify a NOTIFYTARGETS file.
Default: None.
NOTIFYSUCCESSATTACHMENT
The file name to send if a file should be attached on operation success. You must also specify a NOTIFYTARGETS file.
Default: None.
NOTIFYTARGETS
The name of the notification targets file name if you wish to enable notification.
Default: None.
NOVELLRECALL
Obsolete parameter.
NTREGRESTORE
Obsolete parameter..
OSTYPE
Used by the Director to indicate the operating system type of the target.
Default: None.
OUTPORT
If specified, overrides the configuration specified outbound IP port for the Storage Server.
Default: Configuration value.
PACKFLUSHAFTERFILE
Y - Forces a packed record in a backup to be transmitted after each file.
N - Records are fully packed.
Default: N.
PACKRECSIZE
The maximum number of bytes transmitted or received from the Storage Server. Used only if the value is greater than 65400 to specify large record packing (must have z/OS v3.9.1 or Reservoir 3.9.0c) Otherwise, no longer used (see environment variables USBACKUPPACKRECSIZE and USRESTOREPACKRECSIZE).
Default: 65400.
PARAMETER
The name (and optionally the path) of the parameter file to read parameters from.
Default: rmtparm.dat for UNIX, wait.dat for Windows.
PASSWORD
Your password. This is usually required if the user ID is required. You can specify up to 32 characters. If UPSTREAM generates this field in a parameter file, then it is encrypted. In attended mode the password is not read from a parameter file (but can be accepted from the command line or environment).
Default: NONE.
PERFORMBITMAP
A bit map of performance tests you wish to run:
1 - CPU test.
2 - Screen I/O test.
4 - File I/O (read) test.
8 - Backup, No I/O test.
16 - VSAM performance test.
32 - Raw communications test, Client send.
64 - Raw communications test, Storage Server send.
128 - Backup - no communications.
256 - Migration test with no deletes or communications.
Default: 96.
PERFORMNUMRECORDS
The number of records sent/received on raw communications performance tests. If running z/OS v3.9.1 or greater you can specify up to 1 million records, otherwise the maximum is 32700 (z/OS send) 65400 (z/OS receive). Reservoir allows up to 4 billion records.
Default: 100.
PERFORMRECORDSIZE
The size of records send/received on raw communications performance tests. If running z/OS v3.9.1 or greater you can specify up to 1 million bytes, otherwise the maximum is 32700 (z/OS send) 65400 (z/OS receive). Reservoir 3.9.0c allows up to 4 billion bytes, earlier versions limited to 65400
Default: 32700.
POSTJOB
If defined, this is the name of a program, batch file or script file that is run after the unattended UPSTREAM function.
Default: None.
PREJOB
If defined, this is the name of a program, batch file or script file that is run before the unattended UPSTREAM function.
Default: None.
PRTYCLASS
(OS/2, Windows only) The priority class for the requested action:
1 - Idle-time.
2 - Regular.
3 - Time-critical (VERY DANGEROUS).
4 - Fixed-high.
Default: 4.
PRTYLEVEL
(OS/2, Windows only) A number from 0 to 31 (OS/2) or 0 to 8 (Windows, where 0 and 1 are resolved as 8) modifying the priority class.
Default: 1 (OS/2); 8 (Windows).
RECALLCLEANUP
Y - UPSTREAM examines Novell auto-recall stub files to determine if any have expired, and if any have, they are deleted.
N - Auto-recall stub files are not deleted.
Default: N.
RECORDSIZE
Obsolete. USERECORDSIZE is the current parameter.
REMOTEADDR
(Remote requests only) If the remote PC is connected via TCP/IP, this is its IP address.
Default: None.
REMOTEAPPLPREF
(Remote routed requests) The 5 character prefix USTBATCH uses to build its own VTAM APPLID value.
Default: UPSTR.
REMOTEAPPLRETRY
(Remote routed requests) If USTBATCH cannot find a free VTAM APPLID (see APPLPREF), it waits for 5 seconds and retries. The default count of 240 causes USTBATCH to retry every 5 seconds for about 20 minutes.
Default: 240.
REMOTECONNECTTYPE
(Remote requests only) The method used to send the request to the remote Client.
0 - The remote request is via the Storage Server and the LUNAME or TCP/IP address/port number are specified.
1 - The remote request is directly PC-to-PC.
2 - The remote request is via the Storage Server and a registered name is specified.
Default: 0.
REMOTEFLAGS
(Remote requests only) A bit map indicating how a client-to-Storage Server-to-client request is handled.
1 - The request is queued on the remote PC.
2 - There is a single conversation between the Storage Server and the remote client; the client does not deallocate when the request is received.
4 - The requesting PC waits until the process has completed on the remote PC.
8 - This is a z⁄OS Storage Server command rather than a client-to-client request. If specified you must also specify a REMOTEPARAMETERFILE with the command.
Default: 0.
REMOTEIPADAPTER
(Remote routed requests) The IP address of the adapter that Storage Server uses for its outgoing TCP/IP connections to the target system.
Default: None.
REMOTELOCALPARAMETERS
(Remote requests only)
Y - Use parameters defined on your PC.
N - Use a remote parameter file. (The parameter REMOTEPARAMETERFILE must be specified).
Default: N.
REMOTELOGMODE
(Remote routed requests) The VTAM logon mode entry name that is used by z⁄OS Storage Server to establish a session to APPC target workstations.
Default: #INTER.
REMOTELUNAME
(Remote requests only) The LU name (or alias if DCA/Microsoft select PC-to-PC) of the remote system.
Default: NONE.
REMOTEMAXRETRIES
(Remote requests only) If REMOTEPCTOPC=N, this is the number of times the Storage Server attempts to connect to the remote PC.
Default: 0.
REMOTEMODENAME
(Remote requests only) The mode name used to contact the remote system.
Default: USTMODE.
REMOTEPARAMETERFILE
(Remote requests only) The parameter file on the remote PC to execute (if REMOTELOCALPARAMETERS=N).
If you specified REMOTEFLAGS with a value of 8, then this is the Storage Server command to execute.
Default: upstream.dat.
REMOTEPORT
(Remote requests only) If the remote PC is connected via TCP/IP, this is its IP port.
Default: 1972.
REMOTEREQUEST
Y - You are requesting a function be performed on another client system.
N - You are requesting a local function.
Unless you are requesting another client to perform a remote function specify “N”.
Default: N.
REMOTERESTART
(Remote routed requests) Automatic restart of backups and restores. There are two comma separated parameters: number of times to restart and the number of minutes between restart attempts.
Default: 0,0.
REMOTEROUTE
(Remote routed requests) Whether remote requests should be direct or routed via the Storage Server.
Default: N.
REMOTETARGETNAME
(Remote requests only) Fill in a value if you wish to find the remote computer by registered name rather than LU name or IP address.
Default: None.
REMOTETCP
(Remote requests only)
Y - The remote PC is connected via TCP/IP.
N - The remote PC is connected via SNA.
Default: N.
REMOTETIMEOUT
(Unattended wait for remote) The number of minutes that the PC waits in unattended mode for a remote initiated function. 0 indicates wait until a user aborts the wait.
Default: 0.
REMOTETMAXRETRY
(Remote routed requests) If USTBATCH connects to z⁄OS Storage Server and z⁄OS Storage Server is at its maximum task limit, it retries every 10 minutes for the count specified here. 0 indicates no retries.
Default: 0.
REMOTETPN
(Remote requests only) The transaction program name to be used in initiating contact with the remote system.
Default: UPSTREAM.
REMOTEUSAPPL
(Remote routed requests) The VTAM APPLID of the online z⁄OS Storage Server task.
Default: UPSTREAM.
REMOTEVERIFY
(Remote routed requests) Causes z⁄OS Storage Server to verify the client parameters.
Default: Y.
REMOTEWTOCOMP
(Remote routed requests) If CONV=WAIT is specified (REMOTEFLAGS=4), USTBATCH issues a UST747 message indicating the success or failure of the request.
Default: N.
REPORTNAME
The name of the file to write reporting information to.
Default: upstream.rpt (in the work path)
REPORTCSV
Allows you to request host reports (ACTION=20) in comma, separated, value form if the report type supports CSV reports
Default: N
REPORTOPTIONS
A bit map describing any of the report features you wish to enable:
1 - Files backed up/restored.
2 - Files skipped during the backup.
4 - Files automatically deleted.
8 - Inquire versions
16 - Inquire files
32 - Specified parameters.
64 - Inquire versions summary only.
256 - Files excluded (restores only).
512 - Report in Unicode.
1024 - Segments included in backup/restore report.
2048 - Files being asked for in phase 3 (unmatched files) of full merge.
4096 - Files/directories sent.
Default: 0.
RESTARTLASTFILE
The file you wish your restore to start after. Allows manual restore restarts. UNC names must be specified with !:\ rather than \\.
Default: None.
RESTARTTYPE
Specifies the action to be performed, at a restart point (usually the next time UPSTREAM is run), if there is a restartable error during a backup. Restores are automatically restartable.
0 - Never restart.
1 - Restart failed files and incomplete backups
2 - Restart only incomplete backups.
Default: 0.
RESTARTVERSIONDATE
If you specify a restartable action type, the version date of the backup or restore that is being restarted. If the field is left blank, the most recent backup/restore is restarted.
Default: None.
RESTOREARCHIVEBIT
If “Y”, archive bits are set for files that are restored.
Default: N.
RESTORECHECKPOINT
The number of seconds between automatic checkpoints when performing a restartable restore or a restartable physical disk backup.
Default: 120.
RESTOREFILEFAIL
(Windows only) Allows you to specify what to do if a file is locked when you attempt to restore it:
0 - Fail the file.
1 - Restore the file to a generated name.
2 - Restore the file to a generated name, and rename the file to its original name after a reboot.
Default: 0.
RUNASUSER
(UNIX) Allows you to specify the non-root user name to impersonate.
SAN
(Reservoir only)
Y - Backup and restore data is written to or read from the tape drive directly. You must either be running on the Reservoir machine or have configured a sandrives.txt.
N - Backup and restore data is transmitted over the LAN.
Default: N.
SENDHOSTDETAILS
N - Only the first line of an error is sent to the Storage Server.
Y - All message lines of a message are sent except additional description lines from the message file.
Default: N.
SKIP
(Restores only) For restores using “List and Restore”, a set of options of how to process existing files:
0 - Restore all files regardless of whether there are existing files.
1 - Restore only files where there is no existing file of the same name.
2 - Restore only files where the existing file’s modification date/time and size are not the same.
3 - Restore only files which have been marked for UPSTREAM NetWare auto-recall.
4 - Restore only files which have 0 length.
5 - Restore only files which are newer than those stored on disk.
Default: 0.
SKIPBACKUPSCAN
If enabled, UPSTREAM does not prescan the disk for files to backup but performs the scan while the backup is running. Only recommended in certain cases due to the lack of a size estimate. Ignored in many cases (including WinSS, etc.).
Default: N.
SMSTARGETSERVICENAME
Obsolete parameter.
SMSTSA
Obsolete parameter.
SNAPSHOT (Linux only)
Has UPSTREAM perform either a btrfs file system snapshot or LVM snapshot of the data to be backed up (SNAPSIZE is used if LVM). If the option is specified but one or more file systems can’t be snapped, a message is logged and the data is backed up traditionally.
Default: N
SNAPSIZE (Linux LVM snapshots only)
If UPSTREAM is performing a LVM snapshot of a volume, it must allocate a separate volume to hold the copy-on-write data. By default, it takes the size of the existing volume, and then uses 10% of that. However, you can specify the volume size directly in bytes, ‘k’, ‘m’, ‘g’, or ‘t’
Default: 10% (of the snapped volume size)
SOLO
(Reservoir ustbatch only) If set to “Y”, the Reservoir holds this job until it is the only active job in the system.
Default: N.
SORTBACKUP
Sorts the backup in the same order as the Storage Server uses. May result in slightly reduced FILE_INFO overhead.
Default: N.
STARTTIME
A 12 digit date/time YYMMDDHHMMSS which can be used to have multiple backups start at a synchronized time.
Default: None.
STORAGETYPE
(Backups only) How the data is stored on the Storage Server.
0 - Archive backup. Merged to tape when the next archive is performed on the mainframe. No longer supported.
1 - Keyed/duplicate backup. Stored on mainframe disk until rolled off.
2 - Sequential disk. Stored on Storage Server flat files.
3 - Sequential tape. Stored directly to Storage Server tape.
Default: 3.
SWITCHTOTAPEMB
If non-zero, disk backups are sent to tape if the calculated size of the backup (after DASDOVERRIDE is applied) is greater than or equal to this value. Specify in megabytes (1,048,576 bytes).
Default: 0.
TCPADDRESS
If specified, overrides the configuration specified IP address for the Storage Server.
Default: Configuration value.
TCPTIMEOUT
The number of seconds of inactivity before a TCP/IP send or receive times out. 0 disables the timeout. If you specify a non-zero timeout, you should also specify a large (65535) configuration TCPSENDBUFFER and TCPRECVBUFFER.
Default: 0.
TIMEOVERRIDE
(Win32) Overrides the time settings specified in the configuration for a given backup:
0 - Configuration value is used.
1 - Standard time.
2 - Daylight savings time.
3 - Greenwich Mean Time.
Default: 0.
TRACE
Use only when instructed by BMC Support.
Default: N.
TRANSLATE
(File Transfers only)
Y - ASCII/EBCDIC translation is performed on all data (assumes text).
N - No translation of the data (assumes binary).
Default: Y.
ULTRACOMP
(No longer used)
Default: 4.
ULTREG
(No longer used)
Default: N.
ULTUPD
(No longer used)
Default: N.
USECONTROLFILE
If “Y” you can control UPSTREAM functions from an outside program via a pipe or file.
Default: N.
USERECORDSIZE
(Backups only) The actual record size to be used in the backup. 0 says to use the default.
Default: (Reservoir) 32695; (z/OS) Disk: 27968, Tape: 32695, z/OS to disk with no compression with a file size between 10,000 and 50,000 bytes uses 8192.
USERID
Your security identifier. This may be required by some z⁄OS or Reservoir systems (see your UPSTREAM system administrator). You can specify up to 32 characters.
Default: NONE.
UTF8
(Windows)
Y - UTF-8 unicode encoding
N - UPSTREAM unicode encoding.
Default: N.
VAULTNUMBER
(Reservoir Restore only) If restoring from a Reservoir vault, the vault number to restore from. 0 indicates regular backups.
Default: 0.
VERSIONDATE
(Restores only) For a restore, if you specified LATESTVERSION=N, then you are required to specify a complete version date. This is usually used with an inquire versions command. The version date is exactly 12 numeric characters.
Default: NONE.
XFERECORDSIZE
(File Transfers only) The record blocking size for file transfers. Users often use 80 for text files as well.
Default: 8192.
XFERRECSEP
(File transfer) Specifies the record separator if you have specified LINEBLOCK=Y. Most of the time you want to use the line feed (decimal 10).
Default: 10.
XFERRECUSECR
(File transfer) Indicates whether a preceding carriage return should be stripped or added to a file being file transferred.
Y - (PC).
N - (UNIX).
ZLIBFAILIFNOZEDC
(z⁄OS UNIX Backups only) Since there is hardware support built into many z⁄OS processors, and since z⁄OS UNIX supports it and since the overhead of zLib is unacceptable if there is no hardware support installed, the default value is Y, which is to fail if there is no zEDC installed and accessible.
Y - Fail is the software supported zLib is to be used on this z/OS UNIX Backup.
ZLIBLEVEL
(Backups only) If you specify COMPRESSLEVEL 5 (zLib), then this is the zLib level to be used. Values can range from 0 (no compression) to 9 (maximum compression)
6 - Default for most systems
18.3 Repeating Parameters
The following describes the file spec parameters. These parameters repeat for each file spec (SPECNUMBER or SPEC) defined.
ARCHIVEBIT
(Backups only)
Y - The archive bit is reset for all files successfully backed up.
N - The archive bit is not reset.
Default: Y (not used for WinSS).
AUTHORITATIVERESTORE
(Win 2000) No longer used.
Default: N.
BACKUPREPARSEFILES
(Windows only)
0 - Skip files with Reparse Points.
1 - Open files without using Reparse Points.
2 - Open files using Reparse Points.
Default: 1.
CHANGEDIRATTRIBS
(UNIX) If set, UPSTREAM changes owner/group/mode for existing directories; otherwise existing directory attributes are preserved.
Default: Y.
DATELIMIT
(Backups and Migrations only) Allows inclusion or migration of files based on modification date. If you enable this parameter you must also specify a LATESTDATE.
0 (or N) - This feature is disabled.
1 (or Y) - Files after the LATESTDATE (and LATESTTIME for UNIX) are included/migrated.
2 - Files before the LATESTDATE (and LATESTTIME for UNIX) are included/migrated.
Default: N.
DAYSOLD
(Backups and Migrations only) The number of days (less 1) that a file has not been accessed before inclusion in the backup or migration.
Default: 180.
DELETED
(Not used at this time)
Default: N.
DELETEPROMPTS
Obsolete parameter
DESTINATION
(Restores only) This parameter allows you to specify that files be restored to a different file or path name from which they were originally backed up. The wild-card specifications must match the wild-card specifications in the FILES parameter.
Default: NONE (goes back to the original location).
DIRDELETE
(Non WinSS Backups only)
Y - If automatically deleting files, remove directories where all of the files were deleted.
N - Leave the directories which were just emptied.
Default: Y.
DIRSONLY
(Restores only) Whether ONLY directories and no files should be restored:
Y - Restore only directories (no files).
N - Restore files and directories.
Default: N.
DRIVEALIAS
(Backups only) If specified, the drive letter transmitted to the Storage Server in lieu of the one specified in the FILES parameter. Allows you to move drive mappings without affecting merge backups. Specify a single letter (no trailing colon).
Default: None.
FAILBACKUPONERROR
If set to “Y”, the backup is failed if any files fail. This is particularly useful for some plugin backups where the failure of a single file is a failure of the entire backup.
Default: N (Y for snapshot backups)
FAILIFNOFILES
If “Y”, and UPSTREAM finds no files for this file spec, the backup fails.
Default: N.
FAILRESTOREONERROR
Y - The entire restore is failed if there is a file open or write error to any file in this spec.
N - File errors are logged and the restore continues.
Default: N
FILEDATE
The last modified date of a specific file to be restored. For internal use only.
Default: NONE.
FILEDELETE
(Backups only)
Y - Delete the files that were successfully backed up. Only used for a non-merge backup
N - Do not delete the files that were successfully backed up.
Default: N.
FILES
The file specification to be backed up or restored or the name of the job to run. This can include wild-cards.
(If physical disk/FDRSOS backup/restore) For restores of physical disk backups, specify: <:\location\*.* where location is the internal UPSTREAM physical disk form. For restores of FDRSOS backups, specify />_FDRSOS_BACKUP if the source was a UNIX disk or >:\*.* if the source was a PC disk.
Default: NONE.
FILESOPENFORUPDAT
Y - The maximum number of files are backed up:
- 117_List3_Bullet_1083715 • (Win32 and OS/2) backups do NOT use the DENY_WRITE file open attribute.
- 117_List3_Bullet_1083716 • (AIX) files opened for update by other applications are included. Not supported for other UNIX systems.
N - Standard file opens are performed.
Default: Y
HARDLINKS
Enables/disables hard links support for backups or restores. Ignored for WinSS backups and restores where hard links are managed internally.
Default: Y (UNIX); N (Win32)
HIDDENFILES
(Backups only) Whether hidden and system files should be backed up as well as normal files.
Default: Y.
INCREMENTAL
(Non-merge backups only)
Y - Only those files with the archive bit set (files that have changed) are backed up.
N - All files specified are backed up.
Default: N.
INSTALLWIN2KAGENT
Obsolete parameter.
LASTACCESS
(Backups and Migrations only)
Y - Only include files which have not been accessed for the number of days (or more) specified in the DAYSOLD parameter.
N - Don’t restrict by last access date.
Default: N.
LATESTDATE
(Backups and Migrations only) This parameter is only used if you specify DATELIMIT=Y. This field must be 8 characters and specify the date in the format MM-DD-YY, or it can be a +<number> or -<number> that indicates an offset in days from the current date.
Default: NONE.
LATESTTIME
(UNIX Backups and Migrations only) The time, within the LATESTDATE to back up the files. In HH:MM:SS form.
Default: NONE.
LOFS (Solaris only)
N - Skip Soloris loop back file system (lofs).
Y - Include lofs in the backup (this may cause backing up this data twice).
Default: N.
MIGRATED
(Obsolete. Use MIGRBITS instead.)
Y - Include migrated files in the restore.
N - Include only specified files in the restore.
Default: N.
MIGRBITS
(Restores only) How migrated files should be treated in a restore:
1 - Include migrated files in the restore.
2 - Include only migrated files (no regular files).
Default: 0
MOUNTPOINTS
(Windows 2000)
Y - If you wish to include a mount point and all its files in a backup.
N - To exclude the mount point and all files from the backup.
Default: N.
NDS
Obsolete parameter.
NFSBELOW
(UNIX Backups)
Y - Include NFS file systems in your backup.
N - Do not include NFS file systems in your backup.
Default: N.
NODIRFORINCREMENTAL
If specified as “Y”, UPSTREAM does not send directory entries to the Storage Server for incremental backups. This may cause important security information not to be backed up until the full, but results in significantly smaller incremental backups.
Default: N.
NONFILEDATABITMAP
An integer that defines the types of non-file data UPSTREAM attempts to backup or restore. The separate values are coded as powers of 2 and are then added to reach the total value. The default is all options on.
1 - OS/2 or NT extended attributes (files).
2 - OS/2 or NT extended attributes (dirs).
4 - Obsolete
8 - Obsolete
16 - Obsolete
32 - Obsolete
64 - Obsolete
256 - Preserve last access date.
512 - Obsolete
16384 - Windows or UNIX ACLs.
32768 - Obsolete
Default: 16643.
NOUIDGIDNAMES
When set to “Y”, UPSTREAM does not obtain the owner or group name of a file or directory during the backup. This may improve performance at the cost of not having it available for display in the Director, or for restore on a system where the numbers for the names may have changed (which is rare). Particularly valuable in USS performance when get to Y.
Default: N.
NOVELLMIGRATE
Obsolete parameter.
NOVELLMIGRATEADDEXT
Obsolete parameter.
NTFSADDPERMISSION
If enabled, and an UPSTREAM directory or file access fails for security on a NTFS volume, the user that UPSTREAM is running as is added to the ACLs for that directory or file.
Default: N.
PLUGIN
Allows you to specify the name of a DLL or shared library which can be used to extend UPSTREAM’s functionality.
Default: WinSS for Windows, None for UNIX.
PLUGINPARAMETERS
Parameters specific to the PlugIn. See the documentation for the PlugIn for more details.
Default: None.
RECALLOFFLINEFILES
(Windows 2000) Only used if BACKUPREPARSEFILES is 2.
Y - Recall offline files.
N - Backup offline files but do not recover them to disk.
Default: N.
RESTOREDATELIMIT
0 - This feature is disabled.
1 - Files AFTER the LATESTDATE are included.
2 - Files BEFORE the LATESTDATE are included.
Default: 0.
RESTOREMOUNTPOINTS
(Windows) Whether or how Windows mount points are restored:
0 - Do not restore.
1 - Verify before restoring.
2 - Recreate if necessary.
3 - Restore without verification.
4 - Restore without verification, with limited messages.
Default: 3
RESTORESEGMENTS
Y - Restore segmented files.
N - Do not restore segmented files.
Default: N.
RESTORETODIFFFS
(UNIX only)
N - UPSTREAM does not allow you to restore a file to a different file system unless you change the destination.
Y - You can restore files to any destination.
Default: N.
RETAIN
(Migration specs only) In a migration spec, the number of days that the file should be merged forward onto new full backups.
Default: 90.
ROOTENTRY
Y - A fake file: <Volume Information> is created for Windows backups containing non-file data for the volume itself.
N - This file is not created.
Default: Y.
SEGMENTEDFILESIZE
Specified in megabytes (multiples of 1,048,576 bytes) the minimum size that a file must be to be segmented.
Default: 0 (disabled).
SEGMENTSIZE
Specified in kilobytes (multiples of 1024 bytes) the individual files that a segmented file are broken down into.
Default: 1024.
SINGLEFS
(UNIX Backups and Migrations)
Y - Backup only the files in the file system specified in the file spec.
N - Backup all files in the file spec.
Default: N.
SKIPOLD
(Restores only)
Y - Only those files that are newer on the Storage Server are restored.
N - All files are restored.
Default: N.
SOSDISK
The source for backups and the destination for physical disk/FDRSOS restores, using the internal UPSTREAM physical disk format.
Default: None.
SOSTIMESTAMP
Y - Create a FDRSOS Timestamp file during the backup which is used at restore time to determine if a FDRSOS restore has been done if the Highlighted Back to FDRSOS restore option is selected.
N - Do not create a FDRSOS Timestamp file.
Default: N.
SOSTIMESTAMPPATH
If SOSTIMESTAMP=Y, if specified, this is the path where the FDRSOS timestamp file is written (for backups) or read from (for restores). If not specified the file is written/read at the specified backup directory.
Default: None.
SPEC
Can be used in place of the combination of SPECNUMBER and FILES.
Default: None.
SPECNUMBER
The header to this file set. Each file set begins with a SPECNUMBER definition with an ascending number starting at 1.
Default: 1.
SPECTYPE
0 - File specification is files to be included in the backup or restore.
1 - File specification is files to be excluded from the backup or restore.
2 - File specification is files to be migrated during the backup.
Default: 0.
SUBDIRECTORIES
Y - All subdirectories under the specified one are checked for files that match the file specification.
N - Only those files in the specified or default directory that match the file specification are transferred.
Default: Y.
UNCMACHINEALIAS
(non-UNIX) If specified with a UNC file spec, UPSTREAM substitutes the specified name for the real machine name in the spec sent to the Storage Server. This value must be the same size or smaller than the original machine name. This is particularly useful in Novell cluster environments - use the cluster name as the UNCMACHINEALIAS so that you can avoid first-time fulls if the cluster fails over.
Default: None.
USEGID
N - UPSTREAM restores files and directories by name rather than by GID.
Y - UPSTREAM restores files and directories by GID number rather than name.
Default: N.
USEOPTIMIZER (Linux only)
0 - UPSTREAM file reads and writes are done in the conventional manner
1 - UPSTREAM will pre-open and pre-read files to create enough data in memory for non-stop data flow to the storage server. This will take additional memory and other system resources and can be turned with Tech Support supervision.
2 - Same as 1, but with SKIPBACKUPSCAN so that the backup file is created at the same time as the backup runs. Same effect as USEOPTIMIZER 1 and SKIPBACKUPSCAN Y.
Default: 0
USEUID
N - UPSTREAM restores files and directories by name rather than by UID.
Y - UPSTREAM restores files and directories by UID number rather than name.
Default: N.
WRITESPARSE
The boundary number of bytes that a sparse file is written. Typically this is 8192.
Default: 0.
18.4 Environment Variables
UPSTREAM can be controlled in a variety of ways through environment variables. Environment variables are values that are set using the SET <variable>=<value> command from the command line.
You can also specify these values interactively within UPSTREAM, from a UPSTREAM parameter file, from the Storage Server, or from an environment file (usenv.dat) as well as the environment.
To specify these values interactively or to save these values to a configuration or parameter file, pull down the Action menu and select Set Environment from within UPSTREAM. Quite a few of these are visible in Director dialogs.
Environment variable settings most often are not in affect until UPSTREAM is restarted.
If you use usenv.dat, it must be in the UPSTREAM directory as it is loaded immediately on UPSTREAM start (before configuration or parameter files).
Many of these parameters can be inserted into Storage Server jobs as well as defined locally and are now recognized. At this time, they must be manually inserted into the job stream but they are not positional and can be inserted anywhere.
Many of these parameters must be defined in the environment. If you are unsure, contact BMC Support.
Many of these values are listed in other sections. This list is given as a convenience to allow a single point of reference for these values and is given in alphabetical order.
Some of these parameters are related and are listed here. For example:
- 117_List1_Bullet_1136581 • USEOPTIMIZER environment variables include:
- 117_List2_Bullet_1136649 – READERSCOUNT
- 117_List2_Bullet_1136664 – MAXLISTSIZE
- 117_List2_Bullet_1136677 – MAXDATABUFFERSIZE
- 117_List2_Bullet_1136696 – FILESIZEHIGHWATERMARK
- 117_List2_Bullet_1136719 – MAXNETMSGSIZE
- 117_List2_Bullet_1136734 – MAXNETMSGPACKEDSIZE
- 117_List2_Bullet_1136649 – READERSCOUNT
BACKUPBUFFERSIZE
(Windows, and UNIX) The number of bytes requested in each file block read and write. Since BACKUPBUFFERSIZE is used for file I/O, the RECORDSIZE parameter is thus only used for blocking to the Storage Server, not in reading/writing data off the disk.
Default: 262144
FILESIZEHIGHWATERMARK
Optimizer tuning parameter, defines the minimum size of files large enough to pre-read. Never set this variable without Tech Support assistance.
HOME
(UNIX only) The default UPSTREAM work path.
Default: None.
MAXDATABUFFERSIZE
Optimizer tuning parameter, defines the size of the read data buffer. Never set this variable without Tech Support assistance.
MAXFILENAMESIZE
(z/OS Storage Server Only) The maximum file name size supported. This must be large enough to hold the largest value before truncation. For the z⁄OS Storage Server truncation is enabled by default. (See Section “Long, Mangled File Name Support for UPSTREAM z⁄OS” for a description of this method) and the name is preserved in the data.
Default: 1023
MAXLISTSIZE
Optimizer tuning parameter, defines the number of members in the file queue. Never set this variable without Tech Support assistance.
MAXNETMSGPACKEDSIZE
Optimizer tuning parameter, defines the size of the network buffers. Never set this variable without Tech Support assistance.
MAXNETMSGSIZE
Optimizer tuning parameter, defines the size of the network queue. Never set this variable without Tech Support assistance.
NOMVSWILDCARDS
Use for successful inquiries and restores when using UPSTREAM PC v2.3.3 or later and the UPSTREAM Storage Server v2.3.1 or earlier.
Default: Disabled.
NOTES_DATA_DIRECTORY
(Notes R5/R6) The directory that contains notes.ini.
Default: Not defined.
Notes_ExecDirectory
The directory containing the Notes executables.
Default: Not defined.
NUMBACKUPTHREADS
(OS/2 and Windows) The maximum number of file open threads that are started and running. Specify “1” to disable the multi-threaded facility. Max value is 50.
Default: 3.
NUMECBS
The number of event control blocks used in the data transfer. A larger number increases LAN performance at the expense of memory. Do not set this value lower than 5 or greater than 254.
Default: 10.
READERSCOUNT
Optimizer tuning parameter, defines the number of read threads. Never set this variable without Tech Support assistance.
RMTWAIT
(OS/2) If this variable exists, multi-threading is disabled. Used for checking for remote allocates.
Default: Disabled.
SHELL
(UNIX) The system defined environment variable used to find the default command processor.
Default: /bin/sh.
SIZETRC
The number of bytes that are written to a trace file before it wraps to the alternate file. Tested after TRCSIZE.
Default: 10000000.
TRANSLOG_Path
(Notes R5/R6) The path to the transaction log directory.
Default: Not defined.
TRCBUF
The number of bytes used for trace buffering (trace buffering is disabled when TRCFLUSH is enabled).
Default: 1024.
TRCCONSOLE
(Win32 only) If enabled, tracing is written to a separate window.
Default: Disabled.
TRCDIR
The directory where UPSTREAM trace files are created.
Default: Work path.
TRCFAST
If this variable exists, buffer data is not traced.
Default: Disabled.
TRCFLUSH
If this variable exists, the trace information is flushed to disk after each message. Slows the trace significantly but should be used if there is a chance that UPSTREAM may crash.
Default: Disabled.
TRCMEM
If this variable exists, memory tracing begins immediately upon UPSTREAM start. This tracing is extensive. The trace file(s) may be placed in different directories than if the trace is activated later.
Default: Disabled.
TRCNOMESSAGEBOX
If set to any value, UPSTREAM does not display message boxes related to tracing.
Default: Disabled.
TRCNOPIPE
(OS/2 and Win32 only) If enabled, tracing is written in the same way as for other version of UPSTREAM.
Default: Disabled.
TRCNOTCP
(NLM) If enabled, TCP tracing is not used.
Default: Disabled.
TRCPRN
If this variable exists, trace information is written to LPT1:.
Default: Disabled.
TRCSCR
(DOS) If this variable exists trace information is written to the screen rather than the trace files.
Default: Disabled.
TRCSIZE
The number of bytes that are written to a trace file before it wraps to the alternate file.
Default: 100000.
TRCTCP
(NLM and Win32 only) If enabled, tracing is accomplished via TCP/IP to a cooperating program (TRCTCP.EXE).
Default: Enabled (NLM); Disabled (Win32).
TRCTYPE
The tracing level. Allows you to selectively enable tracing. Specified as a bit map, this value can be specified in decimal or hex (if hex, there must be a leading 0x). Values are:
0x0001 - Novell
0x0004 - ULTra
0x0008 - File
0x0010 - Storage Server communications
0x0020 - Backup/restore/file transfer/submit job
0x0040 - Memory allocations
0x0080 - Block tracing (regardless of package)
0x0100 - Error logging
0x0200 - Parameter management
0x0400 - Win 32s
Default: 0xffff (all tracing).
UPSTREAMPATH
(UNIX only) The path used to find the UPSTREAM resource and help files.
Default: None.
USADOBJUSNINCREASE
(Windows 2000 / XP / 2003) Used for controlling the Active Directory object USN increase for authoritative restores that are performed by using the new full-system file spec “\\”.
Default: 100000.
USAIXLOCKDISK
If defined, UPSTREAM locks a physical disk so that no other application (such as EMC ControlCenter) locks it causing UPSTREAM SOS local backups to fail. This does keep multiple applications from simultaneously sharing a local backup disk.
Default: Not defined.
USAIXNODEFUNCT
If defined, UPSTREAM does not install the signal handler for child processes which eliminates the defunct process problem.
Default: Not defined.
USAIXRESERVEDISK
If set to any value, causes UPSTREAM to put a SCSI reserve on the UPSTREAM SOS local backup disk. If you set this option, UPSTREAM locks out any other systems from being able to use the disk during the operation. This option is never recommended when a local backup disk is shared by any other system besides AIX as most operating systems do not properly support SCSI reserves.
Default: Not defined.
USAIXUSERFS
If defined, one or more (colon separated) user file system magic numbers can be specified in hex with a leading 0x indicating hex. For example, USAIXUSERFS 0x20.
Default: Not defined.
USASYNCHOSTCOMM
If defined, UPSTREAM multi-tasks its communications with the Storage Server.
Default: Not defined.
USBACKFILEDAYSOLD
(Windows and UNIX) Specifies the retention period in days for restartable backup and restore files.
Default: 7.
USBACKFILEFREESPACENOCHECKING
If defined, backup file free space checking is disabled.
Default: Not defined.
USBACKFILEFREESPACETHRESHOLD
Specified in MB, the minimum amount of free space that must be available for the backup to begin. Not used if USBACKFILEFREESPACENOCHECKING is defined.
Default: 100 if you do not have INCRDB in use, 200 if you are using INCRDB.
USBACKUPFILEBLOCK
The number of backup file records that are buffered.
Default: 100.
USBACKUPOPENNOSHARE
If enabled, files backed up are opened denying other users access to them.
Default: Disabled.
USBACKUPPACKRECSIZE
If specified, allows the specification of the record packing size for backups, which is the maximum, number of bytes used to send data to the storage server. Specify 0 to disable packing (send the record as is).
Default: 65400
USBIGBACKFILE
If defined, the older method is used to store the backup file, which takes more space, but less memory.
Default: Not defined.
USBLOCKWRITERESTORES
(Windows) If defined, UPSTREAM blocks writes for restores into BACKUPBUFFERSIZE (if defined in the environment) or 16K blocks.
Default: Not defined.
USBUFFEREDFILEIO
(Windows) If defined, UPSTREAM uses buffered I/O for file access. The default is non-buffered I/O which is slightly faster.
Default: Not defined.
USCANCELTIMELIMIT
For UPSTREAM error boxes where the OK button changes to Cancel (for file deletions for example), the number of seconds to wait before timing out and automatically performing the process. This overrides the Messages Time Out value specified in the Configurator.
Default: Not defined.
USCLOSEREMOTECHECKINTERVAL
How often UPSTREAM checks for remote initiates (in milliseconds) during shutdown.
Default: 250.
USCOMPRESSSTACK
The size of the internal high decompression stack. Increase it if you get errors in high decompression; decrease to save memory.
Default: 15000.
USDELETEBEFORERESTORE
If set to ‘Y’, deletes the file before restoring data to it. This is particularly useful if restoring z⁄OS UNIX tags and want any existing tags removed.
USDELETETIME
The number of seconds between when the backup completes and file deletes begin that you can abort the entire deletion process.
Default: 10.
USDONTLOGEXCLUDEDFILES
UPSTREAM logs the names of files that are excluded from a restore. Setting this environment variable to any value causes UPSTREAM to not log these messages.
Default: Not defined.
USDONTOPENREGISTRY
(Windows) If set, the file spec won't be checked for a registry. Thus you should not use this environment variable unless you are sure that there is no system state files in this file spec.
Default: Not defined.
USDONTRESTOREDIRABOVE
(V2.5.6c) If enabled, UPSTREAM does not restore directories above when they are created.
Default: Disabled.
USDONTSENDPLACEHODERFORDIR
(Win32) If set to any value, forces UPSTREAM to send full directory entry information for all the directories instead of just placeholders for unmodified directories during merge backup, which was the default behavior up to version 3.1.3.
Default: Disabled.
USDONTTESTLOSTSERVER
(Windows)(v3.0.1b) If defined, UPSTREAM does not attempt to detect when a server connection has been lost.
Default: Not defined.
USDYNAMICPLUGINS
If set, UPSTREAM attempts to load shared library or DLL plugins. Otherwise, only internal plugins are used.
Default: Not defined.
USERNAME
(Dispatcher) The user name that the job is run as.
Default: Existing user.
USEXCLUDEWILDCARDDIRS
If defined, UPSTREAM excludes subdirectories as well as files for file specifications with wild-cards in the last component of the name if subdirectories are turned off for that spec.
Default: Not defined.
USFILEBACKUPSEMANTICS
(Windows) If defined, UPSTREAM uses the BackupRead function instead of ReadFile to read normal file data.
Default: Not defined.
USFILECHARSET
(Windows) If defined, specifies the Windows character set number for the USFILEFONT specified font. Values are:
0 - ANSI_CHARSET
1 - DEFAULT_CHARSET
2 - SYMBOL_CHARSET
77 - MAC_CHARSET
128 - SHIFTJIS_CHARSET
129 - HANGEUL_CHARSET
130 - JOHAB_CHARSET
134 - GB2312_CHARSET
136 - CHINESEBIG5_CHARSET
161 - GREEK_CHARSET
162 - TURKISH_CHARSET
177 - HEBREW_CHARSET
178 - ARABIC_CHARSET
186 - BALTIC_CHARSET
204 - RUSSIAN_CHARSET
222 - THAI_CHARSET
238 - EASTEUROPE_CHARSET
255 - OEM_CHARSET
Default: 0.
USFILEFLUSH
(Win32) If defined, all writes to disk at file close are flushed. Only recommended on Windows machines when writing to a NetWare drive as it degrades performance when not needed.
Default: Not defined.
USFILEFONT
(Windows) The file specification font to use. This can be a monospace or proportional font. Format:
{{id name="UPSTREAMParameters-117_JCL_1084820"/}}
{{id name="UPSTREAMParameters-1084820"/}}
<size>.<Font name>\\For example, 12.Terminal
Default: System font.
USFILEMAPPING
(Win32 only) If enabled, file mapping is used to improve file access performance. See the USNOFILEMAP environment variables for modifying the behavior of file mapping.
Default: Disabled.
USFILENOASYNC
(Win32 only) (V2.5.6c) If enabled, UPSTREAM does not use asynchronous I/O to improve backup performance.
Default: Disabled.
USFILEOPENRETRY
Specifies the maximum number of times that UPSTREAM attempts to open a file if the file open fails. Specify if you believe that file opens may succeed if retried. Retries are separated by 1 second intervals. This parameter must come from the environment (cannot come from the environment file).
Default: 0 (no retries).
USFILESERVERERRORRETRY
The number of seconds that UPSTREAM waits for the server to reconnect before determining that the backup/restore must be fatally terminated.
Default: 30.
USFILEZEROUNALLOCATEDRANGES
(Windows) If defined, UPSTREAM writes binary zeros in unallocated ranges for restores of sparse files, thus making them not sparse.
Default: Not defined.
USFIRSTEMPTYRETRYTIME
The number of seconds that UPSTREAM retries a failed attempt to find an empty local backup disk using “!”.
Default: 120.
USFREENOTES
(Notes only) If set to any value, UPSTREAM frees the Notes library when it has completed running with the PlugIn.
Default: None.
USHARDLINKDEV
Allows you to specify the device number used for hard link restores. You may need to specify this if files are moved from one file system to another without performing a first-time full backup. In your restore, specify in hex with a leading '0x'. For example:
{{id name="UPSTREAMParameters-117_JCL_1076204"/}}
{{id name="UPSTREAMParameters-1076204"/}}
USHARDLINKDEV 0x66d2\\Default: Not defined.
USHARDLINKSET
The maximum number of hard link files that can be restored in a secondary hard link restore pass.
Default: 65535.
USIOERRORTIMEOUT
The number of seconds that an I/O error is retried in a UNIX SCSI command.
Default: 5.
USLINUXUSERFS
Allows user definable magic numbers to include file systems that UPSTREAM does not yet know about. Note that this may make disaster recovery difficult. Specify magic numbers in hex, colon separated, with a leading 0x. For example:
{{id name="UPSTREAMParameters-117_JCL_1134637"/}}
{{id name="UPSTREAMParameters-1134637"/}}
0x10:0xabcd.\\Default: Not defined.
USLISTINCR
The number of additional lines before/after the line which caused a List and Restore or Restore file list to be refreshed.
Default: 250; (25 for DOS).
USLISTTHRESH
The number of lines between the highlighted item and the top or bottom of a List and Restore or Restore file list when the list is refreshed with previous or subsequent lines.
Default: 10.
USLISTWINDOW
The maximum number of lines that are displayed in a List and Restore or Restore file list. Note that there is a bug in OS/2 v2.1 where 1000 or more entries in any list box makes OS/2 unstable.
Default: 500; (50 for DOS).
USLOGASYNCRETRIES
A performance measurement tool. If defined, UPSTREAM logs the number of retries for each file, showing the amount of potential overlap.
Default: Not defined.
USLONGTRUNCNAMES
(z⁄OS Storage Server only) If defined to any value, file names longer than the supported value on the Storage Server are stored with mangled file names. This allows backup of virtually any file. You must also set MAXFILENAMESIZE to a large value (usually 510) so that the UPSTREAM internals can support the long names.
Default: Not defined.
USMAPFILEREGIONSIZEMB
(Windows only) The number of megabytes UPSTREAM uses for a file mapping buffer when it uses file mapping to improve backup performance.
Default: 8.
USMAXBACKUPSIZE
Restricts the maximum size of a backup in bytes.
Default: Not defined.
USMAXCPU
(z/OS UNIX Systems Services) Sets the maximum CPU time.
Default: Not defined.
USMAXFILEHANDLES
(OS/2 only) The maximum number of simultaneously open files. This value may need to be increased if you specify a large NUMBACKUPTHREADS.
Default: 50.
USMAXFILESPECS
(v3.5.0a WinSS only) When restoring hard linked files using the WinSS PlugIn, specifies the maximum number of restore file specifications that may be dynamically created to restore the hard linked data files.
Default: 1000.
USMEMORYMESSAGEDISABLE
If defined, UPSTREAM takes as much as 1MB less memory at the expense of slightly slower message logging.
Default: Not defined.
USMEMSUBALLOCBLOCKSIZE
(OS/2 32-bit only) The size that UPSTREAM uses for internal memory sub allocation.
Default: 16384.
USMEMSUBALLOCLOWTHRESHOLD
(OS/2 32-bit only) The smallest memory block that UPSTREAM 32-bit memory allocation allows.
Default: 24.
USMEMSUBALLOCHIGHTHRESHOLD
(OS/2 32-bit only.) The largest memory block that UPSTREAM 32-bit memory allocation internally manages.
Default: 2040.
USMINLCLBKPKB
(Reservoir) If this variable is set to a number (before usserver starts), it is the minimum client estimate. The MAXBACKUPSIZE on the disk can still reduce the value.
Default: Estimate from client.
USMODIFYVIRTUALSERVERPOPENAMES
Allows you to override the default pipe name for SQL Server on a cluster system.
Default: SQL Server pipe name.
USMONOCHARSET
(Windows) If defined, specifies the Windows character set number for the USMONOFONT specified font. Values are:
0 - ANSI_CHARSET
1 - DEFAULT_CHARSET
2 - SYMBOL_CHARSET
77 - MAC_CHARSET
128 - SHIFTJIS_CHARSET
129 - HANGEUL_CHARSET
130 - JOHAB_CHARSET
134 - GB2312_CHARSET
136 - CHINESEBIT5_CHARSET
161 - GREEK_CHARSET
162 - TURKISH_CHARSET
177 - HEBREW_CHARSET
178 - ARABIC_CHARSET
186 - BALTIC_CHARSET
204 - RUSSIAN_CHARSET
222 - THAI_CHARSET
238 - EASTEUROPE_CHARSET
255 - OEM_CHARSET
Default: 255.
USMONOFONT
(OS/2 and Windows only) The mono space font to use. Format:
{{id name="UPSTREAMParameters-117_JCL_1084914"/}}
{{id name="UPSTREAMParameters-1084914"/}}
<size>.<Font name>\\Windows uses 12.Terminal
Default: System mono-space font.
USMSGQDEPTH
(Windows) The application message queue depth. The range is 8 to.255.
Default: .8
USNLMRESERVEMODE
(NLM only) Use only if you are getting PC6852D messages with an MM_INVALID_MODE return code to set the mode. Legal values are specified as an additive bit map, in decimal from the following options (shown here in hex):
MM_IO_MODE
0x00000001
MM_CONTROL_MODE
0x00000002
MM_SHARED_READ_RESERVE
0x00010000
MM_SHARED_WRITE_RESERVE
0x00020000
MM_SHARED_PRIMARY_RESERVE
0x00040000
MM_RERESERVE
0x00080000
MM_PRIVILEGED_RESERVE
0x00100000
Default: 262145.
USNO32
(Windows and Windows NT only) If specified, disables all 32-bit file access. It is recommended that if you wish to disable Win 32s that you use USNO32FILE.
Default: None.
USNO32FILE
(Windows and Windows NT only) If specified, disables 32-bit file access.
Default: None.
USNOACL
(OS/2) If specified, disables the loading of OS/2 ACL access.
Default: Disabled.
USNOADDRESSMODECHECK
(Windows only) If defined, UPSTREAM does not check and deny 64-bit backups using a 32-bit version of UPSTREAM.
Default: Not defined.
USNOASR
(Windows only) If defined, UPSTREAM does not create the ASR files during backup regardless of the parameter ASR setting.
Default: Not defined.
USNODFSCHECK
If defined, UPSTREAM does not performed DFS checks (used to determine if registry checks should be skipped for DFS shares).
Default: Not defined.
USNODIRDELETE
If defined, directories are not be removed during file deletions or migrations.
Default: Not defined.
USNODISKMAINTENANCE
(Reservoir only) If defined, the Reservoir does not perform local backup disk maintenance.
Default: Not defined.
USNODLLCLEANUP
(Windows) Use when using a Windows APPC which does not properly handle its DLL being freed.
Default: Disabled.
USNODUPSOCKET
(Windows client only) If defined, the Client does not create a duplicate socket when starting a child process. This should be expected to work except on some notebook computers.
Default: Not defined.
USNOFILEMAPLOCKEDFILES
(Windows only) If enabled and USFILEMAPPING is defined, UPSTREAM honors record locks during file reads.
Default: Disabled.
USNOFILEMAPNOVELLFILES
(Win32 only) If enabled and USFILEMAPPING is defined, UPSTREAM does not use file mapping on Novell drives.
Default: Disabled.
USNOFILEMAPWINDOWS95FILES
(Win32 only) If enabled and USFILEMAPPING is defined, UPSTREAM does not use file mapping on Windows 95 machines.
Default: Disabled.
USNOFREENOTES
(Notes) If set to any value, UPSTREAM does not free the Notes library when it has completed running with the PlugIn.
Default: None.
USNOIISBACKUP
(Windows only) If defined, UPSTREAM does not back up the Internet Information Server (IIS) database.
Default: Not defined.
USNOLIBMAINT
(Reservoir only) If defined, and you are using the direct SCSI/Fibre interface, the libraries files are not rebuilt at maintenance time. This is particularly useful if you have hand modified the files.
Default: Not defined.
USNOLOCALUNCREFERENCE
If enabled (set to any value), prevents UPSTREAM from opening a file with its real file name (i.e. c:\some.file) when it was referenced by a UNC specification (i.e. \\server\share\some.file).
Default: Disabled.
USNOLOGMSG
Can be defined to a list of comma separated UPSTREAM messages that you do not wish logged.
Default: Not defined.
USNOLONGNAMESRESTORE
If defined, long name processing is disabled for file restores.
Default: Not defined.
USNOLONGTRUNCNAMES
(z⁄OS Storage Server) If set to any value long file name truncation is disabled.
Default: Not set.
USNOMAXFILES
(UPSTREAM Reservoir) Forces the UPSTREAM Client to ignore the maximum limit of 16 million files for z⁄OS Storage Server and allows up to 4 billion files. Should only be set (to any value) when going to Reservoir and auto-detection is not working.
Default: Auto-detect the storage server during registration.
USNONEWNWDLLS
(Novell OS/2 and Windows) Forces UPSTREAM to load only the old NetWare DLLs (NWCALLS, NWLOCALE, NWNET).
Default: Disabled.
USNONTCOMPRESS
(Windows) If set to “Y”, UPSTREAM does not backup NTFS file compression information.
Default: None.
USNONOV
If specified, disables the loading of Novell drivers.
Default: Disabled.
USNONOVELLUNC
(Windows) If enabled, you must use drive letters to back up Novell data.
Default: Disabled.
USNONOVERR
If defined, UPSTREAM does not attempt to write or get error information for Novell errors. This may improve performance if you have a number of Novell errors you wish to suppress.
Default: Not defined.
USNONTCOMPRESS
(Windows) If defined, UPSTREAM does not backup information about file compression and files are restored not compressed.
Default: Not defined.
USNOOLDNWDLLS
(Novell OS/2 and Windows) Forces UPSTREAM to load only the new NetWare DLLs (CALoooss, LOCoooss, NEToooss, and CLXoooss where “ooo” is OS2 or WIN and “ss” is either 16 or 32).
Default: Disabled.
USNOOPENDIR2
(z/OS UNIX Systems Services) If set to “Y”, disables the use of the opendir2/readdir2 APIs that gets around bugs in xFS.
Default: N.
USNORECVONEND
If enabled, UPSTREAM does not attempt to receive at the end of a task after all data has been received. Works around an Interlink TCP/IP bug.
Default: Disabled.
USNOREGADDSECURITY
If enabled (set to any value), UPSTREAM does not automatically attempt to authorize the Administrators group of SYSTEM user (depending on how you are logged on) for access to the hive and retry the attempt; UPSTREAM skips the hive.
Default: Disabled.
USNOREUSEADDR
(non Windows) If defined, UPSTREAM does not enable the SO_REUSEADDR socket option. This may potentially lock out inbound sockets after UPSTREAM terminates.
Default: Not defined.
USNORMT
Disables check for remote initiates.
Default: Disabled.
USNORSMBACKUP
(Windows 2003 and above) If defined, UPSTREAM assumes that RSM is not installed and not back it up.
Default: Not defined.
USNOSETTREE
(Novell) Keeps UPSTREAM from obtaining and setting the NDS tree on login.
Default: Not defined.
USNOSIGNAL
(UNIX) If set to any value, UPSTREAM does not install its signal handler.
Default: None.
USNOSPARSE
(UNIX) If set to any value, UPSTREAM does not do special handling for sparse files during backup.
Default: Not defined (sparse files are supported)
USNOSPAWN
(NLM only) If defined, UPSTREAM uses the system call rather than the spawn call to start new processes. The system call uses the console line to start the process. This may result in user keystrokes causing the process to not properly start. However, it avoids server abends when you have to unload a hung child process.
Default: Not defined.
USNOSQLDMO
(MSSQL PlugIn) If defined, prevents the MSSQL PlugIn from attempting to use the SQLDMO API.
Default: Not defined.
USNOSQLOLEDB
(MSSQL PlugIn) If defined, prevents the MSSQL PlugIn from attempting to use the SQLOLDDB API.
Default: Not defined.
USNOSYSRESTDIALOG
(UNIX Rescuer only) If defined, the full screen version of UPSTREAM can be used for disaster recovery including device files and can provide a complete user interface when running the ./usdr program rather than its usual limited interface.
Default: Not defined.
USNOTATTMGR
If defined, the listening UPSTREAM processes all inbound requests without starting a new process.
Default: Not defined.
USNOTCP
(UPSTREAM) Disables TCP/IP for all functions (including the remote java interface).
Default: Not defined.
USNOTCPBLOCKINGHOOK
(Windows)(v3.0.1b) If enabled, UPSTREAM does not install a TCP/IP blocking hook and thus becomes much less responsive when blocked on a send or receive call.
Default: Not defined.
USNOTESINI
(Notes) If specified, the fully qualified notes.ini file name.
Default: Notes data directory.
USNOTESALLOWLOGRESTORE
(Notes) If set, UPSTREAM allows an archived transaction log to be restored manually. You may want to set this if there are errors doing the restore during the automatic recall.
Default: None.
USNOTESRECOVERYFLAGS
Allows you to set recovery flags for applying Lotus Notes transaction logs to restored databases. A bit map with values:
1 - Wait.
2 - ZAP DBIID.
4 - Refresh backup.
8 - Recover at point in time.
16 - ZAP replica ID.
32 - ZAP DBIID if necessary.
Default: Not defined. (Determined by UPSTREAM.)
USNOTLSBACKUP
(Windows only) If defined, UPSTREAM does not back up the Terminal server Licensing Server (TLS) database.
Default: Not defined.
USNOUIDGIDERRORS
(UNIX only) If set to any value, 8000 and 8001 errors are not displayed for missing UID and GID names.
Default: Not defined.
USNOUNCOMMITTEDDELETE
If set to any value, UPSTREAM does not automatically delete uncommitted backups.
Default: Not defined.
USNOUNICODE
(Windows) If specified, UPSTREAM does not use unicode names internally. This may cause files with non-ASCII characters to be skipped.
Default: Not defined.
USNOUNICODECODEPAGE
(Windows and UNIX) If specified, UPSTREAM does not use a system code page for translation, but uses a simple one to two byte translation technique. Use this method if UPSTREAM cannot properly manipulate files with either the ANSI or OEM code pages (defined using the USUNICODEPAGE environment variable).
Default: Not defined.
USNOUNICODETRANSLATION
(Windows) If specified, UPSTREAM does not mangle file names that contain non-ASCII characters.
Default: Not defined.
USNOVFORCECOMPRESS
(Novell only) When set to any value, UPSTREAM sets the COMPRESS_IMMEDIATE attribute (forcing the file to be compressed) if the file is already compressed. This assures that after a backup or a restore. no additional disk space is required.
Default: Disabled.
USNOVIGNOREDI
(Novell) If defined, UPSTREAM allows files with the DELETE_INHIBIT bit on to be migrated.
Default: Not defined.
USNOVREPAIRSTUBS
(Novell auto-recall) If a stub file may have been damaged (for example, by accessing the files without having the recaller loaded), enabling this environment variable lets UPSTREAM fix the damaged stubs automatically.
Default: Not defined.
USNOVWAITTOSET
(Novell) Specify a number of seconds UPSTREAM delays before resetting file date information to get around a NetWare v4 bug where last access dates cannot be reset for compressed files.
Default: 0.
USNOWINSOCK
(NLM only) If defined, UPSTREAM only uses BSD sockets for TCP/IP. This also disables use of the attach manager facility.
Default: Not defined.
USNOWINTCPBLOCKINGHOOK
(Windows) If defined, UPSTREAM disables the TCP/IP blocking hook that allows it to respond to the operating system while waiting for TCP/IP operations.
Default: Not defined.
USNOWMIBACKUP
(Windows only) If defined, UPSTREAM does not back up the Windows Management and Instrumentation (WMI) database.
Default: Not defined.
USNTFSADDPERMISSION
(Windows) Required to be set to “Y” to activate the UPSTREAM parameter NTFSADDPERMISSION.
Default: Not defined.
USOLDDESCFLAG
If specified, causes UPSTREAM to send a 1 byte flag in the backup description rather than a 4 byte flag. This is only necessary if the Storage Server is reporting backup description flag length errors.
Default: Disabled.
USSOLODELAY
(Reservoir 3.5.0a) The number of seconds that a SOLO function waits with no other processing running before a SOLO function runs.
Default: 300.
USPIPEOPENRETRY
(Windows only) Specifies the maximum number of times that UPSTREAM attempts to open a pipe if the pipe open fails. Specify if you believe that pipe opens may succeed if retried. Retries are separated by 1 second intervals. The default is 0 (no retries). This parameter must come from the environment (cannot come from the environment file).
Default: 1.
USPGM
(DOS only) Name and path of the UPSTREAM child program to be run by the TCP/IP parent program.
Default: US.EXE.
USQUEUETIMELIMIT
The number of seconds that a CONV=WAIT or CONV=KEEP remote request be queued for before it times out. 0 indicates that the request should be rejected if UPSTREAM is busy; -1 indicates that it should never be timed out; any other value is the number of seconds that the request should be held for.
Default: 120.
USRAWDISKSKIPTYPES
If specified, these are the raw disk types to be skipped:
1 - Operating system disk access.
2 - ASPI.
4 - UNIX raw disk.
Default: Disabled.
USRAWIGNOREREADERRORS
If specified, raw disk read errors are ignored. This can be dangerous and should only be specified under the direction of BMC Support.
Default: Not defined.
USRAWIGNOREWRITEERRORS
If specified, raw disk write errors are ignored. This can be dangerous and should only be specified under the direction of BMC Support.
Default: Not defined.
USRAWNOOVERLAP
(Win32 only) If enabled UPSTREAM does not use overlapped I/O’s for raw disk access (physical disk and UPSTREAM SOS).
Default: Disabled.
USREADTOSKIP
(Windows only) If defined, UPSTREAM skips throughout data streams by reading the data rather than seeking throughout the data stream. This should only be enabled on systems with known problems with BackupSeek (NT v3.1 for example).
Default: Not defined.
USREMOTECHECKINTERVAL
How often UPSTREAM checks for remote initiates (in milliseconds).
Default: 15000.
USREMOTECHECKNODISPLAY
If enabled, the “Doing remote check” message is disabled.
Default: Disabled.
USREMOTENTEVENTLOGS
(Windows only) If enabled, NT event logs on non-local systems are included in the backup.
Default: Disabled.
USREPORTWAIT
Number of minutes to continue retrying appending a temporary report file to the base report file.
Default: 1.
USRESERVEINPUTTAPE
(Windows Reservoir) If defined, Reservoir puts a reserve on the input tape for any operation that keeps other machines from being able to simultaneously access the tape.
Default: Not defined.
USRESERVEOUTPUTTAPE
(Windows Reservoir) If defined, Reservoir puts a reserve on the output tape for any operation that keeps other machines from being able to simultaneously access the tape. This prevents the SAN Express Direct facility from operating.
Default: Not defined.
USRESTORENOLOGNONFATAL
If defined, UPSTREAM disables non-fatal error logging for restores.
Default: Not defined.
USRESTOREPACING
The number of hundredths of a second delay between Storage Server sends for restores. Used when timing is suspected for communications failure or data corruption.
Default: Not defined.
USRESTOREPACKRECSIZE
If specified, allows the specification of the record packing size for restores, which is the maximum, number of bytes used to receive data from the storage server. Specify 0 to disable packing (receive the records as is).
Default: 65400
USRETRYWAIT
If set to “Y”, then CONV=WAIT or CONV=KEEP batch job requests, where the conversation failed or timed out is retried.
Default: Not defined.
USREUSEADDR
(Windows) If defined, UPSTREAM enables the SO_REUSEADDR socket option. This allows multiple UPSTREAM’s to pick up remote data but avoids annoying error messages binding to listening sockets.
Default: Not defined.
USRMTCNTLTRACE
Enable only on request of BMC Support.
Default: Not defined.
USSCHEDULERMAXMESSAGES
(Dispatcher) If you are not getting all your messages from the Scheduler, allows you to specify the number of message lines buffered by Scheduler threads.
Default: 20.
USSCSIIOCTL
(AIX Reservoir) If defined, enables the exclusive use of the scsi_buf structures for the SCSI pass-through, which appears to be used by the StorageTek T10000 tape drives. If not specified, the drive’s access technique is auto-discovered.
Default: Not defined.
USSEARCHSKIP
(UNIX only) A colon separated list of files that are skipped for directory and physical disk listings.
Default: None.
USSENDDIRS
If set to any value, forces UPSTREAM to send to the Storage Server all directory entries (even unmodified ones) during incremental backup.
Default: Disabled.
USSETFILEAPISTOANSI
(Windows) Setting this to any value causes UPSTREAM to use the ANSI character set for all operations. You may need to enable it if you are getting Windows return code 2 (no file found) for files which have extended character codes in Windows 9.x.
Default: None.
USSIRECORD
Allows you to specify a side info table entry name for CPIC.
Default: None.
USSMSCHECKCRC
(SMS) If defined, UPSTREAM checks the CRC (if generated in the backup with the USSMSGENCRC environment variable) for data integrity. This degrades performance slightly.
Default: Not defined.
USSMSEXCLUDEMIGRATED
(NLM only) If defined, UPSTREAM only backs up the stubs from files migrated with a NetWare compatible migration product such as the one from Caminosoft.
Default: Not defined.
USSMSEXPANDCOMPRESS
If enabled, UPSTREAM expands compressed data during SMS backups. This results in slightly poorer performance and increased CPU overhead.
Default: Not defined.
USSMSFILEREPORT
(SMS) If defined, UPSTREAM generate a report file (SMSFILES.LOG) that shows the UPSTREAM name and the Novell names used during backup and restore.
Default: Not defined.
USSMSGENCRC
(SMS) If defined, UPSTREAM generates a CRC during backup for data integrity checking during restore (requires SMSCHECKCRC during the restore). This degrades performance slightly.
Default: Not defined.
USSMSLONGNAMES
(SMS) If defined, UPSTREAM supports file name lengths of up to the Novell maximum by truncating the name and putting in a checksum name terminator. The mangled name may be difficult to restore, and cannot be restored to a new location.
Default: Not defined.
USSMSNODIRECTSEARCHOPEN
(NLM, SMS) If set to any value, revert to its prior behavior single file searches for files rather than directory level searches. This may improve performance (or even cause skipped files) when performing first-time fulls, but may degrade performance on incremental backups and full merges. This option may cause hangs in NetWare when there are large databases when using TSAFS.
Default: Not defined.
USSMSNOLONGNAMESPACE
(SMS) If defined, UPSTREAM does not attempt to record the long name (if any) for files or directories. This may improve performance slightly.
Default: Not defined.
USSMSRESTOREMODEBITMAP
(Novell SMS) This value is logically OR'd into the restore open call. Specified as a decimal quantity. Allows you, to restrict the data restored. SMS defined values include:
NWSM_NO_DATA_STREAMS
256
NWSM_NO_EXTENDED_ATTRIBUTES
512
NWSM_NO_PARENT_TRUSTEES
1024
NWSM_NO_CHILD_TRUSTEES
2048
NWSM_NO_VOLUME_RESTRICTIONS
4096
NWSM_NO_DISK_SPACE_RESTRICTIONS
8192
NWSM_INCLUDE_MIGRATED_DATA
16384
NWSM_DELETE_EXISTING_TRUSTEES
32768
NWSM_EXPAND_COMPRESSED_DATA_SET
65536
NWSM_EXCLUDE_MIGRATED_DATA
131072
NWSM_PRESERVE_ACCESS_TIME
262144
NWSM_NO_HARDLINK_DATA
524288
Default: 0.
USSMSTRUNCATEREPORT
(Novell SMS) Enables and specifies the file name of a report of truncated file names.
Default: Not defined.
USSOSBUFFERSIZE
The data size used for reads/writes to the local backup disk for UPSTREAM SOS. No longer is limited to 64K.
Default: 32768.
USSOSNOOVERLAP
(Win32 only) If enabled UPSTREAM does not use overlapped I/O’s for UPSTREAM SOS.
Default: Disabled.
USRAWTOLERATE
If set, you can get away with a number of what would be fatal physical disk errors like restoring to regular files, restoring to disks of different sizes, etc.
Default: Not set.
USSNAPDELETEDAYS
The number of days a pending snapshot will be retained for restarts before it is deleted.
Default: 7
USSTATUSRECVBUFFERSIZE
The size of the TCP/IP buffer for receives on the status port. Cannot be set from the Storage Server.
Default: System default.
USSTATUSSENDBUFFERSIZE
The size of the TCP/IP buffer for sends on the status port. Cannot be set from the Storage Server.
Default: System default.
USSTDWINDOW
If defined, UPSTREAM uses the prior method for waiting for remote functions.
Default: Not defined.
USSUSPENDPERCENT
For testing purposes only.
Default: Disabled.
USTAKEOWNERSHIP
(Win32 only) Only active if NTFSADDPERMISSION is on, attempts to take ownership of the file or directory on behalf of the Administrators group if denied access for security.
Default: Disabled.
USTAKESECURITY
(Win32 only) Only active if NTFSADDPERMISSION is on and access is still denied, attempts to remove all existing ACLs and create a single ACL for full control by the Administrators group.
Default: Disabled.
USTAPELIBLOGACCESS
(Reservoir only) If defined, the Reservoir logs all locks gotten and released if the you check “Lock Library” in the Reservoir Configurator.
Default: Not defined.
USTBATCHJOBTIMEOUT
(z/OS UNIX Systems Services) The number of seconds that USTBATCH requests wait for the job output pipe to be opened before they are automatically timed out.
Default: 300.
USTAPEMAINTONLY
(Reservoir only) If defined, Reservoir maintenance only consists of tape subsystem examination; all other maintenance is skipped. Only recommended on the advice of BMC Support.
Default: Not defined.
USTCP
(OS/2 only) Allows you to specify the TCP/IP vendor. If not specified, UPSTREAM automatically determines the vendor:
IBM – IBM TCP/IP v2.0 or greater.
NOVELL – Novell LAN Workplace for OS/2.
Default: Automatic
USTCPCONTROLTIMEOUT
A number of seconds that an UPSTREAM control message (deallocate, send error, etc.) wait until it is timed out.
Default: 600.
USTCPIPTRC
(OS/2 only) Enables low-level (USTCPIP.EXE) tracing. Trace file is USTCPIP.TRC. TRCFLUSH environment variable is used.
Default: Disabled.
USTCPNAGLE
(UPSTREAM SOS, TCP/IP) If defined, UPSTREAM uses the Nagle algorithm to send “keep alive” messages to the Storage Server.
Default: Not defined.
USTCPSHUTDOWNWAIT
Allows specification of a number of seconds to wait for TCP to send all data before the socket is closed.
Default: Not defined.
USTCPWINSOCKVERSION
(Windows) Enter the version of TCP/IP WINSOCK you wish to use. Version 1.1 is 257 (100 hex plus 1); version 2.2 is 514 (200 hex plus 2).
Default: 514.
USTCPTRC
Enables mid-level UPSTREAM TCP/IP tracing.
Default: Disabled.
USTRACE
Activates tracing before configuration/parameter processing.
Default: Disabled.
USTRACELOADNETWARE
(Novell) Use only on instruction of BMC Support.
Default: Disabled.
USTRACEWIN32
(Windows/NT) Use to enable Win32 Thunk tracing.
Default: Disabled.
USTRACKSENDTIME
If you specified SKIPBACKUPSCAN Y, this is the number of seconds between sends. If there is no send pending after this number of seconds, a NULL record is sent.
Default: 60.
USTREEALIGN
If defined the memory used to allocate trees (used by INCRDB and BACKFILE) are be aligned on 4K boundaries.
Default: Defined for HPUX and ALPHA; not defined for all other systems.
USTREEBLOCKSIZE
The default block size for all non-forested trees.
Default: 2048
USTREEFORESTSIZE
The default block size for all forested trees, such as INCRDB and BACKFILE.
Default: 65536
USTREENOALIGN
If defined the memory used to allocate trees (used by INCRDB and BACKFILE) are NOT be aligned on 4K boundaries.
Default: Not defined for HPUX and ALPHA; defined for all other systems.
USTRUNCNOLONGNAMETREE
If set to any value, UPSTREAM does not maintain a list of truncated names and is not able to detect any duplicates within a backup. However, there is a memory savings, so if you need to save memory enabling this option can save quite a bit if there are a lot of truncated files.
Default: Not defined.
USTRUNCONCLOSE
If defined, restores UPSTREAM wait until files close before removing any prior file contents. This disables sparse files.
Default: Not defined.
USTRUNCUSEOLDCHECKSUM
Starting in v3.6.3 the checksum algorithm was changed. For compatibility with old versions (that would allow matching of files on a full merge backup) setting this to any value enables the function. However, the possibility of duplicate truncated names is higher due to the use of a poorer algorithm (a simple checksum rather than a complex digest).
Default: Not defined.
USUNICODEPAGE
(Windows) Allows you to specify the unicode page used for internal translation. The default is 0 (ANSI). Current Microsoft definitions include 1 for the OEM codepage and 2 for the Mac codepage.
Default: 0.
USUNIXACLLIBRARY
The name of the library to load to use ACLs.
Default: /lib/libacl.so.1
USUSE16BITACCESS
(OS/2 32-bit only) Forces use of the 16-bit OS/2 system access routines.
Default: Disabled.
USUSEINODETIMEFORINCR
(UNIX only) If enabled, the I-Node time is used as well as the last modified time to indicate whether a file has changed (in incremental backups).
Default: Disabled.
USUSELINEDRAW
UPSTREAM automatically disables the use of line drawing characters (used predominantly in list and restore) if USMONOCHARSET is defined. By defining this variable to any value, UPSTREAM uses line drawing characters.
Default: Not defined.
USUSEUNCFULLSYSTEM
(Windows) If enabled, UPSTREAM uses the UNC name for local drives when you specify a full system spec; otherwise UPSTREAM uses drive letters.
Default: Not defined.
USUSEV4MMAPIS
(NLM) If set to any value, UPSTREAM uses the version 4 Media Manager APIs for physical disk access, including UPSTREAM SOS; otherwise it detects and uses v5 APIs.
Default: Not defined.
USUSEWIN32ALTERNATEFILENAMES
(Windows NT only.) UPSTREAM uses the mangled file name rather than the long file name.
Default: Disabled.
USWINADMALLOCBUFFER
(Windows 2000 Active Directory) UPSTREAM by default uses a stack based buffer for accessing active directory functions. Enable this environment variable to use an allocated buffer.
Default: Disabled.
USWINTCPBLOCKINGHOOK
(32-bit Windows) If enabled, UPSTREAM installs a TCP/IP blocking hook and thus becomes more responsive when blocked on a send or receive call. This parameter cannot be specified if you are using remote status updates (Java client).
Default: Not defined.
USZLIBBUFFERSIZE
The size of the buffer to be used if you wish to enabled zLib buffering. By default, it uses the record size. Whatever value you specify must be larger than the record size and will be a multiple of it.
Default: Not defined. (use the record size)
1996, 1997, 1998, 1999, 2001, 2003, 2007, 2009, 2010