2 .\" Copyright (C) 2001, Sun Microsystems, Inc. All Rights Reserved
3 .\" 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.
4 .\" 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.
5 .\" 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]
6 .TH IDSCONFIG 8 "May 13, 2017"
8 idsconfig \- prepare an iPlanet Directory Server (iDS) to be populated with
9 data and serve LDAP clients
13 \fB /usr/lib/ldap/idsconfig\fR [\fB-v\fR] [\fB-i\fR \fIinput_configfile\fR]
14 [\fB-o\fR \fIoutput_configfile\fR]
19 Use the \fBidsconfig\fR tool to set up an iPlanet Directory Server (iDS). You
20 can specify the input configuration file with the \fB-i\fR option on the
21 command line. Alternatively, the tool will prompt the user for configuration
22 information. The input configuration file is created by \fBidsconfig\fR with
23 the \fB-o\fR option on a previous run.
26 The first time a server is set up, the user is prompted for all the required
27 information. Future installations on that machine can use the configuration
28 file previously generated by \fBidsconfig\fR using the \fB-o\fR option.
31 The output configuration file contains the directory administrator's password
32 in clear text. Thus, if you are creating an output configuration file, take
33 appropriate security precautions.
36 You should back up the directory server's configuration and data prior to
40 The following options are supported:
44 \fB\fB-i\fR \fIinput_configfile\fR\fR
47 Specify the file name for \fBidsconfig\fR to use as a configuration file. This
48 file will be read by \fBidsconfig\fR, and the values in the file will be used
49 to configure the server. Do not manually edit \fIinput_configfile\fR. The
50 \fIinput_configfile\fR is only partially validated, as \fBidsconfig\fR assumes
51 that the file was created by a previous invocation of the command.
57 \fB\fB-o\fR \fIoutput_configfile\fR\fR
60 Create a configuration file.
74 The following operands are supported:
78 \fB\fIinput_configfile\fR\fR
81 Name of configuration file for \fBidsconfig\fR to use.
87 \fB\fIoutput_configfile\fR\fR
90 Configuration file created by \fBidsconfig\fR.
95 \fBExample 1 \fRPrompting the User for Input
98 In the following example, the user is prompted for information to set up iDS.
103 example# \fBidsconfig\fR
109 \fBExample 2 \fRCreating an Output Configuration File
112 In the following example, the user is prompted for information to set up iDS,
113 and an output configuration file, \fBconfig.1\fR, is created when completed.
118 example# \fBidsconfig -o config.1\fR
124 \fBExample 3 \fRSetting up iDS Using the Specified Configuration File
127 In the following example, iDS is set up by using the values specified in the
128 configuration file, \fBconfig.1\fR. The verbose mode is specified, so detailed
129 information will print to the screen.
134 example# \fBidsconfig -v -i config.1\fR
141 The following exit values are returned:
148 Successful completion.
162 See \fBattributes\fR(5) for descriptions of the following attributes:
170 ATTRIBUTE TYPE ATTRIBUTE VALUE
172 Interface Stability Evolving
177 \fBldap\fR(1), \fBldapadd\fR(1), \fBldapdelete\fR(1), \fBldaplist\fR(1),
178 \fBldapmodify\fR(1), \fBldapmodrdn\fR(1), \fBldapsearch\fR(1),
179 \fBldap_cachemgr\fR(8), \fBldapaddent\fR(8), \fBldapclient\fR(8),
180 \fBresolv.conf\fR(4), \fBattributes\fR(5)