カタログ・サービス・ドメイン管理用タスク

Jacl または Jython スクリプト言語を使用して、WebSphere® Application Server 構成内のカタログ・サービス・ドメインを管理できます。

要件

WebSphere Application Server 環境に WebSphere eXtreme Scale クライアントをインストールしている必要があります。

すべての管理用タスクのリスト

カタログ・サービス・ドメインに関連したすべての管理用タスクのリストを取得するには、 wsadmin で以下のコマンドを実行します。
wsadmin>$AdminTask help XSDomainManagement 

コマンド

カタログ・サービス・ドメインの管理用タスクには、以下のコマンドが含まれます。

createXSDomain

createXSDomain コマンドは、新規カタログ・サービス・ドメインを登録します。
表 1. createXSDomain コマンド引数
引数 説明
-name (必須) 作成するカタログ・サービス・ドメインの名前を指定します。
-default カタログ・サービス・ドメインがセルでデフォルトかどうかを指定します。 デフォルト値は true です。(ブール値: true または false に設定)
-properties カタログ・サービス・ドメインのカスタム・プロパティーを指定します。
表 2. defineDomainServers ステップ引数
引数 説明
name_of_endpoint カタログ・サービス・エンドポイントの名前を指定します。
  • 既存のアプリケーション・サーバーの場合: エンドポイントの名前は 、cell_name¥node_name¥server_name の形式でなければなりません。
  • リモート・サーバーの場合: リモート・サーバーのホスト名を指定します。 複数のエンドポイントを同じ名前にすることができますが、 クライアント・ポートの値はそれぞれのエンドポイントで固有でなければなりません。
custom_properties カタログ・サービス・ドメイン・エンドポイントのカスタム・プロパティーを指定します。 カスタム・プロパティーがない場合、 この引数には一組の二重引用符 ("") を使用します。
endpoint_ports
カタログ・サービス・ドメイン・エンドポイントのポート番号を指定します。ポートは 、<client_port>,<listener_port> の順序で指定する必要があります。
クライアント・ポート
カタログ・サービス・ドメイン内のカタログ・サーバー間の通信に使用するポートを指定します。この値は 、WebSphere Application Server プロセスのみで稼働するカタログ・サーバーに必要で、 他で使用されていないどのポートにも設定できます。
リスナー・ポート
クライアントとの通信に使用するポートを指定します。 この値はリモート・エンドポイントに必要で、 カタログ・サービスが開始されたときに使用された値と一致している必要があります。リスナー・ポートは、 カタログ・サービスとの通信のために、クライアントおよびコンテナーによって使用されます。
WebSphere eXtreme Scale のリモート・エンドポイントの場合: コンテナーおよびクライアントがオブジェクト・リクエスト・ブローカー (ORB) を介して カタログ・サービスと通信するための ORB リスナー・ポートを定義します。WebSphere Application Server エンドポイントの場合、 リスナー・ポート値は、BOOTSTRAP_ADDRESS ポート構成から継承されるためオプションです。
表 3. configureClientSecurity ステップ引数
引数 説明
-securityEnabled カタログ・サーバーのクライアント・セキュリティーが使用可能なことを 指定します。選択したカタログ・サーバーに関連付けられたサーバー・プロパティー・ファイルには、 一致する securityEnabled 設定が なければなりません。これらの設定が一致しない場合、例外が発生します。(ブール値: true または false に設定)
-credentialAuthentication (オプション) 資格情報の認証を実施するか、またはサポートするかを示します。
常になし

クライアント証明書認証は実施されません。

必須
資格情報の認証は必ず実施されます。サーバーが資格情報の認証をサポートしない場合、クライアントは サーバーに接続できません。
サポートされる
(デフォルト) 資格情報の認証は、クライアントとサーバーの両方が資格情報の認証を サポートする場合のみ実施されます。
-authenticationRetryCount (オプション) 資格情報の有効期限が切れている場合に認証を 再試行できる回数を指定します。

認証の再試行を望まない場合は、値を 0 に設定します。 デフォルト値は 0 です。

-credentialGeneratorClass クライアントがスレッドからセキュリティー・トークンを 取得するよう、com.ibm.websphere.objectgrid.security.plugins.builtins. WSTokenCredentialGenerator 実装クラスを指示します。
-credentialGeneratorProps CredentialGenerator 実装クラスの プロパティーを指定します。プロパティーは、setProperties(String) メソッドを使用してオブジェクトに送信されます。 資格情報生成プログラムのプロパティー値は、「資格情報生成プログラム・クラス」フィールドに 値が指定されている場合のみ使用されます。

