asadmin(1M)

NAME | SYNOPSIS | DESCRIPTION | EXAMPLES | ATTRIBUTES | 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 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.

When using the command line interface, you need to understand the usage of the escape character. There are three reasons why the escape character is used:

1. UNIX meta characters: The UNIX meta characters are characters which have special meaning in a shell. These characters include: \/,.!$%^&*|{}[]”'`~;To disable these meta characters, the escape character (backslash “\”) is used. For example:

   echo * will echo all the files in the current directory.echo \* will echo the “*” character.

2. Java escape sequence: The escape character in Java is used as an escape sequence to represent certain special character values like \n for new line, \b for backspace, \t for tab and \” for double quote. An extra escape character is needed to represent the literal \ character.

3. Command-line interface delimiters: The Application Server command-line interface uses “:” as a delimiter for options. If the character “:” is used as part of the property or jvm_options, not as a delimeter, then the escape character is required so that the “:” character is treated as a literal not as a delimeter. For example:

   The command create-jvm-options accepts operands in the following format:

   (jvm_option_name[=jvm_option_value])[:jvm_option_name[=jvm_option_name]]*

   More than one jvm-option can be created by using the “:” delimiter. To disable the “:” delimiter and use it as a literal “:” in either jvm_option_name or jvm_option_value, the escape character is needed.

Since the escape character is used to disable the delimiter in the command-line interface, and the escape character is a special character in UNIX and in Java, you must apply an escape character to every escape character in the command line. This applies to commands executed on UNIX OS and multimode, not to Windows OS.

Additionally, instead of using the escape character, you can use the quote character”. Since quote is a special character in Java you must add an escape character. This does not apply to multimode.

EXAMPLES

---

Example 1 Using an asadmin command option containing an escape character




UNIX OS in singlemode and multimode:

asadmin create-jdbc-connection-pool -u admin --passwordfile mypasswordfile --datasourceclassname --description Test\\Escape\\Character sampleJDBCConnectionPool

Where the description option is Test\Escape\Character

Windows in singlemode:

asadmin create-jdbc-connection-pool -u --passwordfile mypasswordfile --datasourceclassname sampleClassName --description Test\Escape\Character sampleJDBCConnectionPool

In this case, an excape character is needed to disable the escape character in UNIX OS and in multimode. The escape character is not required for Windows.

---

---

Example 2 Using an asadmin command property option containing an escape character to disable the delimiter




The name and value pairs for property option are:

user=dbuserpasswordfile=dbpasswordfileDatabaseName=jdbc:derbyserver=http://localhost:9092

UNIX OS singlemode and multimode:

asadmin create-jdbc-connection-pool --user --passwordfile mypasswordfile --port 4848 --host localhost --datasourceclassname com.derby.jdbc.jdbcDataSource --property user=dbuser:passwordfile=dbpasswordfile:DatabaseName=jdbc\\:derby:server=http\\:// localhost sqe-jdbc-pool

Windows singlemode:

asadmin create-jdbc-connection-pool --user admin --passwordfile mypasswordfile --port 4848 --host localhost --datasourceclassname com.derby.jdbc.jdbcDataSource --property user-dbuser:passwordfile-dbpasswordfile:databaseName=jdbc\:derby:server= http\://localhost\:sqe-jdbc-pool

---

---

Example 3 Using an asadmin command with an operand containing an escape character to disable the delimiter




UNIX OS in singlemode and multimode:

asadmin create-jvm-options --target test-server -e -Dlocation=c\\:\\\\sun\\\\appserver

Windows singlemode:

asadmin create-jvm-options --target test-server -e -Dlocation=c\:\\sun\\appserver

In this case, four escape characters are required (\\\\) to use the literal value of “\”. The first escape is to escape the UNIX meta character. The second escape is to escape the Java escape sequence. The third escape character is to escape the UNIX meta character. And lastly, the fourth escape character is the literal value.

---

---

Example 4 Using an asadmin command with an option containing an escape character




UNIX OS in singlemode and multimode:

asadmin list-jdbc-resources --user \"admin\\admin\" --passwordfile mypasswordfile --host localhost --port 4848

Windows in singlemode and multimode:

asadmin list-jdbc-resources --user \"admin\admin\" --passwordfile mypasswordfile --host localhost --port 4848

In this case, the quote does not help much since an escape character is required to each escape character in UNIX.

---

---

Example 5 Using an asadmin command with a property option containing an escape character




The name and value pairs for property option are:

user=dbuserpasswordfile=dbpasswordfileDatabaseName=jdbc:derbyserver=http://localhost:9092

UNIX OS and Windows singlemode:

asadmin create-jdbc-connection-pool --user --passwordfile mypasswordfile --port 4848 --host localhost --datasourceclassname com.derby.jdbc.jdbcDataSource --property user=dbuser:passwordfile=dbpasswordfile:DatabaseName=\"jdbc:derby\":server=\ "http://localhost sqe-jdbc-pool

Notice that in this case, the escape character is not required before the literal “:” since there are quotes around the value.

---

ATTRIBUTES

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Interface Stability	Unstable

SEE ALSO

appclient(1M), package-appclient(1M)

NAME | SYNOPSIS | DESCRIPTION | EXAMPLES | ATTRIBUTES | SEE ALSO