Red Hat Summit Red Hat SummitSuporteConsoleDesenvolvedoresComeçar um testeContato

Este conteúdo não está disponível no idioma selecionado.

Chapter 2. Getting Started with the Management CLI

The management CLI is included with the JBoss EAP distribution. Once you launch the management CLI, you can connect to a running server instance or managed domains to perform management operations.

2.1. Launch the Management CLI
Copiar o link

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

$ EAP_HOME/bin/jboss-cli.sh
Copy to Clipboard Toggle word wrap
Note

For Windows Server, use the EAP_HOME\bin\jboss-cli.bat script to launch the management CLI.

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

Important

The jboss-cli scripts set the com.ibm.jsse2.overrideDefaultTLS property to true. This setting is important if you are using the IBM JDK to prevent authentication issues when using SSL configured by Elytron.

Be sure to set this property if you are using the IBM JDK and using another method to start a CLI session, for example, programmatically using the classes available in EAP_HOME/bin/client/jboss-cli-client.jar.

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.

2.2. Connect to the Server
Copiar o link

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

connect
Copy to Clipboard Toggle word wrap

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
Copy to Clipboard Toggle word wrap

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
Copy to Clipboard Toggle word wrap

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

connect http-remoting://192.168.0.1:9999
Copy to Clipboard Toggle word wrap

2.3. Change the Current Path
Copiar o link

You can change to a different node path by using the cd command and providing the desired path. When the management CLI is first launched, it is at the root level (/). 

cd /subsystem=datasources
cd data-source=ExampleDS
Copy to Clipboard Toggle word wrap

You can show the full path of the current node using the pwd command. 

pwd
Copy to Clipboard Toggle word wrap 
/subsystem=datasources/data-source=ExampleDS
Copy to Clipboard Toggle word wrap

2.4. List Contents
Copiar o link

You can list the contents of a particular node path by using the ls command. If the path ends on a node name, that resource’s attributes will be listed as well.

The below example navigates the standard-sockets socket binding group and then lists its contents. 

cd /socket-binding-group=standard-sockets
ls -l
Copy to Clipboard Toggle word wrap 
ATTRIBUTE         VALUE                                 TYPE
default-interface public                                STRING
name              standard-sockets                      STRING
port-offset       ${jboss.socket.binding.port-offset:0} INT

CHILD                                      MIN-OCCURS MAX-OCCURS
local-destination-outbound-socket-binding  n/a        n/a
remote-destination-outbound-socket-binding n/a        n/a
socket-binding                             n/a        n/a
Copy to Clipboard Toggle word wrap

The same result can be achieved from anywhere in the resource tree hierarchy by specifying the node path to the ls command. 

ls -l /socket-binding-group=standard-sockets
Copy to Clipboard Toggle word wrap 
ATTRIBUTE         VALUE                                 TYPE
default-interface public                                STRING
name              standard-sockets                      STRING
port-offset       ${jboss.socket.binding.port-offset:0} INT

CHILD                                      MIN-OCCURS MAX-OCCURS
local-destination-outbound-socket-binding  n/a        n/a
remote-destination-outbound-socket-binding n/a        n/a
socket-binding                             n/a        n/a
Copy to Clipboard Toggle word wrap

You can also use the --resolve-expressions parameter to resolve the expressions of the returned attributes to their value on the server. 

ls -l /socket-binding-group=standard-sockets --resolve-expressions
Copy to Clipboard Toggle word wrap 
ATTRIBUTE         VALUE            TYPE
default-interface public           STRING
name              standard-sockets STRING
port-offset       0                INT

CHILD                                      MIN-OCCURS MAX-OCCURS
local-destination-outbound-socket-binding  n/a        n/a
remote-destination-outbound-socket-binding n/a        n/a
socket-binding                             n/a        n/a
Copy to Clipboard Toggle word wrap

In this example, the port-offset attribute shows its resolved value (0) instead of the expression (${jboss.socket.binding.port-offset:0}).

2.5. Getting Help
Copiar o link

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

  • View general help on using the management CLI. 

    help
    Copy to Clipboard Toggle word wrap

    This provides detailed help with launching, navigating, and generating operation requests.

  • View help for a particular command. 

    COMMAND_NAME --help
    Copy to Clipboard Toggle word wrap

    This provides the usage, description, and arguments for the particular command.

  • View the list of available commands, 

    help --commands
    Copy to Clipboard Toggle word wrap
    Note

    Commands that require a connection to either a standalone server or domain controller will not appear in the list unless the connection has been established.

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

2.6. Quit the Management CLI
Copiar o link

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

quit
Copy to Clipboard Toggle word wrap

2.7. Run in Non-Interactive Mode
Copiar o link

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)"
Copy to Clipboard Toggle word wrap

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

{
    "outcome" => "success",
    "result" => "127.0.0.1"
}
Copy to Clipboard Toggle word wrap

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
Copy to Clipboard Toggle word wrap

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

Example Output

{
    "outcome" => "success",
    "result" => "NORMAL"
}
helloworld.war
Copy to Clipboard Toggle word wrap

Note

You can include comments in a CLI script to aid understanding and maintenance. Comments are denoted by a pound sign (#) at the beginning of the line. While executing the script, JBoss EAP ignores the comments you included.

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
Copy to Clipboard Toggle word wrap

The command and its output are displayed as it executes.

Example Output With Command Echo

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

Red Hat logoGithubredditYoutubeTwitter

Aprender

Experimente, compre e venda

Comunidades

Sobre a documentação da Red Hat

Ajudamos os usuários da Red Hat a inovar e atingir seus objetivos com nossos produtos e serviços com conteúdo em que podem confiar. Explore nossas atualizações recentes.

Tornando o open source mais inclusivo

A Red Hat está comprometida em substituir a linguagem problemática em nosso código, documentação e propriedades da web. Para mais detalhes veja o Blog da Red Hat.

Sobre a Red Hat

Fornecemos soluções robustas que facilitam o trabalho das empresas em plataformas e ambientes, desde o data center principal até a borda da rede.

Theme

© 2026 Red HatVoltar ao topo