share/man/man8/poolbind.8

   1 '\" te
   2 .\" Copyright (c) 2003, 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 POOLBIND 8 "Feb 9, 2005"
   7 .SH NAME
   8 poolbind \- bind processes, tasks, or projects or query binding of processes to
   9 resource pools
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fB/usr/sbin/poolbind\fR \fB-p\fR \fIpoolname\fR \fB-e\fR \fIcommand\fR [\fIarguments\fR]...
  14 .fi
  15
  16 .LP
  17 .nf
  18 \fB/usr/sbin/poolbind\fR \fB-p\fR \fIpoolname\fR [\fB-i\fR \fIidtype\fR] \fIid\fR...
  19 .fi
  20
  21 .LP
  22 .nf
  23 \fB/usr/sbin/poolbind\fR \fB-q\fR \fIpid\fR...
  24 .fi
  25
  26 .LP
  27 .nf
  28 \fB/usr/sbin/poolbind\fR \fB-Q\fR \fIpid\fR...
  29 .fi
  30
  31 .SH DESCRIPTION
  32 .sp
  33 .LP
  34 The \fBpoolbind\fR command allows an authorized user to bind zones, projects,
  35 tasks, and processes to pools. With the \fB-e\fR option (see below), it can
  36 execute a command you specify, placing the executed command in a specified
  37 pool. It can also enable you to query a process to determine which pool a
  38 process is bound to.
  39 .SH OPTIONS
  40 .sp
  41 .LP
  42 The following options are supported:
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fB-e\fR \fIcommand\fR [\fIarguments\fR...]\fR
  47 .ad
  48 .RS 29n
  49 Executes \fIcommand\fR, bound to the pool you specify with \fB-p\fR.
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fB-i\fR \fIidtype\fR\fR
  56 .ad
  57 .RS 29n
  58 This option, together with the \fIidlist\fR arguments, specifies one or more
  59 processes to which the poolbind command is to apply. The interpretation of
  60 \fIidlist\fR depends on the value of \fIidtype\fR. The valid \fIidtype\fR
  61 arguments and corresponding interpretations of \fIidlist\fR are as follows:
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fIpid\fR\fR
  66 .ad
  67 .RS 10n
  68 \fIidlist\fR is a list of process \fBID\fRs. Binds the specified processes to
  69 the specified pool. This is the default behavior if no idtype is specified.
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fItaskid\fR\fR
  76 .ad
  77 .RS 10n
  78 \fIidlist\fR is a list of task IDs. Bind all processes within the list of task
  79 IDs to the specified pool.
  80 .RE
  81
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fIprojid\fR\fR
  86 .ad
  87 .RS 10n
  88 \fIidlist\fR is a list of project \fBID\fRs. Bind all processes within the list
  89 of projects to the specified pool. Each project \fBID\fR can be specified as
  90 either a project name or a numerical project \fBID\fR. See \fBproject\fR(4).
  91 .RE
  92
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fIzoneid\fR\fR
  97 .ad
  98 .RS 10n
  99 \fIidlist\fR is a list of zone \fBID\fRs. Bind all processes within the list of
 100 zones to the specified pool. Each zone \fBID\fR can be specified as either a
 101 zone name or a numerical zone \fBID\fR. See \fBzones\fR(5).
 102 .RE
 103
 104 .RE
 105
 106 .sp
 107 .ne 2
 108 .na
 109 \fB\fB-p\fR \fIpoolname\fR\fR
 110 .ad
 111 .RS 29n
 112 Specifies the name of a pool to which the specified zone, project, tasks, or
 113 processes are to be bound.
 114 .RE
 115
 116 .sp
 117 .ne 2
 118 .na
 119 \fB\fB-q\fR \fIpid\fR ...\fR
 120 .ad
 121 .RS 29n
 122 Queries the pool bindings for a given list of process \fBID\fRs. If the
 123 collection of resources associated with the process does not correspond to any
 124 currently existing pool, or if there are multiple pools with the set of
 125 resources that the process is bound to, the query fails for that particular
 126 process \fBID\fR.
 127 .RE
 128
 129 .sp
 130 .ne 2
 131 .na
 132 \fB\fB-Q\fR \fIpid\fR ...\fR
 133 .ad
 134 .RS 29n
 135  Queries the resource bindings for a given list of process IDs. The resource
 136 bindings are each reported on a separate line.
 137 .RE
 138
 139 .SH EXAMPLES
 140 .LP
 141 \fBExample 1 \fRBinding All Processes
 142 .sp
 143 .LP
 144 The following command binds all processes in projects \fB5\fR and \fB7\fR to
 145 the pool \fBweb_app\fR:
 146
 147 .sp
 148 .in +2
 149 .nf
 150 example# /usr/sbin/poolbind \fB-p\fR web_app \fB-i\fR projid 5 7
 151 .fi
 152 .in -2
 153 .sp
 154
 155 .LP
 156 \fBExample 2 \fRBinding the Running Shell
 157 .sp
 158 .LP
 159 The following command binds the running shell to the pool \fBweb_app\fR:
 160
 161 .sp
 162 .in +2
 163 .nf
 164  example# /usr/sbin/poolbind \fB-p\fR web_app $$
 165 .fi
 166 .in -2
 167 .sp
 168
 169 .LP
 170 \fBExample 3 \fRQuerying the Pool Bindings
 171 .sp
 172 .LP
 173 The following command queries the bindings to verify that the shell is bound to
 174 the given pool:
 175
 176 .sp
 177 .in +2
 178 .nf
 179 example# /usr/sbin/poolbind \fB-q\fR $$
 180 .fi
 181 .in -2
 182 .sp
 183
 184 .LP
 185 \fBExample 4 \fRQuerying the Resource Bindings
 186 .sp
 187 .LP
 188 The following command queries the bindings to verify that the shell is bound to
 189 the given resources:
 190
 191 .sp
 192 .in +2
 193 .nf
 194 example# /usr/sbin/poolbind \fB-Q\fR $$
 195 .fi
 196 .in -2
 197 .sp
 198
 199 .SH EXIT STATUS
 200 .sp
 201 .LP
 202 The following exit values are returned:
 203 .sp
 204 .ne 2
 205 .na
 206 \fB\fB0\fR\fR
 207 .ad
 208 .RS 5n
 209 Successful completion.
 210 .RE
 211
 212 .sp
 213 .ne 2
 214 .na
 215 \fB\fB1\fR\fR
 216 .ad
 217 .RS 5n
 218 Requested operation could not be completed.
 219 .RE
 220
 221 .sp
 222 .ne 2
 223 .na
 224 \fB\fB2\fR\fR
 225 .ad
 226 .RS 5n
 227 Invalid command line options were specified.
 228 .RE
 229
 230 .SH ATTRIBUTES
 231 .sp
 232 .LP
 233 See \fBattributes\fR(5) for descriptions of the following attributes:
 234 .sp
 235
 236 .sp
 237 .TS
 238 box;
 239 c | c
 240 l | l .
 241 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 242 _
 243 Interface Stability      See below.
 244 .TE
 245
 246 .sp
 247 .LP
 248 The invocation is Evolving. The output is Unstable.
 249 .SH SEE ALSO
 250 .sp
 251 .LP
 252 \fBpooladm\fR(8), \fBpoolcfg\fR(8), \fBlibpool\fR(3LIB), \fBproject\fR(4),
 253 \fBattributes\fR(5), \fBzones\fR(5)
 254 .sp
 255 .LP
 256 \fI\fR