JBoss EAP 6 what is the purpose of jboss-cli.xml / what are the settings in jboss-cli.xml

Solution Verified - Updated

Environment

JBoss Enterprise Application Platform (EAP) 6.x

Issue

What is the purpose of $JBOSS_HOME/bin/jboss-cli.xml and what are the settings ?

Resolution

A JBoss CLI client, which can be the jboss-cli.sh/jboss-cli.bat or one you write yourself against the JBoss CLI API, will at startup try and load from its working directory a file called "jboss-cli.xml".

For the jboss-cli.sh command this would be:

$JBOSS_HOME/bin/jboss-cli.xml

It is fully documented in

EAP 6.0.x:  $JBOSS_HOME/docs/schema/jboss-as-cli_1_1.xsd
EAP 6.1.x:  $JBOSS_HOME/docs/schema/jboss-as-cli_1_2.xsd
EAP 6.2.x:  $JBOSS_HOME/docs/schema/jboss-as-cli_1_2.xsd
EAP 6.3.x:  $JBOSS_HOME/docs/schema/jboss-as-cli_1_3.xsd

A brief overview:

  • default-controller
    This is where you can configure host and port to which the CLI should connect if you do not specify this at the command line
    By default this is:

    • localhost
    • 9999

  • validate-operation-requests
    When true (the default) the syntax of the command gets checked before being send to the controller. Should normally not be changed.

  • history
    Here you can configure how and where the command history should be kept.
    By default this is stored in ".jboss-cli-history" in your home directory.
    For security reasons you might want to disable the history.

  • ssl
    If you have configured the management domain to use 2-way SSL authentication, then the CLI will need a key and truststore with the controllers server certificate and a valid client certificate.
    Full configuration information can be found in https://access.redhat.com/site/solutions/427463

New since 6.1.0:

  • connection-timeout
    Allows you to change the default 5 seconds timeout for connecting to the controller.

  • silent
    When set to true, all output will be logged to the terminal, even when you are for example redirecting to a file.

new since 6.3:

  • ssl/vault
    The SSL section now allows the use of a vault to encrypt the key and truststore passwords.
SBR
Product(s)
Category
Tags

This solution is part of Red Hat’s fast-track publication program, providing a huge library of solutions that Red Hat engineers have created while supporting our customers. To give you the knowledge you need the instant it becomes available, these articles may be presented in a raw and unedited form.