For up-to-date product documentation, see the IBM MobileFirst Foundation Developer Center.
Commands for troubleshooting
When we invoke the mfpadm program, we 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
The show info command takes the following options after the object.
Table 1. show infos options Option Description --xml Produces XML output instead of tabular output.
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 mfp-ant-deployer.jar is taken.
- productVersion: the exact MobileFirst Server version number from which mfp-admin-service.war is taken
- mfpAdminVersion: the exact build version number of mfp-admin-service.war alone.
Syntax: show versions
The show versions command takes the following options after the object.
Table 2. show versions options Option Description --xml Produces XML output instead of tabular output.
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. Syntax: show diagnostics
The show diagnostics command takes the following options after the object.
Table 3. show diagnostics options Option Description --xml Produces XML output instead of tabular output.
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.
Example
unlock
The list runtimes command
The list runtimes command returns a list of the deployed runtimes. Syntax: list runtimes [--in-database]
The list runtimes command takes the following options:
Table 4. list runtimes options Option Description --in-database Whether to look in the database instead of via MBeans --xml Produces 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. Syntax: show runtime [runtime-name]
The show runtime command takes the following arguments:
Table 5. The show runtime command arguments Argument Description runtime-name Name of the runtime. The show runtime command takes the following options after the object.
Table 6. The show runtime command options Option Description --xml Produces XML output instead of tabular output. This command is based on the Runtime (GET) REST service.
Example
show runtime mfp
The delete runtime command
The delete runtime command deletes a runtime, including its apps and adapters, from the database. We can delete a runtime only when its web application is stopped. Syntax: delete runtime [runtime-name] condition
The delete runtime command takes the following arguments:
Table 7. delete runtime arguments Argument Description runtime-name Name of the runtime. condition Condition when to delete it: empty or always Attention: The always option is dangerous.
Example
delete runtime mfp 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]
The list farm-members command takes the following arguments:
Table 8. list farm-members arguments Argument Description runtime-name Name of the runtime. The list farm-members command takes the following options after the object.
Table 9. list farm-members options Option Description --xml Produces XML output instead of tabular output.
Example
list farm-members 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 the specified runtime is deployed. Use this command when the server has become unavailable or disconnected. Syntax: remove farm-member [runtime-name] server-id
The remove farm-member command takes the following arguments.
Table 10. remove farm-member arguments Argument Description runtime-name Name of the runtime. server-id Identifier of the server. The remove farm-member command takes the following options after the object.
Table 11. remove farm-member option Option Description --force Force removal of a farm member, even if it is available and connected.
Example
remove farm-member mfp srvlx15
This command is based on the Farm topology members (DELETE) REST service.
Parent topic: Administering MobileFirst applications through the command line