Configuration and Settings

Overview

By use of the UPSTREAM Configurator (uscfg), you can use user-friendly dialogs for setting the various UPSTREAM configuration parameters. The Windows Client Configuration Options describes the UPSTREAM Configurator for Windows systems.

Windows Client Configuration Options

This section describes the UPSTREAM Configurator for Windows.

The UPSTREAM Configurator reads the upstream.cfg file previously created by the install wizard. The UPSTREAM Configurator recognizes this and sets a number of configuration parameters according to the Windows system on which UPSTREAM is installed.

Configured Services

UPSTREAM Configured Services

The Services tab has a list-box containing the names of the services that are created by the UPSTREAM Configurator. The buttons on the Services tab can be used to Add and Delete services and Start and Stop them. The Trace can be used to activate a trace when requested by BMC Support.

The UPSTREAM Administrator has the ability to modify options available in the configuration simply by selecting the Service name on this panel. The ‘Current Service’ information on the bottom of the Configurator indicates what service task is currently being worked on. In most cases you would only have one service defined.

The tasks created by the Windows Configurator runs under the ‘Local System’ account. There are situations where this must be modified for a defined task to run as a local Administrator or user in Domain Admins such as when a network resource has to be accessed. This can easily be done by locating the task in the following figure and then modify the ‘log on’ information.

Windows Services Panel

Use the Windows Services panel to verify the userid a specific UPSTREAM service is executing under as well.

Modifying the ‘Log On’ information for a running UPSTREAM Service.

Cluster Services Setup

On a node participating in a Microsoft Windows Cluster, this panel is used to configure what Cluster Roles or Virtual Services need to be made available to the UPSTREAM product for backup.

If UPSTREAM is activated on a Cluster Role or Virtual Service that has multiple TCP/IP addresses or Disk drives the option to select which to use is presented with a pull down tab.

Each cluster service is required to have a dedicated disk with an assigned Drive letter, or a UNC name specified, for UPSTREAM to process it properly.

TCP/IP Settings

The fields and controls on the TCP/IP dialog are:

FDR/UPSTREAM Server TCP/IP Address or DNS Name

This is the TCP/IP address or DNS name of the UPSTREAM Storage Server. Your UPSTREAM Storage Server administrator supplies this address or name.

FDR/UPSTREAM Server Port

This is the TCP/IP port number of the UPSTREAM Storage Server. Your UPSTREAM Storage Server administrator supplies this port number.

Default: 1972.

Local Port

This is the TCP/IP port number of the UPSTREAM Client.

Default: 1972.

Use Duplicate Sockets

Check this check-box to cause the UPSTREAM service (the parent instance of the UPSTREAM Client) to duplicate its TCP/IP sockets before starting a child instance of the UPSTREAM Client to handle a remotely initiated action.

Local Send Address

This is the TCP/IP address that the UPSTREAM Client is limited to when sending data to the UPSTREAM Storage Server. By default, the UPSTREAM Client uses any available TCP/IP address. This TCP/IP address is useful when running the UPSTREAM Client on a Windows cluster system where the UPSTREAM Client must be limited to using only the single TCP/IP address configured for a cluster node or virtual server.

Local Receive Address

This is the TCP/IP address that the UPSTREAM Client is limited to when receiving data from the UPSTREAM Storage Server. By default, the UPSTREAM Client uses any available TCP/IP address. This TCP/IP address is useful when running the UPSTREAM Client on a Windows cluster system where the UPSTREAM Client must be limited to using only the single TCP/IP address configured for a cluster node or virtual server.

Send Buffer Size

This is the size of the TCP/IP data buffer to be used when the UPSTREAM Client sends data to the UPSTREAM Storage Server.

Receive Buffer Size

This is the size of the TCP/IP data buffer to be used when the UPSTREAM Client receives data from the UPSTREAM Storage Server.

Status Port

This is the TCP/IP port number that the UPSTREAM Client uses as a starting point when creating the status ports needed to communicate with the UPSTREAM Director. Each running instance of the UPSTREAM Client creates a pair of status ports. It creates these status ports by using the next available port numbers starting with this value.

