Chapter 2. camel

2.1. camel:component-list

2.1.1. Description

Lists all Camel components that are in use in Karaf.

2.1.2. Syntax

camel:component-list [options] name

2.1.3. Arguments

NameDescription

name

The Camel context name where to look for the components

2.1.4. Options

NameDescription

--help

Display this help message

--verbose, -v

Verbose output which shows more information

2.2. camel:context-inflight

2.2.1. Description

List inflight exchanges.

2.2.2. Syntax

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

2.2.3. Arguments

NameDescription

name

The Camel context name

route

The Camel route ID

2.2.4. Options

NameDescription

--help

Display this help message

--limit, -l

To limit the number of exchanges shown

--sort, -s

true = sort by longest duration, false = sort by exchange id

2.3. camel:context-info

2.3.1. Description

Display detailed information about a Camel context.

2.3.2. Syntax

camel:context-info [options] name

2.3.3. Arguments

NameDescription

name

The name of the Camel context

2.3.4. Options

NameDescription

--help

Display this help message

--verbose, -v

Verbose output

2.4. camel:context-list

2.4.1. Description

Lists all Camel contexts.

2.4.2. Syntax

camel:context-list [options]

2.4.3. Options

NameDescription

--help

Display this help message

2.5. camel:context-resume

2.5.1. Description

Resumes a Camel context.

2.5.2. Syntax

camel:context-resume [options] context

2.5.3. Arguments

NameDescription

context

The name of the Camel context.

2.5.4. Options

NameDescription

--help

Display this help message

2.6. camel:context-start

2.6.1. Description

Start a Camel context.

2.6.2. Syntax

camel:context-start [options] context

2.6.3. Arguments

NameDescription

context

The name of the Camel context.

2.6.4. Options

NameDescription

--help

Display this help message

2.7. camel:context-stop

2.7.1. Description

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

2.7.2. Syntax

camel:context-stop [options] context

2.7.3. Arguments

NameDescription

context

The name of the Camel context.

2.7.4. Options

NameDescription

--help

Display this help message

2.8. camel:context-suspend

2.8.1. Description

Suspends a Camel context.

2.8.2. Syntax

camel:context-suspend [options] context

2.8.3. Arguments

NameDescription

context

The name of the Camel context.

2.8.4. Options

NameDescription

--help

Display this help message

2.9. camel:eip-explain

2.9.1. Description

Explain the EIP in the CamelContext

2.9.2. Syntax

camel:eip-explain [options] name nameOrId

2.9.3. Arguments

NameDescription

name

The name of the Camel context

nameOrId

The name of the EIP or a node id to refer to a specific node from the routes

2.9.4. Options

NameDescription

--verbose, -v

Verbose output to explain all options

--help

Display this help message

2.10. camel:endpoint-explain

2.10.1. Description

Explain all Camel endpoints available in the CamelContext

2.10.2. Syntax

camel:endpoint-explain [options] name

2.10.3. Arguments

NameDescription

name

The name of the Camel context

2.10.4. Options

NameDescription

--verbose, -v

Verbose output to explain all options

--help

Display this help message

--filter, -f

To filter endpoints by pattern

2.11. camel:endpoint-list

2.11.1. Description

Lists Camel endpoints

2.11.2. Syntax

camel:endpoint-list [options] [name]

2.11.3. Arguments

NameDescription

name

The name of the Camel context or a wildcard expression

2.11.4. Options

NameDescription

--help

Display this help message

--verbose, -v

Verbose output which does not limit the length of the uri shown, or to explain all options (if explain selected)

--explain, -e

Whether to explain the endpoint options

--decode, -d

Whether to decode the endpoint uri so its human readable

2.12. camel:endpoint-stats

2.12.1. Description

Display endpoint runtime statistics

2.12.2. Syntax

camel:endpoint-stats [options] [name]

2.12.3. Arguments

NameDescription

name

The name of the Camel context (support wildcard)

