generateconfig command

generateconfig 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 generateconfig -appserver app_server_type -ldap ldap_type -repositorytype ldap_repository_type -deploy deploy_type -task task_type -taskname display_name -profile myprofile [-silent] [-force] [-help]

generateconfig command parameters

-appserver appserver_type

The -appserver appserver_type parameter specifies the type of application server and must be WebSphere.

-ldap ldap_type

The -ldap ldap_type parameter is required only when you are generating all the files at the same time or when you are generating a single file by using the configureldap option. This parameter specifies the type of directory service repository that the CCX-GQL uses for authenticating users and must be activedirectory, adam, ca, edirectory, oid, oracledirectoryse, or tivoli. The adam value applies to both Microsoft ADAM and AD LDS.

-repositorytype ldap_repository_type

The -repositorytype ldap_repository_type parameter specifies the type of LDAP repository to use and must be standalone or federated.

-deploy deploy_type

The -deploy deploy_type parameter is required only when you are generating all the files at the same time or when you are generating a single file by using the deployapplication option. This parameter specifies the type of CCX-GQL deployment. The value must be standard, cluster, or netdeploy (network deployment).

Specify standard if you are deploying CCX-GQL to a stand-alone (that is, a server that is not managed or clustered) WebSphere® Application Server.

Specify cluster if you are deploying CCX-GQL to a WebSphere Application Server cluster.

Specify netdeploy if you are deploying CCX-GQL to a managed WebSphere Application Server instance. That is, you are using Network Deployment to manage individual servers that are not in a cluster.

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

-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 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 all the default configuration files for a profile are created.
downloadcejars	downloadcejars.xml	Generates the file for the Update IBM Content Cortex Client Connector Files task.
importltpakey	importltpakey.xml	Generates the file for importing the Content Platform Engine to the CCX-GQL server.
configureldap	configureldap.xml	Generates the file for configuring the connection to the directory server for authenticating Content Cortex GraphQL users.
deployapplication	deployapplication.xml	Generates the file for the application server properties and the file with settings for deploying the CCX-GQL application on the application server.

-taskname display_name

The -taskname display_name parameter is optional and is valid only for generating the files. This parameter specifies the value for the displayName attribute in the configuration XML file. If the display name includes spaces, put the entire name inside quotation marks. The display name is used in the graphical user interface to identify the task.

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

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

Generate the downloadcejars.xml file for the downloadcejars task:

configmgr_cl generateconfig -appserver app_server_type
 -repositorytype  ldap_repository_type
 -task downloadcejars -profile myprofile

Generate all configuration files at the same time.

the following command generates all the configuration XML files for a new IBM Content Cortex GraphQL Configuration and Deployment tool profile for a standard deployment on WebSphere with IBM Security Directory Server that uses a stand-alone LDAP repository:<csgql_installation_path>/csgraphQLtool/configure/profiles/CSGQLTestProfile directory:

configmgr_cl generateconfig -appserver WebSphere -ldap tivoli -repositorytype standalone -deploy standard -profile CSGQLTest

Display the help for the generateconfig command.

The following command displays the help for the generateconfig command:

configmgr_cl generateconfig -help