NDSBACKUP allows for a entry level restore.

A simple backup can be done with something like:

ndsbackup cvf /tmp/ndsbackupfile.bck -a admin.administration.willeke.com 

ndsbackup#

ndsbackup - creates Novell eDirectory object archives and adds or extracts eDirectory objects

SYNOPSIS#

 ndsbackup  c  [f <ndsbackupfile>] [e] [v] [w] [X <exclude-file>] [R] [Replica-server-name] [-a admin-user] [-I include-file] [-E password] [--config-file <configuration_file_path>]... [eDirectoryobject]

 ndsbackup r [f <ndsbackupfile>] [e] [v] [w] [X <exclude-file>] [R] [Replica-server-name] [-a admin-user] [-I include-file]  [-E  password] [--config-file <configuration_file_path>]... [eDirectoryobject]


ndsbackup  t   [f <ndsbackupfile>] [e] [v] [w] [X <exclude-file>] [R] [Replica-server-name] [-a admin-user] [-I include-file] [-E password] [--config-file <configuration_file_path>]... [eDirectoryobject]


ndsbackup x [f <ndsbackupfile>] [e] [v] [w] [X <exclude-file>] [R] [Replica-server-name] [-a admin-user] [-I  include-file]  [-E  password] [--config-file <configuration_file_path>]... [eDirectoryobject]


ndsbackup  s  [e] [v] [w] [X <exclude-file>] [R] [Replica-server-name] [-a admin-user] [-I include-file] [-E password] [--config-file <configuration_file_path>]... [eDirectoryobject]

If any of the containers have dotted names, ensure that the '.' (dot) is escaped using the '\' (backslash) character.

DESCRIPTION#

The ndsbackup utility archives and extracts Novell eDirectory objects to and from a single file called an ndsbackupfile. You need to log in as a user with Administrator rights to the tree to archive or restore objects. The ndsbackup utility's actions are controlled by the key argument. The key is a string of characters containing exactly one function letter (c, r, t , s, or x) and zero or more function modifiers(letters or digits), depending on the function letter used. The key string contains no space characters. Function modifier arguments are listed on the command line in the same order as their corresponding function modifiers appear in the key string.

The -I include-file and eDirectoryobject arguments specify which eDirectory objects (eDirectory leaf objects or eDirectory container objects) are to be archived or extracted. In all cases, the appearance of an eDirectory container refers to the object itself and (recursively) subordinate objects of that container.

The ndsbackup utility allows you to customize the backup process. You can choose specific eDirectory objects to exclude or include in the backup session. Whether you use exclude or include usually depends on the size of the data you want to back up, compared to the size you do not want to back up. By combining the include and exclude options, you can control what is backed up. To back up most of the eDirectory tree structure while omitting only a small part, use the exclude option to omit the part you do not want to back up. Everything that you do not specifically excluded is included. After you exclude part of the structure, you cannot include objects below that container.

To back up a small part of the eDirectory tree structure, use the include option to specify the data you want. Everything you do not specifically include is excluded. When you specifically select only part of the eDirectory tree structure to include, all objects below that container are included.

You can specify a maximum of 255 total entries in the include and exclude files. You can use wildcard characters (* and ?) in the eDirectory object names.

While using ndsbackup to backup a container that has many objects (like a million), it might take some time to get the list of the objects in the container and start their individual backup.

NOTE: ndsbackup can be used only for backup and restore operations on the same tree.

OPTIONS#

The following options are supported:
  • -a admin-user - The fully distinguished name (FDN) in dot format of the user with Administrator rights to the objects being archived or restored.
  • -I include-file - Opens the include-file containing a list of eDirectory objects, one per line, and acts as if each eDirectory object appeared separately on the command line. If an eDirectory object is specified in both the exclude-file and the include-file (or on the command line), it will be included. Be careful of trailing spaces.
  • -E password - Prompts for password to encrypt or decrypt backup data if any attributes are marked for encryption. If you do not use this option and if you have attributes marked for encryption, the backup/restore fails with the "Requires a Password" error.
  • --config-file - Specifies the location of the nds.conf configuration file.

OPERANDS#

The following operands are supported:

eDirectory object#

The fully distinguished name (FDN) of a leaf object or a container to be archived (when the c or r functions are specified), extracted (x), or listed (t). The action applies to all of the objects and (recursively) subordinate objects of that container. To archive the whole tree, specify [Root]]. You can also back up the eDirectory schema by specifying Schema as the eDirectory object. To back up the entire tree along with the schema, specify Full Directory Backup. If you do not specify the eDirectory object to be backed up, ndsbackup uses the default Full Directory Backup option.

