poolcfg(1m) - osol9

1poolcfg(1M)             System Administration Commands             poolcfg(1M)
2
3
4

NAME

6       poolcfg - create and modify resource pool configuration files
7

SYNOPSIS

9       /usr/sbin/poolcfg -c command [-d | [filename]]
10
11
12       /usr/sbin/poolcfg -f command_file [-d | [filename]]
13
14
15       /usr/sbin/poolcfg -h
16
17

DESCRIPTION

19       The  poolcfg  utility  provides  configuration  operations on pools and
20       sets. These operations are performed upon an existing configuration and
21       take  the form of modifications to the specified configuration file. If
22       you use the -d option, the modifications occur  to  the  kernel  state.
23       Actual  activation of the resulting configuration is achieved by way of
24       the pooladm(1M) utility.
25
26
27       Pools configuration files are structured files that must have been con‐
28       structed using poolcfg itself or libpool(3LIB) directly.
29
30
31       An  invocation of poolcfg with the pool dynamic location and write per‐
32       mission will hang if the dynamic location has already been  opened  for
33       writing.
34
35
36       The  configurations  which  are  created by this utility can be used by
37       pooladm to instantiate the configuration upon a target host.
38

OPTIONS

40       The following options are supported:
41
42       -c command         Specify command as an editing command. See USAGE.
43
44
45       -d                 Operate directly on the kernel state. No filename is
46                          allowed.
47
48
49       -f command_file    Take  the  commands  from command_file. command_file
50                          consists of editing commands, one per line.
51
52
53       -h                 Display extended information  about  the  syntax  of
54                          editing commands.
55
56

USAGE

