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>

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.

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:

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:

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.

  1. 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.

  2. 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.

  3. The local machine is examined to see of it is a Backup server. If it is, then the local machine is used.

  4. 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>

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:

Command Options for nsradmin

The following list describes the commands available and their function:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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]

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]

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]

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]

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]

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]

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] 

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] 

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] 

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] 

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:

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:

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 - 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] 

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 

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...] 

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]

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] 

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:

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...]]

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 - 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...]

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] 

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:

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]

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]

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

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:

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).

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.

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...]

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]...

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

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

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] 

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]

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.

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.

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

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

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] 

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:

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] 

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 

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...