For up-to-date product documentation, see the IBM MobileFirst Foundation Developer Center.

Commands for troubleshooting

We can use Ant task commands to investigate problems with MobileFirst Server web applications.

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. Use this command to test whether the MobileFirst administration services are running at all. It has the following attributes:

Table 1. show-info command attributes

Attribute	Description	Required	Default
output	Name of output file.	No	Not applicable
outputproperty	Name of Ant property for the output.	No	Not applicable

Example

<show-info/>

The show-versions command

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

• mfpadmVersion: the exact MobileFirst Server version number from which the mfp-ant-deployer.jar file is taken.
• productVersion: the exact MobileFirst Server version number from which the mfp-admin-service.war file is taken.
• mfpAdminVersion: the exact build version number of mfp-admin-service.war alone.

The command has the following attributes:

Table 2. show-versions command attributes

Attribute	Description	Required	Default
output	Name of output file.	No	Not applicable
outputproperty	Name of Ant property for the output.	No	Not applicable

Example

<show-versions/>

The show-diagnostics command

The show-diagnostics command shows the status of various components that are necessary for the correct operation of the MobileFirst administration service, such as the availability of the database and of auxiliary services. This command has the following attributes.

Table 3. show-diagnostics command attributes

Attribute	Description	Required	Default
output	Name of output file.	No	Not applicable
outputproperty	Name of Ant property for the output.	No	Not applicable

Example

<show-diagnostics/>

The unlock command

The unlock command releases the general-purpose lock. Some destructive operations take this lock in order to prevent concurrent modification of the same configuration data. In rare cases, if such an operation is interrupted, the lock might remain in locked state, making further destructive operations impossible. Use the unlock command to release the lock in such situations. The command has no attributes.

Example

<unlock/>

The list-runtimes command

The list-runtimes command returns a list of the deployed runtimes. It has the following attributes:

Table 4. list-runtimes command attributes

Attribute	Description	Required	Default
inDatabase	Whether to look in the database instead of via MBeans.	No	false
output	Name of output file.	No	Not applicable
outputproperty	Name of Ant property for the output.	No	Not applicable

Examples

<list-runtimes/>

<list-runtimes inDatabase="true"/>

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. It has the following attributes:

Table 5. show-runtime command attributes

Attribute	Description	Required	Default
runtime	Name of the runtime.	Yes	Not available
output	Name of output file.	No	Not applicable
outputproperty	Name of Ant property for the output.	No	Not applicable

Example

<show-runtime runtime="mfp"/>

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

The delete-runtime command

The delete-runtime command deletes the runtime, including its apps and adapters, from the database. We can delete a runtime only when its web application is stopped. The command has the following attributes.

Table 6. delete-runtime command attributes

Attribute	Description	Required	Default
runtime	Name of the runtime.	Yes	Not available
condition	Condition when to delete it: empty or always Attention: The always option is dangerous.	No	Not applicable

Example

<delete-runtime runtime="mfp" condition="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. It has the following attributes:

Table 7. list-farm-members command attributes

Attribute	Description	Required	Default
runtime	Name of the runtime.	Yes	Not available
output	Name of output file.	No	Not applicable
outputproperty	Name of Ant property for the output.	No	Not applicable

Example

<list-farm-members runtime="mfp"/>

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. Use this command when the server has become unavailable or disconnected. The command has the following attributes.

Table 8. remove-farm-member command attributes

Attribute	Description	Required	Default
runtime	Name of the runtime.	Yes	Not available
serverId	Identifier of the server.	Yes	Not available
force	Force removal of a farm member, even if it is available and connected.	No	false

Example

<remove-farm-member runtime="mfp" serverId="srvlx15"/>

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

Parent topic: Administering MobileFirst applications through Ant