戻り値:

バッチ・モードの使用例

バッチ・モードの場合、 コマンド項目が正しくフォーマットされていることが必要です。入力する値が適切に処理されるように、 対話モードの使用を検討してください。バッチ・モードを使用する場合、 特定のプロパティー配列を使用して -defineDomainServers のステップ引数を 定義する必要があります。このプロパティー配列のフォーマットは、name_of_endpoint custom_properties endpoint_ports です。 endpoint_ports 値は 、<client_port>,<listener_port> の順序で指定する必要があるポートのリストです。

対話モードの使用例
  • Jacl を使用:
    $AdminTask createXSDomain {-interactive}
  • Jython ストリングを使用:
    AdminTask.createXSDomain ('[-interactive]')

deleteXSDomain

deleteXSDomain コマンドは、カタログ・サービス・ドメインを削除します。

必須パラメーター:
-name
削除するカタログ・サービス・ドメインの名前を指定します。

戻り値:

バッチ・モードの使用例
  • Jacl を使用:
    $AdminTask deleteXSDomain {-name TestDomain }
  • Jython ストリングを使用:
    AdminTask.deleteXSDomain('[-name TestDomain ]')
対話モードの使用例
  • Jacl を使用:
    $AdminTask deleteXSDomain {-interactive}
  • Jython ストリングを使用:
    AdminTask.deleteXSDomain ('[-interactive]')

getDefaultXSDomain

getDefaultXSDomain コマンドは、 セルのデフォルト・カタログ・サービス・ドメインを返します。

必須パラメーター: なし

戻り値: デフォルト・カタログ・サービス・ドメインの名前。

バッチ・モードの使用例
  • Jacl を使用:
    $AdminTask getDefaultXSDomain
  • Jython ストリングを使用:
    AdminTask.getDefaultXSDomain
対話モードの使用例
  • Jacl を使用:
    $AdminTask getDefaultXSDomain {-interactive}
  • Jython ストリングを使用:
    AdminTask.getDefaultXSDomain ('[-interactive]')

listXSDomains

listXSDomains コマンドは、既存のカタログ・サービス・ドメインのリストを返します。

必須パラメーター: なし

戻り値: セル内のすべてのカタログ・サービス・ドメインのリスト。

バッチ・モードの使用例
  • Jacl を使用:
    $AdminTask listXSDomains
  • Jython ストリングを使用:
    AdminTask.listXSDomains
対話モードの使用例
  • Jacl を使用:
    $AdminTask listXSDomains {-interactive}
  • Jython ストリングを使用:
    AdminTask.listXSDomains ('[-interactive]')

modifyXSDomain

modifyXSDomain コマンドは、既存のカタログ・サービス・ドメインを変更します。

バッチ・モードの場合、 コマンド項目が正しくフォーマットされていることが必要です。入力する値が適切に処理されるように、 対話モードの使用を検討してください。バッチ・モードを使用する場合、 特定のプロパティー配列を使用して -modifyEndpoints-addEndpoints、 および -removeEndpoints ステップ引数を 定義する必要があります。このプロパティー配列のフォーマットは、name_of_endpoint host_name custom_properties endpoint_ports です。 endpoint_ports 値は 、<client_port>,<listener_port> の順序で指定する必要があるポートのリストです。

表 4. modifyXSDomain コマンド引数
引数 説明
-name (必須) 編集するカタログ・サービス・ドメインの名前を指定します。
-default true に設定した場合、選択したカタログ・サービス・ドメインがセルのデフォルトであることを指定します。 (ブール値)
-properties カタログ・サービス・ドメインのカスタム・プロパティーを指定します。
表 5. modifyEndpoints ステップ引数
引数 説明
name_of_endpoint カタログ・サービス・エンドポイントの名前を指定します。
  • 既存のアプリケーション・サーバーの場合: エンドポイントの名前は 、cell_name¥node_name¥server_name の形式でなければなりません。
  • リモート・サーバーの場合: リモート・サーバーのホスト名を指定します。 複数のエンドポイントを同じ名前にすることができますが、 リスナー・ポートの値はそれぞれのエンドポイントで固有でなければなりません。
