asadmin(1)
NAME
asadmin - wrapper utility for performing administrative tasks for the
Sun Java System Application Server on Ubuntu Linux
SYNOPSIS
asadmin subcommand[-short_option[short_option_argument]]*
[--long_option[long_option_argument]]* [operand]*
Use this asadmin utility wrapper script to run asadmin from the /usr/bin directory. This script automatically creates a default domain in user_home_directory/glassfishv2/domains, if one has not already been created.
This asadmin script is a wrapper for the asadmin utility found in /usr/share/glassfishv2/bin by default when you install Application Server. All commands sent to this script are forwarded to that utility.
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 asadmin utility located in /usr/share/glassfishv2/bin. You can create a domain in any location using the create-domain command with the domaindir option.
Use the asadmin utility to perform administrative tasks for Sun Java System Application Server. You can use asadmin in place of the Admin 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
control how the utility performs a subcommand. Options are also casesensitive. 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.
- For this wrapper script, the most common subcommands are:
- o start-domain, which creates a domain in user_home_directory/glass
fishv2/domains if one doesn't already exist, and starts it. If the domain already exists, it starts the domain.
- o stop-domain, which stops the domain in user_home_directory/glass
fishv2/domains.
- o delete-domain, which deletes the domain in user_home_direc
tory/glassfishv2/domains.
- o help, which gives you help for asadmin. asadmin help gives you a
list of valid subcommands. asadmin subcommand --help gives you help for the subcommand.
- 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:
- 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 about using 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 configuration file.
- 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.
- 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.
ATTRIBUTES
See attributes(5) for descriptions of the following attributes:
+-----------------------------+-----------------------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+-----------------------------+-----------------------------+
|Interface Stability |Unstable |
+-----------------------------+-----------------------------+