Home
Products
Red Hat Fuse
6.2.1
Console Reference

Console Reference

Red Hat JBoss Fuse

Quick access to the Apache Karaf shell commands packaged under JBoss Fuse.

Red Hat

6.2.1

20 Sep 2017

Abstract

The primary interface for managing a container is the command console. This reference provides an easy way to see the commands, their syntax, and options.

Chapter 1. Using the Command Console
Copy link

Overview
Copy link

The Red Hat JBoss Fuse command console is the central tool for both managing the JBoss Fuse environment and interacting with Fuse Fabric. When you start JBoss Fuse the console starts automatically.

The console provides commands that you can use to perform basic management of your JBoss Fuse environment, including deploying and configuring applications.

The console uses prefixes to group commands relating to the same functionality. For example, commands related to configuration are prefixed config:, and logging-related commands are prefixed log:.

Starting the command console
Copy link

To start JBoss Fuse open a command prompt in the installation directory and enter:

Expand

Windows	`bin\fuse`
*NIX	`bin/fuse`

JBoss Fuse starts and the console is ready. You should see a prompt similar to this:

 _ ____ ______ | | _ \ | ____| | | |_) | ___ ___ ___ | |__ _ _ ___ ___ _ | | _ < / _ \/ __/ __| | __| | | / __|/ _ \ | |__| | |_) | (_) \__ \__ \ | | | |_| \__ \ __/ \____/|____/ \___/|___/___/ |_| \__,_|___/\___| JBoss Fuse (6.0.0.redhat-xxx) http://www.redhat.com/products/jbossenterprisemiddleware/fuse/ Hit '<tab>' for a list of available commands and '[cmd] --help' for help on a specific command. Hit '<ctrl-d>' or 'osgi:shutdown' to shutdown JBoss Fuse. JBossFuse:karaf@root

 _ ____ ______ | | _ \ | ____| | | |_) | ___ ___ ___ | |__ _ _ ___ ___ _ | | _ < / _ \/ __/ __| | __| | | / __|/ _ \ | |__| | |_) | (_) \__ \__ \ | | | |_| \__ \ __/ \____/|____/ \___/|___/___/ |_| \__,_|___/\___| JBoss Fuse (6.0.0.redhat-xxx) http://www.redhat.com/products/jbossenterprisemiddleware/fuse/ Hit '<tab>' for a list of available commands and '[cmd] --help' for help on a specific command. Hit '<ctrl-d>' or 'osgi:shutdown' to shutdown JBoss Fuse. JBossFuse:karaf@root

Copy to Clipboard

Toggle word wrap

Getting help
Copy link

The console provides two levels of help:

console help—lists all of the commands along with a brief summary of the commands function
command help—provides a detailed description of a command and its arguments

To access the console help, enter the help command from the console prompt. It displays a grouped list of all the commands available in the console. Each command in the list is followed by a description, as shown in Example 1.1, “Console Help”.

Example 1.1. Console Help

JBossFuse:karaf@root> help
COMMANDS activemq:browse activemq:bstat activemq:create-broker Creates a broker instance. activemq:destroy-broker Destory a broker instance. activemq:list activemq:purge activemq:query admin:change-opts Changes the Java options of an existing container instance. admin:change-rmi-registry-port Changes the RMI registry port (used by management layer) of an existing container instance.
    ...
JBossFuse:karaf@root>

JBossFuse:karaf@root> help
COMMANDS activemq:browse activemq:bstat activemq:create-broker Creates a broker instance. activemq:destroy-broker Destory a broker instance. activemq:list activemq:purge activemq:query admin:change-opts Changes the Java options of an existing container instance. admin:change-rmi-registry-port Changes the RMI registry port (used by management layer) of an existing container instance.
    ...
JBossFuse:karaf@root>

Copy to Clipboard

Toggle word wrap

The help for each command includes the definition, the syntax, and the arguments and any options. To display the help for a command, type the command with the --help option. As shown in Example 1.2, “Help for a Command”, entering admin:start --help displays the help for that command.

Example 1.2. Help for a Command

JBossFuse:karaf@root> admin:start --help
DESCRIPTION admin:start Starts an existing container instance. SYNTAX admin:start [options] name ARGUMENTS name The name of the container instance OPTIONS --help Display this help message -o, --java-opts Java options when launching the instance 
JBossFuse:karaf@root>

JBossFuse:karaf@root> admin:start --help
DESCRIPTION admin:start Starts an existing container instance. SYNTAX admin:start [options] name ARGUMENTS name The name of the container instance OPTIONS --help Display this help message -o, --java-opts Java options when launching the instance 
JBossFuse:karaf@root>

Copy to Clipboard

Toggle word wrap

Command completion
Copy link

Pressing Tab at anytime provides you with a list of commands that can complete what you have already entered at the prompt. For example, if you enter active followed by Tab, a list similar to Example 1.3, “Console Commands” is shown.

Example 1.3. Console Commands

activemq:browse activemq:bstat activemq:create-broker activemq:destroy-broker activemq:list activemq:purge activemq:query JBossA-MQ:karaf@root>

activemq:browse activemq:bstat activemq:create-broker activemq:destroy-broker activemq:list activemq:purge activemq:query JBossA-MQ:karaf@root>

Copy to Clipboard

Toggle word wrap

If you press Tab without entering anything at the prompt, the console lists all of the available commands.

Command groups
Copy link

Commands are grouped under prefixes according to functionality. Table 1.1, “Apache ActiveMQ Command Groups” summarizes the command groups available in the console. Click on a command group name for more information.

Expand

Table 1.1. Apache ActiveMQ Command Groups
Command Group	Description
activemq	Views and manages brokers and messages.
admin	Creates, manages, and destroys containers.
camel	Manages Apache Camel contexts and routes
config	Manages configuration.
cxf	Manages Apache CXF buses and endpoints.
dev	Utilities that are useful for a developer while testing bundles in the container.
fab	Manages the dependency resolution mechanism used by Fuse Application Bundles.
fabric	Performs provisioning and configuration using Fuse Fabric.
features	Performs provisioning based on Apache Karaf feature specs.
jaas	Manages the console's security settings.
jbi	Manage deployed JBI artifacts.
log	Displays and configures logging.
nmr	Lists NMR endpoints.
obr	Accesses the OSGi Bundle Repository (OBR).
osgi	Manages OSGi bundles.
packages	Lists imported and exported packages.
patch	Manages patches.
shell	Performs basic console functions
ssh	Creates and connects to a remote SSH server
web	Lists the WARs deployed in the container.
zk	Accesses and modifies entries in the Zookeeper registry.

Short version
Copy link

Many of the console commands allow you to omit the group prefix.

If the command is only in one command groups, you can omit the group prefix. For example, you can enter bstat in place of activemq:bstat because it only exists in the activemq command group.

If the command exists in multiple command groups, you can still drop the prefix and the console will default to using the version of the command from one of the following command groups:

shell
osgi
admin

For example, info is equivalent to shell:info. If you wanted to use osgi:info, you need to enter the full command.

About console input
Copy link

In console input, the Karaf shell drops leading zeros when the input appears to be a number. For example:

FuseMQ:karaf@root> echo 0123
123
FuseMQ:karaf@root> echo 00.123
0.123
FuseMQ:karaf@root>

FuseMQ:karaf@root> echo 0123
123
FuseMQ:karaf@root> echo 00.123
0.123
FuseMQ:karaf@root>

Copy to Clipboard

Toggle word wrap

This is a problem if you define a numeric username with a leading zero. The shell drops the leading zero and login attempts fail. To avoid this, do not use a zero as the first character in a numeric username. Alternatively, include at least one alphabetic character in a username.

Chapter 2. Shell Console Commands
Copy link

Expand

Table 2.21. shell:watch Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`-n`,`--interval`	Specifies the interval, in seconds, between executions of the command. The default is 1.
`command`	Specifies the command to watch and refresh.

Chapter 3. ActiveMQ Console Commands
Copy link

The activemq commands allow you to view and manage the brokers and messages.

Type activemq: then press Tab at the prompt to view the available commands.

3.1. activemq:browse, browse
Copy link

Abstract

displays messages on a specified destination

Synopsis
Copy link

activemq:browse { --amqurl brokerURL } [ --msgsel { msgsel ...} ] [ --factory className ] [ --passwordFactory className ] [ --user username ] [ --password password ] [ --view { attr ...} ] [[ -Vheader ] | [ -Vcustom ] | [ -Vbody ]] [ --version ] [[ --help ] | [ -h ] | [ -? ]] destName

Arguments
Copy link

Table 3.1, “activemq:browse Arguments” describes the command's arguments.

Expand

Table 3.1. activemq:browse Arguments
Argument	Interpretation
`--amqurl brokerURL`	Specifies the URL of the broker to which you are connecting.
`--msgsel msgsel1,msgsel2,...`	Displays messages matched by the message selector.
`--factory className`	Load className as the javax.jms.ConnectionFactory to use for creating connections.
`--passwordFactory className`	Load className as the `org.apache.activemq.console.command.PasswordFactory` for retrieving the password from a keystore.
`--user username`	Username to use for JMS connections.
`--password password`	Password to use for JMS connections.
`-Vheader`	Shows all the standard JMS message headers.
`-Vcustom`	Shows all the custom fields added to each JMS message.
`-Vbody`	Shows the body of the message.
`--view attr1,attr1,...`	Selects the specific attribute of the message to view.
`--version`	Displays the version information.
`-h, -?, --help`	Displays the online help for this command.

Message filters
Copy link

Message filters specified using the --msgsel option take the form header=value. Table 3.2, “Message Headers for Filtering” lists the headers you can use to filter messages.

Expand

Table 3.2. Message Headers for Filtering
Name	Type
`JMSCorrelationID`	`String`
`JMSDeliveryMode`	`1`-Non-Persistent, `2`-Persistent
`JMSDestination`	`javax.jms.Destination`
`JMSExpiration`	`long`
`JMSMessageID`	`String`
`JMSPriority`	`int`
`JMSRedelivered`	`boolean`
`JMSReplyTo`	`javax.jms.Destination`
`JMSTimestamp`	`long`
`JMSType`	`String`

Examples
Copy link

The following command prints the JMS message header, custom message header, and message body of all the messages in the queue TEST.FOO on a broker:

JBossA-MQ:karaf@root>activemq:browse --amqurl tcp://localhost:61616 TEST.FOO

JBossA-MQ:karaf@root>activemq:browse --amqurl tcp://localhost:61616 TEST.FOO

Copy to Clipboard

Toggle word wrap

The following command displays the attributes from the body of the messages in the TEST.FOO queue:

JBossA-MQ:karaf@root>activemq:browse --amqurl tcp://localhost:61616 -Vbody TEST.FOO

JBossA-MQ:karaf@root>activemq:browse --amqurl tcp://localhost:61616 -Vbody TEST.FOO

Copy to Clipboard

Toggle word wrap

The following command displays any messages with an ID ending in 10:

JBossA-MQ:karaf@root>activemq:browse --amqurl tcp://localhost:61616 --msgsel JMSMessaageID='*:10' TEST.FOO

JBossA-MQ:karaf@root>activemq:browse --amqurl tcp://localhost:61616 --msgsel JMSMessaageID='*:10' TEST.FOO

Copy to Clipboard

Toggle word wrap

The following command displays messages with a priority of 3, enter:

JBossA-MQ:karaf@root>activemq:browse --amqurl tcp://localhost:61616 --msgsel JMSPriority=3 TEST.FOO

JBossA-MQ:karaf@root>activemq:browse --amqurl tcp://localhost:61616 --msgsel JMSPriority=3 TEST.FOO

Copy to Clipboard

Toggle word wrap

The message selectors from the preceding two examples can be combined as follows:

JBossA-MQ:karaf@root>activemq:browse --amqurl tcp://localhost:61616 --msgsel JMSMessaageID='*:10',JMSPriority=3 TEST.FOO

JBossA-MQ:karaf@root>activemq:browse --amqurl tcp://localhost:61616 --msgsel JMSMessaageID='*:10',JMSPriority=3 TEST.FOO

Expand

Table 3.5. activemq:purge Arguments
Option	Interpretation
`--msgsel msgsel1,msgsel2,...`	Purges messages matched by the message selector. See the section called “Message filters”.
`--jmxurl URL`	Sets the JMX URL used to locate the broker.
`--pid PID`	Set the pid to connect to (only on Sun JVM).
`--jmxuser user`	Sets the JMX user, used for authentication.
`--jmxpassword password`	Sets the JMX password, used for authentication.
`--jmxlocal`	Specifies to use the local JMX server instead of a remote server
`--version`	Displays the version information
`-h, -?, --help`	Displays the online help for this command
`destName`	The specified message destination(s)

Examples
Copy link

The following command purges all the messages in the queue TEST.FOO on a broker:

JBossA-MQ:karaf@root>activemq:purge TEST.FOO

JBossA-MQ:karaf@root>activemq:purge TEST.FOO

Copy to Clipboard

Toggle word wrap

The following command purges any messages with an ID ending in 10:

JBossA-MQ:karaf@root>activemq:purge --msgsel JMSMessaageID='*:10' TEST.FOO

JBossA-MQ:karaf@root>activemq:purge --msgsel JMSMessaageID='*:10' TEST.FOO

Copy to Clipboard

Toggle word wrap

The following command purges messages with a priority of 3, enter:

JBossA-MQ:karaf@root>activemq:purge --msgsel JMSPriority=3 TEST.FOO

JBossA-MQ:karaf@root>activemq:purge --msgsel JMSPriority=3 TEST.FOO

Copy to Clipboard

Toggle word wrap

The message selectors from the preceding two examples can be combined as follows:

JBossA-MQ:karaf@root>activemq:purge --msgsel JMSMessaageID='*:10',JMSPriority=3 TEST.FOO

JBossA-MQ:karaf@root>activemq:purge --msgsel JMSMessaageID='*:10',JMSPriority=3 TEST.FOO

Copy to Clipboard

Toggle word wrap

3.5. activemq:query, query
Copy link

Abstract

queries the for broker information on specific objects

Synopsis
Copy link

activemq:query [ -QMBeanType=name ] [ -xQMBeanType=name ] [ --objname query ] [ --xobjname query ] [ --view { attr ...} ] [ --jmxurl JMXUrl ] [ --pid PID ] [ -jmxuser userName ] [ -jmxpassword password ] [ -jmxlocal ] [ --version ] [[ --help ] | [ -h ] | [ -? ]]

Arguments
Copy link

Table 3.6, “activemq:query Arguments” describes the command's arguments.

Expand

Table 3.6. activemq:query Arguments
Argument	Interpretation
`-Q type=name`	Adds to the search list the specific object type matched by the defined object identifier.
`-xQ type=name`	Removes from the search list the specific object type matched by the object identifier.
`--objname query`	Adds to the search list objects matched by the query similar.
`--xobjname query`	Removes from the search list objects matched by the query.
`--view attr1,attr2,...`	Selects the specific attribute of the object to view. By default, all attributes are displayed.
`--jmxurl URL`	Sets the JMX URL to connect to.
`--pid PID`	Set the pid to connect to (only on Sun JVM).
`--jmxuser user`	Sets the JMX user, used for authentication
`--jmxpassword password`	Sets the JMX password, used for authentication
`--jmxlocal`	Specifies to use the local JMX server instead of a remote server
`--version`	Displays the version information
`-h, -?, --help`	Displays the online help for this command

Examples
Copy link

The following command displays all attributes and object name information for all registered MBeans in the default JMX context:

JBossA-MQ:karaf@root>activemq:query

JBossA-MQ:karaf@root>activemq:query

Copy to Clipboard

Toggle word wrap

The following command displays all attributes and object name information of the destination topic TEST.FOO:

JBossA-MQ:karaf@root>activemq:query -QTopic=TEST.FOO

JBossA-MQ:karaf@root>activemq:query -QTopic=TEST.FOO

Copy to Clipboard

Toggle word wrap

The following command displays all the brokers in a context whose name ends in host:

JBossA-MQ:karaf@root>activemq:query -QBroker=*host

JBossA-MQ:karaf@root>activemq:query -QBroker=*host

Copy to Clipboard

Toggle word wrap

the Following command displays all attributes and object name information for all registered queues:

JBossA-MQ:karaf@root>activemq:query -QQueue=*

JBossA-MQ:karaf@root>activemq:query -QQueue=*

Copy to Clipboard

Toggle word wrap

The following command displays all attributes and object name information for all topics ending with .FOO except those that also begin with ActiveMQ.Advisory.:

JBossA-MQ:karaf@root>activemq:query -QTopic=*.FOO -xQTopic=ActiveMQ.Advisory.*

JBossA-MQ:karaf@root>activemq:query -QTopic=*.FOO -xQTopic=ActiveMQ.Advisory.*

Copy to Clipboard

Toggle word wrap

Chapter 4. Admin Console Commands
Copy link

Expand

Table 4.12. admin:stop Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`name`	The name of the container to start

Chapter 5. Camel Console Commands
Copy link

The camel commands are used for managing Camel contexts and routes.

Arguments
Copy link

This command takes the following arguments.

Expand

Table 5.7. camel:route-list Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`contextName`	(Optional) The Camel context name.

5.8. camel:route-resume
Copy link

Abstract

resume the specified Camel route (which was previously suspended)

Synopsis
Copy link

camel:route-resume [ --help ] { route } [ contextName ]

Arguments
Copy link

This command takes the following arguments.

Expand

Table 5.8. camel:route-resume Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`route`	The Camel route ID.
`contextName`	(Optional) The Camel context name.

5.9. camel:route-show
Copy link

Abstract

display the Camel route definition in XML format

Synopsis
Copy link

camel:route-show [ --help ] { route } [ contextName ]

Arguments
Copy link

This command takes the following arguments.

Expand

Table 5.9. camel:route-show Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`route`	The Camel route ID.
`contextName`	(Optional) The Camel context name.

5.10. camel:route-start
Copy link

Abstract

start the specified Camel route

Synopsis
Copy link

camel:route-start [ --help ] { route } [ contextName ]

Arguments
Copy link

This command takes the following arguments.

Expand

Table 5.10. camel:route-start Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`-n`,`--interval`
`route`	The Camel route ID.

5.11. camel:route-stop
Copy link

Abstract

stop the specified Camel route

Synopsis
Copy link

camel:route-stop [ --help ] { route } [ contextName ]

Arguments
Copy link

This command takes the following arguments.

Expand

Table 5.11. camel:route-stop Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`route`	The Camel route ID.
`contextName`	(Optional) The Camel context name.

5.12. camel:route-suspend
Copy link

Abstract

suspend the specified Camel route

Synopsis
Copy link

camel:route-suspend [ --help ] { route } [ contextName ]

Arguments
Copy link

This command takes the following arguments.

Expand

Table 5.12. camel:route-suspend Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`route`	The Camel route ID.
`contextName`	(Optional) The Camel context name.

5.13. camel:context-inflight
Copy link

Abstract

Displays the list of inflight exchanges.

Synopsis
Copy link

camel:context-inflight [ --help ] { contextName }

Arguments
Copy link

This command takes the following arguments.

Expand

Table 5.13. camel:context-inflight Arguments
Argument	Interpretation
`name`	The name of the Camel context.

Options
Copy link

It provides the following options.

Expand

Table 5.14. camel:context-inflight Options
Option	Interpretation
`--help`	Displays the online help for this command.
`--list`	To limit the number of exchanges shown.
`--sort`	When the value is true, sort by longest duration and when the value is false, sort by exchange id.

Chapter 6. Config Console Commands
Copy link

The config commands are used for managing container configuration. The configuration data is edited in two stages. First the changes are queued until they are dynamically loaded into the container by executing the config:update command. A copy of the configuration is persisted to the file system in the container's etc folder.

When editing a configuration the commands are used as follows:

Start the editing session for the specified configuration.
config:edit
Edits, or creates, a configuration.
- config:proplist
  Lists the properties in the configuration.
- config:propappend
  Append a new property to the configuration.
- config:propset
  Sets the value for a configuration property.
- config:propdel
  Deletes a property from the configuration.
config:update
Saves the changes and updates the containers using the configuration.

Expand

Table 6.3. config:edit Arguments
Option	Interpretation
`--help`	Displays the online help for this command
`--force`	Forces the editing of this configuration, even if another configuration was being edited
`-f`, `--use-file`	Use a filename instead of the PID to locate the configuration
`pid`	The persistent identifier of the configuration

