Apache Karaf Console Reference

Chapter 1. bundle

1.1. bundle:capabilities

1.1.1. Description

Displays OSGi capabilities of a given bundles.

1.1.2. Syntax

bundle:capabilities [options] [ids]

1.1.3. Arguments

Name	Description
ids	The list of bundle (identified by IDs or name or name/version) separated by whitespaces

1.1.4. Options

Name	Description
--help	Display this help message
--namespace
--context, -c	Use the given bundle context

1.2. bundle:classes

1.2.1. Description

Displays a list of classes/resources contained in the bundle

1.2.2. Syntax

bundle:classes [options] [ids]

1.2.3. Arguments

Name	Description
ids	The list of bundle (identified by IDs or name or name/version) separated by whitespaces

1.2.4. Options

Name	Description
--help	Display this help message
-a, --display-all-files	List all classes and files in the bundle
--context, -c	Use the given bundle context

1.3. bundle:diag

1.3.1. Description

Displays diagnostic information why a bundle is not Active

1.3.2. Syntax

bundle:diag [options] [ids]

1.3.3. Arguments

Name	Description
ids	The list of bundle (identified by IDs or name or name/version) separated by whitespaces

1.3.4. Options

Name	Description
--help	Display this help message
--context, -c	Use the given bundle context

1.4. bundle:dynamic-import

1.4.1. Description

Enables/disables dynamic-import for a given bundle.

1.4.2. Syntax

bundle:dynamic-import [options] id

1.4.3. Arguments

Name	Description
id	The bundle ID or name or name/version

1.4.4. Options

Name	Description
--help	Display this help message
--context	Use the given bundle context

1.5. bundle:find-class

1.5.1. Description

Locates a specified class in any deployed bundle

1.5.2. Syntax

bundle:find-class [options] className

1.5.3. Arguments

Name	Description
className	Class name or partial class name to be found

1.5.4. Options

Name	Description
--help	Display this help message

1.6. bundle:headers

1.6.1. Description

Displays OSGi headers of a given bundles.

1.6.2. Syntax

bundle:headers [options] [ids]

1.6.3. Arguments

Name	Description
ids	The list of bundle (identified by IDs or name or name/version) separated by whitespaces

1.6.4. Options

Name	Description
--help	Display this help message
--no-uses	Print or not the Export-Package uses section
--indent	Indentation method
--context, -c	Use the given bundle context

1.7. bundle:id

1.7.1. Description

Gets the bundle ID.

1.7.2. Syntax

bundle:id [options] id

1.7.3. Arguments

Name	Description
id	The bundle ID or name or name/version

1.7.4. Options

Name	Description
--help	Display this help message
--context	Use the given bundle context

1.8. bundle:info

1.8.1. Description

Displays detailed information of a given bundles.

1.8.2. Syntax

bundle:info [options] [ids]

1.8.3. Arguments

Name	Description
ids	The list of bundle (identified by IDs or name or name/version) separated by whitespaces

1.8.4. Options

Name	Description
--help	Display this help message
--context, -c	Use the given bundle context

1.9. bundle:install

1.9.1. Description

Installs one or more bundles.

1.9.2. Syntax

bundle:install [options] urls

1.9.3. Arguments

Name	Description
urls	Bundle URLs separated by whitespaces

1.9.4. Options

Name	Description
-l, --start-level	Sets the start level of the bundles
--help	Display this help message
--force, -f	Forces the command to execute
--r3-bundles	Allow OSGi R3 bundles without the `Bundle-ManifestVersion: 2` header.
-s, --start	Starts the bundles after installation

1.10. bundle:list

1.10.1. Description

Lists all installed bundles.

1.10.2. Syntax

bundle:list [options] [ids]

1.10.3. Arguments

Name	Description
ids	The list of bundle (identified by IDs or name or name/version) separated by whitespaces

1.10.4. Options

Name	Description
-name, -n	Show bundle name
--help	Display this help message
-u	Shows the update locations
-r	Shows the bundle revisions
--no-ellipsis
-l	Show the locations
-s	Shows the symbolic name
--context, -c	Use the given bundle context
-t	Specifies the bundle threshold; bundles with a start-level less than this value will not get printed out.
--no-format	Disable table rendered output

1.11. bundle:load-test

1.11.1. Description

Load test bundle lifecycle

1.11.2. Syntax

bundle:load-test [options]

1.11.3. Options

Name	Description
--help	Display this help message
--refresh	percentage of bundle refresh vs restart
--excludes	List of bundles (ids or symbolic names) to exclude
--iterations	number of iterations per thread
--delay	maximum delay between actions
--threads	number of concurrent threads

1.12. bundle:refresh

1.12.1. Description

Refresh bundles.

1.12.2. Syntax

bundle:refresh [options] [ids]

1.12.3. Arguments

Name	Description
ids	The list of bundle (identified by IDs or name or name/version) separated by whitespaces

1.12.4. Options

Name	Description
--help	Display this help message
--context, -c	Use the given bundle context

1.13. bundle:requirements

1.13.1. Description

Displays OSGi requirements of a given bundles.

1.13.2. Syntax

bundle:requirements [options] [ids]

1.13.3. Arguments

Name	Description
ids	The list of bundle (identified by IDs or name or name/version) separated by whitespaces

1.13.4. Options

Name	Description
--help	Display this help message
--namespace
--context, -c	Use the given bundle context

1.14. bundle:resolve

1.14.1. Description

Resolve bundles.

1.14.2. Syntax

bundle:resolve [options] [ids]

1.14.3. Arguments

Name	Description
ids	The list of bundle (identified by IDs or name or name/version) separated by whitespaces

1.14.4. Options

Name	Description
--help	Display this help message
--context, -c	Use the given bundle context

1.15. bundle:restart

1.15.1. Description

Restarts bundles.

1.15.2. Syntax

bundle:restart [options] [ids]

1.15.3. Arguments

Name	Description
ids	The list of bundle (identified by IDs or name or name/version) separated by whitespaces

1.15.4. Options

Name	Description
--help	Display this help message
--context, -c	Use the given bundle context

1.16. bundle:services

1.16.1. Description

Lists OSGi services per Bundle

1.16.2. Syntax

bundle:services [options] [ids]

1.16.3. Arguments

Name	Description
ids	The list of bundle (identified by IDs or name or name/version) separated by whitespaces

1.16.4. Options

Name	Description
--help	Display this help message
-p	Shows the properties of the services
-u	Shows the services each bundle uses. (By default the provided services are shown)
--context, -c	Use the given bundle context
-a	Shows all services. (Karaf commands and completers are hidden by default)

1.17. bundle:start-level

1.17.1. Description

Gets or sets the start level of a bundle.

1.17.2. Syntax

bundle:start-level [options] id [startLevel]

1.17.3. Arguments

Name	Description
id	The bundle ID or name or name/version
startLevel	The bundle’s new start level

1.17.4. Options

Name	Description
--help	Display this help message
--context	Use the given bundle context

1.18. bundle:start

1.18.1. Description

Starts bundles.

1.18.2. Syntax

bundle:start [options] [ids]

1.18.3. Arguments

Name	Description
ids	The list of bundle (identified by IDs or name or name/version) separated by whitespaces

1.18.4. Options

Name	Description
--help	Display this help message
-t, --transient	Keep the bundle as auto-start
--context, -c	Use the given bundle context

1.19. bundle:status

1.19.1. Description

Get the bundle current status

1.19.2. Syntax

bundle:status [options] id

1.19.3. Arguments

Name	Description
id	The bundle ID or name or name/version

1.19.4. Options

Name	Description
--help	Display this help message
--context	Use the given bundle context

1.20. bundle:stop

1.20.1. Description

Stop bundles.

1.20.2. Syntax

bundle:stop [options] [ids]

1.20.3. Arguments

Name	Description
ids	The list of bundle (identified by IDs or name or name/version) separated by whitespaces

1.20.4. Options

Name	Description
--help	Display this help message
-t, --transient	Keep the bundle as auto-start
--context, -c	Use the given bundle context

1.21. bundle:tree-show

1.21.1. Description

Shows the tree of bundles based on the wiring information.

1.21.2. Syntax

bundle:tree-show [options] id

1.21.3. Arguments

Name	Description
id	The bundle ID or name or name/version

1.21.4. Options

Name	Description
--help	Display this help message
-v, --version	Show bundle versions
--context	Use the given bundle context

1.22. bundle:uninstall

1.22.1. Description

Uninstall bundles.

1.22.2. Syntax

bundle:uninstall [options] [ids]

1.22.3. Arguments

Name	Description
ids	The list of bundle (identified by IDs or name or name/version) separated by whitespaces

1.22.4. Options

Name	Description
--help	Display this help message
--context, -c	Use the given bundle context

1.23. bundle:update

1.23.1. Description

Update bundle.

1.23.2. Syntax

bundle:update [options] id [location]

1.23.3. Arguments

Name	Description
id	The bundle ID or name or name/version
location	The bundles update location

1.23.4. Options

Name	Description
--help	Display this help message
--context	Use the given bundle context
--raw	Do not update the bundles’s Bundle-UpdateLocation manifest header
-r, --refresh	Perform a refresh after the bundle update

1.24. bundle:watch

1.24.1. Description

Watches and updates bundles

1.24.2. Syntax

bundle:watch [options] [urls]

1.24.3. Arguments

Name	Description
urls	The bundle IDs or URLs

1.24.4. Options

Name	Description
-i	Watch interval
--help	Display this help message
--stop	Stops watching all bundles
--remove	Removes bundles from the watch list
--start	Starts watching the selected bundles
--list	Displays the watch list

1.24.5. Details

Watches the local maven repo for changes in snapshot jars and redploys changed jars

Chapter 2. camel

2.1. camel:component-list

2.1.1. Description

Lists all Camel components that are in use in Karaf.

2.1.2. Syntax

camel:component-list [options] name

2.1.3. Arguments

Name	Description
name	The Camel context name where to look for the components

2.1.4. Options

Name	Description
--help	Display this help message
--verbose, -v	Verbose output which shows more information

2.2. camel:context-inflight

2.2.1. Description

List inflight exchanges.

2.2.2. Syntax

camel:context-inflight [options] name [route]

2.2.3. Arguments

Name	Description
name	The Camel context name
route	The Camel route ID

2.2.4. Options

