xref: /illumos-gate/usr/src/man/man8/idsconfig.8 (revision bbf21555)
te
Copyright (C) 2001, Sun Microsystems, Inc. All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
IDSCONFIG 8 "May 13, 2017"
NAME
idsconfig - prepare an iPlanet Directory Server (iDS) to be populated with data and serve LDAP clients
SYNOPSIS

 /usr/lib/ldap/idsconfig [-v] [-i input_configfile]
 [-o output_configfile]
DESCRIPTION

Use the idsconfig tool to set up an iPlanet Directory Server (iDS). You can specify the input configuration file with the -i option on the command line. Alternatively, the tool will prompt the user for configuration information. The input configuration file is created by idsconfig with the -o option on a previous run.

The first time a server is set up, the user is prompted for all the required information. Future installations on that machine can use the configuration file previously generated by idsconfig using the -o option.

The output configuration file contains the directory administrator's password in clear text. Thus, if you are creating an output configuration file, take appropriate security precautions.

You should back up the directory server's configuration and data prior to running this command.

OPTIONS

The following options are supported: -i input_configfile

Specify the file name for idsconfig to use as a configuration file. This file will be read by idsconfig, and the values in the file will be used to configure the server. Do not manually edit input_configfile. The input_configfile is only partially validated, as idsconfig assumes that the file was created by a previous invocation of the command.

-o output_configfile

Create a configuration file.

-v

Verbose output.

OPERANDS

The following operands are supported: input_configfile

Name of configuration file for idsconfig to use.

output_configfile

Configuration file created by idsconfig.

EXAMPLES

Example 1 Prompting the User for Input

In the following example, the user is prompted for information to set up iDS.

example# idsconfig

Example 2 Creating an Output Configuration File

In the following example, the user is prompted for information to set up iDS, and an output configuration file, config.1, is created when completed.

example# idsconfig -o config.1

Example 3 Setting up iDS Using the Specified Configuration File

In the following example, iDS is set up by using the values specified in the configuration file, config.1. The verbose mode is specified, so detailed information will print to the screen.

example# idsconfig -v -i config.1
EXIT STATUS

The following exit values are returned: 0

Successful completion.

>0

An error occurred.

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Evolving
SEE ALSO

ldap (1), ldapadd (1), ldapdelete (1), ldaplist (1), ldapmodify (1), ldapmodrdn (1), ldapsearch (1), resolv.conf (5), attributes (7), ldap_cachemgr (8), ldapaddent (8), ldapclient (8)