6.4. config:list
Copy link

Abstract

lists the existing configurations for the container

Synopsis
Copy link

config:list [ --help ] [ query ]

Arguments
Copy link

Table 6.4, “config:list Arguments” describes the command's arguments.

Expand

Table 6.4. config:list Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`query`	An LDAP query

6.5. config:propappend, propappend
Copy link

Abstract

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

Synopsis
Copy link

config:propappend [ --help ] [[ -b ] | [ --bypass-storage ]] [[ -p PID ] | [ --pid PID ]] { name } { value }

Details
Copy link

When you append a value to a property using the config:propappend command, the change is stored in the buffer and not propagated to the container until the editing session is closed.

If you use the -p argument to specify a PID, however, the change is made immediately.

Arguments
Copy link

Table 6.5, “config:propappend Arguments” describes the command's arguments.

Expand

Table 6.5. config:propappend Arguments
Argument	Interpretation
`--help`	Displays the online help for this command.
`-b`, `--bypass-storage`	Doe not write the change to the local file.
`-p`, `--pid`	Specifies the PID of the configuration in which to make the change. The default is to change the configuration currently open for editing.
`name`	Specifies the name of the property to change.
`value`	Specifies the value to append to the property.

6.6. config:propdel, propdel
Copy link

Abstract

deletes a property from the configuration being edited

Synopsis
Copy link

config:propdel [ --help ] [[ -b ] | [ --bypass-storage ]] [[ -p PID ] | [ --pid PID ]] { name }

Details
Copy link

When you delete a property using the config:propdel command, the change is stored in the buffer and not propagated to the container until the editing session is closed.

If you use the -p argument to specify a PID, however, the change is made immediately.

Arguments
Copy link

Table 6.6, “config:propdel Arguments” describes the command's arguments.

Expand

Table 6.6. config:propdel Arguments
Argument	Interpretation
`--help`	Displays the online help for this command.
`-b`, `--bypass-storage`	Does not write the change to the local file.
`-p`, `--pid`	Specifies the PID of the configuration in which to make the change. The default is to change the configuration currently open for editing.
`name`	Specifies the name of the property to delete.

6.7. config:proplist, proplist
Copy link

Abstract

lists the properties in the configuration being edited

Synopsis
Copy link

config:proplist [ --help ] [[ -p PID ] | [ --pid PID ]]

Arguments
Copy link

Table 6.7, “config:proplist Arguments” describes the command's arguments.

Expand

Table 6.7. config:proplist Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`-p`, `--pid`	The PID of the configuration in which to make the change

6.8. config:propset, propset
Copy link

Abstract

sets a property in the configuration being edited

Synopsis
Copy link

config:propset [ --help ] [[ -b ] | [ --bypass-storage ]] [[ -p PID ] | [ --pid PID ]] { name } { value }

Details
Copy link

When you set a property using the config:propset command, the change is stored in the buffer and not propagated to the container until the editing session is closed.

If you use the -p argument to specify a PID, however, the change is made immediately.

Arguments
Copy link

Table 6.8, “config:propset Arguments” describes the command's arguments.

Expand

Table 6.8. config:propset Arguments
Argument	Interpretation
`--help`	Displays the online help for this command.
`-b`, `--bypass-storage`	Does not write the change to the local file.
`-p`, `--pid`	Specifies the PID of the configuration in which to make the change. The default is to change the configuration currently open for editing.
`name`	Specifies the name of the property to set.
`value`	Specifies the value to set for the property.

6.9. config:update
Copy link

Abstract

saves the changes made to the configuration being edited and propagates then to the container

Synopsis
Copy link

config:propset [ --help ] [[ -b ] | [ --bypass-storage ]]

Arguments
Copy link

Table 6.9, “config:update Arguments” describes the command's arguments.

Expand

Table 6.9. config:update Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`-b`, `--bypass-storage`	Do not update the copy of the configuration on the file system

Chapter 7. CXF Console Commands
Copy link

The cxf commands are used for managing Apache CXF buses and endpoints. If these commands are not already loaded into the console, you can load them using the following console command:

JBossFuse:karaf@root> features:install cxf-osgi

JBossFuse:karaf@root> features:install cxf-osgi

Expand

Table 7.4. cxf:stop-endpoint Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`busID`	The Apache CXF bus ID.
`endpointName`	The name of the Apache CXF endpoint.

Chapter 8. Dev Console Commands
Copy link

For example, the various command sets installed in the console (shell:*, admin:*, features:*, and so on) are represented by OSGi services of type, org.apache.karaf.shell.console.SubShell. If you want to check that a sub-shell service is available, you could enter the following console command:

karaf@root> dev:wait-for-service -t 1000 org.apache.karaf.shell.console.SubShell
true

karaf@root> dev:wait-for-service -t 1000 org.apache.karaf.shell.console.SubShell
true

Copy to Clipboard

Toggle word wrap

This form of the command is not very useful in this case, because there are many different instances of the SubShell service installed in the container. To be more specific, you can define an LDAP filter, which specifies one or more service property values. For example, you can wait specifically for the osgi sub-shell service by entering a command like the following:

karaf@root> dev:wait-for-service -t 1000 &(objectClass=org.apache.karaf.shell.console.SubShell)(name=osgi)
true

karaf@root> dev:wait-for-service -t 1000 &(objectClass=org.apache.karaf.shell.console.SubShell)(name=osgi)
true

Copy to Clipboard

Toggle word wrap

Arguments
Copy link

Table 8.9, “dev:wait-for-service Arguments” describes the commands arguments.

Expand

Table 8.9. dev:wait-for-service Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`-t, --timeout`	Timeout (specified in milliseconds: negative to not wait at all, zero to wait forever). Default is forever.
`-e, --exception`	Throw an exception if the wait command times out (the service is not found). Default is false.
`serviceClassOrFilter`	Specifies the OSGi service either by the service's class name or by an LDAP-style filter (which is applied to the OSGi service's properties).

8.10. dev:watch, watch
Copy link

Abstract

watches and automatically updates bundles

Synopsis
Copy link

dev:watch [ --help ] [[ --start ] | [ --stop ]] [ -i interval ] [ --list ] [ --remove ] { bundles ...}

Arguments
Copy link

Table 8.10, “dev:watch Arguments” describes the commands arguments.

Expand

Table 8.10. dev:watch Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`--stop`	Stop watching the specified bundles
`--start`	Start watching the specified bundles
`-i`	Specifies the interval, in milliseconds, to check the bundles.
`--list`	List the bundles being watched.
`--remove`	Remove the specified bundles from the watch list.
`bundles...`	Specifies a whitespace delimited list of bundle URLs or bundle IDs.

Important

Only Maven URLs and Maven snapshots will be updated automatically. So, if you run

JBossA-MQ:karaf@root> dev:watch *

JBossA-MQ:karaf@root> dev:watch *

Copy to Clipboard

Toggle word wrap

You are monitoring all bundles that have a location matching mvn:* that have -SNAPSHOT in their URL.

Chapter 9. Fabric Console Commands
Copy link

This chapter describes fabric console commands.

9.1. fabric:cluster-list
Copy link

Abstract

lists the members of a cluster

Synopsis
Copy link

fabric:cluster-list [ --help ] [ Path ]

Description
Copy link

This command lists the members of the specified cluster, where the cluster can be a cluster of message brokers, a cluster of servlets, or a cluster of Web applications.

For example, to list all of the servlet services in the Fabric, enter the following console command:

fabric:cluster-list servlets

fabric:cluster-list servlets

Copy to Clipboard

Toggle word wrap

To list all of the Web application services in the Fabric, enter the following console command:

fabric:cluster-list webapps

fabric:cluster-list webapps

Copy to Clipboard

Toggle word wrap

Arguments
Copy link

Table 9.1, “fabric:cluster-list Arguments” describes the command's arguments.

Expand

Table 9.1. fabric:cluster-list Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`Path`	Path of the fabric registry node (Zookeeper registry node) to list. Relative paths are evaluated relative to the base node, `/fabric/registry/clusters`. If not specified, all clusters are listed

9.2. fabric:cloud-firewall-edit
Copy link

Abstract

manage a cloud container's firewall

Synopsis
Copy link

fabric:cloud-firewall-edit [ --help ] [ --owner owner ] [ --option key=value ]

Arguments
Copy link

Table 9.2, “fabric:cloud-firewall-edit Arguments” describes the command's arguments.

Expand

Table 9.2. fabric:cloud-firewall-edit Arguments
Argument	Interpretation
`--port`	The target IP port. To specify multiple ports, specify this flag multiple times on the command line—for example, `--port 1234 --port 5678`.
`--flush`	Flush all rules.
`--revoke`	Revoke the rule for the specified port. This blocks access to the specified IP port.
`--target-container`	The target container name.
`--source-container`	The source container, which has access granted or revoked.
`--target-node-id`	The target node ID.
`--source-cidr`	The source CIDR, which has access granted or revoked.
`--provider`	The cloud provider name.
`--help`	Displays the online help for this command.

9.3. fabric:cloud-service-add
Copy link

Abstract

initialize a cloud provider (which can be used for provisioning containers in the cloud)

Synopsis
Copy link

fabric:cloud-service-add [ --help ] [ --provider providerName ] [ --name name ] [ --api APIName ] [ --endpoint URL ] [ --identity accessKeyID ] [ --credential secretAccessKey ] [ --owner owner ] [ --option key=value ] [ --async-registration ]

Description
Copy link

This command runs asynchronously. That is, although the command returns immediately, it runs a thread in the background, which completes the initialization of the cloud provider. You can use fabric:cloud-service-list to discover when the initialization has completed.

There are two different styles of usage for this command:

Commercial cloud provider—if you are using a commercial cloud provider, JClouds provides prepackaged modules that encapsulate the basic connection details for the provider. The prepackaged modules are available to install as Karaf features (named jclouds-ProviderName) and encapsulate such details as the endpoint URI, cloud API, and so on.
For example, to install an Amazon Web Services (AWS) EC2 cloud provider, you can perform the following steps (assuming you are working in a standalone container):
1. Install the basic set of fabric cloud commands:
  karaf@root> features:install fabric-jclouds
  Copy to Clipboard Toggle word wrap
2. Install the JClouds module specifically for AWS EC2:
  karaf@root> features:install jclouds-aws-ec2
  Copy to Clipboard Toggle word wrap
3. Add the AWS EC2 provider, specifying the login credentials for your EC2 account:
  karaf@root> fabric:cloud-service-add --provider aws-ec2 --identity AccessKeyID --credential SecretAccessKey
  Copy to Clipboard Toggle word wrap
4. You are now ready to start creating compute instances on the aws-ec2 cloud service, using the fabric:container-create-cloud command.
Private cloud service—if you are hosting your compute instances on a private cloud service, you must specify the connection details more explicitly, by supplying the --api and --endpoint options. In this case, you must also define a name for the cloud service, by supplying the --name option.
For example, to define a connection to a private cloud service that uses the openstack-nova API through the endpoint, http://172.16.0.1:4000/v2.0/, you can perform the following steps (assuming you are working in a standalone container):
1. Install the basic set of fabric cloud commands:
  karaf@root> features:install fabric-jclouds
  Copy to Clipboard Toggle word wrap
2. Install the JClouds module for the openstack-nova API:
  karaf@root> features:install jclouds-api-openstack-nova
  Copy to Clipboard Toggle word wrap
3. Add the private cloud service, specifying the login credentials, API, and endpoint URL:
  karaf@root> fabric:cloud-service-add --name myOpenStack --api openstack-nova --endpoint http://172.16.0.1:4000/v2.0/ --identity AccessKeyID --credential SecretAccessKey
  Copy to Clipboard Toggle word wrap
  Note
  You can provide additional customisation of the connection by setting options through the --option flag (which can appear multiple times in the command).
4. You are now ready to start creating compute instances on the myOpenStack cloud service, using the fabric:container-create-cloud command.

Installing the command in a fabric
Copy link

To access this command from a fabric container, you must have installed the fabric-jclouds feature. To install the fabric-jclouds feature, deploy the cloud profile into the current container, using the fabric:container-change-profile command.

For example, if the console is currently logged on to the root container of the Fabric, you could add the cloud profile as follows:

JBossA-MQ:karaf@root> fabric:container-list
[id]                           [version] [alive] [profiles]                     [provision status]
root*                          1.0       true    fabric, fabric-ensemble-0000-1 success
JBossA-MQ:karaf@root> fabric:container-change-profile root fabric fabric-ensemble-0000-1 cloud
JBossA-MQ:karaf@root> fabric:container-list
[id]                           [version] [alive] [profiles]                     [provision status]
root*                          1.0       true    fabric, fabric-ensemble-0000-1, cloud success

JBossA-MQ:karaf@root> fabric:container-list
[id]                           [version] [alive] [profiles]                     [provision status]
root*                          1.0       true    fabric, fabric-ensemble-0000-1 success
JBossA-MQ:karaf@root> fabric:container-change-profile root fabric fabric-ensemble-0000-1 cloud
JBossA-MQ:karaf@root> fabric:container-list
[id]                           [version] [alive] [profiles]                     [provision status]
root*                          1.0       true    fabric, fabric-ensemble-0000-1, cloud success

Copy to Clipboard

Toggle word wrap

Arguments
Copy link

Table 9.3, “fabric:cloud-service-add Arguments” describes the command's arguments.

Expand

Table 9.3. fabric:cloud-service-add Arguments
Argument	Interpretation
`--help`	Displays the online help for this command.
`--provider`	The name of a commercial cloud provider (for example, `aws-ec2` or `rackspace`).
`--name`	The JClouds service context name, which identifies the cloud service uniquely. Defaults to the provider name (as specified by the `--provider` option).
`--api`	Specifies the cloud API (for example, `ec2`, `openstack-nova`, or `cloudstack`).
`--endpoint`	Specifies the cloud service's endpoint URL.
`--identity`	The identity used to access the cloud service.
`--credential`	The credential used to access the cloud service.
`--owner`	Specifies the EC2 AMI owner, which enables you to use private images (AWS EC2 only).
`--option`	Provider-specific properties. For example: `--option jclouds.regions=us-east-1`. If you want to specify more than one option, specify this option multiple times.
`--async-registration`	Do not wait for the provider registration (that is, complete the registration in a background thread).

9.4. fabric:cloud-service-list
Copy link

Abstract

list the configured cloud providers

Synopsis
Copy link

fabric:cloud-service-list [ --help ]

Description
Copy link

For each configured cloud provider, displays the provider name, type (compute or blobstore), and registration (local, for a standalone container, or fabric, for a Fabric Container).

To access this command, the current container must belong to a Fabric and you must have installed the fabric-jclouds feature. To install the fabric-jclouds feature, deploy the cloud profile into the current container, using the fabric:container-change-profile command.

For example, if the console is currently logged on to the root container of the Fabric, you could add the cloud profile as follows:

JBossA-MQ:karaf@root> fabric:container-list
[id] [version] [alive] [profiles] [provision status] root* 1.0 true fabric, fabric-ensemble-0000-1 success
JBossA-MQ:karaf@root> fabric:container-change-profile root fabric fabric-ensemble-0000-1 cloud
JBossA-MQ:karaf@root> fabric:container-list
[id] [version] [alive] [profiles] [provision status] root* 1.0 true fabric, fabric-ensemble-0000-1, cloud success

JBossA-MQ:karaf@root> fabric:container-list
[id] [version] [alive] [profiles] [provision status] root* 1.0 true fabric, fabric-ensemble-0000-1 success
JBossA-MQ:karaf@root> fabric:container-change-profile root fabric fabric-ensemble-0000-1 cloud
JBossA-MQ:karaf@root> fabric:container-list
[id] [version] [alive] [profiles] [provision status] root* 1.0 true fabric, fabric-ensemble-0000-1, cloud success

Copy to Clipboard

Toggle word wrap

Arguments
Copy link

Table 9.4, “fabric:cloud-service-list Arguments” describes the command's arguments.

Expand

Table 9.4. fabric:cloud-service-list Arguments
Argument	Interpretation
`--help`	Displays the online help for this command.

9.5. fabric:cloud-service-remove
Copy link

Abstract

removes the specified cloud provider

Synopsis
Copy link

fabric:cloud-service-remove [ --help ] { Name }

Description
Copy link

For example, if the console is currently logged on to the root container of the Fabric, you could add the cloud profile as follows:

JBossA-MQ:karaf@root> fabric:container-list
[id]                           [version] [alive] [profiles]                     [provision status]
root*                          1.0       true    fabric, fabric-ensemble-0000-1 success
JBossA-MQ:karaf@root> fabric:container-change-profile root fabric fabric-ensemble-0000-1 cloud
JBossA-MQ:karaf@root> fabric:container-list
[id]                           [version] [alive] [profiles]                     [provision status]
root*                          1.0       true    fabric, fabric-ensemble-0000-1, cloud success

JBossA-MQ:karaf@root> fabric:container-list
[id]                           [version] [alive] [profiles]                     [provision status]
root*                          1.0       true    fabric, fabric-ensemble-0000-1 success
JBossA-MQ:karaf@root> fabric:container-change-profile root fabric fabric-ensemble-0000-1 cloud
JBossA-MQ:karaf@root> fabric:container-list
[id]                           [version] [alive] [profiles]                     [provision status]
root*                          1.0       true    fabric, fabric-ensemble-0000-1, cloud success

Copy to Clipboard

Toggle word wrap

Arguments
Copy link

Table 9.5, “fabric:cloud-service-remove Arguments” describes the command's arguments.

Expand

Table 9.5. fabric:cloud-service-remove Arguments
Argument	Interpretation
`--help`	Displays the online help for this command.
`Name`	The JClouds service context name, which represents the cloud provider.

9.6. fabric:container-add-profile, container-add-profile
Copy link

Abstract

Adds the specified list of profiles to a container

Synopsis
Copy link

fabric:container-add-profile [ --help ] { Name } { Profiles }

Arguments
Copy link

Table 9.6, “fabric:container-add-profile Arguments” describes the command's arguments.

Expand

Table 9.6. fabric:container-add-profile Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`Name`	Specifies the name of the container.
`Profiles`	Specifies the list of profiles to add to the container.

9.7. fabric:container-change-profile, container-change-profile
Copy link

Abstract

replaces a fuse container's profiles with the specified list of profiles

Synopsis
Copy link

fabric:container-change-profile [ --help ] { Name } { Profiles }

Arguments
Copy link

Table 9.7, “fabric:container-change-profile Arguments” describes the command's arguments.

Expand

Table 9.7. fabric:container-change-profile Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`Name`	Specifies the name of the container.
`Profiles`	Specifies the list of profiles to deploy into the container.

9.8. fabric:container-connect, container-connect
Copy link

Abstract

connects to a remote Fabric Container and execute the specified command

Synopsis
Copy link

fabric:container-connect [ --help ] [[ -u ] | [ --username ]User] [[ -p ] | [ --password ]Password] { ContainerName } [ Command ]

Description
Copy link

This command allows you to connect to any container in the current fabric and execute a command. For example, to execute the osgi:list command on the root2 container, you could enter a console command like Example 9.1, “Executing a Command in a Remote Container”.

Example 9.1. Executing a Command in a Remote Container

JBossA-MQ:karaf@root> fabric:container-connect -u YourName -p YourPass root2 osgi:list

JBossA-MQ:karaf@root> fabric:container-connect -u YourName -p YourPass root2 osgi:list

Copy to Clipboard

Toggle word wrap

This command uses fabric JAAS security to log into the container, so the username and password are managed by the container's JAAS realm.

Arguments
Copy link

Table 9.8, “fabric:container-connect Arguments” describes the command's arguments.

Expand

Table 9.8. fabric:container-connect Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`-u, --username`	Specifies the username for logging on to the remote container. The default is `admin`.
`-p, --password`	SPecifies the password for logging on to the remote container. The default is `admin`.
`ContainerName`	Specifies the name of the remote container.
`Command`	Specifies the console command to execute on the remote container.

9.9. fabric:container-create-child
Copy link

Abstract

create one or more child containers

Synopsis
Copy link

fabric:container-create-child [ --help ] [ --ensemble-server ] [ --profile profileID ] [ --version version ] [ --jmx-user jmxUser ] [ --jmx-password jmxPass ] [ -b, --bind-address bindAddr ] [ --datastore-type storeType ] [ --datastore-option storeOption ] [ --zookeeper-password zooPass ] [ --jvm-opts jvmOpts ] [ --resolver policy ] [ -m, --manual-ip IPAddr ] { parent } { name } [ number ]

