<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
<!--ArborText, Inc., 1988-1999, v.4002-->
<!ENTITY metainfo SYSTEM "metainfo.sgm">
<!ENTITY options-common SYSTEM "options-common.sgm">
<!ENTITY synopsis-common SYSTEM "synopsis-common.sgm">
<!ENTITY % commonents SYSTEM "smancommon.ent">
%commonents;
<!ENTITY % booktitles SYSTEM "booktitles.ent">
%booktitles;
<!ENTITY Dash "&ndash;">
]>
<?Pub UDT _bookmark _target>
<?Pub EntList brvbar bull cross dash diam diams frac12 frac13 frac14 hellip
 laquo lArr loz mdash nabla ndash para pound rArr raquo sect yen ne>
<?Pub Inc>
<refentry id="flush-jmsdest-1">
<refmeta><refentrytitle>flush-jmsdest</refentrytitle><manvolnum>1</manvolnum>&metainfo;
</refmeta>
<refnamediv><indexterm><primary sortas="delete-jmsdest ">flush-jmsdest &mdash;
purges messages in a JMS destination</primary></indexterm><indexterm><primary
sortas="removes messages in a named JMS destination">purges messages in a
JMS destination &mdash; flush-jmsdest</primary></indexterm><refname>flush-jmsdest
</refname><refpurpose>purges messages in a JMS destination.</refpurpose></refnamediv>
<refsynopsisdiv><title>&synp-tt;</title>
<cmdsynopsis><command>flush-jmsdest</command>&synopsis-common;
<arg choice="plain"><?Pub Caret>--desttype|-T topic|queue</arg><arg>&Dash;&Dash;target <replaceable>
target (Default Server)</replaceable></arg><arg choice="plain"><replaceable>
destname</replaceable></arg>
</cmdsynopsis></refsynopsisdiv>
<refsect1><title>&desc-tt;</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><title>&opts-tt;</title>
<variablelist termlength="medium">&options-common;
<varlistentry><term><option role="nodash">&Dash;&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:<itemizedlist>
<listitem><para><literal>server</literal>, which deletes the physical destination
from the default server instance. This is the default value.</para>
</listitem>
<listitem><para><replaceable>configuration_name</replaceable>, which deletes
the physical destination from the named configuration</para>
</listitem>
<listitem><para><replaceable>cluster_name</replaceable>, which deletes the
physical destination from every server instance in the cluster</para>
</listitem>
<listitem><para><replaceable>instance_name</replaceable>, which deletes the
physical destination from a particular server instance</para>
</listitem>
</itemizedlist>&se-ee-only;</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">--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><title>&oper-tt;</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><title>&exam-tt;</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><title>&exit-tt;</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><title>&also-tt;</title>
<para><link linkend="create-jmsdest-1"><citerefentry><refentrytitle>create-jmsdest
</refentrytitle><manvolnum>1</manvolnum></citerefentry></link>, <link linkend="list-jmsdest-1"><citerefentry>
<refentrytitle>list-jmsdest</refentrytitle><manvolnum>1</manvolnum></citerefentry></link>, <link
linkend="create-jmsdest-1"><citerefentry><refentrytitle>delete-jmsdest</refentrytitle>
<manvolnum>1</manvolnum></citerefentry></link></para>
</refsect1>
</refentry>
<?Pub *0000004522>
