usr/src/man/man1m/idsconfig.1m

   1 '\" te
   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 1M "Oct 18, 2001"
   7 .SH NAME
   8 idsconfig \- prepare an iPlanet Directory Server (iDS) to be populated with
   9 data and serve LDAP clients
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fB /usr/lib/ldap/idsconfig\fR [\fB-v\fR] [\fB-i\fR \fIinput_configfile\fR]
  14      [\fB-o\fR \fIoutput_configfile\fR]
  15 .fi
  16
  17 .SH DESCRIPTION
  18 .sp
  19 .LP
  20 Use the \fBidsconfig\fR tool to set up an iPlanet Directory Server (iDS). You
  21 can specify the input configuration file with the \fB-i\fR option on the
  22 command line. Alternatively, the tool will prompt the user for configuration
  23 information. The input configuration  file is created by \fBidsconfig\fR with
  24 the \fB-o\fR option on a previous run.
  25 .sp
  26 .LP
  27 The first time a server is set up, the user is prompted for all the required
  28 information.  Future installations on that machine can use the configuration
  29 file previously generated by \fBidsconfig\fR using the \fB-o\fR option.
  30 .sp
  31 .LP
  32 The output configuration file contains the directory administrator's password
  33 in clear text. Thus, if you are creating an output configuration file, take
  34 appropriate security precautions.
  35 .sp
  36 .LP
  37 You should back up the directory server's configuration and data prior to
  38 running this command.
  39 .SH OPTIONS
  40 .sp
  41 .LP
  42 The following options are supported:
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fB-i\fR \fIinput_configfile\fR\fR
  47 .ad
  48 .RS 24n
  49 Specify the file name for \fBidsconfig\fR to use as a configuration file.  This
  50 file will be read by \fBidsconfig\fR, and the values  in the file will be used
  51 to configure the server.  Do not manually edit \fIinput_configfile\fR. The
  52 \fIinput_configfile\fR is only partially validated, as \fBidsconfig\fR assumes
  53 that the file was created by a previous invocation of the command.
  54 .RE
  55
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fB-o\fR \fIoutput_configfile\fR\fR
  60 .ad
  61 .RS 24n
  62 Create a configuration file.
  63 .RE
  64
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fB-v\fR\fR
  69 .ad
  70 .RS 24n
  71 Verbose output.
  72 .RE
  73
  74 .SH OPERANDS
  75 .sp
  76 .LP
  77 The following operands are supported:
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fIinput_configfile\fR\fR
  82 .ad
  83 .RS 21n
  84 Name of configuration file for \fBidsconfig\fR to use.
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fIoutput_configfile\fR\fR
  91 .ad
  92 .RS 21n
  93 Configuration file created by \fBidsconfig\fR.
  94 .RE
  95
  96 .SH EXAMPLES
  97 .LP
  98 \fBExample 1 \fRPrompting the User for Input
  99 .sp
 100 .LP
 101 In the following example, the user is prompted for information to set up iDS.
 102
 103 .sp
 104 .in +2
 105 .nf
 106 example# \fBidsconfig\fR
 107 .fi
 108 .in -2
 109 .sp
 110
 111 .LP
 112 \fBExample 2 \fRCreating an Output Configuration File
 113 .sp
 114 .LP
 115 In the following example, the user is prompted for information to set up iDS,
 116 and an output configuration file, \fBconfig.1\fR, is created when completed.
 117
 118 .sp
 119 .in +2
 120 .nf
 121 example# \fBidsconfig -o config.1\fR
 122 .fi
 123 .in -2
 124 .sp
 125
 126 .LP
 127 \fBExample 3 \fRSetting up iDS Using the Specified Configuration File
 128 .sp
 129 .LP
 130 In the following example, iDS is set up by using the values specified in the
 131 configuration file, \fBconfig.1\fR. The verbose mode is specified, so detailed
 132 information will print to the screen.
 133
 134 .sp
 135 .in +2
 136 .nf
 137 example# \fBidsconfig -v -i config.1\fR
 138 .fi
 139 .in -2
 140 .sp
 141
 142 .SH EXIT STATUS
 143 .sp
 144 .LP
 145 The following exit values are returned:
 146 .sp
 147 .ne 2
 148 .na
 149 \fB\fB0\fR \fR
 150 .ad
 151 .RS 6n
 152 Successful completion.
 153 .RE
 154
 155 .sp
 156 .ne 2
 157 .na
 158 \fB>\fB0\fR\fR
 159 .ad
 160 .RS 6n
 161 An error occurred.
 162 .RE
 163
 164 .SH ATTRIBUTES
 165 .sp
 166 .LP
 167 See \fBattributes\fR(5) for descriptions of the following attributes:
 168 .sp
 169
 170 .sp
 171 .TS
 172 box;
 173 c | c
 174 l | l .
 175 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 176 _
 177 Interface Stability     Evolving
 178 .TE
 179
 180 .SH SEE ALSO
 181 .sp
 182 .LP
 183 \fBldap\fR(1), \fBldapadd\fR(1), \fBldapdelete\fR(1), \fBldaplist\fR(1),
 184 \fBldapmodify\fR(1), \fBldapmodrdn\fR(1), \fBldapsearch\fR(1),
 185 \fBldap_cachemgr\fR(1M), \fBldapaddent\fR(1M), \fBldapclient\fR(1M),
 186 \fBsuninstall\fR(1M), \fBresolv.conf\fR(4), \fBattributes\fR(5)