Name	Description
--help	Display this help message
--limit, -l	To limit the number of exchanges shown
--sort, -s	true = sort by longest duration, false = sort by exchange id

2.3. camel:context-info

2.3.1. Description

Display detailed information about a Camel context.

2.3.2. Syntax

camel:context-info [options] name

2.3.3. Arguments

Name	Description
name	The name of the Camel context

2.3.4. Options

Name	Description
--help	Display this help message
--verbose, -v	Verbose output

2.4. camel:context-list

2.4.1. Description

Lists all Camel contexts.

2.4.2. Syntax

camel:context-list [options]

2.4.3. Options

Name	Description
--help	Display this help message

2.5. camel:context-resume

2.5.1. Description

Resumes a Camel context.

2.5.2. Syntax

camel:context-resume [options] context

2.5.3. Arguments

Name	Description
context	The name of the Camel context.

2.5.4. Options

Name	Description
--help	Display this help message

2.6. camel:context-start

2.6.1. Description

Start a Camel context.

2.6.2. Syntax

camel:context-start [options] context

2.6.3. Arguments

Name	Description
context	The name of the Camel context.

2.6.4. Options

Name	Description
--help	Display this help message

2.7. camel:context-stop

2.7.1. Description

Stop a Camel context. It becomes unavailable and can not be started again.

2.7.2. Syntax

camel:context-stop [options] context

2.7.3. Arguments

Name	Description
context	The name of the Camel context.

2.7.4. Options

Name	Description
--help	Display this help message

2.8. camel:context-suspend

2.8.1. Description

Suspends a Camel context.

2.8.2. Syntax

camel:context-suspend [options] context

2.8.3. Arguments

Name	Description
context	The name of the Camel context.

2.8.4. Options

Name	Description
--help	Display this help message

2.9. camel:eip-explain

2.9.1. Description

Explain the EIP in the CamelContext

2.9.2. Syntax

camel:eip-explain [options] name nameOrId

2.9.3. Arguments

Name	Description
name	The name of the Camel context
nameOrId	The name of the EIP or a node id to refer to a specific node from the routes

2.9.4. Options

Name	Description
--verbose, -v	Verbose output to explain all options
--help	Display this help message

2.10. camel:endpoint-explain

2.10.1. Description

Explain all Camel endpoints available in the CamelContext

2.10.2. Syntax

camel:endpoint-explain [options] name

2.10.3. Arguments

Name	Description
name	The name of the Camel context

2.10.4. Options

Name	Description
--verbose, -v	Verbose output to explain all options
--help	Display this help message
--filter, -f	To filter endpoints by pattern

2.11. camel:endpoint-list

2.11.1. Description

Lists Camel endpoints

2.11.2. Syntax

camel:endpoint-list [options] [name]

2.11.3. Arguments

Name	Description
name	The name of the Camel context or a wildcard expression

2.11.4. Options

Name	Description
--help	Display this help message
--verbose, -v	Verbose output which does not limit the length of the uri shown, or to explain all options (if explain selected)
--explain, -e	Whether to explain the endpoint options
--decode, -d	Whether to decode the endpoint uri so its human readable

2.12. camel:endpoint-stats

2.12.1. Description

Display endpoint runtime statistics

2.12.2. Syntax

camel:endpoint-stats [options] [name]

2.12.3. Arguments

Name	Description
name	The name of the Camel context (support wildcard)

2.12.4. Options

Name	Description
--help	Display this help message
--filter, -f	Filter the list by in,out,static,dynamic
--decode, -d	Whether to decode the endpoint uri so its human readable

2.13. camel:rest-api-doc

2.13.1. Description

List the Camel REST services API documentation (requires camel-openapi-java on classpath)

2.13.2. Syntax

camel:rest-api-doc [options] name

2.13.3. Arguments

Name	Description
name	The Camel context name where to look for the REST services

2.13.4. Options

Name	Description
--help	Display this help message

2.14. camel:rest-registry-list

2.14.1. Description

Lists all Camel REST services enlisted in the Rest Registry from a CamelContext

2.14.2. Syntax

camel:rest-registry-list [options] name

2.14.3. Arguments

Name	Description
name	The Camel context name where to look for the REST services

2.14.4. Options

Name	Description
--help	Display this help message
--verbose, -v	Verbose output which does not limit the length of the uri shown
--decode, -d	Whether to decode the endpoint uri so its human readable

2.15. camel:rest-show

2.15.1. Description

Display the Camel REST definition in XML

2.15.2. Syntax

camel:rest-show [options] name

2.15.3. Arguments

Name	Description
name	The name of the Camel context

2.15.4. Options

Name	Description
--help	Display this help message

2.16. camel:route-info

2.16.1. Description

Display information about a Camel route.

2.16.2. Syntax

camel:route-info [options] context route

2.16.3. Arguments

Name	Description
context	The Camel context name.
route	The Camel route ID or a wildcard expression

2.16.4. Options

Name	Description
--help	Display this help message

2.17. camel:route-list

2.17.1. Description

List Camel routes.

2.17.2. Syntax

camel:route-list [options] [name]

2.17.3. Arguments

Name	Description
name	The Camel context name where to look for the route

2.17.4. Options

Name	Description
--help	Display this help message

2.18. camel:route-profile

2.18.1. Description

Display profile information about Camel route(s).

2.18.2. Syntax

camel:route-profile [options] context route

2.18.3. Arguments

Name	Description
context	The Camel context name.
route	The Camel route ID or a wildcard expression

2.18.4. Options

Name	Description
--help	Display this help message

2.19. camel:route-reset-stats

2.19.1. Description

Reset route performance stats from a CamelContext

2.19.2. Syntax

camel:route-reset-stats [options] context

2.19.3. Arguments

Name	Description
context	The name of the Camel context.

2.19.4. Options

Name	Description
--help	Display this help message

2.20. camel:route-resume

2.20.1. Description

Resume a Camel route

2.20.2. Syntax

camel:route-resume [options] context route

2.20.3. Arguments

Name	Description
context	The Camel context name.
route	The Camel route ID or a wildcard expression

2.20.4. Options

Name	Description
--help	Display this help message

2.21. camel:route-show

2.21.1. Description

Display the Camel route definition in XML

2.21.2. Syntax

camel:route-show [options] context route

2.21.3. Arguments

Name	Description
context	The Camel context name.
route	The Camel route ID or a wildcard expression

2.21.4. Options

Name	Description
--help	Display this help message

2.22. camel:route-start

2.22.1. Description

Start a Camel route

2.22.2. Syntax

camel:route-start [options] context route

2.22.3. Arguments

Name	Description
context	The Camel context name.
route	The Camel route ID or a wildcard expression

2.22.4. Options

Name	Description
--help	Display this help message

2.23. camel:route-stop

2.23.1. Description

Stop a Camel route

2.23.2. Syntax

camel:route-stop [options] context route

2.23.3. Arguments

Name	Description
context	The Camel context name.
route	The Camel route ID or a wildcard expression

2.23.4. Options

Name	Description
--help	Display this help message

2.24. camel:route-suspend

2.24.1. Description

Suspend a Camel route

2.24.2. Syntax

camel:route-suspend [options] context route

2.24.3. Arguments

Name	Description
context	The Camel context name.
route	The Camel route ID or a wildcard expression

2.24.4. Options

Name	Description
--help	Display this help message

Chapter 3. config

3.1. config:cancel

3.1.1. Description

Cancels the changes to the configuration being edited.

3.1.2. Syntax

config:cancel [options]

3.1.3. Options

Name	Description
--help	Display this help message

3.2. config:delete

3.2.1. Description

Delete a configuration.

3.2.2. Syntax

config:delete [options] pid

3.2.3. Arguments

Name	Description
pid	PID of the configuration

3.2.4. Options

Name	Description
--help	Display this help message
--force	Force the edition of this config, even if another one was under edition

3.3. config:edit

3.3.1. Description

Creates or edits a configuration.

3.3.2. Syntax

config:edit [options] pid

3.3.3. Arguments

Name	Description
pid	PID of the configuration or of the factory if --factory is given. Pid can also be specified as ldap query

3.3.4. Options

Name	Description
--help	Display this help message
--alias	Specifies the alias used for this factory config.
--factory	Define this config as a factory config. Will be created on calling update
--force	Force the edition of this config, even if another one was under edition

3.3.5. Details

classpath:edit.txt

3.4. config:install

3.4.1. Description

Install a cfg file in the Karaf etc folder.

3.4.2. Syntax

config:install [options] url finalname

3.4.3. Arguments

Name	Description
url	The URL of the cfg file.
finalname	Final name of the cfg file

3.4.4. Options

Name	Description
-o, --override	Override the target cfg file
--help	Display this help message

3.5. config:list

3.5.1. Description

Lists existing configurations.

3.5.2. Syntax

config:list [options] [query]

3.5.3. Arguments

Name	Description
query	Query in LDAP syntax. Example: "(service.pid=org.apache.karaf.log)"

3.5.4. Options

Name	Description
--help	Display this help message

3.6. config:meta

3.6.1. Description

Lists meta type information.

3.6.2. Syntax

config:meta [options] pid

3.6.3. Arguments

Name	Description
pid	The configuration pid

3.6.4. Options

Name	Description
--help	Display this help message
-c	Create respective config from metatype defaults

3.7. config:property-append

3.7.1. Description

Appends the given value to an existing property or creates the property with the specified name and value.

3.7.2. Syntax

config:property-append [options] name value

3.7.3. Arguments

Name	Description
name	The name of the property
value	The value to append to the property

3.7.4. Options

Name	Description
--help	Display this help message
-p, --pid	The configuration pid

3.8. config:property-delete

3.8.1. Description

Deletes a property from the configuration being edited.

3.8.2. Syntax

config:property-delete [options] property

3.8.3. Arguments

Name	Description
property	The name of the property to delete

3.8.4. Options

Name	Description
--help	Display this help message
-p, --pid	The configuration pid

3.9. config:property-get

3.9.1. Description

Gets the value of a property in the currently edited configuration.

3.9.2. Syntax

config:property-get [options] property

3.9.3. Arguments

Name	Description
property	The name of the property to get value for

3.9.4. Options

Name	Description
--help	Display this help message
--raw
-p, --pid	The configuration pid

3.10. config:property-list

3.10.1. Description

Lists properties from the currently edited configuration.

