Solstice Backup 5.1 Administration Guide

User Interface Startup

You can use the Backup software through a command line interface or a GUI. You can start the administrative programs from any machine on the network; however, only users with administrator privileges can make changes. You can use the user programs for backup and recovery, as well as the optional archive and retrieve features on any client that has the feature enabled in the client resource.

For server selection, the client commands are classified into two groups: administration and operation. The administration commands include nwadmin, nsrwatch, and mminfo. The operation commands include save, savefs, and recover. Both groups of commands accept a -s server option to explicitly specify a Backup server.

When a server is not explicitly specified, the operation commands use the following steps to locate one. The first available server found is the one used.

The machine where the current directory is actually located is determined. This is either an NFS server or the local machine. If that machine is a client of a Backup server as determined by a RAP query, then that Backup server is used. If more than one server backs up the current directory, one server is chosen and an informational message is printed showing the other server's names.
The machine where the current directory is actually located is examined to see if it is a Backup server. If it is, then that machine is used.
The local machine is examined to see of it is a Backup server. If it is, then the local machine is used.
If a Backup server is still not found, then the machine with the hostname "nsrhost" is used.

`nsradmin`

The nsradmin program is an administrative program for the Backup system that uses the command line. Typically, nsradmin monitors and modifies Backup resources over the network. Commands are entered on standard input, and output is produced on standard output.

If you enter the nsradmin command without command options, the program opens with a command prompt for you to enter additional options as needed:

nsradmin>

The following example describes the format and command options available for the nsradmin program:

nsradmin [-c] [-i file] [-s server] [-p prognum] [v version] [query]
nsradmin [-c] [-i file] [-f resource-file] [-t typefile] [query>

Enter the -f resource-file option to use the Backup resource file you specify for resource-file instead of opening a network connection. Do not use this option if the Backup server is currently running a backup. You can use multiple -f and resource-file arguments to start nsradmin with access to more than one file at a time.
Enter the -i file option to tell Backup to take input commands from a file instead of from standard input. The interactive prompt is not printed when you use the nsradmin program in this mode.
Enter the -p program option to use the given RPC program number instead of the standard program number. The standard program number is 390109. Generally, you should use this option only to debug problems that you encounter.
Enter the -s server option to open a connection to a specific Backup server. This command is useful when you want to limit the number of resources polled if there are many servers, or to administer Backup when the RAP location service is not working.
Enter the -t typefile option to use the alternate file typefile to define RAP types.
Enter the -v version option to bind to the Backup RAP service with the given version number. The default value for version is 2. Generally, you should use this option only to debug problems that you encounter.
Specify the query option, in the form of an attribute list, to perform an edit operation:
attribute ::= name [: value [, value]*]

An attribute is a name optionally followed by a colon, followed by zero or more values, with values separated by commas. A comma at the end of a line continues the line.

attribute list ::= attribute [; attribute]*

An attribute list is one or more attributes separated by semicolons. A semicolon at the end of a line continues the line. The list is ended by a newline character that is not preceded by a comma or semicolon.

name: mars;
type: NSR client;
remote access: mars, venus, jupiter

At each nsradmin input prompt, you enter a command name and optional arguments. You can shorten command names to the smallest unique string, for example, you can enter p for the print command. You specify command arguments in the form of an attribute list. Most nsradmin commands operate on a set of resources returned by a query. The query is specified as an attribute list that is used to match resources with the following rules:

The resource must match all the given attributes.
If more than one value is specified, the resource can match any one of the values.
The values in a query may be in the form of regular expressions. A pattern match is attempted against all resources that contain the specified attribute.
If an attribute is specified with no value, the resource must contain an attribute of that name.

If the query has only one name and no values, the nsradmin program tries to determine the query based on the name. If the name is a hostname, the query is made for all the resources on the given host. Otherwise, the name is interpreted as a type name, and all resources of that given type are selected.

Command Options for `nsradmin`

The following list describes the commands available and their function:

bind query

To bind to the service that owns the resource described by query. If a query is not specified, send the queries to the RAP Resource Directory, and update, create, and delete commands to the service that owns the resource being changed. On failure, the previous service continues to be used.
create attribute-list

To create a resource with the given attributes.
delete query

To delete the resources that match the current query. If a query is specified, it becomes the current query.
edit query

To edit the resources that match the current query. If a query is specified, it becomes the current query. When the editor exits, nsradmin applies update, delete, and create operations based on the changes to the resources. Do not edit the resource identifier attribute, but do write out the file before you exit the editor.
help command-name

? command-name

To print a message describing a command. If no command name is given, a synopsis of all the commands is printed.
print query

To print the resources that match the current query. If a query is specified, it becomes the current query. If the current show list is not empty, only the attributes named in the show list are displayed.
server server-name

To bind to the given Backup server name. If no server is specified, the RAP location service is used. On failure, the previous server continues to be used.
show name

To add names to the show list if a name list (really an attribute list with no values) is specified. Only these attributes are displayed in subsequent print commands. If no name list is given the show list is cleared, resulting in all attributes being shown.
types

To print a list of all known types.
update attributes

To update the resources given by the current query to match attributes.
quit

To exit the nsradmin program.
option dynamic:choice;hidden:choice;resource id:choice

To enable some options to change the display of resources. With no arguments it displays the current options; with a list of options it turns the specified ones on. The option command sets the given display options. Options are separated by semicolons, and you can give them an explicit value of either on or off.

The valid options are:
- dynamic, which causes nsradmin to display all dynamic attributes, even the normally hidden ones.
- hidden, which causes nsradmin to display all attributes, even the normally hidden ones.
- resource id, which causes nsradmin to display the resource identifier of each resource. The resource ID is a number that Backup uses internally to provide sequencing and uniqueness.
unset dynamic;hidden;resource id

To turn off the specified option.
. query

To set the current query, if a query is specified, without printing the results of the query. Otherwise, the current query, show list, server binding, and options are displayed.

Resources Available in the `nsradmin` Program

The nsradmin program provides a character-based interface to manage the same resources available through the nwadmin program. These include:

NSR client

The NSR client resource describes the files that are saved, the backup schedule, the directive used to omit files from the save, the length of time the files' index entries should be kept in the on-line file and media indexes, the users given access to back up, browse, and recover a client's files. To edit the NSR client resources for a Backup server use "nsradmin " or "nwadmin".

The NSR client resource has the following attributes:

The name attribute specifies the hostname of a Backup client.
The server attribute specifies the hostname of a client's Backup server.
The archive services attribute specifies if a system can use archive services. To use this attribute archive support must be enabled on the server first.
The schedule attribute specifies the name of the schedule controlling the backup levels for the save sets listed in the save set attribute.
The browse policy attribute specifies the name of the policy controlling the length of time entries will remain in a client's on-line file index.
The retention policy attribute specifies the name of the policy controlling the length of time entries will remain in the media index before they are marked as recyclable.
The directive attribute specifies the directive used for backing up a client.
The group attribute specifies the group a client is a member of. The group controls when scheduled backups are performed on the client.
The save set attribute lists the path names to be saved for a client. When a client requires different file systems to be saved on different schedules, a client resource is required for each file system and schedule.
The priority attribute specifies the backup priority given to a client where priority 1 is the highest, 1000 is the lowest. Automated savegroup's will attempt to back up clients with higher priorities before clients with lower priorities.
The remote access attribute specifies a users access to back up, browse, and recover a client's files. Additional users, hosts, and netgroups may be granted permission to access a client's files by adding their names to this attribute. Netgroup names must be preceded by an ampersand (&). Input of the form user@host or host/user, grants access to a client's files to the specified users.
The remote user attribute:
- specifies the user login name a Backup server will use to authenticate itself with a client, who has accessed the network through rsh or nsrexecd.
- allows the Backup server (when run with the savegrp -p command) to determine which files to save.
- allows certain clients, (such as NetWare fileservers) to gain access to files being backed up. This procedure only works when the remote user attribute is used along with the password attribute.
The password attribute is used by savegrp to initiate the commands savefs and save on a client machine. The commands savefs and save use the password to gain access to files being backed up. If a password is given, then the remote user attribute for the client resource must also be defined.
The backup command performs a remote backup of client's data and save sets. This command can also perform pre and post backup processes. The prefix of the specified value must begin with "nsr" or "save".
The executable path attribute specifies the path used by the Backup server for executing commands on the client.
The server network interface attribute specifies the network interface the server uses for saves and recovers.
The aliases attribute specifies the aliases for a client machine that queries can match.
The owner notification attribute sends the contents of status messages to the owner/primary user of a system.
The statistics attribute consists of: the size of the client's on-line file index, the number of kilobytes used and the number of entries in the index.
The index save set attribute specifies save set, residing in a client's file index, to purge when an index operation is set to purging oldest cycle.
The index message attribute is the status message resulting from the previous index operation.
The index operation start attribute indicates the starting time of the current index operation. This attribute is a null string ("") when the operation is "Idle".
The index progress attribute indicates the progress an index has made towards finishing the current task. This attribute is blank when the operation is "Idle", and is expressed as a percentage.
The index operation attribute specifies the current index operation.
The parallelism attribute indicates the maximum number of saves that should be run simultaneously on a single client.
The archive users attribute specifies the users given access to the archive services on a client. This attribute can only be set if archive support has been enabled on the server.
The application information attribute specifies a client's application information.
The storage nodes attribute specifies the storage nodes available to a client for saving data. A client's saves are directed to the first storage node that has an enabled device and a functional media service.

The clone storage nodes attribute specifies the storage nodes available to a storage node whose data is being cloned. Cloned data originating from a storage node will be directed to the first storage node that has an enabled device and a functional media service.

The following is an example of a NSR client resource used to define a client, called saturn, backing up all of its files to the Backup server mars:

type: NSR client;

name: saturn;

server: mars;

archive services: Disabled;

schedule: Default;

browse policy: Month;

retention policy: Quarter;

directive: ;

group: engineering;

save set: h:\, c: \usr,  c:\usrsrc;

remote access: venus, sam@*, jupiter/john;

remote user: operator;

password: ;

backup command: ;

aliases: saturn.sun.com;

archive users: ;

storage nodes: nsrserverhost;

clone storage nodes: ;

NSR device

The NSR device resource describes each storage device used by a Backup server.To edit the NSR device resources for a Backup server use "nsradmin " or "nwadmin"

The NSR device resource has the following attributes:

The name attribute specifies the path name for a device. For systems that optionally support "Berkeley style" tape positioning on close, the BSD style tape device name should be used. For optical disks the path name is generally the "c" partition.

To facilitate interaction with external media management services a logical device type has been defined. When interacting with such services, the device into which a volume is loaded may be determined by the media management service. A logical device is used to define a Backup device resource.

At the time of definition the name of a device is not related to any specific device. The default for both the media type and family are set to logical. The name, type, and family are not determined until the media management service has loaded a volume into a device in response to a request made by Backup. The name, type, and family of the actual device are then stored in the attributes logical name, logical type, and logical family, respectively. The association between the logical device and the actual device last only as long as a volume is loaded into the device and allocated for use by Backup.
The media type attribute specifies the media type used by a device. Some of the possible values for this attribute are:
- 4mm, 4mm digital audio tape (1 GB)
- 8mm, 8mm video tape (2 GB)
- dlt, digital linear tape cartridge (10 GB)
- vhs, VHS data grade video tape (14 GB); 3480 - high-speed cartridge tape (200 MB)
- logical, used when interacting with an external media management service.
The enabled attribute indicates whether a device is available for use.
The read only attribute indicates whether a device is reserved for read only operations, such as recover or retrieve.
The target sessions attribute specifies the target number of saves for a device, and used for load-balancing. Once all the devices have reached their corresponding target number, additional sessions are allocated equally across all devices.
The media family attribute specifies the class of storage media, as determined from the media type:
- tape, tape storage device
- disk, disk storage device
- logical, external media device.
The message attribute specifies the last message from a Backup server regarding a device, such as the progress or rate of an operation.
The volume name attribute is monitors the mounting and unmounting of volumes for a device.
The write enabled attribute indicates if writing to the current volume is allowed.
The volume operation attribute manipulates media volumes currently in the device, through several operations:
- The Unmount operation releases the device.
- The Mount operation mounts the loaded volume onto the device.
- The Verify label operation reads the volume's label, volume's attributes and sets the volume expiration.
- The Verify write time operation sets the volume write time attribute.
- The Label or Label without mount operations create new labels for volumes.
- The Eject operation ejects volumes from the device.
- The Monitor device operation periodically checks the device to determine whether a volume has been loaded into the device. When a volume containing a readable Backup label is loaded, the volume is listed in the Backup server's media database, and the volume is writable the volume is mounted with write permissions. Otherwise the volume is mounted read only.
The volume label attribute is set by the Verify label operation and may be an input to the Label operation.
The volume default capacity attribute is used by the Label operation if the volume current capacity attribute is blank. This attribute enables the override of default sizes when using devices (and/or tapes) with different capacities than the defaults.
The volume current capacity attribute determines the capacity of a volume during the Label operation.
The volume expiration attribute specifies a volumes expiration date, which is set by the Verify label operation.
The volume pool attribute specifies the pool a volume belongs, or has been assigned to.
The NSR operation attribute specifies the current operation being performed by the device.
The minor mode attribute reports the current status of a device.
The statistics attribute reports the statistics on the operation of a device. The statistics include:
- elapsed, the time of operation
- errors, the number of errors
- last rate, the last writing rate
- max clients, the maximum number of concurrent clients
- file marks, the number of file marks written
- rewinds, the number of rewinds
- files skipped, the number of files skipped
- records skipped, the number of records skipped
- current file, the current file number
- current record, the current record number
- seek files, the relative number of files being spaced over
- seek records, the relative number of records being spaced over
- estimated kb, the total estimated amount read/written on a volume
- amount kb, the total amount read/written on the volume, in kb
- file amount kb, the current amount read/written on this file, in kb
- sessions, the current number of sessions assigned to this device
The cleaning required attribute indicates whether a device needs to be cleaned. If the value of this attribute changes from yes to no and the value of date last cleaned is not updated then date last cleaned is set to the current time. Backup will set this attribute to yes if the device is scheduled to be cleaned. Then the notification device cleaning required is sent, indicating that a device needs to be cleaned.
The cleaning interval attribute specifies the amount of time from date last cleaned until the next scheduled cleaning for a device.
The date last cleaned attribute records the time and day a device was last cleaned.
The volume block size attribute specifies the block size of a currently mounted volume.
The volumeid attribute specifies the volume id for a currently mounted volume.
The access count attribute indicates the number of operations performed on a device since it's configuration as a Backup device.
The access weight attribute indicates the weight of a single operation performed on a device. Each time a device is used its weight is increased and the less often the device will be selected for new operations.
The consecutive errors attribute specifies the current number of consecutive errors resident on a device.
The max consecutive errors attribute indicates the maximum number of consecutive errors allowed before the device will be disabled.
The operation arg attribute specifies extra parameters about a device operation. Parameters are packed into a string and parsed.
The volume message attribute indicates the result of the volume's last operation.
The volume write time attribute indicates the time a save set was first written onto the volume.
The volume flags attribute indicates new flags for the volume to operated on, during a "Label" or "Label without mount" operation.
The jukebox device attribute indicates if a media device is in a jukebox
The unlabeled volume loaded attribute indicates whether a volume loaded into a device has a readable Backup volume label.
The auto media management attribute indicates whether automated media management for a device is enabled. If the value is set to yes then recyclable volumes loaded into the device may automatically be re-labeled by Backup for re-use and unlabeled volumes loaded into the device may be automatically labeled. A volume is considered to be unlabeled if the volume does not contain a label that may be read by this device. Volumes are considered unlabeled:
- If a volume contains a label written at a density that can not be read by this device.
- If a volume contains data written by an application other than Backup and does not have a label recognizable by Backup.
The logical name attribute specifies the name for a logical device.
The logical type attribute specifies the type for a logical device.
The logical family attribute is the family associated with a logical device.
The connection process id attribute specifies the process identifier that maintains the connection between external media management services and a mounted volume.
The connection message attribute specifies error messages reported by a process connected to an external media management service.
The connection status attribute specifies the exit status reported by a process connected to an external media management service.
The save mount timeout attribute indicates the timeout value from an initial save mount request for a storage node, on which a device resides. If a request is not satisfied, the storage node will be locked from receiving save assignments, for "save lockout" minutes.

The save lockout attribute indicates the amount of time a storage node will be locked from receiving save assignments.

The following is an example of a NSR device resource:

type:	NSR device;

name:	/dev/nrst8;

message:	writing, done

volume name:	mars.017;

media family:	tape;

media type:	8mm 5GB;

enabled:	Yes;

write enabled:	Yes;

read only:	No;

target sessions:	4;

volume label:	mars.017;

volume default capacity:	;

volume current capacity:	5000 MB;

volume expiration:	"Thu Sep 21 17:23:37 1996";

volume pool:	Default;

volume flags:	;

volume operation:	;

volume write time:	;

volume block size:	32 KB;

volume id:	32449;

accesses:	199;

access weight:	1;

consecutive errors:	0;

max consecutive errors:	20;

operation arg:	;

volume message:	;

NSR operation:	;

minor mode:	idle;

jukebox device:	Yes;

statistics:	elapsed = 257572, errors = 0, last rate = 397,

max clients = 3, file marks = 22, rewinds = 4,

files skipped = 1976, records skipped = 0,

current file = 2389, current record = 162,

seek files = 0, seek records = 0,

estimated kb = 0, amount kb = 6273,

file amount kb = 6273, sessions = 1;
cleaning required:	No;

cleaning interval:	2 weeks;

date last cleaned:	"Tue Apr 11 15:10:32 1995";

auto media management:	No;

unlabeled volume loaded:	No;
logical name:	;

logical type:	;

logical family:	;

connection process id:	;

connection message:	;

connection status:	;

save mount timeout:	30;

save lockout:		0;

NSR directive

The NSR directive resource controls the files that are saved and the special handling specifications placed on certain file types.To edit the NSR directive resources for a Backup server use "nsradmin " or "nwadmin".

The NSR directive resource has the following attributes:

The name attribute specifies the name of a directive resource. Names are displayed as choices when creating or updating Backup client resources.

The directive attribute indicates the rules that define a directive.

The following is an example of a NSR directive resource, named NTdirective:

type:	NSR directive;

name:	NT directive;

directive:	"

<< / >>

+skip : core

skip : tmp

<< c:\usr\spool\mail >>

mailasm : *

<< c:\nsr >>

allow

";

NSR group

The NSR group resourcecontrols when a group of Backup clients begin saving data and whether scheduled backups are started automatically each day. To edit the NSR group resources for a Backup server use "nsradmin " or "nwadmin"

The NSR group resource has the following attributes:

The name attribute specifies the name of a group defined by the resource. The name is an option within the NSR client and NSR pool resources.
The autostart attribute determines if a group will be saved automatically on a daily basis. The following operations can be invoked by autostart:
- The Enabled operation starts saving group members data at the time specified in the start time attribute.
- The Disabled operation disables the automatic save process specified for members of a group.
- The Start now operation saves group members data immediately.
The autorestart attribute controls whether a group is automatically restarted after an incomplete save.
The stop now attribute aborts a groups save processes immediately.
The start time attribute specifies the time of day when a group will begin a save.
The last start attribute is the last time a group began a save.
The interval attribute specifies how often a group runs an automatic save.
The force incremental attribute forces an incremental backup of a savegroup, for an interval attribute less than 24 hours.
The client retries attribute indicates the number of times failed clients should be retried before savegroup declares them failed. A client's save sets are retried by savegroup whenever savegroup would otherwise not be able to start a new save set.
The clones attribute causes saves of a group to automatically make a clone for every save set backed up.
The clone pool attribute specifies the pool where save set clones are sent.
The options attribute specifies the options indicated for a group's save.
The level attribute indicates the level a savegroup will use when started automatically by Backup. When level is not specified, the NSR Schedule for each client filesystem will be used to determine the level.
The printer attribute specifies the printer to which bootstrap save set information will be printed to.
The schedule attribute specifies the level of save that will be performed.
The schedule time attribute specifies the time a save will be performed.
The inactivity timeout attribute is the time a savegroup command waits for any kind of activity from the server before concluding that a savegroup descendant is hung.
The work list attribute indicates the saves still not completed. The worklist indicates; the client name, the level of save, and the path to save.
The completion attribute indicates the status of each save set that has been completed.

The status attribute indicates the current status of a NSR group:

idle, indicates the group is inactive
running, indicates the backups are in progress

cloning, indicates backups are complete and clones are being made.

The following is an example of a nsr_group resource:

type:	NSR group;

name:	Default;

autostart:	Enabled;

start time:	"3:33";

options:	Restartable;

printer:	lp2;

inactivity timeout:	30;

work list:	mars, incr, /g, mars, incr, index,

completion:	mars, /, succeeded,

"mars: / level=incr,     31 KB 00:01:01     72 files

NSR jukebox

The NSR jukebox resource describes the physical characteristics of each autochanger known to Backup by a single resource of type NSR Jukebox.To edit the NSR jukebox resources for a Backup server use "nsradmin " or "nwadmin".

The NSR jukebox resource has the following attributes:

The name attribute specifies the name of a jukebox.
The model attribute specifies the jukebox model.
The physical slots attribute specifies the first and last physical slot numbers in the jukebox. The first slot number must be less than or equal to the last slot number, and specified as two separate attribute values. For Silo Tape Libraries this attribute is equal to the number of volumes allocated to a Backup server.
The control port attribute specifies the path of the control port, for the jukebox robotics. Control commands are then sent to the jukebox, from the control port. For Silo Tape Libraries this attribute specifies the hostname and type of the Silo Tape Libraries server.
The devices attribute identifies device pathnames for each device residing within a jukebox. The entries are listed in the same order as they were physically installed in the jukebox.
The number devices attribute identifies the number of configured devices in the jukebox.
The write enabled attribute indicates if the mounted volume can be written to.
The bar code reader attribute indicates if Backup is using the bar code label from the media when a jukebox has a bar code label reader.
The match bar code labels attribute indicates if Backup is using the bar code label, instead of a label template, when labeling media volumes.
The volume expiration attribute specifies the expiration time for a volume that is currently being labeled, or specifies the time a volume within a jukebox will end interaction with external media management services.
The available slots attribute specifies the slots containing volumes available to be written to by Backup requests. The slots are specified by a range which may be a single slot number or a pair of slot numbers separated by a dash. The first number is less than or equal to the second. When satisfying requests to mount a particular volume or slot, all of the volumes within the physical slots can be used.
The enabler code attribute identifies the enabler code for a NSR license resource corresponding to a jukebox resource.
The operation attribute identifies the current jukebox operation.
The operation message attribute displays error messages when an jukebox operation fails.
The operation device attribute passes device names to current operations.
The operation slots attribute passes slots to current operations.
The operation options attribute passes the mode of a volume to the current operation.
The operation barcodes attribute passes volume tags or barcodes to the current operation.
The operation response attribute identifies the default response to questions asked while performing an operation.
The operation report mode attribute identifies the amount of output generated during operation execution.
The operation label state attribute designates the operation to be performed on a labeled volume as; to be recycled or to be unlabeled.
The operation volume capacity attribute specifies a volume's capacity.
The operation volume type attribute specifies the types of volumes that may be considered when allocating a volume.
The operation ineligible attribute specifies volumes ineligible for the current operation.
The operation task attribute designates a secondary task or operation to be performed with the current operation.
The operation result attribute reports error messages for multiple operations. This attribute maintains error messages for 32 simultaneous operations performed on a jukebox, that failed.
The operation instance attribute specifies the instance number associated with an operation.
The operation next instance attribute specifies the instance number associated with the next simultaneous operation.
The operation instances attribute specifies the instance number for each simultaneous operation currently executing.
The operation hostname attribute identifies the name of the system an operation is to executed.This attribute is used for jukeboxes who support devices, attached to multiple hosts, where the host machine may be inferred from other attributes, such as operation device.
The operation template attribute specifies the template a label operation will use.
The operation volume pool attribute specifies the default volume pool for label operations.
The operation source pool attribute specifies the pool a volume will be selected for recycling.
The operation uses left attribute indicates the number of times a cleaning cartridge can used.
The volumes attribute specifies the names of resident volumes in corresponding order to the slot number.
The volume ids attribute specifies the volume identifiers (volid) for resident volumes.
The volume cartridge ids attribute tracks the identifier for each cartridge h a volume resides.
The loaded volumes attribute contains the names of volumes currently loaded in jukebox devices.
The loaded bar codes attribute identifies the bar codes of loaded volumes.
The loaded slots attribute identifies the slot numbers of loaded volumes.
The event tag attribute specifies the tag of the last notification event sent to the nsrd service
The event message attribute is the text of the last notification event sent to the nsrd service.
The messages attribute specifies the log messages from previous operations nsrjb has completed.
The minimum space attribute specifies the low water mark of the remaining space on the volumes contained in the available slots.
The jukebox options attribute specifies the options for this jukebox.
The auto clean attribute specifies automatic cleaning for each device.
The cleaning slots attribute identifies the range of slots in a jukebox that have been set aside for cleaning cartridges. For a pair of slot numbers the first number of the pair is less than or equal to the second. When auto clean is set to yes the range of slots specified for this attribute are assumed to contain cleaning cartridges, and the range of slots specified by available slots.
The default cleanings attribute specifies the number of uses assigned to a new cleaning cartridge during an inventory of a jukebox by nsrjb.
The auto media management attribute indicates whether automated media management for a jukebox is enabled. If the value is set to yes, unlabeled volumes in a jukebox may be automatically labeled.
The STL device names attribute specifies silo device names of the devices identified in the devices attribute of a Silo Tape Library.
The STL interface lib attribute indicates the path name of the dynamically linked Silo Tape interface library.
The STL device sharing attribute specifies, how device sharing is handled. Device sharing is the automatic, load dependent, device switching for devices within a Silo Tape Library between different connected hosts. When this attribute is specified as perm-max, perm and max are numbers with perm < max, and perm is the number of devices, which can be reserved permanently.
The STL barcodes attribute indicates the barcodes of the volumes residing within in a Silo Tape library, which are available to Backup.
The STL device reservation attribute specifies the reservation state of shared devices in a Silo Tape library.
The application name attribute specifies the name used by a server to identify itself to OpenVault when submitting a request to access resources on a jukebox.
The application key attribute specifies the key used by a Backup server to identify itself to OpenVault when submitting a request to access resources on jukebox.
The jukebox lock attribute synchronizes access to resources in a jukebox that supports multiple simultaneous operations. This attribute can be used to lock and unlock a entire jukebox.
The device locks attribute synchronizes access to device resources in a jukebox that supports multiple simultaneous operations. The first two numbers of this attribute identify a range of devices locked, and the third number is the instance number assigned to the lock operation.

The volume/slot locks attribute synchronizes access to volume and slot resources in a jukebox. The first two numbers of this attribute identifies the range of volumes/slots locked and the third number is the instance number assigned to the operation holding the lock.

Following is an example of a NSR jukeboxresource named Huntington:

type:	NSR jukebox;

name:	Huntington;

model:	EXB-210;

physical slots:	1-11;

control port:	scsidev@0.6.0;

devices:	c:\dev\rmt\0mbn, c:\dev\rmt\1mbn;

number device:	2;

write enabled:	Yes;

bar code reader:	Yes;

match bar code labels:	Yes;

volume expiration:	;

available slots:	2-11;

enabler code:	012345-6789ab-cdef00;

operation:	Load;

operation device:	h:\dev\rmt\0mbn;

operation slots: 1-10;

operation options:	manual;

operation barcodes: A01B, A0/3-5/B;

operation response:	Yes;

operation report mode:	verbose;

operation label state:	recycle;

operation volume capacity:	10G;

operation volume type:	8mm, dlt;

operation ineligible:	;

operation task: mount after label;

operation instance:	3;

operation next instance:	2;

operation hostname:	host1;

operation template:	default;

operation volume pool:	NonFull;

operation source pool:	Default;

volumes:	venus.001, venus.002, venus.003;

volume ids:	24198, 24199, 24200;

STL device sharing:	2-4;

STL device reservation:	;

STL interface lib:	h:\usr\lib\libstl.sol;

event tag:	6319962287;event message:	could not unload device h:\dev\rmt\1mbn;

messages:	"09/12/97 11:50:56 CREATED";

minimum space:	7g;
jukebox options:	two_sided;

auto clean:	Yes;

cleaning slots:	1;

default cleanings:	12;

auto media management:	Yes;

reset class:	initialize unload;

jukebox lock:	10;

device locks:	1-1-10;

volume/slot locks:	1-5-10;

`NSR label`

The NSR label resourcedescribes the templates for generating volume labels. To edit the NSR label resources for a Backup server use "nsradmin " or "nwadmin".

The NSR label resource has the following attributes:

The name attribute specifies the name of a label template.
The fields attribute specifies constituent fields of a label template. When generating a volume name, the current value of each field is concatenated. If a separator is defined, they are placed between fields to form a volume name.

The types of fields are: numeric range, lower-case range, upper-case range and a list of strings. Each fields position is indicated by the next attribute.
The separator attribute specifies a character separator for field labels.
The next attribute specifies the next volume name to use. After a name is assigned to a volume, the next volume name will be generated and placed here.

The following is an example of a nsr_label resource:
type: NSR label; name: engineering; fields: aa-zz, 00-99; separator: .; next: aa.00;

NSR license

The NSR license resource describes the features enabled in your Backup installation. To inspect the NSR license resources for a Backup server use "nsradmin " or "nwadmin".

The NSR license resource has the following attributes:

The name attribute specifies the name of the license resource.
The enabler code attribute specifies the code entered into the nsrcap command to enable the feature named in this resource.
The host id attribute specifies the unique host ID associated with the computer or licensed operating system.
The expiration date attribute specifies the date an enabler will expire, if the enabler is an evaluation enabler or un-registered license enabler.
The auth code attribute permanently authorizes an enabler. An unique, valid authorization code for an enabler is obtained from SunSoft through the registration of each purchased license enabler.

Caution -
If a server's host ID changes, all auth codes will immediately be invalidated, and the enablers must be re-registered with SunSoft to obtain new authorization codes.
The license type attribute describes the specific feature(s) enabled.

The checksum attribute maintains consistency of a NSR license resource, and between license resources.

Following is an example of a NSR license resource:

type: NSR license;

name: Backup Advanced/10;

enabler code: 123456-123456-123456;

host id: 7260d859;

expiration date: Authorized - no expiration date;

auth code: abcdef00;

license type: B10;

checksum: xxxxxxxxxxxxxxxxxxxxxx;

NSR migration

The NSR migration resource specifies the files to be saved, the schedule, directives to use to omit files from a save, the group files will be pre-migrated with, the high-water and low-water marks to use for migration, the minimum access time and file size for migration, a list of file owners and groups to include or exclude during migration, and a list of file name patterns to skip.

To edit the NSR migration resources for a Backup server use "nsradmin " or "nwadmin".

The NSR migration resource has the following attributes:

The name attribute identifies the Backup client and save set whose migration attributes are stored in this resource.
The client attribute identifies the HSM client whose save sets are to be placed under migration control.
The save set attribute specifies the path names of filesystems or sub-trees to place under migration control for the specified client.
The enabled attribute specifies whether a save set named in a resource will be automatically migrated.
The directive attribute indicates to the client how to migrate certain files. The choices are defined by the existing directives.
The group attribute indicates the groups a client or saveset is a part of for pre-staging migrated files.
The highwater mark attribute specifies the point at which files will start being replaced by stubs, measured as a percentage of available space used on a file system.
The low water mark attribute specifies the point at which files will stop being replaced by stubs, measured as a percentage of available space used on the file system.
The last access time attribute specifies those files that have not been accessed in the past specified relative time will be migrated.
The minimum file size (KB) attribute indicate files that are larger than then a specified size, will be migrated.
The file owner attribute specifies the users whose files to be migrated.
The file group attribute specifies a groups whose files are to be migrated.
The preserve attribute indicates regular expressions, in a client's shell syntax.
The statistics attribute specifies statistics about recent migration activity for save set(s) managed using a resource.
The update statistics attribute controls whether statistics in this resource should be updated to match the current values on a client.

NSR notification

The NSR notification resourceis used for each combination of an event, priority, and action handled by the Backup notification system. A Backup notification consists of a single event type, a single priority, and a message. The notification system posts each message to the action of each NSR notification resource that includes an event type and priority. To edit the NSR notification resources for a Backup server use "nsradmin " or "nwadmin".

The NSR notification resource has the following attributes:

The name attribute specifies the name of a notification resource.
The event attribute specifies a class of events that will trigger a given notification. The valid classes are:
- Media, identifies events related to a media multiplexor subsystem
- Savegroup, identifies events generated by savegroup
- Index, identifies events related to the on-line file index subsystem, Registration, identifies events caused by changes in a product's registration status
- Server, identifies Backup server events, such as restarting.
The priority attribute specifies the priority at which a notification will be triggered. The valid values in increasing priority order are:
- Info, supplies information about the current state of a server
- Notice, an important piece of information
- Warning, gives information about a non-fatal error
- Waiting, indicates the server is waiting for a routine task
- Critical, the server detected an error condition that requires attention
- Alert, a severe error condition that demands immediate attention
- Emergency, a severe condition that may cause Backup to fail.

The action attribute indicates a command line to be executed when a given event occurs.

Following is an example of a NSR notification resource:

type: NSR notification;

name: savegroup completion;

administrator: root;

action: h:\usr\ucb\mail -s savegroup completion;

event: Savegroup;

priority: Info, Notice, Warning, Waiting;

NSR policy

The NSR policy resourcecontrols how long entries remain in a client's on-line file index, and when to mark a save set as recyclable. Each NSR client resource uses two policies, a browse policy and a retention policy. Each policy defines an amount of time determined by the period and the number of periods.

To edit the NSR policy resources for a Backup server use "nsradmin " or "nwadmin".

The NSR policy resource has the following attributes:

The name attribute specifies the name of the policy defined by this resource. This name will appear as an option of each NSR client resource.
The period attribute indicates the base unit for a policy as one of the following values:
- Weeks, defined as 7 days
- Months, defined 31 days
- Years, defined as 366 days. Example: period: Months;
The number of periods attribute specifies the number of base units to use.

Following is an example of a NSR policy resource named Quarter:
type: NSR policy; name: Quarter; period: Months; number of periods: 3;

NSR pool

The NSR pool resource describes each Backup pool, that determines a save sets browse and retention policies.This resource determines where volumes save sets reside based upon their characteristics.

There are four types of pools:

Backup pools accept data from savegroup and manual backups.
Archive pools accept archive data.
Backup clone pool, where data from a backup pool can be cloned to.
Archive clone pool, where archive data can be cloned to.

There are four pre-enabled pools shipped with Backup:
Default pool, collects any backup data that is not directed to a customized pool.
Archive pool, collects any archive data not directed to a customized pool.
Default clone pool, is available to clone backup data to.
Archive clone pool, is available for users to clone archive data to.

There are also a few pools shipped with Backup that are not enabled by default:
Use the Full and NonFull pools, to segregate full level backups from other backups, for example, fulls versus incrementals.
Use the Offsite, pool to generate offsite backups, as index entries are stored for the media pool and will not be referenced during normal recovers.

To edit the NSR pool resources for a Backup server use "nsradmin " or "nwadmin".

The NSR pool resource has the following attributes:
The name attribute specifies the name of pool resources used when labeling volumes and determines which volumes a save set will reside.
The groups attribute specifies the groups allowed in a pool.
The clients attribute specifies the clients allowed in a pool. If a group is specified, clients that are members of that group can be listed.
The save sets attribute indicates the save sets allowed in a pool. Save sets can be matched using regular expression matching.
The levels attribute specifies the levels allowed in the specified pool.
The archive only attribute enables archive only saves for a pool.
The status attribute indicates the status of a pool as one of the following:
- enabled, the pool is considered for determining what pools a save set should be saved to when performing backup volume selection.
- clone, this pool is considered as the destination for cloning.
- disabled, this pool is completely ignored.
The label template attribute specifies the label template referenced when generating volume names for a pool.
The devices attribute indicates a devices volumes within this pool that are allowed to be mounted to.
The store index entries attributes specifies the entries made into a file index for backups. If entries are not made into the file index e, only media database entries for the save sets will be created.
The auto media verify attribute will verify data written to volumes from this pool. Data is verified by re-positioning the volume to read a portion of the data previously written to the media and comparing the data read to the original data written. If the data read matches the data written, verification succeeds otherwise it fails.
The recycle to other pools attribute specifies whether or not a given pool allows other pools to recycle its recyclable volume for their use.
The recycle from other pools attribute specifies whether a given pool can recycle volumes from other pools when it exhausts all of its write-able and recyclable volumes.

The volume type preference attribute specifies the selection factor made when their is a request for a write-able volume. The preferred type will be considered first within a priority level such as jukebox or stand alone device.

Following is an example of a NSR pool resource:

type:	NSR pool;

archive only:	No;

clients:	;

devices:	;

groups:	;

label template:	Default;

levels:	;

name:	Default;

save sets:	;

status:	Enabled;

store index entries:	Yes;

auto media verify:	Yes;

recycle from other pools:	Yes;

recycle from other pools:	Yes;

volume type preference:	4mm;

NSR schedule

The NSR schedule resource describesa sequence of levels controlling the amount of data saved by Backup clients. There is one NSR schedule resource for each Backup schedule.

To edit the NSR schedule resources for a Backup server use "nsradmin " or "nwadmin".

The NSR schedule resource has the following attributes:

The name attribute specifies a schedule's name used by a client.
The period attribute specifies the length of a schedule. It may be either "Week" or "Month."
The action attribute specifies the sequence of save levels within a schedule. One entry is used for each day of a schedule. The valid levels are `full', `incr', `skip', and the numbers 1 through 9. When the action attribute does not account for every day in the period, Backup will repeat the list of actions when the end of the action list is reached.
The override attribute specifies a list of actions and dates overriding the actions specified in the action attribute. The format of an override specification is action date.

Following is an example of a NSR schedule resource:
type: NSR schedule; name: quarterly; period: Month; action: 5 incr incr incr 9 incr incr; override: f 1/1/1997, f 3/1/1997;

NSR Stage

The NSR Stage resource describes the staging policy used by a Backup server.To edit the NSR Stage resources for a Backup server use "nsradmin " or "nwadmin".

The NSR stage resource has the following attributes:

The name attribute specifies the staging policy name.
The enabled attribute specifies whether or not save sets are automatically staged from devices associated with a policy. It also enables and disables the periodic recover space operations.
The max storage period attribute specifies the maximum number of days for a save set in a given volume before it is staged to a different volume.
The high water mark % attribute specifies the point at which save sets should be staged, measured as the percentage of available space used on the file system. Staging will continue until the lower mark is reached.
The low water mark attribute specifies the point at which the staging process should stop, measured as the percentage of available space used on the file system.
The Save set selection attribute specifies the save set selection criteria for staging. It may be one of four values:
- largest save set
- smallest save set
- oldest save set
- youngest save set.
The Destination pool attribute specifies the pool save sets should be sent.
The Devices attribute specifies the file type devices are associated with.
The Recover space interval attribute specifies the number of hours between recover space operations for save sets with no entries in the media database form file devices.
The Fs check interval attribute specifies the number of hours between file system check operations.

The Start now attribute specifies the selected operation to be triggered immediately on all devices associated with a policy. Operation can be one of the following:

Check fs, check file system and stage data if necessary.
Recover space, recover space for save sets with no entries in the media database.

Stage all save sets, stage all save sets to the destination pool.

Following is an example of a NSR Stage resource:

type: NSR stage; 

name: test stage1;

autostart: Enabled;

max storage period: 7;

high water mark (%): 90;

low water mark (%): 85;

save set selection: largest save set;

destination pool: Default Clone;

devices:h:\disk\fd0;

start now: ;

NSR

The NSR resource describes a Backup server and its clients.Each resource represents a component of a Backup system that needs administration. Resources are manipulated to control a Backup system. The file and the resources in them are accessible through the nwadmin and nsradmin programs, and can be viewed with a text editor.

Each resource is described by a list of attributes. Each attribute consists of a name and optional list of values. The attribute name is separated from an attributes options by a colon (:), attribute values are separated by commas (,), and each attribute ends in a semicolon (;). A comma, semicolon or back-slash (\) at the end of a line continues the line.

Following is an example of a resource, with eight attributes.

          type: NSR client;

          name: venus;

        server: earth;

      schedule: Default;

     directive: Unix standard directives;

         group: Default;

      save set: All;

remote access: ;

Each NSR resource includes the following attributes:

The type attribute defines the attributes a resource can contain.
The name attribute specifies the descriptive name of an object that a resource represents.
The administrator attribute specifies the users that can modify or delete a resource. This attribute is inherited from the type: NSR resource when a new resource is created.
The hostname attribute specifies the hostname of the system where a service that controls the specified resource is running.
The remaining attributes (ONC program number, ONC version number, and ONC transport) specify the Open Network Computing information for a service.

Backup defines the following types of resources:
The NSR resource describes a Backup server. It contains attributes that control administrator authorization, information about operations in progress, and statistics and error information about past operations.
The NSR client resource describes a Backup client. It includes attributes that specify the files to save, which schedule to use, and which group this client belongs to.
The NSR device resource describes a storage device. It includes attributes that specify a particular device name, media type, and name of the currently mounted volume.
The NSR directive resource describes a directive. Directives control how a client's files are processed as they are being saved.
The NSR group resource specifies a logical grouping of Backup clients and a backup starting time.
The NSR jukebox resource describes a jukebox. It includes attributes such as the jukebox model, the first and last slot numbers in the jukebox, and the names of the devices within the jukebox.
The NSR label resource specifies a template describing a sequence of names to be used when labeling volumes.
The NSR license resource contains licensing information for each feature currently enabled. It contains various enabler and authorization codes used by Backup to validate licensed capabilities.
The NSR notification resource specifies an action to be performed when a particular type of Backup event takes place.
The NSR policy resource is used as part of the index management process. These policies control how long entries remain in a client's on-line file index and when to mark a save set as recyclable.
The NSR pool resource is used by Backup to determine where volume save sets should reside on based on the characteristics of the save.
The NSR schedule resource defines a sequence of save levels and an override list. The override list is made up of pairs of levels and dates. The level controls the amount of data saved when a client is backed up.

Server Status Resource for Character-Based Displays

The nsrwatch program displays a Backup server's status from any system with enough termcap capabilities for cursor positioning. The nsrwatch program gets its information through remote procedure calls to the specified server. You can invoke nsrwatch from any machine that can access the Backup server through the network. If you do not specify a particular server, the server selection rules apply.

The nsrwatch display is divided into a header and several panels: the Server panel, the Device panel, the Sessions panel, the Messages panel, and the Pending messages panel. The panel sizes adjust depending on the size of the terminal or window used.

The header contains the name of the server and the current time. The Server panel provides information on the current status of the server (error messages, how long the server has been running, and the version of Backup software the server is using). The Device panel displays all the devices known to the Backup server. For each device, the panel displays the device type, the name of the currently mounted volume (or "unmounted" if there is none), and the device's status. If the device name has a "(J)" listed after it, the device resides in an autochanger or silo. The Sessions panel provides current save set information for each active session (save, recover, or browse). The Message panel displays a history of Backup messages of general interest to the operator. Finally, the Pending message panel displays messages that require operator intervention.

The nsrwatch program runs continuously until stopped by typing q or interrupted by a Control-z or Control-c keystroke. If you type Control-l, the screen is cleared and refreshed with current information.

The following example describes the format and options available for the nsrwatch program:

nsrwatch [-s server] [-p polltime]

Use the -s server option to specify a particular Backup server on the network.
Use the -p polltime option to set the polling interval to be in polltime seconds.

`nwadmin`

The nwadmin program is an X Window System application that is used to administer and monitor Backup servers. You can specify which Backup server to administer by using the -soption with the nwadmin command. If no server option is specified, nwadmin uses the server selection rules outlined under "User Interface Startup".

The following example describes the format and options available for the nwadmin program:

nwadmin [-s server]

Use the -s server option to specify a particular Backup server on the network.

`nwarchive`

The nwarchive program is an X Window System application that provides a GUI to the nsrarchive program, which is used to archive files on a manual basis to a Backup server. You can specify which Backup server to send archived data to by using the -s option with the nwarchive command. If no server option is specified, nwarchive uses the server selection rules outlined under "User Interface Startup".

The following example describes the format and options available for the nwarchive program:

nwarchive [-s server]

Use the -s server option to specify a particular Backup server on the network.

`nwbackup`

The nwbackup program is an X Window System application that provides a GUI to the save program, and is used to administer and monitor Backup servers. You can specify which Backup server to administer by using the -s option with the nwbackup command. If no server option is specified, nwadmin uses the server selection rules outlined under "User Interface Startup".

The following example describes the format and options available for the nwbackup program:

nwbackup [-s server]

Use the -s server option to specify a particular Backup server on the network.

`nwrecover`

The nwrecover program is an X Window System application that is used to administer and monitor Backup servers. You can specify which Backup client's data to recover by using the -c option with the nwrecover command. You can also specify which Backup server to recover the data from by using the -s option with the nwrecover command. If no server option is specified, nwrecover uses the server selection rules outlined under "User Interface Startup".

The following example describes the format and options available for the nwrecover program:

nwrecover [-c client] [-s server]

Use the -s server option to specify a particular Backup server on the network.
Use the -c client option to specify a particular Backup client on the network.

`nwretrieve`

The nwretrieve program is an X Window System application that provides a GUI to the nsrretrieve program, which is used to retrieve archived files on a manual basis from a Backup server. You can specify which Backup server to retrieve the archived data from by using the -s option with the nwretrieve command. If no server option is specified, nwretrieve uses the server selection rules outlined under "User Interface Startup".

The following example describes the format and options available for the nwretrieve program:

nwretrieve [-s server]

Use the -s server option to specify a particular Backup server on the network.