2.12.4. Options

NameDescription

--help

Display this help message

--filter, -f

Filter the list by in,out,static,dynamic

--decode, -d

Whether to decode the endpoint uri so its human readable

2.13. camel:rest-api-doc

2.13.1. Description

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

2.13.2. Syntax

camel:rest-api-doc [options] name

2.13.3. Arguments

NameDescription

name

The Camel context name where to look for the REST services

2.13.4. Options

NameDescription

--help

Display this help message

2.14. camel:rest-registry-list

2.14.1. Description

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

2.14.2. Syntax

camel:rest-registry-list [options] name

2.14.3. Arguments

NameDescription

name

The Camel context name where to look for the REST services

2.14.4. Options

NameDescription

--help

Display this help message

--verbose, -v

Verbose output which does not limit the length of the uri shown

--decode, -d

Whether to decode the endpoint uri so its human readable

2.15. camel:rest-show

2.15.1. Description

Display the Camel REST definition in XML

2.15.2. Syntax

camel:rest-show [options] name

2.15.3. Arguments

NameDescription

name

The name of the Camel context

2.15.4. Options

NameDescription

--help

Display this help message

2.16. camel:route-info

2.16.1. Description

Display information about a Camel route.

2.16.2. Syntax

camel:route-info [options] context route

2.16.3. Arguments

NameDescription

context

The Camel context name.

route

The Camel route ID or a wildcard expression

2.16.4. Options

NameDescription

--help

Display this help message

2.17. camel:route-list

2.17.1. Description

List Camel routes.

2.17.2. Syntax

camel:route-list [options] [name]

2.17.3. Arguments

NameDescription

name

The Camel context name where to look for the route

2.17.4. Options

NameDescription

--help

Display this help message

2.18. camel:route-profile

2.18.1. Description

Display profile information about Camel route(s).

2.18.2. Syntax

camel:route-profile [options] context route

2.18.3. Arguments

NameDescription

context

The Camel context name.

route

The Camel route ID or a wildcard expression

2.18.4. Options

NameDescription

--help

Display this help message

2.19. camel:route-reset-stats

2.19.1. Description

Reset route performance stats from a CamelContext

2.19.2. Syntax

camel:route-reset-stats [options] context

2.19.3. Arguments

NameDescription

context

The name of the Camel context.

2.19.4. Options

NameDescription

--help

Display this help message

2.20. camel:route-resume

2.20.1. Description

Resume a Camel route

2.20.2. Syntax

camel:route-resume [options] context route

2.20.3. Arguments

NameDescription

context

The Camel context name.

route

The Camel route ID or a wildcard expression

2.20.4. Options

NameDescription

--help

Display this help message

2.21. camel:route-show

2.21.1. Description

Display the Camel route definition in XML

2.21.2. Syntax

camel:route-show [options] context route

2.21.3. Arguments

NameDescription

context

The Camel context name.

route

The Camel route ID or a wildcard expression

2.21.4. Options

NameDescription

--help

Display this help message

2.22. camel:route-start

2.22.1. Description

Start a Camel route

2.22.2. Syntax

camel:route-start [options] context route

2.22.3. Arguments

NameDescription

context

The Camel context name.

route

The Camel route ID or a wildcard expression

2.22.4. Options

NameDescription

--help

Display this help message

2.23. camel:route-stop

2.23.1. Description

Stop a Camel route

2.23.2. Syntax

camel:route-stop [options] context route

2.23.3. Arguments

NameDescription

context

The Camel context name.

route

The Camel route ID or a wildcard expression

2.23.4. Options

NameDescription

--help

Display this help message

2.24. camel:route-suspend

2.24.1. Description

Suspend a Camel route

2.24.2. Syntax

camel:route-suspend [options] context route

2.24.3. Arguments

NameDescription

context

The Camel context name.

route

The Camel route ID or a wildcard expression

2.24.4. Options

NameDescription

--help

Display this help message