Description
Copy link

Child containers have the following characteristics:

Each child container has a parent, so that the child containers form a hierarchy, with the root container as the ultimate ancestor.
The child starts in a new JVM instance (JVM options can be passed to the new JVM through the --jvm-opts command option).
A complete set of data directories are created for the child instance, under the ESBInstallDir/instances/ChildName directory. The ESBInstallDir/system directory is shared with the root container.

For example, if you have already created a new fabric (for example, by invoking fabric:create), you could add some child containers to the root container by entering the following command:

karaf@root> fabric:container-create-child root child 3

karaf@root> fabric:container-create-child root child 3

Copy to Clipboard

Toggle word wrap

This command creates three new children under the root container. To check that the containers have been successfully created, invoke the fabric:container-list command, as follows:

karaf@root> fabric:container-list
[id]                           [version] [alive] [profiles]                     [provision status]
root                           1.0       true    fabric, fabric-ensemble-0000-1 
  child1                       1.0       true    default                        success
  child2                       1.0       true    default                        success
  child3                       1.0       true    default                        success

karaf@root> fabric:container-list
[id]                           [version] [alive] [profiles]                     [provision status]
root                           1.0       true    fabric, fabric-ensemble-0000-1 
  child1                       1.0       true    default                        success
  child2                       1.0       true    default                        success
  child3                       1.0       true    default                        success

Copy to Clipboard

Toggle word wrap

As you can see, the command creates three new child containers, child1, child2, and child3, with the default profile. This containers are ordinary (non-ensemble) containers, running fabric agents (ZooKeeper clients).

If you do not explicitly specify any profile (or profiles) for the new child containers, each of the child containers is created with the OSGi bundles required for a minimal Apache Karaf container and all of the profiles and bundles specified by the default profile.

To associate multiple profiles with a new child container, you can specify the --profile option multiple times. For example, if you want to deploy your own application profile, myApp, together with the esb profile, you would use a command like the following:

fabric:container-create-child --profile esb --profile myApp root childMyApp

fabric:container-create-child --profile esb --profile myApp root childMyApp

Copy to Clipboard

Toggle word wrap

Shutting down child containers
Copy link

After you create new child containers, the children run as separate processes, independently of the parent. Consequently, when you shut down the parent container, the child processes continue to run in the background. If you want to shut down the children, you must explicitly invoke the fabric:container-stop command. For example, if a root container has three children—child1, child2, and child3—you can issue the following commands in the root container console to shut down all of the containers:

karaf@root> fabric:container-stop child1
karaf@root> fabric:container-stop child2
karaf@root> fabric:container-stop child3
karaf@root> shutdown -f

karaf@root> fabric:container-stop child1
karaf@root> fabric:container-stop child2
karaf@root> fabric:container-stop child3
karaf@root> shutdown -f

Copy to Clipboard

Toggle word wrap

Arguments
Copy link

Table 9.9, “fabric:container-create-child Arguments” describes the command's arguments.

Expand

Table 9.9. fabric:container-create-child Arguments
Argument	Interpretation
`--help`	Displays the online help for this command.
`--jmx-user`	The JMX username of the parent container.
`--jmx-password`	The JMX password of the parent container.
`--ensemble-server`	Whether the new container should be a Fabric Server.
`--profile`	A profile ID to associate with the new container. To associate multiple profiles with the container, specify this flag multiple times on the command line—for example, `--profile foo --profile bar`. If no profile is specified, the container is associated with the `default` profile.
`--resolver`	Specifies how the container will report its address to other containers. Valid values are `localip`, `localhostname`, `publicip`, `publichostname`, `manualip`. For more information see Section 9.20, “fabric:container-resolver-set”.
`-m, --manual-ip`	The IP address to use, when using the `manualip` resolver. Used in combination with the `--resolver` option.
`-b, --bind-address`	Specifies the default bind address.
`--datastore-type`	Specifies the datastore type.
`--datastore-option`	Options to pass to the container's datastore. To specify multiple options, use this flag multiple times.
`--zookeeper-password`	Used in combination with the `--ensemble-server` option. If creating an ensemble server, specifies the Zookeeper password to use (if not specified, a password is generated automatically).
`--version`	Specifies the version of the new container (the version must be created in advance using `fabric:version-create`). Defaults to the current default version (use `version-list` to find the current default).
`--jvm-opts`	Specify options to pass to the container's JVM.
`Parent`	(Required) The parent container ID.
`Name`	(Required) The name of the container to create. When creating multiple containers, it serves as a prefix
`Number`	The number of containers that should be created.

9.10. fabric:container-create-cloud
Copy link

Abstract

creates one or more new containers on the cloud

Synopsis
Copy link

fabric:container-create-cloud [ --help ] [ --name contextName ] [ --provider cloudProvider ] [ --api cloudAPI ] [ --identity cloudIdentity ] [ --credential loginCredential ] [ --imageId imageID ] [ --os-family osFamily ] [ --os-version osVersion ] [ --hardwareId hardwareID ] [ --instanceType instanceType ] [ --locationId location ] [ --user userAcc ] [ --password userPass ] [ --public-key-file file ] [ --owner owner ] [ --group group ] [ --proxy-uri URI ] [ --ensemble-server ] [ --new-user jaasUser ] [ --new-user-password jaasUserPass ] [ --new-user-role jaasUserRole ] [ -b, --bind-address bindAddress ] [ --datastore-type storeType ] [ --datastore-option storeOption ] [ --zookeeper-password zooPass ] [ --resolver policy ] [ -m, --manual-ip IPAddr ] [ --env key=value ] [ --min-port minPort ] [ --max-port maxPort ] [ --profile profileID ] [ --version version ] [ --jvm-opts jvmOpts ] [ --add-option key=value ] [ --no-admin-access ] [ --path installPath ] { Name } [ Number ]

Description
Copy link

To access this command, you must have installed the fabric-jclouds feature. To install the fabric-jclouds feature, enter the following console command:

features:install fabric-jclouds

features:install fabric-jclouds

Copy to Clipboard

Toggle word wrap

The fabric:container-create-cloud command provisions the container as follows:

Creates a new node on the cloud provider. The node is created using a JClouds compute service: either by lookup in the service registry (using the provider ID as a property) or by instantiating a new node, by specifying the identity and credential of the provider.
Connects to the created node, using the authentication metadata returned upon the node creation (this is usually a username and private key, where the username can be overridden by the --user option). After it connects to the node, it executes a script, which downloads the fabric distribution from the Maven proxy and untars the distribution.
By default, the script uses the oldest Maven proxy server in the current ensemble (every ensemble server has a Maven proxy server deployed in it). You can optionally override the default Maven proxy by specifying the --proxy-uri option. The script would then use the specified Maven proxy server to download the container runtime.
Note
The ability to override the Maven proxy is important in certain cases (for example, in a cloud deployment) where the remote host might not be able to access the default Maven proxy server.
Starts up the newly installed container (or containers) and installs the specified fabric profile (or profiles).
When creating multiple containers using this command (by adding the Number argument), multiple nodes will be created and a root container will be installed on each node.

By default, the newly created cloud containers belong to the current fabric (that is, the same fabric as the container from which you invoked the command). It is possible, however, to create a container on the compute instance that acts as the seed for a completely new fabric, separate from the current one. To create a new fabric on the compute instance, invoke the fabric:container-create-cloud command with the --ensemble-server flag, which makes the newly created container (or containers) an ensemble server, with its own fabric registry agent. The newly created ensemble server on the cloud does not join the current ensemble: it belongs to an independent ensemble (a new fabric).

Arguments
Copy link

Table 9.10, “fabric:container-create-cloud Arguments” describes the command's arguments.

Expand

Table 9.10. fabric:container-create-cloud Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`--name`	(Required) JClouds service context name.
`--provider`	JClouds provider name.
`--api`	The cloud API name.
`--identity`	The identity used to access the cloud service.
`--credential`	The credential used to access the cloud service.
`--imageId`	The image ID to use for the new node(s). Alternatively, the image can be specified indirectly using the `--os-family` and `--os-version` options. Defaults to an instance of the latest version of Ubuntu.
`--os-family`	Specify the image by requesting a particular kind of operating system—for example, `ubuntu` or `redhat`. To see which O/S families are available, type Tab while entering this option. Defaults to `ubuntu`.
`--os-version`	Specifies the version of the O/S family. The version number need not be exact (it will be rounded up to the latest available patch version). Defaults to the latest version available.
`--hardwareId`	Kind of hardware to use.
`--instanceType`	Type of instance required.
`--locationId`	The location used to create the new node(s).
`--user`	Specifies the O/S user account to run on the new nodes. If the user account does not already exist on the new nodes, it will automatically be created. Defaults to the username that matches the current user.
`--password`	Specifies the password associated with the O/S user account defined by the `--user` option.
`--public-key-file`	An option to specify a public key file to copy to the created node. Copying a public key file to a node can be used for SSH access using public key authentication. If no key file is specified, Fabric attempts to auto-detect the user's public key and, if found, this key will be used by default.
`--owner`	Optional owner of images; only really used for EC2, and will be deprecated in future.
`--group`	Group tag to use on the new node(s). Defaults to `fabric`.
`--proxy-uri`	URL of the Maven proxy server used to download the container runtime.
`--ensemble-server`	Whether the new container should be a Fabric Server (effectively creates a new fabric).
`--new-user`	Used in combination with the `--ensemble-server` option to ensure that at least one user exists in the JAAS realm of the Zookeeper login module for the new fabric (otherwise it would be impossible to connect to the newly created Fabric Server). When using this option, you must also specify a password using the `--new-user-password` option.
`--new-user-password`	Used in combination with the `--new-user` option and the `--ensemble-server` option to specify the new user's password. No default value.
`--new-user-role`	Used in combination with the `--new-user` option and the `--ensemble-server` to specify the new user's role. Default is `admin`.
`-b, --bind-address`	Specifies the default bind address.
`--datastore-type`	Specifies the datastore type.
`--datastore-option`	Options to pass to the container's datastore. To specify multiple options, use this flag multiple times.
`--zookeeper-password`	Used in combination with the `--ensemble-server` option. Specifies the Zookeeper password, which is used to access the Zookeeper nodes under the `/fabric/` path. Defaults to the password of the current session user. If you subsequently try to join the current container to the newly-created Fabric Server (ensemble server) using the `fabric:join` command, you will be prompted to enter the Zookeeper password.
`--resolver`	Specifies how the container will report its address to other containers. Valid values are `localip`, `localhostname`, `publicip`, `publichostname`, `manualip`. For more information see Section 9.20, “fabric:container-resolver-set”.
`-m, --manual-ip`	The IP address to use, when using the `manualip` resolver. Used in combination with the `--resolver` option.
`--env`	Sets an environment variable. To specify multiple environment variables, use this flag multiple times.
`--min-port`	Specifies the minimum port number of the allowed IP port range. Default is `0`.
`--max-port`	Specifies the maximum port number of the allowed IP port range. Default is `65535`.
`--profile`	A list of profile IDs to associate with the new container.
`--version`	Specifies the version of the new container (the version must be created in advance using `fabric:version-create`). Defaults to the current default version (use `version-list` to find the current default).
`--jvm-opts`	Specify options to pass to the container's JVM.
`--add-option`	Specifies generic JCloud properties or provider-specify properties. For example, when using Amazon with Amazon VPC to create a container inside a VPN, you can specify `--option subnetId=yoursubnetId` to define the VPC subnet where you want the node to be created. If you want to specify more than one option, specify this option multiple times.
`--no-admin-access`	Disables admin access, as it might not be feasible on all images.
`--path`	Path on the remote filesystem where the container is to be installed.
`Name`	(Required) The name of the container to create. When creating multiple containers, it serves as a prefix.
`Number`	The number of containers that should be created.

9.11. fabric:container-create-ssh
Copy link

Abstract

creates one or more new containers through SSH

Synopsis
Copy link

fabric:container-create-ssh [ --help ] [ --host host ] [ --port port ] [ --min-port minPort ] [ --max-port maxPort ] [ --path path ] [ --user user ] [ --password password ] [ --new-user newUser ] [ --new-user-password newPassword ] [ --new-user-role newRole ] [ --private-key keyPath ] [ --pass-phrase passPhrase ] [ --ssh-retries retries ] [ --proxy-uri URI ] [ --ensemble-server ] [ --profile profileID ] [ --version version ] [ -b, --bind-address bindAddress ] [ --datastore-type storeType ] [ --datastore-option storeOption ] [ --zookeeper-password zooPass ] [ --jvm-optsjvmOpts ] [ --resolver policy ] [ -m, --manual-ip IPAddr ] [ --env key=value ] [ --with-admin-access ] [ --disable-distribution-upload ] { Name } [ Number ]

Description
Copy link

Specifically, this command provisions the container as follows:

Logs into the specified SSH host, using either the provided username and password or using the provided username and private key.
Runs a script on the remote host that that downloads the container runtime to the remote host. The runtime files are downloaded through a Maven proxy server. By default, the script uses the oldest Maven proxy server in the current ensemble (every Fabric Server has a Maven proxy server deployed in it). You can optionally override the default Maven proxy by specifying the --proxy-uri option. The script would then use the specified Maven proxy server to download the container runtime.
Note
The ability to override the Maven proxy is important in certain cases (for example, in a cloud deployment) where the remote host might not be able to access the default Maven proxy server.
Starts up the newly installed container (or containers) and installs the specified fabric profile (or profiles).

By default, the newly created containers belong to the current fabric (that is, the same fabric as the container from which you invoked the command). It is possible, however, to create a container on the remote host that acts as the seed for a completely new fabric, separate from the current one. To create a new fabric on the remote host, invoke the fabric:container-create-ssh command with the --ensemble-server flag, which makes the newly created container (or containers) a Fuse Server. The newly created Fuse Server on the remote host does not join the current ensemble: it belongs to an independent ensemble (a new fabric).

Arguments
Copy link

Table 9.11, “fabric:container-create-ssh Arguments” describes the command's arguments.

Expand

Table 9.11. fabric:container-create-ssh Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`--host`	(Required) Host name to SSH into.
`--port`	The IP port number for the SSH connection. Default is `22`.
`--min-port`	The minimum port number of the allowed IP port range. Default is `0`.
`--max-port`	The maximum port number of the aollowed IP port range. Default is `65535`.
`--path`	Path on the remote filesystem where the container is to be installed.
`--user`	(Required) User name for login.
`--password`	Password for login. If the password is omitted, private key authentication is used instead.
`--new-user`	Used in combination with the `--ensemble-server` option to ensure that at least one user exists in the JAAS realm of the Zookeeper login module for the new fabric (otherwise it would be impossible to connect to the newly created Fabric Server). When using this option, you must also specify a password using the `--new-user-password` option.
`--new-user-password`	Used in combination with the `--new-user` option and the `--ensemble-server` option to specify the new user's password. No default value.
`--new-user-role`	Used in combination with the `--new-user` option and the `--ensemble-server` to specify the new user's role. Default is `admin`.
`--private-key`	Specifies the path to the private key on the local file system. The default is `~/.ssh/id_rsa` on *NIX platforms or `C:\Documents and Settings\UserName\.ssh\id_rsa` on Windows.
`--pass-phrase`	The pass phrase of the key, if private key authentication is used and the private key is encrypted.
`--ssh-retries`	Maximum number or times to retry SSH connection.
`--proxy-uri`	URL of the Maven proxy server used to download the container runtime.
`--ensemble-server`	Whether the new container should be a Fabric Server.
`--profile`	A list of profile IDs to associate with the new container.
`--version`	Specifies the version of the new container (the version must be created in advance using `fabric:version-create`). Defaults to the current default version (use `version-list` to find the current default).
`-b, --bind-address`	Specifies the default bind address.
`--datastore-type`	Specifies the datastore type.
`--datastore-option`	Options to pass to the container's datastore. To specify multiple options, use this flag multiple times.
`--zookeeper-password`	Used in combination with the `--ensemble-server` option. If creating an ensemble server, specifies the Zookeeper password to use (if not specified, a password is generated automatically).
`--jvm-opts`	Specify options to pass to the container's JVM.
`--resolver`	Specifies how the container will report its address to other containers. Valid values are `localip`, `localhostname`, `publicip`, `publichostname`, `manualip`. For more information see Section 9.20, “fabric:container-resolver-set”.
`-m, --manual-ip`	The IP address to use, when using the `manualip` resolver. Used in combination with the `--resolver` option.
`--env`	Sets an environment variable. To specify multiple environment variables, use this flag multiple times.
`--with-admin-access`	Indicates that the target user has administrative access (password-less `sudo`). When this option is specified, Fabric will attempt to install any missing dependencies on the target host.
`--disable-distribution-upload`	Flag to disable uploading the JBoss Fuse distribution. When used, the target host downloads the distribution through Maven instead.
`Name`	(Required) The name of the container to create. When creating multiple containers, it serves as a prefix.
`Number`	The number of containers that should be created.

9.12. fabric:container-default-jvm-options, container-default-jvm-options
Copy link

Abstract

get or set the default JVM options to use when creating a new container

Synopsis
Copy link

fabric:container-default-jvm-options [ --help ] [ JVMOptions ]

Arguments
Copy link

Table 9.12, “fabric:container-default-jvm-options Arguments” describes the command's arguments.

Expand

Table 9.12. fabric:container-default-jvm-options Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`JVMOptions`	Sets the default JVM options for this container. If this argument is omitted, get the current default JVM options.

9.13. fabric:container-delete
Copy link

Abstract

stops and deletes a Fuse Container

Synopsis
Copy link

fabric:container-delete [ --help ] [ --user user ] [ --password password ] [ -f, --force ] [[ -r ] | [ --recursive ]] { GlobList }

Description
Copy link

Deleting a Fuse Container deletes all of the files associated with the container from the host.

If the container has children, the default behavior of the command is to leave the children in place. You can force the deletion of the children using the -r option.

Note

If the container to be deleted is a Fabric Server, you must first remove it from the ensemble using fabric:ensemble-remove.

Arguments
Copy link

Table 9.13, “fabric:container-delete Arguments” describes the command's arguments.

Expand

Table 9.13. fabric:container-delete Arguments
Argument	Interpretation
`--help`	Displays the online help for this command.
`--user`	Specifies the username of the user performing this action.
`--password`	Specifies the password of the user performing this action.
`-f, --force`	Forces execution of the command, regardless of the known state of the container.
`-r, --recursive`	Recursively stops and deletes all child containers.
`GlobList`	(Required) Specifies the list of containers to delete, separated by spaces. Globbing is supported as follows: `?`, matches zero or one characters; `*`, matches zero or more characters.

Using alternative credentials
Copy link

Each time a container is created Fabric stores the credentials used to create the container and will reuse them for all life cycle operations (start, stop, delete). If the credentials have changed, the updated credentials need to be specified as options. Each container type (child, ssh, jclouds) uses different kind of credentials, as follows:

Child containers: Use the JMX credentials of the parent container.
SSH containers: Use the SSH credentials of the target host.
JClouds containers: Use the ssh credentials of the instance.

For example:

fabric:container-delete --user NewJmxUserOfParent --password NewJmxPasswordOfParent child1
fabric:container-delete --password NewSshPasswordOfTargetHost ssh1
fabric:container-delete --password NewSshPasswordOfTargetHost cloud1

fabric:container-delete --user NewJmxUserOfParent --password NewJmxPasswordOfParent child1
fabric:container-delete --password NewSshPasswordOfTargetHost ssh1
fabric:container-delete --password NewSshPasswordOfTargetHost cloud1

Copy to Clipboard

Toggle word wrap

9.14. fabric:container-edit-jvm-options
Copy link

Abstract

Replace the JVM options used to launch a container

Synopsis
Copy link

fabric:container-edit-jvm-options [ --help ] [ -u, --username user ] [ -p, --password password ] { Container } [ JVMOptions ]

Description
Copy link

Enables you to set the Java Virtual Machine (JVM) options that are passed to the Java runtime when launching the container. Note that this command replaces all of the existing JVM options for the container. Hence, when you invoke this command, you must specify all of the container's JVM options, not just the ones you want to add.

For example, suppose you have a container named ssh2 and you want to add the following JVM options: -Xms2048M -Xmx8192M. Proceed as follows:

