The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

Karaf Build Step Plugin

step([$class: 'KarafBuildStepBuilder']): Execute Karaf command

  • useCustomKaraf : boolean
  • karafHome : String
  • flags : String
    -a [port]

    specify the port to connect to

    -h [host]

    specify the host to connect to

    -u [user]

    specify the user name

    -p [password]

    specify the password (optional, if not provided, the password is prompted)


    raise verbosity


    set client logging level. Set to 0 for ERROR logging and up to 4 for TRACE

    -r [attempts]

    retry connection establishment (up to attempts times)

    -d [delay]

    intra-retry delay (defaults to 2 seconds)

    -f [file]

    read commands from the specified file

    -k [keyFile]

    specify the private keyFile location when using key login, need have BouncyCastle registered as security provider using this flag

    -t [timeout]

    define the client idle timeout

  • option
      Nested Choice of Objects
    • $class: 'KarafCommandFileOption'
      • file : String
    • $class: 'KarafCommandScriptOption'
      • script : String (optional)

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?


See existing feedback here.