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 |
