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 Cortex GraphQL settings affected by the task.

Table 1. task_type values

Option	Configuration file	Description
omitted	downloadcejars.xml importltpakey.xml configureldap.xml deployapplication.xml	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.
downloadcejars	downloadcejars.xml	Checks the status for the Update IBM Content Cortex Client Connector Files task.
importltpakey	importltpakey.xml	Checks the status for importing the Content Platform Engine to the CCX-GQL server.
configureldap	configureldap.xml	Checks status for configuring the connection to the directory server for authenticating Content Cortex GraphQL users.
deployapplication	deployapplication.xml	Checks status for deploying the CCX-GQL 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 CSGQLTestProfile. The profile must be located in the <csgql_installation_path>/csgraphQLtool/configure/profiles directory, where <csgql_installation_path> is the location where the CCX-GQL software is installed.

Remember: If the path includes a directory name with spaces, enclose the entire path in quotation marks.

-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 a file for the configureldap (Configure LDAP) task.

The following command checks the status of the configureldap.xml task file in the <csgql_installation_path>/csgraphQLtool/configure/profiles/CSGQLTestProfile directory:

configmgr_cl checkstatus -task configureldap -profile CSGQLTestProfile

Display the help for the checkstatus command.

The following command displays the help for the checkstatus command:

configmgr_cl checkstatus -help