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

   1 '\" te
   2 .\"  Copyright (c) 2007, 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 DSCFG 1M "Oct 2, 2007"
   7 .SH NAME
   8 dscfg \- configuration tool for Sun StorageTek Availability Suite software
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBdscfg\fR
  13 .fi
  14
  15 .LP
  16 .nf
  17 \fBdscfg\fR \fB-L\fR
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBdscfg\fR \fB-h\fR
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fBdscfg\fR [\fB-C\fR \fIgroup\fR]
  28 .fi
  29
  30 .LP
  31 .nf
  32 \fBdscfg\fR [\fB-C\fR \fIgroup\fR] \fB-i\fR [\fB-p\fR \fIparser_config_file\fR]
  33 .fi
  34
  35 .LP
  36 .nf
  37 \fBdscfg\fR [\fB-C\fR \fIgroup\fR] \fB-a\fR \fIconfig_file\fR
  38 .fi
  39
  40 .LP
  41 .nf
  42 \fBdscfg\fR [\fB-C\fR \fIgroup\fR] [\fB-l\fR]
  43 .fi
  44
  45 .LP
  46 .nf
  47 \fBdscfg\fR [\fB-C\fR \fIgroup\fR] [\fB-l\fR] \fB-s\fR \fIconfig_location\fR
  48 .fi
  49
  50 .LP
  51 .nf
  52 \fBdscfg\fR \fB-D\fR \fIdgname\fR
  53 .fi
  54
  55 .SH DESCRIPTION
  56 .sp
  57 .LP
  58 The \fBdscfg\fR command controls the Availability Suite configuration by
  59 providing facilities to initialize, list, format, restore the configuration
  60 database.
  61 .SH OPTIONS
  62 .sp
  63 .LP
  64 If no options are specified, \fBdscfg\fR displays the current local
  65 configuration location. The \fBdscfg\fR command supports the following options:
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fB-L\fR\fR
  70 .ad
  71 .sp .6
  72 .RS 4n
  73 Displays the status of the lock controlling access to the configuration
  74 database. If the configuration database is locked, the type of lock (read or
  75 write) is displayed along with the process id of the process that holds the
  76 lock.
  77 .RE
  78
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fB-h\fR\fR
  83 .ad
  84 .sp .6
  85 .RS 4n
  86 Displays the usage message for the \fBdscfg\fR command.
  87 .RE
  88
  89 .sp
  90 .ne 2
  91 .na
  92 \fB\fB-i\fR\fR
  93 .ad
  94 .sp .6
  95 .RS 4n
  96 Initializes the configuration database. As it deletes previous or current
  97 configuration information, this option prompts you to confirm the deletion
  98 before proceeding.
  99 .RE
 100
 101 .sp
 102 .ne 2
 103 .na
 104 \fB\fB-p\fR \fIparser_config_file\fR\fR
 105 .ad
 106 .sp .6
 107 .RS 4n
 108 When used with the \fB-i\fR option, \fBdscfg\fR loads the parser configuration
 109 file into the persistent configuration, it reformats the configuration
 110 database.
 111 .RE
 112
 113 .sp
 114 .ne 2
 115 .na
 116 \fB\fB-a\fR \fIconfig_file\fR\fR
 117 .ad
 118 .sp .6
 119 .RS 4n
 120 Restore the specified \fIconfig_file\fR into the configuration. This option
 121 does not do any error checking of the file. Use of this option invalidates the
 122 configuration file.
 123 .RE
 124
 125 .sp
 126 .ne 2
 127 .na
 128 \fB\fB-l\fR\fR
 129 .ad
 130 .sp .6
 131 .RS 4n
 132 Lists the contents of current configuration database in a format that is
 133 suitable for the \fB-a\fR option. When used in combination with the \fB-s\fR
 134 option, it displays the contents stored in the location passed to the \fB-s\fR
 135 option, but does not set the configuration location.
 136 .RE
 137
 138 .sp
 139 .LP
 140 The options below are for Sun Cluster-configured systems only. \fIgroup\fR can
 141 be either Sun Cluster device group or as '-' as local devices.
 142 .sp
 143 .ne 2
 144 .na
 145 \fB\fB-C\fR \fIgroup\fR\fR
 146 .ad
 147 .sp .6
 148 .RS 4n
 149 Display the location of cluster configuration database.
 150 .RE
 151
 152 .sp
 153 .ne 2
 154 .na
 155 \fB\fB-C\fR\ \fIgroup\fR\ \fB-i\fR\fR
 156 .ad
 157 .sp .6
 158 .RS 4n
 159 Initializes the configuration database entries that only associated with group
 160 specified. As it deletes previous or current configuration information, this
 161 options prompts you to confirm the deletion before proceeding.
 162 .RE
 163
 164 .sp
 165 .ne 2
 166 .na
 167 \fB\fB-C\fR\ \fIgroup\fR\ \fB-p\fR\ \fIparser_config_file\fR\fR
 168 .ad
 169 .sp .6
 170 .RS 4n
 171 When used with the \fB-i\fR option, \fBdscfg\fR loads the parser configuration
 172 file into the persistent configuration, it reformats the configuration database
 173 entries that only associated with group specified.
 174 .RE
 175
 176 .sp
 177 .ne 2
 178 .na
 179 \fB\fB-C\fR \ \fIgroup\fR\ \fB-a\fR\ \fIconfig_file\fR\fR
 180 .ad
 181 .sp .6
 182 .RS 4n
 183 Restore the specified \fIconfig_file\fR into the configuration database entries
 184 that only associated with group specified.  This option does not do any error
 185 checking of the file. Use of this option invalidates the configuration file.
 186 .RE
 187
 188 .sp
 189 .ne 2
 190 .na
 191 \fB\fB-C\fR\ \fIgroup\fR\ \fB-l\fR\fR
 192 .ad
 193 .sp .6
 194 .RS 4n
 195 Lists the contents of current configuration database that is associated with
 196 resource group specified.
 197 .RE
 198
 199 .sp
 200 .ne 2
 201 .na
 202 \fB\fB-C\fR \ \fIgroup\fR\ \fB-s\fR\ \fIconfig_file_location\fR\fR
 203 .ad
 204 .sp .6
 205 .RS 4n
 206 Specifies where the Sun Cluster configuration database resides, the location
 207 has to be DID device.
 208 .RE
 209
 210 .sp
 211 .ne 2
 212 .na
 213 \fB\fB-D\fR \fIdevice_group\fR\fR
 214 .ad
 215 .sp .6
 216 .RS 4n
 217 Checks whether the specified \fIdevice_group\fR is known by Sun Cluster and
 218 whether it is available on this node. It displays a information that indicates
 219 the device group's status and return values are as follows,
 220 .sp
 221 (use echo $? to retrieve the return value):
 222 .sp
 223 .ne 2
 224 .na
 225 \fB\fB1\fR\fR
 226 .ad
 227 .RS 13n
 228 Device group is in Sun Cluster and is active on this node;
 229 .RE
 230
 231 .sp
 232 .ne 2
 233 .na
 234 \fB\fB0\fR\fR
 235 .ad
 236 .RS 13n
 237 Device group is in Sun Cluster but active on another node;
 238 .RE
 239
 240 .sp
 241 .ne 2
 242 .na
 243 \fB\fB-1\fR\fR
 244 .ad
 245 .RS 13n
 246 Device group is not in Sun Cluster.
 247 .RE
 248
 249 .RE
 250
 251 .SH USAGE
 252 .sp
 253 .LP
 254 The \fBdscfg\fR command is typically run from other scripts, such as package
 255 installation scripts, and from \fBdscfgadm\fR(1M). It is not intended for
 256 general use. For uses of \fBdscfg\fR not covered by \fBdscfgadm\fR, please
 257 refer to the \fIAvailability Suite Troubleshooting Guide\fR.
 258 .SH FILES
 259 .sp
 260 .ne 2
 261 .na
 262 \fB\fB/etc/dscfg_format\fR\fR
 263 .ad
 264 .sp .6
 265 .RS 4n
 266 parser configuration file
 267 .RE
 268
 269 .sp
 270 .ne 2
 271 .na
 272 \fB\fB/etc/dscfg_local\fR\fR
 273 .ad
 274 .sp .6
 275 .RS 4n
 276 configuration location for all entries with no cluster tags
 277 .RE
 278
 279 .sp
 280 .ne 2
 281 .na
 282 \fB\fB/etc/dscfg_cluster\fR\fR
 283 .ad
 284 .sp .6
 285 .RS 4n
 286 reference file specifying the location of the Sun Cluster configuration
 287 database.
 288 .RE
 289
 290 .SH ATTRIBUTES
 291 .sp
 292 .LP
 293 See \fBattributes\fR(5) for descriptions of the following attributes:
 294 .sp
 295
 296 .sp
 297 .TS
 298 box;
 299 c | c
 300 l | l .
 301 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 302 _
 303 Interface Stability     Evolving
 304 .TE
 305
 306 .SH SEE ALSO
 307 .sp
 308 .LP
 309 \fBdscfgadm\fR(1M), \fBiiadm\fR(1M), \fBscmadm\fR(1M), \fBsndradm\fR(1M),
 310 \fBsvadm\fR(1M), \fBds.log\fR(4), \fBattributes\fR(5)