Solstice Backup 5.1 Administration Guide

Appendix B Command Line Reference Utilities

The Backup software includes a graphical user interface (GUI) as well as a command line interface. For instructions on how to use the GUI, see the online help included in the program, which you start by invoking the nwadmin command at the shell prompt.

This appendix provides an abbreviated reference for some of the options available through the command line interface. The information is organized by the tasks to which they relate. The online manual (man) pages, included with your Backup software, are available for more detailed information and examples about each command.

To view a man page, make sure that the MANPATH environment variable includes the path where you installed the Backup man pages, then enter man command-name, for example, man nsrjb. To display a man page that explains the man pages, enter man man. To print a copy of the entire collection of Backup man pages, enter the troff command at the shell prompt with the options shown in this example:

$ troff -t -man `nsr_man -l'| lpr -t -P printer-name

The command for your machine can vary (for example, your print command may be lp instead of lpr), depending on the operating system and the version of PostScript software you have installed.

Enabler Entry and Registration

When you enter an enabler code, you unlock features of Backup that you can use for 45 days. To continue to use Backup after the 45 days expire, you must follow the instructions provided on your Enabler Certificate and register your enabled software. When you register your software, a unique authorization code is generated that is keyed to your specific system information and enabler code. After you receive and enter the authorization code, you can use the Backup software indefinitely.

`nsr_ize`

The interactive nsr_ize program installs or removes Backup software and files to or from a machine. Informational prompts guide you through a series of questions, many of which already provide default answers to use for a standard environment.

The nsr_ize program modifies several system administration files, including /etc/rpc. If you use YP, modify the YP master's /etc/rpc file with the same modifications that nsr_ize makes to the local copy of /etc/rpc.

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

nsr_ize [-i | -r -u] [-c | -s] [-kmnqxv>

Use the -c option to tell nsr_ize to install or remove only the client software.
Use the -i option to install the Backup software and associated files.
Use the -k option to kill the Backup daemons without confirmation.
Use the -m option to tell nsr_ize not to install or remove the Backup man pages.
Use the -n option to tell nsr_ize not to perform actions that change the filesystem. When you use the -n option, nsr_ize prints the installation script without performing the commands.
Use the -q option to run nsr_ize in quiet mode.
Use the -r option to remove the Backup software and associated files.
Use the -s option to tell nsr_ize to install or remove only the server software.
Use the -u option to prepare your system for a Backup software upgrade. The existing Backup software is removed, but the nsr.res file, client file indexes, server bootstrap, and media database are preserved.
Use the -v option to run nsr_ize in verbose mode.
Use the -x option to set the debug flag.

`nsrlic`

The nsrlic program generates reports about all the license information currently active on the Backup server. This command queries the Backup resource database, and formats and displays the results to standard output. You do not need to be root to invoke nsrlic.

If you enter nsrlic at the shell prompt without optional flags, you receive a report, similar to the following example, for the server that you invoked the command from:

SERVER (UNIVERSAL) CLIENT LICENSES
                     Available: 10
                          Used: 0
          Borrowed from Server: 0
                     Remaining: 10
             Connected Clients: ;
               Defined Clients: ;
WORKSTATION CLIENT LICENSES
                     Available: 0
                          Used: 0
                     Remaining: 0
             Connected Clients: ;
               Defined Clients: ;
SERVER CLIENT TYPES
                           AIX: 0
                            HP: 0
                       Solaris: 0
                         SunOS: 0
             Windows NT Server: 0
                       NetWare: 0
WORKSTATION CLIENT TYPES
                           DOS: 0
                     Macintosh: 0
                          OS/2: 0
                  Windows 3.1x: 0
                    Windows 95: 0
        Windows NT Workstation: 0
                        Others: 4

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

nsrlic -vi -s server

Use the -i option to use nsrlic in the interactive mode. In this mode, you can request different reports, refresh the information, or switch to a different server. The interactive mode provides a prompt and displays the choices available:

connecting to jupiter...
Available commands are:
   summary - display a summary report of licenses
   detail - display a detailed report of licenses
   connect [server name] - connect to server
   help - list command helps.
   quit - quit out of nsrlic command.
nsrlic>

The information is requested once and cached until you issue another connect command at the nsrlic prompt.

Use the -s server option to select a specific Backup server to query. If you omit this option, the server from which you invoked the nsrlic program is queried.
Use the -v option to generate a more detailed, verbose report. In addition to the number of licenses or the number of clients, a list of connected and defined clients is gathered and displayed.

`NSR license`

The NSR license resource describes each Backup software feature that you entered an enabler code for, as well as the permanent authorization code, once entered. To inspect the NSR license resource on your Backup server, become root and use the GUI to view the Registration window or enter the following command at the shell prompt:

# nsradmin -c "type:NSR license"

You can create, enable, or authorize a NSR license resource from within the GUI; however, you must use the nsrcap command to update an existing NSR license resource.

`nsrcap`

The nsrcap program enters a unique enabler code into the Backup server's nsr_license resource that enables you to use features in the Backup software that you installed. You can use the nsrcap program to enter the enabler code for a new feature, or you can use the nsrcap program to enter an enabler code that upgrades or downgrades Backup software features that you are already using.

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

nsrcap [-vn] {-c | -u | -d} enabler-code

To use the nsrcap program, you must become root on the Backup server and specify only one of the following command options:

Use the -c option to enter an enabler code that enables you to use a feature that is not already installed. You can only load a feature once; an error is returned if you try to load the enabler more than once.
Use the -d option to enter an enabler that downgrades an existing Base or Jukebox enabler. After you downgrade the enabler, you cannot return to the previous level enabled on your system. Do not use the -d option unless instructed to do so by SunSoft.
Use the -u option to enter an enabler that upgrades an existing Base enabler. (The -u option only works for the server enabler code). After you upgrade the enabler, you cannot return to the previous level enabled on your system.

The nsrcap program has two additional options that you can elect to use when you enter the one of the following command options:
Use the -v option if you want the nsrcap program to display verbose information that describes the enabler entered.
Use the -n option if you want to inspect the enabler code for validity. When you specify the -n option, the enabler code you enter on the command line is inspected, but is not entered into the Backup server's nsr_license resource.

`nsr_shutdown`

The nsr_shutdown command identifies and kills the Backup processes on a Backup server. Use the command whenever you need to install or remove Backup software. You must become root on the system to use the nsr_shutdown command.

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

Use the -a option to kill all of the Backup daemons. The option has the same effect as the -A, -d, and -s options combined.
Use the -A option to kill any nsralist processes.
Use the -d option to kill the Backup server daemons. If you do not specify any options, the -d option is assumed by default.
Use the -n option to echo the kill command without a real shutdown.
Use the -q option to perform a quiet shutdown, without prompts for confirmation.
Use the -s option to kill any savegrp and nsrexecd processes.
Use the -v option to echo commands and their arguments as nsr_shutdown executes them.

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.

Device and Media Management

This section provides a reference of the Backup command lines to use for device and media management. Some of the commands pertain specifically to the devices contained in an autochanger or silo; some commands apply specifically to SCSI devices, either standalone or in an autochanger.

The SCSI device library is a set of interfaces that Backup uses to communicate with SCSI devices. The SCSI devices are named in a platform-independent manner. The name assigned to the SCSI device is essentially a combination of b.t.l, where b is the logical SCSI bus, t is the SCSI target, and l is the SCSI logical unit number (lun) on that target.

A logical SCSI bus number may not be related to any specific platform hardware bus number; it may be a dense positive integer address space, that persists from system reboot to system reboot if the system hardware configuration remains the same. Target and lun information is contingent on the attached SCSI peripheral devices and their settings. Some platforms may allow dynamic addition and removal of SCSI devices, but may require a flush of the cached device information.

Typically, if a device does not have a system driver, users have permission to send SCSI device library commands. If a device has a system driver (for example, a tape drive), system privileges are required to send a command.

`changers`

The changers program lists the SCSI autochangers that are attached to the system.

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

changers [-dv] [-a b.t.l]

Use the -d option to determine the names and addresses of the autochanger's media elements (for example, tape drives).
Use the -v option to list more detailed information about each autochanger. The details provided may indicate how many media transports (MT), storage transports (ST), import/export elements (IE), and data transport (DT) elements the autochanger contains. The -v option also provides information about the element movement matrix supported by the autochanger.
Use the -a option to identify a specific ordinal SCSI address for which you want to list information.

`hpflip`

The hpflip program reads a Vendor Unique mode page from an HP Optical disk drive and toggles or "flips" the device type between OPTICAL and DIRECT ACCESS. Typically, most systems include drivers that can deal with removable DIRECT ACCESS device types (which are often limited to 512 byte/sector formatted disks). Systems with these device types often do not also have device drivers for OPTICAL device types. The hpflip program enables you to control how an HP Optical Disk Drive reports itself, and thus makes the OPTICAL device type available where it otherwise would have required an additional device driver.

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

hpflip -a b.t.l [-r]

You must use the required -a b.t.l argument to select a specific ordinal SCSI address, where "b" is the logical SCSI bus, "t" is the SCSI target, and "l" is the SCSI lun on that target.
Use the -r option to reset the named device to OPTICAL, regardless of its current state. If you do not specify the -r option, the device type simply changes to the opposite of the current state.

`ielem`

The ielem program sends an INITIALIZE ELEMENT STATUS command to the named SCSI device.

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

ielem -a b.t.l [-r element-address.number-of-elements]

You must use the required -a b.t.l argument to select a specific ordinal SCSI address, where b is the logical SCSI bus, t is the SCSI target, and l is the SCSI lun on that target.
If your autochanger supports the Vendor Unique EXABYTE autochanger INITIALIZE ELEMENT STATUS command, use the -r option to initialize the element status for a range of elements. Specify the starting element's decimal address and the number of elements whose status you want to read.

`inquire`

The inquire program (in /etc/LGTOuscsi on Solaris systems) lists SCSI devices available. The inquire program returns INQUIRY data either for the named SCSI device (with the -a option) or for all SCSI devices attached to the system.

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

inquire [-c] [-a b.t.l]

Enter the optional -a b.t.l argument to select a specific ordinal SCSI address, where b is the logical SCSI bus, t is the SCSI target, and l is the SCSI lun on that target.
Enter the optional -c argument to force an INQUIRY command to be sent (to avoid picking up cached data that may be stale).

The inquire program always uses the built-in system drivers to test SCSI devices. The device type or pathname printed by the inquire program may be incorrect for devices that require special, third-party drivers.

Caution -
The inquire program is not supported on HP-UX systems.

`jb_config`

The jb_config must be running on the Backup server or storage node.

The script pauses periodically for you to enter a response to a prompt. If you want to accept the default choice displayed in braces, simply press Return. If you want to enter a different value, type the entry and press Return.

After you configure the autochanger, use the nsrcap command or the Registration window to enter the enabler code for your Autochanger Software Module. You must have a separate enabler for each autochanger you want to use with Backup.

`ldunld`

The ldunld program sends a LOAD or UNLOAD command to the named tape device to load or unload media.

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

ldunld {-u | -l} -a b.t.l

There are three command options:

You must use the required -a argument to select a specific ordinal SCSI address.
Use the -l option to load media into a device.
Use the -u option to unload media from a device.

`libsji`

The libsji program describes the Standard Jukebox Interface (SJI) Library. The location of the SJI library varies from platform to platform.

The SJI library is a public set of interfaces that Backup uses to communicate with jukeboxes. Generally, this library converts SJI commands (as formed by Backup) to the appropriate SCSI commands, but the underlying attachment to the jukebox is irrelevant to the function of this interface.

There are three entry points into the SJI library:

void * sji_open (char * device-name)

The sji_open entry point opens a channel to the SJI-compliant jukebox specified by device-name. A channel token of type void * is returned if successful, otherwise a NULL token is returned. You can express the device name as an ordinal SCSI type (for example, scsidev@b.t.l). The device name can also be a platform-specific style device name (for example, /dev/sjid1u1) for those platforms that do not use SunSoft device drivers.
int sji_cmd (void *token, int cmd, void *arg)

The sji_cmd entry point sends an SJI command to the device opened by sji_open.
void sji_close (void *token)

The sji_close entry point closes a channel to the device opened by the call to sji_open.

The list of all the available commands and their arguments is too large to list here. Send e-mail to sji@legato.com to request more information on these interfaces.

`lrescan`

The lrescan program tells the underlying SCSI library to discard any cached information that it can and scan again for new devices.

`lreset`

The lreset program tells the underlying SCSI library to reset the named logical SCSI bus. You must have administrative privileges to execute this command, which has the following format:

lreset busnumber

Caution -

The lreset command can cause the destruction of vital data, because the command causes a SCSI bus reset. The command may also crash your system. You should only use the lreset command as an extreme last resort to quit a process that is not responding.

`lusbinfo`

The lusbinfo program prints out a limited amount of information about the SCSI buses attached to the system. If you use the optional -v argument, a verbose list of information about the devices in the attached SCSI buses is also printed. The following example shows the format to use for the lusbinfo program:

lusbinfo [-v]

`lusdebug`

The lusdebug program sets a debug level for the underlying Backup SCSI device drivers. A debug level of 0 (zero) turns off debugging. Larger integers enable greater levels of debug information. If you enter an invalid debug level, the lusdebug program defaults to a debug level of zero. The following example shows the format to use for the lusdebug program:

lusdebug debug-level

`lusmode`

The lusmode program prints a large amount of MODE information about the SCSI devices attached to the system.

`msense`

The msense program sends a MODE SENSE command to the named SCSI device and is only indented as input to the pmode command.

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

msense -a b.t.l. [-p pagecode]

You must use the required -a b.t.l argument to select a specific ordinal SCSI address, where b is the logical SCSI bus, t is the SCSI target, and l is the SCSI lun on that target.
Use the -p option to select a specific mode page. If you do not specify a specific mode page, all pages are fetched (code 0x3f). You must specify the pagecode argument in hexadecimal notation.

`nsrjb`

The nsrjb program manages autochangers for Backup servers. Use the nsrjb command, rather than the nsrmm command, to label, load, and unload the volumes contained in an autochanger. Only one nsrjb command can access an autochanger at a time.

The nsrjb program attempts to determine which autochanger to use based on the options -j, -f, or a volume name. If one or more of these options do not uniquely identify an autochanger and one must be selected, the nsrjb program prompts you to choose an autochanger. Alternatively, you can set the NSR_JUKEBOX environment variable to the name of the autochanger you want the nsrjb program to use by default.

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

nsrjb [-C] [-j autochanger-name] [-v]

[-f media-device] [-S slots] [volume-name]
nsrjb -L [-j autochanger-name] [-gnqvM] [-R | -B]

[-Y | -N] [-b pool] [-f media device] [-e expire]

[-c capacity] [-o mode] [-S slots | -T tags]

[volume-name]
nsrjb -l [-j autochanger-name] [-nvqrMR]

[-f media-device] {-S slots | -T tags | volume-name}
nsrjb -u [-j autochanger-name] [-qvM]

[-f media-device] [-S slots -T tags] [volume-name]
nsrjb -I [-j autochanger-name] [-Ev]

[-f media-device] [-S slots | -T tags]
nsrjb -p [-j autochanger-name] [-v]

[-f media-device] [-S slots -T tags]
nsrjb -o mode [-j autochanger-name] [-Y]

{-S slots | media device}
nsrjb -H [-j autochanger-name] [-E] [-v]
nsrjb -h [-j autochanger-name] [-v]
nsrjb -U uses [-j] [-S slots | -T tags]
nsrjb -V [-j autochanger-name] [-v]
nsrjb -d [-j autochanger-name] [-v] [-S slots]

[-P port] [volume-name]
nsrjb -w [-j autochanger-name] [-v] [-S slots]

[-P port] [volume-name]
nsrjb -a [-j autochanger-name] [-v] -T tags
nsrjb -x [-j autochanger-name] [-v] -T tags
nsrjb -F [-j autochanger-name] [-v] -f media-device

Use the -b option to specify the pool to which you want to assign the volume. If you omit this option, the volume is automatically assigned to the Default pool.
Use the -B option to verify that the volume does not already have a readable Backup label. If you specify this option and the volume has a Backup label, the label operation is canceled and an error message is displayed.
Use the -c option to override the volume's default capacity.
Use the -C option to display the current volumes in the autochanger and the associated devices. The -C option does not perform an actual inventory.
Use the -d option to deposit (load into the jukebox) a cartridge from the cartridge access port (CAP).
Use the -e option to override the default volume expiration date.
Use the -E option to initialize element status for autochangers that provide this feature. You can use this option in conjunction with the -I or -H options.
Use the -f option to specify a media device rather than the jukebox control port. Use the pathname of the media device displayed in the NSR jukebox resource.
Use the -h option to display the actions and results of the past 100 autochanger commands issued.
Use the -H option to reset the autochanger hardware (and the Backup database that represents the autochanger) to a consistent state. The autochanger clears the transport, and then unmounts and unloads volumes from the drives to slots. An inventory is not done (see the -I option). If the autochanger senses that the inventory is out-of-date, it prints an appropriate message.
Use the -I option to perform an inventory on the autochanger's contents. The volumes in the specified slots are loaded into a device and their labels are read. Use this option to ensure that the mapping between slot number and volume name is correct. This option may take a long time to complete.

For jukeboxes that have the element status capability (for example, the EXB-120, EXB-60, or HP optical models), you can use the -E option in conjunction with the -I option to reinitialize the autochanger's inventory state. The -E option increases the time it takes to inventory the autochanger, because the hardware must check every component, including all slots and drives, for the presence of media. You only need to use this option if you manually swap media in or out of an autochanger.

Volumes from slots that are reserved for cleaning cartridges are not loaded during the inventory. If your autochanger does not support the element status or barcode reader features, you must use the -U option to enter a cleaning cartridge into the autochanger's inventory. If your autochanger does support either of these features, the cleaning cartridge is indicated in the inventory with the volume name "cleaning tape."
Use the -j option to specify a particular autochanger for the nsrjb program to use. The given name is the one that you assigned when you created the NSR jukebox resource for the autochanger. If you supply the -j option, the NSR_JUKEBOX environment variable is overridden.
Use the -l option to load and mount a volume. You must also specify a volume name or slot number.
Use the -L option to label the volumes in the specified slots. If you do not specify any slots, the range of slots described in the NSR jukebox resource for the autochanger is used. If the autochanger has a barcode label reader and you set the NSR jukebox resource attributes "barcode reader" and "match barcode labels," the volume label is derived from the barcode label on the media, and the media barcode label will be stored in the Backup media database. If you set the NSR jukebox resource attribute "match barcode labels," the volume label is derived from the label template, although the media barcode label is stored in the Backup media database so that it can be used during inventory operations. You cannot label volumes that are in slots reserved for cleaning cartridges.
Use the -n option, in combination with the -l option, to load a volume without mounting it. This allows the nsrjb program to control an autochanger that contains non-Backup volumes.
Use the -N option, in combination with the -LR options, to tell nsrjb to skip the confirmation prompt. When Backup recycles volumes, you normally receive a prompt to confirm that it is okay to overwrite any volumes that Backup considers nonrecyclable.
Use the -o option to set the mode of a volume or range of slots. Choose one of the following mode values: [not]recyclable, [not]read-only, [not]full or [not]manual. The [not]manual modes are the only valid modes when used with the -l option. If you do not give the -Y option, you are prompted to confirm the operation for each volume. See "nsrim " for a discussion of the per-volume flags.
Use the -p option to verify and print a volume's label.
Use the -P option to specify the CAP to load or unload a volume from.
Use the -q option to run the nsrjb program in quiet mode. You can only use this option in conjunction with the -L, -l, and -u options.
Use the -R option to recycle the volumes. If a volume is recyclable, you are not prompted to confirm the recycle operation.
Use the -r option to load a volume as read-only. You can only use this option in conjunction with the -l option.
Use the -S option to specify a slot or range of slots to operate on. The -l and -u options only accept one slot: the other options accept a range of slots. Specify the slot range in low to high integer order. The range is checked for validity against the Jukeboxes resource that describes the autochanger. You can only specify one slot range at a time.
Use the -u option to unload a volume from a device or slot.
Use the -U option with the uses argument to set the number of times a cleaning cartridge may be used. You can use the -T option in conjunction with the -U option to add cleaning cartridges to a silo, which also reserves a slot in the silo for each cleaning cartridge added.
Use the -v option to tell nsrjb to display verbose information about the commands executed.
Use the -V option to display vendor-specific status information. When you combine the -V option with the -v option, the configuration of the autochanger is also displayed.
Use the -w option to withdraw (unload from the jukebox) a cartridge to the CAP.
Use the -Y option to disable the prompt for confirmation.

The following options are only valid for Silo Tape Libraries (STL):
Use the -a option, in conjunction with the -T option, to allocate volumes in an STL for use by a Backup server or storage node. You must allocate a volume before you label it for Backup to use. You can add the -d option for silos that support the deposit (also known as importing or entering) of tapes through the silo's I/O port. The -d option must appear after the -a option on the command line. This function is usually handled by the silo management software, but is provided here for ease of use. The deposit option may not be supported on all the silos that Backup supports. See the -x option for a description of how the volumes are removed from an STL's list of volumes available for use by a Backup server.
Use the -F option to release a shared device contained in an STL. This option is only available for tape libraries that support shared devices.
Use the -T option to specify the tags or barcodes of volumes contained in an STL. You can specify a single volume tag or a volume tag template, which is similar to a regular Backup label template. The volume tag template consists of a list of template fields separated by slashes (/), whereas a Backup label template consists of an alphanumeric string or alphabetic or numeric range.
Use the -x option, in conjunction with the -T option, to remove volumes from the STL's list of volumes available for use by a Backup server or storage node. You can add the -w option for silos that support the withdrawal or ejection of tapes through the silo's I/O port. The -w option must appear after the -x option on the command line. The silo management software usually handles this function, but it is provided here for ease of use. The withdrawal option may not be supported on all the silos that Backup supports. See the -a option for a description of how the volumes are allocated to an STL's list of volumes available for use by a Backup server.

`nsrmm`

The nsrmm program provides a command line interface to manage the media and backup devices used by Backup servers and storage nodes.

The following examples describe the format and options available for the nsrmm program:

nsrmm [-C] [-v | -q] [-s server] [-f device]
nsrmm -m [-v | -q] [-s server] [-f device] [-r]

[volume-name]
nsrmm -l [-v | -q] [-s server] [-f device] [-myB] [-e expiration] [-c
capacity] [-o mode] [-b pool] [-R | volume-name]
nsrmm {-u | -j} [-v | -q] [-s server] [-y]

[-f device | volume-name]
nsrmm -p [-v | -q] [-s server] [-f device]
nsrmm {-d | -o mode} [-v | -q] [-s server] [-Py] [S ssid[/cloneid] |
-V volume-id | volume-name...]

Use the -B option to verify that the volume you want to label does not have a readable Backup label. If you specify this option and the volume has a valid Backup label, the label operation is canceled and an error message is displayed.
Use the -b pool option to specify the pool to which the volume should be assigned. If you omit this option, the volume is automatically assigned to the Default pool. If you specify a pool name without specifying a volume name, the next volume name associated with the pool's label template resource is used.
Use the -C option to display a list of Backup-configured devices and the volumes currently mounted in them. The information is gathered from what the server inventory shows, and does not perform an actual volume operation, unlike the -p option described later. The -C option is the default.
Use the -c option to override a volume's default capacity. Backup normally uses built-in default capacities, based on the device's type. The format of the specification is number multiplier. Number may be any value, including an integer or real number, with up to three decimal places. Multiplier may be one of "K" (1024 bytes), "M" (1000K), or "G" (1000M). Lowercase letters are acceptable, as are extra characters.
Use the -d option to delete the client file indexes and media database entries from the Backup databases. This action does not destroy the data contained on the volume: instead, it removes all references used by Backup to the volume and the user files contained on it. You can use this option to control the size of the Backup databases.
Use the -e expiration option to set the expiration date for volume relabel. This option overrides the default label expiration, which is two years. The value of expiration is entered in the format described in a special value of forever that is used for migration and archive volumes means that the volume label never expires.
Use the -f device option to explicitly specify a device. When you configure more than one device, the nsrmm program selects the first device by default.
Use the -j option to eject a volume from the device. This is similar to performing an unmount operation, except that the volume is also physically ejected from the device, if possible. This option is not available with many devices and media types.
Use the -l option to label a volume for Backup to recognize and use. You must physically load the volume into the device, either by an operator or autochanger, before the label operation can proceed.
Use the -m option to mount a volume in a device. The mount operation is performed after the volume is placed in the device and labeled; therefore, only labeled volumes can be mounted. You can combine the label and mount operation in one command line.
Use the -o mode option to set the mode of a volume, save set, or save set instance (clone). Choose one valid mode value: [not]recyclable, [not]readonly, [not]full, [not]manual, or [not]suspect. The [not]recyclable mode applies to volumes or save sets, but not to clones. The [not]readonly, [not]full, and [not]manual modes are the only valid modes you can use with the -l option. The [not]suspect mode applies only to clones. You must specify the [not]suspect mode if you use the -S option with an ssid/cloneid specification. You do not need to specify the [not]suspect mode if you only specify ssid with the -S option. The suspect flag is set automatically when a recover operation encounters a media error when attempting to recover data from a particular save set clone.
Use the -P option in conjunction with the -d option to purge the corresponding client file index entries, without deleting the entries in the media database. You can then use the scanner command to recover the file index entries.
Use the -p option to verify and print a volume's label. When you use this option, mounted volumes are unmounted to verify the label.
Use the -R option to relabel a volume. This option rewrites the volume's label and purges the client file index entries for all of the user files saved on the volume. Some of the volume usage information is maintained.
Use the -r option to mount a volume as read-only. Volumes that are marked as full and volumes whose mode is set as read-only with the -o option are automatically mounted as read-only.
Use the -s server option to specify the Backup server on which you want to invoke nsrmm.
Use the -S ssid option with the -o option to change or the -d option to remove a save set from the Backup databases. The save set is specified by an ssid. A save set instance (clone) can only be specified with the -o option, using the format ssid/cloneid. You can use the mminfo program to determine the ssid and cloneid values.
Use the -u option to unmount a volume. You should always unmount a volume before you unload it from a device.
Use the -V volid option in conjunction with the -d option to remove a volume from the Backup server's media database. You can determine the value of the volume identifier (volid) with the mminfo program.
Use the -v option to run the nsrmm program in verbose mode.
Use the -y option to turn off confirmation of potentially destructive operations before nsrmm performs them. Use this option with extreme caution.

`pmode`

The pmode program parses the data output by the msense program and prints the output in a format that you can read.

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

pmode [-f filename]

Use the -f filename option to specify the input file to use for the pmode program (the file output from the msense program). If you do not specify the input, standard input is assumed.

The output from the pmode program is similar to the following:

mars# msense -a 0.0.0 -p 0x03 | pmode Mode Header: mdl=35 mtype=0x0
dparm=0x10 bdlen=8 Block Desc[0]: dens=0x0 nblks=3933040
blklen=512 Fixed Page, code 0x03

(Format Device): tracks_per_zone: 0xf

alt_sectors_per_zone: 0x22

alt_tracks_per_zone: 0x0

alt_tracks_per_vol: 0x0

sectors_per_track: 0x5e

data_bytes_per_sect: 0x200

interleave: 0x1

track_skew_factor: 0x8

cylinder_skew_factor: 0x11

SSEC: 0x0

HSEC: 0x1

RMB: 0x0

SURF: 0x0

`relem`

The relem program sends a READ ELEMENT STATUS command to all changers, or to the (optionally, with the -a option) named device.

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

relem [-a b.t.l] [-fvtb] [-m {0|1|2}] [-r element-address.number-of-elements]

Use the -a b.t.l option to select a specific ordinal SCSI address, where "b" is the logical SCSI bus, "t" is the SCSI target, and "l" is the SCSI lun on that target (for example, scsidev@0.4.0).
Use the -b option to have the returned element status data dumped as ASCII hexadecimal codes, rather than decoded information.
Use the -f option to receive full, somewhat verbose output.
Use the -m {0|1|2} option to indicate the method for obtaining element status data. If you specify -m 1, element status data is fetched for each element type (for example, all drive elements are read at once, then all slot elements, and so forth). If you specify the default method -m 2, element data is fetched on a per element basis.
Use the -r element-address.number-of-elements option to read a range of addresses, where element-address is the starting decimal address (in the autochanger's numbering sequence) of the element to start from and number-of-elements is the number of elements of status to read.
Use the -t option to print any volume tags encountered.
Use the -v option to receive verbose output.

`sjidopen`

The sjidopen program tests the SJIDOOROPEN command on SJI-compliant autochangers. The SJIDOOROPEN command tests the open/close capability of the main door to the autochanger. If an autochanger does not support this feature, an error message is returned. The following example shows the correct usage for the sjidopen program:

sjidopen device-name

The device-name option used with the sjidopen program represents any device name that can be used to reach an SJI-compliant autochanger driven by the system, typically in the form b.t.l, where b is the logical SCSI bus, "t" is the SCSI target, and "l" is the SCSI lun on that target (for example, scsidev@0.4.0).

`sjiielm`

The sjiielm program tests the SJIIELEM command on SJI-compliant Jukeboxes. The SJIIELEM command tests the Initialize Element Status interface for an autochanger. If the autochanger does not support the element status feature, an error messages is returned. The following example shows the correct usage for the sjiielm program:

sjiielm device-name [{drive | slot | inlt | mt} address number-of-elements]

The device-name option used with the sjiielm program represents any device name that can be used to reach an SJI-compliant autochanger driven by the system, typically in the form b.t.l, where b is the logical SCSI bus, t is the SCSI target, and l is the SCSI lun on that target (for example, scsidev@0.4.0).

The additional options described next are for use with autochangers that support the initilization of a specific range of elements. If the autochanger supports this feature, select one of the following element types:

drive
slot
inlt (import/export element)
mt (media transport)

Specify the SJI normalized address (for example, starting from 1) and the number of elements to initilize.

`sjiinq`

The sjiinq program tests the SJIINQ command on SJI-compliant autochangers. The SJIINQ command returns a string that identifies an autochanger. If the autochanger does not support this feature, an error message is returned. The following example shows the correct usage for the sjiinq program:

sjiinq device-name

The device-name option used with the sjiinq program represents any device name that can be used to reach an SJI-compliant autochanger driven by the system, typically in the form b.t.l, where b is the logical SCSI bus, t is the SCSI target, and l is the SCSI lun on that target (for example, scsidev@0.4.0).

`sjirdp`

The sjirdp program tests the SJIRDP command on SJI-compliant autochangers. The SJIRDP command reads SJI ordinal device positions from an autochanger. The following example shows the correct usage for the sjirdp program:

sjirdp device-name

The device-name option used with the sjirdp program represents any device name that can be used to reach an SJI-compliant autochanger driven by the system, typically in the form b.t.l, where b is the logical SCSI bus, tis the SCSI target, and l is the SCSI lun on that target (for example, scsidev@0.4.0).

The following example represents typical output from the SJIRDP command:

scsidev@0.4.0 has 2 DATA TRANSPORT Elements starting at address 1

scsidev@0.4.0 has 1 MEDIA TRANSPORT Element starting at address 1

scsidev@0.4.0 has 25 STORAGE Elements starting at address 1

scsidev@0.4.0 has 1 IMPORT/EXPORT Element starting at address 1

`sjirdtag`

The sjirdtag program tests the SJIRTAG command on SJI-compliant autochangers. The SJIRTAG command reads media presence and tag data from an autochanger. The following example shows the correct usage for the sjirdtag program:

sjirdtag device-name

The device-name option used with the sjirdtag program represents any device name that can be used to reach an SJI-compliant autochanger driven by the system, typically in the form b.t.l, where b is the logical SCSI bus, t is the SCSI target, and l is the SCSI lun on that target (for example, scsidev@0.4.0).

The following example represents typical output from the SJIRTAG command:

Tag Data for 0.4.0, Element Type DATA TRANSPORT:

Elem[001]: tag_val=0 pres_val=1 med_pres=1 med_side=0

Tag Data for 0.4.0, Element Type STORAGE:

Elem[001]: tag_val=0 pres_val=1 med_pres=1 med_side=0

Elem[002]: tag_val=0 pres_val=1 med_pres=1 med_side=0

Elem[003]: tag_val=0 pres_val=1 med_pres=1 med_side=0

Elem[004]: tag_val=0 pres_val=1 med_pres=1 med_side=0

Elem[005]: tag_val=0 pres_val=1 med_pres=0 med_side=0

Elem[006]: tag_val=0 pres_val=1 med_pres=1 med_side=0

Elem[007]: tag_val=1 pres_val=1 med_pres=1 med_side=0

VolumeTag=<00000098>

Tag Data for 0.4.0, Element Type MEDIA TRANSPORT:

Elem[001]: tag_val=0 pres_val=1 med_pres=0 med_side=0

`sjirelem`

The sjirelem program tests the SJIRELEM command on SJI-compliant autochangers. The SJIRELEM command reads media presence and origin data from an autochanger. The following example shows the correct usage for the sjirelem program:

sjirelem device-name

The device-name option used with the sjirelem program represents any device name that can be used to reach an SJI-compliant autochanger driven by the system, typically in the form b.t.l, where b is the logical SCSI bus, t is the SCSI target, and l is the SCSI lun on that target (for example, scsidev@0.4.0).

The following example represents typical output from the SJIRELEM command:

Element Data for 0.4.0, Element Type DATA TRANSPORT:

Elem[001]: pres_val=1 med_pres=1 med_side=0

Origin: type STORAGE, address 5

Element Data for 0.4.0, Element Type STORAGE:

Elem[001]: pres_val=1 med_pres=1 med_side=0

Elem[002]: pres_val=1 med_pres=1 med_side=0

Elem[003]: pres_val=1 med_pres=1 med_side=0

Elem[004]: pres_val=1 med_pres=1 med_side=0

Elem[005]: pres_val=1 med_pres=0 med_side=0

Elem[006]: pres_val=1 med_pres=1 med_side=0

Elem[007]: pres_val=1 med_pres=1 med_side=0

Element Data for 0.4.0, Element Type MEDIA TRANSPORT:

Elem[001]: pres_val=1 med_pres=0 med_side=0

`sjirjc`

The sjirjc program tests the SJIRJC command on SJI-compliant autochangers. The SJIRJC command reads internal configuration information and options about an autochanger and prints it out. The following example shows the correct usage for the sjirjc program:

sjirjc device-name

The device-name option used with the sjirjc program represents any device name that can be used to reach an SJI-compliant autochanger driven by the system, typically in the form b.t.l, where b is the logical SCSI bus, t is the SCSI target, and l is the SCSI lun on that target (for example, scsidev@0.4.0).

The following example represents typical output from the SJIRJC command:

Device: scsidev@0.4.0

Number of Drives: 1

Number Drive Pairs: 1

Number of Import/Export Elements: 0

Number of Import/Export Pairs: 1

Number of Slots: 7

Number of Slot Pairs: 1

Number of Transport Elements: 1

Number of Transport Pairs: 1

Initialize Element Status Supported

Auto Eject Supported

`tur`

The tur program sends a TEST UNIT READY command to all SCSI devices attached to the system, or, if the optional -a b.t.l argument is specified, then the device at the specified ordinal SCSI address, where b is the logical SCSI bus, t is the SCSI target, and l is the SCSI lun on that target. The following example shows the format to use for the tur program:

tur [-a b.t.l]

Data Management

This section provides a command line reference for Backup commands to use for data management. Many of these commands are also automatically invoked by the Backup server during scheduled backups. The commands for HSM and Archive are only available when you enable the optional modules for these features on the Backup server.

`savegrp`

The savegrp program runs a group of Backup clients through the save process to back up filesystem data. The group of clients is selected by the name assigned (see "NSR group "). Typically, savegrp is invoked automatically, as specified by each group's NSR group resource.

If you do not specify a group name, the Backup group named Default is used. If you specify a group name, clients whose nsr_client resources specify the named group in their Group attribute are included. If you specify an explicit client list with the -c client-name option, the savegrp program only includes the named clients in the backup and ignores other members of the group.

If you enable the Clone attribute for the named group, the savegrp program automatically invokes a clone of the save sets backed up during the save session. The client save sets and their associated file indexes are cloned before the bootstrap save set is generated, which allows the bootstrap to track both the original save sets and their clones. The bootstrap save set is cloned as well. Cloned save sets are sent volumes assigned to the clone pool specified in the NSR group resource.

If a client's Save Set attribute specifies "All," the savegrp program requests a list of the filesystems to perform the save program on (this is called a probe). The probe expands "All" into a list by searching for local and automatically mounted filesystems on the client machine (NFS mount points and manually mounted filesystems are generally not included in the list gathered by the probe).

You cannot run more than one occurrence of the savegrp program on the same group at the same time; the program exits with an error message. If you run different groups at the same time, each group runs save program sessions up to the limit specified in the Parallelism attribute for the nsr_client resource (the default value for Parallelism is 4). However, the Backup server only allows save program sessions up to the limit specified in the server's Parallelism attribute to write to one backup device at a time. Each save set generates a separate save program session, regardless of the client it originates from.

When the save process (and, if enabled, clone process) is complete, a notification with an Event value of "savegrp" and a Priority value of "notice" is sent to the nsr_notification system. This is generally set up to send e-mail to the root user to indicate the success or failure of the backup, the clients backed up during the savegrp execution, and the data saved.

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

savegrp [see "Options"] [-R | -G] [group-name]

Options:

[-EIOmnpv] [-l level | -C schedule]

[- e expiration] [- t date] [-r retries]

[-P printer] [-W width] [-c client [-c client...]]

Use the -c client option to run savegrp on a specific client or clients. When you specify this option, only the named clients from the specified group-name are run.
Use the -C schedule option to specify the name of the nsr_schedule resource to use for the automatic save level selection process.
Use the -e expiration option to specify the date when the saved data is to expire. If you use the special value of "forever" for expiration, the volume the data resides on never expires. This is typically used for migration or archive volumes. By default, no explicit expiration date is assigned.
Use the -E option to estimate the amount of data that is generated by each save set before the save operation is performed. This option results in a double traversal of the filesystems: once to generate an estimate and again to perform the actual save operation. The data itself is only read from the disk on the final pass, because the estimate is performed by accessing the anode information.
Use the -G option to run only the group, without restart semantics.
Use the -I option to disable the save operation performed on each client's file index.
Use the -l level option to specify the level of the save.
Use the -m option to disable monitor status reports, including all the nsr_notification actions.
Use the -n option to cause save to perform an estimate as described for the -E option, but not to perform an actual save after it generates the estimate. The -m option is implied when you use the -n option.
Use the -O option to only save each client's file index. For the server, this results in a save of the bootstrap as well. By default, the Backup server's bootstrap is backed up any time a group that it is a member of runs through a scheduled or manually invoked savegrp execution. The client file indexes and server bootstrap are a vital part of the disaster recovery procedure.
Use the -p option to run the probe on each client. This provides information on the filesystems and level of save to perform on each client, without an actual save of the data. The -m option is implied when you use the -p option.
Use the -P printer option to specify the printer that the savegrp program should send bootstrap information to upon completion of the backup.
Use the -r retries option to specify the number of times the Backup server should retry failed clients before the savegrp program declares the client backup failed. The default value for this option is taken from the NSR group resource. Abandoned saves are not retried, because they may eventually be completed. A retry is not attempted if the -p option is specified.
Use the -R option to use the information stored on the Backup server to restart a group that was previously terminated (generally, this is due to a crash of the Backup server during a backup).
Use the -v option to run the savegrp program in verbose mode.
Use the -W width option to format the savegrp output or notification messages. The default width is 80.

`save`

The save program, which resides on each Backup client, saves files. You can monitor the progress of a save operation using the X Window System-based nwadmin program or the curses (3X)-based nsrwatchAdministration program.

If you do not specify a path argument either on the command line or through the -I option, the current directory that save is invoked from is saved. The save program saves a directory by saving all the files and subdirectories it contains. The save program does not cross mount points, and it does not follow symbolic links. If you mount the paths indicated from a network file server, the save program instructs you to run the save program on the remote machine, or use the -L option.

Each file in the subdirectory structures specified by the path option is encapsulated in a Backup save stream. This stream of data is sent to a receiving process on the Backup server, which processes the data and adds entries to the client file index for each file in the stream. The data is then directed to long-term storage, either on the server or the designated storage node.

Caution -

The server's bootstrap and the client file indexes are only backed up automatically during a scheduled or manual backup that invokes the savegrp program. If you never run the savegrp program, either a scheduled or manually invoked backup, you do not have the server bootstrap or client file indexes that are vital to the disaster recovery process.

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

save [-BEiLnqvx] [-s server] [-c client-name]

[- N name] [-e expiration] [-f directory-file]

[-b pool] [-F file] [-I input-file] [-g group]

[-l level] [-t date] [-m masquerade] [-W width]

[path...]

Use the -b pool option to specify a particular destination pool for the save sets.
Use the -B option to force a save of all connecting directory information, from the root (/)to the point of invocation.
Use the -c client-name option to specify the client name that starts the save session. This is useful for clients with multiple network interfaces and, hence, multiple hostnames. You can use the option to create multiple client file indexes for the same physical client machine. This option does not specify the network interface to use; the network interface is specified in the Network Interface attribute of the nsr_client resource.
Use the -e expiration option to set the date when the save set expires. When a save set has an explicit expiration date, the save set remains both browsable and nonrecyclable until it expires. After the expiration date, the save set is nonbrowsable. If it has expired and also passed its retention time, the save set becomes recyclable. By default, explicit save set expiration dates are not used.
Use the -E option to estimate the amount of data that is generated by each save set before the save operation is actually performed. This option results in a double traversal of the filesystems: once to generate an estimate and again to perform the save operation. The data itself is only read from the disk on the final pass, because the estimate is performed by accessing the inode information.
Use the -f dirfile option to specify the file from which the save program should read the prototype default directives. A dirfile value of - causes the default directives to be read from standard input.
Use the -F file option to save only files whose change time is newer than the file modification date of the specified file.
Use the -g group option to denote the group to save. Use this option to determine the specific pool to which save sets from the specified group should be written.
Use the -i option to instruct the save command to ignore any.nsr directive files encountered in the subdirectory structures saved.
Use the -I input-file option to read the paths to save from the named text file, in addition to the paths listed on the command line. The paths must be listed one per line. If no paths are listed on the command line, only the files contained in the paths listed in input-file are saved.
Use the -l level option to specify the level of the save.
Use the -L option to perform a save from the local Backup client, even when files are from a network fileserver. To recover files, you must run the recover program with the same -c client argument used to save the data.
Use the -LL option to treat the backup as a local save and print an extra line at the end of the completion report in the form complete savetime=number where number is the savetime of the save set created by this backup. This option is meant for use by the savegrp command for automatic cloning.
Use the -m masquerade option to specify the tag to precede the summary line in the savegroup completion report.
Use the -n option to estimate the amount of data that will be saved, without performing a save operation.
Use the -N option to specify the symbolic name of the save set. By default, the most common prefix of the path argument is used as the save set name.
Use the -q option to run the save program in quiet mode. This option generates only summary information and error messages.
Use the -t date option, in nsr_getdate(3) format,to specify the date after which files must have been modified to qualify for a save.
Use the -v option to run the save program in verbose mode.
Use the -W width option to format summary information output.
Use the -x option to cross mount points during the save operation.

`savefs`

The savefs program is used by the savegrp program to probe a client for its filesystems and recent save times. Running savefs directly to perform a save is not recommended. However, you can safely invoke savefs manually with the -p option to probe the client and produce a preview report of the save sets (and levels) that a savegrp will back up. When probing, savefs does not actually save data, but instead produces a machine-parsable report that describes the layout of the client's filesystems. The -p option provides command line access to the same information you obtain with the Group Control>Preview feature available in the GUI version of the Administration program.

If a filesystem argument is not provided with the savefs command line, the filesystems listed in the Save Set attribute are probed. If the save set list consists of the keyword "All," then the filesystem tables (/etc/vfstab on Solaris)are examined to determine which filesystems to save. Only local, mounted filesystems are considered by the probe.

Metadevices within the Sun Solaris: Online DiskSuite are treated similar to independent disks. This approach allows each to be saved in its own session, assuming sufficient parallelism.

Care should be taken when the Clients resource explicitly lists the save sets, for two primary reasons. First, this list must be manually updated when new filesystems that need saving are added. Second, since savefs only stops at the end of a path or a mount point, if you list two save sets in the same filesystem and one is a subdirectory of the other, the subdirectory is saved twice.

You can specify filesystem arguments to limit the filesystem saves to only those specified, but the specified filesystems must appear on a Save Set list for this client (see the -F option).

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

savefs -p [options] [filesystem...]

[-M filesystem...]

The following lists the valid values for options:

[-BEFnpqRv] [-s server] [-N name] [-g group]

[-l level | -C schedule] [-e expiration]

[-f filename] [-W width] [-t date] [-T seconds]

Use the -B option to force a save of all connecting directory information from root (/)down to the point of invocation. This option is used by savegrp, for example, when saving the server's bootstrap information.
Use the -C schedule option to specify the name of the schedule to use when automatically determining the save level. If this option is not specified, savefs uses the schedule named by the Clients resource for the specified filesystem.
Use the -e expiration option to specify the expiration date for the saved data (in nsr_getdate format). By default, no explicit expiration date is used.
Use the -E option to walk the filesystems specified and estimate the amount of data that the save will generate. Without this flag, the estimated size is zero. Note that this flag consumes an amount of time proportional to the number of files in each filesystem. This is because the entire directory is walked before any saving begins and walked again when actually saving the directory. The file data is only read from the disk the last time. In many cases, the overhead for using this flag is small and is well justified.
Use the -f filename flag to specify the file from which application-specific modules (ASMs) should take their directives. By default, these are taken from the Directives resource named by the Directive attribute in the Clients resource for each client.
Use the -F option to save every argument like a filesystem, even if the arguments are not listed in the filesystem tables or the Clients resource.
Use the -M option, as part of a probe, to signify that all subsequent filesystems should be probed for their ability to be migrated. This option is quietly ignored on systems that do not support file migration.
Use the -g group option to restrict the scope of the client to a particular group. If this option is not specified, save sets from all instances of the Clients resource for this client are used, regardless of the group. This value is also passed on to save, which uses it to select a specific media pool.
Use the -l level option to specify the level of save to perform. There are 12 levels: full, levels 1 though 9, incr, and skip. Full specifies that all files are to be saved. Incr specifies incremental saves in which only those files modified since the most recent save, at any level, are saved. Skip causes no files to be saved. Levels 1 through 9 save all files modified since any lower level save was performed. For example, if you did a Full on Monday, followed by a level 3 save on Tuesday, a subsequent level 3 save on Wednesday contains all files modified or added since the Monday Full save. If you do not specify a level, the save level is determined automatically from the Backup client's schedule. Using the history of previous saves maintained by nsrmmd on the Backup server, savefs accurately computes the time for the given level. When tapes are deleted, savefs uses media information on the server to automatically adjust the time computed for saves based on previous save levels.
Use the -n option to have savefs accurately estimate the amount of data generated, as described for -E, but not actually save any data.
Use the -N name option to assign the symbolic name for the save sets. By default, the first filesystem argument is used as the name.
Use the -p option to list the name of the filesystems, the level of save that would be performed, and the file modification time of files to be saved, but not actually perform the save. This information is gleaned from an operating system-specific file and the Schedules resource.
Use the -q option to run savefs in quite mode. Only summary information and error messages are displayed.
Use the -qq option to run savefs in really quiet mode, and display only error messages.
Use the -R option to cause savefs to echo a simple succeeded or failed message as it is completed. This option is automatically used by the savegrp program when it runs savefs.
Use the -s server option to specify the Backup server for savefs to use.
Use the -t date option to specify the date (in nsr_getdate format)for savefs to use as a base for calculating the level. If this option is not specified, the current time is used.
Use the -T seconds option to specify the inactivity timeout, in seconds, for savefs. If savefs detects that the local server has not made progress in the specified time, it concludes that the save program is not responding. A message is printed to stderr and savefs exits normally. This option should only be used on Backup server machines.
Use the -v option to run savefs in verbose mode. This option results in a lot of debug-style output. This option is automatically used by the savegrp program when it probes for the ability of the client's savefs to support multiple versions.
Use the -W width option to specify the width used for formatting output or notification messages. The default value for width is 80.

`savepnpc`

The savepnpc program, like the save program, saves files to long-term storage. Before performing a save operation, savepnpc performs any pre-processing commands that exist in the /nsr/res/group_name.res file. If the pre-processing command fails, savepnpc exits with an error code and save is not performed. At the end of a successful save of the last save set on the client, savepnpc performs any post-processing commands that exist in the /nsr/res/group_name.res file. An optional timeout condition may be set to indicate at which point in the post-processing commands must be run without waiting for the last save set to back up. The Timeout attribute is set in the same /nsr/res/group_name.res file as the pre- and post-processing commands. All of the results from the savepnpc program are logged in the /nsr/res/savepnpc.log file.

The /nsr/res/group_name.res file is automatically created the first time you run a backup group with a client that has the savepnpc command entered in the Backup Command attribute of the Clients resource. The format looks similar to the following:

type: savepnpc;
precmd: /bin/true;
pstcmd: /bin/true, "/bin/sleep 5";
timeout: "12:00pm";

You can edit the Precmd field to contain any number of commands, separated by commas, to run prior to the start of the save operation on the client's first save set. You can also edit the Postcmd field to contain any number of commands, separated by commas, to run at the end of the save operation on the client's last save set or the timeout condition indicated in the Timeout field, whichever comes first. All fields in the file must terminate with a semicolon (;).

The command syntax for savepnpc is identical to the syntax described for "save ". If you create a customized script to enter in the client's Backup Command attribute, the following rules apply:

The savepnpc command must be part of the script.
The filename of the script must begin with save or nsr, and cannot exceed 64 characters in length.
The script must reside in the same directory as the save program (typically, /usr/bin).

`recover`

The recover program searches (browses) the client file index for a specified client and recovers files from backup volumes to the specified client. The client file index entries are created when the files are backed up with the save command. When you use the interactive version of the recover program, nwrecover, the client file index is presented in a graphical display format that is similar to a UNIX filesystem.

In the automatic mode (-a option) or save set recover mode (-S option), the files specified on the command line are recovered immediately without browsing the client file index. Use of the save set recover mode (-S option) is restricted to users in the operator group. If you run the recover program without the -S option, and users in the operator group can recover any file.

You can specify one or more path arguments to limit the directories and files to just those you want to recover. If you specify the path argument, the beginning of each path name as it exists in the save set must exactly match one of the paths before it can be recovered. Filename matching using meta characters (for example, *, ?, or [...]) is not allowed. You can use a path that ends with a slash character to force a match to a specific directory.

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

recover [-f] [-n] [-q] [-i {nNyYrR}]

[-d destination] [-c client] [-t date]

[-s server] [dir]
recover [-f] [-n] [-q] [-i {nNyYrR}]

[-d destination] [-c client] [-t date]

[-s server] -a path
recover [-f] [-n] [-q] [-i {nNyYrR}]

[-d destination] [-t date] -s server

-S ssid[/cloneid] [-S ssid[/cloneid]] [path]

Use the -a option to cause the recover program to automatically recover files without browsing the client file index.
Use the -c client to specify the name of the machine from which the save sets were originally saved. When you browse a directory that was saved by a different client, the pathnames displayed reflect the filesystem of the client that saved the files. By default, the save and recover programs determine the client machine name from the filesystem table. If you specified the -L option with the save program, the -c client option may not be necessary (see "save " for information about the options available for the save program). You cannot use the -c client option in conjunction with the -S ssid[/cloneid] option.
Use the -d destination option to specify the destination directory where you relocate the recovered file. Relative paths are interpreted in relation to the current working directory.
Use the -f option to force recovered files to overwrite any existing files whenever a filename conflict occurs. This option is the equivalent of specifying the combined -iY option.
Use the -i option with one of the following choices to specify the initial default overwrite response to use when a file name conflict occurs: nNyYrR. You can only specify one letter choice in conjunction with the -i option. The -i option produces the same results as the uasm -i option when you run uasm in recover mode.
Use the -n option to use the recover program without creating any directories or files.
Use the -q option to turn off the default verbose mode for the recover program.
Use the -s server option to specify the Backup server from which you want to recover data. This option is required when you use the save set recover mode (-S). If you omit the -s server option, the default is the server of the first directory marked for recovery, if the server is a network file server as well as a Backup server. If the server is not a network file server or a Backup server, the current server or a machine with a logical name of nsrhost entered in the host table is considered.
Use the -S ssid[/cloneid] option to use the recover program in save set recover mode. Use this mode to implement batch file recovery without the need for client file indexes. The value of ssid specifies the save set IDs for the save sets you want to recover. When multiple clone instances exist for a save set, you can specify a clone ID to select the particular clone instance you want to recover. If you do not specify the path argument, the entire contents of the save set are recovered.
Use the -t date option to display or recover files as of the specified date. You cannot use this option in conjunction with the -S ssid option.

Refer to the recover(1m) man page for more information on how to use the recover program in interactive mode, as well as to view a listing of the more common error messages encountered.

`nsrmig`

The nsrmig program migrates files to the volumes labeled for a Migration pool type. The migrated files are replaced with a stub (a symbolic link) that points to a copy of the file made during premigration with the nsrpmig program. If you access the stub later, the file is automatically recalled to disk from the migration volume by the Backup server or storage node.

The criteria for migration is defined in the Migration resource on the Backup server. Migration is usually an automatic process controlled by the Backup server. The criteria most often employed is last access time. Only regular files are premigrated and, ultimately, migrated.

If you do not specify a path argument, the current directory is migrated. The nsrmig program does not cross mount points, and it does not follow symbolic links.

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

nsrmig [-nvx] [-l percent] -s server] [-t savetime] [-W width] [path]

Use the -l percent option to specify a goal percentage for the nsrmig program to use. Migration stops when the goal percentage is reached. If the goal percentage is already reached before you invoke nsrmig, the program exits without performing any further migration. If you do not specify the -l option, the goal percentage is read from the appropriate migration client resource.
Use the -n option to estimate the number of files and total size that are freed by replacing the files that qualify for migration with a stub, but do not replace the files with stubs.
Use the -s server option to specify the machine to use as the Backup server. If you omit this option, the default machine considered is either the current machine (if it is a Backup server) or a machine with the logical name of nsrhost entered in the host table.
Use the -t savetime option to migrate files that were premigrated at the specified savetime.
Use the -v option to cause the save program invoked by nsrpmig to provide detailed information as it proceeds.
Use the -W width option to specify the width that nsrmig should use to format summary information to standard output. The default width used is 80.
Use the -x option to instruct nsrmig to cross mount points.

Refer to the nsrmig(1m) man page for further details and common error messages encountered.

`nsrpmig`

The nsrpmig program premigrates files that are identified as candidates for migration, as defined in the Backup server's Migration resource. The premigration process invokes the save program to immediately make a copy of the specified file to a backup volume labeled for migration data. When the file is later migrated, the resident file is replaced with a marker that refers to the premigrated copy on volume. You can only premigrate regular files.

The nsrpmig program does not cross mount points or follow symbolic links. If you mount the path to be saved from a network file server, the nsrpmig program issues a message that instructs the user to run the save program on the remote machine or use the -L option with nsrpmig.

The nsrpmig program examines the directive files (.nsrhsm) encountered in each directory to determine any special instructions to apply when saving files (for example, compression and skip directives). The directive files ordinarily used by Backup for save and recover operations (.nsr) are ignored by the nsrpmig program.

The nsrpmig program is only available for use when an enabler code for the Backup HSM is present on the Backup server.

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

nsrpmig [-BEiLnpqvx] [-s server] [-N name]

[- f dirfile] [-b pool] [-g group]

[-m masquerade] [-W width] [-C clone-pool]

[-I input-file] path

Use the -b pool option to specify the volume pool to which the premigrated data should be saved. Migrated data must reside on separate volumes from either backed-up data or archived data. If you do not specify a pool, the Migration pool is selected by default.
Use the -B option to force a save of all connecting directory information, from the root (/) to the point of invocation.
Use the -C clone-pool option to generate a clone of the premigrated save set to the specified clone pool. Clones of migrated data must reside on separate volumes from either backed-up or archived clone data. If you do not specify a clone pool, the Migration Clone pool is selected by default.
Use the -E option to instruct nsrpmig to estimate the amount of data that the save program generates, then perform the save operation. The estimate is generated from the inode information, so the data is only read once.
Use the -f dirfile option to specify a file that nsrpmig should read prototype default directives from [refer to the nsr(5) man page for more information on the default directives]. A value of - for dirfile causes the default directives to be read from standard input.
Use -g group option to denote the group name to which the save set should belong. The Backup server uses this option to select a specific media pool.
Use the -i option to instruct nsrpmig to ignore any .nsrhsm directive files encountered during the premigration process.
Use the -I input-file option to instruct nsrpmig to read the paths to save from the file specified as input-file in addition to those listed on the nsrpmig command line. List each path on a separate line in the file specified by input-file. If you do not also specify paths on the command line, only the paths specified in input-file are saved.
Use the -L option to instruct nsrpmig to perform a local save from the Backup client, even if the files originate from a network fileserver. To recover files that have been locally premigrated, run the recover program with the -c client option, where the value for client is the machine name of the Backup client that performed the save operation.
Use the -LL option to instruct nsrpmig to perform a local save and print an extra line at the end of the completion in the format complete savetime=number where number is the save time of the save set created. The savegrp program uses this option when you specify automatic cloning.
Use the -m masquerade option to specify a tag to precede the savegroup summary notification line. The savegrp and savefs programs use this option to aid in savegroup summary notifications.
Use the -n option to estimate the amount of data that is generated by the save without performing the save. This option is similar to the -E option, except that data is not saved to a volume after the estimate is completed.
Use the -N name option to instruct nsrpmig to use the symbolic name of the save set. By default, the path argument is used as the save set name.
Use the -p option to cause the save program invoked by nsrpmig to exit with a status value of 0. The server uses this option to determine whether a client is installed properly.
Use the -q option to cause the save program invoked by nsrpmig to display only summary information and error messages.
Use the -s server option to specify the machine to use as the Backup server. If you omit this option, the default machine considered is either the current machine (if it is a Backup server) or a machine with the logical name of nsrhost entered in the host table.
Use the -v option to cause the save program invoked by nsrpmig to provide detailed information as it proceeds.
Use the -W width option to specify the width that nsrpmig should use to format summary information to standard output. The default width used is 80.
Use the -x option to instruct nsrpmig to cross mount points.

See "save " and "savegrp " for more information on the save and savegrp program options described in this section. Refer to the nsrpmig(1m) man page for further details and common error messages encountered.

`nsrhsmck`

The nsrhsmck program checks and corrects the consistency between the file stubs and the client file index entries for files migrated by HSM. The nsrhsmck program handles four situations:

The first situation occurs when you rename the stub for a migrated file. In this situation, the stub with the original filename no longer exists. The nsrhsmck program corrects this situation by updating the client file index entry to reflect the new name given to the stub.
The second situation occurs when you create a symbolic link that points to the same name in the Backup Instruction Buffer (IB) namespace as another symbolic link. The nsrhsmck program corrects this situation by replacing the duplicate with a symbolic link that points to the original symbolic link, rather than pointing directly to the Backup IB namespace.
The third situation occurs when you delete the stub that points to a migrated file. This is known as the possible delete case. The term "possible" implies that the stub may reappear later, for example, if the stub is recovered using Backup. The nsrhsmck program corrects this situation by marking the index entry for the migrated file as a possible deletion after 60 days. Note that if a file marked as possibly deleted is detected on disk before the index entry is later deleted, the index entry is unmarked as a possible deletion.
The fourth situation handled by nsrhsmck occurs when an index entry that is marked as a possible deletion that has passed the 60 day expiration time. The nsrhsmck program corrects this situation by removing the expired entries from the HSM file index. Before it deletes an entry from the HSM file index, nsrhsmck makes a final check to make sure the file does not exist on disk.

You must specify a path on the command-line when you run nsrhsmck. Only files and index entries that fall under the path specified are examined for consistency.

The following example describes the options available for the nsrhsmck program:
Use the -c option to instruct the nsrhsmck program to walk the HSM file index and delete entries marked as possibly deleted that have passed the 60-day expiration period.
Use the -d option to instruct the nsrhsmck program to walk the HSM file index and mark any possible deletions that are detected.
Use the -f option to instruct the nsrhsmck program to walk the filesystem on disk and search for duplicated links and renamed stubs.
Use the -M option to tell the nsrhsmck program that it is being run in master mode by nsrexecd or another Backup daemon, and, therefore, to log messages with timestamps as well as perform other behavior expected by nsrexecd. This option is not advised for manual operation; it is used by the Backup server when nsrhsmck is automatically invoked.
Use the -n option to instruct the nsrhsmck program to report on any inconsistencies found, without correcting them.
Use the -s server option to specify the machine to use as the Backup server. If you omit this option, the default machine considered is either the current machine (if it is a Backup server) or a machine with the logical name of nsrhost entered in the host table.
Use the -v option to run nsrhsmck in verbose mode. You can specify this flag up to three times on the command-line to achieve the highest level of verbosity. Note that the verbose mode can produce an extremely large quantity of output and is not recommended for use in most situations.

`nsrarchive`

The nsrarchive program archives files, including directories or entire filesystems, to the Backup server. You can use the nwadmin or nsrwatch programs to monitor the progress of an archive operation. Only users on the Administrator and Archive Users lists have the required privileges to run the nsrarchive program. Additionally, you can allow or disallow public archives through an option in the NSR (or Server) resource, which enables other clients to recover data archived from a particular client machine.

If you do not specify a path argument, the current directory is archived. The nsrarchive program archives all the files and subdirectories contained in a directory, but does not cross mount points or follow symbolic links. If the paths to be archived are mounted from a network fileserver, the nsrarchive program returns a message that instructs you to run the nsrarchive program on the remote machine or use the -L option.

The .nsr directive files encountered in each directory are read by default. The directive files contain instructions on how specific files should be archived (for example, compression).

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

nsrarchive [-BiLnpqvxVy] [-b pool] [-C clone-pool]

[-f filename] [-G remove] [-N name] [-R name]

[-s server] [-T annotation] [-W width] [path...]

Use the -b pool option to specify a destination pool for the archive save sets. This option overrides the automatic pool selection typically used by the server. Archive data must be directed to volumes specifically labeled for a pool type of Archive. If you do not specify a pool, the Archive pool is selected by default.
Use the -B option to force an archive of all the connecting directory information, from root (/) to the point of invocation.
Use the -C clone-pool option to automatically generate a clone of the archived save sets to the specified clone pool. Cloned archive data must be directed to volumes specifically labeled for a pool type of Archive Clone. If you do not specify a clone pool, the Archive Clone pool is selected by default.
Use the -E option to estimate the amount of data that the archive generates, followed by the archive. Note that the estimate is generated from the inode information; therefore, the data is only read once.
Use the -f filename option to specify a file from which nsrarchive should read the default directives to apply to the archive data (refer to the nsr(5) man page for further information on directives). A value of - for filename causes the default directives to be read from standard input.
Use the -G remove option to groom (remove) files after they are successfully archived. If you specify cloning or verification options as well, the groom operation is not performed until those operations are completed successfully. Unless you also specify the -y option, you are prompted for removal of top-level directories. The nsrarchive program creates a temporary file that contains a list of all the files and directories to be groomed. The temporary file is placed in the directory specified by the TMPDIR environment variable, or in the /tmp directory if the environment variable is not defined.
Use the -i option to instruct the nsrarchive program to ignore any directive files encountered in the subdirectories that are archived.
Use the -L option to perform a local archive from the Backup client, even when the files are from a network file server.
Use the -n option to estimate the amount of data that is generated by the archive without performing the actual archive. This option is similar to the -E option, except that data is not saved to a volume after the estimate is completed.
Use the -N name option to instruct nsrarchive to use the symbolic name of the archive save set. By default, the first path argument is used as the value for name.
Use the -p option to instruct nsrarchive to exit with a status of 0. This Backup server uses this option to determine whether the client is properly installed.
Use the -q option to cause nsrarchive to run in quiet mode and display only summary information and error messages.
The -R name option should only be used by the nsralist program, which handles the execution of the archive requests. Updates to the named archive request resource occur when the Backup server specifies this option.
Use the -s server option to specify the machine to use as the Backup server. If you omit this option, the default machine considered is either the current machine (if it is a Backup server) or a machine with the logical name of nsrhost entered in the host table.
Use the -T annotation option to assign an arbitrary text string of 1024 characters or fewer to the archive save set. The string specified as annotation is used by the nsrretrieve program to browse the media database for archive save set entries to retrieve back to local disk. The annotation is a mandatory requirement for all archive save sets; if you omit this option, you are prompted for it before the process continues.
Use the -v option to cause nsrarchive to run in verbose mode.
Use the -V option to verify each archive save set.
Use the -W width option to specify the width that nsrarchive should use to format summary information to standard output. The default width used is 80.
Use the -x option to instruct nsrarchive to cross mount points.
Use the -y option to automatically enter an affirmative response to any queries generated by the nsrarchive program.

`nsrretrieve`

The nsrretrieve program is used to restore archived save sets from the archive volumes managed by the Backup server or storage node. You do not browse client file index entries for archived save sets as you do for regular save sets; you search for a specific annotation string to identify the archive save set you want to retrieve.

The use of nsrretrieve is restricted to users on the Backup server's Administrators and Archive Users list. If the nsrretrieve program is not run by root or a user defined in the operator group, or the Public Archives attribute of the Server resource is not enabled, only the owner of the archived files can retrieve them.

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

nsrretrieve [-f] [-n] [-q] [-i {nNyYrR}] [-d destination] -s server [-
S ssid[/cloneid]]... [-A annotation]...

[path]...

Use the -A annotation option to specify the archive save set to retrieve. An annotation is a regular expression that uniquely identifies a single archive save set. The regular expression is of the form used by the grep(1) command.
Use the -d destination option to specify the destination directory where you want to relocate the retrieved files.
Use the -f option to force retrieved files to overwrite any existing files whenever a filename conflict occurs. This option is the equivalent of specifying the combined -iY option.
Use the -i option with one of the following choices to specify the initial default overwrite response to use when a filename conflict occurs: nNyYrR. You can only specify one letter choice in conjunction with the -i option. The -i option produces the same results as the uasm -i option when you run uasm in recover mode. Refer to the usam(1m) man page for a detailed explanation of how to use the uasm -i option.
Use the -n option to use the nsrretrieve program without actually creating any directories or files.
Use the -q option to cause nsrretrieve to run in quiet mode and display only summary information and error messages.
Use the -s server option to specify the machine to use as the Backup server. If you omit this option, the default machine considered is either the current machine (if it is a Backup server) or a machine with the logical name of nsrhost entered in the host table.
Use the -S ssid[/cloneid] option to specify the ssid for the save set to retrieve. If multiple clone instances exist for an archive save set, you can also specify the clone ID, to select the clone instance that you want to retrieve the data from. If you do not specify a path argument, the entire contents of the archive save set are retrieved. To restrict the retrieval to particular directories or files that match a given path prefix, specify the exact pathname.

`nsrclone`

The nsrclone program makes new copies of existing save sets. The operation is automatic when you enable the Clones attribute of a NSR group resource. You can also run nsrclone on a manual basis from the command line.

Although the command line options enable you to specify a volume name or identifier, nsrclone always copies complete save sets, regardless of how many volumes the save set components reside on. The nsrclone program does not copy volumes; instead, it copies the original save sets specified from one volume to a volume assigned to a special pool for clones. If the first destination volume cannot hold all the save sets to be cloned, another volume from the same clone pool is chosen.

If you use the -c and -N options together, nsrclone creates a super-full copy for the given client save set. The super-full copy is a feature that is supported only under HSM. It automatically creates a clone of the most recent complete full backup of the named client and save set, along with any HSM migration save sets referred to by the full backup. Super-full copies should be cloned to a volume from a migration clone pool. If no migration save sets are referenced by the most recent full backup, only the full set is cloned.

The nsrclone program, in cooperation with the nsrmmd daemon, guarantees that each save set has only one clone on a given volume. When you specify a volume name or identifier, the copy of the save sets on that volume are used as the source. When you specify save sets explicitly, those with existing multiple copies are automatically chosen; copies of save sets that exist on volumes in an autochanger or silo are chosen over those that require operator intervention. You can also specify which copy of a save set to use as the source, with the -S option.

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

nsrclone [-v] [-s server] [-b pool]

{-f file | volume-name}
nsrclone [-v] [-s server] [-b pool] -S

{-f file | ssid}
nsrclone [-v] [-s server] [-b pool] -V

{-f file | volumeid}
nsrclone [-v] [-s server] [-b pool]

-c client -N saveset

Use the -b pool option to specify the name of the clone pool to which the data should be migrated. If you omit this option, the cloned save sets are automatically sent to the Default Clone pool.
Use the -c client option, in conjunction with the -N option, to specify a client whose save sets should be considered for a super-full copy.
Use the -f file option to instruct nsrclone to read the volume names, volume identifiers, or ssids from the text file specified.
Use the -s server option to specify a Backup server to migrate save sets from. If you omit this option, the current machine is selected by default.
Use the -S option to specify one or more specific ssids. You can issue the mminfo -v command to determine the value to use for ssid (see "mminfo " for details).
Use the -v option to run nsrclone in verbose mode. This mode provides additional information during the process, for example, messages about save sets that cross volumes.
Use the -V volid option to specify the name of the volume.

Refer to the nsrclone(1m) man page for examples and error messages for the nsrclone program.

`nsrstage`

The nsrstage program is used on a manual basis to migrate existing save sets from one volume to another. The process begins with a clone of the specific save sets to the new volume specified, followed by deletion of the save set entries from the media database, and finally a removal of the save sets from the original source volume, if possible. The media database entries and save sets are not removed if the clone to the new volume does not succeed.

You can migrate save sets onto volumes that belong to any of the media types supported by Backup (for example, save sets on a file volume may be migrated to an optical disk). However, all volumes used as the destination of a nsrstage operation must belong to a Clone pool type. Refer to the nsr_pool(1m) man page for a description of the various pool types.

The nsrstage program does not perform simple volume migration; it migrates complete save sets. You can specify the copy (clone) of a save set to use as the migration source with the -S ssid option.

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

nsrstage [-v] [-s server] [-b pool] -m

[-S {ssid/cloneid}]
nsrstage [-v] [-s server] -C -V volume

Use the -b pool option to specify the name of the clone pool to which the data should be migrated. If you omit this option, the cloned save sets are automatically sent to the Default Clone pool.
Use the -C option to instruct nsrstage to perform a volume cleaning operation after the save sets have been migrated and their associated entries removed from the media database. You can only use this option with entries that are migrated from a file volume.
Use the -m option to perform the actual migration.
Use the -s server option to specify a Backup server to migrate save sets from. If you omit this option, the current machine is selected by default.
Use the -S ssid (or ssid/cloneid) option to specify one or more specific ssids and clone IDs that you want to migrate. The ssid option is useful when you want to migrate individual save sets from a volume. The cloneid option is useful when you want to specify a particular copy of a save set for migration. The value of either identifier is an unsigned integer; when you specify both you must separate them with a slash (/)character. You can issue the mminfo -v command to determine the value to use for ssid or cloneid (see "mminfo " for details).
Use the -v option to run nsrstage in verbose mode. This mode provides additional information during the process, for example, messages about save sets that cross volumes.
Use the -V volume option to specify the name of the volume that nsrstage should clean. You cannot use this option in conjunction with the -S or -m options.

Refer to the nsrstage(1m) man page for examples and error messages for the nsrstage program.

`scanner`

The scanner program directly reads Backup media (such as backup tapes, optical disks, or files) to confirm the contents of a volume, to extract a save set from a volume, or to rebuild the Backup online indexes. You can only run this command as root. You must specify a device, which is usually one of the device names used by the Backup server. If the device is a tape drive, it must be a nonrewinding type.

If you invoke the scanner program without options (or only the -v option), the volume on the specified device is scanned and a table of contents is generated. The table of contents contains information about each save set found on the volume. By default, one line of information is written to standard output for each save set found on the volume. The information provides the client name, save set name, save time, level, size, files, ssid, and flag.

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

scanner [-Bimnpqv] [-s server] [-S ssid]

[-c client] [-N name] [-f file] [-r record]

[-t type] [-b pool] device [-x command argument-list]

Use the -b pool option to specify the pool to which the volume should belong. This option only applies to volumes backed up by versions of Backup that did not store pool information on the media.
Use the -B option, without the -S option, to quickly scan the tape to the location of the start of the bootstrap save sets. When the entire tape has been scanned, the ssid and tape file location of the most recent bootstrap save set is printed to standard output.
Use the -c client option to instruct scanner to only process save sets that came from the machine specified by client. You can specify more than one client name in the same command line. You can also use the -c option in conjunction with the -N option, but only if you also specify the -i or -x option.
Use the -f file option to start the scan at a specific media file number. See "mminfo " for information on how to determine the media file number.
Use the -i option to instruct scanner to rebuild both the client file indexes and media database from the volumes that are read. If you specify a single save set with the -S ssid option, only the entries from the specified save set are made to the client file index.
Use the -m option to instruct scanner to rebuild only the media database for the volumes that are read.
Use the -n option to run scanner without rebuilding the client file indexes or media database. This option provides a way to check the media without modifying the client file indexes or media database.
Use the -N name option to process only save sets that match the specified name. The value of name should be a literal string. You can specify multiple names when you use this option in conjunction with the -c client option, but only if you also specify the -i or -x option.
Use the -p option to print out information about each save set as it is processed.
Use the -q option to display only error messages or messages of significance.
Use the -r record option to start the scan at a specific media record number, to avoid a scan of potentially unused information. See "mminfo " for information on how to determine the media record number.
Use the -s server option when you run the scanner program on a storage node, to specify the controlling Backup server.
Use the -S ssid option to extract the save set specified by ssid. When you use this option in conjunction with the -i or -x options, you can specify multiple ssid values. The save sets selected are in addition to any selected by the use of the -c and -N options. If you also specify the -B option, the value of ssid is assumed to be that of the bootstrap save set; only one ssid can be specified in this case.
Use the -x command option, with an optional list of command arguments, to specify a UNIX command to execute on each save set scanned. This option can only be specified once per scanner command line, after the device specification.

Refer to the scanner(1m) man page for examples of scanner command usage and a list of common error messages.

File Index and Media Database Management

The Backup client file indexes contain entries that enable users to browse and recover any files backed up by Backup that have not exceeded their assigned browse policy. The Backup media database managed by the server contains information about where the backed-up data resides. You can query the Backup client file indexes as well as the server's media database to obtain information.

`mminfo`

The mminfo program reports information about Backup media and save sets. The default mminfo report displays information about the save sets that completed properly during the last twenty four hours. This report includes; the volume name, client name, creation date, amount of data saved to the volume, level of backup performed and the name of the save set.

See "Examples of mminfo Report Commands" for a list of examples of how to use the mminfo command.

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

mminfo [-avV] [-o order] [-s server] [report] [query] [volname...]
<report>: [-m | -B | -S | -X | -r reportspecification]
<query>: [-c client] [-N name] [-t time] [-q query specification]

Use the -a option to apply the query to all complete, browsable save sets, not just those in the last 24 hours. This option is implied by the -c, -N, -q, -m, and -o options. When combined with a media-only report (-m or a custom report showing only media information), the -a option applies to all volumes, not just those with complete and browsable save sets.
Use the -B option to produce a list of the bootstraps generated in the previous five weeks. The bootstrap report format is used, with one line of output printed for each matched save set. Each line shows the save date and time, save level, ssid, starting file number, starting record number, and volume.
Use the -c client option to restrict the report information to the media and save sets that pertain to the specified client.
Use the -m option to display a media-only report. This report displays information about each volume contained within the specified Backup server's media database.

Use the -v option concurrently with the -m option to display; the internal volume identifier (volid), the number of the next file to be written and the media type.

Use the -V option concurrently with the -m option to display volume characteristics where:
- The d flag, indicates that the volume is currently being written to.
- The r flag, indicates that the volume is marked as read-only.
Use the -N saveset-name option to restrict the reported information to the media and save sets pertaining to the specified save set name.
Use the -o order option to sort the output in a specified order. order may be any combination of the letters celmontR, where:
- c, client
- e, expiration date of the volume
- l, length or percentage of space used on the volume
- m, media
- n, saveset name
- o, filename and record number
- R, reverse
- t, the last time the media was accessed
  
  The default sorting order for a saveset report is mocntl.
Use the -q queryspecification option to add the given query constraint to the list of constraints on the current query. Multiple -q options may be specified, and combined with the shorthand query constraints -c, -N and -t. The syntax of the queryspecification is:
[!] name [comp value] [ , ... ]

name, is the name of a database attribute, such as "name="hot"name="hot"" Save Set" comp, is a valid comparator for the attribute, from the set ">", ">=","=" value, is the value being compared.

The comparator and value must be specified for all attributes, except flags. If a string contains commas, quote the value using single or double quotes. The following is a valid string comparison:

name="Daily, ""hot"" Save Set"

Except for multiple character string values, all of the specified constraints must match a given save set and/or media volume. Numeric constraints can be specified by a, and all character string constraints can be specified by multiple possible values. For example:

%used>20,%used<80
client=mars,client=saturn

Refer to the CUSTOM QUERIES AND REPORTS section in the mminfo(1m) man page for further information on the syntax to use for the query specification.

Use the -r reportspecification option to specify how a report is displayed. Specify the media and save set attributes to be displayed, order of the columns, column widths, and line breaks. The syntax of a reportspecification is:

name [(width)] [, name [(width)]...]

name, is the name of a database attribute

width, specifies how wide the column should be
Use the -s server option to display volume and save set information from the specified Backup server. The default value for server is the current system.
Use the -t time option to restrict the reported information to the media and/or save sets pertaining to the save sets created on or after time. Refer to the nsr_getdate(3) man page for a description of the recognized time formats. The default value for time is "yesterday."
Use the -v option to enable verbose display reports that include:
- aborted completed purged and incomplete save sets
- creation time
- internal save set identifier (ssid),
- An indicator of which portion of a save set resides on a volume.
  
  c, the entire saveset is contained on this volume.
  
  h, the head of the saveset is contained on this volume.
  
  m, a middle section of the saveset is contained on this volume.
  
  t, a tail section of a spanning save set is contained on this volume.
- status of a save set, as indicated by:
  
  b, the save set is browsable with the recover command.
  
  r, the save set is recoverable with the scanner command.
  
  E, the save set has been marked eligible for recycling and may be over-written at any time.
  
  S, the save set was scanned, or rolled in. Rolled in save sets are not subject to the standard index management procedures and will remain in the file index until the user manually purges the save set.
  
  a, the save was aborted before completion. Aborted save sets are removed from the on-line file index by nsrck.
  
  i, the save is still in progress.
Use the -S option to display a long, multi-line save set report for debugging. Each attribute of a save set is displayed in one of the following formats:
name=value client:name

The first line of each multi-line group starts on the left margin and includes the save set identifier (ssid), save time, client and save set names. Subsequent lines for this save set are indented. The next line displays the level, the save set flags, the save set size, the number of files within the save set, and the save set expiration date. Extended attributes, clones and instances of the save set are displayed on the lines that follow.

Use the -V option to display a more verbose report than that obtained through the use of the -v option.

The first line includes:
- the size of each portion of a save set contained on this volume.
- the creation date and time
  
  The second line contains the following information:
- the save time in seconds since 00:00:00 GMT, Jan 1, 1970
- the internal save set identifier (ssid)
- the offset of the first and last bytes of the save set contained within section
- the media file number
- the first record within the media file containing data for this save set
- the internal volume identifier (volid)
- the total size of the save set
- the flag, indicating which part of the save set is contained in this media file (c, h, m, or t)
- save set's status (b, r, a, or i).
Use the -X option to prepare a save set summary report. This summary report breaks the save sets down into several overlapping categories:
- the number of each level backup by type, performed on a save set.
- the number of archived, migrated, empty and purged save sets.
- the number of index save sets.
- the number of incomplete save sets.
  
  For recent usage, weekly and monthly summaries displayed, including the following information:
- the number of files saved in the time interval specified
- the number of save sets
- the total size, and average size per save set
- the average size per file
- the percentage of the amount saved for incrementals v.s. fulls

Examples of `mminfo` Report Commands

The following examples provide a guideline for you to follow when you create your own customized queries. Shortened syntax, wherever acceptable, is shown.

To display all the information about all the volumes managed by the server:

mminfo -m

To display media information from volumes that are labeled mars.001 and mars.002:

mminfo -m mars.001 mars.002

To display all save sets found in the file indexes named /usr:

mminfo -N /usr

To display save sets named /usr, generated by a client named venus, backed up in the past week:

mminfo -N /usr -c venus

To display save sets named /usr, generated by a client named venus, on a volume that is labeled mars.001:

mminfo -N /usr -c venus mars.001

To display a media report of all volumes written on in the past week:

mminfo -m -t `last week'

