checkstatus command

checkstatus command syntax

The following syntax includes line breaks to format the command for reading. Enter the command and options on a single line, without any line breaks.

configmgr_cl checkstatus [-task task_type | -taskfile task_file_name]
 -profile myprofile [-help]

checkstatus command parameters

-task task_type

The -task task_type parameter specifies which task to use for the status check. You can omit the -task task_type parameter if you want to check all of the tasks or if you specify the -taskfile task_file_name parameter. The task_type value is not case sensitive. The following table lists the valid task names, the associated configuration XML file, and a description of the Content Platform Engine settings affected by the task.

Table 1. task_type values

Option	Configuration file	Description
omitted	configurejdbcgcd.xml configurejdbcos.xml configurejdbcos.n.xml configureldap.xml configureldap.n.xml deployapplication.xml Where n is an integer greater than or equal to 2	If you omit the -task task_type parameter and the -taskfile task_file_name parameter, then the status for all the configuration files in the profile is displayed.
configurejdbcgcd	configurejdbcgcd.xml	Checks the status for configuring the JDBC connections to the global configuration database database used by Content Platform Engine.
configurejdbcos	configurejdbcos.xml configurejdbcos.n.xml, where n is an integer greater than or equal to 2	Checks the status for configuring JDBC connections to a single object store database used by Content Platform Engine. You need to generate, edit, and apply the configurejdbcos task settings for each object store in your database. When you generate a second object store JDBC configuration file, it is named configurejdbcos.2.xml. The filename increments for each new file you generate. You cannot change the filename, but you can edit the value in the file for the name of the task. If your profile contains more than one configurejdbcos task, then you must specify the -taskfile task_file_name parameter to identify the task to check.
configureLDAP	configureldap.xml configureldap.n.xml, where n is an integer greater than or equal to 2	Checks status for configuring the connection to the directory server for authenticating Content Platform Engine users. (WebSphere® Application Server or Oracle WebLogic Server only.) If you generate a second LDAP configuration file, then it is named configureldap.2.xml. The filename increments for each new file you generate. You cannot change the filename, but you can edit the value in the file for the name of the task. If your profile contains more than one ConfigureLDAP task, then you must specify the -taskfile task_file_name parameter to identify the task to check.
deployapplication	deployapplication.xml	Checks status for deploying the Content Platform Engine application on the application server.

-taskfile task_file_name

The -taskfile task_file_name parameter specifies the configuration XML file to use.

If only one task file exists for the task_type, then the -taskfile task_file_name parameter is optional.

If more than one task file for the task_type exists, then you must include the -taskfile task_file_name parameter. You can omit the -task task_type parameter when you specify the -taskfile task_file_name parameter.

-profile myprofile

The -profile myprofile parameter specifies the profile to use. The myprofile value can be one of the following items:

• The name of the profile, such as ce_was_tiv_db2. The profile must be located in the ce_install_path/tools/configure/profiles directory, where ce_install_path is the location where the Content Platform Engine software is installed.
• The absolute path to the profile directory, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ce_was_tiv_db2" or /opt/IBM/FileNet/ContentEngine/tools/configure/profiles/ce_was_tiv_db2.
• The absolute path to the profile input file, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ce_was_tiv_db2\ce_was_tiv_db2.cfgp" or /opt/IBM/FileNet/ContentEngine/tools/configure/profiles/ce_was_tiv_db2/ce_was_tiv_db2.cfgp.

Remember: If the path includes a directory name with spaces, enclose the entire path in quotation marks. For example, enter "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ce_was_tiv_db2\ce_was_tiv_db2.cfgp".

-help

The -help parameter is optional and displays a brief message on the command syntax instead of running the command.

checkstatus command examples

The following examples include line breaks to format the command for reading. Enter the command and options on a single line, without any line breaks.

Check the status of a profile with only one file for the configurejdbcos task.

The following command checks the status of the configurejdbcos task in the ce_install_path/tools/configure/profiles/wstdb2jdbc directory:

 configmgr_cl checkstatus -task configurejbcos -profile wstdb2jdbc

Check the status of a profile with several files for the configurejdbcos task.

The following command checks the status of the configurejdbcos.2.xml task file in the ce_install_path/tools/configure/profiles/wstdb2jdbc directory:

 configmgr_cl checkstatus -taskfile configurejdbcos.2.xml
 -profile wstdb2jdbc

Check the status of a profile for the configureldap task.

The following command checks the status of the configureldap task in the ce_install_path/tools/configure/profiles/wstdb2jdbc directory:

 configmgr_cl checkstatus -task configureldap -profile wstdb2jdbc

Display the help for the checkstatus command.

The following command displays the help for the checkstatus command:

configmgr_cl checkstatus -help