Default: 2033.

Allow Dynamic Local TCP/IP Port Assignment

Check this check-box to cause the UPSTREAM Client to dynamically adjust its local port number (default of 1972) if it finds this port to be already in use. Its default is unchecked as its use is highly discouraged. If you have a special need for using this option, contact BMC Support first.

Registered Name Settings

Register Local Name With the FDR/UPSTREAM Server

Check this check-box to have the UPSTREAM Client register its name with the UPSTREAM Storage Server. UPSTREAM registered names (target names) are similar in concept to DNS names in TCP/IP. The default for this feature is checked.

Use System Name as Registered Name

If checked, UPSTREAM registers the name of the computer rather than requiring a target name specified. The default for this feature is checked.

Registered Name

This is the name that the UPSTREAM Client uses to register itself with the UPSTREAM Storage Server. The default is &SYSNAME which is the network name of the machine on which the UPSTREAM Client run.

Registration Interval in minutes

This is the length of time in minutes between registration name refreshes. The UPSTREAM Client registers its name with the UPSTREAM Storage Server every “n” minutes. The default of 1440 means that the UPSTREAMClient registers itself once per day.

Route all requests through the FDR/UPSTREAM Server

Check this box to have the UPSTREAM Director’s requests to the UPSTREAM Client sent via the Storage Server, rather than sent directly. Check this box if you know that the primary connection is hipersockets or some other connection that would keep a direct connection between the UPSTREAM Director and the UPSTREAM Client from working. The default is not checked.

Log File and Status Message Settings

Log File Name

This is the name of the file to which the UPSTREAM Client logs its messages. The default is upstream.log, but can be changed if you want to have the messages written elsewhere.

Message Retention in days

The is the number of days that the UPSTREAM Client preserves older messages in the message log; 0 indicates that all messages are preserved. We strongly recommend that this feature be enabled by setting a non-zero value (such as 60) so that the message log does not grow infinitely. Log clearing is run every 24 hours (when idle) from the time that UPSTREAM is started.

Default: 60.

Status Message Settings

On Screen Display Time in Seconds

This is the number of seconds that the UPSTREAM Client displays messages that are not displayed on either the Backup Status or Restore Status dialogs. The default of 0 means that the UPSTREAM Client leaves the messages displayed indefinitely when it is running in attended mode. If this value is set to 0, the UPSTREAM Client applies a 15 second time limit when it is running in unattended mode.

Status Window Size in Lines

This is the maximum number of message lines that the UPSTREAM Client displays on either the Backup Status or Restore Status dialogs.

Miscellaneous Settings

Data Path

This is the name of a directory that UPSTREAM uses to create temporary work files, log files, and configuration files.

Default: datapath C:\ProgramData\Innovation Data Processing\fdrupstream

Automatically Restart Failed Backups

Check this check-box to have the UPSTREAM Client attempt to restart failed restartable backups when it is started. This option should only be selected after careful consideration.

Standard Time (ST)

Check this radio button to have the UPSTREAM Client record file time-stamps on the UPSTREAM Storage Server in Standard Time only. This prevents the file times from appearing to change for the two times of the year that the time zone period changes (i.e. from ST to DST and from DST to ST). Check this radio button if you have not yet performed your first merge backup or if your last merge backup was performed during the Standard Time part of the year. If your last merge backup was performed during the Daylight Savings Time part of the year, check the Daylight Savings Time (DST) radio button instead.

Daylight Savings Time (DST)

Check this radio button to have the UPSTREAM Client record file time-stamps on the UPSTREAM Storage Server in Daylight Savings Time form only. This prevents the file times from appearing to change for the two times of the year that the time zone period changes (i.e. from ST to DST and from DST to ST). Check this radio button if your last merge backup was performed during the Daylight Savings Time part of the year. If you have not yet performed your first merge backup or your last merge backup was performed during the Standard Time part of the year, check the Standard Time (ST) radio button instead.

Local Time (ST or DST)

