Overview of the CIM Command-line Utility

The Component Instance Manager (CIM) Command-line Utility is a tool to create components, delete components, and view components. The Endeca IAS Service must be running before you can execute any of the CIM Command-line Utility tasks.

In this version of IAS, the types of components you can manage with the CIM Command-line Utility are Record Store components. In future releases, the utility may be extended to manage additional types of components.

The CIM Command-line Utility is a script named component-manager-cmd.sh (for Linux/UNIX systems) and component-manager-cmd.bat (on Windows) that you run from a command prompt. The script is in the bin directory.

Help options

The CIM Command-line Utility has two help options that display the usage syntax. The --help option displays a summary of the tasks. The --help-detail option displays detailed usage information for all the tasks.

For example:

C:Oracle\Endeca\IAS\3.0.0\bin>component-manager-cmd.bat --help
usage: component-manager-cmd <task-name> [options]

  list-types
  list-components
  create-component
  delete-component

For detailed usage information including task options, use --help-detail
For detailed usage information for individual task options, use <task-name> --help

Command-line options

The command syntax for executing the tasks is:

component-manager-cmd task-name [options]

The task-name argument is the task to be performed by the utility, such as the createCrawls task. The task options vary, depending on the task. However, these options can be used with any task:

-h (or --host) specifies the host name of the machine on which the IAS Service is running. If the flag is omitted, it defaults to the value of the com.endeca.eidi.ias.server.host property in workspace\IAS\conf\commandline.properties. If the property is not set, the value then defaults to localhost as the host name.
-p (or --port) specifies the port on which IAS Service is listening. If the flag is omitted, it defaults to the value of the com.endeca.eidi.ias.server.port property in <install path>\workspace\IAS\conf\commandline.properties. If the property is not set, the value then defaults to 8510 as the port number.
-l (or --isPortSsl) specifies whether to communicate with the service using an HTTPS connection. A value of true uses HTTPS and treats the com.endeca.eidi.ias.server.port property as an SSL port. A value of false uses HTTP and treats com.endeca.eidi.ias.server.port as a non-SSL port. Specify false if you enabled redirects from a non-SSL port to an SSL port. Optional.

Host and port settings

You first specify the host and port settings for the Endeca IAS Service as part of the installation wizard. That host runs the IAS Server, the Component Instance Manager, and all Record Store instances. The installation wizard then writes the host (com.endeca.eidi.ias.server.host) and port (com.endeca.eidi.ias.server.port) settings as properties in commandline.properties. All of the command-line utilities use these settings as default values if you omit the -h and -p flags when executing any tasks.

Setting the bin directory in the PATH environment variable

Although not required, it is recommended that you set the path of the bin directory in your systems' PATH environment variable. This allows you to run the Component Instance Manager Command-line Utility script from any location.

About error handling

If desired, you can re-configure the default logging settings in <install path>\IAS\workspace\conf\component-manager-cmd.log4j.properties.
Errors print to standard error, unless you redirect std err to a file instead.
Errors of mis-configured command-line tasks or incorrect input parameters are written to standard out.