
Administration Commands;                  ping-connection-pool(1)

NAME
     ping-connection-pool - tests if a connection pool is usable

SYNOPSIS
     ping-connection-pool
     [--terse={true|false}][ --echo={true|false} ]
     [ --interactive={true|false} ] [ --host  host]
     [--port port] [--secure| -s ] [ --user  admin_user]
     [--passwordfile filename] [--help]
     pool_name

DESCRIPTION
     This command tests if a connection pool is usable  for  both
     JDBC  connection  pools  and connector connection pools. For
     example, if you create a new JDBC  connection  pool  for  an
     application  that is expected to be deployed later, the JDBC
     pool is tested with this command before deploying the appli-
     cation.

     A JDBC connection pool or a connector connection  pool  with
     authentication  can  be  created. You can either use a -pro-
     perty option to specify user, password, or other  connection
     information  using  the command line, or specify the connec-
     tion information in the xml descriptor file.

     Before pinging a connection pool, you must create  the  con-
     nection  pool with authentication and ensure that the enter-
     prise server or database is started.

     This command is supported in remote mode only.

OPTIONS
     -t --terse

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

     -e --echo
         If set to true, the command-line statement is echoed  on
         the standard output. Default is false.

     -I --interactive

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

Java EE 5           Last change: 11 Apr 2008                    1

Administration Commands;                  ping-connection-pool(1)

     -H --host

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

     -p --port
         The HTTP port or HTTPS  port  for  administration.  This
         port is the port in the URL that you specify in your web
         browser   to   manage   the   domain,    for    example,
         http://localhost:4848.

         The default port number for administration is 4848.

     -s --secure

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

         The default is false.

     -u --user
         The user name of the authorized administrative  user  of
         the domain administration server.

         If you have authenticated to a domain by using the asad-
         min  login  command,  you  need  not  specify the --user
         option for subsequent operations on the domain.

     --passwordfile

         Specifies the name, including the full path, of  a  file
         that contains the password entries in a specific format.

         The entry for a password must have the AS_ADMIN_  prefix
         followed  by the password name in uppercase letters. For
         example, to specify the password for the domain adminis-
         tration server, use an entry with the following format:

           AS_ADMIN_PASSWORD=password

         In this example, password is  the  actual  administrator
         password.

         The following other passwords can also be specified:

             o    AS_ADMIN_MAPPEDPASSWORD

             o    AS_ADMIN_USERPASSWORD

Java EE 5           Last change: 11 Apr 2008                    2

Administration Commands;                  ping-connection-pool(1)

             o    AS_ADMIN_ALIASPASSWORD
         All remote  commands  must  specify  the  administration
         password  to  authenticate  to the domain administration
         server. The password can be specified by one of the fol-
         lowing means:

             o    Through the --passwordfile option

             o    Through the asadmin login command

             o    Interactively at the command prompt
         The asadmin login command can be used  only  to  specify
         the  administration  password.  For other passwords that
         remote commands require, use the  --passwordfile  option
         or specify them at the command prompt.

         After authenticating to a domain by  using  the  asadmin
         login  command,  you need not specify the administration
         password through the --passwordfile  option  for  subse-
         quent  operations  on  the  domain.  However,  only  the
         AS_ADMIN_PASSWORD option is not required. You still must
         provide    the    other    passwords,    for    example,
         AS_ADMIN_USERPASSWORD, when required by individual  com-
         mands, such as update-file-user.

         For security reasons, a password that is specified as an
         environment variable is not read by the asadmin command.

         The  default  value   for   AS_ADMIN_MASTERPASSWORD   is
         changeit.

     --help

         Displays the help text for the command.

     --target
         This option is deprecated.

OPERANDS
     pool_name                   This is the name of the pool  to
                                 test.

EXAMPLES
     Example 1 Using the ping-connection-pool command

       asadmin> ping-connection-pool --user admin1 --passwordfile pwordfile
       Command ping-connection-pool executed successfully

Java EE 5           Last change: 11 Apr 2008                    3

Administration Commands;                  ping-connection-pool(1)

     Where: asadmin is the command prompt  and  sampleConnection-
     Pool is the name of the connection pool to ping.

EXIT STATUS
     0                           command executed successfully

     1                           error in executing the command

Java EE 5           Last change: 11 Apr 2008                    4