Check this radio button to have the UPSTREAM Client record file time-stamps on the UPSTREAM Storage Server according to the current time zone period. This is either Standard Time (ST) or Daylight Savings Time (DST) depending on the time of the year. Use of this option may cause UPSTREAM to, in effect, perform a First Time Full Merge backup twice a year on the Full Merge backup that immediately follows the time period change. The use of this option is highly discouraged.

Greenwich Mean Time (GMT)

Check this radio button to have the UPSTREAM Client record the file time-stamps on the UPSTREAM Storage Server in Greenwich Mean Time form only. This prevents the file times from appearing to change for the two times of the year that the time zone period changes (i.e. from ST to DST and from DST to ST). Check this radio button if you are backing up file servers that reside in different time zones to the same the UPSTREAM Storage Server.

Agent Configuration

The controls of this dialog allow you to set a number of internal Agent parameters. The most common use is to enable and disable UPSTREAM client trace options. You do not need to change any of the other controls unless instructed by https://support.compuware.com/. The output of the requested trace is located in the location specified on this panel and should be forwarded to BMC Support.

UNIX/Linux Configuration

Setting Configuration Parameters

The UNIX/LINUX configuration can be updated either locally with a standard Text editor or remotely using the UPSTREAM Web Portal Interface.

The configuration can be found in /etc/opt/fdrupstream.

Default: The default name is upstream.cfg

Using the UPSTREAM Web Portal

Web Portal

The UPSTREAM Web Portal interface provide a list of all UPSTREAM Clients and the Storage Server Host they are registered to.

Configuration

The Interface allows the Backup Administrator to select a specific UPSTREAM Client and then configure the client using the instructions below. Once the modifications are done the file is pushed back and updated when the Save button is selected.

Restart Client

To activate the modified configuration parameters the UPSTREAM Client can then be restarted from the Client List. An option to kill running jobs is provided.

Configuration Parameters

You set a configuration 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. Parameters are listed in the order they appear in the file.

There are two types of parameters: configuration and frequency. The Configuration Parameters do not repeat. The Frequency Parameters repeat for each frequency defined.

DONTSAVEPASSWORD

If “Y”, passwords are not saved to parameter files in UPSTREAM.

Default: N.

DYNAMICPCINPORT

If “Y”, UPSTREAM searches for available listening and status ports if the specified ports are in use.

Default: N.

GUICLIENTTCPADDRESS

(Java Client) One or more addresses (comma separated) of the UPSTREAM process that the Java client connects to.

Default: 127.0.0.1.

GUISTARTCLIENTLOCAL

(Java Client) Whether the Java client starts UPSTREAM itself “Y” or connect to a running UPSTREAM process “N”. If “N”, you must specify a GUICLIENTTCPADDRESS.

Default: Y.

INPORT

(TCP/IP only) The IP port used to allow other computers to request functions (including UPSTREAM Storage Server initiates).

Default: 1972.

LANGUAGEFILE

If specified, the UPSTREAM dialog text replacement file is used to customize UPSTREAM’s dialogs (usually for non-English support).

Default: None.

LOGDAYS

If set to a non-zero number, UPSTREAM clears out the log and retains the specified number of days worth of log entries. The process is performed on program start and every day thereafter at the time the program was started.

Default: 60.

LOGFILE

The name (and optionally the path) of the log file to write the error messages and other messages.

MAXSTATUSMSGLINES

Backup and restore status screens display a messages list box which contains the errors, warnings and other significant events encountered during the operation. This specifies the maximum number of lines in the list before the oldest messages are removed. 0 indicates no limit (not recommended), -1 suppresses screen logging.

Default: 500.

MESSAGEFILE

The name (and optionally the path) of the message file to read the predefined messages from.

Default: upstream.msg.

MESSAGETIMELIMIT

A number indicating the number of seconds that predefined messages should be displayed for the full screen mode of UPSTREAM.

-1 - Do NOT display any messages.

0 - Display messages until released.

number

Number of seconds.

Default: 0.

NOAUTOCREATESERVICE

(Windows only) If “N”, UPSTREAM creates the primary service needed during installation; if ‘Y’ the service is not created.

Default: Y.

NORESTART

If specified as “Y”, restarts are be attempted on UPSTREAM program entry.

Default: Y.