3.10.2. Syntax

config:property-list [options]

3.10.3. Options

Name	Description
--help	Display this help message
--raw
-p, --pid	The configuration pid

3.11. config:property-set

3.11.1. Description

Sets a property in the currently edited configuration.

3.11.2. Syntax

config:property-set [options] property value

3.11.3. Arguments

Name	Description
property	The name of the property to set
value	The value of the property

3.11.4. Options

Name	Description
--help	Display this help message
-p, --pid	The configuration pid

3.12. config:update

3.12.1. Description

Saves and propagates changes from the configuration being edited.

3.12.2. Syntax

config:update [options]

3.12.3. Options

Name	Description
--help	Display this help message

Chapter 4. cxf

4.1. cxf:list-busses

4.1.1. Description

Lists all CXF Busses.

4.1.2. Syntax

cxf:list-busses [options]

4.1.3. Options

Name	Description
--help	Display this help message
--no-format	Disable table rendered output

4.2. cxf:list-endpoints

4.2.1. Description

Lists all CXF Endpoints on a Bus.

4.2.2. Syntax

cxf:list-endpoints [options] [bus]

4.2.3. Arguments

Name	Description
bus	The CXF bus name where to look for the Endpoints

4.2.4. Options

Name	Description
--help	Display this help message
-f, --fulladdress	Display full address of an endpoint
--no-format	Disable table rendered output

4.3. cxf:start-endpoint

4.3.1. Description

Starts a CXF Endpoint on a Bus.

4.3.2. Syntax

cxf:start-endpoint [options] bus endpoint

4.3.3. Arguments

Name	Description
bus	The CXF bus name where to look for the Endpoint
endpoint	The Endpoint name to start

4.3.4. Options

Name	Description
--help	Display this help message

4.4. cxf:stop-endpoint

4.4.1. Description

Stops a CXF Endpoint on a Bus.

4.4.2. Syntax

cxf:stop-endpoint [options] bus endpoint

4.4.3. Arguments

Name	Description
bus	The CXF bus name where to look for the Endpoint
endpoint	The Endpoint name to stop

4.4.4. Options

Name	Description
--help	Display this help message

Chapter 5. dev

5.1. dev:dump-create

5.1.1. Description

Creates zip archive with diagnostic info.

5.1.2. Syntax

dev:dump-create [options] [name]

5.1.3. Arguments

Name	Description
name	Name of created zip or directory

5.1.4. Options

Name	Description
--help	Display this help message
--no-heap-dump	Include or not the heap dump in ZIP archive
--no-thread-dump	Include or not the thread dump in ZIP archive
-d, --directory	Creates dump in a directory in place of a ZIP archive

Chapter 6. feature

6.1. feature:export-bundles

6.1.1. Description

Export all of the bundles that make up a specified feature to a directory on the file system.

6.1.2. Syntax

feature:export-bundles [options] featureName exportLocation

6.1.3. Arguments

Name	Description
featureName	The name of the feature you want to export bundles for
exportLocation	Where you want to export the bundles

6.1.4. Options

Name	Description
-d, --dependencies-only	This flag indicates that only bundles marked as a dependency will be exported.
--help	Display this help message
-v, --version	The version of the feature you want to export bundles for. Default is latest

6.2. feature:info

6.2.1. Description

Shows information about selected feature.

6.2.2. Syntax

feature:info [options] name [version]

6.2.3. Arguments

Name	Description
name	The name of the feature
version	The version of the feature

6.2.4. Options

Name	Description
--help	Display this help message
-d, --dependency	Display dependencies info
-b, --bundle	Display bundles info
-t, --tree	Display feature tree
-c, --configuration	Display configuration info
-x, --xml	Display feature xml
--conditional	Display conditional info
--color	Colorize output (`always', `never' or `auto')

6.3. feature:install

6.3.1. Description

Installs a feature with the specified name and version.

6.3.2. Syntax

feature:install [options] features

6.3.3. Arguments

Name	Description
features	The name and version of the features to install. A feature id looks like name/version. The version is optional.

6.3.4. Options

Name	Description
-t, --simulate	Perform a simulation only
--features-wiring	Print the wiring between features
--help	Display this help message
-v, --verbose	Explain what is being done
--all-wiring	Print the full wiring
--store	Store the resolution into the given file and result for offline analysis
-u, --upgrade	Perform an upgrade of feature if previous version are installed or install it
-r, --no-auto-refresh	Do not automatically refresh bundles
-s, --no-auto-start	Do not start the bundles
-m, --no-auto-manage	Do not automatically manage bundles
-g, --region	Region to install to

6.4. feature:list

6.4.1. Description

Lists all existing features available from the defined repositories.

6.4.2. Syntax

feature:list [options]

6.4.3. Options

Name	Description
-i, --installed	Display a list of all installed features only
-s, --show-hidden	Display hidden features
--help	Display this help message
-o, --ordered	Display a list using alphabetical order
-b, --show-blacklisted	Display blacklisted features
-r, --required	Display a list of all required features only
--no-format	Disable table rendered output

6.5. feature:regions

6.5.1. Description

Prints information about region digraph.

6.5.2. Syntax

feature:regions [options] [regions]

6.5.3. Arguments

Name	Description
regions	Regions to provide detailed info for.

6.5.4. Options

Name	Description
--help	Display this help message
-n, --namespaces	Show namespaces in each filter.
-f, --filters	Show filters.
-v, --verbose	Show all info.
-b, --bundles	Show bundles in each region.

6.6. feature:refresh

6.6.1. Description

Reloads features processing instructions and reprovisions existing features.

6.6.2. Syntax

feature:refresh [options]

6.6.3. Options

Name	Description
-t, --simulate	Perform a simulation only
--features-wiring	Print the wiring between features
--help	Display this help message
-v, --verbose	Explain what is being done
--all-wiring	Print the full wiring

6.7. feature:repo-add

6.7.1. Description

Add a features repository

6.7.2. Syntax

feature:repo-add [options] name/url [version]

6.7.3. Arguments

Name	Description
name/url	Shortcut name of the features repository or the full URL
version	The version of the features repository if using features repository name as first argument. It should be empty if using the URL

6.7.4. Options

Name	Description
--help	Display this help message
-i, --install	Install all features contained in the features repository

6.8. feature:repo-list

6.8.1. Description

Displays a list of all defined repositories.

6.8.2. Syntax

feature:repo-list [options]

6.8.3. Options

Name	Description
--help	Display this help message
-r	Reload all feature urls
-b, --show-blacklisted	Also display blacklisted repositories
--no-format	Disable table rendered output

6.9. feature:repo-refresh

6.9.1. Description

Refresh a features repository

6.9.2. Syntax

feature:repo-refresh [options] [repository] [Feature version]

6.9.3. Arguments

Name	Description
repository	Shortcut name of the feature repository or the full URI
Feature version	The version of the feature if using the feature name. Should be empty if using the uri

6.9.4. Options

Name	Description
--help	Display this help message

6.10. feature:repo-remove

6.10.1. Description

Removes the specified repository features service.

6.10.2. Syntax

feature:repo-remove [options] repository [Feature version]

6.10.3. Arguments

Name	Description
repository	Shortcut name of the feature repository or the full URI
Feature version	The version of the feature if using the feature name. Should be empty if using the uri

6.10.4. Options

Name	Description
--help	Display this help message
-u, --uninstall-all	Uninstall all features from the repository

6.11. feature:requirement-add

6.11.1. Description

Add provisioning requirements.

6.11.2. Syntax

feature:requirement-add [options] requirements

6.11.3. Arguments

Name	Description
requirements

6.11.4. Options

Name	Description
-t, --simulate	Perform a simulation only
--features-wiring	Print the wiring between features
--help	Display this help message
-v, --verbose	Explain what is being done
--all-wiring	Print the full wiring
--store	Store the resolution into the given file and result for offline analysis
-r, --no-auto-refresh	Do not automatically refresh bundles
-s, --no-auto-start	Do not start the bundles
-m, --no-auto-manage	Do not automatically manage bundles
-g, --region	Region to install to

6.12. feature:requirement-list

6.12.1. Description

List provisioning requirements.

6.12.2. Syntax

feature:requirement-list [options]

6.12.3. Options

Name	Description
--help	Display this help message
--no-format	Disable table rendered output

6.13. feature:requirement-remove

6.13.1. Description

Remove provisioning requirements.

6.13.2. Syntax

feature:requirement-remove [options] requirements

6.13.3. Arguments

Name	Description
requirements

6.13.4. Options

Name	Description
-t, --simulate	Perform a simulation only
--features-wiring	Print the wiring between features
--help	Display this help message
-g, --region	Region to apply to
-v, --verbose	Explain what is being done
--all-wiring	Print the full wiring
--store	Store the resolution into the given file and result for offline analysis
-r, --no-auto-refresh	Do not automatically refresh bundles
-s, --no-auto-start	Do not start the bundles
-m, --no-auto-manage	Do not automatically manage bundles

6.14. feature:start

6.14.1. Description

Start features with the specified name and version.

6.14.2. Syntax

feature:start [options] feature

6.14.3. Arguments

Name	Description
feature	The name and version of the features to start. A feature id looks like name/version.

6.14.4. Options

Name	Description
-t, --simulate	Perform a simulation only
--help	Display this help message
-g, --region	Region to apply to
-v, --verbose	Explain what is being done

6.15. feature:stop

6.15.1. Description

Stop features with the specified name and version.

6.15.2. Syntax

feature:stop [options] feature

6.15.3. Arguments

Name	Description
feature	The name and version of the features to stop. A feature id looks like name/version.

6.15.4. Options

Name	Description
-t, --simulate	Perform a simulation only
--help	Display this help message
-g, --region	Region to apply to
-v, --verbose	Explain what is being done

6.16. feature:uninstall

6.16.1. Description

Uninstalls a feature with the specified name and version.

6.16.2. Syntax

feature:uninstall [options] features

6.16.3. Arguments

Name	Description
features	The name and version of the features to uninstall. A feature id looks like name/version. The version is optional.

6.16.4. Options

Name	Description
-t, --simulate	Perform a simulation only
--help	Display this help message
-v, --verbose	Explain what is being done
-r, --no-auto-refresh	Do not automatically refresh bundles
-g, --region	Region to install to

6.17. feature:version-list

6.17.1. Description

Lists all versions of a feature available from the currently available repositories.

