B.1 General Utilities

This section gives a list of the eDirectory utilities on Linux and their usage.

NOTE:After installation, ensure that you run the ndsconfig, ndscheck, and ndslogin utilities from the installed location on the server, which is /opt/novell/eDirectory/bin by default. Do not run ndsconfig from the installation package.

For more information on the usage of the eDirectory utilities, see the man page for each utility and the section Troubleshooting Utilities on Linux in the NetIQ eDirectory 8.8 SP8 Troubleshooting Guide.

Command

Description

Usage

nds-install

Utility that installs NetIQ eDirectory.

nds-install [-h] [--help] [-i] [-j] [-u]

ndsconfig

Configures NetIQ eDirectory

ndsconfig new [-m <modulename>] [-i] [-S <server name>] [-t <tree_name>] [-n <server context>] [-d <path_for_dib>][-P <LDAP URL(s)>] [-L <ldap_port>] [-l <ssl_port>] [-o <http port>] [-O <https port>] [-p <IP address:[port]>] [-c] [-w <admin password>] [-W <obfuscated_password_file>] [-e] [-a <admin FDN>] [-b <port to bind>] [-B <interface1@port1>, <interface2@port2>,..] [-D <custom_location>] [--config-file <configuration file>]
ndsconfig def [-m <modulename>] [-i] [-S <server name>] [-t <tree_name>] [-n <server context>] [-d <path_for_dib>][-P <LDAP URL(s)>] [-L <ldap_port>] [-l <ssl_port>] [-o <http port>] [-O <https port>] [-e] [-a <admin FDN>] [-w <admin password>] [-W <obfuscated_password_file>] [-c] [-D <custom_location>] [--config-file <configuration file>]
ndsconfig add [-m <modulename>] [-S <server name>] [-t <tree_name>] [-p <IP_address:port>] [-n <server context>] [-d <path for dib>][-P <LDAP URL(s)>] [-L <ldap_port>] [-l <ssl_port>] [-o <http port>] [-O <https port>] [-e] [-a <admin FDN>] [-w <admin password>] [-W <obfuscated_password_file>] [-p <IP address:[port]>] [-R] [-c] [-b <port to bind>] [-B <interface1@port1, interface2@port2,..>] [-D <custom_location>] [-E] [--config-file <configuration file>]
ndsconfig rm [-a <admin FDN>] [-w <admin password>] [-W <obfuscated_password_file>] [-c] [--config-file <configuration file>]
ndsconfig upgrade [-a <admin FDN>] [-w <admin password>] [-W <obfuscated_password_file>] [-c]  [-j] [--config-file <configuration file>]
ndsconfig {set <valuelist> | get [<paramlist>] | get help [<paramlist>]}

ndscheck

Utility that checks the health of the tree.

ndscheck [--help | -?] Display command usage ndscheck [--version | -v] Display version information ndscheck [-h <hostname port>] [-a <admin FDN>] [-F <log file>] [-D] [-q] [-w <admin password>] [-W] [--config-file <file name>]
ndscheck [-a <admin FDN>] [-W] [--config-file <file name>]

For example:

ndscheck -a admin.novell -W --config-file /etc/opt/novell/eDirectory/conf-1/nds.conf

ndsmanage

Utility that lists the eDirectory instances.

ndsmanage [-a] 
ndsmanage [<username>] 

ndsbackup

Creates eDirectory object archives and adds or extracts eDirectory objects

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]
ndsbackup --version
ndsbackup [option] [file] [-a <admin FDN>] [-p passstore] [--config-file <file name>]

For example:

ndsbackup cvf /tmp/test.bak -a admin.novell -p passstore --config-file
/etc/opt/novell/eDirectory/conf-1/nds.conf

ndslogin

Diagnostic utility to verify NetIQ eDirectory authentication

ndslogin [-t <treename>] [-h <hostname[:port]>] [-p <password>] [-s] <userFDN> [--config-file <configuration_file_path>] 

ndsd

NDS daemon

/opt/novell/eDirectory/sbin/ndsd [--config-file configfile]

ndsimonitor

Monitors and diagnoses the servers in the NetIQ eDirectory tree using HTTP

/opt/novell/eDirectory/bin/ndsimonitor [-l [-d <path of ndsimonitor conf files>] | u] [-h <local_interface:port>] [--config-file <configuration_file_path>]

ndsmerge

Utility to merge two NetIQ eDirectory trees

ndsmerge [-m target-tree target-admin source-admin [target-container]] [-c] [-t] [-r target-tree source-admin] [-h <local_interface:port>] [--config-file <configuration_file_path>]

ndsrepair

Utility to repair and correct problems with the NetIQ eDirectory database, such as records, schema, bindery objects, and external references.

ndsrepair {-U |-E |-C |-P [Ad] |-S [Ad]|-N |-T |-J <entry_id>} [-A <yes/no>] [-O <yes/no>][-F <filename>] [-h <local_interface:port>] [--config-file <configuration_file_path>]
ndsrepair -R [-l  <yes/no>][-u  <yes/no>][-m  <yes/no>][-i <yes/no>][-f  <yes/no>][-d  <yes/no>][-t  <yes/no>][-o  <yes/no>][-r <yes/no>][-v  <yes/no>][-c  <yes/no>][-A <yes/no>][-O  <yes/no>][-F <filename>] [-h <local_interface>] [--config-file <configuration_file_path>]

ndssch

NetIQ eDirectory schema extension utility

ndssch [-h <hostname>[:<port>]][-t <treename>][-F <logfile>]  <admin-FDN> <schemafile> ...
ndssch [-h <hostname>[:<port>]][-t <treename>] [-d] <admin-FDN> <schemafile> [schema description] ...

ndssnmp

SNMP services module for NetIQ eDirectory.

/opt/novell/eDirectory/bin/ndssnmp

ndssnmpconfig

SNMP trap configuration utility

ndssnmpconfig [-h <hostname[:port]>] [-p <password>] [-a <userFDN>] [-c <command>]

ndssnmpsa

eDirectory SNMP subagent daemon

/opt/novell/eDirectory/bin/ndssnmpsa

ndsstat

Utility that displays the server information

ndsstat { -r -s -p <partitionname>} [-n] [[-h <hostname | IP address>:<port>] | [--config-file <configuration file>]]

ndstrace

Utility that displays the server debug messages

ndstrace [-l|-u|-c "command1;......"|--version] [-h <local_interface:port>] [--config-file <configuration_file_path>]

nds-uninstall

Utility to uninstall NetIQ eDirectory

nds-uninstall [-s][-h]

nldap

LDAP services for NDS daemon

/opt/novell/eDirectory/sbin/nldap

nmasinst

NMAS configuration utility

nmasinst -i <admin-FDN> <treename> [-h <hostname>[:port]]
nmasinst -addmethod <admin-FDN> <treename> <config.txt file> [-h <hostname>[:port]]

npki

Novell Public Key Infrastructure Services

/opt/novell/eDirectory/sbin/npki