asadmin(1M) (Sun Java System Application Server Platform Edition 8.1 2005Q2 Update 2 Reference Manual)

Sun Java System Application Server Platform Edition 8.1 2005Q2 Update 2 Reference Manual

asadmin(1M)

NAME | SYNOPSIS | DESCRIPTION | INTERFACE STABILITY | SEE ALSO

NAME

asadmin– utility for performing administrative tasks for the Sun Java System Application Server

SYNOPSIS

asadmin subcommand[[-short_option[[short_option_argument]]]]* [[--long_option[[long_option_argument]]]]* [[operand]]*

DESCRIPTION

Use the asadmin utility to perform any administrative task for the Sun Java System Application Server. You can use this utility in place of using the Administration Console interface.

The subcommand identifies the operation or task you wish to perform. Subcommands are case-sensitive. Short option arguments have a single dash (-); while long option arguments have two dashes (--). Options modify 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 (—). The asadmin utility treats anything that comes after the options and their values as an operand.

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.

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:

-u --user

authorized domain application server administrative username.

-w --password

password to administer the domain application server.

The ––password option is deprecated. Use ––passwordfile instead.

––passwordfile

The file containing the domain application server password in the following form: AS_ADMIN_PASSWORD=password. Where password is the actual administrator password.

-H --host

machine name where the domain application server is running.

-p --port

port number of the domain application server listening for administration requests. The default port number for Platform Edition is 4848. The default port number for Enterprise Edition is 4949.

-s --secure

if true, uses SSL/TLS to communicate with the domain application server.

-t --terse

indicates that any output data must be very concise, typically avoiding human-friendly sentences and favoring well-formatted data for consumption by a script. Default is false.

-e --echo

setting to true will echo the command line statement on the standard output. Default is false.

-I --interactive

if set to true (default), only the required password options are prompted.

–h ––help

displays the help text for the command.

For security purposes, you can set the password for a subcommand from a file instead of entering the password at the command line. The --passwordfile option takes the file containing the passwords. The valid contents for the file are:

AS_ADMIN_PASSWORD=value
AS_ADMIN_ADMINPASSWORD=value
AS_ADMIN_USERPASSWORD=value
AS_ADMIN_MASTERPASSWORD=value

If AS_ADMIN_PASSWORD has been exported to the global environment, specifying the --passwordfile option will produce a warning using about the --password option. Unset AS_ADMIN_PASSWORD to prevent this from happening.

The master password is not propagated on the command line or an environment variable, but can be specified in the passwordfile.

To use the --secure option, you must use the set command to enable the security—enabled flag in the admin http-listener in the domain.xml.

When you use the asadmin subcommands to create and/or delete, you must restart the server for the newly created command to take affect. Use the start-domain command to restart the server.

To access the manpages for the Application Server command-line interface subcommands on the Solaris platform, add $AS_INSTALL/man to your MANPATH environment variable.

You can obtain overall usage information for any of the asadmin utility subcommands by invoking the --help option. If you specify a subcommand, the usage information for that subcommand is displayed. Using the help option without a subcommand displays a listing of all the available subcommands.

INTERFACE STABILITY

Sun often provides developers with early access to new technologies, which allows developers to evaluate with them as soon as possible. Unfortunately, new technologies are prone to changes and standardization often results in interface incompatibility from previous versions.

To make reasonable risk assessments, developers need to know how likely an interface is to change in future releases. To aid developers in making these assessments, interface stability information is included on some manual pages for commands, entry-points, and file formats.

The more stable interfaces can safely be used by nearly all applications, because Sun will endeavor to ensure that these continue to work in future minor releases. Applications that depend only on Standard and Stable interfaces should reliably continue to function correctly on future minor releases (but not necessarily on earlier major releases).

The less stable interfaces allow experimentation and proto-typing, but should be used only with the understanding that they might change incompatibly or even be dropped or replaced with alternatives in future minor releases.

"Interfaces" that Sun does not document (for example, most kernel data structures and some symbols in system header files) may be implementation artifacts. Such internal interfaces are not only subject to incompatible change or removal, but we are unlikely to mention such a change in release notes.