11.2 Managing Instances with the ndsmanage Utility

The ndsmanage utility enables you to create, start, and stop server instances in the Identity Vault. You can also view a list of configured instances.

11.2.1 Listing Identity Vault Instances

You can use the ndsmanage utility to view the configuration file path, fully distinguished name and port for the server instance, and the status of the instance (active or inactive) for specified users. The utility supports the following parameters:

ndsmanage

Lists all instances configured by you.

ndsmanage -a|--all

Lists instances of all the users who are using a particular installation of the Identity Vault.

ndsmanage username

Lists the instances configured by the specified user.

11.2.2 Creating a New Instance in the Identity Vault

  1. At the command line, enter ndsmanage.

  2. Enter c.

  3. Follow the instructions at the command prompt to create the new instance.

11.2.3 Configuring and Deconfiguring an Instance in the Identity Vault

To configure an instance, enter the following command:

ndsconfig new -t treename -n server_context -a admin_FDN -b port_to_bind -D path_for_data

For example:

ndsconfig new -t mytree -n o=netiq -a cn=admin.o=company -b 1524 -D
/home/mary/inst1/var --config-file /home/mary/inst1/nds.conf

NOTE:The Linux operating system restricts sockets creation on the mounted file system. With eDirectory, NetIQ recommends that you have the var directory on the local file system (-D option with ndsconfig) and the DIB directory can be of any file system (-d option with ndsconfig).

To deconfigure an instance:

  1. At the command line, enter ndsmanage.

  2. Select the instance that you want to deconfigure.

  3. Enter d.

11.2.4 Invoking a Utility for an Instance in the Identity Vault

You can run utilities, such as DSTrace, against an instance. For example, you want to run the DSTrace utility for instance 1 that is listening on port 1524, with its configuration file in the /home/mary/inst1/nds.conf directory and its DIB file in the /home/mary/inst1/var directory. You can enter one of the following commands:

ndstrace --config-file /home/mary/inst1/nds.conf

or

ndstrace -h 164.99.146.109:1524

If you do not specify the instance identifiers, the utility displays all of your instances. You can then select an instance.

11.2.5 Starting and Stopping Instances in the Identity Vault

You can start or stop one or more instances that you configured.

  1. (Conditional) For a guided process in starting or stopping a single instance, complete the following steps:

    1. At the command line, enter ndsmanage.

    2. Select the instance that you want to start or stop.

    3. Enter s or k to start or stop the instance, respectively.

  2. (Conditional) To start or stop a single instance, enter:

    ndsmanage start --config-file configuration_file_of_the_instance

    or

    ndsmanage stop --config-file configuration_file_of_the_instance

  3. (Conditional) To start or stop all instances, enter:

    ndsmanage startall

    or

    ndsmanage stopall