GlassFish - World's first Java EE 7 Application Server


A Glossary of New JBI Commands

These are the new commands that will be added. This page is supposed to be a reference for the people who try out, test, document these commands. Be as detailed as possible.

Id Command name and brief description Options, one per line, with legal and default values Operand, one per line, with brief description
00001 *install-jbi-component*: Will install a Service Engine or Binding Component into the JBI Environment. 
--echo|-e : true|[false]
--interactive|-I : [true]|false
--terse|-t : true|[false]
--secure|-s : true|[false]
--enabled : true|[false]
--port|-p : [port number]
--host|-H : [localhost]
--user|-u : [admin user]
--properties : [(name=value)[:name=value]* | file]
--passwordfile : [filename]
--upload : [true]|false
--target : [target name]
--help
 file path or component name: The archive file that will contain the component attributes, or the name of the component that has been previously installed to the domain.
00002 *start-jbi-component*: Will start a component (service engine or binding component) on the specified target. If no target is specified, the component will be started on the embedded DAS server. 
--echo|-e : true|[false]
--interactive|-I : [true]|false
--terse|-t : true|[false]
--secure|-s : true|[false]
--port|-p : [port number]
--host|-H : [localhost]
--user|-u : [admin user]
--passwordfile : [filename]
--target : [target name]
--help
 component_name: The name of the binding component or service engine.
00003 *stop-jbi-component*: Will stop a component (service engine or binding component) on the specified target. If no target is specified, the component will be stopped on the embedded DAS server. 
--echo|-e : true|[false]
--interactive|-I : [true]|false
--terse|-t : true|[false]
--secure|-s : true|[false]
--port|-p : [port number]
--host|-H : [localhost]
--user|-u : [admin user]
--passwordfile : [filename]
--target : [target name]
--help
 component_name: The name of the component to stop.
00004 *shut-down-jbi-component*: Will shut down a component (service engine or binding component) on the specified target. If no target is specified, the component will be shut down on the embedded DAS server. 
--echo|-e : true|[false]
--interactive|-I : [true]|false
--terse|-t : true|[false]
--secure|-s : true|[false]
--force|-F : true|[false]
--port|-p : [port number]
--host|-H : [localhost]
--user|-u : [admin user]
--passwordfile : [filename]
--target : [target name]
--help
 component_name: The name of the component to shut down.
00005 *uninstall-jbi-component*: Will uninstall a component (service engine or binding component) on the specified target. If no target is specified, the component will be uninstall on the embedded DAS server. 
--echo|-e : true|[false]
--interactive|-I : [true]|false
--terse|-t : true|[false]
--secure|-s : true|[false]
--force|-F : true|[false]
--port|-p : [port number]
--keeparchive : true|[false]
--host|-H : [localhost]
--user|-u : [admin user]
--passwordfile : [filename]
--target : [target name]
--help
 component_name: The name of the component to uninstall.
00006 *deploy-jbi-service-assembly*: Will deploy a Service Assembly into the JBI Environment. The Target option (--target) is only relevant for Application Server Enterprise Edition. Please see the Target Option Behavior table for a complete description on how the deploy command will behave for the different target options. 
--echo|-e : true|[false]
--interactive|-I : [true]|false
--terse|-t : true|[false]
--secure|-s : true|[false]
--enabled : true|[false]
--upload : [true]|false
--port|-p : [port number]
--host|-H : [localhost]
--user|-u : [admin user]
--passwordfile : [filename]
--target : [target name]
--help
 file path or service assembly name: The archive file that will contain the service assembly attributes, or the name of the service assembly that has been previously deployed to the domain.
00007 *start-jbi-service-assembly*: Will start a service assemble on the specified target. If a target is not specified, the command will executed against the 'server' instance. 
--echo|-e : true|[false]
--interactive|-I : [true]|false
--terse|-t : true|[false]
--secure|-s : true|[false]
--port|-p : [port number]
--host|-H : [localhost]
--user|-u : [admin user]
--passwordfile : [filename]
--target : [target name]
--help
 component_name: The name of the service assembly to start.
00008 *stop-jbi-service-assembly*: Will start a service assemble on the specified target. If a target is not specified, the command will executed against the 'server' instance. 
--echo|-e : true|[false]
--interactive|-I : [true]|false
--terse|-t : true|[false]
--secure|-s : true|[false]
--port|-p : [port number]
--host|-H : [localhost]
--user|-u : [admin user]
--passwordfile : [filename]
--target : [target name]
--help
 component_name: The name of the service assembly to stop.
00009 *shut-down-jbi-service-assembly*: Will shut down a service assemble on the specified target. If a target is not specified, the command will executed against the 'server' instance. 
--echo|-e : true|[false]
--interactive|-I : [true]|false
--terse|-t : true|[false]
--secure|-s : true|[false]
--port|-p : [port number]
--host|-H : [localhost]
--user|-u : [admin user]
--passwordfile : [filename]
--target : [target name]
--help
 component_name: The name of the service assembly to shut down.