58   Scripts
59       A script consists of editing commands, one per line, of the following:
60
61       info [entity-name]
62
63           Display configuration (or specified portion) in human readable form
64           to standard output. If no entity is specified,  system  information
65           is  displayed.  Therefore, poolcfg -c 'info' afile is an equivalent
66           invocation to poolcfg -c 'info system name' afile.
67
68
69       create entity-name [property-list]
70
71           Make an entity of the specified type and name.
72
73
74       destroy entity-name
75
76           Remove the specified entity.
77
78
79       modify entity-name [property-list]
80
81           Change the listed properties on the named entity.
82
83
84       associate pool-name [resource-list]
85
86           Connect one or more resources to a pool, or  replace  one  or  more
87           existing connections.
88
89
90       transfer to [resourcetype] name[component-list]
91
92           Transfer one or more discrete components to a resource .
93
94
95       transfer [quantity] from [resourcetype] [src] to [tgt]
96
97           Transfer a resource quantity from src to tgt.
98
99
100       transfer [quantity] to [resourcetype] [tgt] from [src]
101
102           Transfer a resource quantity to tgt from src.
103
104
105       discover
106
107           Create a system entity, with one pool entity and resources to match
108           current system configuration.  All  discovered  resources  of  each
109           resource type are recorded in the file, with the single pool refer‐
110           ring to the default resource for each resource type.
111
112           This command is a NO-OP when poolcfg operates directly on the  ker‐
113           nel. See the -d option.
114
115           You should avoid use of this command. The preferred method for cre‐
116           ating a configuration is to export the dynamic configuration  using
117           pooladm(1M) with the -s option.
118
119
120       rename entity-name to new-name
121
122           Change the name of an entity on the system to its new name.
123
124
125   Property Lists
126       The property list is specified by:
127
128         ( proptype name = value [ ; proptype name = value ]* )
129
130
131
132       where  the  last  definition in the sequence for a given proptype, name
133       pair is the one that holds. For property deletion, use ~ proptype name.
134
135   Resource Lists
136       A resource list is specified by:
137
138         ( resourcetype name [ ; resourcetype name ]* )
139
140
141
142       where the last specification in the sequence for a resource is the  one
143       that holds. There is no deletion syntax for resource lists.
144
145   Component Lists
146       A component list is specified by:
147
148         ( componenttype name [ ; componenttype name ]* )
149
150
151
152       where the last specification in the sequence for a component is the one
153       that holds. There is no deletion syntax for component lists.
154
155   Recognized Entities
156       system    Machine level entity
157
158
159       pool      Named collection of resource associations
160
161
162   Resource Types
163       pset    Processor set resource
164
165
166   Property Types
167       boolean    Takes one of two values true or false.
168
169
170       int        A 64-bit signed integer value.
171
172
173       uint       A 64-bit unsigned integer value.
174
175
176       string     Strings are delimited by quotes ("), and support the charac‐
177                  ter escape sequences defined in formats(5).
178
179
180       float      Scientific notation is not supported.
181
182

EXAMPLES

184       Example 1 Writing a poolcfg Script
185
186
187       The  following  poolcfg  script  creates a pool named Accounting, and a
188       processor set, small-1. The processor set is created  first,  then  the
189       pool is created and associated with the set.
190
191
192         create pset small-1 ( uint pset.min = 1 ; uint pset.max = 4)
193         create pool Accounting
194         associate pool Accounting ( pset small-1 )
195
196
197       Example 2 Reporting on pool_0
198
199
200       The  following  command  reports  on pool_0 to standard output in human
201       readable form:
202
203
204          # poolcfg -c 'info pool pool_0' /etc/pooladm.conf
205
206
207
208       Example 3 Destroying pool_0 and Its Associations
209
210
211       The following command destroys pool_0 and  associations,  but  not  the
212       formerly associated resources:
213
214
215         # poolcfg -c 'destroy pool pool_0' /etc/pooladm.conf
216
217
218
219       Example 4 Displaying the Current Configuration
220
221
222       The following command displays the current configuration:
223
224
225         $ poolcfg -c 'info' /etc/pooladm.conf
226         system example_system
227                        int system.version 1
228                        boolean system.bind-default true
229                        string system.comment Discovered by libpool
230
231                        pool pool_default
232                             boolean pool.default true
233                             boolean pool.active true
234                             int pool.importance 5
235                             string pool.comment
236                             string.pool.scheduler FSS
237                             pset pset_default
238
239                        pset pset_default
240                             int pset.sys_id -1
241                             string pset.units population
242                             boolean pset.default true
243                             uint pset.max 4294967295
244                             uint pset.min 1
245                             string pset.comment
246                             boolean pset.escapable false
247                             uint pset.load 0
248                             uint pset.size 2
249
250                             cpu
251                                  int cpu.sys_id 0
252                                  string cpu.comment
253
254                             cpu
255                                  int cpu.sys_id 2
256                                  string cpu.comment
257
258
259
260       Example 5 Moving cpu with ID 2 to Processor Set pset1 in the Kernel
261
262
263       The following command moves cpu with ID 2 to processor set pset1 in the
264       kernel:
265
266
267         # poolcfg -dc 'transfer to pset pset1 ( cpu 2 )'
268
269
270
271       Example 6 Moving 2 cpus from Processor Set pset1 to Processor Set pset2
272       in the Kernel
273
274
275       The  following command moves 2 cpus from processor set pset1 to proces‐
276       sor set pset2 in the kernel:
277
278
279         # poolcfg -dc 'transfer 2 from pset pset1 to pset2'
280
281
282

ATTRIBUTES

284       See attributes(5) for descriptions of the following attributes:
285
286
287
288
289       ┌─────────────────────────────┬─────────────────────────────┐
290       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
291       ├─────────────────────────────┼─────────────────────────────┤
292       │Availability                 │SUNWpool                     │
293       ├─────────────────────────────┼─────────────────────────────┤
294       │Interface Stability          │See below.                   │
295       └─────────────────────────────┴─────────────────────────────┘
296
297
298       The invocation is Committed. The output is Uncommitted.
299