6.4 Managing Multiple Instances

This section includes the following information:

6.4.1 The ndsmanage Utility

The ndsmanage utility enables you to do the following:

Listing the Instances

The following table describes how to list the eDirectory instances.

Table 6-1 ndsmanage Usage for Listing the Instances

Syntax

Description

ndsmanage

Lists all the instances configured by you.

ndsmanage -a|--all

List instances of all the users who are using a particular installation of eDirectory.

ndsmanage username

List the instances configured by a specific user

The following fields are displayed for every instance:

  • Configuration file path

  • Server FDN and port

  • Status (whether the instance is active or inactive)

NOTE:This utility lists all the instances configured for a single binary.

Refer to Figure 6-1 for more information.

Creating an Instance through ndsmanage

To create a new instance through ndsmanage:

  1. Enter the following command:

    ndsmanage
    

    If you have two instances configured, the following screen is displayed:

    Figure 6-1 ndsmanage Utility Output Screen

  2. Enter c to create a new instance.

    You can either create a new tree or add a server to an existing tree. Follow the instructions on the screen to create a new instance.

Performing Operations for a Specific Instance

You can perform the following operations for every instance:

Other than the ones listed above, you can also run DSTrace for a selected instance.

Starting a Specific Instance

To start an instance configured by you, do the following:

  1. Enter the following:

    ndsmanage
    
  2. Select the instance you want to start.

    The menu expands to include the options you can perform on a specific instance.

    Figure 6-2 ndsmanage Utility Output Screen with Instance Options

  3. Enter s to start the instance.

Alternatively, you can also enter the following at the command prompt:

ndsmanage start --config-file configuration_file_of_the_instance_configured_by_you

Stopping a Specific Instance

To stop an instance configured by you, do the following:

  1. Enter the following:

    ndsmanage
    
  2. Select the instance you want to stop.

    The menu expands to include the options you can perform on a specific instance. For more information, refer to ndsmanage Utility Output Screen with Instance Options.

  3. Enter k to stop the instance.

Alternatively, you can also enter the following at the command prompt:

ndsmanage stop --config-file configuration_file_of_the_instance_configured_by_you

Deconfiguring an Instance

To deconfigure an instance, do the following:

  1. Enter the following:

    ndsmanage
    
  2. Select the instance you want to deconfigure.

    The menu expands to include the options you can perform on a specific instance. For more information, refer to ndsmanage Utility Output Screen with Instance Options.

  3. Enter d to deconfigure the instance.

Starting and Stopping All Instances

You can start and stop all the instances configured by you.

Starting all the Instances

To start all the instances configured by you, enter the following at the command prompt:

ndsmanage startall

To start a specific instance, refer to Starting a Specific Instance.

Stopping All Instances

To stop all the instances configured by you, enter the following at the command prompt:

ndsmanage stopall

To stop a specific instance, refer to Stopping a Specific Instance.

6.4.2 Identifying a Specific Instance

While configuring multiple instances, you assign a hostname, port number, and a unique configuration file path to every instance. This hostname and port number are the instance identifiers.

Most of the utilities have the -h hostname:port or --config-file configuration_file_location option that enables you to specify a particular instance. See the man pages of the utilities for more information.

6.4.3 Invoking a Utility for a Specific Instance

If you want to run a utility for a specific instance, you need to include the instance identifier in the utility command. The instance identifiers are the path of the configuration file, and the hostname and port number. You can use the --config-file configuration_file_location or the -h hostname:port to do so.

If you do not include the instance identifiers in the command, the utility displays the various instances you own and prompts you to select the instance you want to run the utility for.

For example, to run DSTrace for a specific utility using the --config-file option, you would enter the following:

ndstrace --config-file configuration_filename_with_location