Appendix A. XBSA Environment Variables

Appendix A. XBSA Environment Variables
Prev		Next

This appendix gives the steps for changing a NetWorker XBSA environment variable, and lists those variables, their default values, and valid options.

NetWorker XBSA

The NetWorker XBSA allows for configuration of environment options to activate certain features of NetWorker not directly supported by X/Open specifications. NetWorker XBSA enables ON-Bar and NetWorker to interact during backups and restores.

The interaction ensures restoration of dbobjects to the correct OnLine Dynamic Server instance and to their proper sequence in the database.
NetWorker XBSA compiles a history of objects backed up for the OnLine Dynamic Server instance.

See Appendix B, “Error Messages” for a description of error messages associated with a NetWorker XBSA session.

Caution: NetWorker and ON-Bar rely on shared XBSA libraries for interaction during backups and restores. Create a symbolic link, using the appropriate shared library file extension for your system. In the following example, which creates a symbolic link between the NetWorker and ON-Bar XBSA libraries, “so” indicates the file extension for IRIX systems.

ln -s /usr/lib/libbsa.so /usr/lib/ibsad001.so

Changing NetWorker XBSA Variables

To change a value for a NetWorker XBSA variable that does not appear in the default nsrdbmi script:

Copy the template file /etc/nsrdbmi.sh to the directory where the NetWorker binaries are installed.
Add the NetWorker XBSA environment variable to the script and assign a valid value to the variable.

Add the NetWorker XBSA environment variable to the list of variables exported.

export_environment_variables()
{
    export NSR_VOLUME_POOL 
    ...
    export new_NSR_variable 
}

Save the edited script with a descriptive filename.

Edit the NetWorker server's client resource. For example, in the nwadmin Clients window for the OnLine Dynamic Server instance, enter the filename of the custom nsrdbmi script in the Backup command field.

Caution: If you choose continuous log file backups or perform an on–demand backup of a dbobject, the default settings for the NetWorker XBSA variables will override values set with the NetWorker administration program. See Chapter 4 for recommendations about NetWorker XBSA variables that you need to assign explicit values for.

Default Values and Valid Options

This section contains tables for each of the NetWorker XBSA environment variables you can modify by customizing the nsrdbmi script. Most of the environment variables described appear in the default nsrdbmi script, while others are set in the NetWorker XBSA shared libraries included with BusinesSuite Module for Informix.

NSR_BACKUP_LEVEL

Definition

The NSR_BACKUP_LEVEL environment variable indicates the NetWorker backup level to use for the XBSA session.

Default Value

full

Possible Values

All valid NetWorker levels are supported. The 12 possible values for NetWorker levels are: full, 1 through 9 (indicated by the integers 1 through 9), incr, and skip.

If you specify the skip level for a save set, the savegroup completes successfully, but does not perform a backup of the data.

Note: While NetWorker supports incremental backups of levels 1 through 9, ON-Bar only supports incremental levels 1 and 2. If you assign a level other than skip, full, 1, or 2, the backup fails and displays the message “Only level 0 (full), 1, or 2 backups allowed.”

NSR_CLIENT

Definition	The NSR_CLIENT environment variable indicates the NetWorker client resource to use for the XBSA session.
Default Value	Host from which the XBSA session is initiated, as indicated by getlocalhost().
Possible Values	Since the client name is an arbitrary string, the value for NSR_CLIENT is not checked directly. An incorrect value may cause an authentication or system error in NetWorker.

NSR_COMPRESSION

Definition

The NSR_COMPRESSION environment variable indicates whether to compress the backup data as it is sent to the NetWorker server.

Default Value

FALSE

Possible Values

Setting NSR_COMPRESSION to a value of TRUE means the standard compression technique for XBSA for NetWorker is performed on the data backed up.

Setting NSR_COMPRESSION to a value of FALSE means that compression is not performed.

Note: Compressing data from the database server may speed backups, as long as the database server is able to send data to the backup server fast enough to keep the tape drive streaming. Data compression during backup will impact CPU usage on the backup server, but will reduce the amount of data sent to the NetWorker server.

NSR_DATA_VOLUME_POOL

Definition	The NSR_DATA_VOLUME_POOL environment variable indicates the volume pool to which data files should be backed up.
Default Value	XBSA does not set a pool by default—if none is specified, the pool is selected by the NetWorker server based on configuration of the Pools resource.
Possible Values	Any valid NetWorker pool name of 1024 characters or less. This value is set in the NetWorker pools resource and can be explicitly assigned in a shell script.