To display a media report of all non-full volumes, showing the percent used, pool name, and location of each volume:

mminfo -a -r `volume,%used,pool,location' -q `!full'

To display a media report similar to the -m report that shows the barcode instead of the volume label:

mminfo -a -r \ `state,barcode,written,%used,read,space,volexp' \
-r`mounts(5),space(2),capacity'

To display a verbose list of the instances of all save sets with more than one copy, sorted by save time and client name:

mminfo -otc -v -q `copies>1'

To display all archive save sets with an annotation of "my project" for the past four months:

mminfo -q'annotation=my project' \
-r"volume,client,savetime,sumsize,ssid,name,annotation" \ -t'four
months ago'

`mmlocate`

The mmlocate program accesses and manages the volume location information contained in the media database. Any user can use this command with the -l (default) or -L options. The -c, -d and -u options are limited to Backup administrators. Running mmlocate without any arguments lists all volumes and their locations for the specified server. (If you do not specify a server, the current host is used.)

If you use the nsrjb command to move a volume inside a jukebox, the location of a volume is set to the name of the jukebox.

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

mmlocate [-s server] [-l] [-n volume-name | -i volumeID | location]
mmlocate [-s server] -L
mmlocate [-s server] -d location
mmlocate [-s server] -c {-n volume-name | -i volumeID}
mmlocate [-s server] -u

{-n volume-name | -i volumeID} location

Use the -a option to apply the query to all complete, browsable save sets, not just those in the last 24 hours. This option is implied by the -c, -N, -q, -m, and -o options. When combined with a media-only report (-m or a custom report showing only media information), the -a option applies to all volumes, not just those with complete and browsable save sets.
Use the -c option to clear the location field for the specified volume.
Use the -d location option to delete all volumes that show the given location. You receive a confirmation prompt prior to the deletion of each volume.
Use the -i volid option to restrict the mmlocate operation to the specified volume ID.
Use the -l query option to perform a database query using the supplied volume name, volume ID, or location. If you list the -l option without specific query requests, volumes without a set location are displayed.
Use the -L option to list all locations found in the database.
Use the -n volname option to restrict the operation to the volume name listed.
Use the -s server option to access the server's media database.
Use the -u option to update the location for a volume. Locations are limited to a maximum length of 64 characters. You must also specify the -n volname or -i volid options and specify a location.

`mmpool`

The mmpool program accesses pool information stored in the Backup server's media database. You can also use the command to delete all the volumes in a particular pool. If you specify one or more volume names with the mmpool program, the report shows the pool to which each named volume belongs. By default, all volumes and their pools are displayed.

You cannot change the pool to which a volume belongs without relabeling the volume, which destroys all data stored on the volume. Pools are configured through a Backup administration tool, such as nwadmin or nsradmin. Use the administration tool to create and modify unique pools (see "NSR pool ").

The following examples describe the format and options available for the mmpool program:

mmpool [-s server] [volume...]
mmpool [-s server] -d pool-name
mmpool [-s server] -l [pool-name]
mmpool [-s server] -L

Use the -d pool-name option to delete all volumes for the given pool. You are prompted for deletion of each volume.
Use the -l pool-name option to list all volumes and the pools to which they belong. If you specify a pool, mmpool only lists the volumes in that pool.
Use the -L option to list the names of all of the pool resources configured on the server.
Use the -s server option to specify the Backup server to act on. Refer to the nsr(1m) man page for a description of server selection.

`mmrecov`

The mmrecov program recovers a Backup server's online file index and media database from backup volumes when either of the files is lost or damaged. Note that this command overwrites the server's existing online file index and media database. The mmrecov program is not used to recover Backup clients' client file indexes; you can use normal recover procedures for this purpose.

You must fully install and correctly configure the Backup server software and run a backup that includes the server's file index and media database before using the mmrecov program for the first time. If any of the Backup software is lost, reinstall the software from the distribution files before you run mmrecov. Use the same release of Backup, and install it in the same location as it was before the software was lost.

After you start the mmrecov program, the program prompts for the device from which the bootstrap save set will be extracted. Then, it asks for the bootstrap ssid. This number is found in the fourth column (labeled ssid) of the last line of the bootstrap report printed each time you run the savegrp program. Refer to the mmrecov(1m) man page for an example of the bootstrap report.

The mmrecov program works in two phases. First, it extracts the contents of the bootstrap save set, which contains the media database and online file index. The online file index contains only one entry: for itself. In the second phase, the mmrecov program runs the recover program to completely recover the server's online file index. The final phase is performed in the background, so that you can respond to subsequent media mount requests.

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

mmrecov [-q | -v]

Use the -q option to run mmrecov in quiet mode, which only displays error messages encountered.
Use the -v option to run mmrecov in verbose mode, which displays more detail about the program's status as it is executed.

`nsrck`

The nsrck program checks the consistency of the Backup online index of clients' save sets.

Use the nsrck to check the consistency of the Backup client file indexes. Typically, the nsrck program is automatically started by the nsrindexdstartup. The .nsrck file is locked upon program execution; therefore, only one instance of nsrck can run on the server.

You can restart the nsrck program at any time during its execution. Therefore, it can survive system crashes or exhaustion of resources without losing data.

Index consistency checking is done in up to four phases:

Phase zero determines whether a client's index requires further investigation. This phase checks the internal state of the index and, if that state is consistent, avoids further passes. Phase zero also reports index names that appear to be suspicious (for example, indexes whose names do not map to valid network addresses).
Phase one fixes any errors found in the database record file, db, and rebuilds the b-tree indexes for the database, if necessary.
If you specify the -X option, nsrck invokes phase two, which cross-checks the client file index with the media database. Records that do not have existing, browsable save set entries are deleted.
If the database requires compression, either due to space freed by the previous phases or due to a state flagged by a previous run, the index is compressed during phase three.

Index compression is a two- or three-step process. First, the records of the database are copied to a temporary database, db.CMP. When that operation is completed, a flag file, db.SVC, is created; the old, uncompressed database is removed; and the compressed database is renamed to db. Finally, the db.SVC file is removed. If there is not enough room on the filesystem containing the db file to include the temporary database also, nsrck creates a temporary file on another writable filesystem. It stores a pointer to this file in a file named db.PTR. In this case, an extra copy of the data is required, because the uncompressed database must first be removed before the data can be copied back to the correct place. After all these steps are completed, the db.PTR file is removed.

The following example describes the format and options available for the nsrck program:
nsrck [-qM] | [-T tempdir] [-X [-x percent] | -C | -F | -m] [clientname...]

Use the -C option to force index compression on the named clients, or all clients if none are specified. Other phases of checking are only performed if an error in a database is detected.
Use the -F option to force a check on the listed client names. If no names are given, forced checks are performed for all client indexes. This option forces all phases of index checking. For backward compatibility, the -F option implies index compression, and may be used to force the index to be compressed. This option is typically only necessary when the browse policy is reduced (for example, if the browse policy is changed from 1 year to 6 months). See "NSR policy " for information on the policy resource.
Use the -M option to use the nsrck program in master mode (not advised for manual operation). This option advises nsrck that nsrd or another Backup daemon invoked nsrck and logs messages with timestamps, as well as performs any other behavior expected by nsrd.
Use the -m option to force nsrck to check and rebuild the media database b-tree indexes, instead of checking a client's online file index.
Use the -q option to use nsrck in quiet mode. Quiet mode suppresses all advisory messages.
Use the -T option to specify the directory for nsrck to use to hold the temporary database during compression, if there is not enough room in the filesystem containing the db file. If you use this option and there is insufficient space in the specified temporary directory, the nsrck program fails. This argument is ignored if there is sufficient space in the filesystem containing the db file.
Use the -X option to tell nsrck to cross-check the ssids in the index records with save sets found in the media database instead of checking the index databases (unless an error in phase zero occurs). Records that do not correspond to media save sets are discarded. If specific clients are listed, the cross-check is limited to those client indexes.
Use the -x option to compress a database after it has been cross-checked, if the database uses less than the specified percent of the UNIXfile. The unused pages are returned back to the filesystem. The default percentage for the -x option is 30.

`nsrim`

The nsrim program manages the Backup server's client file indexes and media database. Typically, the nsrim program is run automatically by the nsrmmdbd daemon when a scheduled backup starts, by the savegrp program upon completion of the backup, and by nsrd as a result of selecting the option to remove the oldest index cycle. Ordinarily, you should not run the nsrim program manually.

The nsrim program accesses the defined policies to determine how to manage each client's file index. Entries that have existed in the index longer than the period specified by the client's defined browse policy are removed from the client's file index. Save sets that have existed in the media database longer than the period specified by the client's defined retention policy are marked as recyclable in the media database. When all of the save sets contained on a single volume are marked recyclable, the volume itself is considered recyclable. Recyclable volumes may be selected and, in the case of volumes managed by an autochanger, automatically relabeled for use by Backup when a writable volume is requested for another backup. After you relabel the recycled volume, the data once contained on it is destroyed. Until you relabel the volume, you can still use the scanner program to recover the save sets. See "scanner " for information on how to use the scanner program.

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

nsrim [-b browse] [-c client] [-N saveset]

[- r retention] [-x percent] [-lnqvMX]

Use the -b browse option to use the policy specified by browse instead of the browse policy defined in the client's resource. This option is useful when combined with the -n option to determine the potential effect of a modified policy on the client file indexes.
Use the -c client option to process only the client file index for the client specified. If you do not specify this option, all the client file indexes managed by the Backup server are processed. You can repeat multiple -c client options on the same command-line.
Use the -l option to remove the oldest level full save and all save sets that depend on it from the client file index. This option is only acted on if there is more than one cycle of the save set in the client file index. This option ignores the browse and retention policies assigned to the client's resource. The save set's header information prints out the number of browsable full cycles that are currently maintained in the client file index. This option ignores any archive or migration save sets contained in the index. Manual save set entries are treated as if they were run as an incremental level save set. The -l option sets the utilization threshold to 30 percent.
Use the -M option to use the nsrim program in master mode (which is not advised for manual operation). This option advises nsrim that nsrd or another Backup daemon invoked nsrim, and logs messages with timestamps, as well as performs any other behavior expected by nsrd.
Use the -N saveset option to process only the named saveset; all other save sets encountered are skipped. This option may be repeated multiple times on the same command line.
Use the -q option to run nsrim in quiet mode. This option omits the generation of header, trailer, or save set messages.
Use the -r retention option to instruct nsrim to use the policy specified for retention rather than the retention policy defined by the client's resource. This option is useful when combined with the -n option to determine the potential effect of a modified policy on the client file indexes.
Use the -x percent option to set the utilization threshold. If, after removing entries, a client file index's utilization is less than the specified amount, the value of percent is passed to nsrindexd when a cross-check is requested. The default value of percent is 50. If you specify either the -X or -l options, the utilization threshold changes to 30 percent.
Use the -v option to run nsrim in verbose mode. This option may produce an especially large amount of output. If you specify both the -q and -v option together, the options cancel out each other's effect.
Use the -X option to check the consistency of the save set data structures with the volume data structures. The only time you would need this option is if a Backup were to crash occur. This option sets the utilization threshold to 30 percent.

Refer to the nsrim(1m) man page for further details and a list of the most common error messages encountered.

`nsrinfo`

The nsrinfo program generates reports about the contents of a client's file index. The Backup client name is required; if you provide no further options, the nsrinfo program produces a report of all the names of the files and objects, one per line, found in the backup namespace for the specified client. The nsrinfo program can also generate reports for a specific client file index namespace, either for all the namespaces at once, or for a particular XBSA (X-Open Backup Services) application. The report can be restricted to a single time period, called the savetime, which is the time the entry was entered into the client file index.

If you do not specify the -L option, you must be listed on the Backup server's Administrators list to use the nsrinfo program. If you do specify the -L option, you must be the system administrator (for example, root on a UNIX system).

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

nsrinfo [-vV] [-s server | -L] [-n namespace]

[- N filename] [-t time] [-X application] client

The required client specification determines the client that the nsrinfo program is reporting on.
Use the -L option to open the client file index directly without using the Backup server. This option is useful for debugging or to query the client file index when Backup is not running.
Use the -n namespace option to specify a client file index namespace to query. By default, the backup namespace is queried. The other values recognized by the nsrinfo program are migrated, archive (reserved for future use), nsr, informix, and all.
Use the -N filename option to specify an exact filename to search for in the client file index. Only index entries that are an exact match to the specified filename are printed. For some client systems (for example, NetWare), the filename stored in the client file index is often not made up of printable ASCII characters, which limits the use of this option.
Use the -t time option to restrict the nsrinfo query to a single, exact save time. The value of time may be expressed in any of the Backup Backup formats. Every save set created by Backup is assigned a unique save time. You can determine the save time by using the mminfo program (see "mminfo " for information).
Use the -v option to instruct nsrinfo to run in verbose mode. In addition to the filename, this option displays the type of the file, any internal file index identifier designated, its size (UNIX files only), and its save time. You can combine this option with the -V option.
Use the -V option to instruct nsrinfo to run in alternate verbose mode. In addition to the file name, this option displays the offset within the save set that contains the file, its size within the save set, the application namespace, and its save time. You can combine this option with the -v option.
Use the -s server option to define the name of the Backup server that nsrinfo should query. By default, the server on the local system is queried.
Use the -X application-type option to restrict the query to a list of information for a specific X/Open Backup Services (XBSA) application. Valid application types are All, Informix, and None. The expected value for application-type is not case-sensitive.

Refer to the nsrinfo(1m) man page for a full description of the valid values for namespace, the file types encountered in the client file indexes, an example of how nsrinfo is used, and a listing of common error messages encountered.

`nsrls`

The nsrls program, when invoked without any options, prints the number of files in client file index, the number of kilobytes that the client file index currently requires, and the utilization of the client file index with respect to the number of kilobytes allocated to its UNIXfile.

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

nsrls [client-name...]
nsrls -f file-name...

Use the client-name option to specify a particular Backup client file index to examine. By default, the current system is considered to be the client you want to examine indexes for.
Use the -f file-name option to instruct nsrls to take a list of file names rather than a list of Backup client names. For each legitimate index file named, the nsrls program prints an internal volume ID number and the filename, then a statistics banner, followed by the statistics associated with each internal file in the index. Each internal file has the following statistics associated with it: an internal file ID (Fid), the number of kilobytes that the file consumes (Kbytes), the number of logical records in the file (Count), and a descriptive name for the internal file (Name). Refer to the nsrls(1m) man page for a full description of the internal files.

Appendix B Command Line Reference Utilities

Enabler Entry and Registration

nsr_ize

nsrlic

NSR license

nsrcap

nsr_shutdown

User Interface Startup

nsradmin

Command Options for nsradmin

Resources Available in the nsradmin Program

NSR client

NSR device

NSR directive

NSR group

NSR jukebox

NSR label

NSR license

NSR migration

NSR notification

NSR policy

NSR pool

NSR schedule

NSR Stage

NSR

Server Status Resource for Character-Based Displays

nwadmin

nwarchive

nwbackup

nwrecover

nwretrieve

Device and Media Management

changers

hpflip

ielem

inquire

jb_config

ldunld

libsji

lrescan

lreset

lusbinfo

lusdebug

lusmode

msense

nsrjb

nsrmm

pmode

relem

sjidopen

sjiielm

sjiinq

sjirdp

sjirdtag

sjirelem

sjirjc

tur

Data Management

savegrp

save

savefs

savepnpc

recover

nsrmig

nsrpmig

nsrhsmck

nsrarchive

nsrretrieve

nsrclone

nsrstage

scanner

File Index and Media Database Management

mminfo

Examples of mminfo Report Commands

mmlocate

mmpool

mmrecov

nsrck

nsrim

nsrinfo

`nsr_ize`

`nsrlic`

`NSR license`

`nsrcap`

`nsr_shutdown`

`nsradmin`

Command Options for `nsradmin`

Resources Available in the `nsradmin` Program

`NSR label`

`nwadmin`

`nwarchive`

`nwbackup`

`nwrecover`

`nwretrieve`

`changers`

`hpflip`

`ielem`

`inquire`

`jb_config`

`ldunld`

`libsji`

`lrescan`

`lreset`

`lusbinfo`

`lusdebug`

`lusmode`

`msense`

`nsrjb`

`nsrmm`

`pmode`

`relem`

`sjidopen`

`sjiielm`

`sjiinq`

`sjirdp`

`sjirdtag`

`sjirelem`

`sjirjc`

`tur`

`savegrp`

`save`

`savefs`

`savepnpc`

`recover`

`nsrmig`

`nsrpmig`

`nsrhsmck`

`nsrarchive`

`nsrretrieve`

`nsrclone`

`nsrstage`

`scanner`

`mminfo`

Examples of `mminfo` Report Commands

`mmlocate`

`mmpool`

`mmrecov`

`nsrck`

`nsrim`

`nsrinfo`

`nsrls`