3.4. The Management CLI

Procedure 3.7. 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

Procedure 3.8. 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. 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

Procedure 3.9. Batch Mode Commands and Operations

1. Enter batch mode

   Enter batch mode with the batch command.

   [standalone@localhost:9999 /] batch

   Batch mode is indicated by the hash symbol (#) in the prompt.

2. Add operation requests to the batch

   Once in batch mode, enter operation requests as normal. The operation requests are added to the batch in the order they are entered.
   Refer to Section 3.4.8, “Use Operations and Commands in the Management CLI” for details on formatting operation requests.

3. Run the batch

   Once the entire sequence of operation requests is entered, run the batch with the run-batch command.

   [standalone@localhost:9999 / #] run-batch
   The batch executed successfully.

   Refer to Section 3.4.7, “CLI Batch Mode Commands” for a full list of commands available for working with batches.

4. Batch commands stored in external files

   Frequently run batch commands can be stored in an external text file and can either be loaded by passing the full path to the file as an argument to the batch command or executed directly by being an argument to the run-batch command.
   You can create a batch command file using a text editor. Each command must be on a line by itself and the CLI should be able to access it.
   The following command will load a myscript.txt file in the batch mode. All commands in this file will now be accessible to be edited or removed. New commands can be inserted. Changes made in this batch session do not persist to the myscript.txt file.

   [standalone@localhost:9999 /] batch --file=myscript.txt

   The following will instantly run the batch commands stored in the file myscript.txt

   [standalone@localhost:9999 /] run-batch --file=myscript.txt

Procedure 3.10. Create, Configure and Execute Requests

1. Construct the operation request

   Operation requests allow for low-level interaction with the management model. They provide a controlled way to edit server configurations. An operation request consists of three parts:
   • an address, prefixed with a slash (/).
   • an operation name, prefixed with a colon (:).
   • an optional set of parameters, contained within parentheses (()).

   1. Determine the address

      The configuration is presented as a hierarchical tree of addressable resources. Each resource node offers a different set of operations. The address specifies which resource node to perform the operation on. An address uses the following syntax:

      /node-type=node-name

      • node-type is the resource node type. This maps to an element name in the configuration XML.
      • node-name is the resource node name. This maps to the name attribute of the element in the configuration XML.
      • Separate each level of the resource tree with a slash (/).
      Refer to the configuration XML files to determine the required address. The EAP_HOME/standalone/configuration/standalone.xml file holds the configuration for a standalone server and the EAP_HOME/domain/configuration/domain.xml and EAP_HOME/domain/configuration/host.xml files hold the configuration for a managed domain.

      Note

      Running the CLI commands in Domain Mode requires host and server specification. For example, /host=master/server=server-one/subsystem=logging

      Example 3.5. Example operation addresses

      To perform an operation on the logging subsystem, use the following address in an operation request:

      /subsystem=logging

      To perform an operation on the Java datasource, use the following address in an operation request:

      /subsystem=datasources/data-source=java

   2. Determine the operation

      Operations differ for each different type of resource node. An operation uses the following syntax:

      :operation-name

      • operation-name is the name of the operation to request.
      Use the read-operation-names operation on any resource address in a standalone server to list the available operations.

      Example 3.6. Available operations

      To list all available operations for the logging subsystem, enter the following request for a standalone server:

      [standalone@localhost:9999 /] /subsystem=logging:read-operation-names
      {
          "outcome" => "success",
          "result" => [
              "add",
              "read-attribute",
              "read-children-names",
              "read-children-resources",
              "read-children-types",
              "read-operation-description",
              "read-operation-names",
              "read-resource",
              "read-resource-description",
              "remove",
              "undefine-attribute",
              "whoami",
              "write-attribute"
          ]
      }

   3. Determine any parameters

      Each operation may require different parameters.
      Parameters use the following syntax:

      (parameter-name=parameter-value)

      • parameter-name is the name of the parameter.
      • parameter-value is the value of the parameter.
      • Multiple parameters are separated by commas (,).
      To determine any required parameters, perform the read-operation-description command on a resource node, passing the operation name as a parameter. Refer to Example 3.7, “Determine operation parameters” for details.

      Example 3.7. Determine operation parameters

      To determine any required parameters for the read-children-types operation on the logging subsystem, enter the read-operation-description command as follows:

      [standalone@localhost:9999 /] /subsystem=logging:read-operation-description(name=read-children-types)
      {
          "outcome" => "success",
          "result" => {
              "operation-name" => "read-children-types",
              "description" => "Gets the type names of all the children under the selected resource",
              "reply-properties" => {
                  "type" => LIST,
                  "description" => "The children types",
                  "value-type" => STRING
              },
              "read-only" => true
          }
      }

2. Enter the full operation request

   Once the address, operation, and any parameters have been determined, enter the full operation request.

   Example 3.8. Example operation request

   [standalone@localhost:9999 /] /subsystem=web/connector=http:read-resource(recursive=true)

Procedure 3.11. Enable Property Substitution in the Management CLI

1. Open the file EAP_HOME/bin/jboss-cli.xml.
2. Locate the resolve-parameter-values parameter and change the value to true (the default is false).

   <!-- whether to resolve system properties specified as command argument or operation parameter values in the Management CLI VM before sending the operation requests to the controller -->
       <resolve-parameter-values>true</resolve-parameter-values>