Invoke the container-edit-jvm-options command to discover the current JVM options used by the ssh2 container, as follows:

JBossFuse:karaf@root> container-edit-jvm-options ssh2
-XX:+UnlockDiagnosticVMOptions -XX:+UnsyncloadClass -Djava.endorsed.dirs=/usr/lib/jvm/jre/jre/lib/endorsed:/usr/lib/jvm/jre/lib/endorsed:/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133/lib/endorsed -Djava.ext.dirs=/usr/lib/jvm/jre/jre/lib/ext:/usr/lib/jvm/jre/lib/ext:/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133/lib/ext -Dkaraf.instances=/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133/instances -Dkaraf.home=/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133 -Dkaraf.base=/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133 -Dkaraf.data=/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133/data -Dkaraf.etc=/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133/etc -Djava.io.tmpdir=/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133/data/tmp -Djava.util.logging.config.file=/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133/etc/java.util.logging.properties -Djavax.management.builder.initial=org.apache.karaf.management.boot.KarafMBeanServerBuilder -Dkaraf.startLocalConsole=false -Dkaraf.startRemoteShell=true

JBossFuse:karaf@root> container-edit-jvm-options ssh2
-XX:+UnlockDiagnosticVMOptions -XX:+UnsyncloadClass -Djava.endorsed.dirs=/usr/lib/jvm/jre/jre/lib/endorsed:/usr/lib/jvm/jre/lib/endorsed:/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133/lib/endorsed -Djava.ext.dirs=/usr/lib/jvm/jre/jre/lib/ext:/usr/lib/jvm/jre/lib/ext:/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133/lib/ext -Dkaraf.instances=/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133/instances -Dkaraf.home=/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133 -Dkaraf.base=/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133 -Dkaraf.data=/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133/data -Dkaraf.etc=/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133/etc -Djava.io.tmpdir=/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133/data/tmp -Djava.util.logging.config.file=/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133/etc/java.util.logging.properties -Djavax.management.builder.initial=org.apache.karaf.management.boot.KarafMBeanServerBuilder -Dkaraf.startLocalConsole=false -Dkaraf.startRemoteShell=true

Copy to Clipboard

Toggle word wrap

Invoke the container-edit-jvm-options command, passing all of new JVM options as the second argument to the command (enclosed in single or double quotes). That is, to construct the second argument, copy the JVM options output from the previous step, append your additional JVM arguments, and enclose all of these JVM options in quotes. For example:

JBossFuse:karaf@root> container-edit-jvm-options ssh2 '-XX:+UnlockDiagnosticVMOptions -XX:+UnsyncloadClass -Djava.endorsed.dirs=/usr/lib/jvm/jre/jre/lib/endorsed:/usr/lib/jvm/jre/lib/endorsed:/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133/lib/endorsed -Djava.ext.dirs=/usr/lib/jvm/jre/jre/lib/ext:/usr/lib/jvm/jre/lib/ext:/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133/lib/ext -Dkaraf.instances=/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133/instances -Dkaraf.home=/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133 -Dkaraf.base=/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133 -Dkaraf.data=/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133/data -Dkaraf.etc=/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133/etc -Djava.io.tmpdir=/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133/data/tmp -Djava.util.logging.config.file=/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133/etc/java.util.logging.properties -Djavax.management.builder.initial=org.apache.karaf.management.boot.KarafMBeanServerBuilder -Dkaraf.startLocalConsole=false -Dkaraf.startRemoteShell=true -Xms2048M -Xmx8192M'

JBossFuse:karaf@root> container-edit-jvm-options ssh2 '-XX:+UnlockDiagnosticVMOptions -XX:+UnsyncloadClass -Djava.endorsed.dirs=/usr/lib/jvm/jre/jre/lib/endorsed:/usr/lib/jvm/jre/lib/endorsed:/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133/lib/endorsed -Djava.ext.dirs=/usr/lib/jvm/jre/jre/lib/ext:/usr/lib/jvm/jre/lib/ext:/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133/lib/ext -Dkaraf.instances=/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133/instances -Dkaraf.home=/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133 -Dkaraf.base=/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133 -Dkaraf.data=/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133/data -Dkaraf.etc=/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133/etc -Djava.io.tmpdir=/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133/data/tmp -Djava.util.logging.config.file=/home/fuse/containers/ssh2/fabric8-karaf-1.2.0.redhat-133/etc/java.util.logging.properties -Djavax.management.builder.initial=org.apache.karaf.management.boot.KarafMBeanServerBuilder -Dkaraf.startLocalConsole=false -Dkaraf.startRemoteShell=true -Xms2048M -Xmx8192M'

Copy to Clipboard

Toggle word wrap

In order for these new JVM options to take effect, you need to restart the ssh2 container, as follows:

JBossFuse:karaf@root> container-stop ssh2
JBossFuse:karaf@root> container-start ssh2

JBossFuse:karaf@root> container-stop ssh2
JBossFuse:karaf@root> container-start ssh2

Copy to Clipboard

Toggle word wrap

Verify that the current JVM settings have the new values, as follows:
```
JBossFuse:karaf@root> container-edit-jvm-options ssh2
...
```
```
JBossFuse:karaf@root> container-edit-jvm-options ssh2
...
```
Copy to Clipboard Toggle word wrap

Arguments
Copy link

Table 9.14, “fabric:container-edit-jvm-options Arguments” describes the command's arguments.

Expand

Table 9.14. fabric:container-edit-jvm-options Arguments
Argument	Interpretation
`--help`	Displays the online help for this command.
`-u, --username`	Specifies the username to log on to a remote container.
`-p, --password`	Specifies the password to log on to a remote container.
`Container`	The name of the container.
`JVMOptions`	Specifies the container's new JVM options, which completely replace the old JVM options. If this argument is omitted, the command shows the existing JVM options for the specified container.

9.15. fabric:container-domains, container-domains
Copy link

Abstract

lists a container's JMX domains

Synopsis
Copy link

fabric:container-domains [ --help ] { Name }

Arguments
Copy link

Table 9.15, “fabric:container-domains Arguments” describes the command's arguments.

Expand

Table 9.15. fabric:container-domains Arguments
Argument	Interpretation
`--help`	Displays the online help for this command.
`Name`	Specifies the name of the container.

9.16. fabric:container-info, container-info
Copy link

Abstract

displays information about the specified container

Synopsis
Copy link

fabric:container-info [ --help ] [ ContainerName ]

Arguments
Copy link

Table 9.16, “fabric:container-info Arguments” describes the command's arguments.

Expand

Table 9.16. fabric:container-info Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`ContainerName`	Specifies the name of the container for which information is provided. If not specified, the container name defaults to `root`.

9.17. fabric:container-list, container-list
Copy link

Abstract

lists the containers in a fabric

Synopsis
Copy link

fabric:container-list [ --help ] [ --version Version ] [[ -v ] | [ --verbose ]] [[ ID ] | [ profile ]]

Arguments
Copy link

Table 9.17, “fabric:container-list Arguments” describes the command's arguments.

Expand

Table 9.17. fabric:container-list Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`--version`	Specifies a profile version to use as filter.
`-v, --verbose`	Display verbose output.
`ID`	Specifies a container ID to use in filtering the output.
`profile`	Specifies a profile to use in filtering the output. When a profile is specified only the containers with the profile are listed.

9.18. fabric:container-remove-profile, container-remove-profile
Copy link

Abstract

removes the specified list of profiles from the container

Synopsis
Copy link

fabric:container-remove-profile [ --help ] { Name } { Profiles }

Arguments
Copy link

Section 9.18, “fabric:container-remove-profile, container-remove-profile” describes the command's arguments.

Expand

Table 9.18. fabric:container-remove-profile Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`Name`	Specifies the name of the container.
`Profiles`	Specifies the list of profiles to remove from the container.

9.19. fabric:container-resolver-list
Copy link

Abstract

show the resolver policies for the specified containers

Synopsis
Copy link

fabric:container-resolver-list [ --help ] [ containers ]

Description
Copy link

For all containers in the fabric, list the resolver policy and the following variants of the host address: local IP address, local hostname, public IP address, public hostname, and manually specified IP address.

The host addresses are found by looking them up in the Fabric Registry for each container. This information is stored in the Fabric Registry at the time when the container is created. In most cases, only the local IP address and the local hostname are known. The public IP address and public hostname are generally available only for cloud containers.

Arguments
Copy link

Table 9.19, “fabric:container-resolver-list Arguments” describes the command's arguments.

Expand

Table 9.19. fabric:container-resolver-list Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`containers`	List of containers for which the resolver policy is displayed. Shows all containers by default.

9.20. fabric:container-resolver-set
Copy link

Abstract

specifies how the container reports its address to other containers

Synopsis
Copy link

fabric:container-resolver-set [ --help ] [ --container name ] [ --all ] { Resolver }

Description
Copy link

Apply the specified resolver policy to the specified container or containers, where the resolver policy can take one of the following values:

localip
localhostname
publicip
publichostname
manualip

localip
localhostname
publicip
publichostname
manualip

Copy to Clipboard

Toggle word wrap

The localip and localhostname resolver policies are suitable for accessing a container in a LAN. The publicip and publichostname resolver policies are suitable for accessing a container in a WAN (Internet), but they are typically only available for cloud containers. In the case of a the cloud, localip and localhostname can be used for container-to-container connections within the cloud, but for container-to-container connections from outside the cloud, you must use publicip or publichostname.

Fabric manages host addresses as follows:

When you create a new container, fabric tries to discover as much as it can about the container's host address and stores this information in the following fields in the fabric registry: localip (local IP address); localhostname (local hostname); publicip (public IP address); publichostname (public hostname).
For example, if you create a new container using the fabric:container-create-ssh command and specify the local IP address to the --host option, fabric attempts to perform a reverse lookup to obtain the corresponding local hostname and then stores both the local IP address and the local hostname in the Fabric Registry.
If you create a new container in the cloud, the metadata sent by the cloud provider typically includes a complete set of host addresses: localip, localhostname, publicip, and publichostname.
Every container in the fabric has its own resolver policy, which determines what kind of host address is returned to another container that wants to connect to it. The container's resolver policy is set in one of the following ways:
- (Default) By inheriting the resolver policy from the global resolver policy (specified at the time the fabric is created)
- By specifying the resolver policy explicitly at the time the container is created (through the --resolver option).
- By invoking the fabric:container-resolver-set command.
The container's resolver policy is applied whenever fabric looks up the container's host address, irrespective of what protocol is involved. In particular, the resolver policy determines the form of the host address used in the following URLs:
- Fabric Ensemble URL,
- SSH URL (console client port),
- Maven proxy URL,
- JMX URL.

For example, if your fabric includes a container called SSH1 (originally created using the fabric:container-create-ssh command) and the SSH1 container is configured with the localip resolver policy, any container that tries to connect to SSH1 will automatically receive the local IP address of SSH1 when it looks up the Fabric Registry.

Note

A container's resolver policy only affects the host address returned when other containers want to connect to it. The container's own policy has no effect on how the container resolves the host addresses of the other containers. In other words, if containers X, Y, and Z want to connect to container SSH1, the form of host address they get is determined by SSH1's resolver policy. But if SSH1 wants to connect to container X, it is container X's resolver policy that is used.

Manual IP resolver policy
Copy link

The manualip resolver policy is a special case. If none of the standard resolver policies are suitable for your network set-up, you can manually specify a container's host address by setting the following key in the Fabric Registry:

/fabric/registry/containers/config/ContainerName/manualip

/fabric/registry/containers/config/ContainerName/manualip

Copy to Clipboard

Toggle word wrap

Arguments
Copy link

Table 9.20, “fabric:container-resolver-set Arguments” describes the command's arguments.

Expand

Table 9.20. fabric:container-resolver-set Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`--container`	Apply the resolver policy to the specified container. To specify multiple containers, specify this flag multiple times on the command line—for example, `--container foo --container bar`.
`--all`	Apply the resolver policy to all containers in the fabric.
`Resolver`	(Required) The resolver policy to set on the specified container(s). Possible values are: `localip`, `localhostname`, `publicip`, `publichostname`, `manualip`.

9.21. fabric:container-rollback
Copy link

Abstract

roll back the specified containers to an older version

Synopsis
Copy link

fabric:container-rollback [ --help ] [ --all ] { Version } [ ContainerList ]

Description
Copy link

For an example of how this command is used, see fabric:container-upgrade.

Arguments
Copy link

Table 9.21, “fabric:container-rollback Arguments” describes the command's arguments.

Expand

Table 9.21. fabric:container-rollback Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`--all`	Roll back all containers.
`Version`	(Required) The version to roll back to.
`ContainerList`	The list of containers to roll back. An empty list implies the current container.

9.22. fabric:container-start
Copy link

Abstract

Start the specified container

Synopsis
Copy link

fabric:container-start [ --help ] [ --user user ] [ --password password ] [ -f, --force ] { GlobList }

Arguments
Copy link

Table 9.22, “fabric:container-start Arguments” describes the command's arguments.

Expand

Table 9.22. fabric:container-start Arguments
Argument	Interpretation
`--help`	Displays the online help for this command.
`--user`	Specifies the username of the user performing this action.
`--password`	Specifies the password of the user performing this action.
`-f, --force`	Forces execution of the command, regardless of the known state of the container.
`GlobList`	(Required) Specifies the list of containers to start, separated by spaces. Globbing is supported as follows: `?`, matches zero or one characters; `*`, matches zero or more characters.

Using alternative credentials
Copy link

Child containers: Use the JMX credentials of the parent container.
SSH containers: Use the SSH credentials of the target host.
JClouds containers: Use the ssh credentials of the instance.

For example:

fabric:container-start --user NewJmxUserOfParent --password NewJmxPasswordOfParent child1
fabric:container-start --password NewSshPasswordOfTargetHost ssh1
fabric:container-start --password NewSshPasswordOfTargetHost cloud1

fabric:container-start --user NewJmxUserOfParent --password NewJmxPasswordOfParent child1
fabric:container-start --password NewSshPasswordOfTargetHost ssh1
fabric:container-start --password NewSshPasswordOfTargetHost cloud1

Copy to Clipboard

Toggle word wrap

9.23. fabric:container-stop
Copy link

Abstract

Shuts down the specified container

Synopsis
Copy link

fabric:container-stop [ --help ] [ --user user ] [ --password password ] [ -f, --force ] { GlobList }

Arguments
Copy link

Table 9.23, “fabric:container-stop Arguments” describes the command's arguments.

Expand

Table 9.23. fabric:container-stop Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`--user`	Specifies the username of the user performing this action.
`--password`	Specifies the password of the user performing this action.
`-f, --force`	Forces execution of the command, regardless of the known state of the container.
`GlobList`	(Required) Specifies the list of containers to stop, separated by spaces. Globbing is supported as follows: `?`, matches zero or one characters; `*`, matches zero or more characters.

Using alternative credentials
Copy link

Child containers: Use the JMX credentials of the parent container.
SSH containers: Use the SSH credentials of the target host.
JClouds containers: Use the ssh credentials of the instance.

For example:

fabric:container-stop --user NewJmxUserOfParent --password NewJmxPasswordOfParent child1
fabric:container-stop --password NewSshPasswordOfTargetHost ssh1
fabric:container-stop --password NewSshPasswordOfTargetHost cloud1

fabric:container-stop --user NewJmxUserOfParent --password NewJmxPasswordOfParent child1
fabric:container-stop --password NewSshPasswordOfTargetHost ssh1
fabric:container-stop --password NewSshPasswordOfTargetHost cloud1

Copy to Clipboard

Toggle word wrap

9.24. fabric:container-upgrade
Copy link

Abstract

upgrade the specified containers to a new version

Synopsis
Copy link

fabric:container-upgrade [ --help ] [ --all ] { Version } [ ContainerList ]

Description
Copy link

This command is typically used in combination with the fabric:profile-edit command to guarantee atomicity of profile modifications. That is, if multiple edits need to be made to a profile, you can use fabric:container-upgrade to roll out all of the changes in one step.

For example, consider the container, child1, which is currently assigned to version 1.0 and has the sample profile deployed inside it. If you need to make multiple changes to the sample profile, you can roll out these changes atomically, as follows:

Create a new version, 1.1, to hold the pending changes, as follows:

karaf@root> fabric:version-create
Created version: 1.1 as copy of: 1.0

karaf@root> fabric:version-create
Created version: 1.1 as copy of: 1.0

Copy to Clipboard

Toggle word wrap

Now start editing the new version of the sample profile, remembering to specify 1.1, so that the modifications are applied to version 1.1 of sample. For example, to add the camel-quartz feature to the sample profile, enter the following command:
```
fabric:profile-edit --feature camel-quartz sample 1.1
```
```
fabric:profile-edit --feature camel-quartz sample 1.1
```
Copy to Clipboard Toggle word wrap
Note
Instead of adding the option 1.1 to every edit command, you could change the default version to 1.1 by entering the command, fabric:version-set-default 1.1.
When you have finished editing the sample profile and you are ready to let the changes take effect on the container, child1, you can roll out the changes by upgrading the child1 container to version 1.1, as follows:
```
fabric:container-upgrade 1.1 child1
```
```
fabric:container-upgrade 1.1 child1
```
Copy to Clipboard Toggle word wrap
If you are not happy with the changes you made, you can easily roll back to the old version of the sample profile, using the fabric:container-rollback command, as follows:
```
fabric:container-rollback 1.0 child1
```
```
fabric:container-rollback 1.0 child1
```
Copy to Clipboard Toggle word wrap

Arguments
Copy link

Table 9.24, “fabric:container-upgrade Arguments” describes the command's arguments.

Expand

Table 9.24. fabric:container-upgrade Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`--all`	Upgrade all containers.
`Version`	(Required) The version to upgrade to.
`ContainerList`	The list of containers to upgrade. An empty list implies the current container.

9.25. fabric:create
Copy link

Abstract

creates a new fabric and imports fabric profiles

Synopsis
Copy link

fabric:create [ --help ] [ --clean ] [ --no-import ] [ --import-dir dir ] [[ -v ] | [ --verbose ]] [[ -t ] | [ --time ]millis] [[ -n ] | [ --non-managed ]] [[ -p ] | [ --profile ]profile] [[ -b ] | [ --bind-address ]bindAddr] [ --new-user username ] [ --new-user-password password ] [ --new-user-role role ] [ --zookeeper-password zooPassword ] [ --generate-zookeeper-password ] [ --zookeeper-data-dir dataDir ] [ --zookeeper-init-limit ticks ] [ --zookeeper-sync-limit ticks ] [ --zookeeper-ticktime millis ] [ --zookeeper-server-port zkport ] [ --wait-for-provisioning ] [[ -t ] | [ --time ]millis] [[ -g ] | [ --global-resolver ]policy] [[ -r ] | [ --resolver ]policy] [[ -m ] | [ --manual-ip ]ipAddress] [ --min-port port ] [ --max-port port ] [ --external-git-url gitURL ] [ --external-git-user gitUser ] [ --external-git-password gitPass ] [ --bootstrap-timeout ] [ ContainerList ]

Description
Copy link

This command is used to create a new fabric. It can also be used to change the Fabric Servers in an existing fabric. Converting the current container into a fabric has two important side effects:

The contents of a container should now be managed using fabric profiles. Do not try to deploy bundles and features directly in a fabric container.
The default JAAS realm is superseded by the Zookeeper login module, which stores user data in the Zookeeper registry. As the fabric is created it initializes the user data by importing all of the user data that it finds in the etc/users.properties file. If the users.properties file is empty, you can specify a new user explicitly using the --new-user and --new-user-password options (at least one user must be defined).

Arguments
Copy link

Table 9.25, “fabric:create Arguments” describes the command's arguments.

Expand

