execute command

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

execute command parameters

-task task_type

The -task task_type parameter is indicates which task to run. You can omit the -task task_type parameter if you want to run all of the tasks. 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	Description
omitted	If you omit the -task task_type parameter and the -taskfile task_file_name parameter, then all the configuration files in the path are run. Any configuration XML file that has the enabled attribute value in the <configuration> tag set to false is skipped.
downloadcejars	Applies the settings for the Update IBM Content Cortex Client Connector Files task.
importltpakey	Applies the settings for importing the Content Platform Engine to the CCX-GQL server.
configureldap	Applies the settings for configuring the connection to the directory server for authenticating Content Cortex GraphQL users.
deployapplication	Deploys 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.

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

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

Run all the tasks in a profile.

The following command runs all the tasks in the CSGQLTestProfile profile, which is located in the <csgql_installation_path>/csgraphQLtool/configure/profiles/CSGQLTestProfile directory. If you include the -silent parameter in the command, you must also include the -force parameter.

 configmgr_cl execute -profile CSGQLTestProfile

Run the configureldap (Configure LDAP) task.

The following command runs the configureldap task in the <csgql_installation_path>/csgraphQLtool/configure/profiles/CSGQLTestProfile directory:

 configmgr_cl execute -task configureldap -profile CSGQLTestProfile

Display the help for the execute command.

The following command displays the help for the execute command:

configmgr_cl execute -help