OSTAPEACCESS

(Reservoir SAN Express Direct only) Whether tape access should use operating system commands (Y) or direct SCSI commands (N). Typically direct SCSI commands are faster but may not be available in all platforms.

Default: Y

OUTPORT

(TCP/IP only) The IP port used to contact the UPSTREAM Storage Server.

Default: 1972.

PERCENTINTERVAL

If you have enable percentage completion status messages (USNLMOPTIONS 8 bit on), how often completion messages are displayed.

Default: 5.

PCUSERNAME

Used to override the user name for notification messages.

REGISTERROUTEVIAHOST

Whether requests should be sent by the Director directly to the client (N) or routed via the storage server (Y).

Default: N.

REGISTERSYSTEMNAME

If set to 'Y', UPSTREAM registers the name of the computer rather than the specified TARGETNAME.

Default: Y

REMOTEDELAY

The number of seconds that UPSTREAM waits after receiving a remotely initiated request before performing other functions.

Default: 5.

RUNSCHEDULER

Whether you wish to run the local Dispatch scheduler. If set to ‘Y’, you must also specify a SCHEDULESPEC.

Default: N.

SCHEDULESSPEC

The file spec used by the local Dispatch scheduler.

SETPCTIME

Whether the PC clock should be synchronized to the UPSTREAM Storage Server clock when backups are run.

Default: N.

STATUSPORT

If specified, UPSTREAM listens for status type requests. Used for tracing and the Java facilities, this is a base number; UPSTREAM uses two ports.

Default: 2033

STATUSREDRAWINTERVAL

The number of milliseconds between ‘us’ backup or restore status screen refreshes.

Default: 100.

TAPEUSELOCATE

(Reservoir SAN Express Direct only) Whether tape access should use the LOCATE command (Y) or use the SPACE command (N). Locate is dramatically faster but may not work on some platforms (Windows without direct SCSI for example).

Default: N

TARGETNAME

The target (registered) name to transmit to the UPSTREAM Storage Server. Should be specified. There are two defined values: &SYSNAME, which is replaced with the machine’s name used, and &VMNAME (Linux OS on IBMZ only) which is replaced with the VM machine’s name used. &SYSNAME uses the HOST name of the machine, and &VMNAME uses the VM name.

Default: &SYSNAME

TARGETNAMEINTERVAL

How often (in minutes) the registered name is retransmitted to the UPSTREAM Storage Server. 0 means to only transmit the name on UPSTREAM program entry.

Default: 1440 (one day)

CPADDRESS

The IP address of the UPSTREAM Storage Server.

Default: None (but required)

TCPINADAPTER

Allows you to specify the local IP adapter address that you accept remote requests on. The default (blank) accepts requests on all adapters.

Default: Blank (all).

TCPOUTADAPTER

Allows you to specify the local IP adapter address that is used for outbound TCP/IP requests. The default (blank) uses the default system adapter.

Default: Blank (default).

TCPRECVBUFFER

Specify the total per-socket buffer space reserved for receives. This is unrelated to the size of a TCP window.

Default: 65535.

TCPSENDBUFFER

Specify the total per-socket buffer space that is reserved for sends. This is unrelated to the size of a TCP window.

Default: 65535.

TCPOPTIONLEVEL

All TCP/IP advanced options use 65535 except for TCP_NODELAY that uses 6.

Default: 0.

TCPOPTIONNUMBER

If specified, the advanced TCP/IP option:

1 - (TCP_NODELAY). Disables the Nagle algorithm for send coalescing. Use a BOOL OptionValue and an OptionLevel of 6.

1 - (SO_DEBUG). Record debugging information. Use a BOOL OptionValue.

8 - (SO_KEEPALIVE). Send keep alives. Use a BOOL OptionValue.

16 - (SO_DONTROUTE). Do not route; send directly to interface. Use a BOOL OptionValue.

4097 - (SO_SNDBUF). Specify buffer size for sends. Use an INT OptionValue.

4098 - (SO_RCVBUF). Specify buffer size for receives. Use an INT OptionValue.

Default: 0.

TCPOPTIONVALUE