Table 9.25. fabric:create Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`--clean`	Clean local zookeeper cluster and configurations.
`--no-import`	Disable the import of the sample registry data.
`--import-dir`	Directory of files to import into the newly created ensemble.
`-v, --verbose`	Flag to enable verbose output of files being imported.
`-t, --time`	How long to wait (milliseconds) for the ensemble to start up, before trying to import the default data.
`-n`, `--non-managed`	Specifies that the container remains unmanaged.
`-p, --profile`	Specifies the profile (or profiles) to use for the ensemble containers in the new fabric. To specify multiple profiles, specify this flag multiple times on the command line—for example, `--profile foo --profile bar`.
`-b, --bind-address`	Specifies the IP address of the embedded Zookeeper server. For example, this can be a useful option to specify if the container is deployed on a multi-homed host.
`--new-user`	Create a new user in the new fabric's JAAS realm. Because the `fabric:create` command automatically imports user data from the `etc/users.properties` file, you would only need to specify this option, if the `etc/users.properties` file contains no valid user entries. When using this option, you must also specify a password using the `--new-user-password` option.
`--new-user-password`	Used in combination with the `--new-user` option to specify the new user's password. No default value.
`--new-user-role`	Used in combination with the `--new-user` option to specify the new user's role. Default is `admin`.
`--zookeeper-password`	Specifies the Zookeeper password, which is used to access the Zookeeper nodes under the `/fabric/` path. Defaults to the password of the current session user. Subsequently, because the Zookeeper password is cached in the current session, you normally do not need to provide it when executing fabric commands. You can display the Zookeeper password at any time using the `fabric:ensemble-password` command.
`--generate-zookeeper-password`	Directs Fabric to generate a random Zookeeper password. Subsequently, you can display the Zookeeper password using the `fabric:ensemble-password` command.
`--zookeeper-data-dir`	The location where ZooKeeper stores the in-memory database snapshots and, unless specified otherwise, the transaction log of updates to the database. Defaults to `data/zookeeper`.
`--zookeeper-init-limit`	The amount of time, in ticks, to allow followers to connect and sync to a leader. Defaults to 10.
`--zookeeper-sync-limit`	The amount of time, in ticks, to allow followers to sync with ZooKeeper. Defaults to 5.
`--zookeeper-ticktime`	The length of a single tick, which is the basic time unit used by ZooKeeper, as measured in milliseconds. It is used to regulate heartbeats and timeouts. For example, the minimum session timeout is two ticks. Defaults to `2000`.
`--zookeeper-server-port`	Specifies the IP port number of the ZooKeeper server, on which ZooKeeper listens for incoming connections. Default is 2181.
`--wait-for-provisioning`	Flag to wait for the initial container provisioning.
`-g, --global-resolver`	Specifies the global resolver policy, which becomes the default resolver policy applied to all new containers created in this fabric. Possible values are: `localip`, `localhostname`, `publicip`, `publichostname`, `manualip`. The default is `localhostname`.
`-r, --resolver`	Specifies the local resolver policy. Possible values are: `localip`, `localhostname`, `publicip`, `publichostname`, `manualip`. The default is `localhostname`.
`-m, --manual-ip`	If you select the `manualip` resolver policy (using either the `--resolver` or `--global-resolver` options), specifies the IP address to use for the resolver.
`--min-port`	Specifies the minimum port number of the allowed IP port range. Default is `0`.
`--max-port`	Specifies the maximum port number of the allowed IP port range. Default is `65535`.
`--external-git-url`	Specifies an external git url.
`--external-git-user`	Specifies an external git user.
`--external-git-password`	Specifies an external git password.
`--bootstrap-timeout`	How long to wait (in milliseconds) for the initial fabric bootstrap. Default is 120000.
`ContainerList`	The list of containers to include in the ensemble. An empty list implies the current container.

Examples
Copy link

Create a fabric and import sample profiles from the ESBInstallDir/fabric/import directory, as follows:

fabric:create --clean

fabric:create --clean

Copy to Clipboard

Toggle word wrap

Create a fabric without imported profiles, as follows:

fabric:create --clean --no-import

fabric:create --clean --no-import

Copy to Clipboard

Toggle word wrap

Create a fabric and import profiles from the custom import directory, CustomImportDir, as follows:

fabric:create --clean --import-dir CustomImportDir

fabric:create --clean --import-dir CustomImportDir

Copy to Clipboard

Toggle word wrap

Re-create a fabric such that the containers, reg1, reg2, and reg3, are now included in the registry ensemble (an ensemble must consist of an odd number of containers):

fabric:create reg1 reg2 reg3

fabric:create reg1 reg2 reg3

Copy to Clipboard

Toggle word wrap

In this case, the contents of the Zookeeper registry are preserved and the ensemble is expanded to include the specified containers.

9.26. fabric:ensemble-add
Copy link

Abstract

extend the current Fabric Ensemble by converting the specified containers into Fuse Servers

Synopsis
Copy link

fabric:ensemble-add [ --help ] { ContainerList }

Description
Copy link

Because the total number of containers in an ensemble must always be odd, you should add an even number of containers.

For example, consider a fabric consisting of three containers—root1, root2, and root3—where root1 is an Fuse Server and root2 and root3 are ordinary Fabric Containers. You can now add root2 and root3 to the current ensemble by entering the following console command:

fabric:ensemble-add root2 root3

fabric:ensemble-add root2 root3

Copy to Clipboard

Toggle word wrap

Normally, it makes sense to have at most one Fabric Server running on each host, so that the specified containers are actually running on remote hosts (hence, it usually does not make sense to add child containers to an ensemble). You do not need to provide any information about where the containers are running, however, because fabric already knows the location of the containers in the fabric.

Note

Because the Fabric Ensemble is the key component of Fuse Fabric, changing the ensemble is a critical operation. All data will be preserved and copied to the new Fuse Servers before switching.

Arguments
Copy link

Table 9.26, “fabric:ensemble-add Arguments” describes the command's arguments.

Expand

Table 9.26. fabric:ensemble-add Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`ContainerList`	The list of containers to add.

9.27. fabric:ensemble-list
Copy link

Abstract

lists the Fuse Servers in the current Fabric Ensemble

Synopsis
Copy link

fabric:ensemble-list [ --help ]

Description
Copy link

For a complete listing of all the containers in the fabric, use fabric:container-list instead.

Arguments
Copy link

Table 9.27, “fabric:ensemble-list Arguments” describes the command's arguments.

Expand

Table 9.27. fabric:ensemble-list Arguments
Argument	Interpretation
`--help`	Displays the online help for this command

9.28. fabric:ensemble-password
Copy link

Abstract

display the ensemble password

Synopsis
Copy link

fabric:ensemble-password [ --help ]

Description
Copy link

The ensemble password protects access to the Zookeeper nodes under the /fabric/ path, which contains critical configuration data for the fabric. To ensure integrity of the fabric configuration data, you should modify the fabric configuration exclusively using the fabric:* console commands.

Arguments
Copy link

Table 9.28, “fabric:ensemble-password Arguments” describes the command's arguments.

Expand

Table 9.28. fabric:ensemble-password Arguments
Argument	Interpretation
`--help`	Displays the online help for this command

9.29. fabric:ensemble-remove
Copy link

Abstract

remove the specified containers from the current ensemble

Synopsis
Copy link

fabric:ensemble-remove [ --help ] { ContainerList }

Description
Copy link

Re-create the current ensemble, excluding the specified containers from the ensemble. All containers are switched to this new ensemble.

Note

Because the Fabric Ensemble is the key component of Fuse Fabric, changing the ensemble is a critical operation. All data will be preserved and copied to the new ensemble before switching.

Arguments
Copy link

Table 9.29, “fabric:ensemble-remove Arguments” describes the command's arguments.

Expand

Table 9.29. fabric:ensemble-remove Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`ContainerList`	The list of containers to remove. Must be an even number of containers.

9.30. fabric:join
Copy link

Abstract

join a container to an existing fabric

Synopsis
Copy link

fabric:join [ --help ] [[ -f ] | [ --force ]] [[ -p ] | [ --profile ]Profile] [[ -n ] | [ --non-managed ]] [ --zookeeper-password zooPassword ] [[ -r ] | [ --resolver ]policy] [[ -m ] | [ --manual-ip ]ipAddress] [ --min-port port ] [ --max-port port ] [[ -b ] | [ --bind-address ]BindAddress] [[ -v ] | [ --version ]Version] URL [ ContainerName ]

Description
Copy link

The fabric:join command can be used to join a standalone container to fabric.

Arguments
Copy link

Table 9.30, “fabric:join Arguments” describes the command's arguments.

Expand

Table 9.30. fabric:join Arguments
Argument	Interpretation
`--help`	Displays the online help for this command.
`-f`, `--force`	Forces the provided container name to be used.
`-p`, `--profile`	Specifies the profile to associate with the container after it joins the fabric. The `fabric` profile, which installs the Fabric Agent, is automatically assigned to all managed containers.
`-n`, `--non-managed`	Registers the container with the fabric's ensemble, but does not install a Fabric Agent into the container. The container's configuration is not managed by the fabric and continues to behave like a standalone container except that it can be discovered through the fabric's ensemble.
`--zookeeper-password`	The ensemble password for the fabric that you are trying to join. If you do not specify this option, you will be prompted to enter the password.
`-r, --resolver`	Specifies the local resolver policy. Possible values are: `localip`, `localhostname`, `publicip`, `publichostname`, `manualip`. The default is `localhostname`.
`-m, --manual-ip`	If you select the `manualip` resolver policy (using the `--resolver` option), specifies the IP address to use for the resolver.
`--min-port`	Specifies the minimum port number of the allowed IP port range. Default is `0`.
`--max-port`	Specifies the maximum port number of the allowed IP port range. Default is `65535`.
`-b`, `--bind-address`	Specifies the IP address of the embedded Zookeeper server (if there is one). For example, this can be a useful option to specify if the container is deployed on a multi-homed host. Note that it only makes sense to specify this option if the current container deploys a Zookeeper server (for example, if the current container is an ensemble container).
`-v`, `--version`	Specifies the version of the container after joining the fabric. Default is `1.0`.
`URL`	Specifies the URL of one of the Fabric Servers, specified in the format `Host[:Port]`. The `Port` value defaults to `2181`.
`ContainerName`	Specifies a unique name for the container to use when joining the fabric. By default, the value of the `karaf.name` property from the `etc/system.properties` file is used.

Examples
Copy link

The following command will add a standalone container to a fabric as a managed container:

fabric:join myhostA ishmael

fabric:join myhostA ishmael

Copy to Clipboard

Toggle word wrap

Where myhostA is the hostname of a Fabric Server (you must connect to a Fabric Server, not an ordinary fabric container) and the container is assigned the name ishmael. You will be prompted to enter the fabric's Zookeeper password.

Important

If the container being added to a fabric is assigned the same name as a container that is already a part of the fabric, the original container will be reset to have the same settings as the new container.

Warning

If no container name is specified as part of the command, the command will use the value of the karaf.name property from the etc/system.properties file. The default setting for this property is root. To avoid conflicts, you should either specify a container name or change the value of the karaf.name property.

Note

The container where you run the fabric:join command must be a standalone container. It is an error to invoke fabric:join in a container that is already part of a fabric.

To make sure that the container starts up with a specific profile, you use the -p argument as follows:

fabric:join -p whaler myhostA ishmael

fabric:join -p whaler myhostA ishmael

Copy to Clipboard

Toggle word wrap

The container ishmael is assigned the profile, whaler, when it joins the fabric.

If you want to be able to configure the container manually, but take advantage of the fabric's discovery features, you can add the container as a non-managed container using the following command:

fabric:join -n myhostA ishmael

fabric:join -n myhostA ishmael

Copy to Clipboard

Toggle word wrap

9.31. fabric:mq-create
Copy link

Abstract

create a new broker profile

Synopsis
Copy link

fabric:mq-create [ --help ] [ --group groupName ] [ --network brokerGroup ] [ --networks-username user ] [ --networks-password password ] [ --create-container containerID, ... ] [ --assign-container containerID, ... ] [ --config configFile ] [ --data dataDir ] [ --kind brokerKind ] [ --replicas num ] [ --port port ] [ --profile profile ] [ --parent-profile parentProfile ] [ --client-profile clientProfile ] [ --client-parent-profile clientParentProfile ] [ --minimum-instances num ] [[ --property ] | [ -D ]prop] [ --jmx-user jmxUser ] [ --jmx-password jmxPassword ] [ --jvm-opts jvmOpts ] [ --version version ] { name }

Arguments
Copy link

Table 9.31, “fabric:mq-create Arguments” describes the command's arguments.

Expand

Table 9.31. fabric:mq-create Arguments
Argument	Description
`--help`	Displays the online help for this command.
`--group groupName`	Specifies the name of the group to which brokers using this profile are assigned. By default brokers are assigned to the `default` group.
`--network brokerGroup`	Specifies a broker group to which brokers using this profile will establish network connections to form a network of brokers. To specify multiple broker groups, specify this flag multiple times on the command line—for example, `--network GroupA --network GroupB`.
`--networks brokerGroup`	Deprecated.
`--networks-username`	Specifies the username part of the credentials that are used to connect to the broker networks specified by the `--network` option.
`--networks-password`	Specifies the password part of the credentials that are used to connect to the broker networks specified by the `--network` option.
`--create-container containerID,...`	Specifies a comma separated list of child containers to create using the new profile. The new containers will be children of the container from which the command is executed.
`--assign-container containerID,...`	Specifies a comma separated list of containers to which the new profile will be deployed.
`--config configFile`	Specifies the ensemble path of the XML configuration template used by the profile. The path will have the syntax `/fabric/configs/versions/version/profiles/profile/config.xml`.
`--data dataDir`	Specifies the path, relative to the container, for storing the persistence data for a broker using the profile.
`--kind brokerKind`	The kind of broker to create.
`--replicas num`	Number of replicas required for replicated brokers (which typically use a parent-profile of mq-replicated profile).
`--port port`	Port number for a transport connector, specified using the syntax `--port transportConnectorName=port`, where `transportConnectorName` is the value of the `name` attribute from a `transportConnector` element in the configuration template. To specify multiple ports, specify this flag multiple times on the command line—for example, `--port openwire=11111 --port mqtt-ssl=4321`.
`--ports port`	Deprecated.
`--no-ssl`	Disables support for SSL/TLS protocol.
`--profile profile`	The profile name to create or update, if defining `N+1` broker groups. Defaults to `mq-broker-$GROUP.$NAME`.
`--parent-profile parentProfile`	The parent profile to extend.
`--client-profile clientProfile`	The profile name for clients to use to connect to the broker group. Defaults to `mq-client-$GROUP`.
`--client-parent-profile clientParentProfile`	The parent profile used for the client-profile for clients connecting to the broker group. Defaults to `default`.
`--minimum-instances num`	Minimum number of containers required of this broker's profile.
`--property, -D`	Additional properties to define in the profile. To specify multiple properties, specify this flag multiple times on the command line—for example, `--property keyA=valA --property keyB=valB`.
`--jmx-user`	The JMX username for logging on to the parent's JMX port.
`--jmx-password`	The JMX password for logging on to the parent's JMX port.
`--jvm-opts`	Specify options to pass to the container's JVM.
`--version version`	Specifies the version into which the profile is stored. Defaults to the current default version.
`name`	Specifies the name of the new broker profile.

Examples
Copy link

To create a new broker profile with the name myBrokerProfile that uses the XML template file myConfigTemplate.xml use the command:

fabric:mq-create --config /fabric/configs/versions/1.0/profiles/mq-base/myConfigTemplate.xml myBrokerProfile

fabric:mq-create --config /fabric/configs/versions/1.0/profiles/mq-base/myConfigTemplate.xml myBrokerProfile

Copy to Clipboard

Toggle word wrap

To create a new broker profile and create a new container using the new profile use the command:

fabric:mq-create --config /fabric/configs/versions/1.0/profiles/mq-base/myConfigTemplate.xml --create-container broker1 myBrokerProfile

fabric:mq-create --config /fabric/configs/versions/1.0/profiles/mq-base/myConfigTemplate.xml --create-container broker1 myBrokerProfile

Copy to Clipboard

Toggle word wrap

To create a new broker profile and associate it with an existing container use the command:

fabric:mq-create --config /fabric/configs/versions/1.0/profiles/mq-base/myConfigTemplate.xml --assign-container container1 myBrokerProfile

fabric:mq-create --config /fabric/configs/versions/1.0/profiles/mq-base/myConfigTemplate.xml --assign-container container1 myBrokerProfile

Copy to Clipboard

Toggle word wrap

SSL/TLS support
Copy link

For example, to add the new profile, test, which has the current default version and inherits from the parent profiles, mq and camel, enter the following console command:

fabric:profile-create --parent mq --parent camel test

fabric:profile-create --parent mq --parent camel test

Copy to Clipboard

Toggle word wrap

Arguments
Copy link

Table 9.35, “fabric:profile-create Arguments” describes the command's arguments.

Expand

Table 9.35. fabric:profile-create Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`--version`	The profile version. Defaults to the current default version (use `version-list` to find the current default).
`--parent`	Optionally specifies one or multiple parent profiles. To specify multiple parent profiles, specify this flag multiple times on the command line—for example, `--parent foo --parent bar`.
`--parents`	Deprecated.
`Name`	(Required) Name of the new profile.

9.36. fabric:profile-delete
Copy link

Abstract

delete the specified version of the specified profile (where the version defaults to the current default version)

Synopsis
Copy link

fabric:profile-delete [ --help ] [ --version version ] { Profile }

Arguments
Copy link

Table 9.36, “fabric:profile-delete Arguments” describes the command's arguments.

Expand

Table 9.36. fabric:profile-delete Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`--version`	The profile version to delete. Defaults to the current default version (use `version-list` to find the current default).
`Profile`	(Required) Name of the profile to delete.

9.37. fabric:profile-display
Copy link

Abstract

displays information about the specified version of the specified profile (where the version defaults to the current default version)

Synopsis
Copy link

fabric:profile-display [ --help ] [ --version version ] [[ -o ] | [ --overlay ]] { Profile }

Arguments
Copy link

Table 9.37, “fabric:profile-display Arguments” describes the command's arguments.

Expand

Table 9.37. fabric:profile-display Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`--version`	Select a specific profile version. Defaults to the current default version (use `version-list` to find the current default).
`-o, --overlay`	Enable overlay. Shows the effective profile settings, taking into account the settings inherited from parent profiles.
`Profile`	(Required) The name of the profile.

9.38. fabric:profile-edit
Copy link

Abstract

edits the specified version of the specified profile (where the version defaults to the current default version)

Synopsis
Copy link

fabric:profile-edit [ --help ] [[ -p ] | [ --pid ]PID] [[ -r ] | [ --repository ] | [ -f ] | [ --feature ] | [ -b ] | [ --bundle ] | [ -c ] | [ --config ] | [ -s ] | [ --system ] | [ -o ] | [ --overrides ] | [ -l ] | [ --lib ] | [ -n ] | [ --endorsed ] | [ -x ] | [ --extension ]] [[ --set ] | [ --delete ]] [[ --append ] | [ --remove ]] [ --import-pid ] [[ --delimiter ]delim] [[ --resource ]ResourceName] { Profile } [ Version ]

Description
Copy link

In the specified profile, you can edit different kinds of settings, as follows:

Feature repository locations—to add a feature repository to the profile, enter a command in the following format:
```
fabric:profile-edit --repository RepoURL Profile [Version]
```
```
fabric:profile-edit --repository RepoURL Profile [Version]
```
Copy to Clipboard Toggle word wrap
For example, to add the fuse-fabric feature repository to the profile, enter a command like the following:
```
fabric:profile-edit --repository mvn:io.fabric8/fuse-fabric/6.2.1.redhat-084/xml/features Profile [Version]
```
```
fabric:profile-edit --repository mvn:io.fabric8/fuse-fabric/6.2.1.redhat-084/xml/features Profile [Version]
```
Copy to Clipboard Toggle word wrap
To delete repositories, enter a command of the following form:
```
fabric:profile-edit --delete --repository RepoURL Profile [Version]
```
```
fabric:profile-edit --delete --repository RepoURL Profile [Version]
```
Copy to Clipboard Toggle word wrap
To edit repository locations directly, using a visual text editor, enter the following command:
```
fabric:profile-edit Profile [Version]
```
```
fabric:profile-edit Profile [Version]
```
Copy to Clipboard Toggle word wrap
The visual editor opens, showing the contents of the specified profile's agent properties. To edit the repository settings, add, modify, or delete lines of the following form:
```
repository.ID=URL
```
```
repository.ID=URL
```
Copy to Clipboard Toggle word wrap
Where ID is an arbitrary unique identifier and URL gives the location of a single feature repository. Only one repository URL can be specified on each line.
Features to install—to add features to the profile, enter a command in the following format:
```
fabric:profile-edit --feature FeatureName Profile [Version]
```
```
fabric:profile-edit --feature FeatureName Profile [Version]
```
Copy to Clipboard Toggle word wrap
To add multiple features, you can specify the --feature flag multiple times in this command. For example, to add the camel-jetty and the camel-quartz features to the default version of the sample profile, enter a command like the following:
```
fabric:profile-edit --feature camel-jetty --feature camel-quartz sample
```
```
fabric:profile-edit --feature camel-jetty --feature camel-quartz sample
```
Copy to Clipboard Toggle word wrap
To delete features, enter a command of the following form:
```
fabric:profile-edit --delete --feature FeatureName Profile [Version]
```
```
fabric:profile-edit --delete --feature FeatureName Profile [Version]
```
Copy to Clipboard Toggle word wrap
To edit features directly, using the visual text editor, enter the following command:
```
fabric:profile-edit Profile [Version]
```
```
fabric:profile-edit Profile [Version]
```
Copy to Clipboard Toggle word wrap
The visual editor opens, showing the contents of the specified profile's agent properties. To edit the features, add, modify, or delete lines of the following form:
```
feature.ID=FeatureName
```
```
feature.ID=FeatureName
```
Copy to Clipboard Toggle word wrap
Where ID is an arbitrary unique identifier and FeatureName is the name of a feature.
Bundles to install—to add bundles to the profile, enter a command in the following format:
Note
The fabric:profile-edit command supports two flag variations for specifying bundles—--bundle and --bundles. The --bundles flag is included for backwards compatibility. Regardless of which variation you use, to specify multiple bundles on the same command line, you must include the flag with each bundle specification.
```
fabric:profile-edit --bundle BundleURL Profile [Version]
```
```
fabric:profile-edit --bundle BundleURL Profile [Version]
```
Copy to Clipboard Toggle word wrap
For example, to add camel-quartz bundle to the sample profile, enter a command like the following:
```
fabric:profile-edit --bundle mvn:org.apache.camel/camel-quartz/2.15.1.redhat-621084 sample
```
```
fabric:profile-edit --bundle mvn:org.apache.camel/camel-quartz/2.15.1.redhat-621084 sample
```
Copy to Clipboard Toggle word wrap
To delete bundles, enter a command of the following form:
```
fabric:profile-edit --delete --bundle BundleURL Profile [Version]
```
```
fabric:profile-edit --delete --bundle BundleURL Profile [Version]
```
Copy to Clipboard Toggle word wrap
To edit bundles directly, using the visual text editor, enter the following command:
```
fabric:profile-edit Profile [Version]
```
```
fabric:profile-edit Profile [Version]
```
Copy to Clipboard Toggle word wrap
The visual editor opens, showing the contents of the specified profile's agent properties. To edit the bundles, add, modify, or delete lines of the following form:
```
bundle.ID=URL
```
```
bundle.ID=URL
```
Copy to Clipboard Toggle word wrap
Where ID is an arbitrary unique identifier and URL specifies the bundle's location.
Configuration settings for the OSGi Config Admin service—to modify or create a configuration setting from the OSGi Config Admin service, enter a command in the following format:
```
fabric:profile-edit --pid PID/Property=Value Profile [Version]
```
```
fabric:profile-edit --pid PID/Property=Value Profile [Version]
```
Copy to Clipboard Toggle word wrap
Where PID is a persistent ID, which is used in the context of the OSGi Config Admin service to identify a collection of related properties. For example, to change the value of the secure HTTPS port used by the Jetty server in the sample profile, you could edit the org.osgi.service.http.port.secure property from the org.ops4j.pax.web PID using a command like the following:
```
fabric:profile-edit --pid org.ops4j.pax.web/org.osgi.service.http.port.secure=8553 sample
```
```
fabric:profile-edit --pid org.ops4j.pax.web/org.osgi.service.http.port.secure=8553 sample
```
Copy to Clipboard Toggle word wrap
To delete a property, enter a command of the following form:
```
fabric:profile-edit --delete --pid PID/Property Profile [Version]
```
```
fabric:profile-edit --delete --pid PID/Property Profile [Version]
```
Copy to Clipboard Toggle word wrap
If the value of the PID property has the form of a comma-separated list, you can use the --append option and the --remove option to manipulate the list value. For example:
```
fabric:profile-edit --pid org.example.foo/my.prop=a Profile [Version]
fabric:profile-edit --append --pid org.example.foo/my.prop=b Profile [Version]
fabric:profile-edit --append --pid org.example.foo/my.prop=c Profile [Version]
fabric:display Profile
...
PID: org.example.foo
  my.prop a,b,c
```
```
fabric:profile-edit --pid org.example.foo/my.prop=a Profile [Version]
fabric:profile-edit --append --pid org.example.foo/my.prop=b Profile [Version]
fabric:profile-edit --append --pid org.example.foo/my.prop=c Profile [Version]
fabric:display Profile
...
PID: org.example.foo
  my.prop a,b,c
```
Copy to Clipboard Toggle word wrap
To edit OSGi Config Admin settings directly, using the visual text editor, enter the following command:
```
fabric:profile-edit --pid PID Profile [Version]
```
```
fabric:profile-edit --pid PID Profile [Version]
```
Copy to Clipboard Toggle word wrap
The visual editor opens, showing the contents of the specified profile's PID.properties file (which is actually stored in the ZooKeeper registry). To edit the properties, add, modify, or delete lines of the following form:
```
Property=Value
```
```
Property=Value
```
Copy to Clipboard Toggle word wrap
Property settings from etc/config.properties—to modify or create a Java system property in the container's etc/config.properties file (which affects the container), enter a command in the following format:
```
fabric:profile-edit --config Property=Value Profile [Version]
```
```
fabric:profile-edit --config Property=Value Profile [Version]
```
Copy to Clipboard Toggle word wrap
For example, to change the value of the karaf.startlevel.bundle Java system property in config.properties, you would enter a command like the following:
```
fabric:profile-edit --config karaf.startlevel.bundle=80 Profile [Version]
```
```
fabric:profile-edit --config karaf.startlevel.bundle=80 Profile [Version]
```
Copy to Clipboard Toggle word wrap
To delete a Java system property from config.properties, enter a command of the following form:
```
fabric:profile-edit --delete --config Property Profile [Version]
```
```
fabric:profile-edit --delete --config Property Profile [Version]
```
Copy to Clipboard Toggle word wrap
If the value of the configuration property has the form of a comma-separated list, you can use the --append option and the --remove option to manipulate the list value. For example:
```
fabric:profile-edit --config my.prop=a Profile [Version]
fabric:profile-edit --append --config my.prop=b Profile [Version]
fabric:profile-edit --append --config my.prop=c Profile [Version]
fabric:display Profile
...
Config Properties :
          my.prop =     a,
                b,
                c
```
```
fabric:profile-edit --config my.prop=a Profile [Version]
fabric:profile-edit --append --config my.prop=b Profile [Version]
fabric:profile-edit --append --config my.prop=c Profile [Version]
fabric:display Profile
...
Config Properties :
          my.prop =     a,
                b,
                c
```
Copy to Clipboard Toggle word wrap
To edit the Java system properties directly, using the visual text editor, enter the following command:
```
fabric:profile-edit Profile [Version]
```
```
fabric:profile-edit Profile [Version]
```
Copy to Clipboard Toggle word wrap
The visual editor opens, showing the contents of the specified profile's agent properties. To edit the Java system properties (analogous to etc/config.properties), add, modify, or delete lines of the following form:
```
config.Property=Value
```
```
config.Property=Value
```
Copy to Clipboard Toggle word wrap
Property settings from etc/system.properties—to modify or create a Java system property in the container's etc/system.properties file (which affects bundles deployed in the container), enter a command in the following format:
```
fabric:profile-edit --system Property=Value Profile [Version]
```
```
fabric:profile-edit --system Property=Value Profile [Version]
```
Copy to Clipboard Toggle word wrap
For example, to change the default port for the OSGi HTTP service, you would enter a command like the following:
```
fabric:profile-edit --system org.osgi.service.http.port=8181 Profile [Version]
```
```
fabric:profile-edit --system org.osgi.service.http.port=8181 Profile [Version]
```
Copy to Clipboard Toggle word wrap
If the system property, Property, is already set at the JVM level (for example, through the --jvm-opts option to the fabric:container-create command), the preceding fabric:profile-edit command will not override the JVM level setting. If you want to override the JVM level setting, you must indicate this explicitly by adding the karaf.override prefix to the property name, Property—for example:
```
fabric:profile-edit --system karaf.override.Property=Value Profile [Version]
```
```
fabric:profile-edit --system karaf.override.Property=Value Profile [Version]
```
Copy to Clipboard Toggle word wrap
To delete a Java system property from system.properties, enter a command of the following form:
```
fabric:profile-edit --delete --system Property Profile [Version]
```
```
fabric:profile-edit --delete --system Property Profile [Version]
```
Copy to Clipboard Toggle word wrap
If the value of the system property has the form of a comma-separated list, you can use the --append option and the --remove option to manipulate the list value. For example:
```
fabric:profile-edit --system my.prop=a Profile [Version]
fabric:profile-edit --append --system my.prop=b Profile [Version]
fabric:profile-edit --append --system my.prop=c Profile [Version]
fabric:display Profile
...
System Properties :
          my.prop =     a,
                b,
                c
```
```
fabric:profile-edit --system my.prop=a Profile [Version]
fabric:profile-edit --append --system my.prop=b Profile [Version]
fabric:profile-edit --append --system my.prop=c Profile [Version]
fabric:display Profile
...
System Properties :
          my.prop =     a,
                b,
                c
```
Copy to Clipboard Toggle word wrap
To edit the Java system properties directly, using the visual text editor, enter the following command:
```
fabric:profile-edit Profile [Version]
```
```
fabric:profile-edit Profile [Version]
```
Copy to Clipboard Toggle word wrap
The visual editor opens, showing the contents of the specified profile's agent properties. To edit the Java system properties (analogous to etc/system.properties), add, modify, or delete lines of the following form:
```
system.Property=Value
```
```
system.Property=Value
```
Copy to Clipboard Toggle word wrap
If you want to ensure that this setting overrides any JVM level setting, set the system property as follows:
```
system.karaf.override.Property=Value
```
```
system.karaf.override.Property=Value
```
Copy to Clipboard Toggle word wrap

Important

Any modifications you make to a profile using fabric:profile-edit are immediately propagated to the containers that use that profile. This is not the recommended way to edit profiles, however: if you change multiple settings in the profile, you could potentially put the affected containers into an inconsistent state. To guarantee atomicity, it is better to use the fabric:profile-edit command in combination with the fabric:container-upgrade command—see fabric:container-upgrade.

Enclosing an Option Value in Quotes
Copy link

The Karaf shell strips double quotes from an option by default. Hence, to enclose an option value in double quotes, it is necessary to enclose the whole setting in double quotes and to escape the quotes around the option value. For example, to define the system property setting, http.nonProxyHosts="myserver1|myserver2", on the default profile, you would use the following command:

fabric:profile-edit --system "karaf.override.http.nonProxyHosts=\"myserver1|myserver2\"" default

fabric:profile-edit --system "karaf.override.http.nonProxyHosts=\"myserver1|myserver2\"" default

Copy to Clipboard

Toggle word wrap

Where the karaf.override prefix is prepended to the property name, because http.nonProxyHosts is already set at the JVM level and needs to be overridden.

Arguments
Copy link

Table 9.38, “fabric:profile-edit Arguments” describes the command's arguments.

Expand

Table 9.38. fabric:profile-edit Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`-p, --pid`	Edit an OSGi configuration property, specified in the format PID/Property. To specify multiple values, specify this flag multiple times on the command line—for example, `--pid PID/Property=Value --pid PID/Property=Value`.
`-r, --repository`	Add (or delete) a feature repository. To specify multiple values, specify this flag multiple times on the command line—for example, `--repository foo --repository bar`.
`--repositories`	Deprecated.
`-f, --feature`	Add (or delete) a feature. To specify multiple values, specify this flag multiple times on the command line—for example, `--feature foo --feature bar`.
`--features`	Deprecated.
`-b, --bundle`	Add (or delete) a bundle. To specify multiple values, specify this flag multiple times on the command line—for example, `--bundle foo --bundle bar`.
`--bundles`	Deprecated.
`-c, --config`	Edit the Java system properties that affect the container (analogous to editing `etc/config.properties` in a root container). To edit multiple configuration properties, specify this flag multiple times on the command line—for example, `--config Property=Value --config Property=Value`.
`-s, --system`	Edit the Java system properties that affect installed bundles (analogous to editing `etc/system.properties` in a root container). To edit multiple system properties, specify this flag multiple times on the command line—for example, `--system Property=Value --system Property=Value`.
`-o, --overrides`	Add (or delete) a bundle override. A bundle override can be used to override the bundle version installed by a feature. For example, if a feature installs version 1.0.0 of a particular bundle, you could use a bundle override to install version 1.0.1 of the bundle instead. To specify multiple values, specify this flag multiple times on the command line—for example, `--overrides BundleURL --overrides BundleURL`.
`-l, --lib`	Add (or delete) a library. To specify multiple values, specify this flag multiple times on the command line—for example, `--lib LibURL --lib LibURL`.
`--libs`	Deprecated.
`-n, --endorsed`	Add (or delete) an endorsed library. To specify multiple values, specify this flag multiple times on the command line—for example, `--endorsed LibURL --endorsed LibURL`.
`-x, --extension`	Add (or delete) an extension library. To specify multiple values, specify this flag multiple times on the command line—for example, `--extension LibURL --extension LibURL`.
`--set`	Set or create values (selected by default).
`--delete`	Delete values.
`--append`	When editing list values, append the specified value to the list. Can only be used in combination with the `--config`, `--system`, and `--pid` options.
`--remove`	When editing list values, remove the specified value from the list. Can only be used in combination with the `--config`, `--system`, and `--pid` options.
`--delimiter`	Specifies the delimiter to use in combination with the `--append` and `--remove` options. Default is `,` (comma).
`--resource`	When editing with the visual text editor, specifies the name of the resource to edit.
`-i, --import-pid`	Imports the PIDs that are edited, from local OSGi Config Admin.
`Profile`	(Required) Name of the profile to edit.
`Version`	Version of the profile to edit. Defaults to the current default version (use `version-list` to find the current default).

9.39. fabric:profile-list
Copy link

Abstract

lists all profiles that belong to the specified version (where the version defaults to the current default version)

Synopsis
Copy link

fabric:profile-list [ --help ] [ --version version ] [ --hidden ]

Description
Copy link

Arguments
Copy link

Table 9.39, “fabric:profile-list Arguments” describes the command's arguments.

Expand

Table 9.39. fabric:profile-list Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`--version`	Specifies the version of the profiles to list. Defaults to the current default version (use `version-list` to find the current default).
`--hidden`	Shows hidden profiles.

9.40. fabric:profile-refresh, profile-refresh
Copy link

Abstract

performs a change to the profile, that triggers the deployment agent. It's intended to be used for scanning for snapshot changes

Synopsis
Copy link

fabric:profile-refresh [ --help ] { Profile } [ Version ]

Arguments
Copy link

Table 9.40, “fabric:profile-refresh Arguments” describes the command's arguments.

Expand

Table 9.40. fabric:profile-refresh Arguments
Argument	Interpretation
`--help`	Displays the online help for this command.
`Profile`	The profile to refresh.
`Version`	The profile version to refresh. Defaults to the current default version.

9.41. fabric:profile-rename, profile-rename
Copy link

Abstract

rename the specified version of the source profile (where the version defaults to the current default version)

Synopsis
Copy link

fabric:profile-rename [ --help ] [ --version Version ] [ -f ] [ --force ] { OldName } { NewName }

Arguments
Copy link

Table 9.41, “fabric:profile-rename Arguments” describes the command's arguments.

Expand

Table 9.41. fabric:profile-rename Arguments
Argument	Interpretation
`--help`	Displays the online help for this command.
`--version`	The profile version to rename. Defaults to the current default version.
`-f, --force`	Flag to allow replacing the target profile (if it already exists).
`OldName`	The current name of the profile.
`NewName`	The new name of the profile.

9.42. fabric:require-profile-delete
Copy link

Abstract

deletes requirements on the specified profile

Synopsis
Copy link

fabric:require-profile-delete [ --help ] { Profile }

Arguments
Copy link

Table 9.42, “fabric:require-profile-delete Arguments” describes the command's arguments.

Expand

Table 9.42. fabric:require-profile-delete Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`Profile`	A profile ID.

9.43. fabric:require-profile-list
Copy link

Abstract

lists all profile requirements in the current fabric

Synopsis
Copy link

fabric:require-profile-list [ --help ]

Description
Copy link

For example, if both the example-camel profile and the example-cxf profile have requirements set, you could see output like the following:

karaf@root> fabric:require-profile-list
[profile]                                [# minimum]    [# maximum]    [depends on]
example-camel                            2              4              
example-cxf                              2              4

karaf@root> fabric:require-profile-list
[profile]                                [# minimum]    [# maximum]    [depends on]
example-camel                            2              4              
example-cxf                              2              4

Copy to Clipboard

Toggle word wrap

Arguments
Copy link

Table 9.43, “fabric:require-profile-list Arguments” describes the command's arguments.

Expand

Table 9.43. fabric:require-profile-list Arguments
Argument	Interpretation
`--help`	Displays the online help for this command

9.44. fabric:require-profile-set
Copy link

Abstract

associates requirements with the specified profile

Synopsis
Copy link

fabric:require-profile-set [ --help ] [ --minimum MinInstance ] [ --maximum MaxInstance ] [ --dependsOn Dependency ] { Profile }

Description
Copy link

Requirements associated with a profile are used to assess the health of the current fabric. Profile requirements are entirely passive. For example, if the number of running instances of a profile is less than the minimum or greater than the maximum, monitoring tools can be configured to indicate a problem or to trigger an alert. Otherwise, the requirements have no effect on the fabric.

In Fuse IDE a green/red bar indicates what proportion of the required profile instances are currently running in the fabric.

For example, to require a range of 2 to 4 running instances of the example-camel profile, you would enter the following command:

karaf@root> require-profile-set --minimum 2 --maximum 4 example-camel

karaf@root> require-profile-set --minimum 2 --maximum 4 example-camel

Copy to Clipboard

Toggle word wrap

Arguments
Copy link

Table 9.44, “fabric:require-profile-set Arguments” describes the command's arguments.

Expand

Table 9.44. fabric:require-profile-set Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`--minimum`	The minimum number of instances of this profile expected to be running in the fabric.
`--maximum`	The maximum number of instances of this profile expected to be running in the fabric.
`--dependsOn`	The profile IDs that must be provisioned before this profile. To specify multiple profile IDs, specify this flag multiple times on the command line—for example, `--dependsOn foo --dependsOn bar`.
`Profile`	A profile ID.

9.45. fabric:status
Copy link

Abstract

displays the current status of the fabric, based on the configured profile requirements

Synopsis
Copy link

fabric:status [ --help ]

Description
Copy link

This command summarizes the health of the fabric, based on requirements previously configured by the fabric:require-profile-set command. For example, if you configured the example-camel profile to require a minimum of two instances and a maximum of four instances, and there is currently only one instance running, the example-camel profile would get a health rating of 50%.

The fabric:status command produces output like the following:

karaf@root> fabric:status
[profile]                                [instances]    [health]
cloud                                    1              100%
example-camel                            0              0%
example-cxf                              0              0%
fabric                                   1              100%
fabric-ensemble-0000-1                   1              100%

karaf@root> fabric:status
[profile]                                [instances]    [health]
cloud                                    1              100%
example-camel                            0              0%
example-cxf                              0              0%
fabric                                   1              100%
fabric-ensemble-0000-1                   1              100%

Copy to Clipboard

Toggle word wrap

Arguments
Copy link

Table 9.45, “fabric:status Arguments” describes the command's arguments.

Expand

Table 9.45. fabric:status Arguments
Argument	Interpretation
`--help`	Displays the online help for this command

9.46. fabric:version-create
Copy link

Abstract

create a new version

Synopsis
Copy link

fabric:version-create [ --help ] [ --parent parentVersion ] { Version }

Description
Copy link

Create a new version, by default copying all of the profiles from the current latest version into the new version. You can specify which version to copy the profiles from using the --parent option. Using the --description option, you can add a note to describe the new version. If no version is specified, the command creates a new minor version by default. For example:

karaf@root> fabric:version-list
[version]       [default] [# containers]
1.0             true      1             
karaf@root> fabric:version-create --description "Test version"
Created version: 1.1 as copy of: 1.0
karaf@root> fabric:version-list
[version]       [default] [# containers]  [description]
1.0             true      1             
1.1             false     0               Test version

karaf@root> fabric:version-list
[version]       [default] [# containers]
1.0             true      1             
karaf@root> fabric:version-create --description "Test version"
Created version: 1.1 as copy of: 1.0
karaf@root> fabric:version-list
[version]       [default] [# containers]  [description]
1.0             true      1             
1.1             false     0               Test version

Copy to Clipboard

Toggle word wrap

Arguments
Copy link

Table 9.46, “fabric:version-create Arguments” describes the command's arguments.

Expand

Table 9.46. fabric:version-create Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`--default`	Set the created version to be the new default version.
`--description`	Add a description of the newly created version. Enclose the text within double quotes.
`--parent`	The parent version. By default, uses the latest version as the parent.
`Version`	The new version to create. If not specified, defaults to the next minor version.

9.47. fabric:version-delete
Copy link

Abstract

delete the specified version

Synopsis
Copy link

fabric:version-delete [ --help ] { Version }

Description
Copy link

Delete the specified version.

Warning

This command also deletes all of the profile data associated with the deleted version.

Arguments
Copy link

Table 9.47, “fabric:version-delete Arguments” describes the command's arguments.

Expand

Table 9.47. fabric:version-delete Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`Version`	(Required) The version to delete.

9.48. fabric:version-list
Copy link

Abstract

lists the existing versions

Synopsis
Copy link

fabric:version-list [ --help ]

Description
Copy link

For example:

karaf@root> fabric:version-list
[version]       [default] [# containers]
1.0             true      1             
1.1             false     0

karaf@root> fabric:version-list
[version]       [default] [# containers]
1.0             true      1             
1.1             false     0

Copy to Clipboard

Toggle word wrap

Arguments
Copy link

Table 9.48, “fabric:version-list Arguments” describes the command's arguments.

Expand

Table 9.48. fabric:version-list Arguments
Argument	Interpretation
`--help`	Displays the online help for this command

9.49. fabric:version-set-default
Copy link

Abstract

set the new default version (must be one of the existing versions)

Synopsis
Copy link

fabric:version-set-default [ --help ] { Version }

Description
Copy link

Many of the fabric console commands work with a default version. For example, when you create a new profile with fabric:profile-create, the new profile is created in the default version by default. The fabric:version-set-default changes the default version that is used by these commands.

Arguments
Copy link

Table 9.49, “fabric:version-set-default Arguments” describes the command's arguments.

Expand

Table 9.49. fabric:version-set-default Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`Version`	(Required) Version number to use as the new default version.

9.50. fabric:watch
Copy link

Abstract

Watches and automatically updates bundles

Synopsis
Copy link

fabric:watch [ --help ] [ --no-upload ] [[ --start ] | [ --stop ]] [ -i interval ] [ --list ] [ --remove ] { bundles ...}

Arguments
Copy link

Table 9.50, “fabric:watch Arguments” describes the commands arguments.

Expand

Table 9.50. fabric:watch Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`--no-upload`	If specified, updated bundles are not uploaded to the fabric's Maven proxy repository.
`--stop`	Stop watching the specified bundles
`--start`	Start watching the specified bundles
`-i`	Specifies the interval, in milliseconds, to check the bundles.
`--list`	List the bundles being watched.
`--remove`	Remove the specified bundles from the watch list.
`bundles...`	Specifies a whitespace delimited list of bundle URLs or bundle IDs.

Important

Only Maven URLs and Maven snapshots are updated automatically. So, if you enter the command, fabric:watch *, Fabric monitors all bundles whose location matches mvn:* and that have -SNAPSHOT in their URL.

Chapter 10. Features Console Commands
Copy link

The features commands allow you to provision entire applications using the Apache Karaf features facility. Features allow you to provision a collection of bundles using a single name.

Type features: then press Tab at the karaf> prompt to view the available commands.

10.1. features:addurl, addurl
Copy link

Abstract

registers one or more URLs to feature repositories with the container

Synopsis
Copy link

features:addurl [ --help ] [[ -i ] | [ --install-all ]] { urls }

Description
Copy link

Each feature repository defines one or more features, and each feature is made up of a collection of bundles that work together to provide some functionality. When a feature is loaded, the container loads any required bundles that are not already present into the container and activates them.

Arguments
Copy link

Table 10.1, “features:addurl Arguments” describes the command's arguments.

Expand

Table 10.1. features:addurl Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`-i, --install-all`	Install all of the features in the specified feature repository URLs.
`urls`	One or more repository URLs separated by whitespaces.

10.2. features:chooseurl, chooseurl
Copy link

Abstract

registers the feature repository URL for a well known project

Synopsis
Copy link

features:chooseurl [ --help ] { project } { version }

Description
Copy link

Red Hat JBoss Fuse uses a number of features implemented by well-known projects. To simplify the process of adding their feature repositories, the chooseurl command allows you to add a feature repository without knowing its Maven URL. The list of projects supported by chooseurl is configured by the org.apache.karaf.features.repos PID.

Arguments
Copy link

Table 10.2, “features:chooseurl Arguments” describes the command's arguments.

Expand

Table 10.2. features:chooseurl Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`feature`	Specifies the project name for the feature repository to add.
`version`	Specifies the version of the project's feature repository to add.

10.3. features:info
Copy link

Abstract

show information about the specified feature with the optionally specified version

Synopsis
Copy link

features:info [ --help ] [[ -c ] | [ --configuration ]] [[ -b ] | [ --bundle ]] [[ -t ] | [ --tree ]] [[ -d ] | [ --dependency ]] { featureName } { version }

Arguments
Copy link

Table 10.3, “features:info Arguments” describes the command's arguments.

Expand

Table 10.3. features:info Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`-c, --configuration`	Display configuration information.
`-b, --bundle`	Display bundle information.
`-t, --tree`	Display feature tree.
`-d, --dependency`	Display dependency information.
`command`

10.4. features:install
Copy link

Abstract

installs a feature

Synopsis
Copy link

features:install [ --help ] { name } [ version ]

Arguments
Copy link

Table 10.4, “features:install Arguments” describes the command's arguments.

Expand

Table 10.4. features:install Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`name`	The name of the feature to install
`version`	The version of the feature

10.5. features:list
Copy link

Abstract

Lists all existing features available from the defined repositories

Synopsis
Copy link

features:list [ --help ] [[ -i ] | [ --installed ]]

Arguments
Copy link

Table 10.5, “features:list Arguments” describes the command's arguments.

Expand

Table 10.5. features:list Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`-i, --installed`	Displays the list of all installed features

10.6. features:listurl
Copy link

Abstract

lists the features repository URLs

Synopsis
Copy link

features:listurl [ --help ] [[ -v ] | [ --validate ]] [[ -vo ] | [ --verbose ]]

Arguments
Copy link

Table 10.6, “features:listurl Arguments” describes the command's arguments.

Expand

Table 10.6. features:listurl Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`-v`,`--validate`	Validate current version of descriptors.
`-vo`,`--verbose`	Shows validation output.

10.7. features:listVersions, listVersions
Copy link

Abstract

lists all versions of a feature available from the current feature repositories

Synopsis
Copy link

features:listVersions [ --help ] { feature }

Arguments
Copy link

Table 10.7, “features:listVersions Arguments” describes the command's arguments.

Expand

Table 10.7. features:listVersions Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`feature`	Name of a feature.

10.8. features:refreshUrl
Copy link

Abstract

reloads the list of available features from the repositories

Synopsis
Copy link

features:refreshUrl [ --help ] { urls }

Arguments
Copy link

Table 10.8, “features:refreshUrl Arguments” describes the command's arguments.

Expand

Table 10.8. features:refreshUrl Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`urls`	The repository URLs to reload (leave empty for all).

10.9. features:removeUrl
Copy link

Abstract

removes the specified list of repository URLs from the features service

Synopsis
Copy link

features:removeUrl [ --help ] { urls }

Arguments
Copy link

Table 10.9, “features:removeUrl Arguments” describes the command's arguments.

Expand

Table 10.9. features:removeUrl Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`-n`,`--interval`
`urls`	One or more repository URLs separated by whitespace.

10.10. features:removeRepository
Copy link

Abstract

removes the specified repository from the features service

Synopsis
Copy link

features:removeRepository [ --help ] { repository }

Arguments
Copy link

Table 10.10, “features:removeRepository Arguments” describes the command's arguments.

Expand

Table 10.10. features:removeRepository Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`repository`	The name of a features repository.

10.11. features:uninstall
Copy link

Abstract

uninstalls a feature with the specified name and version

Synopsis
Copy link

features:uninstall [ --help ] { features }

Arguments
Copy link

Table 10.11, “features:uninstall Arguments” describes the command's arguments.

Expand

Table 10.11. features:uninstall Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`features`	A space-separated list of features to uninstall, where each feature is specified in the format `feature[/version]` (that is, the version is optional).

Chapter 11. JAAS Console Commands
Copy link

The jaas commands are used for editing JAAS realm and user data. Editing a JAAS realm is done in two stages. The changes are placed in a queue until they are applied by executing the jaas:update.

When editing JAAS settings the commands are used as follows:

Start the editing session.
jaas:manage
Edit the realm's user data.
- jaas:users
  Lists all of the users.
- jaas:useradd
  Add a new user.
- jaas:userdel
  Delete a user.
- jaas:roleadd
  Add a new role to a user.
- jaas:roledel
  Delete a role from a user.
- jaas:pending
  Lists all of the pending changes that have been made to the realms, but have not been applied to the container.
Apply the changes to the JAAS realm and ends the editing session.
jaas:update

You can abandon an editing session using jaas:cancel before the changes applied to the JAAS settings.

Type jaas: then press Tab at the prompt to view the available commands.

11.1. jaas:cancel, cancel
Copy link

Abstract

cancels a JAAS editing session without applying the pending changes

Synopsis
Copy link

jaas:cancel [ --help ]

Details
Copy link

When editing a JAAS realm, the changes are buffered until the editing session is closed. The jaas:cancel command clears the buffer without saving the changes and closes the editing session.

You can see a list of the buffered changes using the jaas:pending command.

Arguments
Copy link

Table 11.1, “jaas:cancel Arguments” describes the command's arguments.

Expand

Table 11.1. jaas:cancel Arguments
Argument	Interpretation
`--help`	Displays the online help for this command

11.2. jaas:groupadd
Copy link

Abstract

Add a user to a group.

Synopsis
Copy link

jaas:groupadd [ --help ] { username } { group }

Details
Copy link

When editing a JAAS realm, add the username user to the group group in the current realm.

Arguments
Copy link

Table 11.2, “jaas:groupadd Arguments” describes the command's arguments.

Expand

Table 11.2. jaas:groupadd Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`username`	The user to add to the group.
`group`	The name of the group to which the user is added.

11.3. jaas:groupcreate
Copy link

Abstract

Create a new group in the current realm.

Synopsis
Copy link

jaas:groupcreate [ --help ] { group }

Details
Copy link

When editing a JAAS realm, creates a new user group with the specified name, group.

Arguments
Copy link

Table 11.3, “jaas:groupcreate Arguments” describes the command's arguments.

Expand

Table 11.3. jaas:groupcreate Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`group`	Name of the group to create.

11.4. jaas:groupdel
Copy link

Abstract

Remove a user from a group.

Synopsis
Copy link

jaas:groupdel [ --help ] { username } { group }

Details
Copy link

When editing a JAAS realm, remove the username user from the group group in the current realm.

Arguments
Copy link

Table 11.4, “jaas:groupdel Arguments” describes the command's arguments.

Expand

Table 11.4. jaas:groupdel Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`username`	The user to remove from the group.
`group`	The name of the group from which the user is removed.

11.5. jaas:grouproleadd
Copy link

Abstract

Add a role to a group.

Synopsis
Copy link

jaas:grouproleadd [ --help ] { groupname } { role }

Details
Copy link

When editing a JAAS realm, add the role role to the groupname group in the current realm.

Arguments
Copy link

Table 11.5, “jaas:grouproleadd Arguments” describes the command's arguments.

Expand

Table 11.5. jaas:grouproleadd Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`groupname`	The name of the group to which you are adding a role.
`role`	The name of the role to add to the group.

11.6. jaas:grouproledel
Copy link

Abstract

Remove a role from a group.

Synopsis
Copy link

jaas:grouproledel [ --help ] { groupname } { role }

Details
Copy link

When editing a JAAS realm, remove the role role from the groupname group.

Arguments
Copy link

Table 11.6, “jaas:grouproledel Arguments” describes the command's arguments.

Expand

Table 11.6. jaas:grouproledel Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`groupname`	The name of the group from which you are removing a role.
`role`	The name of the role to remove from the group.

11.7. jaas:groups
Copy link

Abstract

List groups in a realm.

Synopsis
Copy link

jaas:groups [ --help ]

Details
Copy link

When editing a JAAS realm, lists the available groups in the current realm.

Arguments
Copy link

Table 11.7, “jaas:groups Arguments” describes the command's arguments.

Expand

Table 11.7. jaas:groups Arguments
Argument	Interpretation
`--help`	Displays the online help for this command

11.8. jaas:manage, manage
Copy link

Abstract

opens a JAAS realm for editing

Synopsis
Copy link

jaas:manage [ --help ] {[ --realm realm ] | [ --index index ]} [ --module module ] [ --force ]

Details
Copy link

The jaas:manage command is the first step in editing a JAAS realm. It opens the realm so that calls to the jaas:* editing commands will update the selected realm. The edits made by the jaas:* editing commands are placed in a buffer associated with the selected realm and not written to the realm until the editing session is ended by the jaas:update command.

If you use the jaas:manage command before saving the changes to a realm that is open for editing, the changes to the previously open realm are abandoned. The pending edits for the previous realm are cleared without being saved.

While editing a realm you can get a list of the pending changes using the jaas:pending command.

Arguments
Copy link

Table 11.8, “jaas:manage Arguments” describes the command's arguments.

Expand

Table 11.8. jaas:manage Arguments
Argument	Interpretation
`--help`	Displays the online help for this command.
`--realm`	Select the realm to edit by specifying its realm name.
`--index`	Select the realm to edit by specifying its index.
`--module`	Specify which of the realm's login modules are to be edited.
`--force`	Force the switch to the specified realm. If a different realm was already opened for editing its changes are abandoned without being applied.

Examples
Copy link

You can select the realm to manage either by specifying its realm name or by specifying its index.

If the installed realm names are all distinct (which you can check using jaas:realms), you can identify the realm to manage by specifying the --realm option. For example, if the container is a standalone instance (no fabric installed), you can start to edit the karaf realm as follows:

jaas:manage --realm karaf

jaas:manage --realm karaf

Copy to Clipboard

Toggle word wrap

If the container belongs to a fabric, however, the fabric-jaas feature automatically installs another realm named karaf at a higher priority, so that it overrides the default karaf realm. For example, in a fabric, the jaas:realms command returns a list similar to the following:

Index Realm Module Class 1 karaf org.apache.karaf.jaas.modules.properties.PropertiesLoginModule 2 karaf io.fabric8.jaas.ZookeeperLoginModule

Index Realm Module Class 1 karaf org.apache.karaf.jaas.modules.properties.PropertiesLoginModule 2 karaf io.fabric8.jaas.ZookeeperLoginModule

Copy to Clipboard

Toggle word wrap

In this case, you must identify the realm to manage using the --index option, specifying one of the index values from the list. The current active karaf realm is the ZookeeperLoginModule, which is selected by the index value, 2, as follows:

jaas:manage --index 2

jaas:manage --index 2

Copy to Clipboard

Toggle word wrap

11.9. jaas:pending, pending
Copy link

Abstract

lists the changes waiting to be applied to the realm being edited

Synopsis
Copy link

jaas:pending [ --help ]

Details
Copy link

When editing a JAAS realm, the changes are stored in a buffer until the editing session is closed. The jaas:pending command shows a list of the changes buffered during the currently open editing session.

The jaas:update command saves the changes and closes the editing session.

The jaas:cancel command clears the buffer without saving the changes and closes the editing session.

Arguments
Copy link

Table 11.9, “jaas:pending Arguments” describes the command's arguments.

Expand

Table 11.9. jaas:pending Arguments
Argument	Interpretation
`--help`	Displays the online help for this command.

11.10. jaas:realms, realms
Copy link

Abstract

lists the JAAS realms know to the container

Synopsis
Copy link

jaas:realms [ --help ]

Arguments
Copy link

Table 11.10, “jaas:realms Arguments” describes the command's arguments.

Expand

Table 11.10. jaas:realms Arguments
Argument	Interpretation
`--help`	Displays the online help for this command.

11.11. jaas:roleadd, roleadd
Copy link

Abstract

adds a role to a user

Synopsis
Copy link

jaas:roleadd [ --help ] { username } { role }

Details
Copy link

When editing a JAAS realm, the changes are buffered until the editing session is closed. When you add a new role using the jaas:roleadd command, the change is stored in the buffer and does not take effect until the editing session is closed.

The jaas:update command saves the changes and closes the editing session.

The jaas:cancel command clears the buffer without saving the changes and closes the editing session.

Arguments
Copy link

Table 11.11, “jaas:roleadd Arguments” describes the command's arguments.

Expand

Table 11.11. jaas:roleadd Arguments
Argument	Interpretation
`--help`	Displays the online help for this command.
username	Specifies the name of the user to modify.
role	Specifies the role which is appended to the user data.

11.12. jaas:roledel, roledel
Copy link

Abstract

deletes a role from a user

Synopsis
Copy link

jaas:roledel [ --help ] { username } { role }

Details
Copy link

When editing a JAAS realm, the changes are buffered until the editing session is closed. When you delete a role using the jaas:roledel command, the change is stored in the buffer and does not take effect until the editing session is closed.

The jaas:update command saves the changes and closes the editing session.

The jaas:cancel command clears the buffer without saving the changes and closes the editing session.

Arguments
Copy link

Table 11.12, “jaas:roledel Arguments” describes the command's arguments.

Expand

Table 11.12. jaas:roledel Arguments
Argument	Interpretation
`--help`	Displays the online help for this command.
username	Specifies the name of the user to modify.
role	Specifies the role which is removed from the user data.

11.13. jaas:update
Copy link

Abstract

applies all pending changes to the JAAS realm and closes the editing session

Synopsis
Copy link

jaas:update [ --help ]

Details
Copy link

When editing a JAAS realm, the changes are buffered until the editing session is closed. The jaas:update command saves the buffered changes to the realm and closes the editing session.

You can see a list of the buffered changes using the jaas:pending command.

Arguments
Copy link

Table 11.13, “jaas:update Arguments” describes the command's arguments.

Expand

Table 11.13. jaas:update Arguments
Argument	Interpretation
`--help`	Displays the online help for this command.

11.14. jaas:useradd, useradd
Copy link

Abstract

adds a user to the JAAS realm being edited

Synopsis
Copy link

jaas:useradd [ --help ] { username } { password }

Details
Copy link

When editing a JAAS realm, the changes are buffered until the editing session is closed. When you add a new user using the jaas:useradd command, the change is stored in the buffer and does not take effect until the editing session is closed.

The jaas:update command saves the changes and closes the editing session.

The jaas:cancel command clears the buffer without saving the changes and closes the editing session.

Arguments
Copy link

Table 11.14, “jaas:useradd Arguments” describes the command's arguments.

Expand

Table 11.14. jaas:useradd Arguments
Argument	Interpretation
`--help`	Displays the online help for this command.
username	Specifies the name of the user to add.
password	Specifies the password used to authenticate the user.

11.15. jaas:userdel, userdel
Copy link

Abstract

deletes a user from the JAAS realm being edited

Synopsis
Copy link

jaas:userdel [ --help ] { username }

Details
Copy link

When editing a JAAS realm, the changes are buffered until the editing session is closed. When you delete a user using the jaas:useradd command, the change is stored in the buffer and does not take effect until the editing session is closed.

The jaas:update command saves the changes and closes the editing session.

The jaas:cancel command clears the buffer without saving the changes and closes the editing session.

Arguments
Copy link

Table 11.15, “jaas:userdel Arguments” describes the command's arguments.

Expand

Table 11.15. jaas:userdel Arguments
Argument	Interpretation
`--help`	Displays the online help for this command.
username	Specifies the name of the user to add.

11.16. jaas:users, users
Copy link

Abstract

lists the users in the JAAS realm being edited

Synopsis
Copy link

jaas:users [ --help ]

Arguments
Copy link

Table 11.16, “jaas:users Arguments” describes the command's arguments.

Expand

Table 11.16. jaas:users Arguments
Argument	Interpretation
`--help`	Displays the online help for this command.

Chapter 12. Log Console Commands
Copy link

Expand

Table 12.6. log:tail Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`-p`	The pattern for formatting the output
`-n`	The number of entries to display
`--no-color`	Do not use syntax highlighting when displaying the log.

Chapter 13. The nmr:list Command
Copy link

The nmr:listcommand allows you to list normalized message router (NMR) endpoints. The NMR enables the interaction between different components in the OSGi container. The main purpose of the NMR is to mediate between service consumers and service providers.

13.1. nmr:list
Copy link

Abstract

lists NMR endpoints

Synopsis
Copy link

nmr:list [ --help ]

Arguments
Copy link

This command takes the following arguments.

Expand

Table 13.1. nmr:list Arguments
Argument	Interpretation
`--help`	Displays the online help for this command

Chapter 14. OBR Console Commands
Copy link

The obr commands allow you to access the OSGi Bundle Repository (OBR) Service API.

Note

This command takes the following arguments.

Expand

Table 14.9. obr:start Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`bundles`	List of bundle names to deploy, separated by whitespaces

Chapter 15. OSGi Console Commands
Copy link

Expand

Table 15.18. osgi:update Arguments
Argument	Interpretation
`--help`	Displays the online help for this command.
`--force`	Forces the command to execute.
`id`	Specifies ID of the bundle.
`location`	Specifies the location from which the update is loaded. If no location is specified the container will use either the bundle's Bundle-UpdateLocation property or the bundle's original location.

Chapter 16. Packages Console Commands
Copy link

The packages commands are used for showing all packages imported and exported by the OSGi bundles currently installed.

Type packages: then press Tab at the prompt to view the available commands.

16.1. packages:exports, exports
Copy link

Abstract

displays the packages exported OSGi bundles

Synopsis
Copy link

packages:export [ --help ] [[ -d ] | [ --details ]] [ -s ] [[ -i ] | [ --imports ]] [ id ...]

Arguments
Copy link

Table 16.1, “package:exports Arguments” describes the commands arguments.

Expand

Table 16.1. package:exports Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`-d, --details`	Reformat the output in master/detail layout, which makes it easier to see how related details are grouped together.
`-s`	Show the `Symbolic name` column, which shows the symbolic name of the bundle to which the exported package belongs.
`-i, --imports`	Show the `Imported by` column, which lists all of the bundles that import the exported package.
`id`	Specifies a whitespace separated list of bundle IDs to check.

16.2. packages:imports, imports
Copy link

Abstract

displays the packages imported by OSGi bundles

Synopsis
Copy link

packages:imports [ --help ] [[ -i ] | [ --show-importer ]] [ id ...]

Arguments
Copy link

Table 16.2, “package:imports Arguments” describes the commands arguments.

Expand

Table 16.2. package:imports Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`-i, --show-importer`	Show the bundle(s) that import a package.
`id`	Specifies a whitespace separated list of bundle IDs to check.

Chapter 17. Patch Console Commands
Copy link

The patch commands allow you to download, install, and manage patches.

Patches contain a discreet set of bundles intended to update a standalone container. Each patch includes the following metadata:

the patch name
a description of the patch
the list of bundles included in the patch

The basic procedure applying a patch is:

You receive a notice from customer support that a patch is available.
Using the URL provided by customer support, you download the patch using the patch:add command.
This command downloads an archive file, unzips the archive, and puts the relevant JAR files under the container's system/ directory. The patch does not overwrite any of the existing JAR files and the patch is not actually installed until you run the patch:install command.
You install the patch using the patch:install command.
If you notice that the patch is causing issues, you can remove it using the patch:rollback command.

Table 17.7, “patch:simulate Arguments” describes the command's arguments.

Expand

Table 17.7. patch:simulate Arguments
Argument	Interpretation
`--help`	Displays the online help for this command.
patch	Specifies the name of the patch to simulate installing.

Chapter 18. Service Component Runtime (SCR) Console Commands
Copy link

Table 18.4. scr:list Arguments
Argument	Interpretation
`--help`	Displays the online help for this command.
`-s, --show-hidden`	Show all installed components, including the system components (which are hidden by default).

Chapter 19. SSH Console Commands
Copy link

The ssh commands allow you to connect to or create a secure shell (SSH) server.

Type ssh: then press Tab at the prompt to view the available commands.

19.1. ssh:ssh, ssh
Copy link

Abstract

connects to a remote SSH server

Synopsis
Copy link

ssh:ssh [ --help ] [[ -l username ] | [ --username username ]] [[ -P password ] | [ --password password ]] [[ -p port ] | [ --port port ]] { hostname } [ command ]

Arguments
Copy link

Table 19.1, “ssh:ssh Arguments” describes the commands arguments.

Expand

Table 19.1. ssh:ssh Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`-l, --username`	The username for remote login
`-P, --password`	The password for remote login
`-p, --port`	The port to use for the SSH connection
`hostname`	The hostname to connect to via SSH
`command`	Specifies a command to execute upon connecting.

19.2. ssh:sshd, sshd
Copy link

Abstract

creates an SSH server

Synopsis
Copy link

ssh:sshd [ --help ] [[ -b ] | [ --background ]] [[ -p port ] | [ --port port ]]

Arguments
Copy link

Table 19.2, “ssh:sshd Arguments” describes the commands arguments.

Expand

Table 19.2. ssh:sshd Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`-b, --background`	Specifies that the service will run in the background.
`-p, --port`	Specifies the port to setup for the SSH server. The default is `8101`.

Chapter 20. Web Console Commands
Copy link

The web command group is used to get information about WARs deployed in the container.

Type web: then press Tab at the prompt to view the commands in this group.

20.1. web:list
Copy link

Abstract

lists the WARs deployed in the container

Synopsis
Copy link

web:list [ --help ]

Arguments
Copy link

Table 20.1, “web:list Arguments” describes the command's arguments.

Expand

Table 20.1. web:list Arguments
Argument	Interpretation
`--help`	Displays the online help for this command

Chapter 21. The wrapper:install Command
Copy link

The wrapper:install command installs Red Hat JBoss Fuse as a system service.

Note

This feature is not installed by default. To install the wrapper shell, run the following command:

JBossFuse:karaf@root:> features:install wrapper

21.1. wrapper:install
Copy link

Abstract

installs the container as a system service in the operating system

Synopsis
Copy link

wrapper:install [ --help ] [[ -s ] | [ --start-type ] mode] [[ -n ] | [ --name ] serviceName] [[ -d ] | [ --display ] displayName] [[ -D ] | [ --description ] description]

Arguments
Copy link

This command takes the following arguments.

Expand

Table 21.1. wrapper:install Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`-s, --start-type`	The mode in which the service is installed, either `AUTO_START` or `DEMAND_START`; the default is `AUTO_START`
`-n, --name`	The service name used when installing the service; the default is `karaf`
`-d, --display`	The display name of the service
`-D, --description`	The description of the service

Chapter 22. ZooKeeper Console Commands
Copy link

By default, the ZooKeeper commands are not installed in a Fabric Container. To make the ZooKeeper commands available, install the fabric-zookeeper-commands feature, as follows:

features:install fabric-zookeeper-commands

features:install fabric-zookeeper-commands

Copy to Clipboard

Toggle word wrap

22.1. zk:create
Copy link

Abstract

create a znode

Synopsis
Copy link

zk:create [ --help ] [ -r|--recursive ] [ -i|--import ] [ -e|--ephemeral ] [ -s|--sequential ] [ -a|--acl ListOfACLs ] [ -o|--overwrite ] { path } { data }

Description
Copy link

Using this command, you can create the following different types of znode:

Persistent: The new znode is permanently stored in the ZooKeeper registry. This is the default.
Persistent sequential: The new znode is permanently stored in the ZooKeeper registry and a 10-digit sequence number is appended to the specified znode name. Selected by the --sequential option.
Ephemeral: The new znode exists only for the duration of the current client session. When the session is over, the znode is removed. Selected by the --ephemeral option.
Ephemeral sequential: The new znode exists only for the duration of the current client session and a 10-digit sequence number is appended to the specified znode name. When the session is over, the znode is removed. Selected by combining the --ephemeral option with the --sequential option.

You can optionally specify a list of ACLs to apply to the newly created znode. The ACL is specified as a comma-separated list, where each entry in the list has the following format:

Scheme:ID:Permissions

Scheme:ID:Permissions

Copy to Clipboard

Toggle word wrap

ZooKeeper supports the following built-in schemes:

world:anyone: The permissions apply to all users.
auth:: The permissions apply to all authenticated users, irrespective of their identity (the ID field is left empty).
digest:MD5Hash: The permissions apply to the user whose username and password generate the specified MD5 hash value, MD5Hash.
ip:IPAddress: The permissions apply to the ZooKeeper client with the specified IP address.

The Permissions string consists of one or more of the following characters: r (read), w (write), c (create), d (delete), and a (admin). For example, to create a new znode that explicitly grants all permissions to all users (which is, in fact, the default), you could use a command like the following:

karaf@root> zk:create --acl world:anyone:rwcda /path/to/the/new/znode

karaf@root> zk:create --acl world:anyone:rwcda /path/to/the/new/znode

Copy to Clipboard

Toggle word wrap

Important

To avoid corruption of the fabric registry, you should not create any znodes under the /fabric/ path using the zk:create command. These registry nodes should only be created through the fabric console commands—see Chapter 9, Fabric Console Commands.

Note

Fuse Fabric does not use the ACL security features of ZooKeeper. Currently, all znodes in the fabric registry are created without any ACL restrictions (equivalent to the world:anyone:rwcda ACL setting).

Arguments
Copy link

Table 22.1, “zk:create Arguments” describes the commands arguments.

Expand

Table 22.1. zk:create Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`-r,--recursive`	Automatically create any missing parent nodes in the specified path.
`-i,--import`	Interpret the data argument as a URL that locates a resource containing the initial data for the new znode.
`-e,--ephemeral`	Make the new znode epehemeral, so that it is automatically deleted after the current ZooKeeper client session closes.
`-s,--sequential`	Make the new znode sequential, which implies that a unique 10-digit suffix is appended to the znode name.
`-a,--acl`	Specifies the znode's ACL as a comma-separated list, where each entry in the list has the format, `Scheme:ID:Permissions`. The `Permissions` string consists of the following characters, concatenated in any order: `r` (read), `w` (write), `c` (create), `d` (delete), and `a` (admin).
`-o,--overwrite`	Overwrite the existing znode at this location, if there is one.
`path`	(Required) Path of the znode to create.
`data`	Initial data for the node or, if `--import` is specified, a URL pointing at a location that contains the initial data.

22.2. zk:delete
Copy link

Abstract

delete the specified znode

Synopsis
Copy link

zk:delete [ --help ] [ -v|--version version ] [ -r|--recursive ] { path }

Arguments
Copy link

Table 22.2, “zk:delete Arguments” describes the commands arguments.

Expand

Table 22.2. zk:delete Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`-v,--version`	The ZooKeeper znode version to delete. Defaults to -1 (all versions).
`-r,--recursive`	Recursively delete children. Defaults to `false`.
`path`	Path of the znode to delete.

22.3. zk:get
Copy link

Abstract

get a znode's data

Synopsis
Copy link

zk:get [ --help ] { path }

Arguments
Copy link

Table 22.3, “zk:get Arguments” describes the commands arguments.

Expand

Table 22.3. zk:get Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`path`	(Required) Path of the znode to get.

22.4. zk:list
Copy link

Abstract

list a znode's children

Synopsis
Copy link

zk:list [ --help ] [ -r|--recursive ] [ -d|--display ] { path }

Arguments
Copy link

Table 22.4, “zk:list Arguments” describes the commands arguments.

Expand

Table 22.4. zk:list Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`-r, --recursive`	List children recursively.
`-d, --display`	Display a znode's value, if set.
`path`	Path of the znode to list. Defaults to `/`.

22.5. zk:set
Copy link

Abstract

set a znode's data

Synopsis
Copy link

zk:set [ --help ] [ -i|--import ] { path } { data }

Description
Copy link

The data stored in a znode should not be too large. ZooKeeper imposes an absolute limit of 1 MB, but in practice a data item should normally be much smaller than that.

Important

To avoid corruption of the Fabric Registry, you should not modify any znodes under the /fabric/ path using the zk:set command. These registry values should only be changed through the fabric console commands—see Chapter 9, Fabric Console Commands.

Arguments
Copy link

Table 22.5, “zk:set Arguments” describes the commands arguments.

Expand

Table 22.5. zk:set Arguments
Argument	Interpretation
`--help`	Displays the online help for this command
`-i,--import`	Import data from a URL.
`path`	(Required) Path of the znode to set.
`data`	(Required) The new data or URL to import.

Legal Notice
Copy link

Trademark Disclaimer

The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.

Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.

Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, MetaMatrix, Fedora, the Infinity Logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

Apache, ServiceMix, Camel, CXF, and ActiveMQ are trademarks of Apache Software Foundation. Any other names contained herein may be trademarks of their respective owners.

Console Reference

Quick access to the Apache Karaf shell commands packaged under JBoss Fuse.

Red Hat

Chapter 1. Using the Command ConsoleCopy linkLink copied to clipboard!

OverviewCopy linkLink copied to clipboard!

Starting the command consoleCopy linkLink copied to clipboard!

Getting helpCopy linkLink copied to clipboard!

Command completionCopy linkLink copied to clipboard!

Command groupsCopy linkLink copied to clipboard!

Short versionCopy linkLink copied to clipboard!

About console inputCopy linkLink copied to clipboard!

Chapter 2. Shell Console CommandsCopy linkLink copied to clipboard!

2.1. shell:cat, catCopy linkLink copied to clipboard!

SynopsisCopy linkLink copied to clipboard!

ArgumentsCopy linkLink copied to clipboard!

2.2. shell:clear, clearCopy linkLink copied to clipboard!

SynopsisCopy linkLink copied to clipboard!

ArgumentsCopy linkLink copied to clipboard!

2.3. shell:each, eachCopy linkLink copied to clipboard!

SynopsisCopy linkLink copied to clipboard!

ArgumentsCopy linkLink copied to clipboard!

2.4. shell:echo, echoCopy linkLink copied to clipboard!

SynopsisCopy linkLink copied to clipboard!

ArgumentsCopy linkLink copied to clipboard!

2.5. shell:exec, execCopy linkLink copied to clipboard!

SynopsisCopy linkLink copied to clipboard!

ArgumentsCopy linkLink copied to clipboard!

2.6. shell:grep, grepCopy linkLink copied to clipboard!

SynopsisCopy linkLink copied to clipboard!

ArgumentsCopy linkLink copied to clipboard!

2.7. shell:head, headCopy linkLink copied to clipboard!

SynopsisCopy linkLink copied to clipboard!

ArgumentsCopy linkLink copied to clipboard!

2.8. shell:history, historyCopy linkLink copied to clipboard!

SynopsisCopy linkLink copied to clipboard!

ArgumentsCopy linkLink copied to clipboard!

2.9. shell:if, ifCopy linkLink copied to clipboard!

SynopsisCopy linkLink copied to clipboard!

ArgumentsCopy linkLink copied to clipboard!

2.10. shell:info, infoCopy linkLink copied to clipboard!

SynopsisCopy linkLink copied to clipboard!

ArgumentsCopy linkLink copied to clipboard!

2.11. shell:java, javaCopy linkLink copied to clipboard!

SynopsisCopy linkLink copied to clipboard!

ArgumentsCopy linkLink copied to clipboard!

2.12. shell:logout, logoutCopy linkLink copied to clipboard!

SynopsisCopy linkLink copied to clipboard!

ArgumentsCopy linkLink copied to clipboard!

2.13. shell:more, moreCopy linkLink copied to clipboard!

SynopsisCopy linkLink copied to clipboard!

ArgumentsCopy linkLink copied to clipboard!

2.14. shell:new, newCopy linkLink copied to clipboard!

SynopsisCopy linkLink copied to clipboard!

ArgumentsCopy linkLink copied to clipboard!

2.15. shell:printf, printfCopy linkLink copied to clipboard!

SynopsisCopy linkLink copied to clipboard!

ArgumentsCopy linkLink copied to clipboard!

2.16. shell:sleep, sleepCopy linkLink copied to clipboard!

SynopsisCopy linkLink copied to clipboard!

ArgumentsCopy linkLink copied to clipboard!

2.17. shell:sort, sortCopy linkLink copied to clipboard!

SynopsisCopy linkLink copied to clipboard!

ArgumentsCopy linkLink copied to clipboard!

2.18. shell:source, sourceCopy linkLink copied to clipboard!

SynopsisCopy linkLink copied to clipboard!

ArgumentsCopy linkLink copied to clipboard!

2.19. shell:tac, tacCopy linkLink copied to clipboard!

SynopsisCopy linkLink copied to clipboard!

ArgumentsCopy linkLink copied to clipboard!

2.20. shell:tail, tailCopy linkLink copied to clipboard!

SynopsisCopy linkLink copied to clipboard!

ArgumentsCopy linkLink copied to clipboard!

2.21. shell:watch, watchCopy linkLink copied to clipboard!

SynopsisCopy linkLink copied to clipboard!

ArgumentsCopy linkLink copied to clipboard!

Chapter 3. ActiveMQ Console CommandsCopy linkLink copied to clipboard!

3.1. activemq:browse, browseCopy linkLink copied to clipboard!

SynopsisCopy linkLink copied to clipboard!

ArgumentsCopy linkLink copied to clipboard!

Message filtersCopy linkLink copied to clipboard!

Chapter 1. Using the Command Console
Copy link

Overview
Copy link

Starting the command console
Copy link

Getting help
Copy link

Command completion
Copy link

Command groups
Copy link

Short version
Copy link

About console input
Copy link

Chapter 2. Shell Console Commands
Copy link

2.1. shell:cat, cat
Copy link

Synopsis
Copy link

Arguments
Copy link

2.2. shell:clear, clear
Copy link

Synopsis
Copy link

Arguments
Copy link

2.3. shell:each, each
Copy link

Synopsis
Copy link

Arguments
Copy link

2.4. shell:echo, echo
Copy link

Synopsis
Copy link

Arguments
Copy link

2.5. shell:exec, exec
Copy link

Synopsis
Copy link

Arguments
Copy link

2.6. shell:grep, grep
Copy link

Synopsis
Copy link

Arguments
Copy link

2.7. shell:head, head
Copy link

Synopsis
Copy link

Arguments
Copy link

2.8. shell:history, history
Copy link

Synopsis
Copy link

Arguments
Copy link

2.9. shell:if, if
Copy link

Synopsis
Copy link

Arguments
Copy link

2.10. shell:info, info
Copy link

Synopsis
Copy link

Arguments
Copy link

2.11. shell:java, java
Copy link

Synopsis
Copy link

Arguments
Copy link

2.12. shell:logout, logout
Copy link

Synopsis
Copy link

Arguments
Copy link

2.13. shell:more, more
Copy link

Synopsis
Copy link

Arguments
Copy link

2.14. shell:new, new
Copy link

Synopsis
Copy link

Arguments
Copy link

2.15. shell:printf, printf
Copy link

Synopsis
Copy link

Arguments
Copy link

2.16. shell:sleep, sleep
Copy link

Synopsis
Copy link

Arguments
Copy link

2.17. shell:sort, sort
Copy link

Synopsis
Copy link

Arguments
Copy link

2.18. shell:source, source
Copy link

Synopsis
Copy link

Arguments
Copy link

2.19. shell:tac, tac
Copy link

Synopsis
Copy link

Arguments
Copy link

2.20. shell:tail, tail
Copy link

Synopsis
Copy link

Arguments
Copy link

2.21. shell:watch, watch
Copy link

Synopsis
Copy link

Arguments
Copy link

Chapter 3. ActiveMQ Console Commands
Copy link

3.1. activemq:browse, browse
Copy link

Synopsis
Copy link

Arguments
Copy link

Message filters
Copy link

Examples
Copy link

3.2. activemq:bstat, bstat
Copy link

Synopsis
Copy link