IBM WebSphere Application Server users only.

Removing a task from a configuration profile (removeTask)

Use the removeTask command to remove a task from a configuration profile.

Command description

The removeTask command deletes the XML configuration file or files that are associated with a specific task in the configuration profile.

Important:

You must use the removeTask command with care because not all tasks can be removed.

You cannot remove a task that identifies a repository or an application. If you want to remove a repository or an application from a profile, do not use the removeTask command to remove the tasks because some tasks are shared across multiple repositories or applications. Instead, run the generateConfig command again and specify which repositories or application you do not want to configure.

For example, if you configured both IBM Content Cortex and IBM® Content Manager repositories and included IBM CMIS for FileNet® Content Manager, and you need to remove the IBM Content Manager repository and IBM CMIS for FileNet Content Manager from the profile, you must specify to remove both configurations when you run the generateConfig command again in the following way: 
-configure_CM no 
-configure_CMIS_FileNetP8 no

The updated profile does not include any tasks related to the repository or application that you want to remove from the profile.

The following tasks identify a repository and cannot be removed from a configuration profile:
  • downloadcejarstask: this task identifies an IBM FileNet P8 and IBM CMIS for FileNet Content Manager repository.
  • configureodwek: this task identifies an IBM Content Manager OnDemand repository.
  • configurecm8task: this task identifies an IBM Content Manager repository.

removeTask command syntax

To run the removeTask command, use the following syntax: 
configmgr_cl removeTask
-task value | -taskfile value
-profile value
[-silent] [-force] 
[-help]
Important:
  • Before you run the command, change to the configure subdirectory of the IBM Content Navigator installation directory. The default location is:
    • AIX, Linux, and Linux for System z: /opt/IBM/ECMClient/configure
    • Windows: C:\Program Files\IBM\ECMClient\configure
  • Enter the command and parameters on a single line, without any line breaks.
  • The command name is not case-sensitive.
  • The parameter names and parameter values are case-sensitive.

Examples of use cases

The following examples show how you might use the removeTask command.

Remove the configureldap task from a specific profile
If you have multiple LDAP server configurations in a profile and one of the LDAP servers is no longer valid, run the following command to remove the configuration of the LDAP server that is no longer valid:
configmgr_cl removeTask -taskfile configureldap.2.xml 
-profile myProfile
Remove the configurepe.xml file
If you do not want to use IBM Content Cortex workflows in your IBM Content Navigator deployment, run the following command to remove the XML configuration file from the configuration profile:
configmgr_cl removeTask -taskfile configurepe.xml
-profile myProfile

Command parameters

Specify the following parameters to remove a task from a configuration profile:
-task
Required: No. You can omit the -task parameter if you specify the -taskfile parameter.

Description: Specifies the name of the type of task to remove from the configuration profile.

Valid values: To see a list of the tasks in your profile, use the listTasks command: 
configmgr_cl listTasks -profile myProfile
-taskfile
Required: Only if you have multiple configuration XML files for a task.

Description: Specifies which XML configuration file to remove for a task. For example, you might run this if you have multiple LDAP XML configuration files in a profile and one of the LDAP servers is no longer valid.

By default, the file name increments for each new file that is generated. For example, a second LDAP configuration file is named configureldap.2.xml.

Valid values: To see a list of the tasks in your profile, use the listTasks command: 
configmgr_cl listTasks -profile myProfile
-profile
Required: Yes

Description: The fully qualified directory where the configuration XML files are located. When you specify the -profile parameter, the default location of the configuration XML files is ..\Program Files\IBM\ECMClient\configure\profiles or /opt/IBM/ECMClient/configure/profiles. If the profile directory is at this location, you only need to specify the name of the profile directory.

-silent
Required: No

Description: Runs the command silently, without any user interaction, which means that no prompts or informational messages are displayed on the console. Instead, the errors are written to the log files. Failure messages and validation error messages are displayed as needed, such as messages about missing passwords.

-force
Required: If the -silent parameter is used.

Description: Overrides the checks that the command runs. The task is forced to run without pausing to prompt you for required input or responses to validation error messages. The force parameter should always be used with caution; otherwise, it might result in the loss of data.

-help
Required: No

Description: Use the help parameter to get information about the command syntax, valid parameters, and values.