<!--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="asadmin-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="">
<!-- @(#)asadmin.1 1.3 08/01/31 SMI; -->
<refmeta><refentrytitle>asadmin</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="date">24 Jan 2008</refmiscinfo>
<refmiscinfo class="sectdesc">&man1;</refmiscinfo>
<refmiscinfo class="software">&software;</refmiscinfo>
<refmiscinfo class="arch">generic</refmiscinfo>
<refmiscinfo class="copyright">Copyright (c) 2008, Sun Microsystems, Inc.
All Rights Reserved</refmiscinfo>
</refmeta>
<refnamediv><indexterm><primary sortas="asadmin">asadmin &mdash; wrapper utility
for performing administrative tasks on Ubuntu Linux.</primary></indexterm>
<indexterm><primary
sortas="wrapper utility for performing administrative tasks for the Sun Java System Application Server on Ubuntu Linux">
wrapper utility for performing administrative tasks on Ubuntu Linux&mdash;
asadmin</primary></indexterm>
<refname>asadmin</refname><refpurpose>wrapper utility for performing administrative
tasks on Ubuntu Linux</refpurpose></refnamediv>
<refsynopsisdiv><title></title>
<synopsis><command>asadmin</command> <replaceable> subcommand</replaceable> [<option>
short_option</option>[ <replaceable>short_option_argument</replaceable>]]*
 [<option role="double-dash">long_option</option>[ <replaceable>long_option_argument
</replaceable>]]* [<replaceable>operand</replaceable>]*</synopsis>
</refsynopsisdiv>
<refsect1 role="description"><title></title>
<para>Use this <command>asadmin</command> utility wrapper script to run <command>
asadmin</command> from the <filename>/usr/bin</filename> directory. This script
automatically creates a default domain in <replaceable>user_home_directory</replaceable><filename>
/glassfishv2/domains</filename>, if one has not already been created. </para>
<para>This <command>asadmin</command> script is a wrapper for the <command>asadmin
</command> utility found in <filename>/usr/share/glassfishv2/bin</filename> by
default when you install Communications Server. All commands sent to this
script are forwarded to that utility.</para>
<para>The script is a convenience wrapper to create a domain in the user's
home directory. If the script fails, or there are other domains occupying
the same ports or hosts, run the <command>asadmin</command> utility located
in <filename>/usr/share/glassfishv2/bin</filename>. You can create a domain
in any location using the <command>create-domain</command> command with the <literal>
domaindir</literal> option.</para>
<para>Use the <command>asadmin</command> utility to perform administrative
tasks for Communications Server<?Pub Caret>r. You can use <command>asadmin</command> in
place of the Admin Console interface. </para>
<para>The <replaceable>subcommand</replaceable> identifies the operation or
task you wish to perform. Subcommands are case-sensitive. Short option arguments
have a single dash (<option></option>); while long option arguments have two
dashes (<option role="double-dash"></option>). Options control how the utility
performs a subcommand. Options are also case-sensitive. Most options require
argument values except boolean options, which toggle to switch a feature ON
or OFF. Operands appear after the argument values, and are set off by a space,
a tab, or double dashes (<option role="double-dash"></option>). The <command>asadmin
</command> utility treats anything that comes after the options and their
values as an operand.</para>
<para>For this wrapper script, the most common subcommands are:</para>
<itemizedlist>
<listitem><para><command>start-domain</command>, which creates a domain in <replaceable>
user_home_directory</replaceable><filename>/glassfishv2/domains</filename> if
one doesn't already exist, and starts it. If the domain already exists, it
starts the domain.</para></listitem>
<listitem><para><command>stop-domain</command>, which stops the domain in <replaceable>
user_home_directory</replaceable><filename>/glassfishv2/domains</filename>.</para>
</listitem>
<listitem><para><command>delete-domain</command>, which deletes the domain
in <replaceable>user_home_directory</replaceable><filename>/glassfishv2/domains</filename>.
</para></listitem>
<listitem><para><command>help</command>, which gives you help for <literal>asadmin
</literal>. <command>asadmin help</command> gives you a list of valid subcommands. <command>
asadmin</command> <replaceable>subcommand</replaceable> <command>--help</command> gives
you help for the subcommand.</para></listitem>
</itemizedlist>
<para>Local subcommands can be executed without the presence of an administration
server. However, it is required that the user be logged into the machine hosting
the domain in order to execute the subcommand and have access (permissions)
for the installation and domain directories.</para>
<para>Remote subcommands are always executed by connecting to an administration
server and executing the subcommand there. A running administration server
is required. All remote subcommands require the following options:</para>
<variablelist termlength="wholeline">&options-common;
</variablelist>
<para>The <option role="double-dash">passwordfile</option> option takes the
file containing the passwords. The valid contents for the file are:</para>
<programlisting>AS_ADMIN_PASSWORD=<replaceable>value</replaceable>
AS_ADMIN_ADMINPASSWORD=<replaceable>value</replaceable>
AS_ADMIN_USERPASSWORD=<replaceable>value</replaceable>
AS_ADMIN_MASTERPASSWORD=<replaceable>value</replaceable></programlisting>
<para>If <literal>AS_ADMIN_PASSWORD</literal> has been exported to the global
environment, specifying the <option>-passwordfile</option> option will produce
a warning about using the <option>-password</option> option. Unset <literal>AS_ADMIN_PASSWORD
</literal> to prevent this from happening.</para>
<para>The master password is not propagated on the command line or an environment
variable, but can be specified in the <filename>passwordfile</filename>.</para>
<para>To use the <option>-secure</option> option, you must use the <command>set</command> command
to enable the <classname>security-enabled</classname> flag in the <classname>admin
http-listener</classname> in the <filename>domain.xml</filename> configuration
file.</para>
<para>When you use the <command>asadmin</command> subcommands to create and/or
delete, you must restart the server for the newly created command to take
affect. Use the <command>start-domain</command> command to restart the server.</para>
<para>You can obtain overall usage information for any of the <command>asadmin</command> utility
subcommands by invoking the <option>-help</option> option. If you specify
a subcommand, the usage information for that subcommand is displayed. Using
the <command>help</command> option without a subcommand displays a listing
of all the available subcommands.</para>
</refsect1>
<refsect1 role="attributes"><title></title>
<para>See attributes (5) for descriptions of the following attributes:</para>
<informaltable frame="all" orient="port">
<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="col1" colwidth="198*"
align="left"><colspec colname="col2" colwidth="198*" align="left"><thead>
<row>
<entry align="center" valign="top">
<para>ATTRIBUTE TYPE</para>
</entry>
<entry align="center" valign="top">
<para>ATTRIBUTE VALUE</para>
</entry>
</row>
</thead>
<tbody>
<row>
<entry colname="col1">
<para>Interface Stability</para>
</entry>
<entry colname="col2" colsep="0">
<para>Unstable</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable></refsect1>
<refsect1 role="see-also"><title></title>
<para><olink targetdoc="asrefman" targetptr="asadmin-1m">asadmin(1M)</olink>, <olink targetdoc="asrefman" targetptr="start-domain-1">start-domain(1)</olink>, <olink targetdoc="asrefman" targetptr="stop-domain-1">stop-domain(1)</olink>, <olink targetdoc="asrefman" targetptr="delete-domain-1">delete-domain(1)</olink>.</para>
</refsect1>
</refentry>
<?Pub *0000008128 0>
