NSRADMIN - The backups administrators toolkit

This document was originally published by Legato in 1998.

The nsradmin program is the administrative program for the NetWorker system that uses the command line. Typically, nsradmin monitors and modifies NetWorker 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 [-i file] [-s server]
  • Enter the -i file option to tell NetWorker 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 -s server option to open a connection to a specific NetWorker server. This command is useful when you want to limit the number of resources polled if there are many servers, or to administer NetWorker when the RAP location service is not working.

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 table describes the commands available and their function:

Table 1 - nsradmin Commands
Option Description
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.
help -or- ? 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 NetWorker 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.
. 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 NetWorker server use nsradmin or use the NetWorker Administrator GUI.

The NSR client resource has the following attributes:

Table 2 - NSR client resources
Attribute Description
namespecifies the hostname of a client.
serverspecifies the hostname of a client's server.
archive services specifies if a system can use archive services. To use this attribute archive support must be enabled on the server first.
schedulespecifies the name of the schedule controlling the backup levels for the save sets listed in the save set attribute.
browse policyspecifies the name of the policy controlling the length of time entries will remain in a client's on-line file index.
retention policyspecifies the name of the policy controlling the length of time entries will remain in the media index before they are marked as recyclable.
directivespecifies the directive used for backing up a client.
groupspecifies the group a client is a member of. The group controls when scheduled backups are performed on the client.
save setlists 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.
priorityspecifies 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.
remote accessspecifies 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.
remote user
  • specifies the user login name a server will use to authenticate itself with a client, who has accessed the network through rsh or nsrexecd.
  • allows the 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.
passwordis 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.
backup commandperforms 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".
executable pathspecifies the path used by the server for executing commands on the client.
server network interfacespecifies the network interface the server uses for saves and recovers.
aliasesspecifies the aliases for a client machine that queries can match.
owner -notificationsends the contents of status messages to the owner/primary user of a system.
statisticsconsists of: the size of the client's on-line file index, the number of kilobytes used and the number of entries in the index.
index save setspecifies save set, residing in a client's file index, to purge when an index operation is set to purging oldest cycle.
index messageis the status message resulting from the previous index operation.
index operation startindicates the starting time of the current index operation. This attribute is a null string ("") when the operation is "Idle".
index progressindicates 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.
index operationspecifies the current index operation.
parallelismindicates the maximum number of saves that should be run simultaneously on a single client.
archive usersspecifies 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.
application informationspecifies a client's application information.
storage nodesspecifies 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.
clone storage nodesspecifies 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 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: /, /usr, /var;
      remote access: venus, sam@*, jupiter/john;
        remote user: operator;
           password: ;
     backup command: ;
            aliases: saturn.legato.com;
      archive users: ;
      storage nodes: nsrserverhost;
clone storage nodes: ;
NSR device

To edit the NSR device resources for a NetWorker server use nsradmin or use the NetWorker Administrator GUI The NSR device resource has the following attributes:

Table 3 - NSR device resources
Attribute Description
namespecifies 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 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 . 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 .
media typespecifies 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.
enabledindicates whether a device is available for use.
read onlyindicates whether a device is reserved for read only operations, such as recover or retrieve.
target sessionsspecifies 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.
media familyspecifies the class of storage media, as determined from the media type:
  • tape — tape storage device
  • disk — disk storage device
  • logical — external media device.
messagespecifies the last message from a server regarding a device, such as the progress or rate of an operation.
volume nameis monitors the mounting and unmounting of volumes for a device.
write enabledindicates if writing to the current volume is allowed.
volume operationmanipulates media volumes currently in the device, through several operations:
  • Unmount — operation releases the device.
  • Mount — operation mounts the loaded volume onto the device.
  • Verify label — operation reads the volume's label, volume's attributes and sets the volume expiration.
  • Verify write time — operation sets the volume write time attribute.
  • Label or Label without mount — operations create new labels for volumes.
  • Eject — operation ejects volumes from the device.
  • Monitor device — operation periodically checks the device to determine whether a volume has been loaded into the device. When a volume containing a readable label is loaded, the volume is listed in the server's media database, and the volume is writable the volume is mounted with write permissions. Otherwise the volume is mounted read only.
