NSRADMIN - The backups administrators toolkit
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 fileoption to tell NetWorker to take input commands from a file instead of from standard input. The interactive prompt is not printed when you use thensradminprogram in this mode. - Enter the
-s serveroption 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:
| 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. |
| . 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. |
| quit | To exit the nsradmin program. |
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:
| Attribute | Description |
|---|---|
| name | specifies the hostname of a client. |
| server | specifies 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. |
| schedule | specifies the name of the schedule controlling the backup levels for the save sets listed in the save set attribute. |
| browse policy | specifies the name of the policy controlling the length of time entries will remain in a client's on-line file index. |
| retention policy | specifies the name of the policy controlling the length of time entries will remain in the media index before they are marked as recyclable. |
| directive | specifies the directive used for backing up a client. |
| group | specifies the group a client is a member of. The group controls when scheduled backups are performed on the client. |
| save set | lists the path names to be saved for a client. When a client requires different file systems to be saved on different schedules, a client resource is required for each file system and schedule. |
| priority | specifies the backup priority given to a client where priority 1 is the highest, 1000 is the lowest. Automated savegroup's will attempt to back up clients with higher priorities before clients with lower priorities. |
| remote access | specifies a users access to back up, browse, and recover a client's files. Additional users, hosts, and netgroups may be granted permission to access a client's files by adding their names to this attribute. Netgroup names must be preceded by an ampersand ('&'). Input of the form <user>@<host> or <host>/<user>, grants access to a client's files to the specified users. |
| remote user |
|
| password | is used by savegrp to initiate the commands savefs and save on a client machine. The commands savefs and save use the password to gain access to files being backed up. If a password is given, then the remote user attribute for the client resource must also be defined. |
| backup command | performs a remote backup of client's data and save sets. This command can also perform pre and post backup processes. The prefix of the specified value must begin with "nsr" or "save". |
| executable path | specifies the path used by the server for executing commands on the client. |
| server network interface | specifies the network interface the server uses for saves and recovers. |
| aliases | specifies the aliases for a client machine that queries can match. |
| owner -notification | sends the contents of status messages to the owner/primary user of a system. |
| statistics | consists of: the size of the client's on-line file index, the number of kilobytes used and the number of entries in the index. |
| index save set | specifies save set, residing in a client's file index, to purge when an index operation is set to purging oldest cycle. |
| index message | is the status message resulting from the previous index operation. |
| index operation start | indicates the starting time of the current index operation. This attribute is a null string ("") when the operation is "Idle". |
| index progress | indicates the progress an index has made towards finishing the current task. This attribute is blank when the operation is "Idle", and is expressed as a percentage. |
| index operation | specifies the current index operation. |
| parallelism | indicates the maximum number of saves that should be run simultaneously on a single client. |
| archive users | specifies the users given access to the archive services on a client. This attribute can only be set if archive support has been enabled on the server. |
| application information | specifies a client's application information. |
| storage nodes | specifies the storage nodes available to a client for saving data. A client's saves are directed to the first storage node that has an enabled device and a functional media service. |
| clone storage nodes | specifies the storage nodes available to a storage node whose data is being cloned. Cloned data originating from a storage node will be directed to the first storage node that has an enabled device and a functional media service. |
The following is an example of a NSR client resource used to define a client, called saturn, backing up all of its files to the 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:
| Attribute | Description |
|---|---|
| name | specifies the path name for a device. For systems that optionally support "Berkeley style" tape positioning on close, the BSD style tape device name should be used. For optical disks the path name is generally the "c" partition.
|
| media type | specifies the media type used by a device. Some of the possible values for this attribute are:
|
| enabled | indicates whether a device is available for use. |
| read only | indicates whether a device is reserved for read only operations, such as recover or retrieve. |
| target sessions | specifies the target number of saves for a device, and used for load-balancing. Once all the devices have reached their corresponding target number, additional sessions are allocated equally across all devices. |
| media family | specifies the class of storage media, as determined from the media type:
|
| message | specifies the last message from a server regarding a device, such as the progress or rate of an operation. |
| volume name | is monitors the mounting and unmounting of volumes for a device. |
| write enabled | indicates if writing to the current volume is allowed. |
| volume operation | manipulates media volumes currently in the device, through several operations:
|
| volume label | is set by the Verify label operation and may be an input to the Label operation. |
| volume default capacity | is 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 capacity | determines the capacity of a volume during the Label operation. |
| volume expiration | specifies a volumes expiration date, which is set by the Verify label operation. |
| volume pool | specifies the pool a volume belongs, or has been assigned to. |
| NSR operation | specifies the current operation being performed by the device. |
| minor mode | reports the current status of a device. |
| statistics | reports the statistics on the operation of a device. The statistics include:
|
| cleaning required | indicates whether a device needs to be cleaned. If the value of this attribute changes from yes to no and the value of date last cleaned is not updated then date last cleaned is set to the current time. 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 interval | specifies the amount of time from date last cleaned until the next scheduled cleaning for a device. |
| date last cleaned | records the time and day a device was last cleaned. |
| volume block size | specifies the block size of a currently mounted volume. |
| volume-id | specifies the volume id for a currently mounted volume. |
| access count | indicates the number of operations performed on a device since it's configuration as a device. |
| access weight | indicates the weight of a single operation performed on a device. Each time a device is used its weight is increased and the less often the device will be selected for new operations. |
| consecutive errors | specifies the current number of consecutive errors resident on a device. |
| max consecutive errors | indicates the maximum number of consecutive errors allowed before the device will be disabled. |
| operation arg | specifies extra parameters about a device operation. Parameters are packed into a string and parsed. |
| volume message | indicates the result of the volume's last operation. |
| volume write time | indicates the time a save set was first written onto the volume. |
| volume flags | indicates new flags for the volume to operated on, during a "Label" or "Label without mount" operation. |
| jukebox device | indicates if a media device is in a jukebox |
| unlabeled volume loaded | indicates whether a volume loaded into a device has a readable volume label. |
| auto media management | indicates whether automated media management for a device is enabled. If the value is set to yes then recyclable volumes loaded into the device may automatically be re-labeled by 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:
|
| logical name | specifies the name for a logical device. |
| logical type | specifies the type for a logical device. |
| logical family | is the family associated with a logical device. |
| connection process id | specifies the process identifier that maintains the connection between external media management services and a mounted volume. |
| connection message | specifies error messages reported by a process connected to an external media management service. |
| connection status | specifies the exit status reported by a process connected to an external media management service. |
| save mount timeout | indicates the timeout value from an initial save mount request for a storage node, on which a device resides. If a request is not satisfied, the storage node will be locked from receiving save assignments, for "save lockout" minutes. |
| save lockout | indicates the amount of time a storage node will be locked from receiving save assignments. |
The following is an example of a NSR device resource:
type: NSR device;
name: /dev/nrst8;
message: writing, done
volume name: mars.017;
media family: tape;
media type: 8mm 5GB;
enabled: Yes;
write enabled: Yes;
read only: No;
target sessions: 4;
volume label: mars.017;
volume default capacity: ;
volume current capacity: 5000 MB;
volume expiration: "Thu Sep 21 17:23:37 1996";
volume pool: Default;
volume flags: ;
volume operation: ;
volume write time: ;
volume block size: 32 KB;
volume id: 32449;
accesses: 199;
access weight: 1;
consecutive errors: 0;
max consecutive errors: 20;
operation arg: ;
volume message: ;
NSR operation: ;
minor mode: idle;
jukebox device: Yes;
statistics: elapsed = 257572, errors = 0, last rate = 397,
max clients = 3, file marks = 22, rewinds = 4,
files skipped = 1976, records skipped = 0,
current file = 2389, current record = 162,
seek files = 0, seek records = 0,
estimated kb = 0, amount kb = 6273,
file amount kb = 6273, sessions = 1;
cleaning required: No;
cleaning interval: 2 weeks;
date last cleaned: "Tue Apr 11 15:10:32 1995";
auto media management: No;
unlabeled volume loaded: No;
logical name: ;
logical type: ;
logical family: ;
connection process id: ;
connection message: ;
connection status: ;
save mount timeout: 30;
save lockout: 0;
NSR directive
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:
| Attribute | Description |
|---|---|
| name | specifies the name of a directive resource. Names are displayed as choices when creating or updating client resources. |
| directive | indicates 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:
| Attribute | Description |
|---|---|
| name | specifies the name of a group defined by the resource. The name is an option within the NSR client and NSR-pool resources. |
| autostart | determines if a group will be saved automatically on a daily basis. The following operations can be invoked by autostart:
|
| autorestart | controls whether a group is automatically restarted after an incomplete save. |
| stop now | aborts a groups save processes immediately. |
| start time | specifies the time of day when a group will begin a save. |
| last start | is the last time a group began a save. |
| interval | specifies how often a group runs an automatic save. |
| force incremental | forces an incremental backup of a savegroup, for an interval attribute less than 24 hours. |
| client retries | indicates the number of times failed clients should be retried before savegroup declares them failed. A client's save sets are retried by savegroup whenever savegroup would otherwise not be able to start a new save set. |
| clones | causes saves of a group to automatically make a clone for every save set backed up. |
| clone pool | specifies the pool where save set clones are sent. |
| options | specifies the options indicated for a group's save. |
| level | indicates 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. |
| printer | specifies the printer to which bootstrap save set information will be printed to. |
| schedule | specifies the level of save that will be performed. |
| schedule time | specifies the time a save will be performed. |
| inactivity timeout | is the time a savegroup command waits for any kind of activity from the server before concluding that a savegroup descendant is hung. |
| work list | indicates the saves still not completed. The worklist indicates; the client name, the level of save, and the path to save. |
| completion | indicates the status of each save set that has been completed. |
| status | indicates the current status of a NSR group:
|
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:
| Attribute | Description |
|---|---|
| name | specifies the name of a jukebox. |
| model | specifies the jukebox model. |
| physical slots | specifies the first and last physical slot numbers in the jukebox. The first slot number must be less than or equal to the last slot number, and specified as two separate attribute values. For Silo Tape Libraries this attribute is equal to the number of volumes allocated to a server. |
| control port | specifies the path of the control port, for the jukebox robotics. Control commands are then sent to the jukebox, from the control port. For Silo Tape Libraries this attribute specifies the hostname and type of the Silo Tape Libraries server. |
| devices | identifies device pathnames for each device residing within a jukebox. The entries are listed in the same order as they were physically installed in the jukebox. |
| number devices | identifies the number of configured devices in the jukebox. |
| write enabled | indicates if the mounted volume can be written to. |
| bar code reader | indicates if is using the bar code label from the media when a jukebox has a bar code label reader. |
| match bar code labels | indicates if is using the bar code label, instead of a label template, when labeling media volumes. |
| volume expiration | specifies the expiration time for a volume that is currently being labeled, or specifies the time a volume within a jukebox will end interaction with external media management services. |
| available slots | specifies 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 code | identifies the enabler code for a NSR license resource corresponding to a jukebox resource. |
| operation | identifies the current jukebox operation. |
| operation message | displays error messages when an jukebox operation fails. |
| operation device | passes device names to current operations. |
| operation slots | passes slots to current operations. |
| operation options | passes the mode of a volume to the current operation. |
| operation barcodes | passes volume tags or barcodes to the current operation. |
| operation response | identifies the default response to questions asked while performing an operation. |
| operation report mode | identifies the amount of output generated during operation execution. |
| operation label state | designates the operation to be performed on a labeled volume as; to be recycled or to be unlabeled. |
| operation volume capacity | specifies a volume's capacity. |
| operation volume type | specifies the types of volumes that may be considered when allocating a volume. |
| operation ineligible | specifies volumes ineligible for the current operation. |
| operation task | designates a secondary task or operation to be performed with the current operation. |
| operation result | reports error messages for multiple operations. This attribute maintains error messages for 32 simultaneous operations performed on a jukebox, that failed. |
| operation instance | specifies the instance number associated with an operation. |
| operation next instance | specifies the instance number associated with the next simultaneous operation. |
| operation instances | specifies the instance number for each simultaneous operation currently executing. |
| operation hostname | identifies the name of the system an operation is to executed.This attribute is used for jukeboxes who support devices, attached to multiple hosts, where the host machine may be inferred from other attributes, such as operation device. |
| operation template | specifies the template a label operation will use. |
| operation volume pool | specifies the default volume pool for label operations. |
| operation source pool | specifies the pool a volume will be selected for recycling. |
| operation uses left | indicates the number of times a cleaning cartridge can used. |
| volumes | specifies the names of resident volumes in corresponding order to the slot number. |
| volume ids | specifies the volume identifiers (volid) for resident volumes. |
| volume cartridge ids | tracks the identifier for each cartridge h a volume resides. |
| loaded volumes | contains the names of volumes currently loaded in jukebox devices. |
| loaded bar codes | identifies the bar codes of loaded volumes. |
| loaded slots | identifies the slot numbers of loaded volumes. |
| event tag | specifies the tag of the last notification event sent to the nsrd service |
| event message | is the text of the last notification event sent to the nsrd service. |
| messages | specifies the log messages from previous operations nsrjb has completed. |
| minimum space | specifies the low water mark of the remaining space on the volumes contained in the available slots. |
| jukebox options | specifies the options for this jukebox. |
| auto clean | specifies automatic cleaning for each device. |
| cleaning slots | identifies the range of slots in a jukebox that have been set aside for cleaning cartridges. For a pair of slot numbers the first number of the pair is less than or equal to the second. When auto clean is set to yes the range of slots specified for this attribute are assumed to contain cleaning cartridges, and the range of slots specified by available slots. |
| default cleanings | specifies the number of uses assigned to a new cleaning cartridge during an inventory of a jukebox by nsrjb. |
| auto media management | indicates whether automated media management for a jukebox is enabled. If the value is set to yes, unlabeled volumes in a jukebox may be automatically labeled. |
| STL device names | specifies silo device names of the devices identified in the devices attribute of a Silo Tape Library. |
| STL interface lib | indicates the path name of the dynamically linked Silo Tape interface library. |
| STL device sharing | specifies, how device sharing is handled. Device sharing is the automatic, load dependent, device switching for devices within a Silo Tape Library between different connected hosts. When this attribute is specified as "perm-max", perm and max are numbers with perm < max, and perm is the number of devices, which can be reserved permanently. |
| STL barcodes | indicates the barcodes of the volumes residing within in a Silo Tape library, which are available to . |
| STL device reservation | specifies the reservation state of shared devices in a Silo Tape library. |
| allocated devices | specifies jukeboxes allocated to RLM. |
| application name | specifies the name used by a server to identify itself to OpenVault when submitting a request to access resources on a jukebox. |
| application key | specifies the key used by a server to identify itself to OpenVault when submitting a request to access resources on jukebox. |
| jukebox lock | synchronizes access to resources in a jukebox that supports multiple simultaneous operations. This attribute can be used to lock and unlock a entire jukebox. |
| device locks | synchronizes access to device resources in a jukebox that supports multiple simultaneous operations. The first two numbers of this attribute identify a range of devices locked, and the third number is the instance number assigned to the lock operation. |
| volume/slot locks | synchronizes access to volume and slot resources in a jukebox. The first two numbers of this attribute identifies the range of volumes/slots locked and the third number is the instance number assigned to the operation holding the lock. |
Following is an example of a NSR 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:
| Attribute | Description |
|---|---|
| name | specifies the name of a label template. |
| fields | 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:
|
| separator | specifies a character separator for field labels. |
| next | 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
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:
| Attribute | Description |
|---|---|
| name | specifies the name of the license resource. |
| enabler code | specifies the code entered into the nsrcap command to enable the feature named in this resource. |
| host id | specifies the unique host id associated with the computer or licensed operating system. |
| expiration date | specifies the date an enabler will expire, if the enabler is an evaluation enabler or un-registered license enabler. |
| auth code | permanently authorizes an enabler. An unique, valid authorization code for an enabler is obtained from Legato through the registration of each purchased license enabler.IMPORTANT:
|
| license type | describes the specific feature(s) enabled. |
| checksum | maintains 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:
| Attribute | Description |
|---|---|
| name | identifies the client and save set whose migration attributes are stored in this resource. |
| client | identifies the HSM client whose save sets are to be placed under migration control. |
| save set | specifies the path names of filesystems or sub-trees to place under migration control for the specified client. |
| enabled | specifies whether a save set named in a resource will be automatically migrated. |
| directive | indicates to the client how to migrate certain files. The choices are defined by the existing directives. |
| group | indicates 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 time | specifies 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 owner | specifies the users whose files to be migrated. |
| file group | specifies a groups whose files are to be migrated. |
| preserve | indicates regular expressions, in a client's shell syntax. |
| statistics | specifies statistics about recent migration activity for save set(s) managed using a resource. |
| update statistics | controls 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:
| Attribute | Description |
|---|---|
| name | specifies the name of a notification resource. |
| event | specifies a class of events that will trigger a given notification. The valid classes are:
|
| priority | specifies the priority at which a notification will be triggered. The valid values in increasing priority order are:
|
| action | 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: /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:
| Attribute | Description |
|---|---|
| name | specifies the name of the policy defined by this resource. This name will appear as an option of each NSR client resource. |
| period | indicates the base unit for a policy as one of the following values:
|
| number of periods | 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
This resource determines where volumes save sets reside based upon their characteristics.
There are four types of pools:
| Type | Description |
|---|---|
| Backup | accepts data from savegroup and manual backups. |
| Archive | accepts archive data. |
| Backup clone | where data from a backup pool can be cloned to. |
| Archive clone | where archive data can be cloned to. |
There are four pre-enabled pools shipped with:
| Type | Description |
|---|---|
| Default | collects any backup data that is not directed to a customized pool. |
| Archive | collects any archive data not directed to a customized pool. |
| Default clone | is available to clone backup data to. |
| Archive clone | 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:
| Attribute | Description |
|---|---|
| name | specifies the name of pool resources used when labeling volumes and determines which volumes a save set will reside. |
| groups | specifies the groups allowed in a pool. |
| clients | specifies the clients allowed in a pool. If a group is specified, clients that are members of that group can be listed. |
| save sets | indicates the save sets allowed in a pool. Save sets can be matched using regular expression matching. |
| levels | specifies the levels allowed in the specified pool. |
| archive only | enables archive only saves for a pool. |
| status | indicates the status of a pool as one of the following:
|
| label template | specifies the label template referenced when generating volume names for a pool. |
| devices | indicates a devices volumes within this pool that are allowed to be mounted to. |
| store index entries | 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. |
| auto media verify | 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. |
| recycle to other pools | specifies whether or not a given pool allows other pools to recycle its recyclable volume for their use. |
| recycle from other pools | specifies whether a given pool can recycle volumes from other pools when it exhausts all of its write-able and recyclable volumes. |
| volume type preference | 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;
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:
| Attribute | Description |
|---|---|
| name | specifies a schedule's name used by a client. |
| period | specifies the length of a schedule. It may be either "Week" or "Month." |
| action | 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, will repeat the list of actions when the end of the action list is reached. |
| override | 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
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:
| Attribute | Description |
|---|---|
| name | specifies the staging policy name. |
| enabled | 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. |
| max storage period | specifies 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 selection | specifies the save set selection criteria for staging. It may be one of four values:
|
| Destination pool | specifies the pool save sets should be sent. |
| Devices | specifies the file type devices are associated with. |
| Recover space interval | specifies the number of hours between recover space operations for save sets with no entries in the media database form file devices. |
| FS check interval | specifies the number of hours between file system check operations. |
| Start now | specifies the selected operation to be triggered immediately on all devices associated with a policy. Operation can be one of the following:
|
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:
| Attribute | Description |
|---|---|
| type | defines the attributes a resource can contain. |
| name | specifies the descriptive name of an object that a resource represents. |
| administrator | 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. |
| hostname | specifies the hostname of the system where a service that controls the specified resource is running. |
| ONC program number | specify the Open Network Computing information for a service. |
| ONC version number | |
| ONC transport |
nsradmin Resources
The NSR defines the following types of resources:
| Resource | Description |
|---|---|
| NSR | describes a server. It contains attributes that control administrator authorization, information about operations in progress, and statistics and error information about past operations. |
| NSR client | describes a client. It includes attributes that specify the files to save, which schedule to use, and which group this client belongs to. |
| NSR device | describes a storage device. It includes attributes that specify a particular device name, media type, and name of the currently mounted volume. |
| NSR directive | describes a directive. Directives control how a client's files are processed as they are being saved. |
| NSR group | specifies a logical grouping of clients and a backup starting time. |
| NSR jukebox | 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. |
| NSR label | specifies a template describing a sequence of names to be used when labeling volumes. |
| NSR license | contains licensing information for each feature currently enabled. It contains various enabler and authorization codes used by to validate licensed capabilities. |
| NSR notification | specifies an action to be performed when a particular type of event takes place. |
| NSR policy | 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. |
| NSR pool | is used by to determine where volume save sets should reside on based on the characteristics of the save. |
| NSR schedule | 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. |
This document was originally published by Legato in 1998. However, lost in the ether so reproduced here out of courtesy.