00010 *undeploy-jbi-service-assembly*: Will undeploy a service assemble on the specified target. If a target is not specified, the command will executed against the 'server' instance. 
--echo|-e : true|[false]
--interactive|-I : [true]|false
--terse|-t : true|[false]
--secure|-s : true|[false]
--force|-F : true|[false]
--port|-p : [port number]
--keeparchive : true|[false]
--host|-H : [localhost]
--user|-u : [admin user]
--passwordfile : [filename]
--target : [target name]
--help
 service_assembly_name: The name of the service assembly to undeploy.
00011 *install-jbi-shared-library*: Will install a Shared Library into the JBI Environment. 
--echo|-e : true|[false]
--interactive|-I : [true]|false
--terse|-t : true|[false]
--secure|-s : true|[false]
--port|-p : [port number]
--host|-H : [localhost]
--user|-u : [admin user]
--passwordfile : [filename]
--upload : [true]|false
--target : [target name]
--help
 file path: The archive file that will contain the shared library.
00012 *uninstall-jbi-shared-library*: Command Description Will uninstall a shared library from the specified target instance or cluster. If no target is specified, the shared library will be uninstall on the embedded DAS server. 
--echo|-e : true|[false]
--interactive|-I : [true]|false
--terse|-t : true|[false]
--secure|-s : true|[false]
--force|-F : true|[false]
--port|-p : [port number]
--keeparchive : true|[false]
--host|-H : [localhost]
--user|-u : [admin user]
--passwordfile : [filename]
--target : [target name]
--help
 component_name: The name of the component to start.
00013 *list-jbi-service-engines*: Will list the service engines that have been installed into the JBI Environment. If no filters are specified, the list will contain all service engines that have been installed 
--echo|-e : true|[false]
--interactive|-I : [true]|false
--terse|-t : true|[false]
--secure|-s : true|[false]
--port|-p : [port number]
--host|-H : [localhost]
--user|-u : [admin user]
--passwordfile : [filename]
--lifecyclestate : shutdown|started|stopped
--libraryname : Shared Library Name
--assemblyname : Service Assembly Name
--target : [target name]
--help
 none
00014 *list-jbi-binding-components*: Will list the binding components that have been installed into the JBI Environment. If no filters are specified, the list will contain all binding components that have been installed. 
--echo|-e : true|[false]
--interactive|-I : [true]|false
--terse|-t : true|[false]
--secure|-s : true|[false]
--port|-p : [port number]
--host|-H : [localhost]
--user|-u : [admin user]
--passwordfile : [filename]
--lifecyclestate : shutdown|started|stopped
--libraryname : Shared Library Name
--assemblyname : Service Assembly Name
--target : [target name]
--help
 none
00015 *list-jbi-shared-libraries*: Will list the shared libraries that have been installed into the JBI Environment. If no filters are specified, the list will contain all shared libraries that have been installed 
--echo|-e : true|[false]
--interactive|-I : [true]|false
--terse|-t : true|[false]
--secure|-s : true|[false]
--port|-p : [port number]
--host|-H : [localhost]
--user|-u : [admin user]
--passwordfile : [filename]
--target : [target name]
--componentname : [component name]
--help
 none.
00016 *list-jbi-service-assemblies*: Will list the service assemblies that have been deployed into the JBI Environment. If no filters are specified, the list will contain all service assemblies that have been deployed. 
--echo|-e : true|[false]
--interactive|-I : [true]|false
--terse|-t : true|[false]
--secure|-s : true|[false]
--port|-p : [port number]
--host|-H : [localhost]
--user|-u : [admin user]
--passwordfile : [filename]
--lifecyclestate : shutdown|started|stopped
--componentname : [component name]
--target : [target name]
--help
 none
00017 *show-jbi-service-engine*: Will show the detail information about the specified service engine. 
--echo|-e : true|[false]
--interactive|-I : [true]|false
--terse|-t : true|[false]
--secure|-s : true|[false]
--port|-p : [port number]
--host|-H : [localhost]
--user|-u : [admin user]
--passwordfile : [filename]
--target : [target name]
--help
 Component Name
00018 *show-jbi-binding-component*: Will show the detail information about the specified binding component. 
--echo|-e : true|[false]
--interactive|-I : [true]|false
--terse|-t : true|[false]
--secure|-s : true|[false]
--port|-p : [port number]
--host|-H : [localhost]
--user|-u : [admin user]
--passwordfile : [filename]
--target : [target name]
--help
 Component Name
00019 *show-jbi-shared-library*: Will show the detail information about the specified shared library. 
--echo|-e : true|[false]
--interactive|-I : [true]|false
--terse|-t : true|[false]
--secure|-s : true|[false]
--port|-p : [port number]
--host|-H : [localhost]
--user|-u : [admin user]
--passwordfile : [filename]
--target : [target name]
--help
 Shared Library Name
00020 *show-jbi-service-assembly*: Will show the detail information about the specified service assembly. 
--echo|-e : true|[false]
--interactive|-I : [true]|false
--terse|-t : true|[false]
--secure|-s : true|[false]
--port|-p : [port number]
--host|-H : [localhost]
--user|-u : [admin user]
--passwordfile : [filename]
--target : [target name]
--help
 Service Assembly Name