Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 9. How to…​

The following CLI commands and operations provide basic examples on how to accomplish certain tasks. For detailed instructions, see the appropriate section of the Configuration Guide or other JBoss EAP guide.

Unless specified otherwise, the examples apply when running as a standalone server. Use the --help argument on a command to get usage for that command. Use the read-operation-description to get information on a particular operation for a resource.

9.1. Add a Datasource
Copy link

data-source add --name=DATASOURCE_NAME --jndi-name=JNDI_NAME --driver-name=DRIVER_NAME  --connection-url=CONNECTION_URL
Copy to Clipboard Toggle word wrap

9.2. Add a JMS Queue
Copy link

jms-queue add --queue-address=QUEUE --entries=java:/jms/queue/QUEUE
Copy to Clipboard Toggle word wrap

9.3. Add a JMS Topic
Copy link

jms-topic add --topic-address=TOPIC --entries=java:/jms/topic/TOPIC
Copy to Clipboard Toggle word wrap

9.4. Add a Module
Copy link

module add --name=MODULE_NAME --resources=PATH_TO_RESOURCE --dependencies=DEPENDENCIES
Copy to Clipboard Toggle word wrap
Important

Using the module management CLI command to add and remove modules is provided as technology preview only. This command is not appropriate for use in a managed domain or when connecting to the management CLI remotely. Modules should be added and removed manually in a production environment. For more information, see the Create a Custom Module Manually and Remove a Custom Module Manually sections of the JBoss EAP Configuration Guide.

9.5. Add a Server
Copy link

Add a new server to a host in a managed domain. 

/host=HOST_NAME/server-config=SERVER_NAME:add(group=SERVER_GROUP_NAME)
Copy to Clipboard Toggle word wrap

9.6. Add a Server Group
Copy link

Add a new server group in a managed domain. 

/server-group=SERVER_GROUP_NAME:add(profile=PROFILE_NAME, socket-binding-group=SOCKET_BINDING_GROUP_NAME)
Copy to Clipboard Toggle word wrap

9.7. Add a System Property
Copy link

/system-property=PROPERTY_NAME:add(value=PROPERTY_VALUE)
Copy to Clipboard Toggle word wrap

9.8. Clone a Profile
Copy link

Clone a profile in a managed domain. 

/profile=PROFILE_TO_CLONE:clone(to-profile=NEW_PROFILE_NAME)
Copy to Clipboard Toggle word wrap

9.9. Create a Hierarchical Profile
Copy link

Create a new profile that inherits from other profiles. 

/profile=NEW_PROFILE_NAME:add(includes=[PROFILE_1,PROFILE_2])
Copy to Clipboard Toggle word wrap

9.10. Deploy an Application to a Managed Domain
Copy link

Deploy an Application to All Server Groups. 

deploy /path/to/DEPLOYMENT.war --all-server-groups
Copy to Clipboard Toggle word wrap

Deploy an Application to One or More Server Groups. 

deploy /path/to/DEPLOYMENT.war --server-groups=SERVER_GROUP_1,SERVER_GROUP_2
Copy to Clipboard Toggle word wrap

9.11. Deploy an Application to a Standalone Server
Copy link

deploy /path/to/DEPLOYMENT.war
Copy to Clipboard Toggle word wrap

9.12. Display the Active User
Copy link

Command: 

:whoami
Copy to Clipboard Toggle word wrap

Output: 

{
    "outcome" => "success",
    "result" => {"identity" => {
        "username" => "$local",
        "realm" => "ManagementRealm"
    }}
}
Copy to Clipboard Toggle word wrap

9.13. Display Schema Information
Copy link

To show the schema information for the :product-info command: 

:read-operation-description(name=product-info)
Copy to Clipboard Toggle word wrap

To display the schema version, execute an ls command at the management CLI root and look for the management-*-version values: 

...
management-major-version=4
management-micro-version=0
management-minor-version=1
...
Copy to Clipboard Toggle word wrap

9.14. Display System and Server Information
Copy link

Command: 

:product-info
Copy to Clipboard Toggle word wrap

Output: 

