NAME

nsrarchive − archive files to long term storage with NetWorker

SYNOPSIS

nsrarchive [ −BiLnpqvxVy ] [ −b pool ] [ −C clone pool ] [ −f directive filename ] [ −G remove ] [ −I input file ] [ −N name ] [ −R name ] [ −s server ] [ −T annotation ] [ −W width ] [ path ... ]

DESCRIPTION

nsrarchive archives files, including directories or entire filesystems, to the NetWorker server (see nsr(8)).  The progress of a archive can be monitored using the X Window System based networker(8) program or the curses(3X) based nsrwatch(8) program for other terminal types.  Use of nsrarchive is restricted to user on the administrator and archive user lists. 

If no path arguments are specified and the −I option is not used, 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 or via the −I option will be encapsulated in a NetWorker archive stream.  This stream of data is sent to a receiving process (see nsrd(8)) on the NetWorker 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. 

OPTIONS

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

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

−I input file
Take the list of files to be archived from input file, in addition to any filenames specified on the command line.  Filenames should be listed one per line; blank lines (lines containing only newlines) are ignored.  Whitespace is significant and should be trimmed if necessary.  Unlike save(8), lines beginning with −t are not treated as indicating the start of time specifications. 

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

−L Local.  Archives will be performed from the local NetWorker client, even when files are from a network file server.  This is currently the default. 

−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 NetWorker server. The default is the current machine if it is running a server, otherwise the machine with the logical name “nsrhost” in the host table (see hosts(5)) is used. 

−T annotation
Archive save sets can be annotated with arbitrary text (up to 1024 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), getdate(3), hosts(5), nsr(5), nsr(8), nsr_service(5), nsr_device(5), nsrmm(8), nsrmmd(8), networker(8), nsrd(8), nsrwatch(8), retrieve(8). 

DIAGNOSTICS

Exit Codes

0 Normal exit. 

−1 Abnormal exit. 

NetWorker 4.1.2  —  Last change: May 1995