Function Letters#

The function portion of the key is specified by one of the following letters:
  • c Create - The eDirectory objects are backed up in the specified ndsbackupfile. Writing begins at the beginning of the ndsbackupfile, instead of at the end. If the specified ndsbackupfile already exists, it will be overwritten.
  • r Replace - The named eDirectory objects are backed up in the specified ndsbackupfile. The eDirectory objects are appended to the specified ndsbackupfile, effectively replacing the existing objects for restore.
  • s Scans - Scans the eDirectory objects in a tree.
  • t Table of Contents - The names of the specified eDirectory objects are listed each time they occur in the ndsbackupfile. If no
argument is given, the names of all eDirectory objects in the ndsbackupfile are listed.
  • x RestoreThe named eDirectory objects are extracted from the ndsbackupfile and restored to the eDirectory tree. If a
named eDirectory object matches a container whose contents have been written to the ndsbackupfile, this con‐ tainer is recursively extracted.
  • --versionPrints the version information.

Function Modifiers#

The following characters can be used in conjunction with the letter that selects the desired function.
  • f File - Use the ndsbackupfile argument as the name of the ndsbackupfile. If f is omitted, or if the name of the ndsbackupfile is a hyphen (-), ndsbackup writes to the standard output or reads from the standard input, whichever is appropriate. The ndsbackup utility can be used as the head or tail of a pipeline.
  • e Error - Exit immediately with an Exit status if an unexpected error occurs.
  • R Replica servername/IP address - Use this option to archive or restore eDirectory objects using a server holding the replica of an eDirectory partition. If you omit the R option, the local server is used. In addition, you can also archive the tree objects remotely. You can even restore the same archived tree using the remote restore operation.
  • v Verbose - Outputs the name of each eDirectory object preceded by the function letter. Along with the t function, v provides additional information about the ndsbackupfile entries.
  • w What - Outputs the action to be taken and the name of the eDirectory object, then waits for the user's confirmation. If you enter y, the action is performed. If you enter any other key, the action is not performed. This function modifier cannot be used with the t function.
  • X Exclude - Use the exclude-file argument as a file containing a list of eDirectory objects to be excluded from the ndsbackupfile when using the functions c, x, s, or t. Multiple X arguments can be used, with one exclude-file per argument. If an eDirectory object is specified in both the exclude-file and the include-file (or on the command line), it will be included. Be careful of trailing spaces.

EXAMPLES#

To archive eDirectory objects in the container abc_inc, enter the following command:
ndsbackup cvf ndsbackupfile .o=abc_inc

To archive eDirectory objects in the dotted container xyz.com, enter the following command:

ndsbackup cvf ndsbackupfile .o=xyz.com
To archive all the eDirectory objects in the tree, enter the following command:
ndsbackup cvf ndsbackupfile [Root]
To archive the eDirectory schema, enter the following command:
ndsbackup cvf ndsbackupfile Schema
To archive the complete tree along with the schema, enter the following command:
ndsbackup cvf ndsbackupfile "Full Directory Backup" or ndsbackup cvf ndsbackupfile
To archive all the objects under the context ou=xyz.o=abc, enter the following command:
ndsbackup cvf ndsbackupfile ou=xyz.o=abc
To archive the tree using a replica on a remote server (serv in this example), enter the following command:
ndsbackup cvfR ndsbackupfile serv [Root]
To archive only specific objects, store the names of the objects in an inc-file file, then enter the following command:
ndsbackup cvf ndsbackupfile -I inc-file [Root]
To archive the tree excluding specific objects, store the names of these objects in an exc-file file and enter the following command:
ndsbackup cvfX ndsbackupfile exc-file [Root]
To see the result of a backup before creating the archive file, enter the following command:
ndsbackup sX exc-file [Root]
To restore all the objects in an archive file, enter the following command:
ndsbackup xvf ndsbackupfile
To restore all the objects under the context ou=xyz.o=abc, enter the following command:
ndsbackup xvf ndsbackupfile ou=xyz.o=abc_inc

EXIT STATUS#

The following exit values are returned:
  • 0 - Successful completion.
  • >0 - An error occurred.

NDSBACKUP and ndspassstore#

ndsbackup can work with ndspassstore.

WARNING - Apparently does not work with multiple incidences installs of eDirectory.

ndsbackup xvf /tmp/test.bak -a admin.novell -p passstore

More Information#

There might be more information for this subject on one of the following:

Add new attachment

Only authorized users are allowed to upload new attachments.
« This page (revision-15) was last changed on 12-Feb-2011 09:54 by jim