Application Configuration Framework (Non-GUI)

Connecting to FAS via the CLI 

  • Navigate to the FAS's bin directory e.g. cd <FAS_INSTALL_DIR>/bin
  • Start the JBoss CLI e.g. ./jboss-cli.sh
  • Using the 'connect' command, connect to the master host of the required FAS cluster, specifying its address and the management port e.g. connect <ADDRESS>:9999
  • When prompted for credentials, enter the appropriate username and password
  • To terminate a CLI session type: quit

NOTE: Once connected use 'ctrl + backspace' to delete a command

View List of application managed by ACF

To view a list of applications that are managed or could be managed, use the following command:

/profile=ha/subsystem=config:list-apps()

Output similar to the following should be returned:

{
"outcome" => "success",
"result" => undefined,
"server-groups" => {"main-server-group" => {"host" => {"master-
192.168.9.14" => {"192.168.1.234-1" => {"response" => {
"outcome" => "success",
"result" => [("ServiceBroker" => {
"description" => "Provides sip routing, registrar and adaptation
functions",
"status" => "MANAGED"
})]
}}}}}}
}

The status of the application in the above example is MANAGED, therefore its properties can be modified. If it was UNMANAGED, you would need to perform the following step to manage the application:

To “manage” an application

  1. Discover the application’s name using the list-apps command (as above).
  2. Issue the following command to manage the application:
    /profile=ha/subsystem=config/
    application=<ApplicationName>:add(description="This is my description")

where <ApplicationName> is replaced with the unmanaged application's name (in the above example this would be ServiceBroker).

To “unmanage” an application

Issue the following command:

/profile=ha/subsystem=config/application=<ApplicationName>:remove()

This returns any changed values to their default values.

To view a list of properties exposed by the application

Issue the following command:

/profile=ha/subsystem=config/application=<ApplicationName>:describe()

Where <ApplicationName> is replaced with the managed application's name. This will return a list of properties.

To validate a property

The following command lets you see if a value is valid but does not set it:

/profile=ha/subsystem=config/application=<ApplicationName>/property=<PropertyName>:validate(value=<newValue>)

where the <PropertyName> is replaced with one of the properties returned from the describe() method above.

The outcome of the validation (success, or failed and a reason) will be returned in the response.

To add a property

It is recommended that properties are validated (as above) before they are added.
To add a property, issue the following command:

/profile=ha/subsystem=config/application=<ApplicationName>/property=<PropertyName>:add(value=<newValue>)

To update a property

It is recommended that properties are validated (as above) before they are updated.To update a property, issue the following command:

/profile=ha/subsystem=config/application=<ApplicationName>/property=<PropertyName>:update(value=<newValue>)

To remove a property

Issue the following command:

/profile=ha/subsystem=config/application=<ApplicationName>/property=<PropertyName>:remove()

To save the changes

When all required changes have been made to the properties they can published; this pushes the changes to FAS server processes.

1 First, it is recommended that you validate the application as a whole, using the following command:

/profile=ha/subsystem=config/application=<ApplicationName>:validate()

2 Assuming that the application is still valid, publish the changes using the following command:

/profile=ha/subsystem=config/application=<ApplicationName>:publish()

 

 

Comments are disabled on these articles if you require help contact support@cafex.com.

Have more questions? Submit a request

Comments

Powered by Zendesk