removetask command

removetask 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 removetask -task task_type | -taskfile task_file_name
 -profile myprofile [-silent][-force][-help]

removetask command parameters

-task task_type

The -task task_type parameter is optional and indicates which task to remove. You can omit the -task task_type parameter 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 CCX-GQL settings affected by the task.

Table 1. task_type values

Option	Configuration file	Description
downloadcejars	downloadcejars.xml	Settings for the Update IBM Content Cortex Client Connector Files task.
importltpakey	importltpakey.xml	Settings for importing the Content Platform Engine to the CCX-GQL server.
configureldap	configureldap.xml	Settings for configuring the connection to the directory server for authenticating Content Cortex GraphQL users.
deployapplication	deployapplication.xml	Settings 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.

-silent

The -silent parameter is optional. When -silent is specified, then no prompts or informational messages are displayed in the console, but the errors are written to the log. Failure messages and validation error messages are displayed as needed, such as messages about missing passwords or invalid port numbers. If you run the execute command to run all the tasks in a profile, and you specify the -silent parameter, you must also specify the -force parameter.

-force

The -force parameter is optional and only applies when the -silent parameter is used. When -force is specified, then the task is run without pausing for required responses to validation error messages, such as messages about missing passwords or invalid port numbers.

-help

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

removetask command examples

Remove the configureldap task from a profile with only one configureldap task.

The following command removes the configureldap task and the configureldap.xml file from the profile named CSGQLTestProfile.

configmgr_cl removetask -task configureldap -profile CSGQLTestProfile

Display the help for the removetask command.

The following command displays the help for the removetask command:

configmgr_cl removetask -help