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

Expand
NameDescription

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

Expand
NameDescription

pid

PID of the configuration

3.2.4. Options

Expand
NameDescription

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

Expand
NameDescription

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

Expand
NameDescription

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

Expand
NameDescription

url

The URL of the cfg file.

finalname

Final name of the cfg file

3.4.4. Options

Expand
NameDescription

-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

Expand
NameDescription

query

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

3.5.4. Options

Expand
NameDescription

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

Expand
NameDescription

pid

The configuration pid

3.6.4. Options

Expand
NameDescription

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

Expand
NameDescription

name

The name of the property

value

The value to append to the property

3.7.4. Options

Expand
NameDescription

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

Expand
NameDescription

property

The name of the property to delete

3.8.4. Options

Expand
NameDescription

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

Expand
NameDescription

property

The name of the property to get value for

3.9.4. Options

Expand
NameDescription

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

Expand
NameDescription

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

Expand
NameDescription

property

The name of the property to set

value

The value of the property

3.11.4. Options

Expand
NameDescription

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

Expand
NameDescription

--help

Display this help message

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat