Administration and Configuration Guide

Procedure 2.1. Start the Platform Service as a Standalone Server

1. For Red Hat Enterprise Linux.

   Run the command: EAP_HOME/bin/standalone.sh

2. For Microsoft Windows Server.

   Run the command: EAP_HOME\bin\standalone.bat

3. Optional: Specify additional parameters.

   To list all available parameters for the start-up scripts, use the -h parameter.

Procedure 2.2. Run multiple instances of JBoss EAP standalone servers on a single machine

1. Create a copy of the EAP_HOME/standalone/ directory directly under EAP_HOME/ for each standalone server. For example, to create a directory for standalone servers node1 and node2, type the following commands.

   $ cd EAP_HOME
   $ cp -a ./standalone ./node1 
   $ cp -a ./standalone ./node2

2. Start each JBoss EAP standalone instance by specifying the node name, IP address, server directory, optional server configuration file, and optional port offset. The command uses the following syntax:

   $ ./bin/standalone.sh -Djboss.node.name=UNIQUE_NODENAME -Djboss.server.base.dir=EAP_HOME/NODE_DIRECTORY -b IP_ADDRESS -bmanagement MGMT_IP_ADDRESS --server-config=SERVER_CONFIGURATION_FILE -Djboss.socket.binding.port-offset=PORT_OFFSET

   1. This example starts node1

      $ cd EAP_HOME
      $ ./bin/standalone.sh -Djboss.node.name=node1 -Djboss.server.base.dir=EAP_HOME/node1 -b 10.10.10.10 -bmanagement 127.0.0.1
      

   2. This example to start node2 depends on whether the machine supports multiple IP addresses.
      • If the machine supports multiple IP addresses, the following command is to be used.

        $ cd EAP_HOME
        $ ./bin/standalone.sh -Djboss.node.name=node2 -Djboss.server.base.dir=EAP_HOME/node2 -b 10.10.10.40 -bmanagement 127.0.0.40
        

      • If the machine does not support multiple IP addresses, you must specify a jboss.socket.binding.port-offset property to avoid a port conflict.

        $ cd EAP_HOME
        $ ./bin/standalone.sh -Djboss.node.name=node2 -Djboss.server.base.dir=EAP_HOME/node2 -b 10.10.10.10 -bmanagement 127.0.0.1 -Djboss.socket.binding.port-offset=100
        

Procedure 2.3. Start the Platform Service as a Managed Domain

1. For Red Hat Enterprise Linux.

   Run the command: EAP_HOME/bin/domain.sh

2. For Microsoft Windows Server.

   Run the command: EAP_HOME\bin\domain.bat

3. Optional: Pass additional parameters to the start-up script.

   To list all available parameters for the start-up scripts, use the -h parameter.

Procedure 2.4. Configure the Host Name Using a System Property

1. Open the host configuration file for editing, for example, host.xml.
2. Find the host element in the file, for example:

   <host name="master" xmlns="urn:jboss:domain:1.6">

3. If it is present, remove the name="HOST_NAME" attribute declaration. The host element should now look like the following example.

   <host xmlns="urn:jboss:domain:1.6">

4. Start the server passing the -Djboss.host.name argument, for example:

   -Djboss.host.name=HOST_NAME

Procedure 2.5. Configure the Host Name Using a Specific Name

1. Start the JBoss EAP slave host using the following syntax:

   bin/domain.sh --host-config=HOST_FILE_NAME

   For example:

   bin/domain.sh --host-config=host-slave01.xml

2. Launch the Management CLI.
3. Use the following syntax to replace the host name:

   /host=EXISTING_HOST_NAME:write-attribute(name="name",value=UNIQUE_HOST_NAME)

   For example:

   /host=master:write-attribute(name="name",value="host-slave01")

   You should see the following result.

    "outcome" => "success"

   This modifies the host name attribute in the host-slave01.xml file as follows:

   <host name="host-slave01" xmlns="urn:jboss:domain:1.6">

4. You must reload the server configuration using the old host name to complete the process

   reload --host=EXISTING_HOST_NAME

   For example:

   reload --host=master

Procedure 2.6. Create managed domain on two machines

1. On Machine 1

   1. Use the add-user.sh script to add management user. For example, slave01, so the host can authenticate the domain controller. Note the SECRET_VALUE from the add-user output.
   2. Start domain with host-master.xml config file, which is preconfigured for dedicated domain controller.
   3. Use -bmanagement=$IP1 to make domain controller visible to other machines.

      EAP_HOME/bin/domain.sh --host-config=host-master.xml -bmanagement=$IP1

2. On Machine 2

   1. Update EAP_HOME/domain/configuration/host-slave.xml file with user credentials.

      	<?xml version='1.0' encoding='UTF-8'?>
              <host xmlns="urn:jboss:domain:1.6" name="slave01">   
              <!-- add user name here -->
               <management>
                  <security-realms>
                     <security-realm name="ManagementRealm">
                        <server-identities>
                          <secret value="$SECRET_VALUE" />   
                          <!-- use secret value from add-user.sh output-->
                        </server-identities> 
                        ...

   2. Start host.

      EAP_HOME/bin/domain.sh --host-config=host-slave.xml  -Djboss.domain.master.address=$IP1 -b=$IP2

3. Now we can manage the domain.

   via CLI:

   EAP_HOME/bin/jboss-cli.sh -c --controller=$IP1
   

   via Web Console:

   http://$IP1:9990
   

   Access the server index page:

   http://$IP2:8080/
   http://$IP2:8230/
   

Procedure 2.7. Run Multiple Host Controllers on a Single Machine

1. Copy the EAP_HOME/domain directory for the domain controller.

   cp -r EAP_HOME/domain /path/to/domain1

2. Copy the EAP_HOME/domain directory for a host controller.

   cp -r EAP_HOME/domain /path/to/host1

3. Start the domain controller using /path/to/domain1.

   EAP_HOME/bin/domain.sh --host-config=host-master.xml -Djboss.domain.base.dir=/path/to/domain1

4. Start the host controller using /path/to/host1.

   EAP_HOME/bin/domain.sh --host-config=host-slave.xml -Djboss.domain.base.dir=/path/to/host1 -Djboss.domain.master.address=IP_ADDRESS -Djboss.management.native.port=PORT

Procedure 2.8. Stop an instance of JBoss EAP 6

• Stop an instance which was started interactively from a command prompt.

  Press Ctrl-C in the terminal where JBoss EAP 6 is running.

Procedure 2.9. Stop an instance which was started as an operating system service.

• • Red Hat Enterprise Linux

    For Red Hat Enterprise Linux, if you have written a service script, use its stop facility. This needs to be written into the script. Then you can use service scriptname stop, where scriptname is the name of the script.

  • Microsoft Windows Server

    In Microsoft Windows, use the net service command, or stop the service from the Services applet in the Control Panel.

Procedure 2.10. Stop an instance which is running in the background (Red Hat Enterprise Linux)

1. Obtain the process ID (PID) of the process:

   • If only a single instance is running (standalone mode)

     Either of the following commands will return the PID of a single instance of JBoss EAP 6:
     • pidof java
     • jps
       (The jps command will return an ID for two processes; one for jboss-modules.jar and one for jps itself. Use the ID for jboss-modules.jar to stop the EAP instance)

   • If multiple EAP instances are running (domain mode)

     Identifying the correct process to end if more than one instance of EAP is running requires more comprehensive commands be used.
     • The jps command can be used in verbose mode to provide more information about the java processes it finds.
       Below is an abridged output from a verbose jps command identifying the different EAP processes running by PID and role:

       $ jps -v
       12155 jboss-modules.jar -D[Server:server-one] -XX:PermSize=256m -XX:MaxPermSize=256m -Xms1303m 
       ...
       
       12196 jboss-modules.jar -D[Server:server-two] -XX:PermSize=256m -XX:MaxPermSize=256m -Xms1303m 
       ...
       
       12096 jboss-modules.jar -D[Host Controller] -Xms64m -Xmx512m -XX:MaxPermSize=256m 
       ...
       
       11872 Main -Xms128m -Xmx750m -XX:MaxPermSize=350m -XX:ReservedCodeCacheSize=96m -XX:+UseCodeCacheFlushing 
       ...
       
       11248 jboss-modules.jar -D[Standalone] -XX:+UseCompressedOops -verbose:gc 
       ...
       
       12892 Jps 
       ...
       
       12080 jboss-modules.jar -D[Process Controller] -Xms64m -Xmx512m -XX:MaxPermSize=256m 
       ...
       

     • The ps aux command can also be used to return information about multiple EAP instances.
       Below is an abridged output from a verbose ps aux command identifying the different EAP processes running by PID and role:

       $ ps aux | grep java
       username 12080  0.1  0.9 3606588 36772 pts/0   Sl+  10:09   0:01 /path/to/java -D[Process Controller] -server -Xms128m -Xmx128m -XX:MaxPermSize=256m 
       ...
       
       username 12096  1.0  4.1 3741304 158452 pts/0  Sl+  10:09   0:13 /path/to/java -D[Host Controller] -Xms128m -Xmx128m -XX:MaxPermSize=256m 
       ...
       
       username 12155  1.7  8.9 4741800 344224 pts/0  Sl+  10:09   0:22 /path/to/java -D[Server:server-one] -XX:PermSize=256m -XX:MaxPermSize=256m -Xms1000m -Xmx1000m -server -
       ...
       
       username 12196  1.8  9.4 4739612 364436 pts/0  Sl+  10:09   0:22 /path/to/java -D[Server:server-two] -XX:PermSize=256m -XX:MaxPermSize=256m -Xms1000m -Xmx1000m -server 
       ...
       

     In the above examples, the Process Controller processes are the processes to stop in order to stop the entire domain.
     The grep utility can be used with either of these commands to identify the Process Controller:

     jps -v | grep "Process Controller"

     ps aux | grep "Process Controller"

2. Send the process the TERM signal, by running kill PID, where PID is the process ID identified by one of the commands above.

Procedure 2.11. Start the Server for a Managed Domain

1. Select the Domain tab at the top of the console and then, select the TOPOLOGY tab. In the left navigation bar, under Domain, select Overview.
2. From the list of Server Instances, select the server you want to start. Servers that are running are indicated by a check mark.
   Hover the cursor over an instance in this list to show options in blue text below the server's details.
3. To start the instance, click on the Start Server text when it appears. A confirmation dialogue box will open. Click Confirm to start the server.

Procedure 2.12. Stop a Server in a Managed Domain Using the Management Console

1. Select the Domain tab at the top of the console and then, select the TOPOLOGY tab. In the left navigation bar, under Domain, select Overview.
2. A list of available Server Instances is displayed on the Hosts, groups and server instances table. Servers that are running are indicated by a check mark.
3. Hover the cursor over the chosen server. Click on the Stop Server text that appears. A confirmation dialogue window will appear.
4. Click Confirm to stop the server.

Procedure 2.13. Back Up the Configuration Data

1. To keep user and profile data, domain, host, slave, and logging configuration, back up the entire contents of the following directories.

   • EAP_HOME/standalone/configuration/
   • EAP_HOME/domain/configuration
2. Back up any custom modules created in the EAP_HOME/modules/system/layers/base/ directory.
3. Back up any welcome content in the EAP_HOME/welcome-content/ directory.
4. Back up any custom scripts created in the EAP_HOME/bin/ directory.

Procedure 2.14. jboss-descriptor-property-replacement

1. In the Management CLI, run the following command to determine the value of jboss-descriptor-property-replacement:

   /subsystem=ee:read-attribute(name="jboss-descriptor-property-replacement")

2. Run the following command to configure the behavior:

   /subsystem=ee:write-attribute(name="jboss-descriptor-property-replacement",value=VALUE)

Procedure 2.15. spec-descriptor-property-replacement

1. In the Management CLI, run the following command to confirm the value of spec-descriptor-property-replacement:

   /subsystem=ee:read-attribute(name="spec-descriptor-property-replacement")

2. Run the following command to configure the behavior:

   /subsystem=ee:write-attribute(name="spec-descriptor-property-replacement",value=VALUE)

Procedure 2.16. Take a Configuration Snapshot and Save It

• Save a snapshot

  Run the take-snapshot operation to capture a copy of the current server configuration.

  [standalone@localhost:9999 /] :take-snapshot
  {
      "outcome" => "success",
      "result" => "/home/User/EAP_HOME/standalone/configuration/standalone_xml_history/snapshot/20110630-172258657standalone.xml"
  

Procedure 2.17. Load a Configuration Snapshot

1. Identify the snapshot to be loaded. This example will recall the following file from the snapshot directory. The default path for the snapshot files is as follows.

   EAP_HOME/standalone/configuration/standalone_xml_history/snapshot/20110812-191301472standalone.xml

   The snapshots are expressed by their relative paths, by which the above example can be written as follows.

   jboss.server.config.dir/standalone_xml_history/snapshot/20110812-191301472standalone.xml

2. Start the server with the selected configuration snapshot by passing in the filename.

   EAP_HOME/bin/standalone.sh --server-config=standalone_xml_history/snapshot/20110913-164449522standalone.xml

Procedure 2.18. Delete a Specific Snapshot

1. Identify the snapshot to be deleted. This example will delete the following file from the snapshot directory.

   EAP_HOME/standalone/configuration/standalone_xml_history/snapshot/20110630-165714239standalone.xml

2. Run the :delete-snapshot command to delete a specific snapshot, specifying the name of the snapshot as in the example below.

   [standalone@localhost:9999 /] :delete-snapshot(name="20110630-165714239standalone.xml")
   {"outcome" => "success"}
   

Procedure 2.19. Delete All Snapshots

• Run the :delete-snapshot(name="all") command to delete all snapshots as in the example below.

  [standalone@localhost:9999 /] :delete-snapshot(name="all")
  {"outcome" => "success"}
  

Procedure 2.20. List All Configuration Snapshots

• List all snapshots

  List all of the saved snapshots by running the :list-snapshots command.

  [standalone@localhost:9999 /] :list-snapshots
  {
      "outcome" => "success",
      "result" => {
          "directory" => "/home/hostname/EAP_HOME/standalone/configuration/standalone_xml_history/snapshot",
          "names" => [
              "20110818-133719699standalone.xml",
              "20110809-141225039standalone.xml",
              "20110802-152010683standalone.xml",
              "20110808-161118457standalone.xml",
              "20110912-151949212standalone.xml",
              "20110804-162951670standalone.xml"
          ]
      }
  }
  

1. Launch your web browser and go to this address: http://localhost:9990/console/App.html

   Note

   Port 9990 is predefined as the Management Console socket binding.
2. Enter your username and password to log in to the Management Console.
   

   Figure 3.1. Log in screen for the Management Console

Procedure 3.1. Change the Language of the Web-based Management Console

1. Log into the Management Console.

   Log into the web-based Management Console.

2. Open the Settings dialog.

   Near the bottom right of the screen is a Settings label. Click it to open the settings for the Management Console.

3. Select the desired language.

   Select the desired language from the Locale selection box. Select Save. A confirmation box informs you that you need to reload the application. Click Confirm. The system refreshes your web browser automatically to use the new locale.

Procedure 3.2. Configure the Server

1. Select the Domain tab from the top of the console. Available server instances will be displayed in a table.
2. Click Server Configurations.
   The Server Configurations panel for the relevant host appears.
3. Select the server instance from the Available Server Configurations table.
4. Click Edit above the details of the chosen server.
5. Make changes to the configuration attributes.
6. Click Save to finish.

1. Select the Deployments tab at the top of the console.
2. Select Add on the Content Repository tab. A Create Deployment dialog box appears.
   

   Figure 3.7. Manage standalone deployments

3. In the dialog box, click Browse. Browse to the file you want to deploy, select it and upload it. Click Next to proceed.
   

   Figure 3.8. Deployment selection

4. Verify the deployment name and runtime name that appear in the Create Deployments dialog box. Click Save to upload the file once the names are verified.

Procedure 3.3. Create a New Server Configuration

1. Navigate to the Server Configurations page in the Management Console

   Select the Domain tab from the top of the console.
   

   Figure 3.9. Server Configuration

2. Click Server Configurations in the left menu.

3. Create a new configuration

   1. Select the Add button above the Available Server Configurations table.
   2. Enter the basic server settings in the Create Server Configuration dialog.
   3. Select the Save button to save the new Server Configuration.
   

   Figure 3.10. Create a new configuration

Procedure 3.4. Edit the Logging Levels

1. Navigate to the Logging panel in the Management Console

   1. If you are working with a managed domain, select the Configuration tab at the top of the console, then select the relevant profile from the drop-down list on the left of the console.
   2. For either a managed domain or a standalone server, expand the Core menu from the list on the left of the console and click the Logging entry.
   3. Click on the Log Categories tab in the top of the console.
   

   Figure 3.11. Logging panel

2. Edit logger details

   Edit the details for any of the entries in the Log Categories table.
   1. Select an entry in the Log Categories table, then click Edit in the Details section below.
   2. Set the log level for the category with the Log Level drop-down box. Click the Save button when done.

Procedure 3.5. Configure and Add a new Server Group

1. Navigate to the Server Groups view

   Select the Domain tab from the top of the console.
2. Select Server Groups in the left hand column.
   

   Figure 3.12. The Server Groups view

3. Add a server group

   Click the Add button to add a new server group.

4. Configure the server group

   1. Enter a name for the server group.
   2. Select the profile for the server group.
   3. Select the socket binding for the server group.
   4. Click the Save button to save your new group.
   

   Figure 3.13. The Create Server Group dialog

Procedure 3.6. View JBoss EAP 6 Logs in the Management Console

1. Select the Runtime tab from the top of the Management Console.
   1. If you are using a Managed Domain, use the Change Server button on the left menu to select the JBoss EAP 6 server that you want to view the logs of.
2. Expand the Platform menu on the left, and select Log Viewer.
3. Select a log file from the list, and click the View button.
   You can also click Download to download the log file to your local machine.

   Note

   The Management Console Log Viewer displays a confirmation if you attempt to open a log file that is larger than 15MB.

   The Management Console Log Viewer is not intended to be a text editor replacement for viewing very large log files (>100MB). Opening very large log files in the Management Console Log Viewer could crash your web browser, so you should always download large log files separately and open them in a text editor.
4. The selected log will open as a new tab within the Management Console. You can open multiple log files in other tabs by returning to the LOG FILES tab and repeating the previous step.

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>
   

Procedure 3.12. Display the Current Runtime Value of a Selected Attribute

• Run the read-attribute operation

  From the Management CLI, use the read-attribute operation to display the value of a resource attribute. For more details on operation requests, refer to the topic Section 3.4.8, “Use Operations and Commands in the Management CLI”.

  [standalone@localhost:9999 /]:read-attribute(name=name-of-attribute)

Procedure 3.13. Display the Active User in the Management CLI Using the whoami Operation

• Run the whoami operation

  From the Management CLI, use the whoami operation to display the active user account.

  [standalone@localhost:9999 /] :whoami

  The following example uses the whoami operation in a standalone server instance to show that the active user is username, and that the user is assigned to the ManagementRealm realm.

  Example 3.13. Use the whoami in a standalone instance

  [standalone@localhost:9999 /]:whoami
  {
      "outcome" => "success",
      "result" => {"identity" => {
          "username" => "username",
          "realm" => "ManagementRealm"
      }}
  }
  

Procedure 3.14. Display System and Server Information in the Management CLI

• Run the version command

  From the Management CLI, enter the version command:

  [domain@localhost:9999 /] version

Procedure 3.15. Execute the Command in Management CLI

• Run the read-operation-description operation

  From the Management CLI, use read-operation-description to display information about the operation. The operation requires additional parameters in the format of a key-value pair to indicate which operation to display. For more details on operation requests, refer to the topic Section 3.4.8, “Use Operations and Commands in the Management CLI”.

  [standalone@localhost:9999 /]:read-operation-description(name=name-of-operation)

Procedure 3.16. Execute the Command in Management CLI

• Run the read-operation-names operation

  From the Management CLI, use the read-operation-names operation to display the names of the available operations. For more details on operation requests, refer to the topic Section 3.4.8, “Use Operations and Commands in the Management CLI”.

  [standalone@localhost:9999 /]:read-operation-names

Procedure 3.17. Shut down the Application Server

• Run the shutdown operation

  • From the Management CLI, use the shutdown operation to shut the server down via the System.exit(0) system call. For more details on operation requests, refer to the topic Section 3.4.8, “Use Operations and Commands in the Management CLI”.
    • In the standalone mode, use the following command:

      [standalone@localhost:9999 /]shutdown

    • In the domain mode, use the following command with the appropriate host name:

      [domain@localhost:9999 /]shutdown --host=master

  • To connect to a detached CLI instance and shut down the server, execute the following command:

    jboss-cli.sh --connect command=shutdown
    

  • To connect to a remote CLI instance and shut down the server, execute the following command:

    [disconnected /] connect IP_ADDRESS
    [standalone@IP_ADDRESS:9999 /] shutdown
    

    Replace IP_ADDRESS with the IP address of your instance.

Procedure 3.18. Configure a Resource Attribute with the Management CLI

• Run the write-attribute operation

  From the Management CLI, use the write-attribute operation to modify the value of a resource attribute. The operation can be run at the child node of the resource or at the root node of the Management CLI where the full resource path is specified.

Procedure 3.19. Configure System Properties Using the Management CLI

1. Start the JBoss EAP server.
2. Launch the Management CLI using the command for your operating system.
   For Linux:

   EAP_HOME/bin/jboss-cli.sh --connect

   For Windows:

   EAP_HOME\bin\jboss-cli.bat --connect

3. Add a system property.
   The command you use depends on whether you are running a standalone server or a managed domain. If you are running a managed domain, you can add system properties to any or all of the servers running in that domain.
   • Add a system property on a standalone server using the following syntax:

     /system-property=PROPERTY_NAME:add(value=PROPERTY_VALUE)

     Example 3.22. Add a system property to a standalone server

     [standalone@localhost:9999 /] /system-property=property.mybean.queue:add(value=java:/queue/MyBeanQueue)
     {"outcome" => "success"}

   • Add a system property to all hosts and servers in a managed domain using the following syntax:

     /system-property=PROPERTY_NAME:add(value=PROPERTY_VALUE)

     Example 3.23. Add a system property to all servers in a managed domain

     [domain@localhost:9999 /] /system-property=property.mybean.queue:add(value=java:/queue/MyBeanQueue)
     {
         "outcome" => "success",
         "result" => undefined,
         "server-groups" => {"main-server-group" => {"host" => {"master" => {
             "server-one" => {"response" => {"outcome" => "success"}},
             "server-two" => {"response" => {"outcome" => "success"}}
         }}}}
     }

   • Add a system property to a host and its server instances in a managed domain using the following syntax:

     /host=master/system-property=PROPERTY_NAME:add(value=PROPERTY_VALUE)

     Example 3.24. Add a system property to a host and its servers in a domain

     [domain@localhost:9999 /] /host=master/system-property=property.mybean.queue:add(value=java:/queue/MyBeanQueue)
     {
         "outcome" => "success",
         "result" => undefined,
         "server-groups" => {"main-server-group" => {"host" => {"master" => {
             "server-one" => {"response" => {"outcome" => "success"}},
             "server-two" => {"response" => {"outcome" => "success"}}
         }}}}
     }

   • Add a system property to a server instance in a managed domain using the following syntax:

     /host=master/server-config=server-one/system-property=PROPERTY_NAME:add(value=PROPERTY_VALUE)

     Example 3.25. Add a system property to a server instance in a managed domain

     [domain@localhost:9999 /] /host=master/server-config=server-one/system-property=property.mybean.queue:add(value=java:/queue/MyBeanQueue)
     {
         "outcome" => "success",
         "result" => undefined,
         "server-groups" => {"main-server-group" => {"host" => {"master" => {"server-one" => {"response" => {"outcome" => "success"}}}}}}
     }
     

4. Read a system property.
   The command you use depends on whether you are running a standalone server or a managed domain.
   • Read a system property from a standalone server using the following syntax:

     /system-property=PROPERTY_NAME:read-resource

     Example 3.26. Read a system property from a standalone server

     [standalone@localhost:9999 /] /system-property=property.mybean.queue:read-resource
     {
         "outcome" => "success",
         "result" => {"value" => "java:/queue/MyBeanQueue"}
     }
     

   • Read a system property from all hosts and servers in a managed domain using the following syntax:

     /system-property=PROPERTY_NAME:read-resource

     Example 3.27. Read a system property from all servers in a managed domain

     [domain@localhost:9999 /] /system-property=property.mybean.queue:read-resource
     {
         "outcome" => "success",
         "result" => {
             "boot-time" => true,
             "value" => "java:/queue/MyBeanQueue"
         }
     }

   • Read a system property from a host and its server instances in a managed domain using the following syntax:

     /host=master/system-property=PROPERTY_NAME:read-resource

     Example 3.28. Read a system property from a host and its servers in a domain

     [domain@localhost:9999 /] /host=master/system-property=property.mybean.queue:read-resource
     {
         "outcome" => "success",
         "result" => {
             "boot-time" => true,
             "value" => "java:/queue/MyBeanQueue"
         }
     }
     

   • Read a system property from a server instance in a managed domain using the following syntax:

     /host=master/server-config=server-one/system-property=PROPERTY_NAME:read-resource

     Example 3.29. Read a system property from a server instance in a managed domain

     [domain@localhost:9999 /] /host=master/server-config=server-one/system-property=property.mybean.queue:read-resource
     {
         "outcome" => "success",
         "result" => {
             "boot-time" => true,
             "value" => "java:/queue/MyBeanQueue"
         }
     }

5. Remove a system property.
   The command you use depends on whether you are running a standalone server or a managed domain.
   • Remove a system property from a standalone server using the following syntax:

     /system-property=PROPERTY_NAME:remove

     Example 3.30. Remove a system property from a standalone server

     [standalone@localhost:9999 /] /system-property=property.mybean.queue:remove
     {"outcome" => "success"}

   • Remove a system property from all hosts and servers in a managed domain using the following syntax:

     /system-property=PROPERTY_NAME:remove

     Example 3.31. Remove a system property from all hosts and servers in a domain

     [domain@localhost:9999 /] /system-property=property.mybean.queue:remove
     {
         "outcome" => "success",
         "result" => undefined,
         "server-groups" => {"main-server-group" => {"host" => {"master" => {
             "server-one" => {"response" => {"outcome" => "success"}},
             "server-two" => {"response" => {"outcome" => "success"}}
         }}}}
     }
     

   • Remove a system property from a host and its server instances in a managed domain using the following syntax:

     /host=master/system-property=PROPERTY_NAME:remove

     Example 3.32. Remove a system property from a host and its instances in a domain

     [domain@localhost:9999 /] /host=master/system-property=property.mybean.queue:remove
     {
         "outcome" => "success",
         "result" => undefined,
         "server-groups" => {"main-server-group" => {"host" => {"master" => {
             "server-one" => {"response" => {"outcome" => "success"}},
             "server-two" => {"response" => {"outcome" => "success"}}
         }}}}
     }
     

   • Remove a system property from a server instance in a managed domain using the following syntax:

     /host=master/server-config=server-one/system-property=PROPERTY_NAME:remove

     Example 3.33. Remove a system property from a server in a managed domain

     [domain@localhost:9999 /] /host=master/server-config=server-one/system-property=property.mybean.queue:remove
     {
         "outcome" => "success",
         "result" => undefined,
         "server-groups" => {"main-server-group" => {"host" => {"master" => {"server-one" => {"response" => {"outcome" => "success"}}}}}}
     }
     

Procedure 3.20. View the Management CLI Command History

• Run the history command

  From the Management CLI, enter the history command:

  [standalone@localhost:9999 /] history

Procedure 3.21. Clear the Management CLI Command History

• Run the history --clear command

  From the Management CLI, enter the history --clear command:

  [standalone@localhost:9999 /] history --clear

Procedure 3.22. Disable the Management CLI Command History

• Run the history --disable command

  From the Management CLI, enter the history --disable command:

  [standalone@localhost:9999 /] history --disable

Procedure 3.23. Enable the Management CLI Command History

• Run the history --enable command

  From the Management CLI, enter the history --enable command:

  [standalone@localhost:9999 /] history --enable

Procedure 3.24. Enable Audit Logging to a Syslog Server

1. Enable Audit Logging

   Execute the following command:

   [.. /]/core-service=management/access=audit/logger=audit-log:write-attribute(name=enabled,value=true)

2. Create a syslog Handler

   In this example the syslog server is running on the same server as the JBoss EAP instance, on port 514. Replace the values of the host attribute with values appropriate to your environment.

   Example 3.34. Example syslog handler

   [.. /]batch
   [.. / #]/core-service=management/access=audit/syslog-handler=mysyslog:add(formatter=json-formatter)
   [.. / #]/core-service=management/access=audit/syslog-handler=mysyslog/protocol=udp:add(host=localhost,port=514)
   [.. /]run-batch

3. Add a Reference to the syslog Handler

   Execute the following:

   [.. /]/core-service=management/access=audit/logger=audit-log/handler=mysyslog:add

Procedure 4.1. Create the Initial Administrative User for the Remote Management Interfaces

1. Run the add-user.sh or add-user.bat script.

   Change to the EAP_HOME/bin/ directory. Invoke the appropriate script for your operating system.

   Red Hat Enterprise Linux

   [user@host bin]$ ./add-user.sh

   Microsoft Windows Server

   C:\bin>  add-user.bat

2. Choose to add a Management user.

   Press ENTER to select the default option a to add a Management user.
   This user is added to the ManagementRealm and is authorized to perform management operations using the web-based Management Console or command-line based Management CLI. The other choice, b, adds a user to the ApplicationRealm, and provides no particular permissions. That realm is provided for use with applications.

3. Enter the desired username and password.

   When prompted, enter the username and password. You will be prompted to confirm the password.

4. Enter group information.

   Add the group or groups to which the user belongs. If the user belongs to multiple groups, enter a comma-separated list. Leave it blank if you do not want the user to belong to any groups.

5. Review the information and confirm.

   You are prompted to confirm the information. If you are satisfied, type yes.

6. Choose whether the user represents a remote JBoss EAP 6 server instance.

   Besides administrators, the other type of user which occasionally needs to be added to JBoss EAP 6 in the ManagementRealm is a user representing another instance of JBoss EAP 6, which must be able to authenticate to join a cluster as a member. The next prompt allows you to designate your added user for this purpose. If you select yes, you will be given a hashed secret value, representing the user's password, which would need to be added to a different configuration file. For the purposes of this task, answer no to this question.

7. Enter additional users.

   You can enter additional users if desired, by repeating the procedure. You can also add them at any time on a running system. Instead of choosing the default security realm, you can add users to other realms to fine-tune their authorizations.

8. Create users non-interactively.

   You can create users non-interactively, by passing in each parameter at the command line. This approach is not recommended on shared systems, because the passwords will be visible in log and history files. The syntax for the command, using the management realm, is:

   [user@host bin]$ ./add-user.sh username password

   To use the application realm, use the -a parameter.

   [user@host bin]$ ./add-user.sh -a username password

9. You can suppress the normal output of the add-user script by passing the --silent parameter. This applies only if the minimum parameters username and password have been specified. Error messages will still be shown.

• Configure Interface Attributes

  • Configure Interface Attributes with the Management CLI

    You can use tab completion to complete the command string as you type, as well as to expose the available attributes.
    Use the Management CLI to add a new server and configure instances to it, effectively adding the same piece of configuration to the XML. Substitute server-name with your actual server name and substitute ip-address with your actual IP address.

    /host=master/server-config=server-name:add(group=main-server-group)
    /host=master/server-config=server-name/interface=public:add(inet-address=ip-address)

    Use the Management CLI to add new interfaces and write new values to the interface attributes.

    1. Add a New Interface

       The add operation creates new interfaces as required. The add command runs from the root of the Management CLI session, and in the following example it creates a new interface name title interfacename, with an inet-address declared as 12.0.0.2.

       /interface=interfacename/:add(inet-address=12.0.0.2)

    2. Edit Interface Attributes

       The write-attribute operation writes new values to an attribute. The following example updates the inet-address value to 12.0.0.8.

       /interface=interfacename/:write-attribute(name=inet-address, value=12.0.0.8)

    3. Verify Interface Attributes

       Confirm that the attribute values have changed by running the read-resource operation with the include-runtime=true parameter to expose all current values active in the server model. For example:

       [standalone@localhost:9999 interface=public] :read-resource(include-runtime=true)

  • Configure Interface Attributes with the Management Console

    1. Log into the Management Console.

       Log into the Management Console of your Managed Domain or Standalone Server instance.

    2. Navigate to Configuration tab

       Select the Configuration tab from the top of the screen.

       Note

       For Domain Mode, select a profile from the Profile drop-down menu at the top left of the screen.

    3. Select Interfaces from the Navigation Menu.

       Select the Interfaces menu item from the navigation menu.

    4. Add a New Interface

       1. Click Add.
       2. Enter required values for Name, Inet Address and Address Wildcard.
       3. Click Save.

    5. Edit Interface Attributes

       1. Select the interface that you need to edit from the Available Interfaces list and click Edit.
       2. Enter required values for Name, Inet Address and Address Wildcard.
       3. Click Save.

• Configure Socket Bindings in Socket Binding Groups

  Choose either the Management CLI or the management console to configure your socket bindings as required.

  • Configure Socket Bindings Using the Management CLI

    Use the Management CLI to configure socket bindings.

    1. Add a New Socket Binding

       Use the add operation to create a new address setting if required. You can run this command from the root of the Management CLI session, which in the following examples creates a new socket binding titled newsocket, with a port attribute declared as 1234. The examples apply for both a standalone server and a managed domain editing on the standard-sockets socket binding group as shown.

       [domain@localhost:9999 /] /socket-binding-group=standard-sockets/socket-binding=newsocket/:add(port=1234)

    2. Edit Pattern Attributes

       Use the write-attribute operation to write a new value to an attribute. You can use tab completion to help complete the command string as you type, as well as to expose the available attributes. The following example updates the port value to 2020

       [domain@localhost:9999 /] /socket-binding-group=standard-sockets/socket-binding=newsocket/:write-attribute(name=port,value=2020)

    3. Confirm Pattern Attributes

       Confirm the values are changed by running the read-resource operation with the include-runtime=true parameter to expose all current values active in the server model.

       [domain@localhost:9999 /] /socket-binding-group=standard-sockets/socket-binding=newsocket/:read-resource

  • Configure Socket Bindings Using the Management Console

    Use the management console to configure socket bindings.

    1. Log into the Management Console.

       Log into the management console of your managed domain or standalone server.

    2. Navigate to the Configuration tab.

       Select the Configuration tab at the top of the screen.

    3. Select the Socket Binding item from the navigation menu.

       Expand the General Configuration menu. Select Socket Binding. If you are using a managed domain, select the desired group in the Socket Binding Groups list.

    4. Add a New Socket Binding

       1. Click the Add button.
       2. Enter any required values for Name, Port and Binding Group.
       3. Click Save to finish.

    5. Edit Socket Binding

       1. Select a socket binding from the list and click Edit.
       2. Enter any required values such as Name, Interface or Port.
       3. Click Save to finish.

• Configure Port Offsets

  Choose either the Management CLI or the Management Console to configure your port offsets.

  • Configure Port Offsets Using the Management CLI

    Use the Management CLI to configure port offsets.

    1. Edit Port Offsets

       Use the write-attribute operation to write a new value to the port offset atttribute. The following example updates the socket-binding-port-offset value of server-two to 250. This server is a member of the default local host group. A restart is required for the changes to take effect.

       [domain@localhost:9999 /] /host=master/server-config=server-two/:write-attribute(name=socket-binding-port-offset,value=250)

    2. Confirm Port Offset Attributes

       Confirm the values are changed by running the read-resource operation with the include-runtime=true parameter to expose all current values active in the server model.

       [domain@localhost:9999 /] /host=master/server-config=server-two/:read-resource(include-runtime=true)

  • Configure Port Offsets Using the Management Console

    Use the Management Console to configure port offsets.

    1. Log into the Management Console.

       Log into the Management Console of your Managed Domain.

    2. Select the Domain tab

       Select the Domain tab at the top of the screen.

    3. Edit Port Offset Attributes

       1. Select the server under the Available Server Configurations list and click Edit at the top of the attibutes list below.
       2. Enter any desired values in the Port Offset field.
       3. Click Save to finish.

Procedure 5.1. Disable the IPv4 Stack Java Property

1. Open the relevant file for the installation:

   • For a Standalone Server:

     Open EAP_HOME/bin/standalone.conf.

   • For a Managed Domain:

     Open EAP_HOME/bin/domain.conf.
2. Change the IPv4 Stack Java property to false:

   -Djava.net.preferIPv4Stack=false

   For example:

   Example 5.8. JVM options

   # Specify options to pass to the Java VM.
   #
   if [ "x$JAVA_OPTS" = "x" ]; then
      JAVA_OPTS="-Xms64m -Xmx512m -XX:MaxPermSize=256m -Djava.net.preferIPv4Stack=false 
      -Dorg.jboss.resolver.warning=true -Dsun.rmi.dgc.client.gcInterval=3600000 
      -Dsun.rmi.dgc.server.gcInterval=3600000 -Djava.net.preferIPv6Addresses=true"
   fi
   

Procedure 5.2. Configure the Interface for IPv6 Networking

1. Select the Configuration tab at the top of the screen.
2. Expand the General Configuration menu and select Interfaces.
3. Select the interface from the Available Interfaces list.
4. Click Edit in the detail list.
5. Set the inet address to:

   ${jboss.bind.address.management:[ADDRESS]}

6. Click Save to finish.
7. Restart the server to implement the changes.

Procedure 5.3. Configure the JBoss EAP 6 Installation to Prefer IPv6 Addresses

1. Open the relevant file for the installation:

   • For a Standalone Server:

     Open EAP_HOME/bin/standalone.conf.

   • For a Managed Domain:

     Open EAP_HOME/bin/domain.conf.
2. Append the following Java property to the Java VM options:

   -Djava.net.preferIPv6Addresses=true

   For example:

   Example 5.9. JVM options

   # Specify options to pass to the Java VM.
   #
   if [ "x$JAVA_OPTS" = "x" ]; then
      JAVA_OPTS="-Xms64m -Xmx512m -XX:MaxPermSize=256m -Djava.net.preferIPv4Stack=false 
      -Dorg.jboss.resolver.warning=true -Dsun.rmi.dgc.client.gcInterval=3600000 
      -Dsun.rmi.dgc.server.gcInterval=3600000 -Djava.net.preferIPv6Addresses=true"
   fi
   

Procedure 6.1. Test datasource pools connection using Management Console

1. Section 3.3.2, “Log in to the Management Console”.
2. Select the Runtime tab from the top of the Management Console.
3. Expand the Subsystems menu on the left, and select Datasources.
4. Click the Test Connection button to test the connection to the datasource and verify the settings are correct.

Procedure 6.2. Test datasource connection using Management CLI

1. Launch the CLI tool and connect to your server.
2. Run the following Management CLI command to test the connection:
   • In Standalone mode, enter the following command:

     /subsystem=datasources/data-source=ExampleDS:test-connection-in-pool
     

   • In Domain mode, enter the following command:

     host=master/server=server-one/subsystem=datasources/data-source=ExampleDS:test-connection-in-pool

Procedure 6.3. Modify the JDBC Driver JAR

1. Change to, or create, an empty temporary directory.
2. Create a META-INF subdirectory.
3. Create a META-INF/services subdirectory.
4. Create a META-INF/services/java.sql.Driver file, which contains one line indicating the fully-qualified class name of the JDBC driver.
5. Use the JAR command-line tool to update the JAR like this:

   jar \-uf jdbc-driver.jar META-INF/services/java.sql.Driver

6. Section 3.3.2, “Log in to the Management Console”
7. If you use a managed domain, deploy the JAR file to a server group. Otherwise, deploy it to your server. See Section 10.2.2, “Enable a Deployed Application Using the Management Console”.

Procedure 6.4. Install a JDBC Driver as a Core Module Using the Management CLI

1. Start the Server.
2. Start the Management CLI, but do not use the --connect or -c argument to connect to the running instance.
3. Use the module add CLI command to add the new module.

   Example 6.1. Example CLI command to add a MySQL JDBC driver module

   module add --name=com.mysql --resources=/path/to/mysql.jar --dependencies=javax.api,javax.transaction.api

   Note

   Using the module management CLI command to add and remove modules is provided as technology preview only, and should not be used to add modules to a remote JBoss EAP instance. Modules should be added and removed manually in a production environment.

   Perform the following steps to add a module manually.

   1. A file path structure will be created under the EAP_HOME/modules/ directory. For example, for a MySQL JDBC driver, the following will be created: EAP_HOME/modules/com/mysql/main/.
   2. The JAR files specified as resources will be copied to the main/ subdirectory.
   3. A module.xml file with the specified dependencies will be created in the main/ subdirectory. See Section 7.1.1, “Modules” for an example of a module.xml file.

   Execute module --help for more details on using this command to add and remove modules.
4. Use the connect CLI command to connect to the running instance.
5. Run the CLI command to add the JDBC driver module to the server configuration.
   The command you choose depends on the number of classes listed in the /META-INF/services/java.sql.Driver file located in the JDBC driver JAR. For example, the /META-INF/services/java.sql.Driver file in the MySQL 5.1.20 JDBC JAR lists two classes:

   • com.mysql.jdbc.Driver
   • com.mysql.fabric.jdbc.FabricMySQLDriver

   When there is more than one entry, you must also specify the name of the driver class. Failure to do so results in an error similar to the following:

   Example 6.2. Driver class error

   JBAS014749: Operation handler failed: Service jboss.jdbc-driver.mysql is already registered

   • Run the CLI command for JDBC JARs containing one class entry.

     /subsystem=datasources/jdbc-driver=DRIVER_NAME:add(driver-name=DRIVER_NAME,driver-module-name=MODULE_NAME,driver-xa-datasource-class-name=XA_DATASOURCE_CLASS_NAME)

     Example 6.3. CLI Command for Standalone Mode for JDBC JARs with one driver class

     /subsystem=datasources/jdbc-driver=mysql:add(driver-name=mysql,driver-module-name=com.mysql,driver-xa-datasource-class-name=com.mysql.jdbc.jdbc2.optional.MysqlXADataSource)

     Example 6.4. CLI Command for Domain Mode for JDBC JARs with one driver class

     /profile=ha/subsystem=datasources/jdbc-driver=mysql:add(driver-name=mysql,driver-module-name=com.mysql,driver-xa-datasource-class-name=com.mysql.jdbc.jdbc2.optional.MysqlXADataSource)

   • Run the CLI command for JDBC JARs containing multiple class entries.

     /subsystem=datasources/jdbc-driver=DRIVER_NAME:add(driver-name=DRIVER_NAME,driver-module-name=MODULE_NAME,driver-xa-datasource-class-name=XA_DATASOURCE_CLASS_NAME, driver-class-name=DRIVER_CLASS_NAME)

     Example 6.5. CLI Command for Standalone Mode for JDBC JARs with multiple driver class entries

     /subsystem=datasources/jdbc-driver=mysql:add(driver-name=mysql,driver-module-name=com.mysql,driver-xa-datasource-class-name=com.mysql.jdbc.jdbc2.optional.MysqlXADataSource, driver-class-name=com.mysql.jdbc.Driver)

     Example 6.6. CLI Command for Domain Mode for JDBC JARs with multiple driver class entries

     /profile=ha/subsystem=datasources/jdbc-driver=mysql:add(driver-name=mysql,driver-module-name=com.mysql,driver-xa-datasource-class-name=com.mysql.jdbc.jdbc2.optional.MysqlXADataSource, driver-class-name=com.mysql.jdbc.Driver)

     Example 6.7. CLI Command for Domain Mode for JDBC JARs with multiple non-XA driver class entries

     /profile=ha/subsystem=datasources/jdbc-driver=oracle/:add(driver-module-name=com.oracle,driver-name=oracle,jdbc-compliant=true,driver-datasource-class-name=oracle.jdbc.OracleDriver)

Procedure 6.5. Add a Dependency to the Application

• • Configure the MANIFEST.MF file

    1. Open the application's META-INF/MANIFEST.MF file in a text editor.
    2. Add a dependency for the JDBC module and save the file.

       Dependencies: MODULE_NAME

       Example 6.8. MANIFEST.MF file with com.mysql declared as a dependency

       Dependencies: com.mysql

  • 1. Create a jboss-deployment-structure.xml file

       Create a file called jboss-deployment-structure.xml in the META-INF/ or WEB-INF folder of the application.

       Example 6.9. jboss-deployment-structure.xml file with com.mysql declared as a dependency

       <jboss-deployment-structure>
         <deployment>
           <dependencies>
             <module name="com.mysql" />
           </dependencies>
         </deployment>
       </jboss-deployment-structure>

Procedure 6.6. Create a Datasource using either the Management CLI or the Management Console

• • Management CLI

    1. Launch the CLI tool and connect to your server.
    2. Run the following Management CLI command to create a non-XA datasource, configuring the variables as appropriate:

       Note

       The value for DRIVER_NAME depends on the number of classes listed in the /META-INF/services/java.sql.Driver file located in the JDBC driver JAR. If there is only one class, the value is the name of the JAR. If there are multiple classes, the value is the name of the JAR + driverClassName + "_" + majorVersion +"_" + minorVersion. Failure to do so will result in the following error being logged:

       JBAS014775:    New missing/unsatisfied dependencies

       For example, the DRIVER_NAME value required for the MySQL 5.1.31 driver, is mysql-connector-java-5.1.31-bin.jarcom.mysql.jdbc.Driver_5_1.

       data-source add --name=DATASOURCE_NAME --jndi-name=JNDI_NAME --driver-name=DRIVER_NAME  --connection-url=CONNECTION_URL

    3. Enable the datasource:

       data-source enable --name=DATASOURCE_NAME

  • Management Console

    1. Login to the Management Console.

    2. Navigate to the Datasources panel in the Management Console

       1. Select the Configuration tab from the top of the console.
       2. For Domain mode only, select a profile from the drop-down box in the top left.
       3. Expand the Subsystems menu on the left of the console, then expand the Connector menu.
       4. Select Datasources from the menu on the left of the console.

    3. Create a new datasource

       1. Click Add at the top of the Datasources panel.
       2. Enter the new datasource attributes in the Create Datasource wizard and proceed with the Next button.
       3. Enter the JDBC driver details in the Create Datasource wizard and click Next to continue.
       4. Enter the connection settings in the Create Datasource wizard.
       5. Click the Test Connection button to test the connection to the datasource and verify the settings are correct.
       6. Click Done to finish

Procedure 6.7. Modify a Non-XA Datasource

• • Management CLI

    1. Section 3.4.2, “Launch the Management CLI”.
    2. Use the write-attribute command to configure a datasource attribute:

       /subsystem=datasources/data-source=DATASOURCE_NAME:write-attribute(name=ATTRIBUTE_NAME,value=ATTRIBUTE_VALUE)

    3. Reload the server to confirm the changes:

       reload

  • Management Console

    1. Section 3.3.2, “Log in to the Management Console”.

    2. Navigate to the Datasources panel in the Management Console

       1. Select the Configuration tab from the top of the console.
       2. For Domain mode only, select a profile from the drop-down box in the top left.
       3. Expand the Subsystems menu on the left of the console, then expand the Connector menu.
       4. Select Datasources from expanded menu.

    3. Edit the datasource

       1. Select a datasource from the Available Datasources list. The datasource attributes are displayed below.
       2. Click Edit to edit the datasource attributes.
       3. Click Save to finish.

Procedure 6.8. Remove a Non-XA Datasource

• • Management CLI

    1. Section 3.4.2, “Launch the Management CLI”.
    2. Run the following command to remove a non-XA datasource:

       data-source remove --name=DATASOURCE_NAME

  • Management Console

    1. Section 3.3.2, “Log in to the Management Console”.

    2. Navigate to the Datasources panel in the Management Console

       1. Select the Configuration tab from the top of the console.
       2. For Domain mode only, select a profile from the drop-down box in the top left.
       3. Expand the Subsystems menu on the left of the console, then expand the Connector menu.
       4. Select Datasources.
    3. Select the datasource to be deleted, then click Remove.

Procedure 6.9. Create an XA Datasource, Using Either the Management CLI or the Management Console

• • Management CLI

    1. Section 3.4.2, “Launch the Management CLI”.
    2. Run the following Management CLI command to create an XA datasource, configuring the variables as appropriate:

       Note

       The value for DRIVER_NAME depends on the number of classes listed in the /META-INF/services/java.sql.Driver file located in the JDBC driver JAR. If there is only one class, the value is the name of the JAR. If there are multiple classes, the value is the name of the JAR + driverClassName + "_" + majorVersion +"_" + minorVersion. Failure to do so will result in the following error being logged:

       JBAS014775:    New missing/unsatisfied dependencies

       For example, the DRIVER_NAME value required for the MySQL 5.1.31 driver, is mysql-connector-java-5.1.31-bin.jarcom.mysql.jdbc.Driver_5_1.

       xa-data-source add --name=XA_DATASOURCE_NAME --jndi-name=JNDI_NAME --driver-name=DRIVER_NAME --xa-datasource-class=XA_DATASOURCE_CLASS

    3. Configure the XA datasource properties

       1. Set the server name

          Run the following command to configure the server name for the host:

          /subsystem=datasources/xa-data-source=XA_DATASOURCE_NAME/xa-datasource-properties=ServerName:add(value=HOSTNAME)

       2. Set the database name

          Run the following command to configure the database name:

          /subsystem=datasources/xa-data-source=XA_DATASOURCE_NAME/xa-datasource-properties=DatabaseName:add(value=DATABASE_NAME)

    4. Enable the datasource:

       xa-data-source enable --name=XA_DATASOURCE_NAME

  • Management Console

    1. Section 3.3.2, “Log in to the Management Console”.

    2. Navigate to the Datasources panel in the Management Console

       1. Select the Configuration tab from the top of the console.
       2. For Domain mode only, select a profile from the drop-down box at the top left.
       3. Expand the Subsystems menu on the left of the console, then expand the Connector menu.
       4. Select Datasources.
    3. Select the XA Datasource tab.

    4. Create a new XA datasource

       1. Click Add.
       2. Enter the new XA datasource attributes in the Create XA Datasource wizard and click Next.
       3. Enter the JDBC driver details in the Create XA Datasource wizard and click Next.
       4. Enter the XA properties and click Next.
       5. Enter the connection settings in the Create XA Datasource wizard.
       6. Click the Test Connection button to test the connection to the XA datasource and verify the settings are correct.
       7. Click Done to finish

Procedure 6.10. Modify an XA Datasource, Using Either the Management CLI or the Management Console

• • Management CLI

    1. Section 3.4.2, “Launch the Management CLI”.

    2. Configure XA datasource attributes

       Use the write-attribute command to configure a datasource attribute:

       /subsystem=datasources/xa-data-source=XA_DATASOURCE_NAME:write-attribute(name=ATTRIBUTE_NAME,value=ATTRIBUTE_VALUE)

    3. Configure XA datasource properties

       Run the following command to configure an XA datasource subresource:

       /subsystem=datasources/xa-data-source=DATASOURCE_NAME/xa-datasource-properties=PROPERTY_NAME:add(value=PROPERTY_VALUE)

    4. Reload the server to confirm the changes:

       reload

  • Management Console

    1. Section 3.3.2, “Log in to the Management Console”.

    2. Navigate to the Datasources panel in the Management Console

       1. Select the Configuration tab from the top of the console.
       2. For Domain Mode only, select a profile from the drop-down box at top left.
       3. Expand the Subsystems menu on the left of the console, then expand the Connector menu.
       4. Select Datasources.
    3. Select the XA Datasource tab.

    4. Edit the datasource

       1. Select the relevant XA datasource from the Available XA Datasources list. The XA datasource attributes are displayed in the Attributes panel below it.
       2. Select the Edit button to edit the datasource attributes.
       3. Edit the XA datasource attributes and select the Save button when done.

Procedure 6.11. Remove an XA Datasource Using Either the Management CLI or the Management Console

• • Management CLI

    1. Section 3.4.2, “Launch the Management CLI”.
    2. Run the following command to remove an XA datasource:

       xa-data-source remove --name=XA_DATASOURCE_NAME

  • Management Console

    1. Section 3.3.2, “Log in to the Management Console”.

    2. Navigate to the Datasources panel in the Management Console

       1. Select the Configuration tab from the top of the console.
       2. For Domain mode only, select a profile from the drop-down box in the top left.
       3. Expand the Subsystems menu on the left of the console, then expand the Connector menu.
       4. Select Datasources.
    3. Select the XA Datasource tab.
    4. Select the registered XA datasource to be deleted, and click Remove to permanently delete the XA datasource.