NSR label

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

The NSR label resource has the following attributes:

• The name attribute specifies the name of a label template.

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

  The types of fields are: numeric range, lower-case range, upper-case range and a list of strings. Each fields position is indicated by the next attribute.

• The separator attribute specifies a character separator for field labels.

• The next attribute specifies the next volume name to use. After a name is assigned to a volume, the next volume name will be generated and placed here.

  The following is an example of a nsr_label resource:

  type: NSR label; name: engineering; fields: aa-zz, 00-99; separator: .; next: aa.00;

NSR license

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

The NSR license resource has the following attributes:

• The name attribute specifies the name of the license resource.

• The enabler code attribute specifies the code entered into the nsrcap command to enable the feature named in this resource.

• The host id attribute specifies the unique host ID associated with the computer or licensed operating system.

• The expiration date attribute specifies the date an enabler will expire, if the enabler is an evaluation enabler or un-registered license enabler.

• The auth code attribute permanently authorizes an enabler. An unique, valid authorization code for an enabler is obtained from SunSoft through the registration of each purchased license enabler.

  ---

  Caution -

  If a server's host ID changes, all auth codes will immediately be invalidated, and the enablers must be re-registered with SunSoft to obtain new authorization codes.

  ---

• The license type attribute describes the specific feature(s) enabled.

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

  Following is an example of a NSR license resource:

  type: NSR license; name: Backup Advanced/10; enabler code: 123456-123456-123456; host id: 7260d859; expiration date: Authorized - no expiration date; auth code: abcdef00; license type: B10; checksum: xxxxxxxxxxxxxxxxxxxxxx;

NSR migration

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

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

The NSR migration resource has the following attributes:

• The name attribute identifies the Backup client and save set whose migration attributes are stored in this resource.

• The client attribute identifies the HSM client whose save sets are to be placed under migration control.

• The save set attribute specifies the path names of filesystems or sub-trees to place under migration control for the specified client.

• The enabled attribute specifies whether a save set named in a resource will be automatically migrated.

• The directive attribute indicates to the client how to migrate certain files. The choices are defined by the existing directives.

• The group attribute indicates the groups a client or saveset is a part of for pre-staging migrated files.

• The highwater mark attribute specifies the point at which files will start being replaced by stubs, measured as a percentage of available space used on a file system.

• The low water mark attribute specifies the point at which files will stop being replaced by stubs, measured as a percentage of available space used on the file system.

• The last access time attribute specifies those files that have not been accessed in the past specified relative time will be migrated.

• The minimum file size (KB) attribute indicate files that are larger than then a specified size, will be migrated.

• The file owner attribute specifies the users whose files to be migrated.

• The file group attribute specifies a groups whose files are to be migrated.

• The preserve attribute indicates regular expressions, in a client's shell syntax.

• The statistics attribute specifies statistics about recent migration activity for save set(s) managed using a resource.

• The update statistics attribute controls whether statistics in this resource should be updated to match the current values on a client.

NSR notification

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

The NSR notification resource has the following attributes:

• The name attribute specifies the name of a notification resource.

• The event attribute specifies a class of events that will trigger a given notification. The valid classes are:

  • Media, identifies events related to a media multiplexor subsystem

  • Savegroup, identifies events generated by savegroup

  • Index, identifies events related to the on-line file index subsystem, Registration, identifies events caused by changes in a product's registration status

  • Server, identifies Backup server events, such as restarting.

• The priority attribute specifies the priority at which a notification will be triggered. The valid values in increasing priority order are:

  • Info, supplies information about the current state of a server

  • Notice, an important piece of information

  • Warning, gives information about a non-fatal error

  • Waiting, indicates the server is waiting for a routine task

  • Critical, the server detected an error condition that requires attention

  • Alert, a severe error condition that demands immediate attention

  • Emergency, a severe condition that may cause Backup to fail.

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

  Following is an example of a NSR notification resource:

  type: NSR notification; name: savegroup completion; administrator: root; action: h:\usr\ucb\mail -s savegroup completion; event: Savegroup; priority: Info, Notice, Warning, Waiting;

