share/man/man8/pooladm.8

   1 '\" te
   2 .\" Copyright (c) 2005, 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 POOLADM 8 "Dec 1, 2005"
   7 .SH NAME
   8 pooladm \- activate and deactivate the resource pools facility
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/sbin/pooladm\fR [\fB-n\fR] [\fB-s\fR] [\fB-c\fR] [\fIfilename\fR] | \fB-x\fR
  13 .fi
  14
  15 .LP
  16 .nf
  17 \fB/usr/sbin/pooladm\fR [\fB-d\fR | \fB-e\fR]
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 The \fBpooladm\fR command provides administrative operations on pools and sets.
  24 \fBpooladm\fR reads the specified filename and attempts to activate the pool
  25 configuration contained in it.
  26 .sp
  27 .LP
  28 Before updating the current pool run-time configuration, \fBpooladm\fR
  29 validates the configuration for correctness.
  30 .sp
  31 .LP
  32 Without options, \fBpooladm\fR prints out the current running pools
  33 configuration.
  34 .SH OPTIONS
  35 .sp
  36 .LP
  37 The following options are supported:
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fB-c\fR\fR
  42 .ad
  43 .RS 6n
  44 Instantiate the configuration at the given location. If a filename is not
  45 specified, it defaults to \fB/etc/pooladm.conf\fR.
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fB-d\fR\fR
  52 .ad
  53 .RS 6n
  54 Disable the pools facility so that pools can no longer be manipulated.
  55 .RE
  56
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fB-e\fR\fR
  61 .ad
  62 .RS 6n
  63 Enable the pools facility so that pools can be manipulated.
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fB-n\fR\fR
  70 .ad
  71 .RS 6n
  72 Validate the configuration without actually updating the current active
  73 configuration. Checks that there are no syntactic errors and that the
  74 configuration can be instantiated on the current system. No validation of
  75 application specific properties is performed.
  76 .RE
  77
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fB-s\fR\fR
  82 .ad
  83 .RS 6n
  84 Update the specified location with the details of the current dynamic
  85 configuration.
  86 .sp
  87 This option requires update permission for the configuration that you are going
  88 to update. If you use this option with the \fB-c\fR option, the dynamic
  89 configuration is updated before the static location.
  90 .RE
  91
  92 .sp
  93 .ne 2
  94 .na
  95 \fB\fB-x\fR\fR
  96 .ad
  97 .RS 6n
  98 Remove the currently active pool configuration. Destroy all defined resources,
  99 and return all formerly partitioned components to their default resources.
 100 .RE
 101
 102 .SH OPERANDS
 103 .sp
 104 .LP
 105 The following operands are supported:
 106 .sp
 107 .ne 2
 108 .na
 109 \fB\fIfilename\fR\fR
 110 .ad
 111 .RS 12n
 112 Use the configuration contained within this file.
 113 .RE
 114
 115 .SH EXAMPLES
 116 .LP
 117 \fBExample 1 \fRInstantiating a Configuration
 118 .sp
 119 .LP
 120 The following command instantiates the configuration contained at
 121 \fB/home/admin/newconfig\fR:
 122
 123 .sp
 124 .in +2
 125 .nf
 126 example# \fB/usr/sbin/pooladm \fR\fB-c\fR\fB /home/admin/newconfig\fR
 127 .fi
 128 .in -2
 129 .sp
 130
 131 .LP
 132 \fBExample 2 \fRValidating the Configuration Without Instantiating It
 133 .sp
 134 .LP
 135 The following command attempts to instantiate the configuration contained at
 136 \fB/home/admin/newconfig\fR. It displays any error conditions that it
 137 encounters, but does not actually modify the active configuration.
 138
 139 .sp
 140 .in +2
 141 .nf
 142 example# \fB/usr/sbin/pooladm \fR\fB-n\fR\fB \fR\fB-c\fR\fB /home/admin/newconfig\fR
 143 .fi
 144 .in -2
 145 .sp
 146
 147 .LP
 148 \fBExample 3 \fRRemoving the Current Configuration
 149 .sp
 150 .LP
 151 The following command removes the current pool configuration:
 152
 153 .sp
 154 .in +2
 155 .nf
 156 example# \fB/usr/sbin/pooladm \fR\fB-x\fR
 157 .fi
 158 .in -2
 159 .sp
 160
 161 .LP
 162 \fBExample 4 \fREnabling the Pools Facility
 163 .sp
 164 .LP
 165 The following command enables the pool facility:
 166
 167 .sp
 168 .in +2
 169 .nf
 170 example# \fB/usr/sbin/pooladm -e\fR
 171 .fi
 172 .in -2
 173 .sp
 174
 175 .LP
 176 \fBExample 5 \fREnabling the Pools Facility Using SMF
 177 .sp
 178 .LP
 179 The following command enables the pool facility through use of the Service
 180 Management Facility. See \fBsmf\fR(5).
 181
 182 .sp
 183 .in +2
 184 .nf
 185 example# \fB/usr/sbin/svcadm enable svc:/system/pools:default\fR
 186 .fi
 187 .in -2
 188 .sp
 189
 190 .LP
 191 \fBExample 6 \fRSaving the Active Configuration to a Specified Location
 192 .sp
 193 .LP
 194 The following command saves the active configuration to
 195 \fB/tmp/state.backup\fR:
 196
 197 .sp
 198 .in +2
 199 .nf
 200 example# \fB/usr/sbin/pooladm -s /tmp/state.backup\fR
 201 .fi
 202 .in -2
 203 .sp
 204
 205 .SH FILES
 206 .sp
 207 .ne 2
 208 .na
 209 \fB\fB/etc/pooladm.conf\fR\fR
 210 .ad
 211 .RS 21n
 212 Configuration file for \fBpooladm\fR.
 213 .RE
 214
 215 .SH ATTRIBUTES
 216 .sp
 217 .LP
 218 See \fBattributes\fR(5) for descriptions of the following attributes:
 219 .sp
 220
 221 .sp
 222 .TS
 223 box;
 224 c | c
 225 l | l .
 226 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 227 _
 228 Interface Stability     See below.
 229 .TE
 230
 231 .sp
 232 .LP
 233 The invocation is Evolving. The output is Unstable.
 234 .SH SEE ALSO
 235 .sp
 236 .LP
 237 \fBpoolcfg\fR(8), \fBpoolbind\fR(8), \fBpsrset\fR(8), \fBsvcadm\fR(8),
 238 \fBpset_destroy\fR(2), \fBlibpool\fR(3LIB), \fBattributes\fR(5), \fBsmf\fR(5)
 239 .sp
 240 .LP
 241 \fI\fR
 242 .SH NOTES
 243 .sp
 244 .LP
 245 Resource bindings that are not presented in the form of a binding to a
 246 partitionable resource, such as the scheduling class, are not necessarily
 247 modified in a \fBpooladm\fR \fB-x\fR operation.
 248 .sp
 249 .LP
 250 The pools facility is not active by default when Solaris starts. \fBpooladm\fR
 251 \fB-e\fR explicitly activates the pools facility. The behavior of certain APIs
 252 related to processor partitioning and process binding are modified when pools
 253 is active. See \fBlibpool\fR(3LIB).
 254 .sp
 255 .LP
 256 You cannot enable the pools facility on a system where processor sets have been
 257 created. Use the \fBpsrset\fR(8) command or \fBpset_destroy\fR(2) to destroy
 258 processor sets manually before you enable the pools facility.
 259 .sp
 260 .LP
 261 Because the Resource Pools facility is an \fBsmf\fR(5) service, it can also be
 262 enabled and disabled using the standard SMF interfaces.