6.17.2. Syntax

feature:version-list [options] feature

6.17.3. Arguments

Name	Description
feature	Name of feature.

6.17.4. Options

Name	Description
--help	Display this help message
--no-format	Disable table rendered output

Chapter 7. http

7.1. http:proxies

7.1.1. Description

List the HTTP proxies

7.1.2. Syntax

http:proxies [options]

7.1.3. Options

Name	Description
--help	Display this help message

7.2. http:proxy-add

7.2.1. Description

Add a new HTTP proxy

7.2.2. Syntax

http:proxy-add [options] url proxyTo

7.2.3. Arguments

Name	Description
url	HTTP proxy URL
proxyTo	HTTP location to proxy on the prefix

7.2.4. Options

Name	Description
--help	Display this help message

7.3. http:proxy-remove

7.3.1. Description

Remove an existing HTTP proxy

7.3.2. Syntax

http:proxy-remove [options] prefix

7.3.3. Arguments

Name	Description
prefix	The HTTP proxy prefix

7.3.4. Options

Name	Description
--help	Display this help message

Chapter 8. jaas

8.1. jaas:cancel

8.1.1. Description

Cancel the modification of a JAAS realm

8.1.2. Syntax

jaas:cancel [options]

8.1.3. Options

Name	Description
--help	Display this help message

8.2. jaas:group-add

8.2.1. Description

Make a user part of a group

8.2.2. Syntax

jaas:group-add [options] username group

8.2.3. Arguments

Name	Description
username	Username
group	Group

8.2.4. Options

Name	Description
--help	Display this help message

8.3. jaas:group-create

8.3.1. Description

create a group in a realm

8.3.2. Syntax

jaas:group-create [options] group

8.3.3. Arguments

Name	Description
group	Group

8.3.4. Options

Name	Description
--help	Display this help message

8.4. jaas:group-delete

8.4.1. Description

Remove a user from a group

8.4.2. Syntax

jaas:group-delete [options] username group

8.4.3. Arguments

Name	Description
username	Username
group	Group

8.4.4. Options

Name	Description
--help	Display this help message

8.5. jaas:group-list

8.5.1. Description

List groups in a realm

8.5.2. Syntax

jaas:group-list [options]

8.5.3. Options

Name	Description
--help	Display this help message

8.6. jaas:group-role-add

8.6.1. Description

Add a role to a group

8.6.2. Syntax

jaas:group-role-add [options] group role

8.6.3. Arguments

Name	Description
group	Group
role	Role

8.6.4. Options

Name	Description
--help	Display this help message

8.7. jaas:group-role-delete

8.7.1. Description

Remove a role from a group

8.7.2. Syntax

jaas:group-role-delete [options] group role

8.7.3. Arguments

Name	Description
group	Group
role	Role

8.7.4. Options

Name	Description
--help	Display this help message

8.8. jaas:pending-list

8.8.1. Description

List the pending modification on the active JAAS Realm/Login Module

8.8.2. Syntax

jaas:pending-list [options]

8.8.3. Options

Name	Description
--help	Display this help message

8.9. jaas:realm-list

8.9.1. Description

List JAAS realms

8.9.2. Syntax

jaas:realm-list [options]

8.9.3. Options

Name	Description
--help	Display this help message
-h, --hidden	Show hidden realms
--no-format	Disable table rendered output

8.10. jaas:realm-manage

8.10.1. Description

Manage users and roles of a JAAS Realm

8.10.2. Syntax

jaas:realm-manage [options]

8.10.3. Options

Name	Description
-h, --hidden	Manage hidden realms
--help	Display this help message
--realm	JAAS Realm
-f, --force	Force the management of this realm, even if another one was under management
--index	Realm Index
--module	JAAS Login Module Class Name

8.11. jaas:role-add

8.11.1. Description

Add a role to a user

8.11.2. Syntax

jaas:role-add [options] username role

8.11.3. Arguments

Name	Description
username	User Name
role	Role

8.11.4. Options

Name	Description
--help	Display this help message

8.12. jaas:role-delete

8.12.1. Description

Delete a role from a user

8.12.2. Syntax

jaas:role-delete [options] username role

8.12.3. Arguments

Name	Description
username	User Name
role	Role

8.12.4. Options

Name	Description
--help	Display this help message

8.13. jaas:su

8.13.1. Description

Substitute user identity

8.13.2. Syntax

jaas:su [options] [user]

8.13.3. Arguments

Name	Description
user	Name of the user to substitute (defaults to karaf)

8.13.4. Options

Name	Description
--help	Display this help message
--realm

8.14. jaas:sudo

8.14.1. Description

Execute a command as another user

8.14.2. Syntax

jaas:sudo [options] [command]

8.14.3. Arguments

Name	Description
command

8.14.4. Options

Name	Description
--help	Display this help message
--realm
--user

8.15. jaas:update

8.15.1. Description

Apply pending modification on the edited JAAS Realm

8.15.2. Syntax

jaas:update [options]

8.15.3. Options

Name	Description
--help	Display this help message

8.16. jaas:user-add

8.16.1. Description

Add a user

8.16.2. Syntax

jaas:user-add [options] username password

8.16.3. Arguments

Name	Description
username	User Name
password	Password

8.16.4. Options

Name	Description
--help	Display this help message

8.17. jaas:user-delete

8.17.1. Description

Delete a user

8.17.2. Syntax

jaas:user-delete [options] username

8.17.3. Arguments

Name	Description
username	User Name

8.17.4. Options

Name	Description
--help	Display this help message

8.18. jaas:user-list

8.18.1. Description

List the users of the selected JAAS realm/login module

8.18.2. Syntax

jaas:user-list [options]

8.18.3. Options

Name	Description
--help	Display this help message
--no-format	Disable table rendered output

8.19. jaas:whoami

8.19.1. Description

List currently active principals according to JAAS.

8.19.2. Syntax

jaas:whoami [options]

8.19.3. Options

Name	Description
--help	Display this help message
--no-format	Disable table rendered output.
-g, --groups	Show groups instead of user.
-a, --all	Show all JAAS principals regardless of type.
-r, --roles	Show roles instead of user.

Chapter 9. jdbc

9.1. jdbc:ds-create

9.1.1. Description

Create a JDBC datasource config for pax-jdbc-config from a DataSourceFactory

9.1.2. Syntax

jdbc:ds-create [options] name

9.1.3. Arguments

Name	Description
name	The JDBC datasource name

9.1.4. Options

Name	Description
-p, --password	The database password
--help	Display this help message
-dt, --databaseType	The database type (ConnectionPoolDataSource, XADataSource or DataSource)
-dbName	Database name to use
-dn, --driverName	org.osgi.driver.name property of the DataSourceFactory
-url	The JDBC URL to use
-dc, --driverClass	org.osgi.driver.class property of the DataSourceFactory
-u, --username	The database username

9.2. jdbc:ds-delete

9.2.1. Description

Delete a JDBC datasource

9.2.2. Syntax

jdbc:ds-delete [options] name

9.2.3. Arguments

Name	Description
name	The JDBC datasource name (the one used at creation time)

9.2.4. Options

Name	Description
--help	Display this help message

9.3. jdbc:ds-factories

9.3.1. Description

List the JDBC DataSourceFactories

9.3.2. Syntax

jdbc:ds-factories [options]

9.3.3. Options

Name	Description
--help	Display this help message

9.4. jdbc:ds-info

9.4.1. Description

Display details about a JDBC datasource

9.4.2. Syntax

jdbc:ds-info [options] datasource

9.4.3. Arguments

Name	Description
datasource	The JDBC datasource name

9.4.4. Options

Name	Description
--help	Display this help message

9.5. jdbc:ds-list

9.5.1. Description

List the JDBC datasources

9.5.2. Syntax

jdbc:ds-list [options]

9.5.3. Options

Name	Description
--help	Display this help message

9.6. jdbc:execute

9.6.1. Description

Execute a SQL command on a given JDBC datasource

9.6.2. Syntax

jdbc:execute [options] datasource command

9.6.3. Arguments

Name	Description
datasource	The JDBC datasource
command	The SQL command to execute

9.6.4. Options

Name	Description
--help	Display this help message

9.7. jdbc:query

9.7.1. Description

Execute a SQL query on a JDBC datasource

9.7.2. Syntax

jdbc:query [options] datasource query

9.7.3. Arguments

Name	Description
datasource	The JDBC datasource to use
query	The SQL query to execute

9.7.4. Options

Name	Description
--help	Display this help message

9.8. jdbc:tables

9.8.1. Description

List the tables on a given JDBC datasource

9.8.2. Syntax

jdbc:tables [options] datasource

9.8.3. Arguments

Name	Description
datasource	The JDBC datasource to use

9.8.4. Options

Name	Description
--help	Display this help message

Chapter 10. jms

10.1. jms:browse

10.1.1. Description

Browse a JMS queue

10.1.2. Syntax

jms:browse [options] connectionFactory queue

10.1.3. Arguments

Name	Description
connectionFactory	The JMS connection factory name
queue	The JMS queue to browse

10.1.4. Options

Name	Description
--help	Display this help message
-v, --verbose	Display JMS properties
-s, --selector	The selector to select the messages to browse
-p, --password	Password to connect to the JMS broker
-u, --username	Username to connect to the JMS broker

10.2. jms:connectionfactories

10.2.1. Description

List the JMS connection factories

10.2.2. Syntax

jms:connectionfactories [options]

10.2.3. Options

Name	Description
--help	Display this help message

10.3. jms:consume

10.3.1. Description

Consume messages from a JMS queue.

10.3.2. Syntax

jms:consume [options] connectionFactory queue

10.3.3. Arguments

Name	Description
connectionFactory	The JMS connection factory name
queue	The JMS queue where to consume messages

10.3.4. Options

Name	Description
--help	Display this help message
-s, --selector	The selector to use to select the messages to consume
-p, --password	Password to connect to the JMS broker
-u, --username	Username to connect to the JMS broker

10.4. jms:count

10.4.1. Description

Count the number of messages on a JMS queue.

10.4.2. Syntax

jms:count [options] connectionFactory queue

10.4.3. Arguments

Name	Description
connectionFactory	The JMS connection factory name
queue	The JMS queue name

10.4.4. Options

Name	Description
--help	Display this help message
-p, --password	Password to connect to the JMS broker
-u, --username	Username to connect to the JMS broker

