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 "May 13, 2017"
   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 .LP
  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.
  24 .sp
  25 .LP
  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.
  29 .sp
  30 .LP
  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.
  34 .sp
  35 .LP
  36 You should back up the directory server's configuration and data prior to
  37 running this command.
  38 .SH OPTIONS
  39 .LP
  40 The following options are supported:
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fB-i\fR \fIinput_configfile\fR\fR
  45 .ad
  46 .RS 24n
  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.
  52 .RE
  53
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fB-o\fR \fIoutput_configfile\fR\fR
  58 .ad
  59 .RS 24n
  60 Create a configuration file.
  61 .RE
  62
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fB-v\fR\fR
  67 .ad
  68 .RS 24n
  69 Verbose output.
  70 .RE
  71
  72 .SH OPERANDS
  73 .LP
  74 The following operands are supported:
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fIinput_configfile\fR\fR
  79 .ad
  80 .RS 21n
  81 Name of configuration file for \fBidsconfig\fR to use.
  82 .RE
  83
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fIoutput_configfile\fR\fR
  88 .ad
  89 .RS 21n
  90 Configuration file created by \fBidsconfig\fR.
  91 .RE
  92
  93 .SH EXAMPLES
  94 .LP
  95 \fBExample 1 \fRPrompting the User for Input
  96 .sp
  97 .LP
  98 In the following example, the user is prompted for information to set up iDS.
  99
 100 .sp
 101 .in +2
 102 .nf
 103 example# \fBidsconfig\fR
 104 .fi
 105 .in -2
 106 .sp
 107
 108 .LP
 109 \fBExample 2 \fRCreating an Output Configuration File
 110 .sp
 111 .LP
 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.
 114
 115 .sp
 116 .in +2
 117 .nf
 118 example# \fBidsconfig -o config.1\fR
 119 .fi
 120 .in -2
 121 .sp
 122
 123 .LP
 124 \fBExample 3 \fRSetting up iDS Using the Specified Configuration File
 125 .sp
 126 .LP
 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.
 130
 131 .sp
 132 .in +2
 133 .nf
 134 example# \fBidsconfig -v -i config.1\fR
 135 .fi
 136 .in -2
 137 .sp
 138
 139 .SH EXIT STATUS
 140 .LP
 141 The following exit values are returned:
 142 .sp
 143 .ne 2
 144 .na
 145 \fB\fB0\fR \fR
 146 .ad
 147 .RS 6n
 148 Successful completion.
 149 .RE
 150
 151 .sp
 152 .ne 2
 153 .na
 154 \fB>\fB0\fR\fR
 155 .ad
 156 .RS 6n
 157 An error occurred.
 158 .RE
 159
 160 .SH ATTRIBUTES
 161 .LP
 162 See \fBattributes\fR(5) for descriptions of the following attributes:
 163 .sp
 164
 165 .sp
 166 .TS
 167 box;
 168 c | c
 169 l | l .
 170 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 171 _
 172 Interface Stability     Evolving
 173 .TE
 174
 175 .SH SEE ALSO
 176 .LP
 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(1M), \fBldapaddent\fR(1M), \fBldapclient\fR(1M),
 180 \fBresolv.conf\fR(4), \fBattributes\fR(5)