endpoint_ports
カタログ・サービス・ドメイン・エンドポイントのポート番号を指定します。エンドポイントは 、<client_port>,<listener_port> の順序で指定する必要があります。
クライアント・ポート
カタログ・サービス・ドメイン内のカタログ・サーバー間の通信に使用するポートを指定します。この値は 、WebSphere Application Server プロセスのみで稼働するカタログ・サーバーに必要で、 他で使用されていないどのポートにも設定できます。
リスナー・ポート
クライアントとの通信に使用するポートを指定します。 この値はリモート・エンドポイントに必要で、 カタログ・サービスが開始されたときに使用された値と一致している必要があります。リスナー・ポートは、 カタログ・サービスとの通信のために、クライアントおよびコンテナーによって使用されます。
WebSphere eXtreme Scale のリモート・エンドポイントの場合: コンテナーおよびクライアントがオブジェクト・リクエスト・ブローカー (ORB) を介して カタログ・サービスと通信するための ORB リスナー・ポートを定義します。WebSphere Application Server エンドポイントの場合、 値が BOOTSTRAP_ADDRESS ポート構成から継承されるため、リスナー・ポート値の指定はオプションです。
表 6. addEndpoints ステップ引数
引数 説明
name_of_endpoint カタログ・サービス・エンドポイントの名前を指定します。
  • 既存のアプリケーション・サーバーの場合: エンドポイントの名前は 、cell_name¥node_name¥server_name の形式でなければなりません。
  • リモート・サーバーの場合: リモート・サーバーのホスト名を指定します。 複数のエンドポイントを同じ名前にすることができますが、 リスナー・ポートの値はそれぞれのエンドポイントで固有でなければなりません。
custom_properties カタログ・サービス・ドメイン・エンドポイントのカスタム・プロパティーを指定します。 カスタム・プロパティーがない場合、 この引数には一組の二重引用符 ("") を使用します。
endpoint_ports
カタログ・サービス・ドメイン・エンドポイントのポート番号を指定します。エンドポイントは 、<client_port>,<listener_port> の順序で指定する必要があります。
クライアント・ポート
カタログ・サービス・ドメイン内のカタログ・サーバー間の通信に使用するポートを指定します。この値は 、WebSphere Application Server プロセスのみで稼働するカタログ・サーバーに必要で、 他で使用されていないどのポートにも設定できます。
リスナー・ポート
クライアントとの通信に使用するポートを指定します。 この値はリモート・エンドポイントに必要で、 カタログ・サービスが開始されたときに使用された値と一致している必要があります。リスナー・ポートは、 カタログ・サービスとの通信のために、クライアントおよびコンテナーによって使用されます。
WebSphere eXtreme Scale のリモート・エンドポイントの場合: コンテナーおよびクライアントがオブジェクト・リクエスト・ブローカー (ORB) を介して カタログ・サービスと通信するための ORB リスナー・ポートを定義します。WebSphere Application Server エンドポイントの場合、 値が BOOTSTRAP_ADDRESS ポート構成から継承されるため、リスナー・ポート値の指定はオプションです。
表 7. removeEndpoints ステップ引数
引数 説明
name_of_endpoint 削除するカタログ・サービス・エンドポイントの名前を指定します。
表 8. configureClientSecurity ステップ引数
引数 説明
-securityEnabled カタログ・サーバーのクライアント・セキュリティーが使用可能なことを 指定します。選択したカタログ・サーバーに関連付けられたサーバー・プロパティー・ファイルには、 一致する securityEnabled 設定が なければなりません。これらの設定が一致しない場合、例外が発生します。(ブール値: true または false に設定)
-credentialAuthentication (オプション) 資格情報の認証を実施するか、またはサポートするかを示します。
常になし

クライアント証明書認証は実施されません。

必須
資格情報の認証は必ず実施されます。サーバーが資格情報の認証をサポートしない場合、クライアントは サーバーに接続できません。
サポートされる
(デフォルト) 資格情報の認証は、クライアントとサーバーの両方が資格情報の認証を サポートする場合のみ実施されます。
-authenticationRetryCount (オプション) 資格情報の有効期限が切れている場合に認証を 再試行できる回数を指定します。

認証の再試行を望まない場合は、値を 0 に設定します。 デフォルト値は 0 です。