{
    "outcome" => "success",
    "result" => [{"summary" => {
        "host-name" => "HOST_NAME",
        "instance-identifier" => "INSTANCE_ID",
        "product-name" => "JBoss EAP",
        "product-version" => "7.0.0.GA",
        "product-community-identifier" => "Product",
        "product-home" => "EAP_HOME",
        "standalone-or-domain-identifier" => "OPERATING_MODE",
        "host-operating-system" => "OS_NAME",
        "host-cpu" => {
            "host-cpu-arch" => "CPU_ARCH",
            "host-core-count" => CORE_COUNT
        },
        "jvm" => {
            "name" => "JAVA_VM_NAME",
            "java-version" => "JAVA_VERSION",
            "jvm-version" => "JAVA_VM_VERSION",
            "jvm-vendor" => "JAVA_VM_VENDOR",
            "java-home" => "JAVA_HOME"
        }
    }}]
}
Copy to Clipboard Toggle word wrap

Similarly, for a managed domain, you can display the information for a particular JBoss EAP host or server: 

/host=HOST_NAME:product-info
Copy to Clipboard Toggle word wrap 
/host=HOST_NAME/server=SERVER_NAME:product-info
Copy to Clipboard Toggle word wrap

9.15. Reload a Host Controller
Copy link

reload --host=HOST_NAME
Copy to Clipboard Toggle word wrap

9.16. Reload a Host Controller in Admin-only Mode
Copy link

reload --host=HOST_NAME --admin-only=true
Copy to Clipboard Toggle word wrap

9.17. Reload the Server
Copy link

reload
Copy to Clipboard Toggle word wrap

9.18. Reload the Server in Admin-Only Mode
Copy link

reload --admin-only=true
Copy to Clipboard Toggle word wrap

9.19. Remove a Module
Copy link

module remove --name=MODULE_NAME
Copy to Clipboard Toggle word wrap
Important

Using the module management CLI command to add and remove modules is provided as technology preview only. This command is not appropriate for use in a managed domain or when connecting to the management CLI remotely. Modules should be added and removed manually in a production environment. For more information, see the Create a Custom Module Manually and Remove a Custom Module Manually sections of the JBoss EAP Configuration Guide.

9.20. Shut Down a Host Controller
Copy link

Shut down a host controller in a managed domain. 

shutdown --host=HOST_NAME
Copy to Clipboard Toggle word wrap

9.21. Shut Down the Server
Copy link

Shut down a standalone server. 

shutdown
Copy to Clipboard Toggle word wrap

9.22. Start a Server
Copy link

Start a server in a managed domain. 

/host=HOST_NAME/server-config=SERVER_NAME:start
Copy to Clipboard Toggle word wrap

9.23. Start All Servers in a Server Group
Copy link

Start all servers in a certain server group in a managed domain. 

/server-group=SERVER_GROUP_NAME:start-servers
Copy to Clipboard Toggle word wrap

9.24. Stop a Server
Copy link

Stop a server in a managed domain. 

/host=HOST_NAME/server-config=SERVER_NAME:stop
Copy to Clipboard Toggle word wrap

9.25. Stop All Servers in a Server Group
Copy link

Stop all servers in a certain server group in a managed domain. 

/server-group=SERVER_GROUP_NAME:stop-servers
Copy to Clipboard Toggle word wrap

9.26. Take a Configuration Snapshot
Copy link

Take a snapshot of the current configurations. 

:take-snapshot
Copy to Clipboard Toggle word wrap

Undeploy an application from all server groups with that deployment. 

undeploy DEPLOYMENT.war --all-relevant-server-groups
Copy to Clipboard Toggle word wrap

Undeploy an application from a specific server group. The --keep-content parameter is required in order to keep the content in the repository for other server groups with that deployment. 

undeploy DEPLOYMENT.war --server-groups=SERVER_GROUP_NAME --keep-content
Copy to Clipboard Toggle word wrap 
undeploy DEPLOYMENT.war
Copy to Clipboard Toggle word wrap

9.29. Update a Host Name
Copy link

Update the name of a host in a managed domain. The host must be reloaded in order for the changes to take effect. 

/host=EXISTING_HOST_NAME:write-attribute(name=name,value=NEW_HOST_NAME)
reload --host=EXISTING_HOST_NAME
Copy to Clipboard Toggle word wrap

9.30. View a Server Log
Copy link

/subsystem=logging/log-file=SERVER_LOG_NAME:read-log-file
Copy to Clipboard Toggle word wrap
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2026 Red HatBack to top