geronimo-scm mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From conflue...@apache.org
Subject [CONF] Apache Geronimo v3.0 > gogo commands for Geronimo
Date Tue, 19 Jul 2011 03:34:00 GMT
<html>
<head>
    <base href="https://cwiki.apache.org/confluence">
            <link rel="stylesheet" href="/confluence/s/2042/9/4/_/styles/combined.css?spaceKey=GMOxDOC30&amp;forWysiwyg=true" type="text/css">
    </head>
<body style="background: white;" bgcolor="white" class="email-body">
<div id="pageContent">
<div id="notificationFormat">
<div class="wiki-content">
<div class="email">
    <h2><a href="https://cwiki.apache.org/confluence/display/GMOxDOC30/gogo+commands+for+Geronimo">gogo commands for Geronimo</a></h2>
    <h4>Page <b>edited</b> by             <a href="https://cwiki.apache.org/confluence/display/~chirunhua@gmail.com">Runhua Chi</a>
    </h4>
        <br/>
                         <h4>Changes (1)</h4>
                                 
    
<div id="page-diffs">
                    <table class="diff" cellpadding="0" cellspacing="0">
    
            <tr><td class="diff-unchanged" >{scrollbar} <br> <br></td></tr>
            <tr><td class="diff-deleted-lines" style="color:#999;background-color:#fdd;text-decoration:line-through;">{info}Not completed yet{info} <br> <br></td></tr>
            <tr><td class="diff-unchanged" >{excerpt}The gogo commands for Geronimo is an extension of [Apache karaf Shell|http://karaf.apache.org/|Apache karaf] to interact with Geronimo kernel.{excerpt} Those command names are made up of two parts: &lt;scope&gt;:&lt;name&gt; by convention as listed below. Click each command to learn about its usage. <br> <br></td></tr>
            <tr><td class="diff-snipped" >...<br></td></tr>
    
            </table>
    </div>                            <h4>Full Content</h4>
                    <div class="notificationGreySide">
        <style type='text/css'>/*<![CDATA[*/
table.ScrollbarTable  {border: none;padding: 3px;width: 100%;padding: 3px;margin: 0px;background-color: #f0f0f0}
table.ScrollbarTable td.ScrollbarPrevIcon {text-align: center;width: 16px;border: none;}
table.ScrollbarTable td.ScrollbarPrevName {text-align: left;border: none;}
table.ScrollbarTable td.ScrollbarParent {text-align: center;border: none;}
table.ScrollbarTable td.ScrollbarNextName {text-align: right;border: none;}
table.ScrollbarTable td.ScrollbarNextIcon {text-align: center;width: 16px;border: none;}

/*]]>*/</style><div class="Scrollbar"><table class='ScrollbarTable'><tr><td class='ScrollbarPrevIcon'><a href="/confluence/display/GMOxDOC30/geronimo"><img border='0' align='middle' src='/confluence/images/icons/back_16.gif' width='16' height='16'></a></td><td width='33%' class='ScrollbarPrevName'><a href="/confluence/display/GMOxDOC30/geronimo">geronimo</a>&nbsp;</td><td width='33%' class='ScrollbarParent'><sup><a href="/confluence/display/GMOxDOC30/Tools+and+commands"><img border='0' align='middle' src='/confluence/images/icons/up_16.gif' width='8' height='8'></a></sup><a href="/confluence/display/GMOxDOC30/Tools+and+commands">Tools and commands</a></td><td width='33%' class='ScrollbarNextName'>&nbsp;<a href="/confluence/display/GMOxDOC30/jaxws-tools">jaxws-tools</a></td><td class='ScrollbarNextIcon'><a href="/confluence/display/GMOxDOC30/jaxws-tools"><img border='0' align='middle' src='/confluence/images/icons/forwd_16.gif' width='16' height='16'></a></td></tr></table></d!
 iv>

<p>The gogo commands for Geronimo is an extension of <a href="http://karaf.apache.org/" title="Apache karaf" class="external-link" rel="nofollow">Apache karaf Shell</a> to interact with Geronimo kernel. Those command names are made up of two parts: &lt;scope&gt;:&lt;name&gt; by convention as listed below. Click each command to learn about its usage.</p>

<p>To enter the karaf shell, press <b>Enter</b> after you start up the Geronimo server using <b>geronimo run</b> command.</p>

<p><a name="gogocommandsforGeronimo-top"></a></p>


<table class="sectionMacro" border="0" cellpadding="5" cellspacing="0" width="100%"><tbody><tr>
<td class="confluenceTd" valign="top" width="25%">
<p><a href="#gogocommandsforGeronimo-gogocommandstopserver">geronimo:stop-server</a><br/>
<a href="#gogocommandsforGeronimo-gogocommandassembleserver">deploy:assemble-server</a><br/>
<a href="#gogocommandsforGeronimo-gogocommanddistribute">deploy:distribute</a><br/>
<a href="#gogocommandsforGeronimo-gogocommandinstallplugin">deploy:install-plugin</a><br/>
<a href="#gogocommandsforGeronimo-gogocommandlogin">deploy:login</a><br/>
<a href="#gogocommandsforGeronimo-gogocommandstartmodule">deploy:start-module</a><br/>
<a href="#gogocommandsforGeronimo-gogocommandunlockkeystore">deploy:unlock-keystore</a></p>
</td>

<td class="confluenceTd" valign="top" width="25%">
<p><a href="#gogocommandsforGeronimo-gogocommandwaitforserver">geronimo:wait-for-server</a><br/>
<a href="#gogocommandsforGeronimo-gogocommandconnect">deploy:connect</a><br/>
<a href="#gogocommandsforGeronimo-gogocommandencrypt">deploy:encrypt</a><br/>
<a href="#gogocommandsforGeronimo-gogocommandlistmodules">deploy:list-modules</a><br/>
<a href="#gogocommandsforGeronimo-gogocommandnewserverinstance">deploy:new-server-instance</a><br/>
<a href="#gogocommandsforGeronimo-gogocommandstopmodule">deploy:stop-module</a><br/>
<a href="#gogocommandsforGeronimo-gogocommanddiagnose">equinox:diagnose</a></p></td>

<td class="confluenceTd" valign="top" width="25%">
<p><a href="#gogocommandsforGeronimo-gogocommandstartclient">geronimo:start-client</a><br/>
<a href="#gogocommandsforGeronimo-gogocommanddeploymodule">deploy:deploy-module</a><br/>
<a href="#gogocommandsforGeronimo-gogocommandinstallbundle">deploy:install-bundle</a><br/>
<a href="#gogocommandsforGeronimo-gogocommandlistplugins">deploy:list-plugins</a><br/>
<a href="#gogocommandsforGeronimo-gogocommandredploymodule">deploy:redeploy-module</a><br/>
<a href="#gogocommandsforGeronimo-gogocommandundeploymodule">deploy:undeploy-module</a><br/>
<a href="#gogocommandsforGeronimo-gogocommandresolve">eba:resolve</a></p></td>

<td class="confluenceTd" valign="top" width="25%">
<p><a href="#gogocommandsforGeronimo-gogocommandstartserver">geronimo:start-server</a><br/>
<a href="#gogocommandsforGeronimo-gogocommanddisconnect">deploy:disconnect</a><br/>
<a href="#gogocommandsforGeronimo-gogocommandinstalllibrary">deploy:install-library</a><br/>
<a href="#gogocommandsforGeronimo-gogocommandlisttargets">deploy:list-targets</a><br/>
<a href="#gogocommandsforGeronimo-gogocommandrestartmodule">deploy:restart-module</a><br/>
<a href="#gogocommandsforGeronimo-gogocommanduninstallbundle">deploy:uninstall-bundle</a><br/>
<a href="#gogocommandsforGeronimo-gogocommandgeronimorefresh">obr:geronimo-refresh</a></p></td>
</tr></tbody></table>

<p>Note that if the &lt;name&gt; portion of the command is unique, then you only need to type it. If not, then you must either type the full &lt;scope&gt;:&lt;name&gt; or arrange the scope search path accordingly. For example, you can use <b>list-modules</b> instead of <b>deploy:list-modules</b> to list all modules in the server repository.</p>

<p>Following options are common to those commands:</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p><b><em>generaloptions</em></b> includes:</p>

<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-s or --server, --hostname</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Hostname, default localhost</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-p or --port</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Port, default 1099</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-u or --username</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Specify an Username to start the server</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-w or --password</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Specify the password to start the server</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>--help</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Display this help message</p></div>
</div></div>


<h1><a name="gogocommandsforGeronimo-geronimo%3Astartserver"></a>geronimo:start-server<a name="gogocommandsforGeronimo-gogocommandstartserver"></a></h1>

<p>The server can be started through Felix Shell using the <b>geronimo:start-server</b> command. It uses the following syntax:</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p><b>start-server</b> <b><em>generaloptions</em></b> <b><em>commandoptions</em></b></p>

<p>where</p>

<p><b><em>commandoptions</em></b> includes:</p>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-A or --javaagent</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Use a specific Java Agent, set to <em>none</em> to disable</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-b or --background</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Run the server process in the background</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-D or --property</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Define system properties</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-G or --gproperty</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Define Geronimo system properties</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-H or --home</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Use a specific Geronimo home directory</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-j or --jvm</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Use a specific Java Virtual Machine for server process</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-J or --javaopt</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Set a Java Virtual Machine flag</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-l or --logfile</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Capture console output to a specified log file</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-m or --modules</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Start up a specific module by name</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-P or --profile</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Specify a configuration profile</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-q or --quite</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Suppress informative and warning messages</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-t or --timeout</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Specify the timeout for the server process in seconds</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-v or --verbose</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Enable verbose output; specify multiple times to increase verbosity</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>--secure</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Use secure channel</p></div>
</div></div>

<h2><a name="gogocommandsforGeronimo-startservercommandexamples"></a>start-server command examples</h2>

<p><a href="#gogocommandsforGeronimo-top">Back to Top</a></p>



<h1><a name="gogocommandsforGeronimo-geronimo%3Astopserver"></a>geronimo:stop-server<a name="gogocommandsforGeronimo-gogocommandstopserver"></a></h1>

<p>The server can be stopped using the geronimo/stop-server command. It uses the following syntax:</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p><b>stop-server</b> <b><em>generaloptions</em></b> <b><em>commandoptions</em></b></p>

<p>Where</p>

<p><b><em>commandoptions</em></b> includes:</p>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>--secure</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Use secure channel</p></div>
</div></div>

<h2><a name="gogocommandsforGeronimo-stopservercommandexamples"></a>stop-server command examples</h2>
<p>Use this syntax to stop the server.</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p>geronimo&gt; geronimo:stop-server --hostname localhost -p 1099</p>
</div></div>

<p><a href="#gogocommandsforGeronimo-top">Back to Top</a></p>




<h1><a name="gogocommandsforGeronimo-geronimo%3Awaitforserver"></a>geronimo:wait-for-server<a name="gogocommandsforGeronimo-gogocommandwaitforserver"></a></h1>

<p>The command is used to verify if the server has started in the given time (in seconds). It uses the following syntax:</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p><b>wait-for-server</b> <b><em>generaloptions</em></b> <b><em>commandoptions</em></b></p>

<p>Where</p>

<p><b><em>commandoptions</em></b> includes:</p>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-t or --timeout</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Specify the time (in seconds) to wait while verifying the that the server has started. 60 seconds by default</p></div>
</div></div>

<h2><a name="gogocommandsforGeronimo-waitforservercommandexamples"></a>wait-for-server command examples</h2>


<p><a href="#gogocommandsforGeronimo-top">Back to Top</a></p>



<h1><a name="gogocommandsforGeronimo-deploy%3Alogin"></a>deploy:login<a name="gogocommandsforGeronimo-gogocommandlogin"></a></h1>

<p>The command is used to save the username and password for the current connection to a file to avoid future prompting. This command is used for remote connections only. It has the following syntax:</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p><b>login</b> <b><em>generaloptions</em></b> <b><em>commandoptions</em></b></p>

<p>where</p>

<p><b><em>commandoptions</em></b> includes:</p>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>--secure</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Use secure channel</p></div>
</div></div>

<h2><a name="gogocommandsforGeronimo-logincommandexamples"></a>login command examples</h2>
<p>Use this syntax to save the username and password of the current connection so that you will not be prompted for credentials again when you issue other commands via the connection. Make sure you use <b>deploy:connect</b> firstly to connect to a remote instance, then use <b>deploy:login</b> to record the credential.</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p>geronimo&gt; deploy:login</p>
</div></div>
<p><a href="#gogocommandsforGeronimo-top">Back to Top</a></p>



<h1><a name="gogocommandsforGeronimo-deploy%3Aencrypt"></a>deploy:encrypt<a name="gogocommandsforGeronimo-gogocommandencrypt"></a></h1>

<p>The command is used to generates an encrypted string using <tt>org.apache.geronimo.util.EncryptionManager</tt>. It has the following syntax:</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p><b>encrypt</b> <b><em>commandoptions</em></b> <b><em>string</em></b></p>

<p>where</p>

<p><b><em>commandoptions</em></b> includes:</p>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>--secure</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Use secure channel</p></div>
<p><b><em>string</em></b> is a string to be encrypted</p>
</div></div>

<h2><a name="gogocommandsforGeronimo-encryptcommandexamples"></a>encrypt command examples</h2>
<p>Use this syntax to encrypt string passw0rd on an active server so that the encryption settings of that server will be used.<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p>geronimo&gt; deploy:encrypt passw0rd</p>
</div></div><br/>
Online encryption result is shown below:</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p>String to encrypt: passw0rd<br/>
Online encryption result:<br/>
{Simple}rO0ABXNyABlqYXZheC5jcnlwdG8uU2VhbGVkT2JqZWN0PjY9psO3VHACAARbAA1lbmNv<br/>
ZGVkUGFyYW1zdAACW0JbABBlbmNyeXB0ZWRDb250ZW50cQB+AAFMAAlwYXJhbXNBbGd0ABJMamF2YS9s<br/>
YW5nL1N0cmluZztMAAdzZWFsQWxncQB+AAJ4cHB1cgACW0Ks8xf4BghU4AIAAHhwAAAAEG2NoqXONCcU<br/>
GqfK0reVCpVwdAADQUVT</p>
</div></div>

<p><a href="#gogocommandsforGeronimo-top">Back to Top</a></p>



<h1><a name="gogocommandsforGeronimo-deploy%3Aassembleserver"></a>deploy:assemble-server<a name="gogocommandsforGeronimo-gogocommandassembleserver"></a></h1>

<p>The command is used to extract a customized server assembly from the current one. It has the following syntax:</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p><b>assemble-server</b> <b><em>generaloptions</em></b> <b><em>commandoptions</em></b></p>

<p>Where</p>

<p><b><em>commandoptions</em></b> includes:</p>

<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-a, or --artifact</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Specify the server artifact name</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-f, or --format</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Specify if the assembly is in .zip or tar.gz format</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-g, or --groupId</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Specify the group ID of the library</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-t, or --path</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Specify the assembly location, where your specific plug-ins are stored. The default location is <tt>&lt;geronimo_home&gt;/var/temp/</tt> </p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-l, or --list</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Refresh the plug-in list</p></div>
</div></div>

<h2><a name="gogocommandsforGeronimo-assembleservercommandexamples"></a>assemble-server command examples</h2>
<p>Use this syntax to create a custom server assembly, which is placed at <tt>&lt;geronimo_home&gt;/var/temp/</tt>. </p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p>geronimo&gt; deploy:assemble-server -f zip -g group1 -a assemble1</p>
</div></div>
<p><a href="#gogocommandsforGeronimo-top">Back to Top</a></p>




<h1><a name="gogocommandsforGeronimo-geronimo%3Astartclient"></a>geronimo:start-client<a name="gogocommandsforGeronimo-gogocommandstartclient"></a></h1>

<p>The command is used to start a Geronimo application client. Note that before starting a client, you have to deploy the application to the server. It has the following syntax:</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p><b>start-client</b> <b><em>generaloptions</em></b> <b><em>commandoptions</em></b></p>

<p>Where</p>

<p><b><em>commandoptions</em></b> includes:</p>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-A or --javaagent</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Use a specific Java Agent, set to <em>none</em> to disable</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-b or --background</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Run the server process in the background</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-D or --property</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Define system properties</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-G or --gproperty</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Define Geronimo system properties</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-H or --home</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Use a specific Geronimo home directory</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-j or --jvm</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Use a specific Java Virtual Machine for server process</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-J or --javaopt</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Set a Java Virtual Machine flag</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-l or --logfile</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Capture console output to a specified log file</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-P or --profile</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Specify a configuration profile</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-t or --timeout</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Specify the timeout for the server process in seconds</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-v or --verbose</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Enable verbose output; specify multiple times to increase verbosity</p></div>
</div></div>

<h2><a name="gogocommandsforGeronimo-startclientcommandexamples"></a>start-client command examples</h2>

<p><a href="#gogocommandsforGeronimo-top">Back to Top</a></p>




<h1><a name="gogocommandsforGeronimo-deploy%3Aconnect"></a>deploy:connect<a name="gogocommandsforGeronimo-gogocommandconnect"></a></h1>

<p>The command is used to connect to an instance of Geronimo that is already running. After connected successfully, you can run a series of commands on the remote server. It has the following syntax:</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p><b>connect</b> <b><em>generaloptions</em></b> <b><em>commandoptions</em></b></p>

<p>Where</p>

<p><b><em>commandoptions</em></b> includes:</p>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>--secure</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Use secure channel</p></div>
</div></div>

<p>Note that you can also use <a href="http://karaf.apache.org/manual/2.1.99-SNAPSHOT/users-guide/remote-console.html" title="ssh:ssh" class="external-link" rel="nofollow"><b>ssh:ssh</b> command</a> provided by Karaf shell to connect to a remote instance.</p>

<h2><a name="gogocommandsforGeronimo-connectcommandexamples"></a>connect command examples</h2>
<p>Use this syntax to connect to a remote server instance:</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p>geronimo&gt; deploy:connect -u system -p manager -s &lt;remote-ip&gt;</p>
</div></div>

<p><a href="#gogocommandsforGeronimo-top">Back to Top</a></p>


<h1><a name="gogocommandsforGeronimo-deploy%3Adisconnect"></a>deploy:disconnect<a name="gogocommandsforGeronimo-gogocommanddisconnect"></a></h1>

<p>The command is used to close the connection to a remote Geronimo server. Only one instance of the server can be connected at a time, no additional options are needed to specify which server to disconnect from. If you are trying to connect to a second server instance, use this command to disconnect first. It has the following syntax:</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p><b>disconnect</b></p>
</div></div>

<h2><a name="gogocommandsforGeronimo-disconnectcommandexamples"></a>disconnect command examples</h2>
<p>Use this syntax to disconnect a current connection.</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p>geronimo&gt; deploy:disconnect</p>
</div></div>

<p><a href="#gogocommandsforGeronimo-top">Back to Top</a></p>




<h1><a name="gogocommandsforGeronimo-deploy%3Adeploymodule"></a>deploy:deploy-module<a name="gogocommandsforGeronimo-gogocommanddeploymodule"></a></h1>

<p>The command is used to deploy a module to a Geronimo server. Once deployed, a module is identified by its module ID within Geronimo. It has the following syntax:</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p><b>deploy-module</b> <b><em>generaloptions</em></b> <b><em>commandoptions</em></b> <b>&lt;module&gt; &lt;deployment plan&gt;</b></p>

<p>where</p>

<p><b><em>module</em></b> is a module file, which is required for the command and can be one of the following:</p>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><ul>
	<li>Java EE Enterprise Application Archive (EAR) file</li>
</ul></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><ul>
	<li>Java EE Web Application Archive (WAR) file</li>
</ul></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><ul>
	<li>Java EE Enterprise JavaBean Archive (JAR) file</li>
</ul></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><ul>
	<li>Java EE Java Resource Archive (RAR) file</li>
</ul></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><ul>
	<li>OSGi Bundle</li>
</ul></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><ul>
	<li>Web Archive Bundle(WAB) file</li>
</ul></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><ul>
	<li>Enterprise Bundle Archive(EBA) file</li>
</ul></div>
<p><b><em>deployment plan</em></b> is an optional plan file for Java EE module. If the deployment plan for a Java EE archive file is not in the WEB-INF directory, its location must be specified after the <em>module</em> in the command. See <a href="/confluence/display/GMOxDOC30/Understanding+deployment+plans" title="Understanding deployment plans">Understanding deployment plans</a> for more details.<br/>
<b><em>commandoptions</em></b> includes:</p>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>--secure</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Use secure channel</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-i or --inPlace</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Add and start an archive or directory to an active server, without the archive or directory being copied into the server directory tree</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-t or --targets</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Specify the target repository to be deployed into. See <a href="#gogocommandsforGeronimo-gogocommandlisttargets">list-targets</a> for the names of repositories available on the server.</p></div>
</div></div>

<h2><a name="gogocommandsforGeronimo-deploymodulecommandexamples"></a>deploy-module command examples</h2>
<p>Use this syntax to deploy a WAR file.</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p>deploy-module d:/HelloWorld.war</p>
</div></div>
<p>Use this syntax to deploy a WAR file whose deployment plan is located outside of the WEB-INF directory.</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p>geronimo&gt; deploy:deploy-module d:/HelloWorld.war d:/geronimo-web.xml</p>
</div></div>

<p><a href="#gogocommandsforGeronimo-top">Back to Top</a></p>


<h1><a name="gogocommandsforGeronimo-deploy%3Adistributemodule"></a>deploy:distribute-module<a name="gogocommandsforGeronimo-gogocommanddistribute"></a></h1>

<p>The command works exactly like <a href="#gogocommandsforGeronimo-gogocomanddeploymodules">deploy-modules</a> except the module is not started once it has been deployed into the server and is not marked to be started each time the server starts. It has the same syntax and options as <a href="#gogocommandsforGeronimo-gogocomanddeploymodules">deploy-modules</a>:</p>

<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p><b>distribute-module</b> <b><em>generaloptions</em></b> <b><em>commandoptions</em></b> <b>&lt;module&gt; &lt;deployment plan&gt;</b></p>
</div></div>

<h2><a name="gogocommandsforGeronimo-distributecommandexamples"></a>distribute command examples</h2>
<p>Use this syntax to distribute a module whose deployment plan is located outside of the WEB-INF directory.</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p>geronimo&gt; deploy:distribute-module d:/HelloWorld.war d:/geronimo-web.xml</p>
</div></div>

<p><a href="#gogocommandsforGeronimo-top">Back to Top</a></p>




<h1><a name="gogocommandsforGeronimo-deploy%3Alisttargets"></a>deploy:list-targets<a name="gogocommandsforGeronimo-gogocommandlisttargets"></a></h1>

<p>The command is used to list all available target repositories on the server. It has the following syntax:</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p><b>list-targets</b> <b><em>generaloptions</em></b> <b><em>commandoptions</em></b></p>

<p>where</p>

<p><b><em>commandoptions</em></b> includes:</p>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>--secure</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Use secure channel</p></div>
</div></div>

<h2><a name="gogocommandsforGeronimo-listtargetscommandexamples"></a>list-targets command examples</h2>
<p>Use this syntax to list all available target repository where you can deploy applications to on the localhost.</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p>geronimo&gt; deploy:list-targets<br/>
Available Targets:<br/>
  org.apache.geronimo.framework/j2ee-system/3.0-SNAPSHOT/car?ServiceModule=org.apache.geronimo.framework/j2ee-system/3.0-SNAPSHOT/car,j2eeType=ConfigurationStore,name=Local</p>
</div></div>
<p><a href="#gogocommandsforGeronimo-top">Back to Top</a></p>



<h1><a name="gogocommandsforGeronimo-deploy%3Alistplugins"></a>deploy:list-plugins<a name="gogocommandsforGeronimo-gogocommandlistplugins"></a></h1>

<p>The command is used to list all of plugins in a certain maven repository. It has the following syntax:</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p><b>list-plugins</b> <b><em>generaloptions</em></b> <b><em>commandoptions</em></b></p>

<p>where</p>

<p><b><em>commandoptions</em></b> includes:</p>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>--secure</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Use secure channel</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-rr or --refresh-repository</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>refresh repository</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-r or --repository</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>repository URL</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-rl or --refresh-list</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>referensh plugin list</p></div>
</div></div>


<h2><a name="gogocommandsforGeronimo-listpluginscommandexamples"></a>list-plugins command examples</h2>

<p>Use this syntax to first access the list of repositories. Select a repository from the list, plugins in this repository is displayed.</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p>list-plugins </p>
</div></div>

<p>Use this syntax to display the list of plugins in the given repository using secure channel.</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p>geronimo&gt; deploy:list-plugins --secure -r <a href="http://geronimo.apache.org/plugins/geronimo-3.0/" class="external-link" rel="nofollow">http://geronimo.apache.org/plugins/geronimo-3.0/</a></p>
</div></div>

<p><a href="#gogocommandsforGeronimo-top">Back to Top</a></p>




<h1><a name="gogocommandsforGeronimo-deploy%3Anewserverinstance"></a>deploy:new-server-instance<a name="gogocommandsforGeronimo-gogocommandnewserverinstance"></a></h1>

<p>The command is used to create a new server instance. It has the following syntax:</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p><b>new-server-instance</b> <b><em>generaloptions</em></b> <b><em>commandoptions</em></b> <b><em>instancename</em></b></p>

<p>where</p>

<p><b><em>commandoptions</em></b> includes:</p>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>--secure</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Use secure channel</p></div>
<p><b><em>instancename</em></b> is the name of the new instance.</p>
</div></div>

<h2><a name="gogocommandsforGeronimo-newserverinstancecommandexamples"></a>new-server-instance command examples</h2>
<p>Use this syntax to create a new server instance <em>instance2</em>.</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p>geronimo&gt; deploy:new-server-instance instance2</p>
</div></div>


<p><a href="#gogocommandsforGeronimo-top">Back to Top</a></p>




<h1><a name="gogocommandsforGeronimo-deploy%3Aredeploymodule"></a>deploy:redeploy-module<a name="gogocommandsforGeronimo-gogocommandredeploymodule"></a></h1>

<p>The command is used to deploy a newer version of a module onto a server where the older module is already deployed. It has the following syntax:</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p><b>redeploy-module</b> <b><em>generaloptions</em></b> <b><em>commandoptions</em></b> <b>&lt;module&gt; &lt;deployment plan&gt; &lt;module id&gt;</b></p>

<p>where</p>

<p><b><em>module</em></b> is a module file, which is required for the command and can be one of the following:</p>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><ul>
	<li>Java EE Enterprise Application Archive (EAR) file</li>
</ul></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><ul>
	<li>Java EE Web Application Archive (WAR) file</li>
</ul></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><ul>
	<li>Java EE Enterprise JavaBean Archive (JAR) file</li>
</ul></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><ul>
	<li>Java EE Java Resource Archive (RAR) file</li>
</ul></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><ul>
	<li>OSGi Bundle</li>
</ul></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><ul>
	<li>Web Archive Bundle(WAB) file</li>
</ul></div>
<p><b><em>deployment plan</em></b> is an optional plan file for Java EE module. If the deployment plan for a Java EE archive file is not in the WEB-INF directory, its location must be specified after the <em>module</em> in the command. See <a href="/confluence/display/GMOxDOC30/Understanding+deployment+plans" title="Understanding deployment plans">Understanding deployment plans</a> for more details.<br/>
<b><em>module id</em></b> is the configuration on the server you want to replace. If you do not specify the module_id, the plan supplied (or plan inside the module) will be used to determine the actual configuration that you wish to redeploy. Redeploying a plan with an existing module ID allows you to modify the configuration of a running module without intermediate undeployment.<br/>
<b><em>commandoptions</em></b> includes:</p>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>--secure</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Use secure channel</p></div>
</div></div>

<h2><a name="gogocommandsforGeronimo-redeploymodulecommandexamples"></a>redeploy-module command examples</h2>
<p>Use this syntax to deploy a newer version of an existing module .</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p>geronimo&gt; deploy:redeploy-module D:/HelloWorld.war default/HelloWorld/1.0/car</p>
</div></div>

<p><a href="#gogocommandsforGeronimo-top">Back to Top</a></p>




<h1><a name="gogocommandsforGeronimo-deploy%3Aundeploymodule"></a>deploy:undeploy-module<a name="gogocommandsforGeronimo-gogocommandundeploymodule"></a></h1>

<p>The command is used to properly remove a module from a server. It has the following syntax:</p>

<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p><b>undeploy-module</b> <b><em>generaloptions</em></b> <b><em>commandoptions</em></b> <b>&lt;module id&gt;</b></p>

<p>where</p>

<p><b><em>module id</em></b> is the configuration name you want to remove from the server. It must be provided.<br/>
<b><em>commandoptions</em></b> includes:</p>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>--secure</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Use secure channel</p></div>
</div></div>

<h2><a name="gogocommandsforGeronimo-undeploymodulecommandexamples"></a>undeploy-module command examples</h2>
<p>Use this syntax to remove an existing module.</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p>geronimo&gt; deploy:undeploy-module default/HelloWorld/1.0/car</p>
</div></div>

<p><a href="#gogocommandsforGeronimo-top">Back to Top</a></p>




<h1><a name="gogocommandsforGeronimo-deploy%3Astartmodule"></a>deploy:start-module<a name="gogocommandsforGeronimo-gogocommandstartmodule"></a></h1>

<p>The command is used to start an existing module on the server which is not running. It use the following syntax:</p>

<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p><b>start-module</b> <b><em>generaloptions</em></b> <b><em>commandoptions</em></b> <b>&lt;module id&gt;</b></p>

<p>where</p>

<p><b><em>module id</em></b> is the configuration name you want to start on the server. It must be provided.<br/>
<b><em>commandoptions</em></b> includes:</p>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>--secure</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Use secure channel</p></div>
</div></div>

<h2><a name="gogocommandsforGeronimo-startmodulecommandexamples"></a>start-module command examples</h2>
<p>Use this syntax to start an existing module.</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p>geronimo&gt; deploy:start-module default/HelloWorld/1.0/car</p>
</div></div>

<p><a href="#gogocommandsforGeronimo-top">Back to Top</a></p>




<h1><a name="gogocommandsforGeronimo-deploy%3Astopmodule"></a>deploy:stop-module<a name="gogocommandsforGeronimo-gogocommandstopmodule"></a></h1>

<p>The command is used to stop a running module on the server. It use the following syntax:</p>

<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p><b>start-module</b> <b><em>generaloptions</em></b> <b><em>commandoptions</em></b> <b>&lt;module id&gt;</b></p>

<p>where</p>

<p><b><em>module id</em></b> is the configuration name you want to stop on the server. It must be provided.<br/>
<b><em>commandoptions</em></b> includes:</p>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>--secure</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Use secure channel</p></div>
</div></div>

<h2><a name="gogocommandsforGeronimo-stopmodulecommandexamples"></a>stop-module command examples</h2>
<p>Use this syntax to stop a running module.</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p>geronimo&gt; deploy:stop-module default/HelloWorld/1.0/car</p>
</div></div>

<p><a href="#gogocommandsforGeronimo-top">Back to Top</a></p>




<h1><a name="gogocommandsforGeronimo-deploy%3Arestartmodule"></a>deploy:restart-module<a name="gogocommandsforGeronimo-gogocommandrestartmodule"></a></h1>

<p>The command is used to restart a module on the server. It has the following syntax:</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p><b>restart-module</b> <b><em>generaloptions</em></b> <b><em>commandoptions</em></b> <b>&lt;module id&gt;</b></p>

<p>where</p>

<p><b><em>module id</em></b> is the configuration name you want to restart on the server. It must be provided.<br/>
<b><em>commandoptions</em></b> includes:</p>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>--secure</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Use secure channel</p></div>
</div></div>

<h2><a name="gogocommandsforGeronimo-restartmodulecommandexamples"></a>restart-module command examples</h2>
<p>Use this syntax to restart a module.</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p>geronimo&gt; deploy:restart-module default/HelloWorld/1.0/car</p>
</div></div>

<p><a href="#gogocommandsforGeronimo-top">Back to Top</a></p>




<h1><a name="gogocommandsforGeronimo-deploy%3Alistmodules"></a>deploy:list-modules<a name="gogocommandsforGeronimo-gogocommandlistmodules"></a></h1>

<p>The command is used to list modules in the target repository. It has the following syntax:</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p><b>list-modules</b> <b><em>generaloptions</em></b> <b><em>commandoptions</em></b> <b>&lt;targetname&gt;</b></p>

<p>where</p>

<p><b><em>commandoptions</em></b> includes:</p>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>--secure</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Use secure channel</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-t or --stopped</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Show stopped modules only</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-r or --started</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Show started modules only</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-a or --all</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Show started and stopp modules only, this one is default if you did not specify any parameters</p></div>
<p><b><em>targetname</em></b> is the name of target repository. See <a href="#gogocommandsforGeronimo-gogocommandlisttargets" title="list-targets">list-targets</a> for more details.</p>
</div></div>

<h2><a name="gogocommandsforGeronimo-listmodulescommandexmaples"></a>list-modules command exmaples</h2>
<p>Use this syntax to list the started modules in the target repository.</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p>geronimo&gt; deploy:list-modules -r</p>
</div></div>

<p><a href="#gogocommandsforGeronimo-top">Back to Top</a></p>



<h1><a name="gogocommandsforGeronimo-deploy%3Ainstallplugin"></a>deploy:install-plugin<a name="gogocommandsforGeronimo-gogocommandinstallplugin"></a></h1>

<p>The command is used to install a geronimo plugin into the server. It has the following syntax:</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p><b>install-plugin</b> <b><em>generaloptions</em></b> <b><em>commandoptions</em></b> <b>&lt;configuration archive&gt;</b></p>

<p>where</p>

<p><b><em>commandoptions</em></b> includes:</p>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>--secure</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Use secure channel</p></div>
<p><b><em>configuration archive</em></b> is the fully qualified name of plugin archive. The archive must be a valid <a href="/confluence/display/GMOxDOC30/Plugin+and+plugins+group" title="car file">Geronimo plugin file</a>.</p>
</div></div>

<h2><a name="gogocommandsforGeronimo-installplugincommandexamples"></a>install-plugin command examples</h2>
<p>Use this syntax to deploy a CAR file.</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p>geronimo&gt; deploy:install-plugin d:/HelloWorld-1.0.car</p>
</div></div>
<p><a href="#gogocommandsforGeronimo-top">Back to Top</a></p>



<h1><a name="gogocommandsforGeronimo-deploy%3Ainstalllibrary"></a>deploy:install-library<a name="gogocommandsforGeronimo-gogocommandinstalllibrary"></a></h1>

<p>The command is used to install a geronimo library into the server. It has the following syntax:</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p><b>install-library</b> <b><em>generaloptions</em></b> <b><em>commandoptions</em></b> <b>&lt;configuration archive&gt;</b></p>

<p>where</p>

<p><b><em>commandoptions</em></b> includes:</p>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>--secure</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Use secure channel</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-g or --groupId </p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Specify the group ID of the library</p></div>
<p><b><em>configuration archive</em></b> is the fully qualified name of library archive. </p>
</div></div>

<p>If installed successfully, the library will be found in <tt>&lt;geronimo_home&gt;/repository</tt></p>
<h2><a name="gogocommandsforGeronimo-installlibrarycommandexamples"></a>install-library command examples</h2>
<p>Use this syntax to install a geronimo library.</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p>geronimo&gt; deploy:install-library d:/temp/openejb-ejbd-3.2-SNAPSHOT.jar</p>
</div></div>

<p><a href="#gogocommandsforGeronimo-top">Back to Top</a></p>

<h1><a name="gogocommandsforGeronimo-deploy%3Ainstallbundle"></a>deploy:install-bundle<a name="gogocommandsforGeronimo-gogocommandinstallbundle"></a></h1>

<p>The command is used to install an OSGi bundle into the server, and the bundle information will be recorded in <tt>etc/startup.properties</tt> file. It has the following syntax:</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p><b>install-plugin</b> <b><em>generaloptions</em></b> <b><em>commandoptions</em></b> <b>&lt;bundle file&gt;</b></p>

<p>where</p>

<p><b><em>commandoptions</em></b> includes:</p>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>--groupId</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Defines a group Id for the bundle.</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>--startLevel</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Specifies start level of the bundle.</p></div>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>--start</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Specifies whether to start the bundle after installation. By default, the bundle is not started.</p></div>
<p><b><em>bundle file</em></b> is the fully qualified name of bundle to be installed. </p>
</div></div>

<h2><a name="gogocommandsforGeronimo-installbundlecommandexamples"></a>install-bundle command examples</h2>
<p>Use this syntax to install an OSGi bundle.</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p>server&gt; deploy:install-bundle --groupId myCompany --start --startLevel 100 d:/HelloWorld-1.0.jar</p>
</div></div>
<p><a href="#gogocommandsforGeronimo-top">Back to Top</a></p>

<h1><a name="gogocommandsforGeronimo-deploy%3Auninstallbundle"></a>deploy:uninstall-bundle<a name="gogocommandsforGeronimo-gogocommanduninstallbundle"></a></h1>

<p>The command is used to uninstall a bundle in server. It has the following syntax:</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p><b>unlinstall-bundle</b> <b><em>generaloptions</em></b> <b><em>commandoptions</em></b> <b>bundleId</b></p>

<p>where</p>

<p><b><em>commandoptions</em></b> includes:</p>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>--secure</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Use secure channel</p></div>
<p><b><em>bundleId</em></b> is id of the bundle to be uninstalled.</p>
</div></div>

<h2><a name="gogocommandsforGeronimo-uninstallbundlecommandexamples"></a>uninstall-bundle command examples</h2>
<p>Use this syntax to uninstall an OSGi bundle with id 361 in the server.</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p>server&gt; deploy:uninstall-bundle 361</p>
</div></div>
<p><a href="#gogocommandsforGeronimo-top">Back to Top</a></p>

<h1><a name="gogocommandsforGeronimo-deploy%3Aunlockkeystore"></a>deploy:unlock-keystore<a name="gogocommandsforGeronimo-gogocommandunlockkeystore"></a></h1>

<p>The command is used to unlock a keystore and private key in Geronimo server. It has the following syntax:</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p><b>unlock-keystore</b> <b><em>generaloptions</em></b> <b><em>commandoptions</em></b> <b>&lt;keystore&gt;</b></p>

<p>where</p>

<p><b><em>commandoptions</em></b> includes:</p>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>--secure</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Use secure channel</p></div>
<p><b><em>keystore</em></b> is the name of keystore or private key you want to unlock.</p>
</div></div>

<h2><a name="gogocommandsforGeronimo-unlockkeystorecommandexamples"></a>unlock-keystore command examples</h2>

<p><a href="#gogocommandsforGeronimo-top">Back to Top</a></p>

<h1><a name="gogocommandsforGeronimo-equinox%3Adiagnose"></a>equinox:diagnose<a name="gogocommandsforGeronimo-gogocommanddiagnose"></a></h1>

<p>The command is used to diagnose constraints of an installed OSGi bundle and verify if the bundle can be resolved successfully. The command is only available in Equinox OSGi runtime.</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p><b>diagnose</b> <b><em>generaloptions</em></b> <b><em>commandoptions</em></b> <b>&lt;bundleIDs&gt;</b></p>

<p>where<br/>
<b><em>commandoptions</em></b> includes:</p>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-s or --simple</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Do not perform deeper analysis of resolver problems</p></div>
<p><b><em>bundleIDs</em></b> is a list of bundle IDs seperated by whitepaces.</p>
</div></div>

<h2><a name="gogocommandsforGeronimo-diagnosecommandexamples"></a>diagnose command examples</h2>
<p>Use this syntax to diagnose the resolver problem of a bundle with Id 85.<br/>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p>geronimo&gt; diagnose 85<br/>
mvn:org.apache.geronimo.framework/geronimo-service-builder/3.0-SNAPSHOT [85]<br/>
  No unresolved constraints.</p>
</div></div>diagnose<br/>
<a href="#gogocommandsforGeronimo-top">Back to Top</a></p>



<h1><a name="gogocommandsforGeronimo-eba%3Aresolve"></a>eba:resolve<a name="gogocommandsforGeronimo-gogocommandresolve"></a></h1>

<p>The command is used to resolve constraints of an Aries applications and create the deployment manifest <tt>application.MF</tt> for the applciation.</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p><b>resolve</b> <b><em>generaloptions</em></b> <b><em>commandoptions</em></b> <b>&lt;AppPath&gt;</b></p>

<p>where<br/>
<b><em>commandoptions</em></b> includes:</p>
<div class="indent0 inline" style="margin-left: 0px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>-o or --out</p></div>
<div class="indent20 inline" style="margin-left: 20px;"><style type="text/css">div.inline p:first-child { display: inline; }</style><p>Specify the location to output the resolve application.</p></div>
<p><b><em>AppPath</em></b> is location of Aries application to be resolved.</p>
</div></div>

<h2><a name="gogocommandsforGeronimo-resolvecommandexamples"></a>resolve command examples</h2>
<p>Use this syntax to resolve an Aries application.</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p>geronimo&gt; eba:resolve d:/temp/myAriesApp.eba<br/>
Attempting to resolve myAriesApp application.<br/>
Application myAriesApp is now resolved.</p>
</div></div>
<p><a href="#gogocommandsforGeronimo-top">Back to Top</a></p>

<h2><a name="gogocommandsforGeronimo-obr%3Ageronimorefresh"></a>obr:geronimo-refresh<a name="gogocommandsforGeronimo-gogocommandgeronimorefresh"></a></h2>

<p>The command is used to refresh bundle status in the repository of CE server. This command is useful when you installed a new bundle in to CE server and want the bundle information to be added in to the bundle repository of the server.</p>
<div class="panel" style="border-style: solid;border-width: 1px;"><div class="panelContent">
<p><b>geronimo-refresh</b> <b><em>generaloptions</em></b> </p>
</div></div>

<p><a href="#gogocommandsforGeronimo-top">Back to Top</a></p>

    </div>
        <div id="commentsSection" class="wiki-content pageSection">
        <div style="float: right;">
            <a href="https://cwiki.apache.org/confluence/users/viewnotifications.action" class="grey">Change Notification Preferences</a>
        </div>
        <a href="https://cwiki.apache.org/confluence/display/GMOxDOC30/gogo+commands+for+Geronimo">View Online</a>
        |
        <a href="https://cwiki.apache.org/confluence/pages/diffpagesbyversion.action?pageId=20645486&revisedVersion=52&originalVersion=51">View Changes</a>
                |
        <a href="https://cwiki.apache.org/confluence/display/GMOxDOC30/gogo+commands+for+Geronimo?showComments=true&amp;showCommentArea=true#addcomment">Add Comment</a>
            </div>
</div>
</div>
</div>
</div>
</body>
</html>

Mime
View raw message