volume labelis set by the Verify label operation and may be an input to the Label operation.
volume default capacityis used by the Label operation if the volume current capacity is blank. This attribute enables the override of default sizes when using devices (and/or tapes) with different capacities than the defaults.
volume current capacitydetermines the capacity of a volume during the Label operation.
volume expirationspecifies a volumes expiration date, which is set by the Verify label operation.
volume poolspecifies the pool a volume belongs, or has been assigned to.
NSR operationspecifies the current operation being performed by the device.
minor modereports the current status of a device.
statisticsreports 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
cleaning requiredindicates 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. 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.
cleaning intervalspecifies the amount of time from date last cleaned until the next scheduled cleaning for a device.
date last cleanedrecords the time and day a device was last cleaned.
volume block sizespecifies the block size of a currently mounted volume.
volume-idspecifies the volume id for a currently mounted volume.
access countindicates the number of operations performed on a device since it's configuration as a device.
access weightindicates 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.
consecutive errorsspecifies the current number of consecutive errors resident on a device.
max consecutive errorsindicates the maximum number of consecutive errors allowed before the device will be disabled.
operation argspecifies extra parameters about a device operation. Parameters are packed into a string and parsed.
volume messageindicates the result of the volume's last operation.
volume write timeindicates the time a save set was first written onto the volume.
volume flagsindicates new flags for the volume to operated on, during a "Label" or "Label without mount" operation.
jukebox deviceindicates if a media device is in a jukebox
unlabeled volume loadedindicates whether a volume loaded into a device has a readable volume label.
auto media managementindicates 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 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 and does not have a label recognizable by.
logical namespecifies the name for a logical device.
logical typespecifies the type for a logical device.
logical familyis the family associated with a logical device.
connection process idspecifies the process identifier that maintains the connection between external media management services and a mounted volume.
connection messagespecifies error messages reported by a process connected to an external media management service.
connection statusspecifies the exit status reported by a process connected to an external media management service.
save mount timeoutindicates 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.
save lockoutindicates 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

To edit the NSR directive resources for a NetWorker server use nsradmin or use the NetWorker Administrator GUI The NSR directive resource has the following attributes:

Table 4 - NSR directive resources
Attribute Description
namespecifies the name of a directive resource. Names are displayed as choices when creating or updating client resources.
directiveindicates the rules that define a directive.

The following is an example of a NSR directive resource, named "UNIX directive"

               type: NSR directive;
               name: UNIX directive;
          directive: "
<< / >>
+skip : core
skip : tmp
<< /var/spool/mail >>
mailasm : *
<< /nsr >>
allow
";
NSR group

Controls when a group of clients begin saving data and whether scheduled backups are started automatically each day.

To edit the resources for a NetWorker server use nsradmin or use the NetWorker Administrator GUI

The resource has the following attributes:

Table 5 - NSR group resources
Attribute Description
namespecifies the name of a group defined by the resource. The name is an option within the NSR client and NSR-pool resources.
The autostartdetermines if a group will be saved automatically on a daily basis. The following operations can be invoked by autostart:
  • Enabled — starts saving group members data at the time specified in the start time attribute.
  • Disabled — disables the automatic save process specified for members of a group.
  • Start now — saves group members data immediately.
autorestartcontrols whether a group is automatically restarted after an incomplete save.
stop nowaborts a groups save processes immediately.
start timespecifies the time of day when a group will begin a save.
last startis the last time a group began a save.
intervalspecifies how often a group runs an automatic save.
force incrementalforces an incremental backup of a savegroup, for an interval attribute less than 24 hours.
client retriesindicates 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.
clonescauses saves of a group to automatically make a clone for every save set backed up.
clone poolspecifies the pool where save set clones are sent.
optionsspecifies the options indicated for a group's save.
levelindicates the level a savegroup will use when started automatically by . When level is not specified, the NSR Schedule for each client filesystem will be used to determine the level.
printerspecifies the printer to which bootstrap save set information will be printed to.
schedulespecifies the level of save that will be performed.
schedule timespecifies the time a save will be performed.
inactivity timeoutis the time a savegroup command waits for any kind of activity from the server before concluding that a savegroup descendant is hung.
work listindicates the saves still not completed. The worklist indicates; the client name, the level of save, and the path to save.
completionindicates the status of each save set that has been completed.
statusindicates 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

To edit the NSR jukebox resources for a NetWorker server use nsradmin or use the NetWorker Administrator GUI. The NSR jukebox resource has the following attributes:

