Chapter 9. Managing your installation manager configurations using the Management CLI
The Management CLI enables you to manage your installation manager configuration. You can perform actions like viewing channels, subscribing, and unsubscribing from channels. For more information about managing channels on JBoss EAP 8.0 see JBoss EAP channels in the Installation guide.
9.1. Listing subscribed channels
The following example describes how to use the Management CLI to list all the channels you are subscribed to in a stand-alone server and managed domain.
Procedure
Launch the Management CLI:
EAP_HOME/bin/jboss-cli.sh
List subscribed channels in your JBoss EAP server:
List channels in a stand-alone server:
[standalone@localhost:9990 /] installer channel-list
List channels in a managed domain:
[domain@localhost:9990 /] installer channel-list --host=target-host
9.2. Subscribing to a channel
The following example describes how to use the Management CLI to subscribe to a channel in a stand-alone server and a managed domain.
Procedure
Launch the Management CLI:
EAP_HOME/bin/jboss-cli.sh
Subscribe to a channel:
Subscribe to a channel in stand-alone server:
[standalone@localhost:9990 /] installer channel-add --channel-name=test-channel --manifest=org.test:test-manifest --repositories=mrrc::https://maven.repository.redhat.com
Subscribe to a channel in a managed domain:
[domain@localhost:9990 /] installer channel-add --host=target-host --channel-name=test-channel --manifest=org.test:test-manifest --repositories=mrrc::https://maven.repository.redhat.com
9.3. Unsubscribing from a channel
The following example describes how to use the Management CLI to unsubscribe from a channel in a stand-alone server and a managed domain.
Procedure
Launch the Management CLI:
EAP_HOME/bin/jboss-cli.sh
Unsubscribe to a channel:
Unsubscribe to a channel in a stand-alone server:
[standalone@localhost:9990 /] installer channel-remove --channel-name=test-channel
Unsubscribe to a channel in a managed domain:
[domain@localhost:9990 /] installer channel-remove --host=target-host --channel-name=test-channel
9.4. Editing a channel subscription
The following example describes editing a channel subscription using the Management CLI.
Procedure
Launch the Management CLI:
EAP_HOME/bin/jboss-cli.sh
Edit a channel subscription in JBoss EAP:
Edit a channel subscription in a stand-alone server:
[standalone@localhost:9990 /] installer channel-edit --channel-name=channel-name --manifest=org.new.test:org.new.test-manifest --repositories=mrrc::https://maven.repository.redhat.com ,mvncentral::https://repo.maven.apache.org/maven2/
Edit a channel subscription in a managed domain:
[domain@localhost:9990 /] installer channel-edit --host=target-host --channel-name=channel-name --manifest=org.new.test:org.new.test-manifest --repositories=mrrc::https://maven.repository.redhat.com ,mvncentral::https://repo.maven.apache.org/maven2/
9.5. Exporting a server snapshot
You can export the installation manager configuration used by your JBoss EAP server to an archive file. This file can be used to recreate the same server configuration using the jboss-eap-installation-manager
tool. This feature ensures easy replication of your server setup in other environments. For information see exporting a server snapshot using the jboss-eap-installation-manager
.
One compelling use case for this capability is when you encounter a technical issue and need to seek support from the JBoss EAP team. By sharing the exported archive file with the support team, they can recreate your server configuration precisely as it is in your environment. This ensures that the support team can replicate the issue you are facing and provide targeted assistance, ultimately expediting the resolution process. You can also provide more details about your environment by following the steps in the JDR tool documentation.
Procedure
Launch the Management CLI:
EAP_HOME/bin/jboss-cli.sh
Export a server snapshot:
Export a server snapshot in a stand-alone server:
standalone@localhost:9990 /] attachment save --operation=/core-service=installer:clone-export()
Export a server snapshot in a managed domain:
[domain@localhost:9990 /] attachment save --operation=/host=target-host/core-service=installer:clone-export()
Additional resources