-credentialGeneratorClass クライアントがスレッドからセキュリティー・トークンを 取得するよう、com.ibm.websphere.objectgrid.security.plugins.builtins. WSTokenCredentialGenerator 実装クラスを指示します。
-credentialGeneratorProps CredentialGenerator 実装クラスの プロパティーを指定します。プロパティーは、setProperties(String) メソッドを使用してオブジェクトに送信されます。 資格情報生成プログラムのプロパティー値は、「資格情報生成プログラム・クラス」フィールドに 値が指定されている場合のみ使用されます。

戻り値:

バッチ・モードの使用例
  • Jacl を使用:
    $AdminTask modifyXSDomain {-name TestDomain -default true -modifyEndpoints 
    {{xhost1.ibm.com "" ,2809}} -addEndpoints {{xhost2.ibm.com "" ,2809}}} 
    -removeEndpoints {{xhost3.ibm.com}}}
  • Jython ストリングを使用:
    AdminTask.modifyXSDomain('[-name TestDomain  
    -default false -modifyEndpoints [[xhost1.ibm.com "" ,2809]] 
    -addEndpoints [[xhost3.ibm.com "" ,2809]] 
    -removeEndpoints [[xhost2.ibm.com]]]')
  • 変更コマンドでのクライアント・セキュリティー仕様の使用:
    $AdminTask modifyXSDomain {-name myDomain -default false 
    -configureClientSecurity {-securityEnabled true - 
    Supported -authenticationRetryCount 1 -credentialGeneratorClass 
    com.ibm.websphere.objectgrid.security.plugins.builtins.UserPasswordCredentialGenerator
     -credentialGeneratorProps "manager manager1"}}
対話モードの使用例
  • Jacl を使用:
    $AdminTask modifyXSDomain {-interactive}
  • Jython ストリングを使用:
    AdminTask.modifyXSDomain ('[-interactive]')

testXSDomainConnection

testXSDomainConnection コマンドは、カタログ・サービス・ドメインへの接続をテストします。

必須パラメーター:
-name
接続をテストするカタログ・サービス・ドメインの名前を指定します。
オプション・パラメーター
-timeout
接続されるまで待機する最大時間を秒数で指定します。

戻り値: 接続できた場合、true が返されます。接続できなかった場合は、接続エラー情報が返されます。

バッチ・モードの使用例
  • Jacl を使用:
    $Admintask testXSDomainConnection
  • Jython ストリングを使用:
    AdminTask.testXSDomainConnection
対話モードの使用例
  • Jacl を使用:
    $AdminTask testXSDomainConnection {-interactive}
  • Jython ストリングを使用:
    AdminTask.testXSDomainConnection ('[-interactive]')

testXSServerConnection

testXSServerConnection コマンドは、カタログ・サーバーへの接続をテストします。 このコマンドは、スタンドアロン・サーバーと、カタログ・サービス・ドメインに属するサーバーの両方で機能します。

必須パラメーター:
ホスト (host)
カタログ・サーバーが存在するホストを指定します。
listenerPort
カタログ・サーバーのリスナー・ポートを指定します。
オプション・パラメーター
timeout
カタログ・サーバーに接続されるまで待機する最大時間を秒数で指定します。
domain
カタログ・サービス・ドメインの名前を指定します。このパラメーターの値を定義した場合は、 指定されたカタログ・サービス・ドメインのクライアント・セキュリティー・プロパティーを使用して 接続がテストされます。 そうでなければ、指定されたホストとリスナー・ポートのカタログ・サービス・ドメインを 見つけるために検索が実行されます。カタログ・サービス・ドメインが見つかった場合は、その カタログ・サービス・ドメインに定義されているクライアント・セキュリティー・プロパティーを使用して サーバーがテストされます。そうでなければ、テスト時にクライアント・セキュリティー・プロパティーは 使用されません。

戻り値:

バッチ・モードの使用例
  • Jacl を使用:
    $Admintask testXSServerConnection {-host xhost1.ibm.com -listenerPort 2809}
  • Jython ストリングを使用:
    AdminTask.testXSServerConnection('[-host xshost3.ibm.com -listenerPort 2809]')
対話モードの使用例
  • Jacl を使用:
    $AdminTask testXSServerConnection {-interactive}
  • Jython ストリングを使用:
    AdminTask.testXSServerConnection ('[-interactive]')