Sun Microsystems, Inc.
spacerspacer
spacer   www.sun.com docs.sun.com | | |  
spacer
black dot
   
A   B   C   D   E   F   G   H   I   J   K   L   M   N   O   P   Q   R   S   T   U   V   W   X   Y   Z
    
 
System Administration Commandspoolcfg(1M)


NAME

 poolcfg - create and modify resource pool configuration files

SYNOPSIS

 /usr/sbin/poolcfg -c command filename
 /usr/sbin/poolcfg -f command_file filename
 /usr/sbin/poolcfg -h

DESCRIPTION

 

The poolcfg command provides configuration operations on pools and sets. These operations are performed upon an existing configuration and take the form of modifications to the specified configuration file. The special discover command does not require an existing configuration. Actual activation of the resulting configuration is achieved by way of the pooladm(1M) command.

Pools configuration files are structured files that must have been constructed using poolcfg itself or libpool(3LIB) directly.

The configurations which are created by this tool may be used by pooladm to instantiate the configuration upon a target host.

OPTIONS

 

The following options are supported:

-c command
Specify command as an editing command. See USAGE.
-f command_file
Take the commands from command_file. command_file consists of editing commands, one per line.
-h
Display extended information about the syntax of editing commands.

USAGE

 

Scripts

 

A script consists of editing commands, one per line, of the following:

info [entity-name]
Display configuration (or specified portion) in human readable form to standard output. If no entity is specified, system information is displayed. Therefore, poolcfg -c 'info' afile is an equivalent invocation to poolcfg -c 'info system name' afile.
create entity-name [property-list]
Make an entity of the specified type and name.
destroy entity-name
Remove the specified entity.
modify entity-name [property-list]
Change the listed properties on the named entity.
associate pool-name [resource-list]
Connect one or more resources to a pool, or replace one or more existing connections.
discover
Create a system entity, with one pool entity and resources to match current system configuration. All discovered resources of each resource type are recorded in the file, with the single pool referring to the default resource for each resource type.
rename entity-name to new-name
Change the name of an entity on the system to its new name.

Property Lists

 

The property list is specified by:

 
( proptype name = value [ ; proptype name = value ]* )

where the last definition in the sequence for a given proptype, name pair is the one that holds. For property deletion, use ~ proptype name.

Resource Lists

 

A resource list is specified by

 
( resourcetype name [ ; resourcetype name ]* )

where the last specification in the sequence for a resource is the one that holds. There is no deletion syntax for resource lists.

Recognized Entities

 
system
Machine level entity
pool
Named collection of resource associations

Resource Types

 
pset
Processor set resource

Property Types

 
boolean
Takes one of two values true or false.
int
A 64-bit signed integer value.
uint
A 64-bit unsigned integer value.
string
Strings are delimited by quotes ("), and support the character escape sequences defined in formats(5).
float
Scientific notation is not supported.

EXAMPLES

 Example 1. Creating an Initial Configuration File
 

The following command creates an initial configuration file for this host. By not supplying a file name, /etc/pooladm.conf is assumed.

 
$ poolcfg -c discover
Example 2. Creating an Initial Configuration File
 

The following command creates an initial configuration file for this host and writes it to /home/admin/new_config:

 
$ poolcfg -c discover /home/admin/new_config
Example 3. Writing a poolcfg Script
 

The following poolcfg script creates a pool named Accounting, and a processor set, small-1. The processor set is created first, then the pool is created and associated with the set.

 

create pset small-1 ( int pset.size = 4 )
create pool Accounting
associate pool Accounting ( pset small-1 )

Example 4. Reporting on pool_0
 

The following command reports on pool_0 to standard output in human readable form:

 
# poolcfg -c 'info pool pool_0' /etc/pooladm.conf
Example 5. Destroying pool_0 and Its Associations
 

The following command destroys pool_0 and associations, but not the formerly associated resources:

 
# poolcfg -c 'destroy pool pool_0' /etc/pooladm.conf
Example 6. Displaying the Current Configuration
 

The following command displays the current configuration:

 
$ poolcfg -c 'info' /etc/pooladm.conf

system muskoka
          int system.version 1
          boolean system.bind-default true
          string system.comment Discovered by libpool
     
          pool pool_default
               boolean pool.default true
               boolean pool.active true
               int pool.importance 5
               string pool.comment
               string.pool.scheduler FSS
               pset pset_default
    
          pset pset_default
               int pset.sys_id -1
               string pset.units population
               boolean pset.default true
               uint pset.max 4294967295
               uint pset.min 1
               string pset.comment 
               boolean pset.escapable false
               uint pset.load 0
               uint pset.size 2
     
               cpu
                    int cpu.sys_id 0
                    string cpu.comment 
     
               cpu
                    int cpu.sys_id 2
                    string cpu.comment 
    

ATTRIBUTES

 

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPEATTRIBUTE VALUE
AvailabilitySUNWpool
Interface Stability Invocation Output Evolving Unstable

SEE ALSO

 

pooladm(1M), poolbind(1M), libpool(3LIB), attributes(5), formats(5)

System Administration Guide: Resource Management and Network Services


SunOS 5.9Go To TopLast Changed 3 Jan 2002

 
      
      
Copyright 2002 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.