10.5. jms:create

10.5.1. Description

Create a JMS connection factory.

10.5.2. Syntax

jms:create [options] name

10.5.3. Arguments

Name	Description
name	The JMS connection factory name

10.5.4. Options

Name	Description
--help	Display this help message
-t, --type	The JMS connection factory type (ActiveMQ, Artemis or WebsphereMQ)
--url	URL of the JMS broker. For WebsphereMQ type, the URL is hostname/port/queuemanager/channel
-p, --password	Password to connect to the JMS broker
-u, --username	Username to connect to the JMS broker

10.6. jms:delete

10.6.1. Description

Delete a JMS connection factory

10.6.2. Syntax

jms:delete [options] name

10.6.3. Arguments

Name	Description
name	The JMS connection factory name

10.6.4. Options

Name	Description
--help	Display this help message

10.7. jms:info

10.7.1. Description

Provides details about a JMS connection factory.

10.7.2. Syntax

jms:info [options] connectionFactory

10.7.3. Arguments

Name	Description
connectionFactory	The JMS connection factory name

10.7.4. Options

Name	Description
--help	Display this help message
-p, --password	Password to connect to the JMS broker
-u, --username	Username to connect to the JMS broker

10.8. jms:move

10.8.1. Description

Move messages from one JMS queue to another one.

10.8.2. Syntax

jms:move [options] connectionFactory source destination

10.8.3. Arguments

Name	Description
connectionFactory	The JMS connection factory name
source	The source JMS queue
destination	The destination JMS queue

10.8.4. Options

Name	Description
--help	Display this help message
-s, --selector	Selector to move only some messages
-p, --password	Password to connect to the JMS broker
-u, --username	Username to connect to the JMS broker

10.9. jms:queues

10.9.1. Description

List the JMS queues.

10.9.2. Syntax

jms:queues [options] connectionFactory

10.9.3. Arguments

Name	Description
connectionFactory	The JMS connection factory name

10.9.4. Options

Name	Description
--help	Display this help message
-p, --password	Password to connect to the JMS broker
-u, --username	Username to connect to the JMS broker

10.10. jms:send

10.10.1. Description

Send a message to

10.10.2. Syntax

jms:send [options] connectionFactory queue message

10.10.3. Arguments

Name	Description
connectionFactory	The JMS connection factory name
queue	The JMS queue name
message	The JMS message content

10.10.4. Options

Name	Description
--help	Display this help message
-r, --replyTo	Set the message ReplyTo
-p, --password	Password to connect to the JMS broker
-u, --username	Username to connect to the JMS broker

10.11. jms:topics

10.11.1. Description

List the JMS topics.

10.11.2. Syntax

jms:topics [options] connectionFactory

10.11.3. Arguments

Name	Description
connectionFactory	The JMS connection factory name

10.11.4. Options

Name	Description
--help	Display this help message
-p, --password	Password to connect to the JMS broker
-u, --username	Username to connect to the JMS broker

Chapter 11. jndi

11.1. jndi:alias

11.1.1. Description

Create a JNDI alias on a given name.

11.1.2. Syntax

jndi:alias [options] name alias

11.1.3. Arguments

Name	Description
name	The JNDI name
alias	The JNDI alias

11.1.4. Options

Name	Description
--help	Display this help message

11.2. jndi:bind

11.2.1. Description

Bind an OSGi service in the JNDI context

11.2.2. Syntax

jndi:bind [options] service name

11.2.3. Arguments

Name	Description
service	The ID of the OSGi service to bind
name	The JNDI name to bind the OSGi service

11.2.4. Options

Name	Description
--help	Display this help message

11.3. jndi:contexts

11.3.1. Description

List the JNDI sub-contexts.

11.3.2. Syntax

jndi:contexts [options] [context]

11.3.3. Arguments

Name	Description
context	The base JNDI context

11.3.4. Options

Name	Description
--help	Display this help message

11.4. jndi:create

11.4.1. Description

Create a new JNDI sub-context.

11.4.2. Syntax

jndi:create [options] context

11.4.3. Arguments

Name	Description
context	The JNDI sub-context name

11.4.4. Options

Name	Description
--help	Display this help message

11.5. jndi:delete

11.5.1. Description

Delete a JNDI sub-context.

11.5.2. Syntax

jndi:delete [options] context

11.5.3. Arguments

Name	Description
context	The JNDI sub-context name

11.5.4. Options

Name	Description
--help	Display this help message

11.6. jndi:names

11.6.1. Description

List the JNDI names.

11.6.2. Syntax

jndi:names [options] [context]

11.6.3. Arguments

Name	Description
context	The JNDI context to display the names

11.6.4. Options

Name	Description
--help	Display this help message

11.7. jndi:unbind

11.7.1. Description

Unbind a JNDI name.

11.7.2. Syntax

jndi:unbind [options] name

11.7.3. Arguments

Name	Description
name	The JNDI name to unbind

11.7.4. Options

Name	Description
--help	Display this help message

Chapter 12. kar

12.1. kar:create

12.1.1. Description

Create a kar file for a list of feature repos

12.1.2. Syntax

kar:create [options] repoName [features]

12.1.3. Arguments

Name	Description
repoName	Repository name. The kar will contain all features of the named repository by default
features	Names of the features to include. If set then only these features will be added

12.1.4. Options

Name	Description
--help	Display this help message

12.2. kar:install

12.2.1. Description

Installs a KAR file.

12.2.2. Syntax

kar:install [options] url

12.2.3. Arguments

Name	Description
url	The URL of the KAR file to install.

12.2.4. Options

Name	Description
--help	Display this help message
--no-start	Do not start the bundles automatically

12.3. kar:list

12.3.1. Description

List the installed KAR files.

12.3.2. Syntax

kar:list [options]

12.3.3. Options

Name	Description
--help	Display this help message
--no-format	Disable table rendered output

12.4. kar:uninstall

12.4.1. Description

Uninstall a KAR file.

12.4.2. Syntax

kar:uninstall [options] name

12.4.3. Arguments

Name	Description
name	The name of the KAR file to uninstall.

12.4.4. Options

Name	Description
--help	Display this help message

Chapter 13. log

13.1. log:clear

13.1.1. Description

Clear log entries.

13.1.2. Syntax

log:clear [options]

13.1.3. Options

Name	Description
--help	Display this help message

13.2. log:display

13.2.1. Description

Displays log entries.

13.2.2. Syntax

log:display [options] [logger]

13.2.3. Arguments

Name	Description
logger	The name of the logger. This can be ROOT, ALL, or the name of a logger specified in the org.ops4j.pax.logger.cfg file.

13.2.4. Options

Name	Description
-p	Pattern for formatting the output
--help	Display this help message
--no-color	Disable syntax coloring of log events
-n	Number of entries to display
-l, --level	The minimal log level to display

13.3. log:exception-display

13.3.1. Description

Displays the last occurred exception from the log.

13.3.2. Syntax

log:exception-display [options] [logger]

13.3.3. Arguments

Name	Description
logger	The name of the logger. This can be ROOT, ALL, or the name of a logger specified in the org.ops4j.pax.logger.cfg file.

13.3.4. Options

Name	Description
--help	Display this help message

13.4. log:get

13.4.1. Description

Shows the currently set log level.

13.4.2. Syntax

log:get [options] [logger]

13.4.3. Arguments

Name	Description
logger	The name of the logger or ALL (default)

13.4.4. Options

Name	Description
--help	Display this help message
--no-format	Disable table rendered output

13.5. log:load-test

13.5.1. Description

Load test log.

13.5.2. Syntax

log:load-test [options]

13.5.3. Options

Name	Description
--help	Display this help message
--messaged
--threads

13.6. log:log

13.6.1. Description

Log a message.

13.6.2. Syntax

log:log [options] message

13.6.3. Arguments

Name	Description
message	The message to log

13.6.4. Options

Name	Description
--help	Display this help message
--level, -l	The level the message will be logged at

13.7. log:set

13.7.1. Description

Sets the log level.

13.7.2. Syntax

log:set [options] level [logger]

13.7.3. Arguments

Name	Description
level	The log level to set (TRACE, DEBUG, INFO, WARN, ERROR) or DEFAULT to unset
logger	Logger name or ROOT (default)

13.7.4. Options

Name	Description
--help	Display this help message

13.8. log:tail

13.8.1. Description

Continuously display log entries. Use ctrl-c to quit this command

13.8.2. Syntax

log:tail [options] [logger]

13.8.3. Arguments

Name	Description
logger	The name of the logger. This can be ROOT, ALL, or the name of a logger specified in the org.ops4j.pax.logger.cfg file.

13.8.4. Options

Name	Description
-p	Pattern for formatting the output
--help	Display this help message
--no-color	Disable syntax coloring of log events
-n	Number of entries to display
-l, --level	The minimal log level to display

Chapter 14. maven

14.1. maven:http-proxy-list

14.1.1. Description

Lists HTTP proxy configurations for Maven remote repositories

14.1.2. Syntax

maven:http-proxy-list [options]

14.1.3. Options

Name	Description
--help	Display this help message
-x, --show-passwords	Do not hide passwords related to Maven encryption

14.2. maven:http-proxy

14.2.1. Description

Manage HTTP proxy configuration for Maven remote repositories

14.2.2. Syntax

maven:http-proxy [options] [hostPort]

14.2.3. Arguments

Name	Description
hostPort	host:port of HTTP proxy

14.2.4. Options

Name	Description
-p, --password	Password for remote repository (may be encrypted, see "maven:password -ep")
--help	Display this help message
-f, --force	Do not ask for confirmation
-id	Identifier of HTTP proxy
--change	Changes HTTP proxy configuration in Maven settings
-n, --non-proxy-hosts	Non-proxied hosts (in the format '192.168.*\|localhost\|…')
--remove	Removes HTTP proxy configuration from Maven settings
--add	Adds HTTP proxy configuration to Maven settings
-u, --username	Username for remote repository
-x, --show-passwords	Do not hide passwords related to Maven encryption

14.3. maven:password

14.3.1. Description

Manage passwords for remote repositories and proxies

14.3.2. Syntax

maven:password [options]

14.3.3. Options

