<!--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;
]>
<?Pub UDT _bookmark _target>
<?Pub CX solbook(>
<refentry id="flush-jmsdest-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="">
<!-- @(#)flush-jmsdest.1 1.9 07/04/25 SMI; -->
<refmeta><refentrytitle>flush-jmsdest</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>flush-jmsdest</primary></indexterm><indexterm>
<primary>purges messages in a JMS destination</primary></indexterm>
<refname>flush-jmsdest</refname><refpurpose>purges messages in a JMS destination.
</refpurpose></refnamediv>
<refsynopsisdiv><title></title>
<synopsis><command>flush-jmsdest</command> &synopsis-common; --desttype|-T topic|queue
 [<option role="double-dash">target</option> <replaceable>target (Default Server)
</replaceable>] <replaceable>destname</replaceable></synopsis>
</refsynopsisdiv>
<refsect1 role="description"><title></title>
<para>The <command>flush-jmsdest</command> command purges the messages from
a physical destination in the specified target's JMS Service configuration. </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 helps specify the location of the JMS destination
from where you want to clean the messages. 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><?Pub Caret1>&se-ee-only;</para>
</listitem>
</varlistentry>
<varlistentry><term><option>--desttype</option></term>
<listitem><para>This option indicates the type of physical destination from
where you want to purge messages. The supported destination types are topic
and queue.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="operands"><title></title>
<variablelist termlength="medium">
<varlistentry><term><replaceable>dest_name</replaceable></term>
<listitem><para>The unique identifier of the JMS destination to be purged.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="examples"><title></title>
<example><title>Using the flush-jmsdest command</title>
<para>The following command purges messages from the queue named <literal>PhysicalQueue
</literal>:</para>
<screen>asadmin> <userinput>flush-jmsdest --user admin --passwordfile passwords.txt 
--host localhost --port 4848 --desttype queue PhysicalQueue</userinput>
Command flush-jmsdest 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="list-jmsdest-1">list-jmsdest(1)</olink>, <olink targetdoc="ASREFMAN" targetptr="create-jmsdest-1">create-jmsdest(1)</olink></para>
</refsect1>
</refentry>
<?Pub *0000004168 0>
