Example configurations
Chapter 3. Management Interfaces
3.1. About the Management Console and Management CLI
In JBoss Enterprise Application Platform 6, all server instances and configurations are managed through management interfaces rather than by editing XML files. While the configuration XML files are still available for editing, administration through the management interfaces provides extra validation and advanced features for the persistent management of server instances. Changes made to the XML configuration files while the server instance is running will be overwritten by the server model, and any XML comments added will be removed as well. Only the management interfaces should be used for modifying the configuration files while a server instance is running.
To manage servers through a graphical user-interface in a web browser, use the Management Console.
To manage servers through a command line interface, use the Management CLI.
Report a bug
3.2. The Management Console
3.2.1. Management Console
The Management Console is a web-based administration tool for JBoss Enterprise Application Platform 6.
Use the Management Console to start and stop servers, deploy and undeploy applications, tune system settings, and make persistent modifications to the server configuration. The Management Console also has the ability to perform administrative tasks, with live notifications when any changes require the server instance to be restarted or reloaded.
In a Managed Domain, server instances and server groups in the same domain can be centrally managed from the Management Console of the domain controller.
Report a bug
3.2.2. Log in to the Management Console
Prerequisites
JBoss Enterprise Application Platform 6 must be running.
Procedure 3.1. Task
1. Navigate to the Management Console start page
Navigate to the Management Console in your web browser. The default location is
http://localhost:9990/console/, where port 9990 is predefined as the Management Console socket binding.
2. Log in to the Management Console
Enter the username and password of the account that you created previously to log into the Management Console login screen.
Figure 3.1. Log in screen for the Management Console
Result
Once logged in, one of the Management Console landing pages appears:
Managed domain
http://localhost:9990/console/App.html#server-instances
Standalone server
http://localhost:9990/console/App.html#server-overview
Report a bug
3.2.3. Change the Language of the Management Console
The language settings of web-based Management Console use English by default. You can choose to use one of the following languages instead.
Supported Languages German (de)
Simplified Chinese (zh-Hans) Brazilian Portuguese (pt-BR) French (fr)
Spanish (es) Japanese (ja)
Procedure 3.2. Task
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. Refresh your web browser to use the new locale.
Report a bug
3.2.4 . Configure a Server Using the Management Console
Prerequisites
Section 2.6.3, “Start JBoss Enterprise Application Platform 6 as a Managed Domain”
Section 3.2.2, “Log in to the Management Console”
Procedure 3.3. Task
1. Navigate to the server's Server Configuration panel in the Management Console a. Select the Server tab from the top-right of the console.
b. Expand the Server Configurations menu item on the left of the console and select the relevant server from the list.
Figure 3.2. Server configuration 2. Edit the server configuration
a. Select the Edit button beneath the server list.
b. Make changes to the configuration attributes.
c. Select the Save button beneath the server list.
Result
The server configuration is changed, and will take effect next time the server restarts.
Report a bug
3.2.5. Add a Deployment in the Management Console
Prerequisites
Section 3.2.2, “Log in to the Management Console”
Procedure 3.4 . Task
1. Navigate to the Manage Deployments panel in the Management Console a. Select the Runtime tab from the top right of the console.
b. For either a managed domain or a standalone server, select the Deployments → Manage Deployments option from the menu on the left of the console.
The Manage Deployments panel appears.
Figure 3.3. Manage domain deployments 2. Add deployment content
Select the Add Content button in the top right of the Deployments panel. An Upload dialog box appears.
3. Choose a file to deploy
In the dialog box, select the Choose File button. Browse to the file you want to deploy and select it for upload. Select the Next button to proceed once a file has been selected.
Figure 3.4 . Deployment selection 4. Verify deployment names
Verify the deployment name and runtime name that appear in the Upload dialog box. Select the Save button to upload the file once the names are verified.
Figure 3.5. Verify deployment names
Result
The selected content is uploaded to the server and is now ready for deployment.
Figure 3.6. Uploaded deployment in a managed domain
Figure 3.7. Uploaded deployment on a standalone server instance
Report a bug
3.2.6. Create a New Server in the Management Console
Prerequisites
Section 2.6.3, “Start JBoss Enterprise Application Platform 6 as a Managed Domain”
Section 3.2.2, “Log in to the Management Console”
Procedure 3.5. Task
1. Navigate to the Server Configurations page in the Management Console Select the Server tab from the top-right of the console.
2. Create a new configuration
a. Select the Add button at the top of the Server Configuration panel.
b. Edit the basic server settings in the Create Server Configuration dialog.
c. Select the Save button to save the new server configuration.
Result
The new server is created and listed in the Server Configurations list.
Report a bug
3.2.7. Change the Default Log Levels Using the Management Console
Procedure 3.6. Task
1. Navigate to the Logging panel in the Management Console
a. If you are working with a managed domain, select the Profiles tab from the top-right of the console, then select the relevant profile from the drop-down list on the left of the console.
b. For either a managed domain or a standalone server, select the Core → Logging option from the menu on the left of the console.
c. Click on the Log Categories tab in the top of the console.
Figure 3.8. Logging panel 2. Edit logger details
Edit the details for any of the entries in the Log Categories table.
a. Select an entry in the Log Categories table, then select the Edit button in the Details section below.
b. Set the log level for the category with the Log Level drop-down box. Select the Save button when done.
Result
The log levels for the relevant categories are now updated.
Report a bug
3.2.8. Create a New Server Group in the Management Console
Prerequisites
Section 3.2.2, “Log in to the Management Console”
Procedure 3.7. Task
1. Navigate to the Server Groups view Select the Profiles tab in the top-right corner.
2. Select the Group Configurations tab under the Server Groups menu in the left hand column.
Figure 3.9. The Server Groups view
3. Add a server group
Click the Add button to add a new server group.
4. Configure the server group
a. Enter a name for the server group.
b. Select the profile you want to add the server group to.
c. Select the socket binding you want to add the server group to.
d. Select the Save button to save your new group.
Figure 3.10. The Create Server Group dialog
Result
The new server group is visible in the Management Console.
Report a bug
3.3. The Management CLI
3.3.1. About the Management Command Line Interface (CLI)
The Management Command Line Interface (CLI) is a command line administration tool for JBoss Enterprise Application Platform 6.
Use the Management CLI to start and stop servers, deploy and undeploy applications, configure system settings, and perform other administrative tasks. Operations can be performed in batch modes, allowing multiple tasks to be run as a group.
Report a bug
3.3.2. Launch the Management CLI
Prerequisites
Perform one of the following before accessing the Management CLI:
Section 2.6.2, “Start JBoss Enterprise Application Platform 6 as a Standalone Server”
Section 2.6.3, “Start JBoss Enterprise Application Platform 6 as a Managed Domain”
Procedure 3.8. Task
A. 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 B. Launch the CLI in Windows
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
Report a bug
3.3.3. Quit the Management CLI
Prerequisites
Section 3.3.2, “Launch the Management CLI”
Procedure 3.9. Task