NSR policy

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

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

The NSR policy resource has the following attributes:

• The name attribute specifies the name of the policy defined by this resource. This name will appear as an option of each NSR client resource.

• The period attribute indicates the base unit for a policy as one of the following values:

  • Weeks, defined as 7 days

  • Months, defined 31 days

  • Years, defined as 366 days. Example: period: Months;

• The number of periods attribute specifies the number of base units to use.

  Following is an example of a NSR policy resource named Quarter:

  type: NSR policy; name: Quarter; period: Months; number of periods: 3;

NSR pool

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

There are four types of pools:

• Backup pools accept data from savegroup and manual backups.

• Archive pools accept archive data.

• Backup clone pool, where data from a backup pool can be cloned to.

• Archive clone pool, where archive data can be cloned to.

  There are four pre-enabled pools shipped with Backup:

• Default pool, collects any backup data that is not directed to a customized pool.

• Archive pool, collects any archive data not directed to a customized pool.

• Default clone pool, is available to clone backup data to.

• Archive clone pool, is available for users to clone archive data to.

  There are also a few pools shipped with Backup that are not enabled by default:

• Use the Full and NonFull pools, to segregate full level backups from other backups, for example, fulls versus incrementals.

• Use the Offsite, pool to generate offsite backups, as index entries are stored for the media pool and will not be referenced during normal recovers.

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

  The NSR pool resource has the following attributes:

• The name attribute specifies the name of pool resources used when labeling volumes and determines which volumes a save set will reside.

• The groups attribute specifies the groups allowed in a pool.

• The clients attribute specifies the clients allowed in a pool. If a group is specified, clients that are members of that group can be listed.

• The save sets attribute indicates the save sets allowed in a pool. Save sets can be matched using regular expression matching.

• The levels attribute specifies the levels allowed in the specified pool.

• The archive only attribute enables archive only saves for a pool.

• The status attribute indicates the status of a pool as one of the following:

  • enabled, the pool is considered for determining what pools a save set should be saved to when performing backup volume selection.

  • clone, this pool is considered as the destination for cloning.

  • disabled, this pool is completely ignored.

• The label template attribute specifies the label template referenced when generating volume names for a pool.

• The devices attribute indicates a devices volumes within this pool that are allowed to be mounted to.

• The store index entries attributes specifies the entries made into a file index for backups. If entries are not made into the file index e, only media database entries for the save sets will be created.

• The auto media verify attribute will verify data written to volumes from this pool. Data is verified by re-positioning the volume to read a portion of the data previously written to the media and comparing the data read to the original data written. If the data read matches the data written, verification succeeds otherwise it fails.

• The recycle to other pools attribute specifies whether or not a given pool allows other pools to recycle its recyclable volume for their use.

• The recycle from other pools attribute specifies whether a given pool can recycle volumes from other pools when it exhausts all of its write-able and recyclable volumes.

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

  Following is an example of a NSR pool resource:

  type: NSR pool; archive only: No; clients: ; devices: ; groups: ; label template: Default; levels: ; name: Default; save sets: ; status: Enabled; store index entries: Yes; auto media verify: Yes; recycle from other pools: Yes; recycle from other pools: Yes; volume type preference: 4mm;

NSR schedule

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

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

The NSR schedule resource has the following attributes:

• The name attribute specifies a schedule's name used by a client.

• The period attribute specifies the length of a schedule. It may be either "Week" or "Month."

• The action attribute specifies the sequence of save levels within a schedule. One entry is used for each day of a schedule. The valid levels are `full', `incr', `skip', and the numbers 1 through 9. When the action attribute does not account for every day in the period, Backup will repeat the list of actions when the end of the action list is reached.

