Red Hat Training

A Red Hat training course is available for Red Hat Fuse

5.7. Management CLI commands for SwitchYard

Prerequisites

There are commands that are available for SwitchYard. To access the commands you first have to operate in the SwitchYard subsystem.

Ensure that you have started the Management CLI and connected to it.

The Management CLI employs tab completion in two ways:

By completing partially entered commands if there is enough entered for it to be unique.
By presenting a list of options if a unique result cannot be found, or if the command is missing.

If you enter the following command and press tab, you will get a list of operations available for the SwitchYard subsystem.

[standalone@localhost:9999 /] /subsystem=switchyard:

The available operations for the SwitchYard subsystem are:

Table 5.1. JBoss EAP Management CLI operations available for SwitchYard subsystem

Operation Name	Function
get-version	This will show the version of SwitchYard currently running on the JBoss EAP instance.
list-applications	This shows a list of the SwitchYard applications currently running on the JBoss EAP instance.
list-references	Lists the references used for SwitchYard applications currently running on the JBoss EAP instance.
read-application	This lists the details for SwitchYard applications running on the JBoss EAP instance.
read-references	Lists the references used by SwitchYard applications running on the JBoss EAP instance.
read-service	Lists the services and details used by SwitchYard applications running on the JBoss EAP instance.
reset-metrics	Reset the message metrics for the SwitchYard subsystem.
show-metrics	List the message metrics for the SwitchYard subsystem.
start-gateway	Start the gateway for a SwitchYard service.
stop-gateway	Stop the gateway for a SwitchYard service.
update-throttling	Update message throttling for a SwitchYard service.
stop-gateway	Stop the gateway for a SwitchYard service.
uses-artifacts	Lists the artifacts used throughout the SwitchYard subsystem.

Enter the operations in the following format, replacing operation-name with one of the operation names from the list above:

[standalone@localhost:9999 /] /subsystem=switchyard:operation-name

The response will vary depending on the operation entered.

Note