NSR_DEBUG_FILE

Definition

The NSR_DEBUG_FILE environment variable indicates the full pathname and filename where NetWorker XBSA messages should be written. Message logs for XBSA are separated from regular NetWorker messages. NetWorker XBSA error messages are indicated by the prefix “BSA.”

Default Value

/nsr/applogs/xbsa.messages

Possible Values

Any valid values for pathname and filename are valid. If the file specified cannot be opened, a BSA_RC_INVALID_KEYWORD error message is written to one of the following locations:

the alternate messages directory created during installation, /nsr/applogs the directory assigned to the TMPDIR environment variable

the /tmp directory, if TMPDIR is not set

NSR_DEBUG_LEVEL

Definition

The NSR_DEBUG_LEVEL environment variable allows you to set the level of NetWorker XBSA error report messages sent to the xbsa.messages log file.

Default Value

The default value is 2, which means that critical error messages and all network (RPC) errors are written to xbsa.messages.

Possible Values

Any integer from 0 to 9 is valid. Higher values generate more detailed reports:

A value of 0 means that no error messages are written to xbsa.messages.

A value of 1 means that only critical error messages are written to xbsa.messages.

A value of 2 means that all network (RPC) errors are written to xbsa.messages.

A value of 3 means that all NetWorker XBSA informational messages are written to xbsa.messages.

NSR_GROUP

Definition

The NSR_GROUP environment variable indicates which backup group to use for a backup session.

Default Value

None

Possible Values

Any valid NetWorker group name of 1024 characters or less. Invalid group names may cause authentication or system errors in another routine.

A NetWorker save group acts as an “alarm clock,” notifying the NetWorker server that a group of clients have a backup scheduled to occur at the time designated in the group's “start time” attribute.

NSR_LOG_VOLUME_POOL

Definition	The NSR_LOG_VOLUME_POOL environment variable indicates the volume pool to which logical logs should be backed up.
Default Value	NetWorker XBSA does not set a pool by default—if none is specified, the pool is selected by NetWorker based on configuration of the Pools resource.
Possible Values	Any valid NetWorker pool name of 1024 characters or less. This value is set in the NetWorker pools resource and can be explicitly assigned in a shell script.

NSR_NO_BUSY_ERRORS

Definition

The NSR_NO_BUSY_ERRORS environment variable indicates whether the savegroup should wait for a busy NetWorker server or fail immediately.

Default Value

FALSE. Wait for the NetWorker server to accept the connection.

Possible Values

Setting NSR_NO_BUSY_ERRORS to a value of TRUE causes the backup to fail immediately when the NetWorker server is busy. A network error message describing the reason for the failure is written to xbsa.messages.

If NSR_DEBUG_LEVEL is set to 1 and the NetWorker server is busy, the backup process stops and the error message “BSA_RC_ABORT_SYSTEM_ERROR” appears in xbsa.messages.

NSR_PROCESS_ENVIRON

Definition	The NSR_PROCESS_ENVIRON variable indicates whether the environment vector for the process calling NetWorker XBSA should be processed along with the explicit XBSA environment vector.
Default Value	TRUE. Process environment vectors for the process calling XBSA. Environment options passed from XBSA take precedence over options set by the calling process.
Possible Values	FALSE. NetWorker XBSA will ignore the environment vectors passed from the calling process (for example, the shell that the onbar command was executed from).

NSR_SAVESET_NAME

Definition

The NSR_SAVESET_NAME environment variable indicates the save set name NetWorker XBSA should use for a save session.

Default Value

If NSR_SAVESET_NAME is not assigned a specific value, NetWorker XBSA will use the format “INFORMIX:/objectSpaceName,” where objectSpaceName is the name of the OnLine Dynamic Server instance.

Possible Values

Any valid NetWorker save set name. Only the first 63 characters are meaningful to the NetWorker server's media database.

For dbspaces and blobspaces:

INFORMIX:/objectSpaceName/spacename/level

For logical logs:

INFORMIX:/objectSpaceName/logspace/log_number

NSR_SERVER

Definition	The NSR_SERVER environment variable indicates the hostname of the server NetWorker XBSA should use for a save session.
Default Value	The most appropriate server, based on the index name and client name for the session. See also NSR_CLIENT
Possible Values	The server name defined by the NSR_SERVER environment variable is checked, using gethostbyname(). If this routine call fails, the NetWorker XBSA error code “BSA_RC_INVALID_KEYWORD” is returned.

Prev	Table of Contents	Next
Chapter 5. Restoring Data		Appendix B. Error Messages