• The override attribute specifies a list of actions and dates overriding the actions specified in the action attribute. The format of an override specification is action date.

  Following is an example of a NSR schedule resource:

  type: NSR schedule; name: quarterly; period: Month; action: 5 incr incr incr 9 incr incr; override: f 1/1/1997, f 3/1/1997;

NSR Stage

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

The NSR stage resource has the following attributes:

• The name attribute specifies the staging policy name.

• The enabled attribute specifies whether or not save sets are automatically staged from devices associated with a policy. It also enables and disables the periodic recover space operations.

• The max storage period attribute specifies the maximum number of days for a save set in a given volume before it is staged to a different volume.

• The high water mark % attribute specifies the point at which save sets should be staged, measured as the percentage of available space used on the file system. Staging will continue until the lower mark is reached.

• The low water mark attribute specifies the point at which the staging process should stop, measured as the percentage of available space used on the file system.

• The Save set selection attribute specifies the save set selection criteria for staging. It may be one of four values:

  • largest save set

  • smallest save set

  • oldest save set

  • youngest save set.

• The Destination pool attribute specifies the pool save sets should be sent.

• The Devices attribute specifies the file type devices are associated with.

• The Recover space interval attribute specifies the number of hours between recover space operations for save sets with no entries in the media database form file devices.

• The Fs check interval attribute specifies the number of hours between file system check operations.

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

  • Check fs, check file system and stage data if necessary.

  • Recover space, recover space for save sets with no entries in the media database.

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

    Following is an example of a NSR Stage resource:

    type: NSR stage; name: test stage1; autostart: Enabled; max storage period: 7; high water mark (%): 90; low water mark (%): 85; save set selection: largest save set; destination pool: Default Clone; devices:h:\disk\fd0; start now: ;

NSR

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

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

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

          type: NSR client;

          name: venus;

        server: earth;

      schedule: Default;

     directive: Unix standard directives;

         group: Default;

      save set: All;

remote access: ;

Each NSR resource includes the following attributes:

• The type attribute defines the attributes a resource can contain.

• The name attribute specifies the descriptive name of an object that a resource represents.

• The administrator attribute specifies the users that can modify or delete a resource. This attribute is inherited from the type: NSR resource when a new resource is created.

• The hostname attribute specifies the hostname of the system where a service that controls the specified resource is running.

• The remaining attributes (ONC program number, ONC version number, and ONC transport) specify the Open Network Computing information for a service.

  Backup defines the following types of resources:

• The NSR resource describes a Backup server. It contains attributes that control administrator authorization, information about operations in progress, and statistics and error information about past operations.

• The NSR client resource describes a Backup client. It includes attributes that specify the files to save, which schedule to use, and which group this client belongs to.

• The NSR device resource describes a storage device. It includes attributes that specify a particular device name, media type, and name of the currently mounted volume.

• The NSR directive resource describes a directive. Directives control how a client's files are processed as they are being saved.

• The NSR group resource specifies a logical grouping of Backup clients and a backup starting time.

• The NSR jukebox resource describes a jukebox. It includes attributes such as the jukebox model, the first and last slot numbers in the jukebox, and the names of the devices within the jukebox.

• The NSR label resource specifies a template describing a sequence of names to be used when labeling volumes.

• The NSR license resource contains licensing information for each feature currently enabled. It contains various enabler and authorization codes used by Backup to validate licensed capabilities.

• The NSR notification resource specifies an action to be performed when a particular type of Backup event takes place.

• The NSR policy resource is used as part of the index management process. These policies control how long entries remain in a client's on-line file index and when to mark a save set as recyclable.

• The NSR pool resource is used by Backup to determine where volume save sets should reside on based on the characteristics of the save.

• The NSR schedule resource defines a sequence of save levels and an override list. The override list is made up of pairs of levels and dates. The level controls the amount of data saved when a client is backed up.

Server Status Resource for Character-Based Displays

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

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

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

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

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

nsrwatch [-s server] [-p polltime]

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

• Use the -p polltime option to set the polling interval to be in polltime seconds.