JBoss Community Archive (Read Only)

ModeShape 5

Administering Repositories in JBoss Wildfly

Once the ModeShape standalone server for Wildfly is running, you can use the application server's command line management tool (CLI) to view the ModeShape subsystem. The CLI allows you to view the attributes and metrics of ModeShape repositories, as well as, view the installed web applications.

More information about the Wildfly Command Line Interface (CLI) is available here.

Getting Started

To start the CLI, run this command:


When the CLI first starts, you will see something like this:

You are disconnected at the moment. Type 'connect' to connect to the server or 'help' for the list of supported commands.
[disconnected /]

Enter "connect" to establish a connection your Wildfly managed instance:

[disconnected /] connect
[standalone@localhost:9999 /]

Press the tab key at the command line prompt to trigger tab-completion!

At any time enter "ls" to view child managed node names and current values for properties. Also, enter "pwd" to see your current location in the management model.


The CLI allows you to navigate the management model just as if you were navigating a file system. Here are some helpful commands that can be run at the root of the management system. But each of these commands can be modified to run using relative paths also.

  • To navigate to the ModeShape subsystem:

cd /subsystem=modeshape
  • To navigate to the ModeShape repositories:

cd /subsystem=modeshape/repository
  • To navigate to a specific repository:

cd /subsystem=modeshape/repository=<repository-name>
  • To navigate to the ModeShape web applications:

cd /subsystem=modeshape/webapp
  • To navigate to a specific ModeShape web application:

cd /subsystem=modeshape/webapp=<web-app-war>
  • To navigate to a specific ModeShape repository's CND sequencer:

cd /subsystem=modeshape/repository=<repository-name>/sequencer=cnd-sequencer

Managed Resource Commands

To view attribute values, metric values, and child managed nodes of a resource, like a repository, just enter "ls" for a listing. A nicer way to see the same information in a much more readable form is to enter the following:


A metric is a special runtime attribute.

Other helpful commands:

  • To obtain descriptions, possible attribute types, and possible child types:

  • To obtain current metric values:

  • To obtain current attribute values recursively for child nodes so that you do not have to navigate to each child node:


Example Output

[standalone@localhost:9999 repository=artifacts] :read-resource(include-runtime=true)
    "outcome" => "success",
    "result" => {
        "allow-workspace-creation" => false,
        "anonymous-roles" => undefined,
        "anonymous-username" => "<anonymous>",
        "authenticator" => undefined,
        "cache-container" => undefined,     
        "cluster-stack" => undefined,
        "configuration" => undefined,
        "default-initial-content" => undefined,
        "default-workspace" => "default",        
        "text-extractor" => {"tika-extractor" => undefined}
[standalone@localhost:9999 repository=artifacts]

RHQ Plugin

Another way to view ModeShape managed Wildfly components is to use RHQ. The image below shows the RHQ console.  images/author/download/attachments/103547165/ms-rhq.png

JBoss.org Content Archive (Read Only), exported from JBoss Community Documentation Editor at 2020-03-11 12:12:49 UTC, last content change 2016-04-05 12:08:25 UTC.