Name	Description
-emp, --encrypt-master-password	Encrypts master password used to encrypt/decrypt other passwords, see "mvn -emp"
--help	Display this help message
-ep, --encrypt-password	Encrypts passwords to use for remote repositories and proxies, see "mvn -ep"
-p, --persist

14.4. maven:repository-add

14.4.1. Description

Adds Maven repository

14.4.2. Syntax

maven:repository-add [options] [uri]

14.4.3. Arguments

Name	Description
uri	Repository URI. It may be file:// based, http(s):// based, may use other known protocol or even property placeholders (like ${karaf.base})

14.4.4. Options

Name	Description
-nr, --no-releases	Disable release handling in this repository
-p, --password	Password for remote repository (may be encrypted, see "maven:password -ep")
--help	Display this help message
-f, --force	Do not ask for confirmation
-id	Identifier of repository
-idx	Index at which new repository is to be inserted (0-based) (defaults to last - repository will be appended)
-d, --default	Edit default repository instead of remote one
-s, --snapshots	Enable SNAPSHOT handling in the repository
-cp, --checksum-policy	Checksum policy for repository (ignore, warn (default), fail)
-u, --username	Username for remote repository
-x, --show-passwords	Do not hide passwords related to Maven encryption
-up, --update-policy	Update policy for repository (never, daily (default), interval:N, always)

14.5. maven:repository-change

14.5.1. Description

Changes configuration of Maven repository

14.5.2. Syntax

maven:repository-change [options] [uri]

14.5.3. Arguments

Name	Description
uri	Repository URI. It may be file:// based, http(s):// based, may use other known protocol or even property placeholders (like ${karaf.base})

14.5.4. Options

Name	Description
-nr, --no-releases	Disable release handling in this repository
-p, --password	Password for remote repository (may be encrypted, see "maven:password -ep")
--help	Display this help message
-f, --force	Do not ask for confirmation
-id	Identifier of repository
-d, --default	Edit default repository instead of remote one
-s, --snapshots	Enable SNAPSHOT handling in the repository
-cp, --checksum-policy	Checksum policy for repository (ignore, warn (default), fail)
-u, --username	Username for remote repository
-x, --show-passwords	Do not hide passwords related to Maven encryption
-up, --update-policy	Update policy for repository (never, daily (default), interval:N, always)

14.6. maven:repository-list

14.6.1. Description

Maven repository summary.

14.6.2. Syntax

maven:repository-list [options]

14.6.3. Options

Name	Description
--help	Display this help message
-v, --verbose	Show additional information (policies, source)
-x, --show-passwords	Do not hide passwords related to Maven encryption

14.7. maven:repository-remove

14.7.1. Description

Removes Maven repository

14.7.2. Syntax

maven:repository-remove [options]

14.7.3. Options

Name	Description
--help	Display this help message
-f, --force	Do not ask for confirmation
-id	Identifier of repository
-d, --default	Edit default repository instead of remote one
-x, --show-passwords	Do not hide passwords related to Maven encryption

14.8. maven:summary

14.8.1. Description

Maven configuration summary.

14.8.2. Syntax

maven:summary [options]

14.8.3. Options

Name	Description
--help	Display this help message
-p, --property-ids	Use PID property identifiers instead of their names
-s, --source	Adds information about where the value is configured
-d, --description	Adds description of Maven configuration options
-x, --show-passwords	Do not hide passwords related to Maven encryption

Chapter 15. obr

15.1. obr:deploy

15.1.1. Description

Deploys a list of bundles using OBR service.

15.1.2. Syntax

obr:deploy [options] bundles

15.1.3. Arguments

Name	Description
bundles	List of bundle names to deploy (separated by whitespaces). The bundles are identified using the following syntax: symbolic_name,version where version is optional.

15.1.4. Options

Name	Description
--help	Display this help message
-d, --deployOptional	Deploy optional bundles
-s, --start	Start the deployed bundles

15.2. obr:find

15.2.1. Description

Find OBR bundles for a given filter.

15.2.2. Syntax

obr:find [options] requirements

15.2.3. Arguments

Name	Description
requirements	Requirement

15.2.4. Options

Name	Description
--help	Display this help message

15.3. obr:info

15.3.1. Description

Prints information about OBR bundles.

15.3.2. Syntax

obr:info [options] bundles

15.3.3. Arguments

Name	Description
bundles	Specify bundles to query for information (separated by whitespaces). The bundles are identified using the following syntax: symbolic_name,version where version is optional.

15.3.4. Options

Name	Description
--help	Display this help message

15.4. obr:list

15.4.1. Description

Lists OBR bundles, optionally providing the given packages.

15.4.2. Syntax

obr:list [options] [packages]

15.4.3. Arguments

Name	Description
packages	A list of packages separated by whitespaces.

15.4.4. Options

Name	Description
--help	Display this help message
--no-format	Disable table rendered output

15.5. obr:resolve

15.5.1. Description

Shows the resolution output for a given set of requirements.

15.5.2. Syntax

obr:resolve [options] requirements

15.5.3. Arguments

Name	Description
requirements	Requirements

15.5.4. Options

Name	Description
-w, --why	Display the reason of the inclusion of the resource
--help	Display this help message
--no-remote	Ignore remote resources during resolution
-l, --no-local	Ignore local resources during resolution
--deploy	Deploy the selected bundles
--optional	Resolve optional dependencies
--start	Deploy and start the selected bundles

15.6. obr:source

15.6.1. Description

Downloads the sources for an OBR bundle.

15.6.2. Syntax

obr:source [options] folder bundles

15.6.3. Arguments

Name	Description
folder	Local folder for storing sources
bundles	List of bundles to download the sources for. The bundles are identified using the following syntax: symbolic_name,version where version is optional.

15.6.4. Options

Name	Description
--help	Display this help message
-x	Extract the archive

15.7. obr:start

15.7.1. Description

Deploys and starts a list of bundles using OBR.

15.7.2. Syntax

obr:start [options] bundles

15.7.3. Arguments

Name	Description
bundles	List of bundles to deploy (separated by whitespaces). The bundles are identified using the following syntax: symbolic_name,version where version is optional.

15.7.4. Options

Name	Description
--help	Display this help message
-d, --deployOptional	Deploy optional bundles

15.8. obr:url-add

15.8.1. Description

Adds a list of repository URLs to the OBR service.

15.8.2. Syntax

obr:url-add [options] urls

15.8.3. Arguments

Name	Description
urls	Repository URLs to add to the OBR service separated by whitespaces

15.8.4. Options

Name	Description
--help	Display this help message

15.9. obr:url-list

15.9.1. Description

Displays the repository URLs currently associated with the OBR service.

15.9.2. Syntax

obr:url-list [options]

15.9.3. Options

Name	Description
--help	Display this help message
--no-format	Disable table rendered output

15.10. obr:url-refresh

15.10.1. Description

Reloads the repositories to obtain a fresh list of bundles.

15.10.2. Syntax

obr:url-refresh [options] [ids]

15.10.3. Arguments

Name	Description
ids	Repository URLs (or indexes if you use -i) to refresh (leave empty for all)

15.10.4. Options

Name	Description
-i, --index	Use index to identify URL
--help	Display this help message

15.11. obr:url-remove

15.11.1. Description

Removes a list of repository URLs from the OBR service.

15.11.2. Syntax

obr:url-remove [options] ids

15.11.3. Arguments

Name	Description
ids	Repository URLs (or indexes if you use -i) to remove from OBR service

15.11.4. Options

Name	Description
-i, --index	Use index to identify URL
--help	Display this help message

Chapter 16. package

16.1. package:exports

16.1.1. Description

Lists exported packages and the bundles that export them

16.1.2. Syntax

package:exports [options]

16.1.3. Options

Name	Description
--help	Display this help message
-b	Only show packages exported by given bundle id
-d	Only show packages that are exported by more than one bundle
--show-name-only	Show only package name
-p	Only show package starting with given name
--no-format	Disable table rendered output

16.2. package:imports

16.2.1. Description

Lists imported packages and the bundles that import them

16.2.2. Syntax

package:imports [options]

16.2.3. Options

Name	Description
--help	Display this help message
-b	Only show imports of the given bundle id
--show-name-only	Show only package name
--filter	Only show package instead of full filter
-p	Only show package starting with given name
--no-format	Disable table rendered output

Chapter 17. scheduler

17.1. scheduler:list

17.1.1. Description

List scheduled jobs

17.1.2. Syntax

scheduler:list [options]

17.1.3. Options

Name	Description
--help	Display this help message

17.2. scheduler:reschedule

17.2.1. Description

Update scheduling of an existing job

17.2.2. Syntax

scheduler:reschedule [options] name

17.2.3. Arguments

Name	Description
name	The job name

17.2.4. Options

Name	Description
--help	Display this help message
--period	Time during executions (in seconds)
--at	Absolute date in ISO format (ex: 2014-05-13T13:56:45)
--times	Number of times this job should be executed
--concurrent	Should jobs run concurrently or not (defaults to false)
--cron	The cron expression

17.3. scheduler:schedule

17.3.1. Description

Schedule a script execution

17.3.2. Syntax

scheduler:schedule [options] script

17.3.3. Arguments

Name	Description
script	The script to schedule

17.3.4. Options

Name	Description
--help	Display this help message
--period	Time during executions (in seconds)
--at	Absolute date in ISO format (ex: 2014-05-13T13:56:45)
--times	Number of times this job should be executed
--name	Name of this job
--concurrent	Should jobs run concurrently or not (defaults to false)
--cron	The cron expression

17.4. scheduler:trigger

17.4.1. Description

Manually trigger a scheduled job

17.4.2. Syntax

scheduler:trigger [options] name

17.4.3. Arguments

Name	Description
name	Name of the job to trigger

17.4.4. Options

Name	Description
--help	Display this help message
-b, background	schedule the trigger in the background

17.5. scheduler:unschedule

17.5.1. Description

Unschedule a job

17.5.2. Syntax

scheduler:unschedule [options] [name]

17.5.3. Arguments

Name	Description
name

17.5.4. Options

Name	Description
--help	Display this help message

Chapter 18. scr

18.1. scr:activate

18.1.1. Description

Activates a Component for the given name

18.1.2. Syntax

scr:activate [options] name

18.1.3. Arguments

Name	Description
name	The name of the Component to activate

18.1.4. Options

Name	Description
--help	Display this help message
-s, --show-hidden	Show all Components including the System Components (hidden by default)

