293 useradd/del/mod should be ZFS-aware
[illumos-gate.git] / usr / src / man / man1m / poold.1m
blob0fdee07ddd3889177f02268cbeb5f001a1de3b2f
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 POOLD 1M "Dec 1, 2005"
7 .SH NAME
8 poold \- automated resource pools partitioning daemon
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBpoold\fR [\fB-l\fR \fIlevel\fR]
13 .fi
15 .SH DESCRIPTION
16 .sp
17 .LP
18 \fBpoold\fR provides automated resource partitioning facilities. \fBpoold\fR
19 can be enabled or disabled using the Solaris Service Management Facility,
20 \fBsmf\fR(5). \fBpoold\fR requires the Resource Pools facility to be active in
21 order to operate.
22 .sp
23 .LP
24 The dynamic resource pools service's fault management resource identifier
25 (FMRI) is:
26 .sp
27 .in +2
28 .nf
29 svc:/system/pools/dynamic
30 .fi
31 .in -2
33 .sp
34 .LP
35 The resource pools service's FMRI is:
36 .sp
37 .in +2
38 .nf
39 svc:/system/pools
40 .fi
41 .in -2
43 .sp
44 .LP
45 \fBpoold\fR's configuration details are held in a \fBlibpool\fR(3LIB)
46 configuration and you can access all customizable behavior from this
47 configuration.
48 .sp
49 .LP
50 \fBpoold\fR periodically examines the load on the system and decides whether
51 intervention is required to maintain optimal system performance with respect to
52 resource consumption. \fBpoold\fR also responds to externally initiated (with
53 respect to \fBpoold\fR) changes of either resource configuration or objectives.
54 .sp
55 .LP
56 If intervention is required, \fBpoold\fR attempts to reallocate the available
57 resources to ensure that performance objectives are satisfied. If it is not
58 possible for \fBpoold\fR to meet performance objectives with the available
59 resources, then a message is written to the log. \fBpoold\fR allocates scarce
60 resources according to the objectives configured by the administrator. The
61 system administrator must determine which resource pools are most deserving of
62 scarce resource and indicate this through the importance of resource pools and
63 objectives.
64 .SH OPTIONS
65 .sp
66 .LP
67 The following options are supported:
68 .sp
69 .ne 2
70 .na
71 \fB\fB-l\fR \fIlevel\fR\fR
72 .ad
73 .RS 12n
74 Specify the vebosity level for logging information.
75 .sp
76 Specify \fIlevel\fR as \fBALERT\fR, \fBCRIT\fR, \fBERR\fR, \fBWARNING\fR,
77 \fBNOTICE\fR, \fBINFO\fR, and \fBDEBUG\fR. If \fIlevel\fR is not supplied, then
78 the default logging level is \fBINFO\fR.
79 .sp
80 .ne 2
81 .na
82 \fB\fBALERT\fR\fR
83 .ad
84 .RS 11n
85  A condition that should be corrected immediately, such as a corrupted system
86 database.
87 .RE
89 .sp
90 .ne 2
91 .na
92 \fB\fBCRIT\fR\fR
93 .ad
94 .RS 11n
95 Critical conditions, such as hard device errors.
96 .RE
98 .sp
99 .ne 2
101 \fB\fBERR\fR\fR
103 .RS 11n
104 Errors.
108 .ne 2
110 \fB\fBWARNING\fR\fR
112 .RS 11n
113 Warning messages.
117 .ne 2
119 \fB\fBNOTICE\fR\fR
121 .RS 11n
122  Conditions that are not error conditions, but that may require special
123 handling.
127 .ne 2
129 \fB\fBINFO\fR\fR
131 .RS 11n
132 Informational messages.
136 .ne 2
138 \fB\fBDEBUG\fR\fR
140 .RS 11n
141 Messages that contain information normally of use only when debugging a
142 program.
149 When invoked manually, with the \fB-l\fR option, all log output is directed to
150 standard error.
151 .SH EXAMPLES
153 \fBExample 1 \fRModifying the Default Logging Level
156 The following command modifies the default logging level to \fBERR\fR:
159 .in +2
161 # /usr/lib/pool/poold -l ERR
163 .in -2
167 \fBExample 2 \fREnabling Dynamic Resource Pools
170 The following command enables dynamic resource pools:
173 .in +2
175 # /usr/sbin/svcadm enable svc:/system/pools/dynamic
177 .in -2
180 .SH ATTRIBUTES
183 See \fBattributes\fR(5) for descriptions of the following attributes:
188 box;
189 c | c
190 l | l .
191 ATTRIBUTE TYPE  ATTRIBUTE VALUE
193 Interface Stability     See below.
198 The invocation is Evolving. The output is Unstable.
199 .SH SEE ALSO
202 \fBpooladm\fR(1M), \fBpoolbind\fR(1M), \fBpoolcfg\fR(1M), \fBpoolstat\fR(1M),
203 \fBsvcadm\fR(1M), \fBpool_set_status\fR(3POOL), \fBlibpool\fR(3LIB),
204 \fBattributes\fR(5), \fBsmf\fR(5)
207 \fI\fR