Manpage of nbackup

nbackup

Section: User Commands (1)
Updated: 6 June 2005
Index Return to OES 2 Main Contents

NAME

nbackup - Novell backup application to back up and restore using the Novell Storage Management Services (SMS) framework.

SYNOPSIS

nbackup [options] [directory1, ...directoryN] [file1,.... fileN]

DESCRIPTION

nbackup is an archive utility that can be used to create archives using the ECMA standard System Independent Data Format [SIDF]. nbackup uses the Novell SMS framework (see sms(7)) to connect to different targets locally or remotely and to create SIDF archives. This utility can create and extract archives created on tape or on disk. Disk archives are created with file extension "sidf". nbackup command can take different options followed by directory or filenames to create or extract from an archive. All non-option arguments are considered as names of files or directories. By default, nbackup recurses into subdirectories and excludes the mount points under the given path. nbackup is intended to be a sample backup application that can be used to understand and set up the SMS framework. It is not intended or built to be used as an enterprise backup solution and it might not support advanced backup options.

OPTIONS

Operations

The options should contain one of the following operations:

-c, --create: Creates a new nbackup archive.
-t, --list: Lists the filenames in the given archive.
-x, --extract: Extracts files from the archive.
-a , --append: Appends files to an existing archive.

Other Options

-h, --help: Displays help on usage of the nbackup utility.
--exclude-path=[@]path: Excludes the file/directory with the specified path for back up or restore. You can also use this to exclude directories specified in an input file; each directory path should be separated by a new line. Use this option multiple times to exclude more than one path.
--extract-dir=[@]path: Extracts the specified directory from the archive. You can also use this to extract directories specified in an input file; each directory path should be separated by a new line. Use this option multiple times to extract more then one directory.
--extract-file=[@]path: Extracts the specified file from the archive. You can also use this to extract files specified in a input file; each directory path should be separated by a new line. Use this option multiple times to extract more then one file.
--exclude-file=name pattern: Excludes all files matching the name or pattern for back up or restore. Filenames can contain a pattern with wild cards * and ?. Use this option multiple times to exclude more than one pattern.
--exclude-file-data: Excludes the files' data during backup or restore, and backs up or restores only the meta data for a file.
-F, --full-paths: Stores the full paths for both directories and files in the created archive.
-f, --file=archive name: Name of the target file/device to write the archive data. Writes to stdout by default.
-V, --label=NAME: Creates archive labelled NAME.
-k, --keep-old-files: Does not overwrite existing files while extracting files from the archive. Files will be overwritten, if this option is not present.
-m, --move-to=PATH: Extracts the archive to the given PATH.
-N, --after-date=date: Backs up files newer than date
-P, --password=password: The password to connect to the Target Service Agent. The password can be supplied at runtime.
-r, --restore-to="BACKUP_PATH NEW_PATH": Restores by replacing BACKUP_PATH with NEW_PATH.
-R, --remote-target=HOSTNAME: Connects to the file system Target Service Agent (TSA) of host specified in HOSTNAME for backup.
--target-type=TARGET_NAME: Connects to the Target Service specified by TARGET_NAME. TARGET_NAME can take the values of Linux, NetWare, iFolder.
-S, --summary: Prints statistical details like total bytes and the files and directories written while creating the archive.
-T, --input-file=file: Takes file containing fully qualified paths as input for creating archive. This file should contain one path per line.
-U, --user=user id: Username to use while connecting to the Target Service Agent.
--version: Displays the version of the nbackup utility.
-v, --verbose: Displays verbose messages while executing the command.

EXAMPLES

: nbackup --help or nbackup -h Displays the usage information.
: nbackup -cvf myarchive.sidf -U user1 --target-type=linux /home/user1 Creates SIDF archive named myarchive.sidf with all files under the directory /home/user1 using Linux File System Target Service. Use the option -R HOSTNAME to connect to remote hosts.
: nbackup -xvf myarchive.sidf -r "/home/user1 /home/newuser" -U user1 Extracts the archive myarchive.sidf to /home/newuser with verbose messages using the userid 'user1'.
: nbackup -tvf myarchive.sidf Lists the file names available in archive myarchive.sidf
: nbackup -cU user1 --after-date="01-01-2005 12:30" /home/user1 1>myarchive.sidf Creates an archive, myarchive.sidf, that contains files and directories modified after 1st January 2005 in /home/user1.

NOTES

The option --after-date (or -N) supports date-time inputs in the following formats: "%d-%m-%Y %H:%M:%S" "%d-%m-%Y %H:%M" where d,m,Y,H,S are format variables of standard Linux date/time implementations. The supported formats can be extended using the DATEMSK environment variable, in case of extensions, the DATEMSK environment variable must be sent to the file path pointing to the date-time formats to support. See getdate(1),strptime(3) man pages for more information on DATEMSK and its usage.

AUTHOR

Novell, Inc.

COPYRIGHT