Using the asadmin Administrative Command Line Interface (CLI) to Administer JBI Components

The Sun Java System (GlassFish) Application Server includes a command line administration utility known as asadmin. The asadmin utility can be used to perform any of the application server's administrative tasks, including those for administrating JBI Components.

The asadmin Utility uses the following guidelines:

• All asadmin commands and options are case sensitive.

• Option arguments are preceded by a single dash (-) or two dashes (--). Double dashes are used to specify long option arguments and a single dash specify the short option argument. Not all arguments will have a short option. Most options require argument values except boolean options which toggle to switch a feature ON or OFF.

  For more information on options and their use, see the JBI Command Options and Values Table.

• The asadmin utility can be run in interactive and non-interactive modes. Interactive mode will prompt the user for input, and is the default mode.

• The command syntax is:

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

• JBI command name syntax is:

  verb-jbi-noun 

  For example: start-jbi-component or deploy-jbi-service-assembly.

  This convention distinguishes JBI commands from other application server commands, and provides a name that describes the purpose of the command.

• Help can be obtained by issuing the following commands:

  • asadmin --help (displays general help)

  • asadmin command --help (displays help for the specified command)