<!--Arbortext, Inc., 1988-2008, 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;
]>
<?Pub UDT _bookmark _target>
<?Pub EntList bull rArr sect>
<?Pub Inc>
<refentry id="jms-ping-1"><?Pub Tag atict:info tracking="off" ref="2"><?Pub Tag
atict:user user="hl34125" fullname=""><?Pub Tag atict:user user="pmdavies"
fullname=""><?Pub Tag atict:user user="ah95648" fullname="">
<!-- @(#)jms-ping.1 1.9 07/04/25 SMI; -->
<refmeta><refentrytitle>jms-ping</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>jms-ping</primary></indexterm><indexterm>
<primary>checks to see if the JMS service is up and running</primary>
</indexterm>
<refname>jms-ping </refname><refpurpose>checks if the JMS service is up and
running</refpurpose></refnamediv>
<refsynopsisdiv><title></title>
<synopsis><command>jms-ping</command> &synopsis-common; [<replaceable>target</replaceable>]
</synopsis>
</refsynopsisdiv>
<refsect1 role="description"><title></title>
<para>The <command>jms-ping</command> command checks if the JMS service (also
known as the JMS provider) is up and running. When you start the server<?Pub
Caret>, the JMS service starts by default. </para>
<para>The <command>jms-ping</command> command pings only the default JMS host
within the JMS service. It displays an error message when it is unable to
ping a built-in JMS service.</para>
<para>This command is supported in remote mode only.</para>
</refsect1>
<refsect1 role="options"><title></title>
<variablelist termlength="medium">&options-common;
</variablelist>
</refsect1>
<refsect1 role="operands"><title></title>
<variablelist termlength="medium">
<varlistentry><term><replaceable>target</replaceable></term>
<listitem><para>This operand specifies the target for which the operation
is to be performed. Valid values are:</para>
<itemizedlist>
<listitem><para><literal>server</literal>&hyphen; Specifies the default server
instance as the target.  <literal>server</literal> is the name of the default
server instance and is the default value.</para></listitem>
<listitem><para><replaceable>configuration_name</replaceable>&hyphen; Specifies
a certain configuration as the target.</para></listitem>
<listitem><para><replaceable>cluster_name</replaceable>&hyphen; Specifies
a certain cluster as the target.</para></listitem>
<listitem><para><replaceable>instance_name</replaceable>&hyphen; Specifies
a certain server instance as the target.</para></listitem>
</itemizedlist>
<para>&oper-se-ee-only;</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="examples"><title></title>
<example><title>Using the jms-ping command</title>
<para>The following command checks to see if the JMS service is running on
the server instance <literal>server1</literal>:</para>
<screen>asadmin> <userinput>jms-ping --user admin 
--passwordfile passwords.txt --host bluestar --port 4848 
server1</userinput>
JMS Ping Status=RUNNING
Command jms-ping executed successfully.</screen>
</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>
<refsect1 role="see-also"><title></title>
<para><olink targetdoc="ASREFMAN" targetptr="create-jmsdest-1">create-jmsdest(1)</olink>, <olink
targetdoc="ASREFMAN" targetptr="create-jms-resource-1">create-jms-resource(1)</olink></para>
</refsect1>
</refentry>
