endeca-cmdユーティリティについて

Endeca Serverには、Endeca Serverクラスタのノード、Endeca Serverクラスタにホストされるデータ・ドメイン、およびデータ・ドメイン・ノードを制御できるコマンドライン・インタフェースがあります。

endeca-cmdコマンドを使用すると、Endeca Serverのバージョンを取得して、次の場所で操作を実行できます。

endeca-cmdユーティリティを実行するには、Javaランタイム環境(JRE)が必要です。したがって、システムのPATH変数定義の開始部分で、インストールしたJKDのbinディレクトリが含まれていることを確認します。または、JAVA_HOME環境変数を正しく設定していることを確認します。

endeca-cmdコマンドの構文は次のとおりです。
endeca-cmd command [global options] [command options]

endeca-cmdコマンドは、Endeca Serverの2つのWebサービス・インタフェース(クラスタWebサービスおよび管理Webサービス)を使用します。つまり、Webサービス・リクエスト(soapUIなど)を直接使用するか、または、Webサービス・リクエストからJavaスタブを生成して、これらのリクエストを生成するためのJavaメソッドを使用することで、すべてのendeca-cmdコマンドをプログラム的に発行できます。クラスタWebサービスおよび管理Webサービスの詳細は、Oracle Endeca Serverクラスタ・ガイドを参照してください。

endeca-cmdスクリプトが任意のEndeca Serverノードにインストールされているディレクトリから、endeca-cmdコマンドを発行できます。endeca-cmdスクリプトには、SSL用と非SSL用の2つのバージョンがあります。

非SSLバージョンのendeca-cmd

非SSLバージョンのendeca-cmdスクリプトは、デフォルトで、Endeca Serverインストールのルートのendeca-cmdディレクトリにあります。たとえば、Windowsのデフォルトのパスは次のとおりです。
C:\Oracle\Middleware\EndecaServer7.5.1_1\endeca-cmd

Linuxの場所もEndeca Serverインストール・ディレクトリにあります。

Endeca Serverデプロイメントが非SSL環境にインストールされている場合は、このバージョンのスクリプトを使用します。

SSLバージョンのendeca-cmd

SSLバージョンのendeca-cmdスクリプトは、デフォルトで、$DOMAIN_HOME/EndecaServer/binディレクトリにあります。たとえば、endeca_domainがWebLogic Serverドメインの名前の場合、Windowsのデフォルトのパスは次のようになります。
C:\Oracle\Middleware\user_projects\domains\endeca_domain\EndecaServer\bin

このバージョンでは、--keystoreおよび--truststoreオプションでSSL証明書の場所を指定することなく、endeca-cmdコマンドを発行できます。これを実行するには、デフォルトで$DOMAIN_HOME/configディレクトリにあるEndecaCmd.propertiesファイルを使用します。

EndecaCmd.propertiesファイルのパラメータは、generate_ssl_keysユーティリティを実行して証明書を生成すると自動的に設定されます。ファイルのパラメータは次のとおりです。
  • host: Endeca Serverが実行されているホスト・マシンの名前( --hostオプションと同じ)。
  • port: Endeca Serverがリスニングしているホスト・マシンのポート(--portオプションと同じ)。
  • root: Endeca Serverのコンテキスト・ルート(--rootオプションと同じ)。
  • keystore: キーストアの場所(--keystoreオプションと同じ)。
  • truststore: トラストストアの場所(--truststoreオプションと同じ)。
  • ssl: SSLが使用中かどうかを示すブール設定(--sslオプションと同じ)。
WindowsサーバーのEndecaCmd.propertiesファイルの例は次のとおりです。
host=Web007
port=7002
root=/endeca-server
keystore=C:/Oracle/Middleware/user_projects/domains/endeca_domain/config/ssl/endecaServerClientCert.ks
truststore=C:/Oracle/Middleware/user_projects/domains/endeca_domain/config/ssl/endecaServerTrustStore.ks
ssl=true

デフォルトでは、コマンドを発行すると、キーストアのパスワードを求められます。これは、generate_ssl_keysユーティリティの--sslPassphraseフラグで指定したパスワードです。--passwordオプションでパスワードを指定することで、プロンプトをオーバーライドできることに注意してください。