Chapter 2. Getting Started with the Management CLI

You can launch the management CLI by running the jboss-cli script provided with JBoss EAP.

EAP_HOME/bin/jboss-cli.sh

$ EAP_HOME/bin/jboss-cli.sh

See Connect to the Server for details on launching the management CLI and connecting to the server in one step using the --connect argument.

For a complete listing of all available jboss-cli script arguments and their purposes, use the --help argument or see the Management CLI Startup Arguments section.

You can connect to a running standalone server or managed domain by using the connect command.

connect

connect

The default host and port configuration is localhost:9990. If the server is listening on a different host and port, then these need to be provided to the connect command.

connect 192.168.0.1:9991

connect 192.168.0.1:9991

You can also launch the management CLI and connect to the server in one step using the --connect argument (and the --controller argument if necessary).

EAP_HOME/bin/jboss-cli.sh --connect --controller=192.168.0.1:9991

$ EAP_HOME/bin/jboss-cli.sh --connect --controller=192.168.0.1:9991

In JBoss EAP 7.3, to connect using the http-remoting protocol, use:

connect http-remoting://192.168.0.1:9990

connect http-remoting://192.168.0.1:9990

The management CLI provides several ways for you to get help with using the management CLI.

See the Management CLI Commands section for a listing of management CLI commands.

You can quit the management CLI by entering the quit command.

quit

quit

You can issue management CLI commands without launching and interacting with the management CLI. This is useful for processing batches of commands and executing commands from scripts. You can either pass in the commands or pass in a file that contains commands to the jboss-cli startup script.

Pass in Commands

You can use the --command argument to provide a single CLI command to execute. The management CLI will terminate once the commands have completed.

EAP_HOME/bin/jboss-cli.sh --connect --command="/interface=public:read-attribute(name=inet-address,resolve-expressions=true)"

$ EAP_HOME/bin/jboss-cli.sh --connect --command="/interface=public:read-attribute(name=inet-address,resolve-expressions=true)"

The output from each command provided is displayed as it executes.

{
    "outcome" => "success",
    "result" => "127.0.0.1"
}

{
    "outcome" => "success",
    "result" => "127.0.0.1"
}

You can also use the --commands argument to provide a comma-separated list of CLI commands to execute.

Pass in a File of Commands

You can use the --file argument to pass in a text file of CLI commands to execute, with each command on a separate line in the file.

EAP_HOME/bin/jboss-cli.sh --connect --file=/path/to/cli_commands.txt

$ EAP_HOME/bin/jboss-cli.sh --connect --file=/path/to/cli_commands.txt

The output from each command in the file is displayed as it executes.

{
    "outcome" => "success",
    "result" => "NORMAL"
}
helloworld.war

{
    "outcome" => "success",
    "result" => "NORMAL"
}
helloworld.war

You can use the --echo-command argument to include the prompt and command with the output. This can be useful when resolving failures by matching the output to the command that was executed.

EAP_HOME/bin/jboss-cli.sh --connect --file=/path/to/cli_commands.txt --echo-command

$ EAP_HOME/bin/jboss-cli.sh --connect --file=/path/to/cli_commands.txt --echo-command

The command and its output are displayed as it executes.

[standalone@localhost:9990 /] :read-attribute(name=running-mode)
{
    "outcome" => "success",
    "result" => "NORMAL"
}
[standalone@localhost:9990 /] ls /deployment
helloworld.war

[standalone@localhost:9990 /] :read-attribute(name=running-mode)
{
    "outcome" => "success",
    "result" => "NORMAL"
}
[standalone@localhost:9990 /] ls /deployment
helloworld.war