PingDirectory

Using dsconfig in non-interactive mode

The dsconfig non-interactive command-line mode provides a simple way to make arbitrary changes to the server by invoking it from the command line.

Steps

  1. To use administrative scripts to automate configuration changes, run the dsconfig command in non-interactive mode.

    Non-interactive mode is convenient for scripting applications.

    If you plan to make changes to multiple configuration objects at the same time, then the batch mode might be more appropriate.

  2. Use the dsconfig tool to update a single configuration object using command-line arguments to provide all of the necessary information.

    Example:

    The following shows the general format for the non-interactive command line.

    $ bin/dsconfig --no-prompt {globalArgs} {subcommand} {subcommandArgs}

    The --no-prompt argument indicates that you want to use non-interactive mode. The {sub-command} is used to indicate which general action to perform. The {globalArgs} argument provides a set of arguments that specify how to connect and authenticate to the PingDirectory server. Global arguments can be standard LDAP connection parameters or SASL connection parameters depending on your setup. For example, using standard LDAP connections, you can invoke the dsconfig tool, as shown.

    $ bin/dsconfig --no-prompt list-backends \
  --hostname server.example.com \
  --port 389 \
  --bindDN uid=admin,dc=example,dc=com \
  --bindPassword password

  3. If your system uses SASL GSSAPI (Kerberos), invoke dsconfig as shown.

    $ bin/dsconfig --no-prompt list-backends \
  --saslOption mech=GSSAPI \
  --saslOption authid=admin@example.com \
  --saslOption ticketcache=/tmp/krb5cc_1313 \
  --saslOption useticketcache=true

  4. To always display the advanced properties, use the --advanced command-line option.

    The {subcommandArgs} argument contains a set of arguments specific to the particular subcommand that you want to invoke.

    Global arguments can appear anywhere on the command line, including before the subcommand and after or intermingled with subcommand-specific arguments. The subcommand-specific arguments can appear anywhere after the subcommand.