Release 3 (8.1.7) for Windows 2000 and Windows NT
Part Number A85377-01
 Library |
 Product |
 Contents |
 Index |
| Legato Storage Manager Command Reference Guide Release 3 (8.1.7) for Windows 2000 and Windows NT Part Number A85377-01 |
|
MM data - Legato Storage Manager media multiplexor data (tape and disk) format
This documents the data format that the Legato Storage Manager media multiplexor daemon, nsrmmd(8), writes to long term storage media such as tapes and optical disks. See nsr_device(5) and nsrmm(8) for a discussion of supported device families and types. The format described here applies to any fixed record device, such as raw disks, or fixed record tape devices with file marks. Legato Storage Manager uses the eXternal Data Representation (XDR) standard to write media which can be interchanged among a wide variety of machines. Only the mechanism used to multiplex save set streams onto the storage media is described here; the formats of save set streams depend on the type of Legato Storage Manager client, and are described in nsr_data(5).
A volume is one physical piece of media such as a tape reel or disk cartridge. A tape volume is made up of multiple media files, and each media file may contain several media records. These media files and records should not be confused with a client's (for example UNIX or DOS) user files or records; the two do not necessarily correspond. For example, a given media file or even a single media record may contain many small client user files. On the other hand, a single large client file may be split across several media files, and even across several volumes. Media files do not span volume boundaries. Save sets may span media files and even volumes.
On most tapes, media files can be skipped very quickly by the device's hardware or associated device driver software, and the hardware can detect when an end of a file has been reached. On some tapes, records can also be quickly skipped forward. Otherwise, access to the media is sequential.
Media records are described by the mrecord structure. Label records are fixed in size, MINMRECSIZE bytes. Other records can potentially be a larger size that must be some constant for the rest of the volume. Legato Storage Manager always writes, reads and skips data in units of full-sized media records. Each mrecord contains zero or more mchunks of data from either one or more client save sessions, or used internally for synchronization and labels. The XDR format of a media file's mrecords and mchunks are as follows:
const MINMRECSIZE = 32768; /* minimum media record size */ const MMAXCHK = 2048; /* max number of chunks in record */ const MHNDLEN = 124; /* private area len for handlers */ typedef unsigned long ssid_t; /* save set id */ typedef unsigned long ssoff_t; /* an offset in a save set */ typedef unsigned long volid_t; /* key for the volume data base */ struct mchunk {
ssid_t mc_ssid; /* owning save set id */ ssoff_t mc_low; /* 1st byte, relative to save stream */ opaque mc_data<MINMRECSIZE>; /* chunk's data */
};
struct mrecord {
opaque mr_handler[MHNDLEN]; /* private to media handler*/ u_long mr_orec; /* record size */ volid_t mr_volid; /* encompassing volume's id*/ u_long mr_fn; /* encompassing file number*/ u_long mr_rn; /* record number within the file */ u_long mr_len; /* record byte length */ mchunk mr_chunk<MMAXCHK>; /* chunks of save streams */
};
The first field of an mrecord, mr_handler, is reserved for media-specific data (currently it is not used by any implementation). The mr_orec field is the size of the current record. A media record's header fields, mr_volid, mr_fn, and mr_rn, are used to check the tape position and the data read from the record. The file numbers and record numbers start at zero and increment sequentially. The record number is reset each time the file number is incremented. On disks, file numbers are always zero. The mr_len field is the actual number of valid bytes in this record, as opposed to the size of the device's read or write request.
If file or record skipping is unreliable, Legato Storage Manager can still recover from isolated errors, at worst by rewinding and reading the tape from the start. If a volume can be physically unmounted or mounted without notice to the media management daemon, then the volume identifier in each record provides a quick way of verifying when this happens, without the need for a full rewind and reading of the label in most cases.
The mchunks within an mrecord contain client data from one or more save sessions. The mc_ssid and mc_low values are used to reconstruct the save streams from the chunks within the records. The mc_data field holds the actual data of each chunk. For a given save set, mc_low plus the length of mc_data should equal the following chunk's value for mc_low. Save sets may by intermingled arbitrarily within media records.
The first chunk of the first record of the first media file on the volume encapsulates the volume label information; for some media, the second chunk contains additional volume information, for example the media pool the volume belongs to; subsequent data in the first file is reserved for future expansion. The label may be duplicated in a second file for redundancy, in case the first copy of the label gets accidentally overwritten. The formats of the volume label and additional label information are described by the following XDR data structures:
const MVOLMAGIC = 0x070460; /* volume magic number */ const NSR_LENGTH = 64; /* length of several strings */ const RAP_MAXNAMELEN = 64; /* max length of attribute name */ struct mvollabel {u_long mvl_magic; /* medium volume verification number */ u_long mvl_createtime; /* time at which volume labeled */ u_long mvl_expiretime; /* time for volume to expire */ u_long mvl_recsize; /* expected size of mrecords */ volid_t mvl_volid; /* medium volume id */ string mvl_volname<NSR_LENGTH>; /* medium volume name */};
struct vallist {vallist *next; string value<>; /* attribute value */};
struct attrlist {attrlist *next; string name<RAP_MAXNAMELEN>; /* attribute name */ vallist *values; /* attribute values */};
/* * Additional information may includes the following attributes (listed by the
* name they are stored with): "volume pool" : the media pool
*/
struct mvolinfo {struct attrlist *mvi_attributes; /* any other information */};
The mvl_magic field must be equal to MVOLMAGIC in order for the chunk to represent a valid volume label. If the volume label changes in the future, the new format will have another ``magic'' number, but the format described here must still be allowed. The mvl_volid is an internal identifier assigned and managed by the media manager. The mvl_volname is the volume name that is assigned when the media is first labeled. The time fields are in UST format - the number of seconds elapsed since 00:00 GMT, January 1, 1970. The mvl_recsize is the size of all subsequent media records found on the tape.
The mvp_pool is the pool name that is assigned when the media is first labeled. Different media pools allow administrators to segregate their data onto sets of volumes. Media cannot be reassigned from one media pool to another. Pool names are a maximum of NSR_LENGTH characters long.
Synchronization marks, called schunks, are also written periodically to the media for each save set. Synchronization chunks are used by scanner(8) when verifying or extracting directly from a volume. They are also used by nsrmmd when trying to recover from media errors during file recovery. The following XDR data structure describes a synchronization chunk:
struct schunk {opaque ssi_host[NSR_LENGTH]; /* save set host */ opaque ssi_name[NSR_LENGTH]; /* symbolic name */ u_long ssi_time; /* save time */ u_long ssi_expiry; /* expiration date */ u_long ssi_size; /* actual size saved */ u_long ssi_nfiles; /* number of files */ ssid_t ssi_ssid; /* ssid for this save set */ u_long ssi_flag; /* various flags, see below*/ u_long ssi_info; /* volid or ssid, see below*/};
#define SSI_START 1 /* start of a save set */ #define SSI_SYNC 2 /* synchronization point */ #define SSI_CONT 3 /* continued from another volume */ #define SSI_END 4 /* end of this save set */ #define SSI_SSMASK 0x0000000f /* save set sync chunk type*/ #define SSI_LBIAS 0x10000000 /* the level is included in the flags */ #define SSI_LMASK 0xff000000 /* mask to cover bits for level */ #define SSI_LSHIFT 24 /* shift amount for the level */ #define SSI_INCOMPLETE 0x00010000 /* not finished (aborted) */ #define SSI_CONTINUED 0x00800000 /* continued save set series */
The ssi_host is the name of the index which contains this save set. Traditionally this is the host name of the client where the save set originated. The ssi_name is the save set name to be presented to the user. These are both null-terminated strings, even though the fields are fixed length. The ssi_time field contains the create time of the save set in UST. The ssi_expiry field is the expiration date, in UST for this save set. This field is zero if an explicit save set expiration time was not specified when the save set was created. The ssi_size and ssi_nfiles are the number of bytes and number of files saved so far for this save set. The ssi_ssid is the save set identifier of this save set.
The ssi_flag indicates the type of this synchronization chunk, the level of save set, and other information about the save set. There are four basic types of synchronization marks that can be found from examining ssi_flag &
SSI_SSMASK. SSI_START is used to mark the beginning of a save set. SSI_SYNC marks a periodic synchronization point and is only written at an exact file boundary in the save set. SSI_CONT indicates that this is the continuation of a save set that started on a different volume. When ssi_flag & SSI_SSMASK is SSI_CONT,
ssi_info contains the volume identifier for the save set's preceding volume. These synchronization chunks are used when a save set spans a volume boundary.
SSI_END marks the end of a save set.
If the SSI_LBIAS bit is set then ssi_flag & SSI_LMASK shifted right by
SSI_LSHIFT specifies the level of the save set. The SSI_INCOMPLETE bit indicates that this save set did not finish properly. This could be caused by a user interrupting an in progress save.
The SSI_CONTINUED bit indicates that this save set is logically continued to or from another save set. These continued save sets are used to handle very large save sets. If the SSI_CONTINUED bit is set and ssi_flag & SSI_SSMASK is
SSI_START, then ssi_info gives the previous save set id that this save set was continued from. If the SSI_CONTINUED bit is set and ssi_flag & SSI_SSMASK is SSI_END, then ssi_info gives the next save set id that this save set is continued to.
|
See Also:
nsr_device(5), nsr_data(5), nsrmm(8), nsrmmd(8), nsrmmdbd(8), nsr(8), scanner(8). RFC 1014 XDR: External Data Representation Specification |
mminfo - Legato Storage Manager media database reporting command
mminfo [ -avV ] [ -o order ] [ -s server ] [ report ] [ query ] [ volname... ]
report:
[ -m | -B | -S | -X | -r reportspec ]
query:
[ -c client ] [ -N name ] [ -t time ] [ -q queryspec ]
The mminfo command reports information about Legato Storage Managers media and save sets. The mminfo command can produce several different reports depending on the flags specified. Several built-in reports can be specified using short-hand flags. Custom reports can also be specified. The default report, along with the built-in reports printed by the use of the -v, -V, -m, -S, -B, and -X flags, are described first below. The custom query and report generators, using the
-q queryspec and -r reportspec options, are described in the Custom Queries and Reports section. Other options are described in the Options section.
Without any options, mminfo displays information about the save sets that completed properly during the last twenty four hours, and are still contained in an on-line file index (browsable save sets). The following information is printed for each save set: the containing volume name, the client's name, the creation date, the size saved on that volume, the save set level, and the save set name. The size field is displayed in Bytes (B), KiloBytes (KB), MegaBytes (MB) or TeraBytes (TB). The save set level will display `full', `incr', `migration' or 1 through 9, for full, incremental, migration save sets, level 1 through 9, respectively. The level is only kept for scheduled saves and file migration; save sets generated by explicitly running the save(8) command (called ad hoc saves) do not have an associated level.
Specifying the -v flag causes three additional fields to be displayed: the creation time, the internal save set identifier (ssid), and two flags. One character is used per flag.
The first flag indicates which part of the save set is on the volume. When the save is completely contained on the volume, a c is displayed. An h is displayed when the save set spans volumes and the head is contained on this volume. The remaining sections will be on other volumes. An m is displayed when the save set spans volumes and a middle section is contained on this volume. The head and tail sections will be on different volumes. There may be more than one middle section. A t is displayed when the tail section of a spanning save set is contained on this volume. Again, the other sections will be on other volumes.
The second flag indicates the status of the save set. A b indicates that the save set is in the on-line index and is browsable via the recover(8) command. An r indicates that the save set is not in the on-line index and is recoverable via the scanner(8) command. An E indicates that the save set has been marked eligible for recycling and may be over-written at any time. An S denotes that the save set was scanned in (or rolled in). Rolled in save sets are not subject to the standard index management procedures and will remain in the file index until the user manually purges the save set. An a indicates that the save was aborted before completion. Aborted save sets are removed from the on-line file index by nsrck(8). An i indicates that the save is still in progress. The -v flag prints aborted, purged, and incomplete save sets in addition to the complete, browsable save sets printed by default.
The -V flag displays even more detail than the -v flag, and is generally used for debugging. This format also displays information (i.e. media file number and record number) that can be used to speed the operation of the scanner(8) command. Rather than displaying one line per save set per volume, two lines are displayed each time a section of a save set occurs within a file on a volume. A single save set will have multiple index entries if it starts in one file on a volume and ends in another. The first line will contain the fields similar to those described for the default output, above, with two differences. First, the size field will now list the number of bytes that are contained in the section, rather than the total amount of the save set on this volume. Second, both the creation date and the time are shown. The second line contains the following fields: the save time in seconds since 00:00:00 GMT, Jan 1, 1970, the internal save set identifier (ssid), the offset of the first and last bytes of the save set contained within section, the media file number, the first record within the media file containing data for this save set, the internal volume identifier (volid), the total size of the save set, and the flags, described in the -v paragraph above, indicating which part of the save set is contained in this media file (c, h, m, or t) and the save set's status (b, r, a, or i).
The -m flag causes mminfo to display the name of each volume in the media database, the number of bytes written to it, the percent of space used (or the word `full' indicating that the volume is filled to capacity), the number of bytes read, the expiration date, the number of times the volume has been mounted, and the volume's capacity. Volumes that are recyclable (see nsrim(8)) are flagged by an E in the 1st column (meaning Eligible for recycling). If a volume has been marked as manually-recyclable, an M is displayed instead of the E. If a volume is both manually-recyclable and eligible for recycling, an X will be displayed. Archive and migration volumes are flagged by an A, also in the 1st column. If the volume is not an archive or migration volume, and is not recyclable, no flag appears.
Specifying the -v flag with the -m flag causes three additional fields to be displayed: the internal volume identifier (volid), the number of the next file to be written, and the type of media.
Using a -V flag with the -m adds a column of flags to the output. There are currently two possible flags. The d flag is set if the volume is currently being written (dirty). The r flag is set if the volume is marked as read-only. If neither condition is present, the flags column will be empty.
The -S flag displays a long, multi-line save set report, which is used for debugging. The number of lines varies per save set. Due to the length, there are no column headers. Instead, each attribute of the save set is displayed in a `name=value' manner, except the client and save set name, which are displayed as `client:name'. The first line of each multi-line group starts on the left margin and includes the save set identifier (ssid), save time as both a date/time string and seconds since 00:00:00 GMT, Jan 1, 1970, and the client and save set names. Subsequent lines for this save set are indented. If the save set is part of a save set series (a `continued save set') and is not the first in the series, the save set identifier of the previous save set in the series in shown on the second line by itself. The next line displays the level, the save set flags (in `ssflags' format, as described in the table in the Custom Queries and Reports section), the save set size in bytes, the number of files in the save set, and the save set expiration date (`undef' means the expiration date is determined by the current policies for the client). If the save set has extended attributes, they are printed next, at most one attribute per line. The clones or instances of the save set are shown last (every save set has at least once instance). The first line of each clone shows the clone identifier, the date and time the instance was created, and the per-clone flags (in `clflags' format from the Custom Queries and Reports table). For each instance, each section of that instance is shows as a fragment line. The fragment line shows the offset of that fragment from the beginning of the save set, the volume identifier (volid) containing the fragment, the media file and record numbers of start of the fragment, an absolute positioning identifier (unused by existing servers), and the date of last access of the fragment. The -v and -V options have no effect on this report.
The -X flag prepares a save set summary report instead of one or more lines per save set. Note that the entire media database must be examined to resolve this query, making it very slow and expensive. The summary lists the total number of save sets, and breaks the total down into several overlapping categories summarizing the save set types. The recent save set usage, if appropriate to the query, is also printed. The categories are the number of fulls, the number of incrementals, The number of other non-full, non-incremental saves, the number of ad hoc, archive, migration, empty and purged save sets, the number of index save sets, and finally, the number of incomplete save sets. For recent usage, the number of save sets per day are shown, up to a week ago, along with a summary of the week's save sets and, if applicable, a summary of the month's save sets. For each line, the number of files (saved in the time interval specified), number of save sets, total size, and average size per save set, and average size per file, are listed. The percentage of the amount saved for incrementals v.s. fulls and the percentage of browsable files are also printed, when appropriate. The -v and -V options have no effect on the summary report.
The -B flag performs a canned query to output, in a convenient format, the list of bootstraps generated in the previous five weeks. In this format, there is one line of output for each matched save set. Each line contains the save date and time, save level, save set identifier (ssid), starting file number, starting record number, and the volume. The equivalent query is described below in the Examples section. The -v and -V options have no effect on the bootstrap display.
-a
Causes queries to apply to all complete, browsable save sets, not just those in the last 24 hours. This option is implied by the -c, -N, -q, -m, and -o options, described below. When combined with a media-only report (-m or a custom report showing only media information), -a applies to all volumes, not just those with complete and browsable save sets.
-c client
Restricts the reported information to the media and/or save sets pertaining to the specified client.
-m
Display a media report instead of the default save set report (in other words, a report about the media containing save sets, not the save sets themselves).
-N name
Restricts the reported information to the media and/or save sets pertaining to the specified save set name.
-o order
Sort the output in the specified order. Before displaying the save sets, they are sorted by various fields. Numeric fields are sorted least to greatest, other fields are sorted alphabetically. order may be any combination of the letters celmontR, representing client, expiration date, length, media name, name of save set,
offset on media (file and record number), time, and Reverse, respectively. The default sorting order for save set reports is mocntl. The offset fields (file and record) are only considered when the -V option has been selected and for custom reports that show save set section (fragment) information. When applied to -m media-only reports, the length is the amount used on the volume, the expiration date applies to the volume, the time is the last time the media was accessed, and the other order flags are ignored.
-q queryspec
Adds the given query constraint to the list of constraints on the current query. Multiple -q options may be given. See the Custom Queries and Reports section below for the syntax of the queryspec.
-r reportspec
Appends the given report specification to the list of attributes to be displayed for the current query. Multiple -r options may be given. See the Custom Queries and Reports section below for the syntax of the reportspec.
-s server
Display volume and save set information from the Legato Storage Manager system on server. See nsr(8) for a description of server selection. The default is the current system.
-t time
Restricts the reported information to the media and/or save sets pertaining to the save sets created on or after time. See nsr_getdate(3) for a description of the recognized time formats. The default is `yesterday'.
-v
Turn on the verbose display reports, described above.
-B
Run the canned query to report bootstraps which have been generated in the past five weeks, as described above. This option is used by savegrp(8) when saving the server's index and bootstrap.
-S
Displays a long, multi-line save set report, as described above.
-V
Displays additional verbose report output, as described above.
-X
Prepare a summary report, as described above.
The custom query and report options of mminfo allow one to generate media and save set reports matching complex constraints without resorting to pipelines and scripts. This section describes the syntax of custom query and report specifications, and gives some simple examples. Further examples are shown in the Examples section, below.
The custom query option, -q queryspec, is an extension to the short-hand query options, such as -c client, which allow you to make queries based on almost any media or save set attribute in the database, and allow various comparisons in addition to the simple equality comparison provided by the short-hand options. The format of a queryspec is
[!] name [ comp value ] [ , ... ]
where name is the name of a database attribute, listed in the table below, comp is a valid comparator for the attribute, from the set `>', `>=', `=', '<=', '<', and value is the value being compared. Leading and trailing spaces can be used to separate the individual components of the specification. The comparator and value must be specified for all but flag attributes. Generally numeric attributes allow all five comparators, and character string attributes generally only allow equality. When comparing flags, whose values are normally `true' and `false', one may alternatively use the `[ ! ] name' syntax. The `!name' form is equivalent to `name=false', and `name' by itself is equivalent to `name=true'. The comparisons in the specification are separated by commas. If a time or a string contains commas, you must quote the value with single or double quotes. Quotes are escaped within a string by repeating them. The following is a valid string comparison:
name="Joe's daily, ""hot"" Save Set"
Note that command line shells also interpret quotes, so you will need to enclose the entire query within quotes, and quote the single value inside the query, possibly with a different kind of quote, depending on the shell. Except for multiple character string values, explained below, all of the specified constraints must match a given save set and/or media volume before a line will be printed in the report. Multiple -q options may be specified, and may be combined with the short-hand query constraints -c, -N and -t. The order of the above query constraints is unimportant.
Numeric constraints, except for identifiers (volume, save set and clone identifiers) allow ranges to be specified, and all character string constraints allow multiple possible values to be specified. Note that times and levels are considered to be numeric values, not character strings. The upper and lower bounds of a numeric range are specified as two separate constraints. For example,
%used>20,%used<80
matches volumes that are between 20% and 80% used. Each possible value of a given character string attribute is specified as a separate equality constraint. For example,
client=pegasus,client=avalon
matches save sets from the client `pegasus' or the client `avalon'.
The custom report option, -r reportspec, allows one to specify exactly which media and save set attributes should be shown in the report, the order of the columns, the column widths, and where line breaks should be placed. The format of a reportspec is
name [ (width) ] [ , name [ (width) ] ... ]
where name is the name of a database attribute, listed below, and the optional width, enclosed in parentheses, specifies how wide the column should be. Leading and trailing spaces are ignored. The default column width depends on the attribute; default widths are also shown in the table, below. Multiple -r options may be specified. The order of the columns in the report will be left to right, and correspond to the order of the attribute names specified. Each line of output will contain all of the data requested (you can cause line breaks within a logical line by using the newline attribute name). If a value does not fit in the requested column width, subsequent values in the line will be shifted to the right (values are truncated at 256 characters).
The table below lists all of the recognized attribute names, their valid range of query values (or `NA' for attributes that are only valid for report specifications), their default column width in characters (or `NA' for flag attributes that are only valid for query specifications), and a short description. Numeric attributes (shown as number in the valid range column of the table) can be specified using any of the comparators listed above, and can be used in range comparisons. The =number attributes have the same characteristics as number attributes, with the exception that only numeric equality comparisons are allowed. Flag attributes have the values `true' or `false', only apply as query constraints, and have corresponding flag summary strings for report specifications. Time attributes are specified in
nsr_getdate(3) format and are otherwise treated as numeric attributes (note that you will need to quote times that contain commas). The special time `forever', when used as an expiration date, means a save set or volume will never expire. The special time `undef' is displayed when the time is undefined. Undefined expiration dates mean a save set will expire depending on its client's retention and browsability policies. When output, times are displayed as MM/DD/YY HH:MM:SS for numeric month, day year (last two digits), hours, minutes, and seconds, respectively. If the column is very narrow (less that 14 characters), only the date is shown, columns less than 17 characters wide drop the seconds, columns 17 or more characters wide print the full date. Size and kbsize attributes may have a scale factor appended to them, `KB' for kilobytes, `MB' for MegaBytes, `GB' for GigaBytes and `TB' for TeraBytes. The default scale (when no scale is explicitly specified) on query constraints for size attributes is bytes; the default for kbsize attributes is kilobytes. The scale varies in reports, depending on the actual value. String attributes may be any arbitrary character string, enclosed in quotes if necessary, as described above in the query syntax paragraph.
attribute value width description name range space NA 1 White space before the next column. newline NA 1 Line break(s) within a logical line.Width is actually the number of newlines desired. volume string 15 The volume name. volid =number 11 The unique volume identifier. barcode string 15 The volume barcode, when set. family string 4 The media family (eg. tape, disk). type string 7 The media type (eg. 8mm, optical). volflags NA 5 Volume summary flags, d and r,for dirty (in use) and read-only. state NA 3 Volume state summary, E, M, X and A, meaning eligible for recycling, manually-recyclable, both, and archive or migration volumes, respectively. full flag NA Matches full volumes. inuse flag NA Matches in-use (dirty) volumes. volrecycle flag NA Matches recycleable volumes. readonly flag NA Matches read-only volumes. manual flag NA Matches manually-recyclable volumes. pool string 15 The pool containing the volume. location string 15 The volume's location. capacity size 8 The volume's estimated capacity. written kbsize 7 Kbytes written to volume. %used number 5 Estimated percentage used, or `full' or `full' for volumes marked as full. read kbsize 8 Kbytes read (recovered) from the volume. next number 5 Next media file for writing. nrec number 5 Next media record for writing. volaccess time 9 Last time volume was accessed (written to or labeled). Old servers do not provide this value reliably. volexp time 9 Volume expiration date. olabel time 9 The first time the volume was labeled. labeled time 9 The most recent time the media volume was (re)labeled. mounts number 6 Number of times the volume was mounted explicitly (reboots do not count). recycled number 4 Number of times the volume was relabeled. avail NA 3 Summary of volume availability, current valid values, n meaning nearline (ie. in a jukebox), and ov meaning the volume is being managed by SmartMedia. near flag NA Matches nearline volumes. smartmedia flag NA Matches volumes managed by SmartMedia. metric number 6 Volume speed and desirability metric (unused by existing servers). savesets NA 6 Number of save sets on a volume. name string 31 The save set name. savetime time 9 The save time. nsavetime NA 11 The save time, printed as seconds since 00:00:00 GMT, Jan 1, 1970. ssid =number 11 The unique save set identifier. level 0..9, 5 The backup level. Manual backups are printed as full, incr, blank column migration values in reports. or manual client string 11 The client name for the save set. attrs NA 31 The extended save set attributes. pssid =number 11 When part of a save set series, the previous save set identifier in the series, zero for the first or only save set in a series. ssflags NA 7 The save set flags summary, one or more characters in the set CvrSENRiIF, for continued, valid, purged (recoverable), scanned-in (rolled-in), eligible for recycling, NDMP generated, raw, incomplete,in-progress and finished (ended),respectively. continued flag NA Matches continued save sets. recoverable flag NA Matches recoverable (purged) save sets. ssrecycle flag NA Matches recyclable save sets. incomplete flag NA Matches incomplete save sets. rolledin flag NA Matches rolled-in save sets. NDMP flag NA Matches NDMP save sets. raw flag NA Matches raw save sets. valid flag NA Matches valid save sets. All save sets are marked `valid' by current servers. sumflags NA 3 Per-volume save set summary flags,as described for the -v report. fragflags NA 3 Per-section save set summary flags, as described for the -V report. totalsize number 11 The total save set size. nfiles number 5 The number of the client's files in the save set. ssexp time 9 The save set's expiration time, `undef' means it depends on client policies. copies number 6 The number of copies (instances or clones) of the save set, all with the same save time and save set identifier. cloneid =number 11 The clone identifier of one copy. clonetime time 9 The time a copy was made. clflags NA 5 The clone flags summary, from the set ais for aborted, incomplete and suspect (read error), respectively. suspect flag NA Matches suspect save set copies, copies that had errors during file recovery. annotation string 31 Matches the string to the save set's annotation. first number 11 The offset of the first byte of the save set contained within the section. last NA 11 The calculated offset of the last byte of the save set contained within the current section. fragsize NA 7 The calculated size of the current section of the save set. sumsize NA 7 The calculated total size of all of the sections of the save set on this volume. mediafile number 5 The media file number containing the current section of the save set. mediarec number 5 The media record number where the first bytes of the save set are found within the current media file. mediamark number 5 The absolute positioning data for the current section (not used by existing servers). ssaccess time 9 The last time this section of the save set was access (for backup or recover).
In the following examples, the equivalent short-hand and custom versions of the report are shown, when a short-hand option exists for a given report or query.
Display all bootstraps generated in the previous five weeks, as reported by savegrp(8):
mminfo -B
mminfo -N bootstrap -t '5 weeks ago' -ot
-r 'savetime(17),space,level(6),ssid'
-r 'mediafile(6),mediarec(8),space(3),volume'
Display information about all of the volumes:
mminfo -m
mminfo -a -r 'state,volume,written,%used,read,space,volexp'
-r 'mounts(5),space(2),capacity'
Display media information from volumes mars.001 and mars.002:
mminfo -m mars.001 mars.002
mminfo -m -q 'volume=mars.001,volume=mars.002'
Display all save sets named /usr:
mminfo -N /usr
mminfo -q name=/usr
Display save sets named /usr, generated by client venus, in the past week:
mminfo -N /usr -c venus
mminfo -q 'name=/usr,client=venus'
Display save sets named /usr, generated by client venus, on volume mars.001:
mminfo -N /usr -c venus mars.001
mminfo -q 'name=/usr,client=venus,volume=mars.001'
Display a media report of all volumes written on in the past week:
mminfo -m -t 'last week'
mminfo -m -q 'savetime>=last week'
Display a media report of all non-full volumes, showing the percent-used, pool and location of each volume:
mminfo -a -r 'volume,%used,pool,location' -q '!full'
Display a media report similar to the -m report but showing the barcode instead of the volume label:
mminfo -a -r 'state,barcode,written,%used,read,space,volexp'
-r 'mounts(5),space(2),capacity'
Display a verbose list of the instances of all save sets with more than one copy, sorted by save time and client name:
mminfo -otc -v -q 'copies>1'
Display all archive save sets with an annotation of "project data" for the past four months.
mminfo -q'annotation=project data'
-r"volume,client,savetime,sumsize,ssid,name,annotation"
-t'four months ago'
/nsr/mm/mmvolume
The save set and media volume databases (actually accessed by nsrmmdbd(8)).
|
See Also:
nsr_getdate(3), nsr_layout(5), nsradmin(8), nsrmmdbd(8), recover(8), savegrp(8), scanner(8) |
no matches found for the query
No save sets or volumes were found in the database that matched all of the constraints of the query.
invalid volume name `volname'
The volume name given is not in a valid format. Note that volume names may not begin with a dash. Queries that match no volumes wil return the error `no matches found for the query'.
only one of -m, -B, -S, -X or -r may be specified
Only one report can be generated at a time. Use separate runs of mminfo to obtain multiple reports.
invalid sorting order specifier, choose from `celmnotR'
Only letters from celmnotR may be used with the -o option.
only one -o allowed
Only one sorting order may be specified.
only one -s allowed
Only one server can be queried at one time. Use multiple runs of mminfo to obtain reports from multiple servers.
Out of Memory
The query exhausted available memory. Try issuing it again, using the sorting order -om, or make the query more restrictive (eg. list specific volumes, clients, and/or save set names).
invalid value specified for `attribute'
The value specified is either out of range (eg. a negative number for a value that can only take positive numbers), the wrong type (an alphabetic string value specified for a numeric attribute), or just poorly formatted (eg. non-blank characters between a close quote and the next comma or a missing close quote).
value of `attribute' is too long
The value specified for attribute is longer than the maximum accepted value. Query attributes must have values less than 65 characters long.
non-overlapping range specified for `attribute'
The range specified for attribute is a non-overlapping numeric range, and cannot possibly match any save set or volume in the database.
unknown query constraint: attribute
The given query attribute is not valid. See the Custom Queries and Reports table for a list of all valid attribute names.
need a value for query constraint `attribute'
The attribute is not a flag, and must be specified in the `name comparator value' format.
constraint `attribute' is only valid for reports
The attribute specified for a query may only by used in report (-r) specifications. Calculated values, flag summaries, save set extended attributes, and formatting tools (space and newline) may not be used in queries.
invalid comparator for query constraint `attribute'
The comparator used is not valid for the given attribute. See the Custom Queries and Reports section for a list of the valid comparators for attribute.
query constraint `attribute' specified more than once
The given attribute was specified more than once with the same comparator, and is not a string attribute (string attributes can match one of several specific values).
unknown report constraint: attribute
The given report attribute is not valid, see the Custom Queries and Reports table for a list of all valid attribute names.
constraint `attribute' is only valid for queries
The attribute specified for a report is a flag matching attribute and may only by used in query (-q) specifications. See the Custom Queries and Reports table for the appropriate flag summary attribute that one may use in reports of a given flag.
column width of `attribute' is invalid
The width specified for attribute is out of range. Column widths must be positive numbers less than 256.
missing close parenthesis after report constraint `attribute'
The width of attribute is missing a close parenthesis.
missing comma after report constraint `attribute'
There are non-blank characters after the width specification for attribute without any comma preceding them.
No data requested, no report generated
The given report specification contains only formatting, no data attribute names.
You cannot specify save set extended attributes as query constraints.
You cannot list several possible equality matches for numbers, only for strings.
Some queries, namely those that are not highly selective (few query constraints) and use a sorting order where the volume name is not the primary sort key, still require mminfo to retrieve the entire database before printing any of it. Such queries use up large amounts of memory in mminfo, but not, as was the case with older versions, in nsrmmdbd.
You cannot make a report that shows save set or media instances and a summary without running mminfo at least twice.
You cannot specify query constraints that compare database attributes with each other.
You cannot make a report that uses -B flag with -c flag.
mmlocate - Legato Storage Manager media location reporting command
mmlocate [ -s server ] [ -l { -n volname | -i volid | location }] [ -L ] [ -d location ]
[ -c { -n volname | -i volid }] [ -u { -n volname| -i volid| location }]
The mmlocate command is used to access and manage the volume location information contained in the media database. The information contained in a volume's location field is meant to give the user an idea of where the volume can physically be found. Other Legato Storage Manager commands will display the location along with the volume name (see the versions sub-command of recover(8)). Any user can use this command with the -l (default) or -L options. The -c, -d and -u options are limited to Legato Storage Manager administrators (see nsr(8)). -l is assumed by mmlocate if a -L, -c, -d or -u option is not specified.
Running mmlocate without any arguments lists all volumes and their locations for the specified server (if you do not specify a server, the current host is used).
Note that each time nsrjb() moves a piece of media inside a jukebox, the location of a volume is set to the name of the jukebox. When using storage nodes, the name of the jukebox is used to indicate on which node the volume can be mounted. Hence, the first portion of this field containing the jukebox name should not be changed. When using volumes on a storage node that are not contained within a jukebox, this field can be used to indicate on which node a volume should be mounted, by giving it a value of any remote device on that node. See nsr_storage_node(5) for additional detail on storage nodes.
-c
Clears the location field for the specified volume.
-d location
Deletes all volumes associated with the specified location. A confirmation prompt appears prior to the deletion of each volume.
-i volid
Restricts the mmlocate operation to the specified volume ID (volid).
-l
Lists entries. Performs a database query using the supplied volume name, volume ID or location.
If a volume name or volume id is given, then only the volume's location information is displayed. If a location is provided, then only volumes in that location are displayed. When the -l option is used without specifying any other options (volume name, volume id, or location), volumes without a set location are displayed.
-L
Lists all locations found in the database.
-n volname
Restricts the operation to the volume name (volname) listed.
-s server
Accesses the server's media database.
-u
Updates the location for a volume. Locations are limited to a maximum length of 64 characters. The -n volname or -i volid and location options must be used in conjunction with the -u option.
Update the media database to show that volume Offsite.011 is now at location 'Media Vault'
"mmlocate -u -n Offsite.011 'Media Vault'
Delete volumes at location 'Media Shelf 6'
"mmlocate -d 'Media Shelf 6'
Delete location information for volume NonFull.001
"mmlocate -c -n NonFull.001
List the location of volume NonFull.001
"mmlocate -n NonFull.001
List all volumes stored in the location 'Media Vault'
"mmlocate 'Media Vault'
/nsr/mm/mmvolume
The media database.
Server server does not support remote update operations...
If you are running mmlocate against an old server, you are not allowed to use the -u or -c options. You must login to that server and run the mmlocate program there.
mmpool - Legato Storage Manager media pool reporting command
mmpool [ -s server ] [ volume... ]
[ -d pool ] [ -l pool ] [ -L ]
The mmpool command is used to access pool information stored in the Legato Storage Manager server's media database. This command can also be used to delete all the volumes in a particular pool. If you specify one or more volume names with the mmpool command, the report shows the pool to that each named volume belongs to. By default, all volumes and their pools are displayed.
You cannot change the pool to which a volume belongs, without relabeling the volume, which destroys all data stored on the volume. Pools are configured through a Legato Storage Manager administration tool, such as nwadmin(8) or nsradmin(8). These tools are used to create and modify unique pool (see nsr_pool(5)) resources.
-d pool
Deletes all volumes for the given pool. The user will be prompted for deletion of each volume.
-l pool
Lists all volumes and the pools to which they belong. If a pool is specified, mmpool only list the volumes belonging to that pool.
-L
Lists the names of all pool resources configured on the server.
-s server
Specifies the Legato Storage Manager server to act upon. See nsr(8) for a description of server selection.
/nsr/mm/mmvolume (UNIX)
The media database on the server.
mmrecov - Recover a Legato Storage Manager server's on-line index and media index
mmrecov [ -q | -v ]
The mmrecov command is used in recovering from the loss of a Legato Storage Manager server's critical files including the server's index, the media index, and the server's resource files. Typical events causing such disasters are accidental removal of these files by a user or a disk crash on the Legato Storage Manager server itself. The mmrecov command is used to recover the indexes and other files. See nsr_crash(8) for a discussion of general issues and procedures for Legato Storage Manager client and server crash recovery.
Mmrecov is used to recover the Legato Storage Manager server's on-line file and media index from the media (backup tapes or disks) when either of the server's online file or media index has been lost or damaged. Note that this command overwrites the server's existing online file and media index. The mmrecov command is not used to recover Legato Storage Manager clients' online indexes; you can use normal recover procedures for this purpose.
The Legato Storage Manager system must be fully installed and correctly configured prior to using this command. If any of the Legato Storage Manager software is lost, re-install Legato Storage Manager from the distribution files before you run mmrecov. Use the same release of Legato Storage Manager, and install it in the same location as it was before the software was lost.
Mmrecov program works in two phases. First, it extracts the contents of a bootstrap save set, which contains the media and online file indexes. The online file index only contains one entry, for the online file index itself. In the second phase, mmrecov will run recover(8) to completely recover the server's online file index. This last phase is performed in the background, so the operator can respond to subsequent media mount requests.
When mmrecov is started, it will ask for the device from which the bootstrap save set will be extracted. Next, it will ask for the bootstrap save set identifier. This number is found in the fourth column (labeled ssid) of the last line of the bootstrap information sheet printed by savegrp, an example of which is shown below:
Jun 17 22:21 1999 mars's Legato Storage Manager bootstrap information Page 1 date time level ssid file record volume 6/14/99 23:46:13 full 17826163 48 0 mars.1 6/15/99 22:45:15 9 17836325 87 0 mars.2 6/16/99 22:50:34 9 17846505 134 0 mars.2 mars.3 6/17/99 22:20:25 9 17851237 52 0 mars.3
In the example above, the ssid of the most recent bootstrap save set is `17851237'. If you are cloning save sets, your bootstrap save set is also cloned, and you need to use the second to last save set. See the Recovering from Clone Media section for an example of boostrap information with cloned save sets. Next, mmrecov prompts for the file and record location of the bootstrap save set. Both values may default to zero if they are not known. The file and record locations are the fifth and sixth columns of the bootstrap information sheet. In the example above, the values for the file and record locations are 52 and 0, respectively. Finally, mmrecov will ask that the volume (`mars.3' in the example above) containing the selected bootstrap save set be inserted into the specified device. All of the ssid, file location, record location, and the physical volume must be determined by the user from the printed sheet, since mmrecov has no way of determining this information. On the other hand, if the volume containing the bootstrap is not known, the -B option of scanner(8) can be used to determine the file and record locations.
If the bootstrap save set spans more than one volume, multiple volume names are printed. The order printed is the order required by mmrecov. In the example above, the third save set produced on 6/16/92 begins on volume `mars.2' and spans to volume `mars.3'. If a bootstrap save set spans volumes, mmrecov will ask for the name of the device where the next volume has been loaded when an end-of-volume occurs. The volume is then scanned, and the bootstrap save set extracted.
After the volume scan completes, mmrecov will complete. A recover will be running in the background, reconstructing a complete index from the save sets generated by the server's save schedule. Since the save sets may be spread across multiple volumes, nwadmin(8) or nsrwatch(8) should be run, and the volumes mounted as they are requested.
When the recover completes, the message "The index is now fully recovered" is displayed. recover can now be used in its normal interactive browsing mode, to recover other server files, including other Legato Storage Manager client on-line file indexes. Once a Legato Storage Manager client's index is recovered, that client can start recovering its files.
As stated earlier, the Legato Storage Manager resource files are saved as part of the bootstrap save set. If your resource files were also deleted, you may quickly replace them by copying or moving them from /nsr/res.R to /nsr/res. Before restoring them to /nsr/res, the daemons must be shut down (see nsr_shutdown(8)).
Sometimes, it is neccessary to recover the Legato Storage Manager server onto a new machine, for example, after a major hardware failure. When this occurs, the Legato Storage Manager Licensing software will detect the move. Once the Legato Storage Manager server has been moved to a new machine, it must be re-registered with Customer Support within 15 days of the move, or the server will disable itself. After disabling itself, you will only be able to recover files; new backups cannot be performed until the server is re-registered. Notifications will be sent by the NSR Registration notification, warning of the need to re-register the product.
If you are running mmrecov with clone media only, for example, at a remote site, you will need to perform the recovery using a slightly different method. When selecting the bootstrap identifier, make sure that you are using the information associated with the cloned save set: the last save set listed in the bootstrap output. Consider the following list of save sets:
Jun 17 22:21 1999 mars's Legato Storage Manager bootstrap information Page 1
date time level ssid file record volume 6/14/99 23:46:13 full 17826163 48 0 mars.1 6/14/99 23:46:13 full 17826163 12 0 mars_c.1 6/15/99 22:45:15 9 17836325 87 0 mars.2 6/15/99 22:45:15 9 17836325 24 0 mars_c.2 6/17/99 22:20:25 9 17851237 52 0 mars.3 6/17/99 22:20:25 9 17851237 6 0 mars_c.3
In the example above, the ssid of the most recent bootstrap save set is `17851237'. The cloned save set resides on mars_c.3 and the values for the file and record locations are 6 and 0, respectively.
Once mmrecov recovers the bootstrap save set, it will start pursuing other pieces of the server's client index to complete the recovery. The cloned bootstrap knows about the original and cloned volumes. If all clone volumes needed are online when the index recovery proceeds, mmrecov will complete on its own.
If some of the volumes are not online, then mmrecov will attempt to recover the index from the original volume it was backed up to, and therefore request the original media. In the example bootstrap output above, mars_c.1 and mars_c.3 would all need to be online. If volume mars_c.3 was the only volume online, then mmrecov would also request mars.1. To finish recovering the server's index in this case, you need to perform the following steps:
Given the scenario in the example above where only mars_c.3 was mounted, we would have to delete mars.1 from the media database, i.e. nsrmm -d mars.1.
Use nsr_shutdown(8) to bring the server down. Run nsrd(8) to start the server again.
Use mminfo(8) to determine the save set id of the last index backup, for example:
mminfo -s server -c server -N /nsr/index/server -v -o t
Note that the -N option should be given the full path to the index if it is located in a different location. For example, if /nsr/index/server is a symlink to /disk1/nsr/index/server, you should specify -N /disk1/nsr/index/server. The save set id to use for recover by save set follows the size field in the mminfo(8) output. In the following example output from mminfo, the save set id is `18196'
mars_c.002 mars 12/27/96 14:06:32 138 KB 18196 cb 9 /nsr/index/mars
Once you have the save set id, you can run recover(8). Given the information above, one would run the following command:
recover -s server -S 18196
When the recover completes, the message "The index is now fully recovered" is displayed.
-q
Quiet. Display only error messages.
-v
Verbose. Generates debugging information.
/nsr
If this was a symbolic link when the bootstrap save set was created, it is recovered (recreated) unconditionally by mmrecov.
/nsr/res
This directory and its contents are saved as part of the bootstrap save set. Mmrecov restores this directory, and then renames it to /nsr/res.R. The original directory is temporarily renamed to /nsr/res.org while the bootstrap save set is being recovered.
/nsr/mm/mmvolume
The Legato Storage Manager server's media index saved as part of the bootstrap save set, and unconditionally recovered by mmrecov.
/nsr/index/servername/db
The Legato Storage Manager server's on-line file index saved as part of the bootstrap save set, and unconditionally recovered by mmrecov.
The name mmrecov is misleading, as a result mmrecov is often used when it is not needed. A name like "recover_server_index_or_media_index_when_either_is_missing" is more descriptive. Note that any part of the bootstrap save set contents are recoverable using normal recover procedures provided that the server's on-line index and media index are intact.
To recover files that are not in the on-line file index (for example, files saved after the last run of savegrp), scanner must be used to rebuild the media and on-line file indexes from the contents of the volumes generated between the time of the last run of savegrp and the loss of the original index.
"The index for server was NOT fully recovered
There was an error recovering all or part of the server's index. Look back through the output to find out what was not recovered (one or more additional error messages will be mixed in with other mmrecov status messages). You may need to retry the mmrecov, for example, in the case of a temporary resource limitation or media error, or you may need to resort to recovering an older version of the index, in the case a permanent media error.
nsr - Legato Storage Manager directive file format
This man page describes the format of directive files. These files are interpreted by save(8) and Application Specific Module (ASM) programs, during Legato Storage Manager backup processes. This format is also used in the directive attribute of the nsr_directive(5) resource.
Directives control how particular files are to be backed-up, how descendent directories are searched, and how subsequent directives are processed. For each file backed-up, any ASM information required to recover that file is also backed-up. This enables recover(8), or any ASM directly invoked, to recover a file correctly, even if the current directives have changed since the file was backed-up. See uasm(8) for a general description of the various ASMs.
The directive file in each directory is parsed before anything in that directory is backed up, unless Legato Storage Manager is being run in ignore mode. Each line of a directive file, and each line of the directive attribute, contains one directive. Any text after a "#" character until the end of the line is treated as a comment and discarded. Directives appear in one of three distinct forms:
[+] ASM [args ...] : pattern ...
save environment
<< dir >>
The three forms are referred to as ASM specifications, save environment directives, and << dir >> directives, respectively.
Use ASM specifications (name and any arguments), to specify how files or directories with a matching pattern are backed-up. When a pattern matches a directory, the specified ASM is responsible for handling the directory and its contents. Any pattern or ASM arguments requiring special control or white space characters should be quoted using double quotes (").
A colon (:) is used as the separator between the ASM specification (and any arguments) and the pattern specification list. The pattern list for each ASM specification consists of simple file names or patterns. The pattern cannot be ".." and must not contain any "/" characters (all names must be within the current directory). The string "." can be used to match the current directory. Standard sh(1) file pattern matching (*, [...], [!...], [x-y], ?) can be used to match file names. If a "+" precedes the ASM name, then the directive is propagated to subdirectories. When a directory is first visited, it is searched for a file. If one is found, it is then read. Each file is only read once. When starting a save at a directory below /, any files on the normalized path of the current working directory are read before any files are saved to catalog any propagated directives.
The following algorithm is used to match files to the appropriate ASM specification. First the file in the current directory (if any) is scanned from top to bottom for an ASM specification without a leading "+" whose pattern matches the file name. If no match is found then the file in the current directory is re-scanned for an ASM specification with a leading "+" whose pattern matches the file name (for clarity, we recommend placing all propagating ("+") directives after all the non-propagating directives in a file). If no match is found, then the file found in the ".." directory (if any) is scanned from top to bottom looking for a match with an ASM specification that has a leading +. This process continues until the file in the "/" directory (if any) is scanned. If no match is found (or a match is found with an ASM specification whose name is the same as the currently running ASM), then the currently running ASM will handle the save of the file.
Use save environment directives to change how ASM specifications and future files are used. The save environment directives do not take any file patterns. They affect the currently running ASM and subsequent ASMs invoked below this directory. There are three different possible save environment directives that can be used:
forget
Forget all inherited directives (those starting with a "+" in parent directories).
ignore
Ignore subsequent files found in descendent directories.
allow
Allow file interpretation in descendent directories.
The << dir >> directive can be used to specify a directory where subsequent ASM specifications from the current file should be applied. This directive is intended to be used to consolidate the contents of several files to a single location or directory. The dir portion of this directive must resolve to a valid directory at or below the directory containing this directive or subsequent ASM specifications will be ignored. Relative path names should be used for file names to ensure the interpretation of subsequent ASM directives is consistent, even if a directory is mounted in a different absolute part of the filesystem.
There must be a << dir >> as the first directive in a directive file used in conjunction with the -f option to save(8), savefs(8) or with an ASM program. Also, when << dir >> directives are used in this manner, whether first or later in the file, absolute path names should be used to ensure appropriate interpretation. Absolute path names should also be used for each directory specified within the directive attribute of the NSR directive resource (see nsr_directive(5)).
When a << dir >> directive is used, subsequent directives are parsed and logged for later use. When a directory specified by dir is opened, any save environment directives specified for that directory (for example, allow, ignore, and forget) are processed first. If the ASM is not currently ignoring files and a local file exists, the file is read and processed. Finally, any of the non save environment directives specified for that directory are handled as if they where appended to the end of a file in that directory. If multiple << dir >> specifications resolve to the same directory, then the corresponding save directives are handled logically in "last seen first" order.
Having a /usr/src/.nsr file containing:
+skip: errs *.o
+compressasm: .
will cause all files (or directories) located in the /usr/src directory named errs or *.o (and anything contained within them) to be skipped. In addition, all other files contained in the /usr/src directory will be compressed during save and will be set up for automatic decompression on recover.
Having a /var/.nsr file containing:
compressasm: adm .nsr
null: * .?*
causes all files (or directories) and their contents located within the /var directory and anything contained within them, (except for those files located in the /var/adm directory and the file itself) to be skipped, although all the names in the directory would be backed-up. In addition, since compressasm is a searching directive (see uasm(8)), the files contained within the /var/adm directory will be compressed during back up and will be set up for automatic decompression on recover.
The following is an example of using the /.nsr file as a master save directive file for the entire filesystem by using << dir >> directives to consolidate the various ASM save directives to a single location:
# Master Legato Storage Manager directive file for this machine << ./ >> # /mnt and /a are used for temporary fs mounting # and need not be savedskip: mnt a +skip: core errs dead.letter *% *~# Don't bother saving anything within /tmp << ./tmp >>skip: .?* *<< ./export/swap >>swapasm: *# Translate all mailboxes. Also, use mailasm to save each mail file to maintain # mail file locking conventions and to preserve the last file access time. << ./usr/spool/mail >>xlateasm: . mailasm: *# Allow .nsr files to be interpreted in /nsr, even if we are currently ignoring # .nsr files. Legato Storage Manager applications (such as nsrindexd) set up # their own private .nsr files which save index files more intelligently. << ./nsr >>allow# We can rebuild any .o files in /usr/src from sources except those in # /usr/src/sys. << ./usr/src >>+skip: *.o<< ./usr/src/sys >>forget
Save directive file in each directory.
|
See Also:
sh(1), nsr_directive(5), nsrindexasm(8), nsrmmdbasm(8), recover(8), save(8), savefs(8), uasm(8) |
NSR - Introduction and overview of Legato Storage Manager
Legato Storage Manager facilitates the backup and recovery of files on a network of computer systems. Files and filesystems may be backed up on a scheduled basis. Recovery of entire filesystems and single files is simplified by use of an on-line index of saved files.
Legato Storage Manager uses a client-server model to provide the file backup and recover service. At least one machine on the network is designated as the Legato Storage Manager Server, and the machines with disks to be backed up are Legato Storage Manager clients. Five daemons provide the Legato Storage Manager service, control access to the system, and provide index and media support. On the clients, there are special programs to access the file systems and communicate with the Legato Storage Manager server.
The Legato Storage Manager system has several parts. Commands and files are only briefly mentioned here; see the appropriate reference manual page for more detailed information. Each command has a manual page entry in section 8. The files and their formats are explained in section 5 manual pages.
The Legato Storage Manager Administrator's Guide provides information on configuring and administering a Legato Storage Manager system. It includes many examples and rationales for setting up and running a successful backup operation.
How Legato Storage Manager is installed varies depending on the architecture of the machine upon which you're installing. See the Oracle Server Installation Guide for detailed installation instructions.
lsminst
The Legato Storage Manager installation script. The script will install both clients and servers. The lsminst script can also be used to de-install Legato Storage Manager. Note that some systems use other methods for installing and de-installing Legato Storage Manager, in which case the lsminst script will not exist.
nsr_layout(5)
Describes where Legato Storage Manager programs, files, and manual pages are installed.
Legato Storage Manager uses a client-server model to provide a backup and recover service. The following daemons encompass the server side of Legato Storage Manager.
nsrd(8)
The main Legato Storage Manager daemon. nsrd handles initial communication with clients, and starts and stops the other Legato Storage Manager server daemons.
nsrindexd(8)
This server daemon provides access to the Legato Storage Manager on-line index. The index holds records of saved files. The index allows clients to selectively browse and choose files to recover without having to access the backup media.
nsrmmdbd(8)
The media management database daemon provides an index of save sets and media. The nsrmmdbd daemon provides a much coarser view of the saved files than does nsrindexd, and therefore the resultant index is usually much smaller.
nsrmmd(8)
The media multiplexor daemon provides device support for Legato Storage Manager. When more than one client is saving files, the data from each client is multiplexed. During recovery operations, the data is demultiplexed and sent back to the requesting clients. When the multiple devices are enabled, several of these daemons may be active simultaneously.
Legato Storage Manager is administered via resources and attributes. Every resource has one or more attributes associated with it. For example, a device is a Legato Storage Manager resource type; an attribute of devices is the device type, for example, 4mm or 8mm. The Legato Storage Manager resource format is documented in nsr_resource(5). There is also a manual page for each Legato Storage Manager resource in section 5 of the manual.
Resource files are not normally edited by hand. Rather, a Legato Storage Manager tool (usually nwadmin(8) or nsradmin(8)) is used to modify resource files dynamically so that values can be checked and changes can be propagated automatically to the interested programs.
nwadmin(8)
Monitors the activity of and administers Legato Storage Manager servers. The nwadmin command is an X Window System application, using a Motif look and feel. The nwadmin command is most users' primary interface to Legato Storage Manager.
nsradmin(8)
A curses(3) based tool for the administration of Legato Storage Manager servers.
nsrwatch(8)
A curses(3) based tool to monitor the activity of Legato Storage Manager servers.
nsrmm(8)
Media manager command. The nsrmm command is used to label, mount, unmount, delete and purge volumes. Mount requests are generated by nsrmmd, and displayed by nwadmin or nsrwatch. The size of the on-line user file indexes may be controlled by deleting and purging volumes.
nsrim(8)
Automatically manages the on-line index. Usually run periodically by savegrp.
mminfo(8)
Provides information about volumes and save sets.
nsrck(8)
Checks and repairs the Legato Storage Manager on-line index. It is run automatically when nsrd starts up if the databases were not closed cleanly due to a system crash.
nsr_shutdown(8)
A shell script used to safely shut down the local Legato Storage Manager server. The nsr_shutdown script can only be run by the super user.
Legato Storage Manager supports both scheduled and manual saving of files and filesystems. Each client may be scheduled to save all or part of its filesystems. Different clients may be scheduled to begin saving at different times.
save(8)
A command-line-based tool used to back up a specified file or group of files. The save command may be run manually by users and administrators, or automatically by savegrp.
nwbackup(8)
A Motif-based tool for backing up files. The nwbackup command is the graphical equivalent of save.
Note: LSM does not support nwbackup(8).
savegrp(8)
Used to initiate the backup of a group of client machines. Usually started automatically by the Legato Storage Manager server. The savegrp command also backs up the clients' on-line file indexes, which are stored on the server. When backing up the server itself, a bootstrap save set is also created.
nsrexec(8)
The agent savegrp process, spawned by savegrp. The nsrexec command monitors the progress of Legato Storage Manager commands.
nsrclone(8)
The Legato Storage Manager save set/volume cloning command. Using nsrclone, clones, or exact replicas, of save sets or entire volumes can be made. Clone data is indistinguishable from the original data, except for the Legato Storage Manager media volumes upon which the data reside.
Note: LSM does not support nsrclone(8).
nsrexecd(8)
Legato Storage Manager-specific remote execution service which runs on Legato Storage Manager clients. Used by savegrp to start save and savefs on client machines.
savefs(8)
Used by savegrp to determine characteristics of a client, and to map the save set All to a the current list of all save sets on a client.
Legato Storage Manager maintains an on-line index of user files that have been saved. Users may browse the index and select files for recovery. This information is used to build an representation of the file heirarchy as of any time in the past. Legato Storage Manager then locates the correct volume and recovers the requested files.
recover(8)
Browses the on-line user file index and selects files and filesystems to recover.
Note: LSM does not support recover(8).
nwrecover(8)
A Motif-based tool for recovering files. The nwrecover command is the graphical equivalent of recover.
Note: LSM does not support nwrecover(8).
mmrecov(8)
Used only for disaster recovery. Recovers the special bootstrap index and the server's on-line file index. The recover or nwrecover commands are used to recover other on-line file indexes.
scanner(8)
Verifies correctness and integrity of Legato Storage Manager volumes. Can also recover complete save sets and rebuild the on-line file and media indexes.
nsr_crash(8)
A man page describing crash recovery techniques.
nsrinfo(8)
Used to generate reports about the contents of a client's file index.
In order to process user files in an optimal manner, Legato Storage Manager provides the ASM mechanism. Pattern matching is used to select files for processing by the different ASMs. The patterns and associated ASMs are described in nsr(5). The save command keeps track of which ASMs were used to process a file so that recover may use the same ASMs to recover the file.
uasm(8)
UNIX filesystem specific save/recover module. The uasm man page documents the general rules for all ASMs. The uasm command and its man page actually comprise several additional ASM including compressasm, mailasm, and xlateasm, to name a few.
nsrindexasm(8)
Processes the on-line user file indexes.
nsrmmdbasm(8)
Processes the on-line media database.
On large networks there may be several Legato Storage Manager servers installed. Each Legato Storage Manager client command must select a server to use.
For server selection, the client commands are classified into two groups: administration and operation. The administration commands include nwadmin, nsrwatch, and mminfo. The operation commands include save, savefs, and recover. Both groups of commands accept a -s server option to explicitly specify a Legato Storage Manager server.
When a server is not explicitly specified, the operation commands use the following steps to locate one. The first server found is used.
The administrative commands only use step 1.
Before a save is allowed, there must be a NSR client resource created for the given client. Before a recovery is allowed, the server validates client access by checking the remote access attribute in the NSR client resource (see nsr_client(5)). Earlier versions Legato Storage Manager required that connections come to the server using ports in the reserved port range. This required UNIX clients to be run with an effective uid of root at connection set up time. Newer versions of Legato Storage Manager use a stronger RPC authentication flavor and do not depend on using reserved ports and so setuid root operation is not required.
The savegrp(8) command initiates the save(8) command on each client machine in an NSR group by using the nsrexecd(8) remote save execution service. See the nsrexecd(8) man page for details. For backward compatibility with older versions of Legato Storage Manager, savegrp(8) will fall back on using the rsh(1) protocol for remote execution if nsrexecd is not running on a particular client.
Access to the NSR resources through the nsradmin(8) or nwadmin(8) commands is controlled by the administrator attribute on each resource. This attribute has a list of names of the users who have permission to administer that resource. Names that begin with an ampersand (&) denote netgroups (see netgroup(5)). Also names can be of the form user@host to authorize a specific user on a specific host.
As described above, the NSR server only accepts connections initiated from the machines listed as clients or listed in the remote access list (for recovering). Since machines may be connected to more than one physical network and since each physical network connection may have numerous aliases, the policies below are used as a compromise between security and ease of use. For further information about naming in the UNIX environment, refer to gethostent(3), or other documentation on name services.
A client determines its own name as follows. First the client's UNIX system name is acquired via the gethostname(2) system call. The UNIX system name is used as a parameter to the gethostbyname(3) library routine. The client declares its name to be the official (or ``primary'') name returned by gethostbyname. This name is passed to the Legato Storage Manager server during connection establishment.
A server authenticates a client connection by reconciling the connection's remote address with client's stated name. The address is mapped to a list of host names via the gethostbyaddr(3) library function. Next, the client's stated name is used as a parameter to gethostbyname to acquire another list of host names. The client is successfully authenticated if and only if there exists a common name between the two lists.
The Legato Storage Manager server maps a client's name to an on-line index database name by resolving the client's name to the official name returned by gethostbyname. This mapping takes place both at client creation time and at connection establishment time.
To ensure safe and effective naming, the following rules should be employed:
rsh(1), gethostname(2), gethostent(3), netgroup(5), nsr(5), nsr_layout(5), nsr_resource(5), ypfiles(5), ypmake(5), mminfo(8),
See Also:
nsr_crash(8), nsr_shutdown(8), nsradmin(8), nsrck(8), nsrclone(8), nsrd(8), nsrexecd(8), nsrim(8), nsrindexasm(8), nsrindexd(8), nsrinfo(8), nsrls(8), nsrmm(8), nsrmmd(8), nsrmmdbasm(8), nsrmmdbd(8), nsrwatch(8), nwadmin(8), nwbackup(8), nwrecover(8), recover(8), mmrecov(8), save(8), savefs(8), savegrp(8), scanner(8), uasm(8).
Legato Storage Manager Administrator's Guide
NSR archive client - Legato Storage Manager resource type ``NSR archive client''
type: NSR archive client
Each NSR archive client is described by a single resource of type NSR archive client (see nsr_resource(5)). To edit the NSR archive client resources for a Legato Storage Manager server type:
nsradmin -c "type:NSR archive client"
See the nsradmin(8) manual page for more information on using the Legato Storage Manager administration program. The archive client resource may also be edited using the command nwadmin(8).
This resource describes systems that are allowed to utilize archive services on a Legato Storage Manager server. There is only one resource per archive client.
The following attributes are defined for resource type NSR archive client. The information in parentheses describes how the attribute values are accessed. Read-only indicates that the value cannot be changed by an administrator. Read/write means the value can be set as well as read. Hidden means it is an attribute of interest only to programs or experts, and these attributes can only be seen when the hidden option is turned on in nsradmin(8) or by selecting the details Menu Item in the View Menu for a particular window in nwadmin(8). Dynamic attributes have values which change rapidly. Encrypted attributes contain data that is not displayed in its original form. The assumption is that the data is sensitive in nature and needs to be protected from accidental disclosure. Several additional attributes (for example, administrator) are common to all resources, and are described in nsr_resource(5).
name (read-only, single string)
This attribute specifies the hostname of the Legato Storage Manager archive client.
Example: name: venus;
archive users list (read/write, string list)
This attribute specifies a list of users that are allowed to use the archive services on the client. If no users are listed, only administrators and the local root user are allowed to use the archive services on the client. A value of '*' implies any user is allowed to archive or retrieve data. The '/' and '@' characters are not allowed as part of the user name.
Example: archive users list: paul;
remote access (read/write, string list)
This attribute controls who may back up, browse, and recover a client's files. By default this attribute is an empty list, signifying that only users on the client are allowed to back up, browse, and recover it's files. Additional users, hosts, and netgroups may be granted permission to access this 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 the client's files to the specified users. The <user> and/or <host> may be a wild card, "*". If a user name is a wild card, it means all users at the host are granted access the the client's data. When a host name is a wild card, that user on all hosts is granted access to the client's data. All users on a host may also be granted access to the client's data by just listing the host's name, i.e. <host> is equivalent to *@<host> or <host>/*. A plus sign, ``+'', grants access to the client's files to all users on any host whose root user is trusted by the server's remote command system. Note that this attribute does not override file system permissions, the user still needs the necessary file system permissions to back up, browse, or recover a file. The following example grants access to the client's data for all users that satisfy at least one of the following criteria, <user name, user's hostname, server's domain> is a member of the netgroup "netadmins", the user is from the host mars, the user is from the host jupiter, the user's name is sam from host pluto, or the user's id is root from any host.
Example: remote access: &netadmins, mars, *@jupiter, sam@pluto, */root;
remote user (read/write, string)
This attribute specifies the user login name the Legato Storage Manager server will use to run commands on the client. The default value is NULL, implying that `root' should be used. When nsralist (see nsralist(8)) is run on the Legato Storage Manager server, the server runs commands on the client to execute an archive list.
Example: remote user: operator;
password (read/write, encrypted)
The nsralist command uses this attribute when initiating the command nsrarchive on the client's machine. The command nsrarchive uses the password to gain access to the files being archived. If a password is given, then the "remote user" attribute for this resource must also be defined. This attribute does not need to be set for UNIX clients.
executable path (read/write, string, hidden)
This attribute specifies the path to use when the Legato Storage Manager server is executing commands on the client. When no path is specified, the "remote user's" $PATH is used.
Example: executable path: /etc/nsr;
aliases (read/write, string list, hidden)
This is a list of aliases (nicknames) for the client machine that queries can match. If this list is empty, match on client name alone.
Example: aliases: mars;
server network interface (read/write, string, hidden)
The name of the network interface on the server to be used for archives and retrieves.
Example: server network interface: mars-2 ;
Note: The hidden options are not shown in this example.
A resource to define an archive client, called pluto:
type: NSR archive client; name: pluto; archive users: ; remote access: ;
|
See Also:
nsr(5), nsr_directive(5), nsradmin(8), nsralist(8), nsrarchive(8), nsrretrieve(8), nwadmin(8) |
nsr_archive_request - Legato Storage Manager resource type ``NSR archive request''
type: NSR archive request
Each NSR archive request is described by a single resource of type NSR archive request (see nsr_resource(5)). To edit the NSR archive request resources for a Legato Storage Manager server type:
nsradmin -c "type:NSR archive request"
See the nsradmin(8) manual page for more information on using the Legato Storage Manager administration program. The archive request resource may also be edited using the command nwadmin(8).
This resource allows administrators to set up an archive to occur later or to set up frequent archives of a set of data. The administrator can run an archive on a specified client within the next 24 hours. The archive is executed via the nsralist(8)) command.
The following attributes are defined for resource type NSR archive request. The information in parentheses describes how the attribute values are accessed. Read-only indicates that the value cannot be changed by an administrator. Read/write means the value can be set as well as read. Hidden means it is an attribute of interest only to programs or experts, and these attributes can only be seen when the hidden option is turned on in nsradmin(8) or by selecting the details Menu Item in the View Menu for a particular window in nwadmin(8). Dynamic attributes have values which change rapidly. Encrypted attributes contain data that is not displayed in its original form. The assumption is that the data is sensitive in nature and needs to be protected from accidental disclosure. Several additional attributes (for example, administrator) are common to all resources, and are described in nsr_resource(5).
name (read/write)
This attribute specifies the name of this Legato Storage Manager archive request.
Example: name: Product Source Tree;
annotation (read/write)
This attribute contains the annotation text associated with the archive save set generated from this archive request.
Example: annotation: Product Release 4.1;
status (read/write, choice)
This attribute determines if an archive request should be run. No value implies the archive request is not scheduled. Selecting start now causes the archive request to be run immediately. Selecting start later causes the archive request to be run at the time specified by the start time attribute (see below).
Example: status:;
start time (read/write)
This attribute determines when the archive request will be run. The status attribute (see above) must be set to start later for the archive request to be scheduled. The 24 hour clock format is "hours:minutes".
Example: start time: 3:33;
completion time (read/write, hidden)
This attribute indicates when the archive request completed. The format is "day-of-week month day hours:minutes:seconds year".
Example: "Thu Oct 22 17:00:37 1999";;
client (read/write)
This attribute indicates what Legato Storage Manager archive client the archive request is to be executed on.
Example: client: neptune;
save set (read/write)
The save set attribute lists the path names to be archived on the archive client. The names should be separated by a comma and a space (", ").
Example: save set: /product/src, /accounting/db;
directive (read/write)
This attribute specifies the directive to use when running the archive. The default value is nothing selected. The valid choices for the directive resource are names of the currently defined `NSR directive' resources, see nsr_directive(5).
Example: directive: Default with compression;
archive pool (read/write)
This attribute can be used to override the normal media pool selection applied to the archive save set generated from the archive request. Selecting a pool will direct the archive to that media pool.
Example: archive pool: Archive;
verify (read/write, choice)
This attribute indicates the archive request should verify the archive. See
nsr_archive(5) for more information on archiving. Selecting the Yes choice causes the verification to occur. Selecting the No choice will not cause any verification. If the user also requests that the archive save set be cloned, the verification is done on the clone since the cloning operation will have verified the original archive save set.
Example: verify: Yes;
verified (read/write, hidden)
This attribute is unused.
Example: verified: No;
clone (read/write)
This attribute controls whether the archive save set generated by the archive request is to be cloned. A value of Yes implies the archive save set should be cloned. A value of No does not imply cloning.
Example: clone: No;
cloned (read/write, hidden)
This attribute is unsed.
Example: cloned: No;
archive clone pool (read/write)
This attribute indicates the archive clone media pool the archive request should use when cloning the archive save set generated by this archive request.
Example: archive clone pool: Archive clone;
grooming (read/write)
This attribute indicates any grooming actions to be taken once the archive save set generated by the archive request has been created, verified, and cloned. A value of none implies no action. A value of remove implies the files and directories specified in the save set attribute will be removed via the rmdir(2) and unlink(2) system calls.
Example: grooming: none;
archive completion (read/write)
A notification action to be executed to send status of the archive request to.
Example: archive completion: /usr/ucb/mail -s "Product Archive" systemadmin;
log (read/write, hidden)
This attribute contains any information pertaining to the execution of the nsralist command.
Example: log:;
Note: The hidden options are not shown in this example.
A resource to define an archive request, called Product:
type: NSR archive request;name: Product Source;annotation: Product Release 3.0;status: Start later;start time: "2:00";client: space;save set: /product/source;directive: Default with compression;archive pool: Archive;verify: Yes;clone: Yes;archive clone pool: Archive Clone;grooming: none;archive completion: mail -s Product Source Archive productteam;
nsr_client - Legato Storage Manager resource type ``NSR client''
type: NSR client
Each NSR client is described by a single resource of type NSR client (see
nsr_resource(5)). To edit the NSR client resources for a Legato Storage Manager server type:
nsradmin -c "type:NSR client"
See the nsradmin(8) manual page for more information on using the Legato Storage Manager administration program. The client resource may also be edited using the command nwadmin(8).
For each Legato Storage Manager client, this resource describes which files should be saved, the schedule used to save these files, which directive should be used to omit files from the save, how long the files' index entries should be kept in the on-line file index and the media index, and who is allowed to back up, browse, and recover this client's files. A client may have more than one resource describing it.
The following attributes are defined for resource type NSR client. The information in parentheses describes how the attribute values are accessed. Read-only indicates that the value cannot be changed by an administrator. Read/write means the value can be set as well as read. Hidden means it is an attribute of interest only to programs or experts, and these attributes can only be seen when the hidden option is turned on in nsradmin(8) or by selecting the details Menu Item in the View Menu for a particular window in nwadmin(8). Dynamic attributes have values which change rapidly. Encrypted attributes contain data that is not displayed in its original form. The assumption is that the data is sensitive in nature and needs to be protected from accidental disclosure. Several additional attributes (for example, administrator) are common to all resources, and are described in nsr_resource(5).
name (read-only, single string)
This attribute specifies the hostname of this Legato Storage Manager client.
Example: name: venus;
server (constant, single string)
This attribute specifies the hostname of this client`s Legato Storage Manager server. The server`s hostname will be used as the default value.
Example: server: jupiter;
archive services (read/write, choice)
This attribute determines if this system can use archive services. This attribute can only be set if archive support has been enabled on the server. The choices are enabled or disabled.
Example: archive services: enabled;
schedule (read/write, choice)
This attribute specifies the name of the schedule controlling the backup levels for the save sets listed in the `save set' attribute. The default value is `Default'. Any currently defined schedule names may be used, see nsr_schedule(5).
Example: schedule: Default;
browse policy (read/write, choice)
This attribute specifies the name of the policy controlling how long entries will remain in this client's on-line file index. The default value is `Month'. Any currently defined policy name may be used as long as the period defined by the policy is not longer than the retention policy's period, see nsr_policy(5).
Example: browse policy: Month;
retention policy (read/write, choice)
This attribute specifies the name of the policy controlling how long entries will remain in the media index before they are marked as recyclable. The default value is `Year'. Any currently defined policy name may be used as long as the period defined by the policy is not shorter than the browse policy's period, see nsr_policy(5).
Example: retention policy: Year;
directive (read/write, choice)
This attribute specifies the directive to use when backing up the client. The default value is NULL. The valid choices for the directive resource are names of the currently defined `NSR directive' resources, see nsr_directive(5).
Example: directive: Unix with compression directives;
group (read/write, choice list)
This attribute specifies the group this client is a member of. The group controls the start time for automatic backups. The value may be one of currently defined `NSR group' resources, see nsr_group(5). The default value is `Default'.
Example: group: Default;
save set (read/write, list)
The save set attribute lists the path names to be saved for this client. The names should be separated by comma space (, ). The default value is `All'. On UNIX clients, `All' refers to the mounted file systems. On DOS clients, `All' refers to file systems that have been specified on the client via the `Change Automatic Backup' selection of the Legato Storage Manager for DOS. By default, all of a DOS client's hard disks are backed up.
When a client needs to have different file systems saved on different schedules, a client resource is needed for each set of file systems on a particular schedule. For all the client resources with the same name in a group, a given path name may only appear once. When a client resource lists the save set `All', it must be the only client resource with it's name belonging to it's group.
Example: save set: /, /usr, /usr/src;
priority (hidden, read/write, choice)
This attribute controls the backup priority of this client. Priority 1 is the highest, 1000 is the lowest. Automated savegrp's will attempt to back up clients with higher priorities before clients with lower priorities. Note that this is a hint only. The savegrp command has many parameters to consider, and may choose a lower priority client while trying to balance the load.
Example: priority: 500;
remote access (read/write, string list)
This attribute controls who may back up, browse, and recover a client's files. By default this attribute is an empty list, signifying that only users on the client are allowed to back up, browse, and recover it's files. Additional users, hosts, and netgroups may be granted permission to access this 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 the client's files to the specified users. The <user> and/or <host> may be a wild card, "*". If a user name is a wild card, it means all users at the host are granted access to the client's data. When a host name is a wild card, that user on all hosts is granted access to the client's data. All users on a host may also be granted access to the client's data by just listing the host's name, i.e. <host> is equivalent to *@<host> or <host>/*. Note that this attribute does not override file system permissions, the user still needs the necessary file system permissions to back up, browse, or recover a file. The following example grants access to the client's data for all users that satisfy at least one of the following criteria, <user name, user's hostname, server's domain> is a member of the netgroup "netadmins", the user is from the host mars, the user is from the host jupiter, the user's name is sam from host pluto, or the user's id is root from any host.
Example: remote access: &netadmins, mars, *@jupiter, sam@pluto, */root;
remote user (read/write, string)
This attribute has several uses. For those clients that are accessed via the rsh(1) protocol (new clients use nsrexecd(8) instead), this attribute specifies the user login name the Legato Storage Manager server will use to authenticate itself with the client. The default value is NULL, implying that `root' should be used. When savegrp -p (see savegrp(8)) is run on the Legato Storage Manager server, the server runs commands on the client to determine which files to save. Note that when the nsrexecd(8) protocol is used to access the client, the remote user attribute is not used for authentication.
Certain clients, such as NetWare fileservers, use this attribute along with the password attribute, below, to gain access to the files being backed up. Other clients that back up application data, such as Sybase databases, use this attribute along with the password to gain access to the application data. There may be a different value of this attribute for each resource that describes the same client.
Example: remote user: operator;
password (read/write, encrypted)
The savegrp command uses this attribute when initiating the commands savefs and save on the client's machine. The commands savefs and save use the password to gain access to the files being backed up. If a password is given, then the "remote user" attribute for the client resource must also be defined. There may be a different value of this attribute for each resource that describes the same client. This attribute does not need to be set for existing UNIX clients that are not backing up any application specific data.
backup command (read/write, string)
The remote command to run to backup data for this client and save sets. This command can be used to perform pre and post backup processing and defaults to the save command. The value must not include a path and must start with the prefix "save" or "nsr".
Example: backup command: savemsg;
executable path (read/write, string, hidden)
This attribute specifies the path to use when the Legato Storage Manager server is executing commands on the client. When no path is specified, the "remote user's" $PATH is used.
Example: executable path: /etc/nsr;
server network interface (read/write, string, hidden)
The name of the network interface on the server to be used for saves and recovers.
Example: server network interface: mars-2;
aliases (read/write, string list, hidden)
This is a list of aliases (nicknames) for the client machine that queries can match. If this list is empty, match on client name alone.
Example: aliases: mars;
owner notification (read/write, hidden)
A notification action to be executed to send the contents of status messages to the owner/primary user of a machine (for example, savegroup completion messages).
Example: owner notification: /usr/ucb/mail -s "mars' owner notification" carl@mars;
statistics (constant, hidden, dynamic)
This attribute contains three values: the size of the client's on-line file index in kilobytes, the number of kilobytes actually used, and the number of entries in the index.
Example:
statistics: elapsed = 1761860, index size (KB) = 776, amount used (KB) = 680,
entries = 2216;
index save set (update-only, hidden, dynamic)
This attribute specifies the client file index save set to purge when the index operation is set to purging oldest cycle.
Example: index save set: /;
index path (read/write, hidden)
This attribute is used to allow the Legato Storage Manager administrator to balance Legato Storage Manager online file index disk utilization across multiple disk partitions. If set, this attribute contains the full path to the directory containing the client's online file index. Note that the last component of the path must match the name attribute of the client resource (see above). If left blank, the index path defaults to the path /nsr/index/name, where name is the name attribute from the client resource.
Example: index path: /disk2/index/venus;
index message (update-only, hidden, dynamic)
This attribute contains the ending status message for the previous index operation. This attribute is typically blank, indicating that the previous operation completed successfully.
Example: index message:;
index operation start (update-only, hidden, dynamic)
This attribute contains the starting time of the current index operation. This attribute is a null string ("") when the operation is `Idle'. The format is weekday followed by hour and minutes.
Example: index operation start: Wednesday 02:45;
index progress (update-only, hidden, dynamic)
This attribute contains the progress the index has made towards finishing the current task. This attribute is blank when the operation is `Idle'. The progress is expressed as a percentage.
Example: index progress: 45;
index operation (update-only, hidden, dynamic)
This attribute contains the current index operation. It is normally `Idle'.
Example: index operation: Reclaiming space;
parallelism (read/write, hidden)
This attribute specifies the maximum number of saves that should be run at the same time for the client.
Example: parallelism: 2;
archive users (read/write, string list)
This attribute specifies a list of users that are allowed to use the archive services on the client. This attribute can only be set if archive support has been enabled on the server. If no users are listed, only administrators and the local root user are allowed to use the archive services on the client. A value of '*' implies any user is allowed to archive or retrieve data. The '/' and '@' characters are not allowed as part of the user name.
Example: archive users: paul;
application information (read/write, hidden, string list)
This attribute contains client application information.
Example: application information: ;
storage nodes (read/write, string list)
This is an ordered list of storage nodes for the client to use when saving its data. Its saves are directed to the first storage node that has an enabled device and a functional media daemon, nsrmmd(8). The default value of 'nsrserverhost' represents the server. See nsr_storage_node(5) for additional detail on storage nodes.
clone storage nodes (read/write, string list)
This is an ordered list of storage nodes for the storage node to use when its data is being cloned. Cloned data originating from the storage node will be directed to the first storage node that has an enabled device and a functional media daemon, nsrmmd(8). There is no default value. If this attribute has no value, the server's 'clone "storage" "nodes'" will be consulted. If this attribute also has no value, then the server's 'storage "nodes'" attribute will be used to select a target node for the clone. See nsr_storage_node(5) for additional detail on storage nodes.
Note: The hidden attributes are not shown in these examples.
A resource to define a client, called venus, backing up all of its files to the Legato Storage Manager server mars:
type: NSR client; name: venus; server: mars; archive services: Disabled; schedule: Full Every Friday; browse policy: Month; retention policy: Quarter; directive: Unix with compression directives; group: Default; save set: All; remote access: ; remote user: ; password: ; backup command: ; aliases: venus, venus.legato.com; archive users: ; storage nodes: nsrserverhost; clone storage nodes: ;
The resources for a client backing up different file systems on different schedules:
type: NSR client; name: saturn; server: mars; archive services: Disabled; schedule: Default; browse policy: Month; retention policy: Quarter; directive: ; group: engineering; save set: /, /usr, /usr/src; remote access: venus, sam@*, jupiter/john; remote user: operator; password: ; backup command: ; aliases: saturn.legato.com; archive users: ; storage nodes: nsrserverhost; clone storage nodes: ; type: NSR client; name: saturn; server: mars; archive services: Disabled; schedule: Full on 1st Friday of Month; browse policy: Month; retention policy: Quarter; directive: Unix standard directives; group: Default; save set: /usr/src/archive; remote access: sam@venus, &netadmins, root@*; remote user: operator; password: ; backup command: ; aliases: saturn.legato.com; archive users: ; storage nodes: nsrserverhost; clone storage nodes: ;
|
See Also:
rsh(1), ruserok(3), nsr(5), nsr_schedule(5), nsr_directive(5), nsr_group(5), nsr_policy(5), nsr_storage_node(5), save(8), savegrp(8), savefs(8), nsradmin(8), nsrexecd(8), nwadmin(8) |
nsr_crash - How to recover from a disaster with Legato Storage Manager
Legato Storage Manager can be used to recover from all types of system and hardware failure that result in loss of files.
When a Legato Storage Manager client has lost files, the recover command can be used to browse, select, and recover individual files, selected directories, or whole filesystems. If the Legato Storage Manager recover command is lost or damaged it will have to be copied either from a Legato Storage Manager client or from the Legato Storage Manager distribution media.
When recovering a large number of files onto a filesystem that was only partially damaged, you may not want to overwrite existing versions of files. To do this, wait until recover asks for user input to decide how to handle recovering an existing file. You can then answer N meaning ``always no'' to cause recover to avoid overwriting any existing files, or n if you want to protect this file but you want recover to ask again on other files.
If you do want to replace the existing version of a file or set of files with the saved versions use the add command in recover to select which files should be retrieved, and answer Y or y when it asks if it should overwrite existing files (Y means ``always yes'' for future overwrite cases; y means just overwrite this one file).
For more information on using the recover command see the recover(8) manual page.
If the Legato Storage Manager server daemons or commands are lost, it may be necessary to re-install the server from the Legato Storage Manager distribution media. Once the Legato Storage Manager server is installed and the daemons are running, other Legato Storage Manager server files can be recovered using the recover command. When re-installing Legato Storage Manager you must be sure to install the /nsr directory in exactly the same place as it was originally installed. The machine used to recover files may be different that the one used to save the files, but it must have the same hostname as the original machine. This is important because recovery of the Legato Storage Manager on-line index requires that the index files have the same pathname, which includes the server's hostname, as they did at the time of the latest save.
In the event that the Legato Storage Manager server's index is lost, it will be necessary to first recover the index from media before the recover command can be used to browse and recover other files. To recover the Legato Storage Manager server's index use the mmrecov command. The mmrecov command quickly recovers the lost on-line index for a Legato Storage Manager server by locating the bootstrap save set produced by the savegrp(8) command at the end of an automatic save. The bootstrap save set tells mmrecov which save sets to extract from which volumes to recover the whole index. The save set identifier and other information about the bootstrap save set is printed by savegrp at the end of each automatic save. See the savegrp(8) manual page for more details.
After mmrecov completes, the server's file index and media database will be fully recovered (unless mmrecov prints an error message to the contrary). However, the Legato Storage Manager server's /nsr/res directory, which contains the resource files describing your Legato Storage Manager installation, require additional work on the part of the administrator before they will be used. Perform the following steps to complete the mmrecov process (these steps will be incorporated into mmrecov in a future release).
Once mmrecov is run and the media database has been recovered, one can use the recover by save set feature to restore entire filesystems. This method can be faster as one does not have to use a browser to mark all the files and directories in a file system, an operation which can take a long time. You should only use this method for recovery of a filesystem when you can locate a recent save set for that filesystem which was saved with level=full. When recovering multiple save sets which are interleaved on media, recover will recover all save sets concurrently instead of making a separate pass over the media for each save set. See the recover(8) man page for details on running recover by save set.
If you want to recover whole filesystems, an alternative to using mmrecov and recover is to use the scanner command to recover all of the files in a particular save set. The scanner command can also be used to print a table of contents for a volume to help you locate the correct save set for a filesystem. Similar to recover by save set, you should only use scanner for recovery of a filesystem when you can locate a recent save set for that filesystem which was saved with level=full. If using this method of recovery, use of the -x option is preferred to simply piping the output through uasm as multiple save sets interleaved on the media can be read concurrently instead of making a separate pass over the media for each save set. For example, the first command is preferred to the second:
scanner -s 16234 -s 16257 /dev/nrst8 -x uasm -rv
scanner -s 16234 /dev/nrst8 | uasm -rv
scanner -s 16257 /dev/nrst8 | uasm -rv
See the scanner(8) manual page for more details.
If the server is damaged so badly that it will not run at all, you will need to follow the manufacturer's instructions for re-installing and rebooting a multiuser system. Once you have the system up and running in multiuser mode, you can re-install Legato Storage Manager (i.e. extract Legato Storage Manager from the distribution media and install it, using nsr_ize(8) or pkgadd(1M), depending on your system) and use mmrecov to rebuild the on-line index. Finally, you will want to recover files which previously existed on the machine, but which do not exist on the manufacturer's distribution media. This may include: system files which had been customized, a specially tailored kernel, new special device entries, locally developed software, and user's personal files.
nsr_data - Data formats for Legato Storage Manager Save and Recover
All data in the Legato Storage Manager system is encoded using the eXternal Data Representation (XDR) standard. When files are passed between client (see save(8) and recover(8)) and server (see nsrd(8)) and media (see nsrmmd(8)), they are represented as a savestream, which is encoded as a linked list of savefiles. There are currently 2 different savefile formats. A magic number at the start of each file indicates the particular type of the following savefile thus allowing for self identifying savestreams containing more than one savefile type. Logically each savefile consists of some header information followed by file data. The original savefile1 format uses a doubly wrapped set of client attributes describing the file attributes and the file data is encoded as a bucketlist. The newer savefile2 format uses an alternate singularly wrapped client attributes with the file data encoded as a bucket-less succession of self describing sections each containing a type, a length, and bytes of data. The file data section of a file is terminated by an ending section with a type of 0 (NSR_ASDF_END).
The XDR language description of the OS independent portion of the savestream data structures is shown below.
const NSR_IDLEN = 1024; /* length of file id */ const NSR_MAXNAMELEN = 1024; /* max length of file system name */ const NSR_MAXCATTRSIZE = 8192; /* max size of client specific attributes */ const NSR_MAXBUCKETDATA = 8192; /* max size of file bucket's data (w/o slop) */ const NSR_MAXBUCKETSIZE = 9000; /* max total size of file bucket (w/ slop) */ const NSR_MAXCLNTSIZE = 16384; /* max size of a clntrec */ typedef opaque fileid<NSR_IDLEN>; /* file identifier */ typedef string nsrname<NSR_MAXNAMELEN>; /* file name type */ typedef opaque clientattr<NSR_MAXCATTRSIZE>; /* client attributes */ sbtypedef opaque wraposaverec<NSR_MAXCLNTSIZE>;/* wrapped osaverec */ typedef nulong_t checksum; /* 4 bytes for checksum */ typedef u_long sfid_t; /* savefile id (offset) */ struct id {string id_str<>; /* id string */ id *id_next; /* next such structure */}; struct asmrec {id *ar_info; /* name and args to ASM */ nsrname *ar_path; /* not currently used */ asmrec *ar_next; /* next such structure */}; const NSR_MAGIC1 = 0x09265900; /* older format using buckets & ssaverec's */ struct osaverec {nsrname sr_filename; /* name of this file */ fileid sr_fid; /* client specific file id */ asmrec *sr_ar; /* ASM list for this file */ u_long sr_catype; /* client specific attribute type */ clientattr sr_cattr; /* client specific file attributes */}; struct ssaverec {sfid_t sr_id; /* savefile id in the savestream */ u_long sr_size; /* size of encoded savefile*/ nulong_t sr_savetime; /* savetime of this saveset*/ wraposaverec sr_wcr; /* a wrapped osaverec */}; /* * File data for older style savestream is logically * expressed as a linked list of file buckets. */ struct bucketlist {bucket bl_bucket; bucketlist *bl_next;}; /* * XDR description of the original savefile1 format. */ struct savefile1 {u_long sf_magic; /* magic number (must be NSR_MAGIC1) */ u_long sf_chksumtype; /* file checksum type */ ssaverec sf_saverec; /* wrapped file attributes */ bucketlist *sf_data; /* file data in buckets */ checksum sf_checksum; /* checksum value */}; /* * New savestream defines and structures. */ const NSR_MAGIC2 = 0x03175800; /* newer bucketless format */ const NSRAPP_BACKUP = 1; /* backup application name space */ const NSRAPP_HSM = 2; /* HSM application name space */ const NSRAPP_ARCHIVE = 3; /* Archive application name space */ struct saverec {sfid_t sr_id; /* savefile id in the savestream */ u_long sr_size; /* size of encoded savefile*/ nulong_t sr_savetime; /* savetime of this saveset*/ nulong_t sr_appid; /* application id */ nsrname sr_filename; /* name of encoded file */ fileid sr_fid; /* client specific file id */ asmrec *sr_ar; /* ASM list for this file */ u_long sr_catype; /* client specific attribute type */ clientattr sr_cattr; /* client specific file attributes */}; /* * Defines for self describing data sections. * The NSR_ASDF_END type defines the end of the file data. * The NSR_ASDF_FILE_DATA_TYPE type has the file data preceded * by a nulong_t that is the relative offset from the last * block into the file. */ const NSR_ASDF_END = 0x0; /* end of ASDF data */ const NSR_ASDF_FILE_DATA_TYPE = 0x100; /* normal file data */ /* * Describes a section of Legato Storage Manager "file data" * when using ASM Structured Data Format (ASDF) sections. */ struct asdf_hdr {nulong_t typevers; /* type of file data */ nulong_t length; /* section length */}; /* * Pseudo XDR description of the newer savefile2 format. * The new savefile2 format uses the unwrapped saverec * structure and a "bucketless" file data format that is based * on ASDF. The data portion ends with a 0 sized section of * type NSR_ASDF_END. */ struct savefile2 {u_long sf_magic; /* magic number (must be SF_MAGIC2) */ u_long sf_chksumtype; /* file checksum type */ saverec sf_saverec; /* new saverec structure */ <asdf_hdr & data> /* ASDF section sans buckets */ ... <asdf_hdr & data> /* ASDF section sans buckets */ <asdf_hdr.typevers = 0> /* final ASDF section type = NSR_ASDF_END */ <asdf_hdr.length = 0> /* final ASDF section len = 0 */ checksum sf_checksum; /* checksum value */};
|
See Also:
mm_data(5), nsr(8), nsrmmd(8), nsrd(8), recover(8), save(8), xdr(3n). |
nsr_device - Legato Storage Manager resource type "NSR device"
type: NSR device
Each storage device used by a Legato Storage Manager server is described by a single resource of type NSR device. See nsr_resource(5) for information on Legato Storage Manager resources. To edit the NSR device resources run:
nsradmin -c "type:NSR device"
Be sure to include quotation marks and to insert a space between NSR and device. See nsradmin(8) for information on using the Legato Storage Manager administration program. The mounting and unmounting of individual volumes (tapes or disks) is performed using the nsrmm(8) and nwadmin(8) commands.
The following attributes are defined for resource type NSR device. The information in parentheses describes how the attribute values are accessed. Read-only indicates that the value cannot be changed by an administrator. Read/write indicates a value that can be set as well as read. Hidden indicates a hidden attribute of interest only to programs or experts. These attributes can only be seen when the hidden option is turned on in nsradmin(8), or if the Details View option is selected in the Media Devices window in nwadmin(8). Static attributes change values rarely, if ever. Dynamic attributes have values that change rapidly. For example, an attribute marked (read-only, static) has a value that is set when the attribute is created and never changes.
name (read-only, static)
The name attribute specifies the path name of the device. Only non-rewinding tape devices are supported. For systems that support "Berkeley style" tape positioning,use the BSD tape device name. The name given to Optical disks is typically the name given to the "c" partition of the raw device.
A logical device type has been defined to facilitate interaction with external media management services. When interacting with external media management services, the device name may be determined by the media management service associated with the device where a volume is loaded. The logical device is used to define a Legato Storage Manager device resource. The number of device resources that can exist is limited by the number of volumes managed by the service that Legato Storage Manager may access simultaneously. The name given to a logical device is not related to any specific device, but is required to be a unique name for the device. For logical devices both the media type and the family are set to logical. The name, type, and family are determined after the media management service has loaded a volume into a device in response to a request made by Legato Storage Manager. 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 only exists when the volume is loaded into the device and allocated for use by Legato Storage Manager.
When defining a remote device on a storage node, include the prefix "rd=hostname:", in the path name; where hostname is the system to which the device is directly attached (the storage node). For more information, see
nsr_storage_node(5).
Example: name: /dev/rmt/0hbn;
media type (read-only, static)
This attribute indicates the type of media a device uses. The media type varies depending on the Operating System/platform. Potential values, their meaning, and default capacities are:
4mm - 4mm digital audio tape (1 GB);
8mm - 8mm video tape (2 GB);
8mm 5GB - 8mm video tape (5 GB);
dlt - digital linear tape cartridge (10 GB);
vhs - VHS data grade video tape (14 GB);
3480 - high-speed cartridge tape (200 MB);
qic - quarter inch data cartridge (150 MB);
himt - half inch magnetic tape (100 MB);
tk50 - DEC TK50 cartridge tape (94 MB);
tk70 - DEC TK70 cartridge tape (296 MB);
optical - optical disks, Write Once Read Many (WORM), Erasable Optical Disks (EOD), or standard UNIX files are supported;
file - file device type, standard UNIX file system is supported;
logical - used when interacting with an external media management service.
Example: media type: 8mm 5GB;
enabled (read/write)
This attribute indicates whether a device is available for use. The value for this attribute is either yes or no. If the value is set to no, no volumes may be mounted into the device. This value cannot be changed if a volume is mounted.
Example: enabled: yes;
read only (read-write)
This attribute indicates whether a device is reserved for read only operations, such as recover or retrieve. The value for this attribute can be either yes or no. If the value is set to yes, only read operations are permitted on the device. This value cannot be changed if when the volume is mounted.
Example: read only: yes;
target sessions (read/write)
This attribute indicates the target number of saves for a device. Saves are allocated to a device in sequential order, until the target number assigned to a device is reached and the next device is used. When all devices have reached their corresponding target number, additional sessions are allocated equally across all devices. This value can only be set by root or administrator.
Use higher values to multiplex many clients onto each tape. There might be value in spreading the clients over as many devices as possible. This attribute is not a maximum number for a device, but is used for load-balancing.
Example: target sessions: 3;
media family (read-only, static, hidden)
The media family attribute describes the class of storage media, as determined from the media type. The only legal values are: tape - tape storage device; disk - disk storage device; logical - used when interacting with an external media management service.
Example: media family: tape;
message (read-only, dynamic, hidden)
This attribute specifies the last message received from the Legato Storage Manager server regarding this device. The values for this attribute may include information on the progress or rate of the operation.
Example: message: "Tape full, mount volume mars.017 on /dev/nrst8";
volume name (read-only, dynamic, hidden)
This attribute monitors the mounting and unmounting of volumes for a device. When a volume is mounted, the value is the volume name, otherwise there is no value.
Example: volume name: mars.017;
write enabled (read/write, dynamic, hidden)
This attribute indicates whether writing to the current volume is allowed. The value for this attribute may be set to yes or no. This value can only be set when a volume is not mounted.
Example: write enabled: no;
volume operation (read/write, dynamic, hidden)
The volume operation attribute manipulates the media (volume) currently located inside the device. This attribute can be set to one of the following values: Unmount, Mount, Verify label, Verify write time, Label, Label without mount, Eject, or Monitor device. Each of these operations may require parameters to be set.
When the value is Unmount, Legato Storage Manager releases the device. The Unmount operation is asynchronous.
When the value is Mount, Legato Storage Manager mounts the loaded volume into the device. The Mount operation is asynchronous.
When the value is Verify label, the volume's label is read by Legato Storage Manager, and the attributes volume label and volume expiration are set. The Verify label operation is synchronous, and therefore the operation may take a long time to complete.
When the value is Verify write time, the volume's label is read by Legato Storage Manager, and the attributes volume label, volume expiration, and volume write time are set. The Verify write time operation is synchronous, and therefore the operation may take a long time to complete.
When the value is Label or Label without mount, the volume receives a new label as determined by the attributes below. When the value is Label, the volume is then mounted. These operations are asynchronous.
When the value is Eject, Legato Storage Manager ejects the volume from the device. The Eject operation is asynchronous.
When the value is Monitor device and the device is idle (no volume loaded into the device), Legato Storage Manager will periodically check the device to determine whether a volume has been loaded into the device. When a volume containing a readable Legato Storage Manager label is loaded, the volume is placed into the Legato Storage Manager media database. The volume can then be written to by Legato Storage Manager if the volume is mounted with write permissions turned on; otherwise, the volume is mounted as read only, and cannot be written to by Legato Storage Manager. When a volume without a readable Legato Storage Manager label is loaded into the device, the device's unlabeled volume loaded attribute is set to yes, and the volume may be labeled at a later date. The Monitor device operation is never performed on jukebox devices, because Legato Storage Manager only monitors non-jukebox devices.
volume label (read/write, dynamic, hidden)
This attribute is set by the Verify label operation and can be performed before the Label operation. If this attribute is blank during the labeling process, then the volume's current label is reused.
volume default capacity (read/write, static, hidden)
This attribute is used by the Label operation when the volume current capacity attribute is blank. A non-blank value is used to override the default capacity associated with the media type. The value of this attribute must end with K, M, or G, where K represents Kilobytes, M represents Megabytes, and G represents Gigabytes.
This hidden attribute can be modified by a user, and can be used to override default sizes when using devices (and/or tapes) with different capacities than the defaults.
Example: To override the default capacity of a tape drive to 10 Gb for all future volume label operations, set the value as follows:
volume default capacity: 10G;
volume current capacity (read/write, dynamic, hidden)
If the attribute's value is non-blank, it determines the capacity of a volume during the Label operation. Its format is the same as volume default capacity.
Example: volume current capacity: 5G;
volume expiration (read/write, dynamic, hidden)
This attribute is set by the Verify label operation and can also be used by the Label operation. The value for this attribute is specified in nsr_getdate(3) format. A blank value causes the default expiration to be used during labeling.
Example: volume expiration: next year;
volume pool (read/write, hidden)
This attribute indicates the pool that a mounted volume belongs to. If this attribute is set during a Label or Label without mount operation, this value will indicate the pool a volume is being assigned to. See nsr_pool(5) for more information on volume pools.
Example: volume pool: Default;
NSR operation (read-only, dynamic, hidden)
This attribute indicates the current operation being performed by a device. The valid values for this attribute are: Idle, Write, Read, Eject, Verify label, or Label.
Example: NSR operation: Write;
minor mode (read-only, dynamic, hidden)
This attribute indicates the current state of a device. The NSR operation attribute is the major mode. The valid values for this attribute are: idle, reading, writing, rewinding, moving forward, moving backward, error, done, writing eof, or finding eom.
Example: minor mode: moving forward;
statistics (read-only, dynamic, hidden)
This attribute reports the statistics for the operation of this device. The statistics include:
the time of operation ("elapsed"), the number of errors ("errors"), the last writing rate ("last rate"), the max number of concurrent clients ("max clients"), the number of file marks written ("file marks"), the number of rewinds ("rewinds"), the number of files skipped ("files skipped"), the number of records skipped ("records skipped"), the current file number ("current file"), the current record number ("current record"), the relative nhumber of files being spaced over ("seek files"), the relative number of records being spaced over ("seek records"), the total estimated amount read/written on the volume, in KB ("estimated KB", to be implemented in a future release), the total amount read/written on the volume, in KB ("amount KB"), the current amount read/written on this file, in KB ("file amount KB"), and the current number of sessions assigned to this device ("sessions").
cleaning required (read/write)
This attribute indicates whether a device needs to cleaned. The value for this attribute may be either yes or no. If the value of this attribute changes from yes to no and the value of date last cleaned attribute is not updated, then the date last cleaned attribute is set to the current time. Legato Storage Manager might set this attribute to yes if at the time the device is next scheduled to be cleaned it is not available to be cleaned. In this case, the following message is displayed: device cleaning required . This message indicates that the device needs to be cleaned. This attribute can only be used for a device whose media family is tape and jukebox device is yes. For all other devices the value of this attribute is always no.
cleaning interval (read/write)
This attribute indicates the amount of time from the date last cleaned until the next scheduled cleaning for the device. This value can be specified in days, weeks, or months. One day, week, or month is implied if a number is not specified. If this attribute is set and date last cleaned is blank, date last cleaned is set to the current time. This attribute may only be used for a device whose media family is tape and jukebox device is yes.
Example: cleaning interval: 2 weeks;
date last cleaned (read/write)
This attribute indicates the time and day a device was last cleaned. Input may be in any format acceptable to nsr_getdate(3). Some values acceptable to nsr_getdate(3) are relative, for example, now. For that reason all input is converted into ctime(3) format, weekday, month, day, time, year. As noted in the description of cleaning required and cleaning interval , the value of this attribute might be set automatically by Legato Storage Manager. This attribute can only be used for a device whose media family is tape and jukebox device is yes.
volume block size (read-only, dynamic, hidden)
This attribute indicates the block size of the currently mounted volume.
volume id (read-only, dynamic, hidden)
This attribute indicates the volume id for the currently mounted volume.
access count (read-only, dynamic, hidden)
This attribute indicates the total number of operations performed on the device since it was configured as a Legato Storage Manager device.
access weight (read-only, dynamic, hidden)
This attribute indicates the weight of a single operation performed on the device. The "access count" attribute will be incremented by "access weight" each time an operation performed on the device. The higher the weight, the less often the device will be selected for new operations.
consecutive errors (read-only, dynamic, hidden)
This attribute indicates the current number of consecutive errors on a device.
max consecutive errors (read-only, hidden)
This attribute indicates the maximum number of consecutive errors allowed before disabling the device.
operation arg (read-only, dynamic, hidden)
This attribute indicates extra parameters to be used during device operations. Parameters are packed into a string and parsed by the associated operation's function.
volume message (read-only, dynamic, hidden)
This attribute indicates the result of the last volume operation.
volume write time (read-only, dynamic, hidden)
This attribute indicates the time that a save set was first written to the volume.
volume flags (read/write, hidden)
This attribute displays the new flags for the volume being operated on. This attribute is used during "Label" or "Label without mount" operations.
jukebox device (read/write, dynamic, hidden)
This attribute indicates the media device that is part of a jukebox device. This value can be either yes or no.
unlabeled volume loaded (read only, dynamic, hidden)
This attribute indicates whether a volume loaded into the device has a readable Legato Storage Manager volume label. This value can be either yes or no. This attribute is set to yes when Legato Storage Manager is monitoring the device, a volume is loaded into the device, and the volume does not have a valid Legato Storage Manager label that can be read by this device. This attribute is set to no when the volume in the device is labeled or ejected from the device.
auto media management (read-write)
This attribute indicates whether "automated media management" is enabled for a device. For jukebox devices this value is always no. For non-jukebox devices, this value can be either yes or no. If this value is set to yes, then any recyclable volumes loaded into the device might be automatically re-labeled by Legato Storage Manager for re-use, and unlabeled volumes loaded into the device can be automatically labeled. When Legato Storage Manager is labeling a volume that is not expected to have a valid Legato Storage Manager label, it verifies that the volume is unlabeled before labeling the volume. A volume is considered to be unlabeled if the volume does not contain a label that may be read by this device.
Note: If a volume contains a label, but the label is written at a density that cannot be read by the associated device, the volume is considered to be unlabeled. If the volume contains data written by an application other than Legato Storage Manager, it most likely does not have a label recognizable by Legato Storage Manager, and the volume is considered to be unlabeled. With this attribute enabled, care should be taken when loading any volume considered to be unlabeled or recyclable into the device. The volume might be re-labeled and the data previously on the volume over-written by Legato Storage Manager.
When this attribute is set to yes for a device, and the device is idle (no tape loaded into the device), Legato Storage Manager will monitor the device and wait for a volume to be loaded. See the description of Monitor device in the discussion of the volume operation attribute.
Example: auto media management: yes;
logical name (read-only, hidden, no create)
This attribute indicates the name of the actual device associated with the logical device. This attribute is only used for logical devices.
Example: logical name: /dev/rmt/0hbn;
logical type (read-only, hidden, no create)
This attribute indicates the actual device type associated with the logical device. The values that can be associated with this attribute are the values that are valid for the attribute media type. The only exception is that the value of this attribute cannot be set to logical. This attribute is only used for logical devices.
Example: logical type: 8mm 5GB;
logical family (read-only, hidden, no create)
This attribute indicates the family of the actual device currently associated with the logical device. The values that can be associated with this attribute are the values that are valid for the attribute media family . The only exception is that the value of this attribute cannot be set to logical. This attribute is only used for logical devices.
Example: logical family: tape;
connection process id (read only, hidden, no create)
This attribute indicates the process identifier maintaining the connection with an external media management service.
External media management services often require a connection to be maintained while an application is using allocated resources. If the connection is not maintained the service may attempt to reclaim any resources allocated to an application. This may include unloading a volume currently mounted into a device. Therefore, while Legato Storage Manager has a volume mounted into a device being managed by such a service, a process must maintain an open connection with the media management service.
connection message (read only, hidden, no create)
This attribute records any error message(s) reported upon exit by a process maintaining a connection with an external media management service.
connection status (read only, hidden, no create)
This attributes records the exit status reported by a process maintaining a connection with an external media management service. A status of zero indicates that the process exited successfully. A non-zero status indicates an error occured while the process was exiting.
save mount timeout (read/write, hidden, no create)
This attribute indicates the timeout value for an initial save mount request for the storage node on which a device is located. If the request is not satisfied within the indicated time, the storage node will be locked from receiving save processes for the "save lockout" time. See nsr_storage_node(5) for a description of storage nodes. This attribute can be used for local devices as well, but "save lockout" cannot be changed from its default value of zero. Hence, local devices cannot be locked out from save requests.
save lockout (read/write, hidden, no create)
This attribute indicates the number of minutes a storage node will be locked from receiving save assignments after it reaches the save mount timeout time during a save mount request. A value of zero indicates that the node will not be locked. This attribute cannot be changed for local devices.
A complete example follows:
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 1999"; 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 1999"; 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/res/nsr.res - this file should never be edited directly. Use nsrmm(8), nsradmin(8), or nwadmin(8) instead.
|
See Also:
nsr_getdate(3), ctime(3), nsr_resource(5), nsr_pool(5), nsr_schedule(5), nsr_service(5), nsr_storage_node(5), nsr(8), nsrmmd(8), nsrmm(8), nsradmin(8), nwadmin(8) |
nsr_directive - Legato Storage Manager resource type ``NSR directive''
type: NSR directive
Each NSR directive is described by a single resource of type NSR directive (see
nsr_resource(5)). To edit the NSR directive resources for a Legato Storage Manager server use nsradmin(8) or nwadmin(8). See the corresponding manual page for more information on the use of these Legato Storage Manager administration programs.
These resources are used by the Legato Storage Manager asm family of commands when processing files, see uasm(8) and nsr(5). Directives can be used to improve the efficiency of backups by controlling which files get saved and specifying special handling on certain types of files.
The following attributes are defined for resource type NSR directive. The information in parentheses describes how the attribute values are accessed. Create-only indicates that the value cannot be changed after the resource has been created. Read/write means the value can be updated by authorized administrators. Hidden means it is an attribute of interest only to programs or experts, and these attributes can only be seen when the hidden option is turned on in nsradmin(8) or the details view is enabled in nwadmin(8). Dynamic attributes have values which change rapidly. Several additional attributes (for example, administrator) are common to all resources, and are described in nsr_resource(5).
name (create-only)
The names of directive resources are displayed as choices when creating or updating Legato Storage Manager client resources, see nsr_client(5). The name can generally be chosen at the administrator's convenience, but it must be unique for this Legato Storage Manager server. The directive resource named `Unix standard directives' may be modified, but it may not be deleted. Other directives can only be deleted if no clients or archive lists are using them.
Example: name: Unix standard directives;
directive (read/write)
This attribute contains the rules defining the directive. The value of this attribute is similar to the contents of a file except that absolute path names must be specified for each << path >> directive. See nsr(5) for more information on the format of Legato Storage Manager directives.
Example: directive: "<< / >> skip : core";
NOTE:
Legato Storage Manager comes with four directive resources already defined, "Unix standard directives", "Unix with compression directives", "DOS standard directives", and "NetWare standard directives". The first two are meant for use with clients running on UNIX platforms. "DOS standard directives" is intended for use with clients on machines running DOS. The last directive, "NetWare standard directives", is meant for use with clients running on NetWare platforms. There may also be two other directives "Default" and "Default with compression". These are old names for "Unix standard directives" and "Unix with compression directives", respectively. Legato Storage Manager will remove the directive resources using the old names when they are no longer of use.
An example NSR directive resource, named `Unix directive', follows:
type: NSR directive;name: Unix directive;directive: "<< / >>+skip : coreskip : tmp<< /usr/spool/mail >>mailasm : *<< /nsr >>allow";
nsr_getdate - Convert time and date from ASCII
#include <sys/types.h>
time_t nsr_getdate(buf)
char *buf;
The nsr_getdate() routine converts most common time specifications to standard UNIX format. It takes a character string containing time and date as an argumant and converts it to a time format.
The character string consists of zero or more specifications of the following form:
tod
A tod is a time of day, which is of the form hh[:mm[:ss]] (or hhmm) [meridian] [zone]. If no meridian - am or pm - is specified, a 24-hour clock is used. A tod may be specified as just hh followed by a meridian. If no zone (for example, GMT) is specified, the current time zone, as determined by the second parameter, now, is assumed.
date
A date is a specific month and day, and possibly a year. The acceptable formats are mm/dd[/yy] and monthname dd[, yy] If omitted, the year defaults to the current year. If a year is specified as a number in the range 70 and 99, 1900 is added. If a year is in the range 00 and 30, 2000 is added. The treatment of other years less than 100 is undefined. If a number not followed by a day or relative time unit occurs, it will be interpreted as a year if a tod, monthname, and dd have already been specified; otherwise, it will be treated as a tod. This rule allows the output from date(1) or ctime(3) to be passed as input to nsr_getdate.
day
A day of the week may be specified; the current day will be used if appropriate. A day may be preceded by a number, indicating which instance of that day is desired; the default is 1. Negative numbers indicate times past. Some symbolic numbers are accepted: last, next, and the ordinals first through twelfth (second is ambiguous, and is not accepted as an ordinal number). The symbolic number next is equivalent to 2; thus, next monday refers not to the immediately coming Monday, but to the one a week later.
relative time
Specifications relative to the current time are also accepted. The format is [number]unit; acceptable units are year, month, fortnight, week, day, hour, minute, and second.
The actual date is formed as follows: first, any absolute date and/or time is processed and converted. Using that time as the base, day-of-week specifications are added; last, relative specifications are used. If a date or day is specified, and no absolute or relative time is given, midnight is used. Finally, a correction is applied so that the correct hour of the day is produced after allowing for daylight savings time differences.
Nsr_getdate accepts most common abbreviations for days, months, etc.; in particular, it will recognize them with upper or lower case first letter, and will recognize three-letter abbreviations for any of them, with or without a trailing period. Units, such as weeks, may be specified in the singular or plural. Time zone and meridian values may be in upper or lower case, and with or without periods.
The grammar and scanner are rather primitive; certain desirable and unambiguous constructions are not accepted. Worse yet, the meaning of some legal phrases is not what is expected; next week is identical to 2 weeks.
The daylight savings time correction is not perfect, and can get confused if handed times between midnight and 2:00 am on the days that the reckoning changes.
Because localtime(2) accepts an old-style time format without zone information, passing nsr_getdate a current time containing a different zone will probably fail.
nsr_group - Legato Storage Manager resource type ``NSR group''
type: NSR group
Each Legato Storage Manager group is described by a single resource of type NSR group (see nsr_resource(5)). To edit the NSR group resources for a Legato Storage Manager server type:
nsradmin -c "type:NSR group"
or use the nwadmin(8) GUI. See the nsradmin(8) manual page for more information on using the Legato Storage Manager administration program.
These resources control when a group of Legato Storage Manager clients begin saving data and whether backups are started automatically each day. Each NSR client resource (see nsr_client(5)) lists the groups of which that client (or save sets for that client) is a member. Groups can only be deleted if no clients are members of them.
The following attributes are defined for resource type NSR group. The information in parentheses describes how the attribute values are accessed. Create-only indicates that the value cannot be changed by an administrator once the resource is created. Read/write means the value can be set as well as read at any time. Choice indicates that the value can only be selected from a given list. Yes/no means only a yes or no choice is possible. Static attributes change values rarely, if ever. Dynamic attributes have values which change rapidly. Hidden means it is an attribute of interest only to programs or experts, and these attributes can only be seen when the hidden option is turned on in nsradmin(8). For example, an attribute marked (create-only, static) has a value which is set when the attribute is created and never changes. Several additional attributes (for example, administrator) are common to all resources, and are described in nsr_resource(5).
name (create-only)
This attribute contains the name of the group defined by this resource. The name must be unique for this Legato Storage Manager server, but otherwise can be anything that makes sense to the administrator. This name will appear as a choice attribute of each NSR client and NSR pool(5) resource. The NSR group resource named `Default' may be modified, but it may not be removed. The name can only be specified when the group is created.
Example: name: marketing;
autostart (read/write, choice)
The autostart attribute determines if this group will be saved automatically every day. It may be one of three values: Enabled, Disabled or Start now. When the value is Enabled, the members of this group will start saving data at the time specified in the start time attribute. When the value is Disabled, the member of this group will not automatically start saving their data. When the Start now value is specified, the member clients will start saving their data immediately. The attribute will then return to its prior value.
Example: autostart: Enabled;
autorestart (read/write, choice, hidden)
This controls whether this group should be automatically restarted when an incomplete run (due to a power failure or administrator intervention) is noticed during Legato Storage Manager server startup. Like the autostart attribute, setting this attribute's value to Restart now causes Legato Storage Manager to restart the group immediately. Enabling autorestart only has an effect if autostart is also enabled.
stop now (read/write, choice, hidden)
Setting this value to `True' when this group is running causes this group to abort all of its saves immediately. Once the group is stopped, the value is set back to `False'. These are the only valid values.
start time (read/write)
The start time attribute specifies the time of day when this group will start saving. The Legato Storage Manager server's local time is used. The time is specified as "hours:minutes". Note that the quotes may be necessary when using character-based administration tools such as the nsradmin program because of the colon in the value. The hours may range from 0 to 23 (using a 24 hour clock) and the minutes range from 0 to 59.
Example: start time: "4:53";
last start (read/write, hidden)
The last time this group was started. This attribute is for informational purposes only, and changing it has no effect on the system.
interval (read/write, static, hidden)
The interval time specifies how often this group is to be run automatically by Legato Storage Manager. Manually starting a group overrides the interval. The default value is 24:00, which means run once a day.
force incremental (read/write, static, hidden, choice)
Setting this attribute to `Yes' will force an incremental level of a savegrp, when the interval attribute is less than 24 hours. The default value is `Yes,' which means force an incremental if the group is run more than once a day. A value of `No' would allow more than one full per day.
client retries (read/write)
The number of times failed clients should be retried before savegrp gives up and declare them failed. Zero means don't retry. Abandoned saves are not retried, because they may eventually complete. A client's save sets are retried by savegrp whenever savegrp would otherwise not be able to start a new save set. That is, savegrp prefers to start new save sets first, and only retries when there is nothing else to do.
Example: client retries: 1;
clones (read/write, static, yes/no, choice)
Setting this value to `Yes' causes saves of this group to automatically make a clone of every save set backed up. The save set clones will be sent to the pool named in the clone pool attribute.
clone pool (read/write, static, choice)
The pool to which save set clones should be sent when `clones' is `Yes'. Only pools of type `Backup Clone' are allowed (see nsr_pool(5)).
options (read/write, static, hidden)
The values specify flags with which this group will be run. The values No Monitor, No index save, No save, Verbose, Estimate, and Preview map to the the savegrp command line flags -m, -I, -n, -v, -E, and -p respectively. Some of these values (Preview and No save) are automatically reset when a run of savegrp completes normally.
Example: options: Verbose;
level (read/write, hidden, choice)
This is an explicit level the savegrp will use when started automatically by Legato Storage Manager. This hidden attribute can be modified by a user. This value is not cleared automatically, i.e. if one sets this attribute to full this savegrp will run with a full level until this value is manually cleared. When not specified (the normal case), the NSR Schedule for each client filesystem will be used to determine the level. Manually running savegrp from the command line overrides this value. The choices are the standard level identifiers `full', `consolidate', `incr', `skip', and the number levels `1' through `9'.
printer (read/write, static, hidden)
The printer to which the bootstrap save set information will be printed, if one is generated by the run of this group. This hidden attribute can be modified by a user. If an invalid printer name is specified, bootstrap information will be included in the savegrp completion information piped through the savegroup completion notification (see nsr_notification(5)).
Example: printer: ps;
schedule (read/write, choice, hidden)
The schedule to use for determining what level of save to perform. This hidden attribute can be modified by a user. This value is not cleared automatically, i.e. if one sets this attribute to a particular schedule, all clients which are part of this group will have their schedules overridden until this value is manually cleared. This overrides the schedule specified for individual clients. See nsr_schedule(5)).
schedule time (read/write, hidden)
An explicit time can be specified when looking at a schedule to determine which level of save to perform. A null value (normal setting) means use the current date to determine the level.
Example: schedule time: "3:00 am 01/11/93";
inactivity timeout (read/write, static, hidden)
The number of minutes that the savegrp command waits for any kind of activity on the server before concluding that a savegrp descendant is hung. This hidden attribute can be modified by a user. Once a hang is detected, savegrp prints a message indicating that a save is being aborted, kills or aborts the backup, and moves on to its next task. Inactivity is defined as the last time a client has sent data to the server. If a client has a very large filesystem and an incremental is run, it is possible for savegrp to abort a save set that only appears to be hung. In these cases, the inactivity timeout should be increased to accomodate the particular client.
Example: inactivity timeout: 30;
work list (read/write, dynamic, hidden)
The list of saves still not completed. These come in sets of 3 values: the client name, the level of save, and the path to save.
Example: work list: mars, incr, /usr, mars, incr, /g, mars, venus, /usr
completion (read/write, dynamic, hidden)
The status of each save set that has been completed. These come in sets of 4 values: the client name, the path saved, a status message (succeeded, failed, or unexpectedly exited), and the output from the save.
Example:
completion: "mars", "/usr", "succeeded", "mars: / level=full, 6577 KB 00:06:41 625 files"
status (read-only, dynamic, hidden)
The current status of this NSR group. Currently, this can have the values `idle', `running' and `cloning'. The value `idle' is set when the group is not active, it is `running' while backups are in progress, and it is `cloning' when the backups are complete and clones are automatically being made.
The default NSR group resource automatically starts its members at 33 minutes past 3 o`clock in the morning:
type: NSR group; name: Default; autostart: Enabled; start time: "3:33"; administrator: root;
A complete example follows, with the hidden attributes shown with values reasonable for an active group:
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, venus, incr, /usr, venus, incr, index, jupiter, full, /, jupiter, full, /usr, jupiter, full, index completion: mars, /, succeeded, "mars: / level=incr, 31 KB 00:01:01 72 files", mars, /usr, succeeded, "mars: /usr level=incr, 2 KB 00:00:48 5 files", venus, /, succeeded, "venus: / level=incr, 7711 KB 00:04:37 29 files"; administrator: root, &operator;
nsr_label - Legato Storage Manager resource type ``NSR label''
type: NSR label
Each NSR label template is described by a single resource of type NSR label (see nsr_resource(5)). To edit the NSR label resources for a Legato Storage Manager server, type:
nsradmin -c "type:NSR label"
or use the nwadmin(8) GUI. See the nsradmin(8) manual page for more information on using the Legato Storage Manager administration program.
This resource describes the templates used to generate volume labels.
The following attributes are defined for resource type NSR label. The information in parentheses describes how the attribute values are accessed. Several additional attributes (for example, administrator) are common to all resources, and are described in nsr_resource(5).
name (create-only, single string, static)
This attribute specifies the name of this label template.
Example: name: Default;
fields (read/write, list of strings)
This attribute specifies the constituent fields of a label template. When generating a volume name, the current value of each field is concatenated. The first field is considered the most significant, the last field the least. If there is a separator (see below) defined, then it will be placed between fields as they are concatenated to form a volume name. The fields are separated by commas.
There are four different types of fields: `numeric range', `lower-case range', `upper-case range', and a `list of strings'. A `list of strings' consists of space (` ') separated strings. The other types are specified as starting and ending values separated by a dash (`-') . The starting and ending values of a range must have the same number of characters.
The next attribute (see below) contains the current position or value of each field. After a volume name has been assigned to a volume, the next attribute is incremented. When the ending value is reached, the current value will wrap around to the starting value. A `list of strings' field is incremented by selecting the next string in the list. A numeric range field is incremented by adding 1 to its current value. Lower-case and upper-case ranges are incremented by moving on to the next letter in the least significant position. In the example below, after aa.99, the next label would be ab.00.
Example: fields: aa-zz, 00-99;
separator (read/write, single choice, null ok)
This attribute specifies the character to use to separate the label fields. It may be one of `.', `_', `:', `-' or NULL.
Example: separator: .;
next (read/write, single string)
This attribute specifies the next volume name to use. After it is assigned to a volume, the next volume name will be generated and remembered here. The attribute consists of a component for each of the specified fields and the separator.
Example:
next: aa.00;
Using the separator and field attributes shown above, the next attribute would show: next:aa.01;
This would be followed by: next:aa.02;
A label resource named engineering is shown below. (Hidden options are not shown.) There are two range type fields defined, the first ranging from `aa' to `zz', the second from `00' to `99'. The separator attribute has the value `.' and it will be inserted in between the two fields. The next attribute holds the next name that will be generated by this template. After aa.00 is used, the 00 will be incremented. The new name will be aa.01. After 98 more names have been generated, the next attribute will hold the name aa.99. When this name is incremented, the next attribute will hold ab.00. After generating 67,500 more names, the next attribute will hold zz.99. This will be followed by aa.00.
type: NSR label;name: engineering;fields: aa-zz, 00-99;separator: .;next: aa.00;
A label resource named accounting is shown below. The field attribute defines five component fields. The separator attribute has the value `.'. It will be inserted in between adjacent fields. The next attribute holds the next name that will be used with this template. After 0.23.aa.AA.first is used, the fifth field will be incremented. The new name will be 0.23.aa.AA.second. This will be followed by 0.23.aa.AB.first. After 1349 more volume names, the name will be 0.23.aa.ZZ.second. This will be followed by 0.23.ab.AA.first. After using 9.45.zz.ZZ.second, the name will wrap around to 0.23.aa.AA.first.
type: NSR label; name: accounting; fields: 0-9, 23-45, aa-zz, AA-ZZ, first second; separator: .; next: 0.23.aa.AA.first;
nsr_layout - Legato Storage Manager file layout
The Legato Storage Manager server filesystem has a directory called /nsr that contains log files, on-line indexes, and configuration information. This directory can be created in any filesystem with /nsr set up as a symbolic link to the actual directory (this is determined at installation time). The format of this directory is as follows:
/nsr/logs
Contains server logging messages. The files in this directory are in ASCII format.
/nsr/res
Contains the configuration files for various components of the Legato Storage Manager server. For example, the server stores configuration files in /nsr/res/nsr.res and /nsr/res/nsrjb.res.
/nsr/mm
Contains the media index. Information about the contents of this index file can be printed with the nsrls(8) command. See the nsrmm(8) and mminfo(8) manual pages on how to view and manipulate the media index information.
/nsr/index
This directory contains subdirectories with names that correspond to the Legato Storage Manager clients that have saved files. Each index directory contains files that allow the Legato Storage Manager server to provide an on-line database of the client's saved files. The most important element is the db directory which contains the Legato Storage Manager save records and access indexes to those records. The disk space utilized by the index grows with the number of files saved by the Legato Storage Manager service. Administrators should plan to use about 200 bytes per saved file instance placed in this index. There are no practical limits on the maximum size of an online index, except that it must reside entirely within a single file system.
The format of the db directory is subject to change, and is accessible only through an RPC interface to nsrindexd(8). However, the command nsrls(8) can be used to obtain some useful statistics from this directory. The nsrck(8) command is used for checking and rebuilding index files.
/nsr/cores
Contains directories that correspond to the Legato Storage Manager server daemons and certain executables. Each directory may contain core files from Legato Storage Manager server daemons or executables that have abnormally terminated.
/nsr/drivers
This directory may contains any device drivers for use with Legato Storage Manager.
/nsr/tmp
This directory contains temporary files used by the Legato Storage Manager system.
The executables for the Legato Storage Manager system are usually installed in the directories /usr/etc or /usr/bin, though alternate locations may be chosen when the nsr_ize(8) installation script is run. Alternate locations are not available on SCO systems that install with custom(ADM). See pkgadd(1M) for details on alternate executable locations for Solaris 2.x.
When executables for more than one architecture are installed, the non-native architectures are by default put in the directory /export/exec/arch/etc, where arch refers to a given architecture name. A different location to install non-native executables can be chosen at installation time.
/nsr
Legato Storage Manager indexes, log files, and configuration information.
/usr/etc, /usr/bin
Where Legato Storage Manager executables for the native architectures are normally installed.
/export/exec/arch/etc
Where Legato Storage Manager executables for non-native architectures are normally installed.
/usr/bin, /usr/sbin, /usr/lib/nsr
Where Legato Storage Manager executables for Solaris 2.x are normally installed.
nsr_license - Legato Storage Manager resource type ``NSR license''
type: NSR license
A resource of type NSR license is used to describe each feature enabled in your Legato Storage Manager installation. See nsr_resource(5) for more information on Legato Storage Manager resources. To inspect the NSR license resources type:
nsradmin -c "type:NSR license"
or use the nwadmin(8) GUI. NSR license resources may be created, enabled and authorized from the GUI, but the nsrcap(8) command must be used to update an existing license resource. See nsradmin(8) for more information on using the Legato Storage Manager administration program.
The following attributes are defined for resource type NSR license. The information in parentheses describes how the attribute values are accessed. Create-only indicates that the value cannot be changed by an administrator, except when the resource is created. Read/write means the value can be changed at any time by authorized administrators. Static attributes change values rarely, if ever. Hidden means it is an attribute of interest only to programs or experts, and these attributes can only be seen when the hidden option is turned on in nsradmin(8) or by selecting the details Menu Item in the View Menu for the Server Registration window in nwadmin(8). For example, an attribute marked (create-only, static) has a value which is set when the attribute is created and never changes. Several additional attributes (for example, administrator) are common to all resources, and are described in nsr_resource(5).
name (create-only, static)
This attribute holds the name of the license resource.
enabler code (create-only, static)
This code is identical to the code entered into the nsrcap(8) command to enable the feature named in this resource. The enabler code consists of 18 hexidecimal digits, printed in groups of 6 digits.
Example: enabler code: 123456-123456-123456;
host id (read-only, dynamic)
The unique host id associated with the computer or licensed operating system on which the enabler has been loaded. This value will often be an 8 digit hexidecimal number, however other formats are possible, depending on specific platform requirements.
Example: host id: 7260d859;
expiration date (read-only)
The date on which this enabler will expire, if the enabler is an evaluation enabler or an otherwise un-registered license enabler. The enabler expires at 12:00:01 am on the date listed. The special prefix G means that a grace period has been allowed for this enabler. Enablers with the grace period allowed should be registered immediately. If the enabler has been registered, and the auth code is filled in with a valid value, the value will be as shown in the example, below.
Example: expiration date: Authorized - no expiration date;
auth code (read/write)
An 8 digit hexidecimal value used to permanently authorize an enabler. The unique, valid auth code for an enabler is obtained from Legato by registering each purchased license enabler. Eval enablers cannot be permanently authorized. If the server's host id changes, all auth codes will immediately be invalidated, and the enablers must be re-registered with Legato to obtain new auth codes.
Example: auth code: abcdef00;
license type (create-only, hidden)
A special code, used internally to describe the specific feature or features enabled by this license enabler.
Example: license type: J16;
checksum (read/write, hidden)
A coded checksum used to maintain consistency of a NSR license resource, and between license resources.
Below is a complete NSR license resource for an authorized base enabler:
type: NSR license;name: Legato Storage Manager 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/res/nsr.res - this file should never be edited directly. Use nsradmin(8) instead.
nsr_migration - Legato Storage Manager resource type ``NSR migration''
type: NSR migration
Each NSR migration client is described by a single resource of type NSR migration (see nsr_resource(5)). To edit the NSR migration resources for a Legato Storage Manager server type:
nsradmin -c "type:NSR migration"
See the nsradmin(8) manual page for more information on using the Legato Storage Manager administration program. The client resource may also be edited using the command nwadmin(8).
For each Legato Storage Manager migration client, this resource describes which files should be saved, the schedule used to save these files, which directive should be used to omit files from the save, the group that files will be pre-migrated with, the high-water mark for migration, the low-water mark for migration, the minimum last access time for file migration, the minimum file size for migration, a list of file owners and groups to include or exclude for migration, and a list of file name patterns to skip migration of. A client may have more than one resource describing it.
The following attributes are defined for resource type NSR migration. The information in parentheses describes how the attribute values are accessed. Read-only indicates that the value cannot be changed by an administrator. Read/write means the value can be set as well as read. Hidden means it is an attribute of interest only to programs or experts, and these attributes can only be seen when the hidden option is turned on in nsradmin(8) or by selecting the details Menu Item in the View Menu for a particular window in nwadmin(8). Dynamic attributes have values which change rapidly. Encrypted attributes contain data that is not displayed in its original form. The assumption is that the data is sensitive in nature and needs to be protected from accidental disclosure. Several additional attributes (for example, administrator) are common to all resources, and are described in nsr_resource(5).
name (read-only, single string)
This attribute identifies the Legato Storage Manager client and save set whose migration attributes are stored in this resource.
Example: name: venus All;
client (read-only, single string)
The client name identifies the HSM client whose save sets are to be placed under migration control. This name must be a valid name for an existing NSR client resource.
Example: client: elantra;
save set (read/write, list)
The save set attribute lists the path names of filesystems or sub-trees within filesystems to put under migration control for this client. The names should be separated by comma space (, ). The default value is `All'. On UNIX clients, `All' refers to all mounted file systems, except for the filesystems /, /usr, /var (and /opt on solaris), where migration of files is not allowed.
Example: save set: /usr/src, /spare;
enabled (read/write, choice)
The enabled attribute determines whether the save set named in this resource should be automatically migrated. A resource can be disabled to temporarily keep migration from occuring. On update, any ongoing migration operations will complete. This attribute has no affect on recall operations.
Example: enabled: No;
directive (read/write, choice)
Directives tell the client how to migrate certain files. The choices are defined by the set of existing directives. The default value is NULL. The valid choices for the directive resource are names of the currently defined `NSR directive' resources, see nsr_directive(5).
Example: directive: Unix with compression directives;
group (read/write, list)
The groups this client/saveset is part of for pre-staging migrated files. The choices are defined by the set of existing groups.
Example: group: Default;
high water mark (%) (read/write, single string)
The point at which files should start being replaced by stubs, measured as the percentage of available space used on the file system. Migration (stub replacement) will continue until the lower water mark is reached.
Example: high water mark (%): 90;
low water mark (%) (read/write, single string)
The point at which files should be stop being replaced by stubs, measured as the percentage of available space used on the file system.
Example: low water mark (%): 80;
last access time (read/write, single string)
Migrate only those files that have not been accessed in the past specified relative time. If this value is empty, the last access time to not be considered.
Example values: 5 days ago, 1 month ago, 1 second ago.
Example: last access time: 7 days ago
minimum file size (KB) (read/write, single string)
Migrate only those files that are larger than then specified size (in KiloBytes). Setting this value to zero causes file size to not be considered.
Example: minimum file size (KB): 5;
file owner (read/write, list)
A list of the users whose files should be migrated. A leading dash (`-') in a user name indicates negation, in which case all users except the named user's files will be migrated.
Example: file owner: karl, cohrs;
file group (read/write, list)
A list of the groups whose files should be migrated. A leading dash (`-') in a group name indicates negation, in which case all groups except the named group's files will be migrated.
Example: file group: staff, developers;
preserve (read/write, list)
A list of regular expressions, in the client shell syntax (for example, /bin/sh syntax on UNIX). A file name which matches any pattern in the list will be preserved and will never be migrated.
Example: preserve: *.exe *.dll;
statistics (read/write, hidden, list)
A list of statistics about recent migration activity for the save set(s) managed using this resource. The first value is the last update time. Subsequent groups of values contain a save set name, and statistics. The statistics are currently a date, K-bytes pre-migrated, files pre-migrated, K-bytes stubbed, files stubbed, K-bytes de-migrated and files de-migrated.
update statistics (read/write, hidden, choice)
This controls whether the statistics in this resource should be updated to match the current values on the client. Selecting "Yes" causes the statistics to be updated, but the attribute value will not actually change.
Example: update statistics: No;
Note: The hidden options are not shown in these examples.
A resource to define an HSM client, called elantra, migrating and recalling files in the /test filesystem from a Legato Storage Manager server:
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;
A resource to define an HSM client, called elantra, migrating and recalling files owned by the user "karl" in all filesystems except for /, /usr, and /var (and /opt on solaris), to the Legato Storage Manager server jupiter:
type: NSR migration;name: "elantra:All";client: elantra;save set: All;enabled: Yes;directive: Unix with compression directives ;group: Default ;high water mark (%): 90;low water mark (%): 60;last access time: ;minimum file size (KB): 10;file owner: ;file group: ;preserve: ;
|
See Also:
nsr(5), nsr_directive(5), nsr_group(5), savegrp(8), savefs(8), nsrpmig(8), nsrmig(8), nsrhsmck(8), nsradmin(8), nsrexecd(8), nwadmin(8) |
nsr_notification - Legato Storage Manager resource type ``NSR notification''
type: NSR notification
A resource of type NSR notification is used for each combination of an event, priority, and action handled by the Legato Storage Manager notification system. A Legato Storage Manager 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 (by executing the command listed in the action, with the message on standard input) that includes that event type and priority. See
nsr_resource(5) for more information on Legato Storage Manager resources. To edit the NSR notification resources type:
nsradmin -c "type:NSR notification"
or use the nwadmin(8) GUI. See nsradmin(8) for more information on using the Legato Storage Manager administration program.
The following attributes are defined for resource type NSR notification. The information in parentheses describes how the attribute values are accessed. Create-only indicates that the value cannot be changed by an administrator, except when the resource is created. Read/write means the value can be changed at any time by authorized administrators. Choice list means that any number of values can be chosen from the given list. Single string means that only a single value is allowed. Static attributes change values rarely, if ever. Hidden means it is an attribute of interest only to programs or experts, and these attributes can only be seen when the hidden option is turned on in nsradmin(8) or expert mode (-x) in nwadmin(8). For example, an attribute marked (create-only, static) has a value which is set when the attribute is created and never changes. Several additional attributes (for example, administrator) are common to all resources, and are described in nsr_resource(5).
name (create-only, static)
This attribute holds the name of the notification resource.
event (create-only, choice list, hidden)
Each value is a class of events that will trigger the given notification. More than one class may be selected. Valid values are: Media for events related to the media multiplexor subsystem, Savegroup for events generated by the savegrp(8) command (usually the nightly automatic backups), Index for events related to the on-line file index subsystem, Registration for events caused by changes in the product's registration status (for example, a license that will soon time out), and Server for other Legato Storage Manager server events, such as restarting.
Example: event: Media;
priority (create-only, choice list, hidden)
Each value is a priority at which the notification will be triggered. More than one priority may be selected. The valid values in increasing priority order are Info - supplies information about the current state of the server; Notice - an important piece of information; Warning - information about a non-fatal error; Waiting - the server is waiting for an operator to perform a routine task, such as mounting a tape; Critical - the server detected an error condition that should be fixed by a qualified operator; Alert - a severe error condition that demands immediate attention; Emergency - a condition that may cause Legato Storage Manager to fail unless corrected immediately.
Example: priority: Notice;
action (read/write, single string)
The value is a command line to be executed when the given event occurs. The command line is run (see popen(3s)) with the event information connected to standard input. Typical actions are to log the message with the syslog(3) package, or send electronic mail to a system operator.
Example: action: /usr/ucb/mail -s "savegroup completion" root;
A complete example follows with two resources, one for mail and one using the syslog mechanism:
type: NSR notification; name: savegroup completion; administrator: root; action: /usr/ucb/mail -s \"savegroup completion\" root; event: Savegroup; priority: Notice;type: NSR notification;name: log default;administrator: root;action: /usr/ucb/logger -p daemon.notice -f -;event: Media, Savegroup, Index, Server,Registration;priority: Info, Notice, Warning, Waiting,Critical, Alert, Emergency;
/nsr/res/nsr.res - this file should never be edited directly. Use nsradmin(8) instead.
|
See Also:
nsr_resource(5), nsr_service(5), nsr_device(5), nsr(8), nsrmm(8), syslog.conf(5), syslog(3), nsradmin(8), nsrmmd(8), nwadmin(8) |
nsr_policy - Legato Storage Manager resource type ``NSR policy''
type: NSR policy
Each Legato Storage Manager policy is described by a single resource of type
NSR policy (see nsr_resource(5)). To edit the NSR policy resources for a Legato Storage Manager server, type:
nsradmin -c "type:NSR policy"
See nsradmin(8) for more information on using the Legato Storage Manager administration program.
These resources control 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 (see nsr_client(5)) uses two policies, a browse policy and a retention policy. Policies can only be deleted if no clients are using them.
Each policy defines an amount of time. The amount of time is determined by the period and the number of periods.
The following attributes are defined for resource type NSR policy. The information in parentheses describes how the attribute values are accessed. Create-only indicates that the value cannot be changed by an administrator once the resource is created. Read/write means the value can be set as well as read at any time. Several additional hidden attributes (for example, administrator) are common to all resources, and are described in nsr_resource(5).
name (create-only)
This attribute contains the name of the policy defined by this resource. The name must be unique for this Legato Storage Manager server, but otherwise can be anything that makes sense to the administrator. This name will appear as a choice attribute of each NSR client resource. The NSR policy resources named "Quarter" and "Year" may be modified, but may not be removed. The name can only be specified when the group is created.
Example: name: life cycle;
period (read/write)
The period attribute determines the base unit for this policy. It may be one of four values: Days, Weeks, Months or Years. A week is defined as 7 days, a month as 31 days, and a year as 366 days.
Example: period: Months;
number of periods (read/write)
The number of periods attribute specifies the number of base units to use.
Example: number of periods: 3;
The following NSR policy resource named "Quarter" defines a period of 3 months, or one quarter of a year:
type: NSR policy;name: Quarter;period: Months;number of periods: 3;
nsr_pool - Legato Storage Manager resource type ``NSR pool''
type: NSR pool
Each NSR pool is described by a single resource of type NSR pool (see
nsr_resource(5)). To edit the NSR pool resources for a Legato Storage Manager server type:
nsradmin -c "type:NSR pool"
Be careful to include the quotes and the space between ``NSR'' and ``pool''. See the nsradmin(8) manual page for more information on using the Legato Storage Manager administration program.
These resources are used by Legato Storage Manager to determine what volumes save sets should reside on depending upon the characteristics (for example, Group or Level) of the save. Consult your Legato Storage Manager Administrator's Guide for more guidelines on using pools.
There are four types of pools. Backup pools accept data from savegrp and manual backups. Archive pools accept archive data. Data cloned from a backup pool can be directed to a backup clone pool. Likewise, archive data can be cloned to a archive clone pool.
There are four pools shipped pre-enabled with Legato Storage Manager. The Default pool is meant to collect any backup data not directed to a pool a user creates with selection criteria. Any archive data not directed to a pool with selection criteria is collected in the Archive pool. When cloning data, the user must select a destination pool for the operation. The Default clone pool is available for users to clone backup data to. The Archive clone pool is available for users to clone archive data to.
There are also a few pools shipped with Legato Storage Manager that are not enabled by default. The Full and NonFull pools can be used to segregate full level backups from other backups, for example, fulls versus incrementals. The Offsite pool can be used to generate offsite backups, because no index entries are stored for the media pool and will not be referenced during normal recovers. Note that one can also clone media to produce copies of data to be taken offsite. Save sets that are generated without index entries can still be recovered using ``Save Set Recover'' feature of nwadmin(8) or recover(8).
The following attributes are defined for resource type NSR pool. The information in parentheses describes how the attribute values are accessed. Create-only indicates that the value cannot be changed after the resource has been created. Read/write means the value can be updated by authorized administrators. Yes/no means only a yes or no choice is possible. Choice indicates that the value can only be selected from a given list. Hidden means it is an attribute of interest only to programs or experts, and these attributes can only be seen when the hidden option is turned on in nsradmin(8) or if the Details View option is selected in the Media Pools window in nwadmin(8).
name (create-only)
The names of pool resources are used when labeling volumes and when determining what volumes a save set should reside on. The name can generally be chosen at the administrator's convenience, but it must be unique for this Legato Storage Manager server. The pool resources named Default, Default Clone, Archive, and Archive Clone may not be modified or deleted. The pool resource named Full and NonFull may not be deleted. Other pools can only be deleted if no volumes still reference them.
Example: name: Accounting;
groups (read/write, choice)
What groups (nsr_group(5)) are allowed in this pool.
Example: groups: Accounting;
clients (read/write, choice)
What clients (nsr_client(5)) are allowed in this pool. If a group is specified, only clients that are members of that group are allowed to be listed.
Example: clients: mars;
save sets (read/write, choice)
What save sets (nsr_client(5)) are allowed in this pool. Save sets can be matched using the regular expression matching algorithm described in nsr_regexp(5)).
Example: save sets: /, /usr;
levels (read/write, choice)
What levels (nsr_schedule(5)) are allowed in this pool.
Example: levels: full;
archive only (read/write, yes/no, hidden, create)
If yes is selected, only archive saves are allowed to this pool. This hidden attribute can be modified by a user.
Example: archive only: no;
status (read/write, hidden, choice)
If set to enabled, this pool is considered for determining what pools a save set should be saved to when performing backup volume selection. If set to clone, this pool is considered only as the destination of cloning operations. If set to disabled, this pool is completely ignored. This hidden attribute can be modified by a user.
Example: status: enabled;
label template (read/write, choice)
Determine what label template (nsr_label(5)) is referenced when generating volume names for this pool.
Example: label template: Accounting;
devices (read/write, choice)
This attribute lists the only devices volumes from this pool are allowed to be mounted onto. If no devices are listed, volumes from this pool may be mounted on any device.
Example: devices: /dev/nrst8;
store index entries (read/write, yes/no, choice)
If set to yes, entries are made into the file indexes for the backups. Otherwise, only media database entries for the save sets are created.
Example: store index entries: yes;
auto media verify (read/write, yes/no, choice)
If set to yes, Legato Storage Manager verifies 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. Media is verified whenever a volume becomes full while saving and it is necessary to continue onto another volume, or when a volume goes idle because all save sets being written to the volume are complete. When a volume fails verification it is marked full so Legato Storage Manager will not select the volume for future saves. The volume remains full until it is recycled or a user marks it not full. If a volume fails verification while attempting to switch volumes all save sets writing to the volume are terminated.
Example: auto media verify: yes;
recycle to other pools (read/write, yes/no, choice)
This attribute determines whether or not a given pool allows other pools to recycle its recyclable volume for their use.
Example: recycle to other pools: yes;
recycle from other pools (read/write, yes/no, choice)
This attribute determines whether or not a given pool can recycle volumes from other pools when it exhausts all its writeable and recyclable volumes.
Example: recycle from other pools: yes;
volume type preference (read/write, choice)
The volume selection preference attribute is used as a selection factor when a request is made for a write-able volume. The preferred type will be considered first within a priority level such as jukebox or stand alone device.
Example: volume type preference: 4mm;
A complete NSR pool resource, named `Default', follows:
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;
|
See Also:
nsr(5), nsr_label(5), nsr_resource(5), nwrecover(8), recover(8), savegrp(8), savefs(8), uasm(8) |
nsr_regexp - Regular expression syntax
This manual page describes the regular expression handling used in Legato Storage Manager. The regular expressions recognized are described below. This description is essentially the same as that for ed(1).
A regular expression specifies a set of strings of characters. A member of this set of strings is said to be matched by the regular expression.
Form Description
nsr_repack_schedule - Legato Storage Manager resource type ``NSR repack schedule''
type: NSR repack schedule
Each Legato Storage Manager repack schedule is described by a single resource of type NSR repack schedule (see nsr_resource(5)). To edit the NSR repack schedule resources for a Legato Storage Manager server, type:
nsradmin -c "type:NSR repack schedule"
or use the nwadmin(8) GUI. See nsradmin(8) for more information on using the Legato Storage Manager administration program.
This resource describes what day(s) that a volume may be repacked (see nsrrepack(8) and nsr_pool(5)). There is one NSR repack schedule resource for each Legato Storage Manager repack schedule.
The following attributes are defined for resource type NSR repack schedule. The information in parentheses describes how the attribute values are accessed. Read-only indicates that the value cannot be changed by an administrator. Read/write means the value can be set as well as read. Several additional hidden attributes (for example, administrator) are common to all resources, and are described in nsr_resource(5).
name (read/write)
Specifies the repack schedule's name. The repack schedule is referred to by its name in client resources.
Example: name: monthly_fulls;
period (read-only)
Specifies the length of the repack schedule's period. It may be either "Week" or "Month". "Week" repack schedules repeat every 7 days and start on Sunday. "Month" repack schedules start over at the first of each month. The default is "Week".
Example: period: Month;
action (read/write)
Specifies the sequence of actions making up the repack schedule. One entry is used for each day of the repack schedule. The entries must be separated by whitespace, for example, blanks or tabs. The valid actions are `repack' and `skip'. The actions repack and skip may be abbreviated `r' and `s', respectively. `Repack' permits repacking while `skip' disallows it.
When the action attribute does not contain enough entries to account for every day in the period, Legato Storage Manager will repeat the list of actions when the end of the action list is reached.
Example: action: r s s s s s s;
override (read/write)
Specifies a list of actions and dates overriding the actions specified in the action attribute. The format of the override specification is actiondate. action must be one of `repack' or `skip'. date must be of the form `month/day/year'. Action/date pairs are separated by a commas (,). Month and day are 2-digit numbers; year may be either 2 or 4 digits. If the year is 2 digits, numbers in the range 70-99 are assumed to be offsets from 1900; those in the range 00-69 are assumed to be offset from 2000.
Example: override: repack 1/1/1999, repack 6/1/1999;
The following defines an NSR repack schedule resource named `Default'. The Default repack schedule may be modified, but it may not be deleted. Each Legato Storage Manager server must have a Default repack schedule. This repack schedule has a period of one week, does a repack on Sunday, followed by 6 skips. There are no override actions specified.
type: NSR repack schedule;name: Default;period: Week;action: r s s s s s s;override: ;
The following defines a repack schedule named `quarterly'. It has a period of one month. The action attribute specifies repack and skips. In the override attribute, repacking is specified for the first day of each quarter. Note that there are only 7 entries in the action attribute. Upon reaching the end of the list, Legato Storage Manager will start over at the beginning of the list, performing a repack.
type: NSR repack schedule;name: quarterly;period: Month;action: repack skip skip skip repack skip skip;override: repack 1/1/1998, repack 3/1/1998, repack6/1/1998, repack 9/1/1998, repack 1/1/1999;
nsr_resource - Legato Storage Manager resource format
resource ::= attribute list <blank line>
attribute list ::= attribute [ ; attribute ]*
attribute ::= name [ : value [ , value ]* ]
name, value ::= <printable string>
The Legato Storage Manager system uses files containing resources to describe itself and its clients. Each resource represents a component of the Legato Storage Manager system that might need administration. Devices, schedules, and clients are examples of Legato Storage Manager resources. The system administrator manipulates resources to control the Legato Storage Manager system. The file and the resources in them are accessible through the nwadmin(8) and the nsradmin(8) programs. They can also be viewed with a normal text editor.
The files all share a common format. The same format is used by the nsradmin(8) program. Each resource is described by a list of attributes, and ends in a blank line. Each attribute in the attribute list has a name and an optional list of values. The attribute name is separated from the attribute values 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. A line beginning with a pound-sign (#) is a comment and the rest of the line is ignored. The back-slash character can also be used to escape the special meaning of other characters (comma, semicolon, pound-sign, and back-slash).
The attribute name and values can contain any printable character. Upper and lower case is not distinguished on comparisons, and extra white space is removed from both ends but not from inside of names and values. For example,
Name: this is a test;
matches
name : This Is A Test ;
but is different from
Name: this is a test;
In the following example resource, there are eight attributes. They are type, name, server, schedule, directive, group, save set, and remote access. The remote access attribute has no value.
type: NSR client;name: venus;server: earth;schedule: Default;directive: Unix standard directives;group: Default;save set: All;remote access: ;
In the following resource, there are six attributes. The administrator attribute has three values: &engineering, root, and operator. Note that the three values are separated by commas. The action attribute has one value: incr incr incr incr incr full incr. Note that this is a single value - it just happens to have spaces separating its words.
type: NSR schedule;action: incr incr incr incr incr full incr;administrator: &engineering, root, operator;name: engineering servers;override: ;period: Week;
Each Legato Storage Manager resource includes seven special attributes: type, name, administrator, hostname, ONC program number, ONC version number, and ONC transport. The type and name attributes are normally visible, but the others attributes are hidden. That an attribute is hidden indicates that it is infrequently used and perhaps esoteric. Frequently, hidden attributes should not be changed by the user.
The type attribute defines which other attributes a resource can contain. For example, a resource with type NSR client will always include the attribute server, while a resource of type NSR schedule does not.
The name attribute is a descriptive name of the object that a resource represents. In the first example above, the name attribute is the name of the Legato Storage Manager client machine. In the second example, the name attribute describes a schedule used to back up the the servers in the engineering department.
The administrator attribute is the list of users that have permission to modify or delete this resource. This attribute is inherited from the type: NSR resource when a new resource is created. The administrator of the NSR resource also controls who has permission to create and delete Legato Storage Manager resources.
The hostname attribute specifies the hostname of the machine on which the service that controls this resource is running. It is used internally and cannot be changed by the administrator.
The remaining attributes (ONC program number, ONC version number, and ONC transport) specify the Open Network Computing information for this service. They should never be changed manually.
In some cases, the resource identifier will be visible. Although it may look like an attribute, it is an internal value that is set and used by the Legato Storage Manager system to provide unique identification of each resource. When new resources are created in the edit command of nsradmin(8), the resource identifier attribute should be left off. This signals that this is a new resource and a new identifier will be assigned.
Legato Storage Manager resources are implemented by the Legato Resource Administration Platform, which is described in the resource(5) manual page. This flexible architecture means that in future releases of Legato Storage Manager, more resource types or attributes may be added, and the administration tools in this release will automatically be able to use them. To make this possible, each server provides type descriptors that are used internally to describe the attributes of each type, between the administration tools and the services. These type descriptors may cause limitation on the values, such as only allowing a single value, allowing no value, or only numeric values.
This release of Legato Storage Manager defines the following types of resources:
NSR
This resource describes a Legato Storage Manager server. It contains attributes that control administrator authorization, information about operations in progress, and statistics and error information about past operations. For more information see the nsr_service(5) manual page.
NSR client
This resource describes a Legato Storage Manager client. It includes attributes that specify the files to save, which schedule to use, and which group this client belongs to. There may be more than one client resource for a Legato Storage Manager client. This allows a client to save files on different schedules. For more information see the nsr_client(5) manual page.
NSR device
This resource type describes a storage device. It includes attributes that specify a particular device name (for example, /dev/nrst1), media type (for example, 8mm), and the name of the currently mounted volume. It also provides status and statistics on current and past operations. For more information see the nsr_device(5) manual page.
NSR directive
This resource describes a directive. Directives control how a client's files are processed as they are being saved. For more information see the nsr_directive(5), the nsr(5) and the uasm(8) manual pages.
NSR group
This resource specifies a logical grouping of Legato Storage Manager clients and a starting time. Each day, at the specified time, all members of the group will start their saves. For more information see the nsr_group(5) manual page.
NSR jukebox
This resource type 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
This resource type specifies a template describing a sequence of names to be used when labeling volumes. For more information see the nsr_label(5) manual page.
NSR license
This resource contains licensing information for each feature currently enabled in this Legato Storage Manager installation. It contains various enabler and authorization codes that are used by Legato Storage Manager to validate licensed capabilities. For more information see the nsr_license(5) and nsrcap(8) manual pages.
NSR notification
A notification specifies an action to be performed when a particular type of Legato Storage Manager event takes place. For more information see the
nsr_notification(5) manual page.
NSR policy
Policy resources are used as part of the index management process in Legato Storage Manager. These policies control how long entries remain in a client's on-line file index and when to mark a save set as recyclable. For more information see the nsr_policy(5) manual page.
NSR pool
This resource type is used by Legato Storage Manager to determine what volumes save sets should reside on based on the characteristics of the save (for example, group or level). For more information see the nsr_pool(5) manual page.
NSR schedule
Schedule resources define 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. For more information see the
nsr_schedule(5) manual page.
NSR stage
Each stage resource describes a staging policy. The resource includes attributes that define control parameters for the policy, and devices managed by the policy. For more information see the nsr_stage(5) manual page.
/nsr/res/nsr.res
Holds the Legato Storage Manager server's resources.
nsr_schedule - Legato Storage Manager resource type ``NSR schedule''
type: NSR schedule
Each Legato Storage Manager schedule is described by a single resource of type NSR schedule (see nsr_resource(5)). To edit the NSR schedule resources for a Legato Storage Manager server, type:
nsradmin -c "type:NSR schedule"
or use the nwadmin(8) GUI. See nsradmin(8) for more information on using the Legato Storage Manager administration program.
This resource describes a sequence of levels controlling the amount of data saved by Legato Storage Manager clients (see nsr_client(5)). There is one NSR schedule resource for each Legato Storage Manager schedule.
The following attributes are defined for resource type NSR schedule. The information in parentheses describes how the attribute values are accessed. Read-only indicates that the value cannot be changed by an administrator. Read/write means the value can be set as well as read. Several additional hidden attributes (for example, administrator) are common to all resources, and are described in nsr_resource(5).
name (read/write)
This attribute specifies the schedule's name. The schedule is referred to by its name in client resources.
Example: name: monthly_fulls;
period (read-only)
This attribute specifies the length of the schedule's period. It may be either "Week" or "Month". "Week" schedules repeat every 7 days and start on Sunday. "Month" schedules start over at the first of each month. The default is "Week".
Example: period: Month;
action (read/write)
This attribute specifies the sequence of save levels making up the schedule. One entry is used for each day of the schedule. The entries must be separated by whitespace, i.e., blanks or tabs. The valid levels are 'consolidate', `full', `incr', `skip', and the numbers 1 through 9. The actions consolidate, full, incr, and skip may be abbreviated as 'c', "`f'," "`i'," "and" "`s'," "respectively."
When the action attribute does not contain enough entries to account for every day in the period, Legato Storage Manager will repeat the list of actions when the end of the action list is reached.
Example: action: f i i i i i i;
override (read/write)
This attribute specifies a list of actions and dates overriding the actions specified in the action attribute. The format of the override specification is action date. action must be one of `full', `incr', `skip' or one of the numbers 1 through 9. date must of of the form `month/day/year'. Action/date pairs are separated by commas (`,'). Month and day are 2 digit numbers, year may be either 2 or 4 digits. If the year it 2 digits, numbers in the range 70-99 are assumed to be offsets from 1900, those in the range 00-69 are assumed to be offset from 2000.
Example: override: full 1/1/1999, full 6/1/1999;
The following defines a NSR schedule resource named `Default'. The Default schedule may be modified, but it may not be deleted. Each Legato Storage Manager server must have a Default schedule. This schedule has a period of one week, does a full on Sunday, followed by 6 incremental saves. There are no override actions specified.
type: NSR schedule;name: Default;period: Week;action: f i i i i i i;override: ;
The following defines a schedule named `quarterly'. It has a period of one month. The action attribute specifies level 5, 9, and incremental saves. In the override attribute, full saves are specified for the first day of each quarter. Note that there are only 7 entries in the action attribute. Upon reaching the end of the list, Legato Storage Manager will start over at the beginning of the list, performing a level 5 save.
type: NSR schedule;name: quarterly;period: Month;action: 5 incr incr incr 9 incr incr;override: f 1/1/1998, f 3/1/1998, f 6/1/1998,f 9/1/1998, f 1/1/1999;
|
See Also:
nsr(8), savefs(8), mminfo(8), nsradmin(8), nsr_client(5), nsr_policy(5), nsr_resource(5), nwadmin(8) |
nsr_service - Legato Storage Manager server resource type ``NSR''
type: NSR
Each Legato Storage Manager server is described by a resource of type NSR. See nsr_resource(5) for general information on Legato Storage Manager resources. To edit the NSR resource use the command:
nsradmin -c "type:NSR"
or use the nwadmin(8) GUI. See nsradmin(8) for information on using the Legato Storage Manager administration program.
The following attributes are defined for the NSR resource. The information in parentheses describes how the attribute values are accessed. Read-only indicates that the value cannot be changed by an administrator. Read/write means the value can be set as well as read. Choice list means that any number of values can be chosen from the given list. Static attributes change values rarely, if ever. Dynamic attributes have values which can change rapidly. Hidden means it is an attribute of interest only to programs or experts, and these attributes can only be seen when the hidden option is turned on in nsradmin(8) or details option is set in nwadmin(8). For example, an attribute marked (read-only, static) has a value which is set when the resource is created and never changes, or is changed only by the server.
name (read-only, static)
This attribute specifies the hostname of this Legato Storage Manager server.
Example name: mars;
version (read-only, dynamic)
This is the software version of the Legato Storage Manager server daemon, nsrd(8). This includes a slash and the number of clients currently licensed.
Example: version: Legato Storage Manager 4.1 Turbo/110;
save totals (read-only, dynamic, hidden)
Save statistics. A string containing the total number of save sessions, the number of saves with errors (if any) and the total number of bytes saved (if any). This attribute is updated after each save session completes.
Example: save totals: "37 sessions, 457 MB total";
recover totals (read-only, dynamic, hidden)
Recovery statistics. A string containing the total number of recover sessions, the number of recovers with errors (if any) and the total number of bytes recovered (if any). This attribute is updated after each recover session completes.
Example: recover totals: "347 sessions, 48 MB total";
totals since (read-only, dynamic)
The time statistics collection started. This is usually the last time the Legato Storage Manager server was rebooted.
Example: totals since: "Fri Jun 1 09:35:02 1999";
NSR operation (read-only, choice list, hidden)
This attribute is currently unused and is provided for backward compatibility.
parallelism (read/write, static)
This attribute sets the number of concurrent save sessions that this server will allow. The value can be set by an administrator. Use higher values for better performance on a fast system with lots of main memory and swap space, and use lower values to avoid overloading a slow system, or systems with little main memory and/or swap space. Warning: due to bugs in some versions of UNIX, high values of parallelism may cause the system to lock up.
Example: parallelism: 4;
session statistics (read-only, dynamic, hidden)
This attribute reports the statistics of each active session. There are 14 values for each set of statistics, namely, id (session's unique identifier), name (session's name), mode (read, write, browse), pool (current pool), volume (current volume), rate kb (current data transfer rate for save session), amount kb (current amount read/written by session), total kb (total amount to be read by session), amount files (current number of files recovered; to be implemented in a future release), total files (current number of files to recover; to be implemented in a future release), connect time (time session has been connected), num volumes (number of volumes to be used by recover session), used volumes (number of volumes processed by recover session), and completion (running, complete, or continued)
Example: sessions statistics: ;
manual saves (read/write, hidden)
This attribute allows the administrator to disable manual backups to the server. Scheduled backups continue to work normally.
volume priority (read/write)
If a Legato Storage Manager server has volumes in locally managed jukeboxes and volumes being managed by SmartMedia, this attribute allows the administrator to set a priority for selecting volumes to be used while saving data. Determines whether the server has a preference for volumes being managed by SmartMedia, SmartMedia Priority, or whether the server has a preference for volumes in a locally managed jukebox, NearLine Priority, when selecting a volume to be used to record data while saving. The default value is NearLine Priority.
Example: volume priority: NearLine Priority;
SmartMedia save mount (read/write)
This attribute controls the form of the request made to SmartMedia to mount a volume for saving data. Setting this attributes value to, volume by characteristics, causes Legato Storage Manager to request a volume meeting specified criteria, and lets SmartMedia select an appropriate volume from all media which satisfy the criteria specified. When this attribute's value is set to, volume by name, Legato Storage Manager will request the volume by name and SmartMedia mounts the volume requested. The default value is volume by characteristics.
Example: SmartMedia save mount: volume by characteristics;
license server (read/write, hidden)
The name of the server on which a Legato license manager is installed and running. This attribute used to be called "GEMS server". You can set the value to a GEMStation where a GEMS license manager is running or to a machine where a Legato license manager is running.
Example: license server: maruthi;
message (read-only, dynamic, hidden)
The last message of any kind logged. A time stamp is included at the start of the string.
Example: message: "Mon 12:25:51 Tape full, mount volume mars.001 on /dev/nrst1";
message list (read-only, dynamic, hidden)
A list of recent messages, with a time stamp and a string message for each value.
Example: message: "Mon 12:25:51 Tape full, mount volume mars.001 on /dev/nrst1";
session (read-only, dynamic, hidden)
The value of this attribute is a list of session information strings. Each string includes the Legato Storage Manager client name, type of operation (saving, browsing, or recovering) and information about the save set, including name, number of bytes, and number of files. All sizes and rates are in bytes per second, Kilobytes (1024), Megabytes (a thousand Kilobytes), etc.
Example:
session: "venus:/usr saving to mars.001 20MB",
"mars:/usr/src done saving 24MB";
pending (read-only, dynamic, hidden)
A list of events pending with the Legato Storage Manager event notification system (see nsr_notification(5)). The first three fields are the time, priority, and event name.
Example: pending: "Fri 14:40:15 alert: media mount of mars.001 suggested on /dev/nrst1";
status (read-only, dynamic, hidden)
A list of status flags for the Legato Storage Manager server. These flags are only for use by Legato Storage Manager server-side programs (for example, savegrp) and list various features enabled in the running server. The format is currently name=boolean (true or false). The features listed, and their states, can change at any time.
statistics (read-only, dynamic, hidden)
A list of strings of the form name=number that give a number of server statistics.
types created (read-only, static)
A list of all the other resource types this Legato Storage Manager server can create and about which clients can query.
Example: types created: NSR device, NSR group;
administrator (read/write, static)
This is a list of names (or netgroups) of users who are allowed to administer Legato Storage Manager. Normally this list is inherited by all other resources on this server, although each administrator attribute can be explicitly changed if desired. Administrators can change the values of attributes for the resource which lists them. The administrator list also determines who can add and delete resources of the other NSR types. The user "root" on the local host of the server is always an administrator. Entries specifying other administrators are of the form, user, user@host, host/user, or &netgroup. The user name and/or host name may be a wild card, "*" (any user and/or host). Entering just a user name allows that user to administer Legato Storage Manager from any host (equivalent to user@* or */user). Netgroup names are always preceded by an "&". The following example grants Legato Storage Manager administrative privileges to, "root" from any host, the user "operator" from the hosts "jupiter" and "mars", the user "admin" from any host, and all <user name, user's hostname, server's domain> in the netgroup "netadmins".
Example: administrator: root, operator@jupiter, mars/operator, admin@*, &netadmins;
contact name (read/write, static)
This attribute is used for product licensing/registration purposes. It must be specified before printing the registration information from the registration window.
Example: contact name: contact_name;
company (read/write, static)
This attribute is used for product licensing/registration purposes. Your comapny name must be specified before printing the registration information from the registration window.
Example: company: Legato;
street address (read/write, static)
This attribute is used for product licensing/registration mailing purposes. Specify your mailing street address.
Example: street address: 3145 Porter Drive;
city/town (read/write, static)
This attribute is used for product licensing/registration mailing purposes.
Example: city/town: Palo Alto;
state/province (read/write, static)
This attribute is used for product licensing/registration mailing purposes.
Example: state/province: CA;
zip/postal code (read/write, static)
This attribute is used for product licensing/registration mailing purposes.
Example: zip/postal code: 94304;
country (read/write, static)
This attribute is used for product licensing/registration mailing purposes.
Example: country: USA;
phone (read/write, static)
This attribute is used for product licensing/registration information purposes. This attribute must to be specified before printing the registration information from the registration window.
Example: phone: 650-812-6100;
fax (read/write, static)
This attribute is used for product licensing/registration purposes.
Example: fax: 650-812-6031;
email address (read/write, static)
This attribute is used for product licensing/registration purposes.
Example: email address: support@us.oracle.com;
server OS type (read/write, static)
This attribute is used for product licensing/registration purposes.
Example: erver OS type: Solaris;
purchase date (read/write, static)
This attribute is used for product licensing/registration purposes. It specifies the purchase date of the product enabler code. This attribute must be specified before printing the registration information from the registration window.
product serial number (read/write, static)
This attribute is used for product licensing/registration purposes. It must be specified before printing the registration information from the registration window.
mm op message (read/write, dynamic, hidden)
This attribute lists the descriptive message for the most recently completed media database operation. The Legato Storage Manager program (such as nsrmm(8)) that requested the operation clears this attribute as soon as it has read the result. An administrator should never change this attribute manually.
mm operation value (read/write, dynamic, hidden)
This attribute is used by programs such as nsrmm(8) to pass the desired media database operation location or flags to the Legato Storage Manager server. The value is automatically cleared when the operation completes. An administrator should never change this attribute manually.
mm operation (read/write, choice list, dynamic, hidden)
This attribute is used by programs such as nsrmm(8) to pass the media database operation type currently desired to the Legato Storage Manager server. The possible choices are: purge volume, purge save set, delete volume, delete save set, mark volume, mark save set, unmark volume, unmark save set, specify volume lcoation, specify volume flags, and specify save set flags. The server serializes such operations and performs the appropriate queries on nsrmmdbd(8). The value is automatically cleared when the operation completes. An administrator should never change this attribute manually.
mm operation id (read/write, dynamic, hidden)
This attribute is used by programs such as nsrmm(8) to pass the desired media database operation identifier to the Legato Storage Manager server. The value is automatically cleared when the operation completes. An administrator should never change this attribute manually.
nsrmon info (read/write, dynamic, hidden)
This attribute is used by programs such as nsrmon(8) to pass information about remote daemon requests to the Legato Storage Manager server. The value is automatically cleared when the request completes. An administrator should never change this attribute manually. See nsr_storage_node(5) for a description of storage nodes and remote daemons.
nsrmmd count (read-only, dynamic, hidden)
This attribute is used by programs such as nsrd(8) to track the number and location of the media daemons, nsrmmd(8).
nsrmmd polling interval (read/write, hidden)
This attribute specifies the number of minutes between polling events of a remote nsrmmd(8). nsrd(8) polls a remote nsrmmd(8) at this interval, to determine whether it is running. If it determines from this poll that the daemon is no longer running, it will restart the nsrmmd(8), with a delay set by the `nsrmmd restart interval', see below. See nsr_storage_node(5) for additional details on this attribute and storage nodes.
nsrmmd restart interval (read/write, hidden)
This attribute specifies the number of minutes between restart attempts of a remote nsrmmd(8). When nsrd(8) determines that a remote nsrmmd(8) has terminated, it periodically attempts to restart the remote daemon. A value of zero for this attribute means the daemon should be restarted immediately. See nsr_storage_node(5) for additional details on this attribute and storage nodes.
nsrmmd control timeout (read/write, hidden)
This attribute specifies the number of minutes nsrd(8) waits for storage node requests.
enabler code (read/write, dynamic, hidden)
This attribute specifies the enabler code for the base enabler of the server software.
SS cutoff size (read/write, hidden)
This attribute sets the default "save set cut off size" to be used when saving. A blank value uses the built in default value. A non blank value for this attribute consists of a number followed by KB, MB, or GB signifying Kilobytes, Megabytes, or Gigabytes.
A complete example follows:
type: NSR; name: mars; version: Legato Storage Manager 4.1 Turbo/110; save totals: "84 sessions, 3597 MB total"; recover totals: 1 session; totals since: "Fri Oct 14 12:41:31 1999"; NSR operation: Idle Write Read Verify label Label; parallelism: 4; manual saves: Enabled Disabled ; message: \ "Mon 14:37:25 media alert event: recover waiting for 8mm tape mars.001"; message list: \ "Mon 07:10:12 media info: loading volume man.001 into /dev/nrst11", "Mon 07:10:33 /dev/nrst11 mount operation in progress", "Mon 07:11:15 /dev/nrst11 mounted 8mm 5GB tape man.001"; session: "mars:george browsing", "mars:/home/mars starting recovery of 9K bytes"; session statistics: ; pending: \ "Mon 14:40:15 media alert: recover waiting for 8mm tape mars.001"; status: disabled=false, jukebox=true, dm=true, archive=true, cds=true, turbo=true, single=false; statistics: elapsed = 257415, saves = 1176, recovers = 12, save KB = 12050007, recover KB = 28272839, bad saves = 0, bad recovers = 0, current saves = 1, current recovers = 0, max saves = 12, max recovers = 1, mounts = 0, recover delays = 0, saving daemons = 0, recovering daemons = 0, idle daemons = 0; types created: NSR device, NSR group, NSR directive, NSR notification, NSR client, NSR policy, NSR schedule, NSR pool, NSR label, NSR jukebox, NSR license, NSR archive client, NSR archive list; administrator: root; contact name: Technical Support; company: Oracle; street address: 3145, Porter Drive; city/town: Palo Alto; state/province: CA; zip/postal code: 94304; country: USA; phone: 650-812-6100; fax: 650-812-6031; email address: support@us.oracle.com; CompuServe address: 76044,3423; purchase date: ; product serial number: ; mm op message: ; mm operation value: ; mm operation: ; mm operation id: ; nsrmon info: ; nsrmmd count: "mars:2"; nsrmmd polling interval: 3; nsrmmd restart interval: 2; nsrmmd control timeout: 5; enabler code: ; SS cutoff size: ;
/nsr/res/nsr.res - This file should never be edited directly. Use nwadmin(8) or nsradmin(8) instead.
|
See Also:
netgroup(5), nsr(5), nsr(8), nsr_device(5), nsr_group(5), nsr_notification(5), nsr_resource(5), nsr_storage_node(5), nsradmin(8), nsrd(8), nsrmm(8), nsrmmdbd(8), nsrmon(8), nwadmin(8), recover(8), save(8) |
nsr_shutdown - Stop a Legato Storage Manager server's processes
nsr_shutdown [ -a ] [ -A ] [ -d ] [ -n ] [ -q ] [ -s ] [ -v ]
nsr_shutdown kills Legato Storage Manager processes on a Legato Storage Manager server. This command is simpler than the procedure of using ps(1), grep(1), and kill(1).
-a
Kill all daemons. This is the same as using the -A, -d, and -s options.
-A
Kill any nsralist(8) processes.
-d
This is the default option; it kills the server daemons. These may include nsrd(8), nsrindexd(8), nsrexecd(8), nsrib(8), nsrmmd(8), and nsrmmdbd(8). Since savegrp(8), nsrexec(8), and nsralist(8) processes depend on the service daemons, they are also killed.
-n
Not really. Echoes the kill command without actually invoking it.
-q
Perform the shutdown quietly; don't prompt for confirmation.
-s
Kill any savegrp(8) (and nsrexec(8)) processes.
-v
Verbose: Instruct the shell to print commands and their arguments as they are executed.
|
See Also:
nsralist(8), nsrd(8), nsrexec(8), nsrexecd(8), nsrindexd(8), nsrmmd(8), nsrmmdbd(8), savegrp(8) |
nsr_stage - Legato Storage Manager resource type ``NSR stage''
type: NSR stage
Each staging policy used by a Legato Storage Manager server is described by a single resource of type NSR stage. See nsr_resource(5) for information on Legato Storage Manager resources. To edit the NSR stage resources run:
nsradmin -c "type:NSR stage"
Be careful to include the space between ``NSR'' and ``stage'' and the surrounding quotes. See nsradmin(1m) for information on using the Legato Storage Manager administration program.
The following attributes are defined for resource type NSR stage. The information in parentheses describes how the attribute values are accessed. Read-only indicates that the value cannot be changed by an administrator. Read/write means the value can be set as well as read. Hidden means it is an attribute of interest only to programs or experts, and these attributes can only be seen when the hidden option is turned on in nsradmin(1m) or if the Details View option is selected in the Stage window in nwadmin(1m). Static attributes change values rarely, if ever. Dynamic attributes have values which change rapidly. For example, an attribute marked (read-only, static) has a value which is set when the attribute is created and may never changes. Additional attributes (for example, administrator) are common to all resources, and are described in nsr_resource(5).
name (read-only, single string)
The name attribute specifies the staging policy name.
enabled (read/write, choice)
The enabled attribute determines whether or not save sets are automatically staged from devices associated with this policy. It also enables and disables the periodic recover space operations. It may be one of two values: Yes, No
max storage period (read/write)
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 (%) (read/write)
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.
Example: high water mark (%): 90;
low water mark (%) (read/write)
The point at which the staging process should stop, measured as the percentage of available space used on the file system.
Example: low water mark (%): 80;
Save set selection (read/write)
Save set selection criteria for staging. It may be one of four values:
largest save set
smallest save set
oldest save set
or
youngest save set.
Destination pool (read/write)
The pool to which save sets should be sent (see nsr_pool(5)).
Devices (read/write, multiple choice)
This attribute lists the file type devices associated with this policy.
Recover space interval (read/write, hidden)
The number of hours between recover space operations for save sets with no entries in the media database form file devices.
Fs check interval (read/write, hidden)
The number of hours between file system check operations.
Start now (read/write)
Updating this aribute will cause the selected operation to be triggered immediately on all devices associated with this policy. The attribute value will not actually change. Operation can be one of the following:
Check fs check file system and stage data if neccessary.
Recover space recover space for save sets with no entries in the media database (garabage collection).
Stage all save sets stage all save sets to the destination pool.
Note: The hidden options are not shown in the first example.
The following example shows a resource that defines a stage policy called `test stage1'. Save sets will be staged from device `/disk/fd0' to pool `Default Clone' when the file system is 90% full or 7 days after the date of the backup, whichever comes first. The largest save set will be the first to stage to the destination pool:
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: ;
The following example shows a resource that defines a stage policy called `test stage2'. Save sets will be staged from device `/disk/fd2' to pool `Default' when the file system is 95% full or 14 days after the date of the backup, whichever comes first. The smallest save set will be the first to stage to the destination pool. The file system will be checked every 1 hour and a staging operation will be triggered if necessary. A recover-space operation (for save sets with no entries in the media database) will be triggered every 3 hours on all devices associated with the policy:
type: NSR stage; name: test stage2; autostart: Enabled; max storage period: 14; high water mark (%): 95; low water mark (%): 80; save set selection: smallest save set; destination pool: Default; devices: /disk/fd2; recover space interval: 3; fs check interval: 1; start now: ; administrator: root@omni; hostname: omni;
storage node - Description of the storage node feature
The storage node feature provides central server control of distributed devices for saving and recovering client data.
A storage node is a host that has directly attached devices that are used and controlled by a Legato Storage Manager server. These devices are called remote devices, since they are remote from the server. Clients may save and recover to these remote devices by altering their "storage nodes" attribute (see nsr_client(5)). A storage node may also be a client of the server, and may save to its own devices.
The main advantages provided by this feature are central control of remote devices, reduction of network traffic, use of faster local saves and recovers on a storage node, and support of heterogeneous server and storage node architectures.
There are several attributes which affect this function. Within the NSR resource (see nsr_service(5)) there are the "nsrmmd polling interval", "nsrmmd restart interval" and "nsrmmd control timeout" attributes. These attributes control how often the remote media daemons (see nsrmmd(8)) are polled, how long between restart attempts, and how long to wait for remote requests to complete, respectively.
Within the "NSR device" resource (see nsr_device(5)) the resource's name will accept the "rd=hostname:dev_path" format when defining a remote device. The "hostname" is the hostname of the storage node and "dev_path" is the device path of the device attached to that host. There are also hidden attributes called "save mount timeout" and "save lockout," which allow a pending save mount request to timeout, and a storage node to be locked out for upcoming save requests.
Within the "NSR client" resource (see nsr_client(5)), there are the "storage nodes" and "clone storage nodes" attributes. The former is used by the server in selecting a storage node when the client is saving data. The latter is used during cloning, to direct cloned data from a volume on the storage node (the node represented by this client resource).
In order to install a storage node, choose the client and storage node packages, where given the choice. For those platforms that do not have a choice, the storage node binaries are included in the client package. In addition, install any appropriate device driver packages. If not running in evaluation mode, a storage node enabler must be configured on the server for each node.
As with a client, ensure that the nsrexecd(8) daemon is started on the storage node. To define a device on a storage node, from the controlling server define a device with the above mentioned "rd=" syntax. For a remote jukebox (on a storage node), run jbconfig(8) from the node, after adding root@storage_node to the server's administrator list, (where root is the user running jbconfig and storage_node is the hostname of the storage node). This administrator list entry may be removed after jbconfig(8) completes. Note that on a Windows NT storage node, use jbconfig rather than jbconfig(8).
In addition to jbconfig(8), when running scanner(8) on a storage node, root@storage_node must be on the adminstrator list.
When a device is defined (or enabled) on a storage node, the server will attempt to start a media daemon (see nsrmmd(8)) on the node. In order for the server to know whether the node is alive, it polls the node every "nsrmmd polling interval" minutes. When the server detects a problem with the node's daemon or the node itself, it attempts to restart the daemon every "nsrmmd restart interval" minutes, until either the daemon is restarted or the device is disabled (by setting "enabled" to "no" in the device's "enabled" attribute).
In addition to needing a storage node enabler for each storage node, each remote jukebox will need its own jukebox enabler, as is needed for local jukeboxes.
A storage node is assignable for work when it is considered functional by the server (nsrexecd running, device enabled, nsrmmd running, and responding to the server's polls). When a client save starts, the client's "storage nodes" attribute is used to select a storage node. This attribute is a list of storage node hostnames, which are considered in order, for assignment to the request.
The exception to this node assignment approach is when the server's index or bootstrap is being saved - these save sets are always directed to the server's local devices, regardless of the server's "storage nodes" attribute. Hence, the server will always need a local device to backup such data, at a minimum. Note that these save sets can later be cloned to a storage node, as can any save set.
If a storage node is created first (by defining a device on the host), and a client resource for that host is then added, that hostname is added to its "storage nodes" attribute. This addition means the client will back up to its own devices. However, if a client resource already exists, and a device is defined on that host, then one must manually update the client's "storage nodes" attribute, with the hostname for that machine. Since this attribute is an ordered list of hostnames, add its own name as the first entry.
Note that the volume's location field is used to determine the host location of an unmounted volume. The server looks for a device or jukebox name in this field, as would be added when a volume resides in a jukebox. Volumes in a jukebox are considered to be located on the host to which the jukebox is connected. The location field can be used to bind a stand-alone volume to a particular node by manually setting this field to any device on that node (using the "rd=" syntax).
There are several commands that interact directly with a device, and so must run on a storage node. These include jbconfig(8), nsrjb() and scanner(8), in addition to those in the device driver package. When invoking these commands directly, do so on the storage node rather than on the server, and use the server option ("-s server_hostname", where server_hostname is the controlling server's hostname).
A single clone request may be divided into multiple sub-requests, one for each different source machine (i. e., the host from which save sets will be read). For example, suppose a clone request must read data from volumeA and volumeB, which are located on storage nodes A and B, respectively. Such a request would be divided into two sub-requests, one to read volumeA from storage node A and another to read volumeB from storage node B.
Before the "clone storage nodes" attribute was introduced (see nsr_client(5)) the target location for a clone request (the storage node to which cloned data is written) was determined by the "storage nodes" attribute of the server's client resource. In servers where the "clone storage nodes" attribute is defined, the target node is determined by examining the "clone storage nodes" attribute of the client resource of the storage node, from which the clone volume will be read. If this attribute has no value, the "clone storage nodes" attribute of the server's client resource is consulted. Finally, if this attribute has no value, the "storage nodes" attribute of the server's client resource is used.
Some limitations of this feature are that a server cannot be a storage node of another server, and a storage node can only be controlled by one server.
|
See Also:
mmlocate(8), nsr_client(5), nsr_device(5), nsr_service(5), nsrclone(8), nsrexecd(8), nsrmmd(8), nsrmon(8), scanner(8) |
nsradmin - Legato Storage Manager administrative program
nsradmin [ -c ] [ -i file ] [ -s server ] [ -p prognum ] [ -v version ] [ query ]
nsradmin [ -c ] [ -i file ] [ -f resfile ... ] [ -t typefile ] [ query ]
The nsradmin command is a command-line based administrative program for the Legato Storage Manager system. Normally nsradmin monitors and modifies Legato Storage Manager resources over the network. Commands are entered on standard input, and output is produced on standard output.
If nsradmin is started without a query it uses a default query that selects all resources involved in Legato Storage Manager products.
-c
Use the termcap(5) and curses(3) packages to implement a full-screen display mode, just like the visual command described below.
-f resfile
Use the Legato Storage Manager resource file resfile instead of opening a network connection. This should generally never be used, except when the Legato Storage Manager server is not running. Multiple -f and resfile arguments can be used to start nsradmin with access to more than one file at a time.
-i file
Take input commands from file instead of from standard input. In this mode, the interactive prompt will not be printed.
-s server
Open a connection to the named Legato Storage Manager server instead of allowing administration of all servers. Useful to limit the number of resources if there are many servers, or to administer when the RAP location service is not working.
-p program
Use the given RPC program number instead of the standard program number. The standard number is 390109. This option is generally used only for debugging.
-t typefile
Use the alternate file typefile to define RAP types.
-v version
Bind to the Legato Storage Manager RAP service with the given version number. The default is 2. This option is generally used only for debugging.
query
If a query is specified (in the form of an attribute list), the edit operation (see below) is performed on the results of the query. See Commands, below, for more information on how the edit command works.
Each Legato Storage Manager resource is made up of a list of named attributes. Each attribute can have zero or more values. The attribute names and values are all represented by printable strings. Upper and lower case is not distinguished on comparisons, and spaces are ignored except inside the names and values.
The format for specifying attributes and attribute lists is:
attribute ::= name [ : value [ , value ]* ]
An attribute is a name optionally followed by a colon, followed by zero or more values, with values separated by commas. A comma at the end of a line continues the line.
attribute list ::= attribute [ ; attribute ]*
An attribute list is one or more attributes separated by semicolons. A semicolon at the end of a line continues the line. The list is ended by a newline that is not preceded by a comma or semi-colon.
Here is an example of an attribute list:
name: mars;
type: NSR client;
remote access: mars, venus, jupiter;
For more information on attributes, attribute lists, and the Legato Storage Manager resource types, see the resource(5), nsr_resource(5), and rap(8) manual pages.
At each input prompt, nsradmin expects a command name and some optional arguments. Command names can be shortened to the smallest unique string (for example, p for print). Command arguments are always specified in the form of an attribute list. Most commands operate on a set of resources returned by a query. The query is specified as an attribute list which is used to match resources with the following rules:
Thus, a query:
type:NSR device;
name:mars, venus;
test
will match all resources that have a type attribute with the value NSR device and a name attribute with a value of either mars or venus, and an attribute test with any value.
If the query has only one name and no values (for example, if there is no semi-colon or colon in it), then the program tries to guess a more reasonable query. If the name is a host name, then the query will select all the resources on the given host. Otherwise, the name will be interpreted as a type name, and all resources of that given type will be selected.
bind [query]
Bind to the service that owns the resource described by query. If no query is specified, queries are sent 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 will continue to be used.
create attribute list
Create a resource with the given attributes. One of the attributes must be type to specify a Legato Storage Manager type that can be created. The types command can be used to find out which types a server supports.
delete [query]
Delete the resources that match the current query. If a query is specified, it becomes the current query.
edit [query]
Edit the resources that match the current query. If a query is specified, it becomes the current query. If the environment variable EDITOR is set, then that editor will be invoked; otherwise vi(1) will be started. When the editor exits, nsradmin applies update, delete and create operations based on the changes to the resources. Be careful to not edit the resource identifier attribute, and to write the file out before exiting the editor.
help [command]
Print a message describing a command. If no command name is given a synopsis of all of the commands is printed.
print [query]
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 will be displayed.
server [servername]
Bind to the given Legato Storage Manager server name. If no server is specified, the RAP location service will be used. On failure, the previous server will continue to be used.
show [name; ...]
If a name list (really an attribute list with no values) is specified, add those names to the show list. Only these attributes will be displayed in subsequent print commands. If no name list is given the show list is cleared, resulting in all attributes being shown.
types
Print a list of all known types.
update attributes
Update the resources given by the current query to match attributes.
quit
Exit.
visual [query]
Enter a full-screen mode using the curses(3) package to step through commands in a perhaps more user-friendly manner than the command line interface. You can get this mode directly using the -c command line argument.
option [list]
This command enables some options to change the display of resources. With no arguments it displays the current options; with a list of options it turns the specified ones on. The options are: Dynamic displays all dynamic attributes, even the normally hidden ones. Hidden displays all attributes, even the normally hidden ones. Resource ID displays the resource identifier on each resource, a number that is used internally to provide sequencing and uniqueness.
unset [list]
This command turns off the specified option.
.[query]
If a query is specified, this command will set the current query without printing the results of the query. Otherwise, it will display the current query, show list, server binding, and options.
? [command]
Same as the help command above.
print type:NSR device Print all resources of type NSR device and make this the current query.
show type; name Set the show list to only display the attributes type and name.
delete Delete all resources that match the current query.
delete type:NSR device; hostname: mars Delete the resource with attributes: type: NSR device and hostname: mars.
edit type:NSR notification Edit all resources of type NSR notification.
The following exit status values are meaningful:
0 Interactive mode exited normally.
1 There was a usage or other non-query related error.
2 When reading input from a file (-i file), one or more RAP operations failed. This
status is never returned interactively.
nsralist - Legato Storage Manager archive request executor
nsralist -R archive request name
The nsralist command is used to execute an archive request (see
nsr_archive_request(5)). The nsralist command is normally run automatically by nsrd(8), as specified by each archive request resource.
The nsralist command will set up an RPC connection to nsrexecd(8) to run nsrarchive(8) on the specified client. If nsrexecd is unavailable, nsralist will fall back on using the rcmd(3) protocol and the client-side rshd(8).
The nsralist monitors the execution of the archive command and stores any output in the log of the archive request. The nsrarchive command running on the client updates the server with its progress, including whether or not optional verification and cloning operations have completed successfully. See nsrclone(8) for more information on cloning.
-R archive request name
This option specifies which archive request is supposed to be run.
/nsr/tmp/al.request_name
A lock file to keep multiple runs of the same archive list from running simultaneously.
nsrarchive - Archive files to long term storage with Legato Storage Manager
nsrarchive [ -BinpqvxVy ] [ -b pool ] [ -C clone pool ] [ -f directive filename ]
[ -G remove ] [ -N name ] [ -R name ] [ -s server ] [ -T annotation ] [ -W width ]
[ path ... ]
nsrarchive archives files, including directories or entire filesystems, to the Legato Storage Manager server (see nsr(8)). The progress of an archive can be monitored using the X Window System based nwadmin(8) program or the curses(3X) based nsrwatch(8) program for other terminal types. Use of nsrarchive is restricted to users on the administrator and archive users lists.
If no path arguments are specified, the current directory will be archived. nsrarchive will archive a directory by archiving all the files and subdirectories it contains, but it will not cross mount points, nor will it follow symbolic links.
The directive files (see nsr(5)) encountered in each directory will be read by default, and they contain special instructions directing how particular files are to be archived (i.e. compressed, skipped, etc.). These files are named .nsr.
Each file in the subdirectory structures specified by the path arguments will be encapsulated in a Legato Storage Manager archive stream. This stream of data is sent to a receiving process (see nsrd(8)) on the Legato Storage Manager server, which will process the data, adding entries to the media database for the archive save set, with the data finally ending up on some long term storage media (see nsrmmd(8)).
Details about handling media are discussed in nsrmm(8) and nsr_device(5).
If the grooming option remove is requested, all files and directories archived are removed. If verification is requested, the files will not be removed if the verification failed. Likewise, the files will not be removed if a requested cloning operation fails. The user is prompted for confirmation before the files are removed unless the -y option is supplied.
If the user does not supply a -T option on the command line, they will be prompted to enter an annotation for the archive.
-b pool
Specify a destination pool for the archive save set. This option overrides the automatic pool selection which normally occurs on the server.
-B
Force archive of all connecting directory information from root (``/'') down to the point of invocation. Note that the connecting directory information is always archived even without this option if client file index is generated.
-C clone pool
Generate a clone of this archive save set to the specified clone pool.
-E
Estimate the amount of data which will be generated by the archive, then perform the actual archive. Note that the estimate is generated from the inode information, and thus the data is only actually read once.
-f filename
The file from which to read default directives (see nsr(5)). A filename of - causes the default directives to be read from standard input.
-i
Ignore directive files as they are encountered in the subdirectory structures being archived.
-G remove
Groom the files after they have been archived. If cloning or verification is requested, no grooming is performed until those operations have completed successfully. The user is prompted for removal of top-level directories unless the y option is supplied. nsrarchive creates a temporary file which contains a list of all files and directories to be removed. The temporary file is placed in /tmp unless the environment variable TMPDIR is set.
-n
No archive. Estimate the amount of data which will be generated by the archive, but do not perform the actual archive.
-N name
The symbolic name of this archive save set. By default, the first path argument is used as the name.
-v
Verbose. Cause the nsrarchive program to tell you in great detail what it is doing as it proceeds.
-p
Exit with status 0. Used by server to determine if client installed properly.
-q
Quiet. Display only summary information and error messages.
-R name
This option should only be used by the nsralist program, which handles executing archive requests. Updates to the named archive request resource occur when this option is specified.
-s server
Specify which machine to use as the Legato Storage Manager server.
-T annotation
Archive save sets can be annotated with arbitrary text (up to 1023 characters). This option specifies an annotation for the archive save set being generated.
-V
Verify the archive save set after it completes.
-W width
The width used when formatting summary information output.
-x
Cross mount points.
-y
Answer yes to any questions.
|
See Also:
curses(3X), nsr_getdate(3), nsr(5), nsr(8), nsr_service(5), nsr_device(5), nsrmm(8), nsrmmd(8), nsrd(8), nsrwatch(8), nsrretrieve(8), nwadmin(8) |
Exit codes:
0 Normal exit.
-1 Abnormal exit.
nsrcap - Update the capabilities of a Legato Storage Manager installation
nsrcap [ -vn ] { -c | -u | -d } enabler-code
The nsrcap program is primarily used to enable new features on Legato Storage Manager. You can also use nsrcap to upgrade or downgrade Legato Storage Manager software features that are currently being used (upgrades and downgrades should be performed carefully; read the descriptions below). Enablers are separate from the Legato Storage Manager software, and are specified by an 18-digit code, usually displayed as 3 groups of 6 digits each. To enable a new feature, the nsrd(8) program must be running on the system where the Legato Storage Manager server software is installed. To enable a new feature you must be logged in to the Legato Storage Manager server as administrator or root. The nsrcap program is run once for each feature you want to enable by specifying the 18-digit code each time. If no errors occur, no output is printed. You can inspect the enablers currently loaded by viewing the NSR license resources using nwadmin(8) or nsradmin(8).
-c
Causes nsrcap to enable a feature that is not currently installed, using the specified enabler code. You can only load a feature once; an error is returned if you attempt to load the enabler more than once. You can only specify one of the -c, -d, or -u options.
-d
Causes nsrcap to downgrade an existing Base or Jukebox enabler. After you downgrade the enabler, you cannot return to the previous level enabled on the system. Do not use the -u option unless instructed to do so by Oracle Technical Support. You must specify one of the -c, -d, or -u options.
-u
Causes nsrcap to enter an enabler that upgrades an existing Base or Jukebox enabler. After you upgrade the enabler, you cannot return to the previous level enabled on the system. Do not use the -u option unless instructed to do so by Oracle Technical Support.
-v
Causes nsrcap to display more verbose information, describing the enabler being loaded. You must specify one of the -c, -d, or -u options.
-n
No load. Causes nsrcap to inspect the enabler code for validity. When you specify the -n option, the enabler code you enter on the command line is inspected and verified, but is not entered into the Legato Storage Manager server's nsr_license resource.
enabler-code is too long
Enabler codes must be 18 digits in length. The code entered is longer than 18 digits, and is invalid.
invalid code: xxxxxx-xxxxxx-xxxxxx
The 18-digit code entered on the command line is invalid. Re-check the enabler-code on your enabler sheet.
cannot find a jukebox resource to enable
The code word entered is a jukebox license enabler, but there are no jukebox resources to enable. You need to run jbconfig(8) to complete the jukebox installation before running nsrcap.
found a jukebox, but it had more than N slots.
Jukebox enablers can only enable jukeboxes with at most N physical slots, where N is the type of jukebox enabler. Either the jukebox was installed incorrectly, or you need to obtain a larger jukebox enabler.
this enabler-code is already assigned
The enabler-code entered is already loaded onto the system and cannot be used again for an upgrade.
no appropriate jukeboxes to upgrade
An upgrade was attempted, but no jukebox resources were found. Only use the -u option for jukeboxes when upgrading from one jukebox level to another, not on the initial installation. You also need to run jbconfig(8) before running nsrcap.
this enabler-code previously loaded
The enabler-code entered has been loaded onto the system previously and cannot be used again. You need to purchase a new enabler-code for the upgrade.
don't know how to upgrade this enabler
don't know how to downgrade this enabler
The enabler-code entered is not for a base or jukebox enabler. These are the only types of enablers that you can currently upgrade or downgrade.
base enabler must be loaded before upgrading
base enabler must be loaded before downgrading
You cannot perform an upgrade or downgrade until a base product has been installed. Install a base enabler, and then perform the upgrade or downgrade.
cannot find the enabler to upgrade
A jukebox upgrade was attempted, but the license enabler for the jukebox is not currently loaded. You must use the -c option for the initial installation of a jukebox enabler, not the -u option.
RPC error, Program not registered
The nsrcap program requires that the Legato Storage Manager daemons be running. Start your Legato Storage Manager daemons (cd /; nsrd) and re-run the nsrcap program. If nsrd is already running, you have probably reached a resource limit on the server (for example, not enough memory, or no more processes).
RAP error, user login name needs to be of the type:NSR administrator list.
Your login name is not listed in the administrator's list for the server. You need to be a valid administrator to run nsrcap.
RAP error, ...
Various other errors can be returned from nsrd if the enabler is invalid. For example, if you try to load a base enabler onto a system that already has a base enabler loaded, or if you attempt to load a jukebox enabler before the jukebox has been completely installed. The specific problem will follow the RAP error prefix.
nsrcat - Legato Storage Manager notification redirector for tty devices
nsrcat [ -n ]
The nsrcat command appends a carriage return to all newlines so that Legato Storage Manager notification messages can be redirected to the /dev/console or /dev/tty directory on systems with tty drivers that do not append a carriage return to output lines. This command reads text messages from standard input, appends a carriage return to the newline character, and writes the message to standard out.
-n
Indicates that the codeset is to be converted from UTF-8 to the user's native character encoding.
type: NSR notification; name: Log default; action: nsrcat > /dev/console;
nsrck - Legato Storage Manager index consistency check and repair program
nsrck [ -qM ] | [ -T tempdir ] [ -X [ -x percent ] | -C | -F | -m | -c ]
[ clientname ... ]
Nsrck is used to check the consistency of the Legato Storage Manager on-line index of clients' save records. Normally, nsrck is started automatically and synchronously by the nsrindexd(8) program when nsrindexd starts.
Index consistency checking is done in up to four phases.
Phase zero determines if any further checking of a client's index is necessary. This phase checks certain internal state of the index database, and if that state is consistent, avoids further passes. Phase zero also reports any suspicious-looking index names (i.e. indexes whose names cannot be mapped into network addresses).
Phase one fixes all errors in the database record file, db, and, if necessary, rebuilds the b-tree indexes for that database.
In phase two, if the database has been flagged for cross-checking with the media database, the records in the file index are checked against the media database, and any records that do not match existing, browsable save sets are deleted.
Finally, in phase three, if the database requires compression, either due to space freed by the previous phases or due to state flagged by a previous run, the index is compressed.
Index compression is a two or three step process. First, the records of the database are copied to a temporary database, db.CMP. When that operation completes, a flag file, db.SVC, is created, the old, uncompressed database is removed, and the compressed database is renamed to db. Finally, the db.SVC file is removed. If there is not enough room on the filesystem containing the db file to also include the temporary database, nsrck will create a temporary file on another writable filesystem, and stores a pointer to this file in a file named db.PTR. In this case, an extra copy of the data is required, since the uncompressed database must first be removed before the data can be copied back to the correct place. After all of these steps are completed, the db.PTR file is removed.
The nsrck program is restartable at any time during its execution. Therefore, it can survive system crashes or exhaustion of resources without losing data.
-C
Force index compression on the named clients, or all clients if none are specified. Other phases of checking are only performed if an error in a database is detected.
-c
Create indexes databases for the named clients, or all clients if none are specified. Do not check the index databases if they already exist.
-F
Force a check on any given client names. If no names are given, forced checks are performed for all client indexes. This option forces all phases of index checking. For backward compatibility, the -F option implies index compression, and may be used to force the index to be compressed. This option is typically only necessary when the browse policy (see nsr_policy(5)) is reduced, for example, changing the browse policy from 1 year to 6 months.
-T tempdir
Specify the directory to use to hold the temporary database during compression if there is not enough room in the filesystem containing the db file. If this option is used and there is insufficient space in the specified directory, nsrck will fail. This argument is ignored if there is sufficient space in the filesystem containing the db file.
-M
Master mode (not advised for manual operation). This advises nsrck that it is being run by nsrd(8) or another Legato Storage Manager daemon and should log messages with timestamps, and perform any other behavior expected by nsrd.
-m
Forces nsrck to check and rebuild the media database b-tree indexes, instead of checking a client's online file index.
-q
Quiet mode. All advisory messages are suppressed.
-X
Do not check the index databases (unless an error in phase zero occurs), rather cross-check the save set ids in the index records with save sets found in the media database. Records that have no corresponding media save sets are discarded. If any clients are listed, the cross-check is limited to those indexes.
-x percent
After a database has been cross-checked, if the database uses less than percent of the UNIX file, then the database is compressed to release unused pages back to the filesystem. The percent default is 30.
/nsr/tmp/.nsrck
Nsrck locks this file thereby insuring that only one copy of the command thrashes the Legato Storage Manager server.
/nsr/index/clientname
/nsr/index/clientname/db
/nsr/index/clientname/db.CMP
/nsr/index/clientname/db.PTR
/nsr/index/clientname/db.SCV
/nsr/index/clientname/db.RCV
/anyfilesystem/nsrckXXXXXX
Temporary database created while compressing a db file if there is not enough room to do compression in /nsr/index/clientname/db.CMP.
|
See Also:
nsr_layout(5), nsr_policy(5), hosts(5), nsrd(8), nsrindexd(8), nsrmmdbd(8), nsrim(8), savegrp(8) |
checking index for clientname
Informative message that the files associated with the named client are being inspected.
more space needed to compress clientname index, size required
The program cannot find enough disk space to hold the temporary file db.CMP. The operator should free some disk space on any local filesystem and retry the command. The df(8) command may be used to see how much free space is available on any filesystem.
cannot lock flag file for clientname: reason
The flag file signifying the end of the first part of index compression is already in use by another instance of this program, or by the nsrindexd daemon. Since disaster will ensue if two processes access the same index at the same time, the program will refuse to act on the named file.
WARNING no valid savetimes - cross-check not performed for clientname
During a cross-check, no save sets were found for this client. Since this situation can occur during disaster recovery, nsrck avoids deleting the entire contents client index and instead does nothing.
cross-checking index for clientname
Displayed when the -X option is in effect.
rolling forward index compression for clientname
After a reboot, if index compression completed its first copy, the compression is rolled forward.
compressing index for clientname
Displayed when the -x or -C option has taken effect.
completed checking count clients
Displayed as the program finishes, provided some form of checking was accomplished.
nsrclone - Legato Storage Manager save set cloning command
nsrclone [ -v ] [ -s server ] [ -b pool ] { -f file | volname... }
nsrclone [ -v ] [ -s server ] [ -b pool ] -S { -f file | ssid... }
nsrclone [ -v ] [ -s server ] [ -b pool ] -V { -f file | volid... }
and on HSM enabled server:
nsrclone [ -v ] [ -s server ] [ -b pool ] -c client -N saveset
The nsrclone program is used to make new copies of existing save sets. These copies are indistinguishable from the original, except for the volume(s) storing the copies. The copies are placed on different media volumes, allowing for higher reliability than a single copy provides. The copies may be made onto any kind of media (for example, save sets on an 8mm tape may be copied to a set of optical disks). However, all media that will be used as the destination of an nsrclone operation must be in a clone pool. See nsr_pool(8) for a description of the various pool types.
Although the command line parameters allow you to specify volume names or volume identifiers, nsrclone always copies complete save sets. Save sets that are only partially contained on a specified volume will be completely copied, so volumes may be requested during the cloning operation in addition to those specified on the command line. Note that nsrclone does not perform simple volume duplication, but rather, copies full save sets to a set of destination volumes in a given pool. If the first destination volume chosen cannot hold all of the save sets to be copied, another volume will be chosen. This allows one to use different kinds of media for each copy, and allows for variable sized volumes, such as tapes.
If you use the -c and -N options together, nsrclone will create a super-full clone for the given client save set. A super-full clone is a feature that is supported only with HSM (most useful on HSM enabled servers). It automatically creates a clone of the most recent complete full backup of the named client and save set, along with any HSM migration save sets referenced to by the backup. Super-full clones should be cloned to a volume from a pool of type Migration Clone. If no migration save sets are referenced by the most recent backup, only the full save set is cloned.
The nsrclone program, in conjunction with nsrmmd(8), guarantees that each save set will have at most one clone on a given volume. When you specify a volume name or identifier, the copy of the save sets on that volume are used as the source. When save sets are specified explicitly, those with existing multiple copies are automatically chosen (copies of save sets that exist on volumes in a jukebox are chosen over those that require operator intervention). You can also specify which copy (clone) of a save set to use as the source; see the -S option, below.
Cloning between storage nodes is accomplished by an nsrmmd(8) on the source node reading from a volume, and another nsrmmd(8) on the target node writing to a volume. The source node is determined by the location of a source volume, which is given by where the volume is currently mounted or by its "location" field if unmounted (see mmlocate(8)). The target node of a clone is determined by either the "clone storage nodes" attribute of the storage node's client resource, that of the server's, or the "storage nodes" attribute of the server. See nsr_storage_node(5) and nsr_client(5) for additional detail on how these attributes are used and on other storage node information.
-b pool
Specifies the media pool to which the destination clones should be sent. The pool may be any pool currently registered with nsrd(8) that has its status set to clone. The possible values can be viewed by selecting the Pools menu item from the Administration menu of nwadmin(8). If you omit this option, the cloned save sets are automatically sent to the Default Clone pool.
-c client
Specifies a client whose save sets should be considered in the creation of a super-full clone. This option must always be specified in conjunction with the -N option.
-f file
Instructs nsrclone to read the volume names, volume identifiers or save set identifiers from the file specified, instead of listing them on the command line. The values must be listed one per line in the input file. The file may be "-", in which case the values are read from standard input.
-N saveset
Specifies which save set name is used to create a super-full clone. This option must always be specified in conjunction with the -c option.
-s server
Specifes a Legato Storage Manager server to migrate save sets from. See nsr(8) for a description of server selection. The default is the current system.
-v
Enable verbose operation. In this mode, additional messages are displayed about the operation of nsrclone, such as save sets that cross volumes, or save set series expansions.
-S
Causes nsrclone to treat subsequent command line parameters as save set identifiers, not volume names. Save set identifiers are unsigned numbers. You can find out the save set identifier of a save set using the mminfo -v command (see mminfo(8)). The -S option is useful when you want to copy individual save sets from a volume or all save sets matching an mminfo query (see the examples below). The save set identifiers may also specify exactly which copy of a save set with multiple copies to use as the source. To specify exact copies, use the ssid/cloneid format for each save set identifier. In this case, the ssid and the cloneid are unsigned numbers, separated by a single slash (/). You can find out the cloneid for a particular copy by using the mminfo -S report, or a custom report.
-V
Causes nsrclone to treat subsequent command line parameters as volume identifiers, not volume names. Volume identifiers can be found using the mminfo -mv report, for example. This option can not be used in conjunction with the -S option.
Copy all save sets on the volume mars.001 to a volume in the Offsite Clone pool:
nsrclone -b 'Offsite Clone' mars.001
Copy all complete save sets created during the previous weekend (recall that
nsr_getdate(3) dates without time-of-day match midnight at the beginning of that day). Only complete save sets can be copied by nsrclone(8):
nsrclone -S `mminfo -r ssid \
-q '!incomplete,savetime>last saturday,savetime<last monday'`
Copy a specific clone of a specific save set:
nsrclone -S 1538800517/770700786
|
See Also:
nsr_getdate(3), nsr_pool(5), nsr_storage_node(5), mminfo(8), nsr(8), nsrd(8), nsrmmd(8), nwadmin(8) |
The exit status is zero if all of the requested save sets were cloned successfully, non-zero otherwise.
Several messages are printed signalling that nsrd(8) is unavailable for cloning data; these are self-explanatory. You may also see a message from the following list.
adding save set series which includes ssid
If running in verbose mode, this message is printed when nsrclone notices that a requested save set is continued, requiring the entire series to be cloned (even if only part of the series was specified in the command line parameters).
Cannot contact media database
The media database (and most likely other Legato Storage Manager services as well) on the named server is not answering queries. The server may need to be started, or if it was just started, it needs to finish its startup checks before answering queries.
cannot clone save set number, series is corrupt
The given save set is part of a save set series (used for saving very large files or filesystems), but not all of the save sets in the series were found in the media database. This can happen if, for example, you relabel a tape that contains part of a save set series.
cannot clone backup and archive data together
Archive and backup data is fundamentally different and cannot be cloned to the same pool. You need to run nsrclone twice, once to clone the backup save sets and once more for the archive save sets.
cannot open nsrclone session with server
This message is printed when the server does not accept clone sessions.
cloning not supported; upgrade required
Another enabler is required to use this feature.
cloning requires at least 2 devices
Cloning requires at least one read/write device and one read-only or read/write device, since data is copied from one volume directly to another.
server does not support cloning
The named server is not capable of cloning.
error, no valid clones of ssid number
The listed save set exists, but cannot be cloned because there are no complete copies of the save set. The save set was either aborted or is in progress. Only complete save sets can be copied.
error, user username needs to be on administrator list
error, user username needs to be on archive users list
Only Legato Storage Manager administrators are allowed to make clones of backup save sets. Legato Storage Manager administrators are listed in the NSR server resource, see nsr_service(5) for more information. For servers with archive capability, users listed in the NSR archive client's user list are allowed to clone archive save sets.
no complete, full backup of client:saveset
During an attempt to create a super-full clone, nsrclone could not find a complete, full backup of the requested save set.
no complete save sets to clone
Only complete save sets can be copied, and no complete save sets were found matching the requested command line parameters.
number is not a valid save set
The given save set identifier is not valid. Two forms are understood: simple save set identifiers and those with a cloneid specified. Simple save sets are unsigned numbers. The save set with the cloneid form is specified as two unsigned numbers separated by a single slash (/).
pool is not a cloning pool
The pool specified with the -b pool option is not a clone pool. You must always use a pool with a type of "Backup Clone" or "Archive Clone" for the -b option.
save set number does not exist
The given save set (from a -S save set list) does not exist. Verify your save set identifiers using mminfo(8).
save set number crosses volumes; requesting additional volumes
This message is printed in verbose mode when volume names or IDs were specified, but the given save set is only partially resident on the listed volumes. Since only complete save sets can be cloned, nsrclone automatically requests additional volumes.
save set clone number/cloneid does not exist
A specific clone of a save set was specified, but that save set has no clones with that clone identifier. Verify your save set identifiers using mminfo(8).
volume name-or-number does not exist
The given volume (either a volume name or a volume id specified in the -V option) does not exist in the media database.
waiting 30 seconds then retrying
A temporary error occurred and nsrclone will automatically retry the request until the condition is cleared. For example, an error will occur if all devices are busy saving or recovering and nsrclone must wait for these devices become available.
Warning: No candidate migration save sets of client:saveset
If you are using nsrclone to create a super-full clone, and the most recent full backup of the named client and save set does not refer to any migration save sets, this warning is printed as nsrclone begins cloning the full backup.
nsrd - Daemon providing the Legato Storage Manager service
nsrd
The nsrd daemon provides an RPC-based save and recover service. This service allows users to save, query for, and recover their files across a network. The RPC program number provided by nsrd is 390103.
Normally nsrd is invoked from a startup shell script (for example rc.local, rc.boot) at boot-time, and should never need to be started directly by a user. After it is started, nsrd starts up the other daemons it needs to provide the Legato Storage Manager service.
The nsrd command must be run on a machine with appropriate resources. These resources include such things as devices (for example, tape drives) which are under the control of the media multiplexor software, nsrmmd(8), and sufficient disk space for the index daemons, nsrindexd(8), and nsrmmdbd(8), to maintain the index of user files that have been saved and which volumes contain which files.
Each time a backup, recover or various other sessions begin, nsrd starts another program, ansrd, to process the requested session. The ansrd program is called an agent. The agent is in charge of monitoring that backup, recover, or other session, and automatically exits when a session completes. Using ps(1) or another process monitoring tool, one can inspect the subsequent parameters of ansrd to see what kind of session it is monitoring. If necessary, agents can be forcibly terminated to abort a backup or recover session. Agents cannot be run directly; they can only be started by nsrd.
/nsr/logs/daemon.log
The file to which nsrd and other Legato Storage Manager daemons send information about various error conditions that cannot otherwise be logged using the Legato Storage Manager event mechanism.
/nsr/res/nsr.res
Attributes describing the Legato Storage Manager service and its resources (See nsr_service(5)).
/nsr/res/nsrjb.res
Attributes describing the jukebox resources of the Legato Storage Manager service.
nsrexec - Remotely execute Legato Storage Manager commands on Legato Storage Manager clients
nsrexec [ -a auth ] [ -vR ] [ -T hangseconds ] [ -c client ] [ -f file | - ] [ -- ... ]
The nsrexec command is run only by other Legato Storage Manager commands. It is used to remotely execute commands on Legato Storage