DirX Directory Commands

DirX Directory provides the following administrative programs for maintaining the directory service:

  • The DirX Directory Administration Program (dirxadm), which manages the DSA. This program supports the following objects:

    • abbr—Displays valid abbreviations for object classes, attributes, and structured attributes

    • audit—Manages audit logging

    • db—Manages database configuration

    • dse—Manages DSE and policy administration

    • ldap—Performs LDAP server administration

    • lob—Manages LDIF agreements

    • nmi—Displays network management information from the DSA management information base (MIB)

    • progsvr—Manages the Progsvr

    • sob—Manages shadowing agreements

    • sys—Performs directory system administration

    Modifications performed by using dirxadm bypass the LDAP cache and the distribution over shadowing.

  • The DirX Directory Command Line DUA (dirxcp), which manages object entries in the directory information tree. This program supports the following objects:

    • abbr—Displays valid abbreviations for object classes, attributes, and structured attributes

    • args—Manages service controls associated with a DAP directory operation

    • ldapargs—Manages service controls associated with an LDAP directory operation

    • obj—Manages directory objects

  • The dirxauddecode command, which displays audit log files.

  • The dirxdumplog command, which displays the contents of a binary directory service log file or a binary transport *interface log file.

  • The dirxbackup command, which saves, restores, and verifies a DBAM database.

  • The dirxmodify command, loads an LDIF content / change file into a DBAM database.

  • The dirxconfig command, which creates the properties of a profile that describes a DBAM database (profile) and initializes a DBAM database.

  • The dbaminit command, which initializes a file-based DBAM database.

  • The dbamconfig command, which creates, deletes, and displays the properties of a profile that describes a DBAM database (profile).

  • The dbamboot command, which initializes a DBAM database.

  • The dirxload command, which loads LDIF content files into a DBAM database.

  • The dbamverify command, which verifies the consistency of a DBAM database.

  • The dbamdevinfo command, which displays information about the capacity of the logical and the attribute index specific devices of the database.

  • The dirxextop command, which performs a single LDAP extended operation.

  • The dirxhostinfo command, which provides information about host name and presentation addresses.

On Windows Server, perform the DirX Directory commands with administrator rights. Use the account that installed the DirX Directory service. Use Run as…​ from the context-sensitive menu to run the command prompt as administrator.

The remainder of this chapter describes the DirX Directory commands and provides command syntax and examples. It is organized as follows: the dirxadm command is described first, followed by descriptions of all the objects it supports in alphabetical order. The dirxcp command is next, followed by the objects it supports in alphabetical order. (Note that both dirxadm and dirxcp support the abbr object. This object is described once in the dirxadm section.) Following the dirxadm and dirxcp commands and objects, the dirxauddecode, dirxdumplog, dirxbackup, dirxmodify, dirxconfig, dbaminit, dbamconfig, dbamboot, dirxload, dbamverify, dbamdevinfo, dirxextop, and dirxhostinfo commands are described.

DirX Directory commands in scripts can use the backslash (\) as the line continuation character. In interactive mode, there is no continuation character. Instead, you must continue typing. The line automatically wraps if your characters extend beyond the line end. If you press the Enter/Return key, the information you have typed is sent to the system for processing. You should press the Enter/Return key only when you have typed all information required for the command to process.

The majority of the sample commands in this chapter uses continuation character and appear as they would appear in a script. The commands are presented this way so that they can be formatted for readability.