Table 6 - NSR jukebox resources
Attribute Description
namespecifies the name of a jukebox.
modelspecifies the jukebox model.
physical slotsspecifies 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 server.
control portspecifies 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.
devicesidentifies 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.
number devicesidentifies the number of configured devices in the jukebox.
write enabledindicates if the mounted volume can be written to.
bar code readerindicates if is using the bar code label from the media when a jukebox has a bar code label reader.
match bar code labelsindicates if is using the bar code label, instead of a label template, when labeling media volumes.
volume expirationspecifies 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.
available slotsspecifies the slots containing volumes available to be written to by 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.
enabler codeidentifies the enabler code for a NSR license resource corresponding to a jukebox resource.
operationidentifies the current jukebox operation.
operation messagedisplays error messages when an jukebox operation fails.
operation devicepasses device names to current operations.
operation slotspasses slots to current operations.
operation optionspasses the mode of a volume to the current operation.
operation barcodespasses volume tags or barcodes to the current operation.
operation responseidentifies the default response to questions asked while performing an operation.
operation report modeidentifies the amount of output generated during operation execution.
operation label statedesignates the operation to be performed on a labeled volume as; to be recycled or to be unlabeled.
operation volume capacityspecifies a volume's capacity.
operation volume typespecifies the types of volumes that may be considered when allocating a volume.
operation ineligiblespecifies volumes ineligible for the current operation.
operation taskdesignates a secondary task or operation to be performed with the current operation.
operation resultreports error messages for multiple operations. This attribute maintains error messages for 32 simultaneous operations performed on a jukebox, that failed.
operation instancespecifies the instance number associated with an operation.
operation next instancespecifies the instance number associated with the next simultaneous operation.
operation instancesspecifies the instance number for each simultaneous operation currently executing.
operation hostnameidentifies 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.
operation templatespecifies the template a label operation will use.
operation volume poolspecifies the default volume pool for label operations.
operation source poolspecifies the pool a volume will be selected for recycling.
operation uses leftindicates the number of times a cleaning cartridge can used.
volumesspecifies the names of resident volumes in corresponding order to the slot number.
volume idsspecifies the volume identifiers (volid) for resident volumes.
volume cartridge idstracks the identifier for each cartridge h a volume resides.
loaded volumescontains the names of volumes currently loaded in jukebox devices.
loaded bar codesidentifies the bar codes of loaded volumes.
loaded slotsidentifies the slot numbers of loaded volumes.
event tagspecifies the tag of the last notification event sent to the nsrd service
event messageis the text of the last notification event sent to the nsrd service.
messagesspecifies the log messages from previous operations nsrjb has completed.
minimum spacespecifies the low water mark of the remaining space on the volumes contained in the available slots.
jukebox optionsspecifies the options for this jukebox.
auto cleanspecifies automatic cleaning for each device.
cleaning slotsidentifies 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.
default cleaningsspecifies the number of uses assigned to a new cleaning cartridge during an inventory of a jukebox by nsrjb.
auto media managementindicates 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.
STL device namesspecifies silo device names of the devices identified in the devices attribute of a Silo Tape Library.
STL interface libindicates the path name of the dynamically linked Silo Tape interface library.
STL device sharingspecifies, 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.
STL barcodesindicates the barcodes of the volumes residing within in a Silo Tape library, which are available to .
STL device reservationspecifies the reservation state of shared devices in a Silo Tape library.
allocated devicesspecifies jukeboxes allocated to RLM.
application namespecifies the name used by a server to identify itself to OpenVault when submitting a request to access resources on a jukebox.
application keyspecifies the key used by a server to identify itself to OpenVault when submitting a request to access resources on jukebox.
jukebox locksynchronizes access to resources in a jukebox that supports multiple simultaneous operations. This attribute can be used to lock and unlock a entire jukebox.
device lockssynchronizes 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.
volume/slot lockssynchronizes 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 jukebox resource named "Huntington":

                     type: NSR jukebox;
                     name: Huntington;
                    model: EXB-210;
           physical slots: 1-11;
             control port: scsidev@0.6.0;
                  devices: /dev/rmt/0mbn, /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: /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: /usr/lib/libstl.sol;
                event tag: 6319962287;
            event message: could not unload device /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

