CIMコマンドライン・ユーティリティの概要

Component Instance Manager(CIM)コマンドライン・ユーティリティは、コンポーネントの作成、削除および表示を行うツールです。Endeca IAS Serviceは、CIMコマンドライン・ユーティリティのタスクを行う前に実行しておく必要があります。

このバージョンのIASでは、CIMコマンドライン・ユーティリティで管理可能なコンポーネントのタイプはレコード・ストア・コンポーネントになります。今後のリリースでは、ユーティリティは、その他のタイプのコンポーネントを管理するように拡張されます。

CIMコマンドライン・ユーティリティは、コマンド・プロンプトから実行するcomponent-manager-cmd.sh(Linux/UNIXシステムの場合)およびcomponent-manager-cmd.bat(Windowsの場合)というスクリプトになります。スクリプトはIAS\<バージョン>\binディレクトリにあります。

helpのオプション

CIMコマンドライン・ユーティリティには、使用構文を表示する2つのhelpオプションがあります。--helpオプションは、タスクの概要を表示します。--help-detailオプションは、すべてのタスクの詳しい使用情報を表示します。

次に例を示します。

C:Oracle\Endeca\IAS\3.1.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

コマンドライン・オプション

タスクを実行するためのコマンド構文は次のようになります。

component-manager-cmd task-name [options]

task-name引数は、createCrawlsタスクなどの、ユーティリティから実行するタスクになります。タスク・オプションは、タスクによって異なります。ただし、次のオプションはどのタスクでも使用できます。

-cp (または--contextPath)は、IASのコンテキスト・パスを指定します。WebLogic Serverインストールの場合、この値にスラッシュ(/)が含めることも、含めないこともできます。フラグを省略する場合、デフォルトで<インストール・パス>\IAS\workspace\conf\commandline.propertiesのcom.endeca.eidi.ias.server.contextPathプロパティの値に設定されます。このプロパティが設定されていない場合、この値は、WebLogic Serverインストールでは/ias-serverになり、Jettyインストールでは空(つまり、ルート・コンテキスト・パス)になります。オプション。
-h(または--host)は、IAS Serviceが実行しているマシンのホスト名を指定します。フラグを省略する場合、デフォルトでworkspace\IAS\conf\commandline.propertiesのcom.endeca.eidi.ias.server.hostプロパティの値に設定されます。プロパティを設定しない場合、値はデフォルトでホスト名としてlocalhostに設定されます。オプション。
-p(または--port)は、IAS Serviceがリスニングするポートを指定します。フラグを省略する場合、デフォルトで<インストール・パス>\workspace\IAS\conf\commandline.propertiesのcom.endeca.eidi.ias.server.portプロパティの値に設定されます。プロパティを設定しない場合、値はデフォルトでポート番号として8401に設定されます。オプション。
-l(または--isPortSsl)は、HTTPS接続を使用してサービスと通信するかどうかを指定します。値がtrueの場合、HTTPSが使用され、com.endeca.eidi.ias.server.portプロパティはSSLポートとして扱われます。値がfalseの場合、HTTPが使用され、com.endeca.eidi.ias.server.portは非SSLポートとして扱われます。非SSLポートからSSLポートへのリダイレクトを有効にした場合はfalseを指定します。オプション。

ホストとポートの設定

インストール・ウィザードの一環で、最初にEndeca IAS Serviceのホストとポートの設定を指定します。そのホストが、IAS Server、Component Instance Managerおよびすべてのレコード・ストア・インスタンスを実行します。次に、インストール・ウィザードでは、ホスト(com.endeca.eidi.ias.server.host)とポート(com.endeca.eidi.ias.server.port)の設定を、commandline.propertiesのプロパティとして書き込みます。すべてのコマンドライン・ユーティリティでは、タスクの実行時に-hフラグと-pフラグを省略する場合、これらの設定がデフォルト値として使用されます。

PATH環境変数でのbinディレクトリの設定

必須ではありませんが、使用するシステムのPATH環境変数にbinディレクトリのパスを設定することをお薦めします。これにより、どの場所からでもComponent Instance Managerコマンドライン・ユーティリティのスクリプトを実行できます。

エラー処理について

必要に応じて、<インストール・パス>\IAS\workspace\conf\component-manager-cmd.log4j.propertiesでデフォルトのロギング設定を再構成できます。
エラーは、かわりにstd errをファイルにリダイレクトする場合を除き、標準エラーに出力されます。
コマンドライン・タスクを誤って構成した場合のエラーや入力したパラメータが正しくない場合のエラーは標準出力に書き込まれます。