18.2. scr:components

18.2.1. Description

Display available components

18.2.2. Syntax

scr:components [options]

18.2.3. Options

Name	Description
--help	Display this help message
-s, --show-hidden	Show all Components including the System Components (hidden by default)

18.3. scr:deactivate

18.3.1. Description

Deactivates a Component for the given name

18.3.2. Syntax

scr:deactivate [options] name

18.3.3. Arguments

Name	Description
name	The name of the Component to deactivate

18.3.4. Options

Name	Description
--help	Display this help message
-s, --show-hidden	Show all Components including the System Components (hidden by default)

18.4. scr:details

18.4.1. Description

Display available components

18.4.2. Syntax

scr:details [options] name

18.4.3. Arguments

Name	Description
name	The component name

18.4.4. Options

Name	Description
--help	Display this help message
-s, --show-hidden	Show all Components including the System Components (hidden by default)

Chapter 19. service

19.1. service:list

19.1.1. Description

Lists OSGi services.

19.1.2. Syntax

service:list [options] [objectClass]

19.1.3. Arguments

Name	Description
objectClass	Name of service objectClass to filter for

19.1.4. Options

Name	Description
-a	Shows all services. (By default Karaf commands are hidden)
--help	Display this help message
-n	Shows only service class names

19.2. service:wait

19.2.1. Description

Wait for a given OSGi service.

19.2.2. Syntax

service:wait [options] service

19.2.3. Arguments

Name	Description
service	The service class or filter

19.2.4. Options

Name	Description
-t, --timeout	timeout to wait for the service (in milliseconds, negative to not wait at all, zero to wait forever)
--help	Display this help message
-e, --exception	throw an exception if the service is not found after the timeout

Chapter 20. shell

20.1. shell:completion

20.1.1. Description

Display or change the completion mode on the current console session.

20.1.2. Syntax

shell:completion [options] [mode]

20.1.3. Arguments

Name	Description
mode	The completion mode to set. The valid completion modes are: global, first, subshell.

20.1.4. Options

Name	Description
--help	Display this help message

20.2. shell:exec

20.2.1. Description

Executes system processes.

20.2.2. Syntax

shell:exec [options] command

20.2.3. Arguments

Name	Description
command	Execution command with arguments

20.2.4. Options

Name	Description
--help	Display this help message

20.3. shell:info

20.3.1. Description

Prints system information.

20.3.2. Syntax

shell:info [options]

20.3.3. Options

Name	Description
--help	Display this help message
--memory-pools, -mp	Includes detailed information about memory pools

20.4. shell:java

20.4.1. Description

Executes a Java standard application.

20.4.2. Syntax

shell:java [options] className [arguments]

20.4.3. Arguments

Name	Description
className	The name of the class to invoke
arguments	Arguments to pass to the method of the given class

20.4.4. Options

Name	Description
--help	Display this help message
-m, --method	Invoke a named method

20.5. shell:logout

20.5.1. Description

Disconnects shell from current session.

20.5.2. Syntax

shell:logout [options]

20.5.3. Options

Name	Description
--help	Display this help message

20.6. shell:printf

20.6.1. Description

Formats and prints arguments.

20.6.2. Syntax

shell:printf [options] format arguments

20.6.3. Arguments

Name	Description
format	The format pattern to use
arguments	The arguments for the given format pattern

20.6.4. Options

Name	Description
--help	Display this help message

20.7. shell:source

20.7.1. Description

Run a script

20.7.2. Syntax

shell:source [options] script [args]

20.7.3. Arguments

Name	Description
script	A URI pointing to the script
args	Arguments for the script

20.7.4. Options

Name	Description
--help	Display this help message

20.8. shell:stack-traces-print

20.8.1. Description

Prints the full stack trace in the console when the execution of a command throws an exception.

20.8.2. Syntax

shell:stack-traces-print [options] [print]

20.8.3. Arguments

Name	Description
print	Print stack traces or not (defaults to true)

20.8.4. Options

Name	Description
--help	Display this help message

20.9. shell:threads

20.9.1. Description

Prints the current threads (optionally with stacktraces)

20.9.2. Syntax

shell:threads [options] [id]

20.9.3. Arguments

Name	Description
id	Show details for thread with this Id

20.9.4. Options

Name	Description
--tree	Display threads as a tree
--list	Display threads as a list
-e, --empty-groups	Show empty groups
--packages	Pruned packages
--help	Display this help message
--monitors	Display monitors
-t, --threshold	Minimal number of interesting stack trace line to display a thread
--locks	Display locks
--no-format	Disable table rendered output

20.10. shell:ttop

20.10.1. Description

Display threads information

20.10.2. Syntax

shell:ttop [options]

20.10.3. Options

Name	Description
--seconds, -s	Delay between updates in seconds
--order, -o	Comma separated list of sorting keys
--millis, -m	Delay between updates in milliseconds
--nthreads, -n	Only display up to NTHREADS threads
--help	Display this help message
--stats, -t	Comma separated list of stats to display

20.11. shell:watch

20.11.1. Description

Watches & refreshes the output of a command

20.11.2. Syntax

shell:watch [options] command

20.11.3. Arguments

Name	Description
command	The command to watch / refresh

20.11.4. Options

Name	Description
--help	Display this help message
-n, --interval	The interval between executions of the command in seconds
-a, --append	The output should be appended but not clear the console

Chapter 21. ssh

21.1. ssh:ssh

21.1.1. Description

Connects to a remote SSH server

21.1.2. Syntax

ssh:ssh [options] hostname [command]

21.1.3. Arguments

Name	Description
hostname	The host name to connect to via SSH
command	Optional command to execute

21.1.4. Options

Name	Description
--help	Display this help message
-P, --password	The password for remote login
-p, --port	The port to use for SSH connection
-q	Quiet Mode. Do not ask for confirmations
-r, --retries	retry connection establishment (up to attempts times)
-l, --username	The user name for remote login
-k, --keyfile	The private keyFile location when using key login, need have BouncyCastle registered as security provider using this flag

21.2. ssh:sshd

21.2.1. Description

Creates a SSH server

21.2.2. Syntax

ssh:sshd [options]

21.2.3. Options

Name	Description
--help	Display this help message
-b, --background	The service will run in the background
-p, --port	The port to setup the SSH server
-i, --idle-timeout	The session idle timeout in milliseconds
-w, --welcome-banner	The welcome banner to display when logging in
-n, --nio-workers	The number of NIO worker threads to use

Chapter 22. subsystem

22.1. subsystem:info

22.1.1. Description

Display information about subsystems

22.1.2. Syntax

subsystem:info [options] [id]

22.1.3. Arguments

Name	Description
id	Subsystem names or ids

22.1.4. Options

Name	Description
--help	Display this help message
--indent	Indentation method

22.2. subsystem:install

22.2.1. Description

Install a new subsystem

22.2.2. Syntax

subsystem:install [options] [Subsystem to install the new subsystem into] [New subsystem url]

22.2.3. Arguments

Name	Description
Subsystem to install the new subsystem into
New subsystem url

22.2.4. Options

Name	Description
--help	Display this help message

22.3. subsystem:list

22.3.1. Description

List all subsystems

22.3.2. Syntax

subsystem:list [options]

22.3.3. Options

Name	Description
--help	Display this help message

22.4. subsystem:start

22.4.1. Description

Start the specified subsystems

22.4.2. Syntax

subsystem:start [options] [id]

22.4.3. Arguments

Name	Description
id	Subsystem names or ids

22.4.4. Options

Name	Description
--help	Display this help message

22.5. subsystem:stop

22.5.1. Description

Stop the specified subsystems

22.5.2. Syntax

subsystem:stop [options] [id]

22.5.3. Arguments

Name	Description
id	Subsystem names or ids

22.5.4. Options

Name	Description
--help	Display this help message

22.6. subsystem:uninstall

22.6.1. Description

Uninstall the specified subsystems

22.6.2. Syntax

subsystem:uninstall [options] [id]

22.6.3. Arguments

Name	Description
id	Subsystem names or ids

22.6.4. Options

Name	Description
--help	Display this help message

Chapter 23. system

23.1. system:framework

23.1.1. Description

OSGi Framework options.

23.1.2. Syntax

system:framework [options] [framework]

23.1.3. Arguments

Name	Description
framework	Name of the OSGi framework to use

23.1.4. Options

Name	Description
-nodebug, --disable-debug	Disable debug for the OSGi framework
--help	Display this help message
-debug, --enable-debug	Enable debug for the OSGi framework

23.2. system:name

23.2.1. Description

Show or change Karaf instance name.

23.2.2. Syntax

system:name [options] [name]

23.2.3. Arguments

Name	Description
name	New name for the instance

23.2.4. Options

Name	Description
--help	Display this help message

23.3. system:property

23.3.1. Description

Get or set a system property.

23.3.2. Syntax

system:property [options] [key] [value]

23.3.3. Arguments

Name	Description
key	The system property name
value	New value for the system property

23.3.4. Options

Name	Description
--help	Display this help message
-f, --file-dump	Dump all system properties in a file (in data folder)
-p, --persistent	Persist the new value to the etc/system.properties file
-u, --unset	Show unset know properties with value unset

23.4. system:shutdown

23.4.1. Description

Shutdown the Karaf container.

23.4.2. Syntax

system:shutdown [options] [time]

23.4.3. Arguments

Name	Description
time	Shutdown after a specified delay. The time argument can have different formats. First, it can be an absolute time in the format hh:mm, in which hh is the hour (1 or 2 digits) and mm is the minute of the hour (in two digits). Second, it can be in the format m (or +m), in which m is the number of minutes to wait. The word now is an alias for 0 (or +0).

23.4.4. Options

Name	Description
-c, --clean, --clean-all, -ca	Force a clean restart by deleting the data directory
--help	Display this help message
-h, --halt	Halt the Karaf container.
-cc, --clean-cache, -cc	Force a clean restart by deleting the cache directory
-f, --force	Force the shutdown without confirmation message.
-r, --reboot	Reboot the Karaf container.

23.5. system:start-level

23.5.1. Description

Gets or sets the system start level.

23.5.2. Syntax

system:start-level [options] [level]

23.5.3. Arguments

Name	Description
level	The new system start level to set

23.5.4. Options

Name	Description
--help	Display this help message

23.6. system:version

23.6.1. Description

Display the instance version