Describes the templates for generating volume labels.

To edit the NSR label resources for a NetWorker server use nsradmin or use the NetWorker Administrator GUI.

The NSR label resource has the following attributes:

Table 7 - NSR label resources
Attribute Description
namespecifies the name of a label template.
fieldsspecifies 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.
separatorspecifies a character separator for field labels.
nextspecifies 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

Describes the features enabled in your NetWorker installation. To inspect the NSR license resources for a NetWorker server use nsradmin or use the NetWorker Administrator GUI.

The NSR license resource has the following attributes:

Table 8 - NSR license resources
Attribute Description
namespecifies the name of the license resource.
enabler codespecifies the code entered into the nsrcap command to enable the feature named in this resource.
host idspecifies the unique host id associated with the computer or licensed operating system.
expiration datespecifies the date an enabler will expire, if the enabler is an evaluation enabler or un-registered license enabler.
auth codepermanently authorizes an enabler. An unique, valid authorization code for an enabler is obtained from Legato through the registration of each purchased license enabler.
    IMPORTANT: If a server's host id changes, all auth codes will immediately be invalidated, and the enablers must be re-registered with Legato to obtain new authorization codes.
license typedescribes the specific feature(s) enabled.
checksummaintains consistency of a NSR license resource, and between license resources.

Following is an example of a NSR license resource:

               type: NSR license;
               name: NetWorker Advanced/10;
       enabler code: 123456-7890ab-cdef01;
            host id: 7260d859;
    expiration date: Authorized - no expiration date;
          auth code: a1b2c3d4;
       license type: B10;
           checksum: xxxxxxxxxxxxxxxxxxxxxx;
NSR migration

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 NetWorker server use nsradmin or use the NetWorker Administrator GUI.

The NSR migration resource has the following attributes:

Table 9 - NSR migration resources
Attribute Description
nameidentifies the client and save set whose migration attributes are stored in this resource.
clientidentifies the HSM client whose save sets are to be placed under migration control.
save setspecifies the path names of filesystems or sub-trees to place under migration control for the specified client.
enabledspecifies whether a save set named in a resource will be automatically migrated.
directiveindicates to the client how to migrate certain files. The choices are defined by the existing directives.
groupindicates the groups a client or saveset is a part of for pre-staging migrated files.
highwater mark %specifies the point at which files will start being replaced by stubs, measured as a percentage of available space used on a file system.
low water mark %specifies the point at which files will stop being replaced by stubs, measured as a percentage of available space used on the file system.
last access timespecifies those files that have not been accessed in the past specified relative time will be migrated.
minimum file size (KB)indicate files that are larger than then a specified size, will be migrated.
file ownerspecifies the users whose files to be migrated.
file groupspecifies a groups whose files are to be migrated.
preserveindicates regular expressions, in a client's shell syntax.
statisticsspecifies statistics about recent migration activity for save set(s) managed using a resource.
update statisticscontrols whether statistics in this resource should be updated to match the current values on a client.

Following is an example of a NSR migration resource defining an HSM client, called elantra:

                  type: NSR migration;
                  name: "elantra:/test";
                client: elantra;
              save set: /test;
               enabled: Yes;
             directive: Unix with compression directives ;
                 group: Default;
   high water mark (%): 90;
    low water mark (%): 80;
      last access time: ;
minimum file size (KB): 5;
            file owner: joe, dave;
            file group: staff, developers;
              preserve: *.exe *.dll;
NSR notification

is used for each combination of an event, priority, and action handled by the notification system. A 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 NetWorker server use nsradmin or use the NetWorker Administrator GUI.

The NSR notification resource has the following attributes:

Table 10 - NSR notification resources
Attribute Description
namespecifies the name of a notification resource.
eventspecifies 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 server events, such as restarting.
priorityspecifies 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 to fail.
actionindicates 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: /usr/ucb/mail -s savegroup completion;
              event: Savegroup;
           priority: Info, Notice, Warning, Waiting;
NSR policy

Controls 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 NetWorker server use nsradmin or use the NetWorker Administrator GUI.

The NSR policy resource has the following attributes:

Table 11 - NSR policy resources
Attribute Description
namespecifies the name of the policy defined by this resource. This name will appear as an option of each NSR client resource.
periodindicates 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.
number of periodsspecifies 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

This resource determines where volumes save sets reside based upon their characteristics.