(TCP/IP only) Specify the new value for the option. For BOOL values, specify 1 to enable, 0 to disable; for INT values, specify the value you wish to set.

Default: 0.

TCPOPTIONVALUELENGTH

(TCP/IP only) The number of bytes used by OptionValue, which is processor dependent. For most implementations use 4 for both BOOL and INT.

Default: 0.

TESTCONNECT

Used by BMC Support .

TIMECONVERSION

(Win32) During backups, how NTFS and LAN file modification times are stored on the UPSTREAM Storage Server. Can be overridden using the overall parameter TIMEOVERRIDE.

0 - Local time.

1 - Standard time.

2 - Daylight savings time.

3 - Greenwich Mean Time.

Default: 1.

USEDUPLICATESOCKET

(Windows) Whether to use a complex procedure to work around problems in socket inheritance. Usually only needs to be turned on if child processes always fail with a “socket operation on non-socket” error message.

Default: N

USETARGETNAME

Whether a target (registered) name is to be transmitted on program entry.

Default: Y.

USETCPKEEPALIVE

Whether to turn on the built-in TCP/IP keep alive facility (SO_KEEPALIVE)

Default: N

WORKPATH

The name of a drive and directory where temporary and trace files are written. It is recommended that this path NOT be part of any file spec to be backed up.

Default: UPSTREAM directory/workpath.

Configuration and Management of Multiple Unix Daemons

Being able to backup certain applications such as Lotus Notes, Oracle Databases might require the UPSTREAM Client daemon performing to task to run with a user id that is different from the standard Local System Account.

The recommended method for accomplishing this is to use the following provided tools to create one or more UPSTREAM daemon services from one install directory. Using this method allows for the UPSTREAM Client to be easily maintained and updated to new maintenance levels across all the running services.

Converting / Consolidating Multiple Installations of UPSTREAM Client

•  Install UPSTREAM Client - Make note of the new install library location
  
• For each UPSTREAM daemon running - locate the current associated install library.
  
• From each install library - copy the current used configuration file (default upstream.cfg) over to the new install library and make sure to rename the file to make it unique.
  
• If the parameter file (default rmtparm.dat) is different - then copy that to the new install location - again renaming it to make the name unique.
  

UNIX Daemon Controls

A script called fdrupstream is now provided that controls UPSTREAM Client daemon(s) configured.

The Script accepts two parameters (the second one is optional, with no parameters - returns status):

services

See the list of the daemon instances configured.

status [instance]

Check status of all (or particular) daemon instance.

start [instance]

Start either all or a particular daemon instance.

stop [instance]

Stop either all or a particular daemon instance.

quit

Stop all daemon instances and their children.

kill

Kill all daemons from the current install directory.

killall

Kill ALL UPSTREAM instances running regardless of install directory.

restart [instance]

Restart all or a particular daemon instance.

update

Synch the list of actually running instances with the upstream.ini list (after updating it).

Service configuration stored in upstream.ini file with this format (this is the default daemon configuration):

The first default daemon gets created during installation. In case of an upgrade we convert the currently configured daemon into the new format.

Daemon Configuration

A script called daemon_configure is now provided to configure the UPSTREAM Client daemon(s).

Create Daemon Example

Create Daemon

• ./fdrupstream services command list the current running daemons.
  
• ./daemon configure begins the configuration process.
  
• A is selected to Add a new daemon service.
  
• We enter a unique name for the new daemon - in this example ‘upstream-lotusnotes’.
  
• The name of the configuration file needed for the new daemon is entered. This configuration file should be created ahead of time using the UPSTREAM Configurator OR it could be the name of an configuration file copied over from an already existing installation.
  
• Type in the name of the parameter file. In most cases the default rmtparm.dat file can be used for all daemons - but this file could be different for each daemon or one that was copied from an already existing installation.
  
• Now decide the start mode of the new daemon. In the above example ‘auto’ was selected.
  
• Inform the system if the new daemon task should be started now.
  

Verify the new daemon is running using the ./fdrupstream services command.

Verify Daemon

If the new daemon is running - verify it works - then go ahead and optionally remove / uninstall the OLD installation if it was converted.