23.6.2. Syntax

system:version [options]

23.6.3. Options

Name	Description
--help	Display this help message

Chapter 24. web

Note

The web application is a bundle, so we can use normal bundle:start and bundle:stop commands.

The recommended method is to use WAB bundles, that have the Web-ContextPath: /path manifest header.

WAB bundles can be installed as the type war:

Example

mvn:io.hawt/hawtio-osgi/2.0.0.fuse-7_12_0-00009/war.

24.1. web:context-list

24.1.1. Description

Lists all available web contexts. These may originate from HttpService, Whiteboard or WAB Extender.

24.1.2. Syntax

web:context-list

24.1.3. Options

Name	Description
--help	Display this help message

24.1.4. Additional information

This command is mostly useful for OSGi web application developers.

Table 24.1. Sample web:context-list output
Bundle ID	Symbolic Name	Context Path	Context Name	Rank	Type	Scope	Registration Properties
122	org.apache.cxf.cxf-rt-transports-http	/	default	MAX	HttpService	static*	httpContext.id=default httpContext.path=/ osgi.http.whiteboard.context.httpservice=default osgi.http.whiteboard.context.path=/
230	org.ops4j.pax.web.pax-web-extender-whiteboard	/	default	0	Whiteboard	static*	osgi.http.whiteboard.context.name=default osgi.http.whiteboard.context.path=/
43	io.hawt.hawtio-osgi	/hawtio	/hawtio	MAX	WAB	static*	osgi.http.whiteboard.context.path=/hawtio

24.2. web:launch

24.2.1. Description

Start the web application in a browser of the given bundle ID.

24.2.2. Syntax

web:launch [options] id

24.2.3. Arguments

Name	Description
id	The bundle ID to start the browser with

24.2.4. Options

Name	Description
--base	The base URL to browse to, otherwise default localhost:8181 will be used.
--help	Display this help message

24.3. web:wab-list

24.3.1. Description

Lists all available, deployed Web Application Bundles.

24.3.2. Syntax

web:wab-list

24.3.3. Options

Name	Description
--help	Display this help message

24.4. web:servlet-list

24.4.1. Description

Lists details for available servlets.

24.4.2. Syntax

web:servlet-list [options]

24.4.3. Options

Name	Description
--help	Display this help message
--no-format	Disable table rendered output

24.4.4. Additional information

The web:servlet-list command lists installed servlets, showing additional information, for example the method of servlet registration.

Table 24.2. Sample output for Fuse 7.12
Bundle ID	Name	Class	Context Path(s)	URLs	Type
43	default	org.ops4j.pax.web.service.undertow.internal.web.UndertowResourceServlet	/hawtio	/	WAB
43	jolokia-agent	io.hawt.web.servlets.JolokiaConfiguredAgentServlet	/hawtio	/jolokia/*	WAB
43	jolokia-proxy	io.hawt.web.proxy.ProxyServlet	/hawtio	/proxy/*	WAB
43	jsp	org.ops4j.pax.web.jsp.JspServlet	/hawtio	.jspx, .jsp	WAB
43	keycloak	io.hawt.web.auth.keycloak.KeycloakServlet	/hawtio	/keycloak/*	WAB
43	login	io.hawt.web.auth.LoginServlet	/hawtio	/auth/login	WAB
43	logout	io.hawt.web.auth.LogoutServlet	/hawtio	/auth/logout	WAB
43	plugin	io.hawt.web.plugin.PluginServlet	/hawtio	/plugin/*	WAB
43	user	io.hawt.web.auth.keycloak.KeycloakUserServlet	/hawtio	/user/*	WAB
122	cxf-osgi-transport-servlet	org.apache.cxf.transport.servlet.CXFNonSpringServlet	/	/cxf/*	HttpService

24.5. web:start

Deprecated: Use bundle:start with WAB bundles instead.

24.5.1. Description

Start the web context of given bundles.

24.5.2. Syntax

web:start [options] ids

24.5.3. Arguments

Name	Description
ids	The list of bundle IDs separated by whitespaces

24.5.4. Options

Name	Description
--help	Display this help message

24.6. web:stop

Deprecated: Use bundle:stop with WAB bundles instead.

24.6.1. Description

Stop the web context of given bundles.

24.6.2. Syntax

web:stop [options] ids

24.6.3. Arguments

Name	Description
ids	The list of bundle IDs separated by whitespaces

24.6.4. Options

Name	Description
--help	Display this help message

24.7. web:wab-info

24.7.1. Description

Shows information about Web Application Bundle.

24.7.2. Syntax

web:wab-info [options]

24.7.3. Options

Name	Description
--wab	WAB specified by context path or bundle ID
--help	Display this help message

24.7.4. Additional information

The web:wab-info command shows information about the structure of a web application. It displays reachable bundles, WAB classpath and registered ServletContainerInitializers.

Sample output for hawtio web application

hawtio :: OSGi Web Console (43)
-------------------------------
Context Path: /hawtio
Deployment State: Deployed
WAB ClassPath:
 - bundle://2469cbea-ac0f-4f79-9760-2186c2e80b94_43.0:0/WEB-INF/classes/
 - jar:bundle://2469cbea-ac0f-4f79-9760-2186c2e80b94_43.0:0/WEB-INF/lib/hawtio-core-2.0.0.fuse-7_12_0-00009.jar!/
 - jar:bundle://2469cbea-ac0f-4f79-9760-2186c2e80b94_43.0:0/WEB-INF/lib/hawtio-system-2.0.0.fuse-7_12_0-00009.jar!/
 - jar:bundle://2469cbea-ac0f-4f79-9760-2186c2e80b94_43.0:0/WEB-INF/lib/jolokia-core-1.7.1.redhat-00001.jar!/ (scanning skipped)
 - jar:bundle://2469cbea-ac0f-4f79-9760-2186c2e80b94_43.0:0/WEB-INF/lib/json-simple-1.1.1.redhat-1.jar!/
 - jar:bundle://2469cbea-ac0f-4f79-9760-2186c2e80b94_43.0:0/WEB-INF/lib/httpclient-4.5.13.redhat-00002.jar!/ (scanning skipped)
 - jar:bundle://2469cbea-ac0f-4f79-9760-2186c2e80b94_43.0:0/WEB-INF/lib/httpcore-4.4.13.redhat-00001.jar!/ (scanning skipped)
 - jar:bundle://2469cbea-ac0f-4f79-9760-2186c2e80b94_43.0:0/WEB-INF/lib/commons-logging-1.2.0.redhat-3.jar!/ (scanning skipped)
 - jar:bundle://2469cbea-ac0f-4f79-9760-2186c2e80b94_43.0:0/WEB-INF/lib/commons-io-2.11.0.redhat-00001.jar!/ (scanning skipped)
 - jar:bundle://2469cbea-ac0f-4f79-9760-2186c2e80b94_43.0:0/WEB-INF/lib/commons-codec-1.15.0.redhat-00001.jar!/ (scanning skipped)
 - jar:bundle://2469cbea-ac0f-4f79-9760-2186c2e80b94_43.0:0/WEB-INF/lib/guava-27.1-jre.jar!/ (scanning skipped)
 - jar:bundle://2469cbea-ac0f-4f79-9760-2186c2e80b94_43.0:0/WEB-INF/lib/failureaccess-1.0.1.jar!/
 - jar:bundle://2469cbea-ac0f-4f79-9760-2186c2e80b94_43.0:0/WEB-INF/lib/listenablefuture-9999.0-empty-to-avoid-conflict-with-guava.jar!/
 - jar:bundle://2469cbea-ac0f-4f79-9760-2186c2e80b94_43.0:0/WEB-INF/lib/jsr305-3.0.2.jar!/
 - jar:bundle://2469cbea-ac0f-4f79-9760-2186c2e80b94_43.0:0/WEB-INF/lib/checker-qual-2.5.2.jar!/
 - jar:bundle://2469cbea-ac0f-4f79-9760-2186c2e80b94_43.0:0/WEB-INF/lib/error_prone_annotations-2.2.0.jar!/
 - jar:bundle://2469cbea-ac0f-4f79-9760-2186c2e80b94_43.0:0/WEB-INF/lib/j2objc-annotations-1.1.jar!/
 - jar:bundle://2469cbea-ac0f-4f79-9760-2186c2e80b94_43.0:0/WEB-INF/lib/animal-sniffer-annotations-1.17.jar!/
 - jar:bundle://2469cbea-ac0f-4f79-9760-2186c2e80b94_43.0:0/WEB-INF/lib/json-20171018.jar!/
 - jar:bundle://2469cbea-ac0f-4f79-9760-2186c2e80b94_43.0:0/WEB-INF/lib/hawtio-util-2.0.0.fuse-7_12_0-00009.jar!/
 - jar:bundle://2469cbea-ac0f-4f79-9760-2186c2e80b94_43.0:0/WEB-INF/lib/org.apache.aries.blueprint.web-1.1.0.jar!/ (scanning skipped)
 - jar:bundle://2469cbea-ac0f-4f79-9760-2186c2e80b94_43.0:0/WEB-INF/lib/org.apache.aries.blueprint.noosgi-1.1.0.jar!/ (scanning skipped)
 - jar:bundle://2469cbea-ac0f-4f79-9760-2186c2e80b94_43.0:0/WEB-INF/lib/slf4j-api-1.7.36.redhat-00002.jar!/ (scanning skipped)
ServletContainerInitializers:
 - org.ops4j.pax.web.jsp.JasperInitializer
 - org.ops4j.pax.web.service.undertow.websocket.internal.WebSocketsInitializer
 - io.undertow.servlet.sse.ServerSentEventSCI
Container web fragments (reachable bundles without /META-INF/web-fragment.xml):
 - (231) org.ops4j.pax.web.pax-web-jsp/8.0.17
 - (237) org.ops4j.pax.web.pax-web-undertow-websocket/8.0.17
 - (193) org.apache.servicemix.specs.javax-el-api-3.0.0/3.0.0.1
 - (50) io.undertow.servlet/2.2.23.SP1-redhat-00001
 - (51) io.undertow.websockets-jsr/2.2.23.SP1-redhat-00001
 - (49) io.undertow.core/2.2.23.SP1-redhat-00001
 - (212) org.jboss.xnio.api/3.8.7.SP1-redhat-00001

24.8. web:wab-list

24.8.1. Description