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 |
| -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
