Commands for troubleshooting

When you invoke the wladm program, you can include various commands for troubleshooting.

The show info command

The show info command shows basic information about the MobileFirst administration services that can be returned without accessing any runtime nor database. This command can be used to test whether the MobileFirst administration services are running at all.

Syntax:

show info

It takes the following options after the object:

Table 1. show info options
Option	Description
`--xml`	Produce XML output instead of tabular output.

Example:

show info

The show versions command

The show versions command displays the MobileFirst versions of various components:

wladmVersion: the exact MobileFirst Server version number from which worklight-ant-deployer.jar is taken.
productVersion: the exact MobileFirst Server version number from which worklightadmin.war is taken

and for every project WAR file:

serverVersion: the exact MobileFirst Server version number from which worklight-jee-library.jar is taken
platformVersion: the exact version number of the MobileFirst development tools that built the project WAR file

Syntax:

show versions

It takes the following options after the object:

Table 2. show versions options
Option	Description
`--xml`	Produce XML output instead of tabular output.

Example:

show versions

The list runtimes command

The list runtimes command returns a list of the deployed runtimes (MobileFirst projects).

Syntax:

list runtimes [--in-database]

It takes the following options:

Table 3. list runtimes options
Option	Description
`--in-database`	Whether to look in the database instead of via MBeans
`--xml`	Produce XML output instead of tabular output.

Examples:

list runtimes
list runtimes --in-database

This command is based on the Runtimes (GET) REST service.

The show runtime command

The show runtime command shows information about a given deployed runtime (MobileFirst project).

Syntax:

show runtime [runtime-name]

It takes the following arguments:

Table 4. show runtime arguments
Argument	Description
`runtime-name`	Name of the runtime web application or MobileFirst project.

It takes the following options after the object:

Table 5. show runtime options
Option	Description
`--xml`	Produce XML output instead of tabular output.

Example:

show runtime worklight

This command is based on the Runtime (GET) REST service.

The delete runtime command

The delete runtime command deletes a runtime, including its apps and adapters, from the database. It is only possible to delete a runtime when its web application is stopped.

Syntax:

delete runtime [runtime-name] condition

It takes the following arguments:

Table 6. delete runtime arguments
Argument	Description
`runtime-name`	Name of the runtime web application or MobileFirst project.
`condition`	Condition when to delete it: 'empty' or 'always' (dangerous!)

Example:

delete runtime worklight empty

This command is based on the Runtime (DELETE) REST service.

The list farm-members command

The list farm-members command returns a list of the farm member servers on which a given runtime is deployed.

Syntax:

list farm-members [runtime-name]

It takes the following arguments:

Table 7. list farm-members arguments
Argument	Description
`runtime-name`	Name of the runtime web application or MobileFirst project.

It takes the following options after the object:

Table 8. list farm-members options
Option	Description
`--xml`	Produce XML output instead of tabular output.

Example:

list farm-members worklight

This command is based on the Farm topology members (GET) REST service.

The remove farm-member command

The remove farm-member command removes a server from the list of farm members on which a given runtime is deployed. This command should be used when the server has become unavailable or disconnected.

Syntax:

remove farm-member [runtime-name] server-id

It takes the following arguments:

Table 9. remove farm-member arguments
Argument	Description
`runtime-name`	Name of the runtime web application or MobileFirst project.
`server-id`	Identifier of the server.

It takes the following options after the object:

Table 10. remove farm-member option
Option	Description
`--force`	Force removal of a farm member, even if it is available and connected.

Example:

remove farm-member worklight srvlx15

This command is based on the Farm topology members (DELETE) REST service.