Jonas 5 Commands Reference Guide
Total Page:16
File Type:pdf, Size:1020Kb
JOnAS 5 Commands Reference Guide This document describes all the commands that can be used with JOnAS JOnAS Team ( François FORNACIARI) - March 2009 - Copyright © OW2 Consortium 2008-2009 This work is licensed under the Creative Commons Attribution-ShareAlike License. To view a copy of this license,visit http://creativecommons.org/licenses/by-sa/2.0/deed.en or send a letter to Creative Commons, 559 Nathan Abbott Way, Stanford, California 94305, USA. Table of Contents 1. jonas command ......................................................................................................... 1 1.1. jonas start ...................................................................................................... 1 1.1.1. Options ............................................................................................... 1 1.1.2. Description .......................................................................................... 2 1.2. jonas stop ...................................................................................................... 2 1.2.1. Options ............................................................................................... 2 1.2.2. Description .......................................................................................... 2 1.3. jonas admin ................................................................................................... 2 1.3.1. Synopsis ............................................................................................. 3 1.3.2. Description .......................................................................................... 3 1.3.3. Options ............................................................................................... 3 1.4. jonas version .................................................................................................. 4 1.4.1. Synopsis ............................................................................................. 4 1.4.2. Description .......................................................................................... 4 1.5. jonas check .................................................................................................... 4 1.5.1. Synopsis ............................................................................................. 5 1.5.2. Description .......................................................................................... 5 1.6. jcl ................................................................................................................ 5 1.6.1. Synopsis ............................................................................................. 5 1.6.2. Description .......................................................................................... 5 2. jclient command ........................................................................................................ 6 2.1. Options ......................................................................................................... 6 2.2. Description .................................................................................................... 6 3. GenIC command ....................................................................................................... 7 3.1. Options ......................................................................................................... 7 3.2. Example ........................................................................................................ 7 3.3. Description .................................................................................................... 7 3.4. Environment .................................................................................................. 8 4. JMS commands ........................................................................................................ 9 4.1. JmsServer ...................................................................................................... 9 4.1.1. Synopsis ............................................................................................. 9 4.1.2. Description .......................................................................................... 9 4.1.3. Example ............................................................................................. 9 4.2. joram_raconfig ............................................................................................... 9 4.2.1. Options ............................................................................................... 9 4.2.2. Description .......................................................................................... 9 4.2.3. Example ............................................................................................ 10 5. Configuration commands .......................................................................................... 11 5.1. newjb command ............................................................................................ 11 5.1.1. Synopsis ............................................................................................ 11 5.1.2. Description ........................................................................................ 11 5.2. newjc command ............................................................................................ 11 5.2.1. Options ............................................................................................. 12 5.2.2. Description ........................................................................................ 12 5.2.3. Review newjc output ........................................................................... 12 5.2.4. Tell Apache about mod_jk ................................................................... 13 5.3. RAConfig command ...................................................................................... 14 5.3.1. Synopsis ............................................................................................ 14 5.3.2. Description ........................................................................................ 14 5.3.3. Options ............................................................................................. 14 5.3.4. Examples .......................................................................................... 15 ii Chapter 1. jonas command This command provides the capability to start, stop, or administrate JOnAS servers. The following two scripts can be reviewed and possibly modified for assistance with problems or for obtaining additional information: • jonas for UNIX systems • jonas.bat for WINDOWS systems There are five different sub-commands, that depend on the first mandatory argument: start, stop, admin, version, check 1.1. jonas start Command allowing to start a JOnAS server. 1.1.1. Options jonas start [-standby] [-fg] [-bg] [-win] [-tui] [-gui] [-dev] [-clean] [-n name] [-target server] [- Ddomain.name=domain] -standby Start a minimal JOnAS server with only mandatory services : registry, jmx. If the discovery service is configured in the JOnAS service list, it will bo started too. When the server startup is done, JOnAS should be in the STANDBY state. In this state, the server can either be stopped (see jonas stop command) or be fully started by executing the jonas start command to reach the RUNNING state. -bg Start the server in background mode -win Start the server in a new window -tui Start the Apache Felix TUI (force foreground mode) -gui Start the Apache Felix GUI -dev This option allows to start a JOnAS server by using bundles present in the default maven repository instead of bundles under $JONAS_ROOT/lib/bundles. A specific maven repository location can be given by setting the m2.repository property -clean Clean the Apache Felix cache before starting a JOnAS server -n name Set the server name. It must be unique in the domain. By default, the server name is jonas -target server This option allows to start another server or cluster (group of servers) in the domain. This action is to be executed in the environment of a running master server who's name is given by the -n option. In order to start a target server or cluster, the following conditions have to be met: • the target must belong to the domain (has to be defined in the domain's map) 1 jonas command • a cluster daemon has to be running on the target's host and it has to be aware of the target (see cluster daemon configuration) -Ddomain.name=domain Set the name of the management domain to which the server belongs 1.1.2. Description Start a JOnAS server. The process can be run in the foreground, in the background, or in a new window. If the background option is chosen (default option), control is given back to the caller only when the server is ready. The gui and tui options allow to interact with the OSGi framework. The name of the management domain to which the server belongs is given by the domain.name propery, or by the server name if this property is not defined. 1.2. jonas stop Command allowing to stop a JOnAS server. 1.2.1. Options jonas stop [-standby] [-n name] [-target server] [-Ddomain.name=domain] -standby Allows to stop all services except the mandatory ones (registry and jmx). When the server stop is done, JOnAS should be in the STANDBY state and the JVM is still running. In this state, the server can either be started (see jonas start command) or be fully stopped by executing the jonas stop command to stop all services and the JVM. -n name Set the name of the server to stop. By default, the server name is jonas -target server