There are four types of pools:

  • Backup pool — accepts data from savegroup and manual backups.
  • Archive pool — accepts 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:

  • 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 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 NetWorker server use nsradmin or use the NetWorker Administrator GUI.

The NSR pool resource has the following attributes:

Table 12 - NSR pool resources
Attribute Description
namespecifies the name of pool resources used when labeling volumes and determines which volumes a save set will reside.
groupsspecifies the groups allowed in a pool.
clientsspecifies the clients allowed in a pool. If a group is specified, clients that are members of that group can be listed.
save setsindicates the save sets allowed in a pool. Save sets can be matched using regular expression matching.
levelsspecifies the levels allowed in the specified pool.
archive onlyenables archive only saves for a pool.
statusindicates 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.
label templatespecifies the label template referenced when generating volume names for a pool.
devicesindicates a devices volumes within this pool that are allowed to be mounted to.
store index entriesspecifies 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.
auto media verifywill 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.
recycle to other poolsspecifies whether or not a given pool allows other pools to recycle its recyclable volume for their use.
recycle from other poolsspecifies whether a given pool can recycle volumes from other pools when it exhausts all of its write-able and recyclable volumes.
volume type preferencespecifies 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;
                    name: Default;
            archive only: No;
                 clients: ;
                 devices: ;
                  groups: ;
          label template: Default;
                  levels: ;
               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

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

To edit the NSR schedule resources for a NetWorker server use nsradmin or use the NetWorker Administrator GUI.

The NSR schedule resource has the following attributes:

Table 13 - NSR schedule resources
Attribute Description
namespecifies a schedule's name used by a client.
periodspecifies the length of a schedule. It may be either "Week" or "Month."
actionspecifies 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, will repeat the list of actions when the end of the action list is reached.
overridespecifies 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

To edit the NSR Stage resources for a NetWorker server use nsradmin or use the NetWorker Administrator GUI.

The NSR stage resource has the following attributes:

Table 14 - NSR stage resources
Attribute Description
namespecifies the staging policy name.
enabledspecifies whether or not save sets are automatically staged from devices associated with a policy. It also enables and disables the periodic recover space operations.
max storage periodspecifies the maximum number of days for a save set in a given volume before it is staged to a different volume.
high water mark %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.
low water mark- %specifies the point at which the staging process should stop, measured as the percentage of available space used on the file system.
Save set selectionspecifies 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.
Destination poolspecifies the pool save sets should be sent.
Devicesspecifies the file type devices are associated with.
Recover space intervalspecifies the number of hours between recover space operations for save sets with no entries in the media database form file devices.
FS check intervalspecifies the number of hours between file system check operations.
Start nowspecifies 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: /disk/fd0;
          start now: ;
NSR

Each resource represents a component of a system that needs administration. Resources are manipulated to control a 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:

Table 15 - NSR resources
Attribute Description
typedefines the attributes a resource can contain.
namespecifies the descriptive name of an object that a resource represents.
administratorspecifies the users that can modify or delete a resource. This attribute is inherited from the type: NSR resource when a new resource is created.
hostnamespecifies the hostname of the system where a service that controls the specified resource is running.
ONC program numberspecify the Open Network Computing information for a service.
ONC version number
ONC transport
nsradmin Resources

The NSR defines the following types of resources:

Table 16 - NSR resource definitions
Resource Description
NSRdescribes a server. It contains attributes that control administrator authorization, information about operations in progress, and statistics and error information about past operations.
NSR clientdescribes a client. It includes attributes that specify the files to save, which schedule to use, and which group this client belongs to.
NSR devicedescribes a storage device. It includes attributes that specify a particular device name, media type, and name of the currently mounted volume.
NSR directivedescribes a directive. Directives control how a client's files are processed as they are being saved.
NSR- groupspecifies a logical grouping of clients and a backup starting time.
NSR jukeboxdescribes 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.
NSR labelspecifies a template describing a sequence of names to be used when labeling volumes.
NSR licensecontains licensing information for each feature currently enabled. It contains various enabler and authorization codes used by to validate licensed capabilities.
NSR notificationspecifies an action to be performed when a particular type of event takes place.
NSR policyis 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.
NSR poolis used by to determine where volume save sets should reside on based on the characteristics of the save.
NSR scheduledefines 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.