NAME | SYNOPSIS | DESCRIPTION | SUBCOMMANDS | OPTIONS | EXAMPLES | EXIT STATUS | ATTRIBUTES | SEE ALSO
The directoryserver command is a comprehensive, front end to the utility programs provided by the Solaris Directory Server (DS).
Options for the directoryserver command itself must appear before the subcommand. Arguments for a subcommand must appear after the subcommand. Subcommands have specific arguments. See SUBCOMMANDS.
When managing multiple versions of Directory Server, use the appropriate option to identify the version to which the command applies. By default Directory Server operates using the most recent version. The -useversion option allows you to select which version you wish to use. When multiple versions of Directory Server are installed, the initial default version is the first version installed.
The following subcommands are supported:
Inactivates and locks an entry or group of entries.
Activates an entry or group of entries.
Provides account status information to establish whether an entry or group of entries is inactivated or not.
Deprecated subcommand. Use the Server Console to update the local Administration Server configuration file and configuration directory instead. When your computer system's IP address changes, you must change to the new IP address, as failing to do so would prevent you from being able to start Administration Server.
Restore the database from the most recent archived backup. Directory Server must be stopped for this tool to work.
Restore the data to the database.
Configure an instance of Directory Server.
The configure subcommand has two modes of operation. You can invoke it with a curses-based interaction to gather input. Alternatively, you can provide input in a configuration file using the -f option, which requires the DISPLAY environment variable to be set.
The configure subcommand supports the following arguments:
Specifies the configuration file for silent installation.
Create a backup of the current database contents. This command can be executed with the server either running or not.
Create a backup of the current database contents. Directory Server must be running to exexute this command.
Create and generate the new set of indexes to be maintained following the modification of indexing entries in the cn=config configuration file.
Export the contents of the database to LDIF. You must specify either the -n or the -s option or both. This tool can be executed while the server is still running.
Export the contents of the database to LDIF. To run this subcommand the server must be running and either the -n backend_instance or the -s includesuffix option is required.
Display directoryserver usage message or subcommand specific usage message. To obtain a usage message for the directoryserver command itself, type directoryserver help and to obtain a usage message for a directoryserver subcommand, type directoryserver subcommand help.
Provide an easy and reliable way of checking the patch levels and kernel parameter settings for your system. You must install Directory Server before you can run idsktune. It gathers information about the operating system, kernel, and TCP stack to make tuning recommendations.
For information regarding the arguments supported by the idsktune command see: idsktune(1).
Import directory contents from LDIF. To run this tool Directory Server must be stopped.
Import data to the directory. The server must be running when you run this subcommand.
Format LDIF files, and create base 64 encoded attribute values. With base 64 encoding you can represent binary data, such as a JPEG image, in LDIF. You identify base 64 encoded data by using the :: symbol. The ldif subcommand takes any input and formats it with the correct line continuation and appropriate attribute information. The subcommand also senses whether the input requires base 64 encoding.
Perform an import operation over LDAP to Directory Server. To run the ldif2ldap subcommand the server must be running.
Deprecated subcommand. See/use the mpsadmserver(1m) magt subcommand instead.
Retrieve performance monitoring information using the ldapsearch command-line utility.
Combine multiple LDIF files into a single authoritative set of entries. Typically each LDIF file is from a master server cooperating in a multi master replication agreement (e.g. masters that refuse to sync up for whatever reason). Optionally, it can generate LDIF change files that could be applied to the original to bring it up to date with the authoritative. At least two input files must be specified.
Subcommand is no longer supported. Use iconv (1M) instead.
Print the encrypted form of a password using one of the server's encryption algorithms. If a user cannot log in, you can use this script to compare the user's password to the password stored in the directory.
Restart Directory Server. All instances are started by default. With the -s option, you can specify the instance to be restarted.
Deprecated subcommand. See/use the mpsadmserver(1m) restart-admin subcommand instead.
Restore the most recently saved Directory Server configuration information. This subcommand overrides the content under/ServerRoot/slapd-serverID/config with the data from /ServerRoot/slapd-serverID/confbak
Deprecated subcommand. See/use the mpsadmserver(1m) sagt subcommand instead.
Save the Directory Server configuration information to the /ServerRoot/slapd-serverID/confbak directory. Directory Server must be running for this tool to work.
Start Directory Server. All instances are started by default. With the -s option, you can specify the instance to be restarted.
Deprecated subcommand. See/use the mpsadmserver(1m) start-admin subcommand instead.
Deprecated subcommand. See/use the mpsconsole(1m) startconsole subcommand instead.
Stop Directory Server.
With the -s option, you can specify the instance to be stopped.
Deprecated subcommand. See/use the mpsadmserver(1m) stop-admin subcommand instead.
Map a suffix to a database.
Specify -s suffix as the suffix to be mapped to the database.
Removes all Directory Server instances and configuration, including any changes made following configuration.
The unconfigure subcommand has two modes of operation. You can invoke it with a GUI-based interaction to gather input. Alternatively, you can provide input in a configuration file using the -f option.
The unconfigure subcommand supports the following arguments:
Specifies the configuration file for silent installation.
Create virtual list view (VLV) indexes, known in the Directory Server Console as Browsing Indexes. The server must be stopped beforehand.
Options for the directoryserver command itself must appear before the subcommand argument.
The following options are supported:
Display the version of Directory Server managed and the path to the directoryserver command used when no version is specified.
Display all versions of Directory Server that can be managed with the directoryserver.
Set the version of Directory Server managed when no version is specified. version must be of the form displayed when the -listversions option is used.
The server instance name. Specify the Directory Server instance to process the command against. For some of the listed subcommands the server instance is optional and for other sub commands it is a required option.
Use the version of Directory Server specified to perform the subcommand using the arguments specified. version must be of the form displayed when the -listversions option is used.
The following command starts all the instances of Directory Server:
example% directoryserver start |
The following command starts the instances of myhost of Directory Server.
example% directoryserver -s myhost start |
The following command runs the monitor tool and outputs the current status of the ephesus directory instance.
example% directoryserver -s ephesus monitor |
The following command runs the idsktune tool and outputs performance tuning information:
example% directoryserver idsktune |
Configure Directory Server 5.2 when 5.1 is also installed.
example% directoryserver -u 5.2 configure |
Check the version managed and directoryserver command used when no version is specified.
example% directoryserver -g Default is: 5.2:/usr/ds/v5.2/sbin/directoryserver |
The path to the command used is provided for debugging purposes only. Do not use such paths in your scripts.
Make Directory Server 5.2 the version managed when no version information is specified.
example% directoryserver -d 5.2 |
This example shows that when 5.2 is the default version, you can still manage Directory Server 5.1 instances. The 5.1 instance in this example is named dirserv.
example% directoryserver -g Default is: 5.2:/usr/ds/v5.2/sbin/directoryserver example% directoryserver -u 5.1 stop -s dirserv |
See attributes(5) for descriptions of the following attributes:
ATTRIBUTE TYPE | ATTRIBUTE VALUE |
---|---|
Availability | SUNWdsvu |
Stability Level | Stable |
mpsadmserver(1M)
Directory Server Administration Guide
Directory Server Administration Reference
NAME | SYNOPSIS | DESCRIPTION | SUBCOMMANDS | OPTIONS | EXAMPLES | EXIT STATUS | ATTRIBUTES | SEE ALSO