1.3. Management CLI

1.3.1. Launch the Management CLI

Procedure 1.1. Launch CLI in Linux or Microsoft Windows Server

    • Launch the CLI in Linux

      Run the EAP_HOME/bin/jboss-cli.sh file by entering the following at a command line: 
      $ EAP_HOME/bin/jboss-cli.sh

    • Launch the CLI in Microsoft Windows Server

      Run the EAP_HOME\bin\jboss-cli.bat file by double-clicking it, or by entering the following at a command line: 
      C:\>EAP_HOME\bin\jboss-cli.bat

1.3.2. Quit the Management CLI

From the Management CLI, enter the quit command: 
[domain@localhost:9999 /] quit

1.3.3. Connect to a Managed Server Instance Using the Management CLI

Prerequisites

Procedure 1.2. Connect to a Managed Server Instance

  • Run the connect command

    From the Management CLI, enter the connect command: 
    [disconnected /] connect
Connected to domain controller at localhost:9999
    • Alternatively, to connect to a managed server when starting the Management CLI on a Linux system, use the --connect parameter: 
      $ EAP_HOME/bin/jboss-cli.sh --connect
    • The --connect parameter can be used to specify the host and port of the server. To connect to the address 192.168.0.1 with the port value 9999 the following would apply: 
      $ EAP_HOME/bin/jboss-cli.sh --connect --controller=192.168.0.1:9999

1.3.4. Obtain Help with the Management CLI

Summary

Sometimes you might need guidance if you need to learn a CLI command or feel unsure about what to do. The Management CLI features a help dialog with general and context-sensitive options. (Note that the help commands dependent on the operation context require an established connection to either a standalone or domain controller. These commands will not appear in the listing unless the connection has been established.)

Prerequisites

  1. For general help

    From the Management CLI, enter the help command: 
    [standalone@localhost:9999 /] help

  2. Obtain context-sensitive help

    From the Management CLI, enter the help -commands extended command: 
    [standalone@localhost:9999 /] help --commands
  3. For a more detailed description of a specific command, enter the command, followed by --help. 
    [standalone@localhost:9999 /] deploy --help
Result

The CLI help information is displayed.