listtasks command

listtasks command syntax

configmgr_cl listtasks [-task task_type]  -profile myprofile
 [-help]

listtasks command parameters

-task task_type

The -task task_type parameter is optional and indicates which task type to list. 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 CCX-GQL 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 all the configuration tasks and the associated task files for the profile are listed.
downloadcejars	downloadcejars.xml	Lists the tasks for the Update IBM Content Cortex Client Connector Files task.
importltpakey	importltpakey.xml	Lists the tasks for importing the Content Platform Engine to the CCX-GQL server.
configureldap	configureldap.xml	Lists the tasks for configuring the connection to the directory server for authenticating Content Cortex GraphQL users.
deployapplication	deployapplication.xml	Lists the tasks for the application server properties and the file with settings for deploying the CCX-GQL application on the application server.

-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.

listtasks command examples

List all the configuration tasks in the profile.

The following command lists all the configuration tasks and the associated configuration XML files in the CSGQLTestprofile profile located in the <csgql_installation_path>/csgraphQLtool/configure/profiles/CSGQLTestprofile directory:

configmgr_cl listtasks -profile CSGQLTestprofile

A message like the following example is displayed:

All tasks in profile CSGQLTestprofile.  The tasks will be executed in the 
positions indicated when executing all tasks:
Task 1:
        Name: Update the IBM Content Cortex client connector files (Content Cortex)        
        Type: downloadcejars
        File: downloadcejars.xml
Task 2:
        Name: Import your Content Engine LTPA keys
        Type: importltpakey
        File: importltpakey.xml
Task 3:
        Name: Configure CCX-GQL server LDAP settings
        Type: configureldap
        File: configureldap.xml
Task 4:
        Name: Deploy Application
        Type: deployapplication
        File: deployapplication.xml

List all the configureldap tasks in the profile.

The following command lists all the configure LDAP settings tasks and the associated configuration XML files in the CSGQLTestProfile profile located in the <csgql_installation_path>/csgraphQLtool/configure/profiles/CSGQLTestProfile directory:

configmgr_cl listtasks -task configureldap -profile CSGQLTestProfile

A message like the following example is displayed:

Tasks in profile CSGQLTestProfile of the task type configureldap:
Task name: Configure CCX-GQL server LDAP settings
        File: configureldap.xml

Display the help for the listtasks command.

The following command displays the help for the listtasks command:

configmgr_cl listtasks -help