
Administration Commands                      create-threadpool(1)

NAME
     create-threadpool - adds a threadpool

SYNOPSIS
     create-threadpool
     [--terse={true|false}][ --echo={true|false} ]
     [ --interactive={true|false} ] [ --host  host]
     [--port port] [--secure| -s ] [ --user  admin_user]
     [--passwordfile filename] [--help]
     [ --target  target_name]
     [--maxthreadpoolsize max_thread_pool_size]
     [--minthreadpoolsize min_thread_pool_size]
     [--idletimeout idle_thread_timeout_in_seconds]
     [--workqueues number_work_queues] threadpool_id

DESCRIPTION
     The create-threadpool command creates a threadpool with  the
     specified  name.  You can specify maximum and minimum number
     of threads in the pool, the number of work queues,  and  the
     idle  timeout  of  a thread.  The created thread pool can be
     used for servicing IIOP requests and for  resource  adapters
     to  service  work  management  requests.  Please note that a
     created  thread  pool  can  be  used  in  multiple  resource
     adapters. This command is supported in remote mode only.

OPTIONS
     -t --terse                  Indicates that any  output  data
                                 must  be very concise, typically
                                 avoiding   human-friendly   sen-
                                 tences    and   favoring   well-
                                 formatted data  for  consumption
                                 by a script. Default is false.

     -e --echo                   Setting to true  will  echo  the
                                 command  line  statement  on the
                                 standard  output.   Default   is
                                 false.

     -I --interactive            If set to true  (default),  only
                                 the  required  password  options
                                 are prompted.

     -H --host                   The  machine  name   where   the
                                 domain  administration server is
                                 running. The  default  value  is
                                 localhost.

Java EE 5           Last change: 30 Jan 2007                    1

Administration Commands                      create-threadpool(1)

     -p --port                   The HTTP/S port for  administra-
                                 tion.  This is the port to which
                                 you should point your browser in
                                 order  to manage the domain. For
                                 example, http://localhost:4848.

                                 The default port number is 4848.

     -s --secure                 If set to true, uses SSL/TLS  to
                                 communicate   with   the  domain
                                 administration server.

     -u --user                   The authorized  domain  adminis-
                                 tration   server  administrative
                                 username.

                                 If you have authenticated  to  a
                                 domain  using  the asadmin login
                                 command,  then  you   need   not
                                 specify  the  --user  option  on
                                 subsequent  operations  to  this
                                 particular domain.

     --passwordfile              The --passwordfile option speci-
                                 fies  the  name,  including  the
                                 full path, of a file  containing
                                 the   password   entries   in  a
                                 specific format. The  entry  for
                                 the   password   must  have  the
                                 AS_ADMIN_ prefix followed by the
                                 password   name   in   uppercase
                                 letters.

                                 For  example,  to  specify   the
                                 domain   administration   server
                                 password, use an entry with  the
                                 following                format:
                                 AS_ADMIN_PASSWORD=password,
                                 where  password  is  the  actual
                                 administrator  password.   Other
                                 passwords  that can be specified
                                 include AS_ADMIN_MAPPEDPASSWORD,
                                 AS_ADMIN_USERPASSWORD,       and
                                 AS_ADMIN_ALIASPASSWORD.

                                 All remote commands must specify
                                 the  admin password to authenti-
                                 cate to the  domain  administra-
                                 tion  server,  either through --

Java EE 5           Last change: 30 Jan 2007                    2

Administration Commands                      create-threadpool(1)

                                 passwordfile or  asadmin  login,
                                 or  interactively on the command
                                 prompt. The asadmin  login  com-
                                 mand can be used only to specify
                                 the admin  password.  For  other
                                 passwords,  that  must be speci-
                                 fied for  remote  commands,  use
                                 the --passwordfile or enter them
                                 at the command prompt.

                                 If you have authenticated  to  a
                                 domain  using  the asadmin login
                                 command,  then  you   need   not
                                 specify   the   admin   password
                                 through    the    --passwordfile
                                 option  on subsequent operations
                                 to this particular domain.  How-
                                 ever, this is applicable only to
                                 AS_ADMIN_PASSWORD  option.   You
                                 will  still  need to provide the
                                 other  passwords,  for  example,
                                 AS_ADMIN_USERPASSWORD,   as  and
                                 when required by individual com-
                                 mands, such as update-file-user.

                                 For security reasons,  passwords
                                 specified   as   an  environment
                                 variable will  not  be  read  by
                                 asadmin.

                                 The    default     value     for
                                 AS_ADMIN_MASTERPASSWORD       is
                                 changeit.

     --help                      Displays the help text  for  the
                                 command.

     --target                    This option specifies the target
                                 on  which  you  are creating the
                                 threadpool. Valid values are

                                     o    server-  Specifies  the
                                          default server instance
                                          as   the   target   for
                                          creating   the  thread-
                                          pool.

                                     o    configuration_name-
                                          Specifies  a particular
                                          configuration  as   the

Java EE 5           Last change: 30 Jan 2007                    3

Administration Commands                      create-threadpool(1)

                                          target for creating the
                                          threadpool.

                                     o    cluster_name- Specifies
                                          a particular cluster as
                                          the target for creating
                                          the threadpool.

                                     o    instance_name-   Speci-
                                          fies    a    particular
                                          server instance as  the
                                          target for creating the
                                          threadpool.

     --maxthreadpoolsize         Maximum number of threads in the
                                 threadpool servicing requests in
                                 this queue. This  is  the  upper
                                 bound  on  the number of threads
                                 that exist in the threadpool.

     --minthreadpoolsize         Minimum number of threads in the
                                 threadpool servicing requests in
                                 this queue. These are created up
                                 front  when  the  threadpool  is
                                 instantiated.

     --idletimeout               Idle threads  are  removed  from
                                 the pool after this time.

     --workqueues                Identifies the total  number  of
                                 work  queues  serviced  by  this
                                 threadpool.

OPERANDS
     threadpool_id               an ID for the  work  queue;  for
                                 example,  thread-pool-1, thread-
                                 pool-2, etc.

EXAMPLES
     Example 1 Using create-threadpool Command

       asadmin> create-threadpool --user admin1
       --passwordfile password.txt --maxthreadpoolsize 100
       --minthreadpoolsize 20 --idletimeout 2 --workqueues 100 threadpool-1
       Command create-threadpool executed successfully

Java EE 5           Last change: 30 Jan 2007                    4

Administration Commands                      create-threadpool(1)

EXIT STATUS
     0                           command executed successfully

     1                           error in executing the command

SEE ALSO
     delete-threadpool(1), list-threadpools(1)

Java EE 5           Last change: 30 Jan 2007                    5

