<!--Arbortext, Inc., 1988-2007, v.4002-->
<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD SolBook 3.5//EN" [
<!ENTITY options-common SYSTEM "options-common.sgm">
<!ENTITY synopsis-common SYSTEM "synopsis-common.sgm">
<!ENTITY % commonents SYSTEM "common.ent">
%commonents;
]>
<refentry id="ping-connection-pool-1">
<!-- @(#)ping-connection-pool.1 1.10 07/04/25 SMI; -->
<refmeta><refentrytitle>ping-connection-pool</refentrytitle><manvolnum>1
</manvolnum>
<refmiscinfo class="date">30 Jan 2007</refmiscinfo>
<refmiscinfo class="sectdesc">&man1
;</refmiscinfo>
<refmiscinfo class="software">&software;</refmiscinfo>
<refmiscinfo class="arch">generic</refmiscinfo>
<refmiscinfo class="copyright">Copyright (c) 2007, Sun Microsystems, Inc.
All Rights Reserved</refmiscinfo>

</refmeta>
<refnamediv><indexterm><primary>ping-connection-pool</primary></indexterm><indexterm><primary>tests that a connection pool
is usable</primary></indexterm><refname>ping-connection-pool
</refname><refpurpose>tests if a connection pool is usable </refpurpose></refnamediv>
<refsynopsisdiv><title></title>
<synopsis><command>ping-connection-pool</command> &synopsis-common; <replaceable>pool_name</replaceable></synopsis></refsynopsisdiv>
<refsect1 role="description"><title></title>
<para>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 application.
</para>
<para>A JDBC connection pool or a connector connection pool with authentication
can be created. You can either use a <option>property</option> option to specify user,
password, or other connection information using the command line, or specify
the connection information in the xml descriptor file.</para>
<para>Before pinging a connection pool, you must create the connection pool
with authentication and ensure that the enterprise server or database is started.
</para>
</refsect1>
<refsect1 role="options"><title></title>
<variablelist termlength="medium">&options-common;
<varlistentry><term><option role="double-dash">target</option></term>
<listitem><para>This option is deprecated.</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1 role="operands"><title></title>
<variablelist termlength="medium">
<varlistentry><term><replaceable>pool_name</replaceable></term><listitem>
<para>This is the name of the pool to test.</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1 role="examples"><title></title>
<example>
<title>Using the ping-connection-pool command</title>
<screen>asadmin> <userinput>ping-connection-pool --user admin1 --passwordfile pwordfile

</userinput>
Command ping-connection-pool executed successfully</screen>
<para>Where: asadmin is the command prompt and sampleConnectionPool is the
name of the connection pool to ping.</para>
</example>
</refsect1>
<refsect1 role="exit-status"><title></title>
<variablelist termlength="medium">
<varlistentry><term>0</term><listitem><para>command executed successfully
</para>
</listitem></varlistentry>
<varlistentry><term>1</term><listitem><para>error in executing the command
</para>
</listitem></varlistentry>
</variablelist></refsect1>
</refentry>
<?Pub *0000003508>
