Red Hat JBoss Fuse

Console Reference

Quick access to the commands used to manage the broker

Red Hat

6.1

Legal Notice

Trademark Disclaimer

The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, MetaMatrix, Fedora, the Infinity Logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Apache, ServiceMix, Camel, CXF, and ActiveMQ are trademarks of Apache Software Foundation. Any other names contained herein may be trademarks of their respective owners.

Legal Notice

Third Party Acknowledgements

One or more products in the Red Hat JBoss Fuse release includes third party components covered by licenses that require that the following documentation notices be provided:
  • JLine (http://jline.sourceforge.net) jline:jline:jar:1.0
    License: BSD (LICENSE.txt) - Copyright (c) 2002-2006, Marc Prud'hommeaux
    All rights reserved.
    Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
    • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
    • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
    • Neither the name of JLine nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  • Stax2 API (http://woodstox.codehaus.org/StAX2) org.codehaus.woodstox:stax2-api:jar:3.1.1
    Copyright (c) <YEAR>, <OWNER> All rights reserved.
    Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
    • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
    • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  • jibx-run - JiBX runtime (http://www.jibx.org/main-reactor/jibx-run) org.jibx:jibx-run:bundle:1.2.3
    License: BSD (http://jibx.sourceforge.net/jibx-license.html) Copyright (c) 2003-2010, Dennis M. Sosnoski.
    All rights reserved.
    Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
    • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
    • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
    • Neither the name of JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  • JavaAssist (http://www.jboss.org/javassist) org.jboss.javassist:com.springsource.javassist:jar:3.9.0.GA:compile
  • HAPI-OSGI-Base Module (http://hl7api.sourceforge.net/hapi-osgi-base/) ca.uhn.hapi:hapi-osgi-base:bundle:1.2
    License: Mozilla Public License 1.1 (http://www.mozilla.org/MPL/MPL-1.1.txt)
02 Dec 2014

Abstract

The primary interface for managing a container is the command console. This reference provides an easy way to see the commands, their syntax, and options.
1. Using the Command Console
2. Shell Console Commands
shell:cat — displays the contents of a file or URL
shell:clear — clears the console buffer
shell:each — execute a closure on a list of arguments
shell:echo — prints arguments to the standard output
shell:exec — executes system processes
shell:grep — displays lines matching a regular expression
shell:head — displays the first lines of a file
shell:history — prints the command history
shell:if — executes an if/then/else block
shell:info — displays system information and statistics about the container
shell:java — execute a Java application
shell:logout — disconnects the shell from the current session
shell:more — displays output as pages of a specified length
shell:new — creates a new Java object of the specified class
shell:printf — formats and prints the specified output
shell:sleep — sleeps for a specified time, then wakes up
shell:sort — writes a sorted concatenation of the specified files to standard output
shell:source — run a shell script
shell:tac — captures the STDIN and returns it as a string and optionally writes the content to a file
shell:tail — displays the last lines of a file
shell:watch — watches and refreshes the output of a command
3. ActiveMQ Console Commands
activemq:browse — displays messages on a specified destination
activemq:bstat — summarizes the statistics for a broker
activemq:list — lists all available brokers in the specified JMX context
activemq:purge — purges messages from a destination
activemq:query — queries the for broker information on specific objects
4. Admin Console Commands
admin:change-opts — changes the Java options of an existing container
admin:change-rmi-registry-port — changes the RMI registry port used by the management layer of a container
admin:change-rmi-server-port — changes the RMI server port used by the management layer of a container
admin:change-ssh-port — changes the secure shell port of a container
admin:clone — clones an existing container instance
admin:connect — connects to an existing container
admin:create — creates a new child container
admin:destroy — destroys a child container
admin:list — list all of the child containers on the current host
admin:rename — renames a child container
admin:start — starts a child container
admin:stop — stops a child container
5. Camel Console Commands
camel:context-info — display detailed information about the specified Camel context
camel:context-list — list all active Camel contexts
camel:context-start — start up the specified Camel context
camel:context-stop — stop the specified Camel context
camel:endpoint-list — lists all deployed Camel endpoints
camel:route-info — display detailed information about the specified Camel route
camel:route-list — list the Camel routes
camel:route-resume — resume the specified Camel route (which was previously suspended)
camel:route-show — display the Camel route definition in XML format
camel:route-start — start the specified Camel route
camel:route-stop — stop the specified Camel route
camel:route-suspend — suspend the specified Camel route
6. Config Console Commands
config:cancel — cancels the changes to the configuration being edited
config:delete — deletes a configuration from the container
config:edit — begins an editing session for a configuration. If the configuration does not exist a new configuration is created.
config:list — lists the existing configurations for the container
config:propappend — appends the given value to an existing property or creates the property with the specified name and value
config:propdel — deletes a property from the configuration being edited
config:proplist — lists the properties in the configuration being edited
config:propset — sets a property in the configuration being edited
config:update — saves the changes made to the configuration being edited and propagates then to the container
7. CXF Console Commands
cxf:list-busses — lists all Apache CXF buses
cxf:list-endpoints — list all active endpoints belonging to the specified Apache CXF bus
cxf:start-endpoint — start the specified Apache CXF endpoint belonging to the specified bus
cxf:stop-endpoint — stop the specified Apache CXF endpoint belonging to the specified bus
8. Dev Console Commands
dev:classloaders — displays a list of leaking bundle classloaders
dev:create-dump — creates a ZIP file containing diagnostic information
dev:dynamic-import — enables/disables dynamic imports for a bundle
dev:framework — enables/disables debugging for an OSGi framework
dev:print-stack-traces — enables/disables printing of full stack traces in the console when the execution of a command throws an exception
dev:restart — restart the container
dev:show-tree — shows the tree of bundles based on the wiring information
dev:threads — shows the threads in the JVM
dev:wait-for-service — wait for the specified OSGi service
dev:watch — watches and automatically updates bundles
9. Fuse Application Bundle(FAB) Console Commands
fab:headers — displays the headers of a FAB
fab:info — display information about a FAB, including the list of shared and unshared dependencies, and the list of features installed as part of the FAB resolution process
fab:start — starts the specified FAB
fab:stop — stops the specified FAB bundle together with its shared transitive dependencies, except for those dependencies that are being used by other bundles.
fab:tree — displays the dependency tree of a FAB
fab:uninstall — uninstall the specified FAB and all of its transitive dependencies, except for those dependencies that are being used by other bundles
10. Fabric Console Commands
fabric:cluster-list — lists the members of a cluster
fabric:cloud-firewall-edit — manage a cloud container's firewall
fabric:cloud-service-add — initialize a cloud provider (which can be used for provisioning containers in the cloud)
fabric:cloud-service-list — list the configured cloud providers
fabric:cloud-service-remove — removes the specified cloud provider
fabric:container-add-profile — Adds the specified list of profiles to a container
fabric:container-change-profile — replaces a fuse container's profiles with the specified list of profiles
fabric:container-connect — connects to a remote Fabric Container and execute the specified command
fabric:container-create-child — create one or more child containers
fabric:container-create-cloud — creates one or more new containers on the cloud
fabric:container-create-ssh — creates one or more new containers through SSH
fabric:container-default-jvm-options — get or set the default JVM options to use when creating a new container
fabric:container-delete — stops and deletes a Fuse Container
fabric:container-domains — lists a container's JMX domains
fabric:container-info — displays information about the specified container
fabric:container-list — lists the containers in a fabric
fabric:container-remove-profile — removes the specified list of profiles from the container
fabric:container-resolver-list — show the resolver policies for the specified containers
fabric:container-resolver-set — specifies how the container reports its address to other containers
fabric:container-rollback — roll back the specified containers to an older version
fabric:container-start — start the specified container
fabric:container-stop — shuts down the specified container
fabric:container-upgrade — upgrade the specified containers to a new version
fabric:create — creates a new fabric and imports fabric profiles
fabric:ensemble-add — extend the current Fabric Ensemble by converting the specified containers into Fuse Servers
fabric:ensemble-list — lists the Fuse Servers in the current Fabric Ensemble
fabric:ensemble-password — display the ensemble password
fabric:ensemble-remove — remove the specified containers from the current ensemble
fabric:export — export the contents of the Fabric Registry to the specified directory in the filesystem
fabric:import — import data either from a filesystem or from a properties file into the Fabric Registry
fabric:join — join a container to an existing fabric
fabric:mq-create — create a new broker profile
10.1. fabric:patch-apply
fabric:profile-change-parents — replace the profile's parents with the specified list of parents (where the parents are specified as a space-separated list)
fabric:profile-copy — copies the specified version of the source profile (where the version defaults to the current default version)
fabric:profile-create — create a new profile with the specified name and version
fabric:profile-delete — delete the specified version of the specified profile (where the version defaults to the current default version)
fabric:profile-display — displays information about the specified version of the specified profile (where the version defaults to the current default version)
fabric:profile-edit — edits the specified version of the specified profile (where the version defaults to the current default version)
fabric:profile-list — lists all profiles that belong to the specified version (where the version defaults to the current default version)
fabric:profile-refresh — performs a change to the profile, that triggers the deployment agent. It's intended to be used for scanning for snapshot changes
fabric:profile-rename — rename the specified version of the source profile (where the version defaults to the current default version)
fabric:require-profile-delete — deletes requirements on the specified profile
fabric:require-profile-list — lists all profile requirements in the current fabric
fabric:require-profile-set — associates requirements with the specified profile
fabric:status — displays the current status of the fabric, based on the configured profile requirements
fabric:version-create — create a new version
fabric:version-delete — delete the specified version
fabric:version-list — lists the existing versions
fabric:version-set-default — set the new default version (must be one of the existing versions)
11. Features Console Commands
features:addurl — registers one or more URLs to feature repositories with the container
features:chooseurl — registers the feature repository URL for a well known project
features:info — show information about the specified feature with the optionally specified version
features:install — installs a feature
features:list — Lists all existing features available from the defined repositories
features:listurl — lists the features repository URLs
features:listVersions — lists all versions of a feature available from the current feature repositories
features:refreshUrl — reloads the list of available features from the repositories
features:removeUrl — removes the specified list of repository URLs from the features service
features:removeRepository — removes the specified repository from the features service
features:uninstall — uninstalls a feature with the specified name and version
12. JAAS Console Commands
jass:cancel — cancels a JAAS editing session without applying the pending changes
jaas:manage — opens a JAAS realm for editing
jaas:pending — lists the changes waiting to be applied to the realm being edited
jaas:realms — lists the JAAS realms know to the container
jaas:roleadd — adds a role to a user
jaas:roledel — deletes a role from a user
jaas:update — applies all pending changes to the JAAS realm and closes the editing session
jaas:useradd — adds a user to the JAAS realm being edited
jaas:userdel — deletes a user from the JAAS realm being edited
jaas:users — lists the users in the JAAS realm being edited
13. JBI Console Commands
jbi:list — lists JBI endpoints
jbi:shutdown — shuts down a JBI artifact
jbi:start — starts a JBI artifact
jbi:stop — stops a JBI artifact
14. Log Console Commands
log:clear — clears the log
log:display — displays log entries
log:display-exception — displays the last thrown exception from the log
log:get — shows the log level
log:set — sets the log level
log:tail — continually displays log entries
15. The nmr:list Command
nmr:list — lists NMR endpoints
16. OBR Console Commands
obr:addUrl — adds a list of repository URLs to the OBR service
obr:deploy — deploys a list of bundles using the OBR service
obr:info — prints information about OBR bundles
obr:list — lists OBR bundles
obr:listUrl — displays the repository URLs currently associated with the OBR service
obr:refreshUrl — reloads the repositories to obtain a fresh list of bundles
obr:removeUrl — removes a list of repository URLs from the OBR service
obr:source — downloads the sources for an OBR bundle
obr:start — deploys and starts a list of bundles using OBR
17. OSGi Console Commands
osgi:bundle-level — gets or sets the start level of a given bundle
osgi:bundle-services — lists the OSGi services provided by a bundle
osgi:classes — lists all of the classes in the specified bundle or bundles
osgi:find-class — locates a specified class in any deployed bundle
osgi:headers — displays the headers of a specified OSGi bundle
osgi:info — displays detailed information about OSGi bundles
osgi:install — installs one or more OSGi bundles
osgi:list — lists the installed bundles whose start level equals or exceeds the specified threshold
osgi:ls — lists OSGi services
osgi:refresh — refreshes an OSGi bundle
osgi:resolve — resolves an OSGi bundle's dependencies
osgi:restart — stops and restarts an OSGi bundle
osgi:shutdown — stops the OSGi framework
osgi:start — starts an OSGi bundle
osgi:start-level — gets or sets the OSGi framework's active start level
osgi:stop — stops an OSGi bundle
osgi:uninstall — uninstalls an OSGi bundle
osgi:update — updates an OSGi bundle
18. Packages Console Commands
packages:exports — displays the packages exported OSGi bundles
packages:imports — displays the packages imported by OSGi bundles
19. Patch Console Commands
patch:add — download a patch file from a remote location and places the relevant JAR files in the container's system directory
patch:install — installs a patch that was previously downloaded
patch:list — lists all known patches, showing the patch name and status (installed or not)
patch:rollback — reverses a patch installation
patch:simulate — logs all of the actions that would be performed during a patch install, without actually performing the install
20. Service Component Runtime (SCR) Console Commands
scr:activate — activate the specified SCR component
scr:deactivate — deactivate the specified SCR component
scr:details — show details for the specified SCR component
scr:list — list all of the components defined using the OSGi Declarative Services framework
21. SSH Console Commands
ssh:ssh — connects to a remote SSH server
ssh:sshd — creates an SSH server
22. Web Console Commands
web:list — lists the WARs deployed in the container
23. The wrapper:install Command
wrapper:install — installs the container as a system service in the operating system
24. ZooKeeper Console Commands
zk:create — create a znode
zk:delete — delete the specified znode
zk:get — get a znode's data
zk:list — list a znode's children
zk:set — set a znode's data