2.6.4 create-cluster
Java EE Serverクラスターの作成
書式
asadmin [asadmin-options] create-cluster [--help] [--config config-name] [--systemproperties name=value[:name=value]...] [--properties name=value[:name=value]...] [--gmsenabled={true|false}] [--multicastport multicast-port] [--multicastaddress multicast-address] [--bindaddress bind-address] cluster-name
格納先
Application Serverインストールディレクトリー/javaee/glassfish/bin
機能
create-clusterサブコマンドは、Java EE Serverクラスターを作成します。
クラスターは、そのクラスターに追加するすべてのインスタンスの構成を定義する名前付き構成への参照を必要とします。
クラスターの構成がほかのクラスターやスタンドアロンのサーバインスタンスと共有されていないため、作成されるクラスターはスタンドアロンのクラスターです。
このサブコマンドはリモートモードだけサポートします。
前提条件
ドメイン管理サーバは、稼働状態である必要があります。
引数
- --help | -?
-
このサブコマンドのヘルプテキストを表示します。
- --config config-name
-
クラスターが参照する名前付き構成を指定します。--configオプションを指定して、共有クラスターを作成します。このオプションを省略した場合、スタンドアロンのクラスターが作成されます。
型:String
指定できる値を次に示します。
-
構成名
デフォルト値:なし
-
- --systemproperties name=value[:name=value]...
-
--systempropertiesオプションで任意の属性名と値のペアを指定できます。ここで設定したプロパティーはdefault-config構成の中の設定を上書きします。
指定形式は、name=valueです。複数指定する場合は、コロン(:)で区切ります。同じプロパティー名を複数指定した場合は、最後に指定したプロパティーの値が有効となります。
プロパティー名とvalueに指定できる値を次に示します。
ASADMIN_LISTENER_PORT=value
このプロパティーは、ドメイン管理サーバがインスタンスを管理する際に接続するHTTPまたはHTTPSポートのポート番号を指定します。
型:Integer
指定できる値を次に示します。
-
1〜65535
デフォルト値:なし
HTTP_LISTENER_PORT=value
このプロパティーは、HTTP要求をリッスンするのに使用するポートのポート番号を指定します。
型:Integer
指定できる値を次に示します。
-
1〜65535
デフォルト値:なし
HTTP_SSL_LISTENER_PORT=value
このプロパティーは、HTTPS要求をリッスンするのに使用するポートのポート番号を指定します。
型:Integer
指定できる値を次に示します。
-
1〜65535
デフォルト値:なし
IIOP_LISTENER_PORT=value
このプロパティーは、IIOP接続に使用するポートのポート番号を指定します。
型:Integer
指定できる値を次に示します。
-
1〜65535
デフォルト値:なし
IIOP_SSL_LISTENER_PORT=value
このプロパティーは、セキュアなIIOP接続に使用するポートのポート番号を指定します。
型:Integer
指定できる値を次に示します。
-
1〜65535
デフォルト値:なし
IIOP_SSL_MUTUALAUTH_PORT=value
このプロパティーは、クライアント認証を持つセキュアなIIOP接続に使用するポートのポート番号を指定します。
型:Integer
指定できる値を次に示します。
-
1〜65535
デフォルト値:なし
JAVA_DEBUGGER_PORT=value
このプロパティーは、Java Platform Debugger Architecture(JPDA)(http://java.sun.com/javase/technologies/core/toolsapis/jpda/)デバッガーへの接続に使用するポートのポート番号を指定します。
型:Integer
指定できる値を次に示します。
-
1〜65535
デフォルト値:なし
JMS_PROVIDER_PORT=value
このプロパティーは、JMSプロバイダーのポート番号を指定します。
型:Integer
指定できる値を次に示します。
-
1〜65535
デフォルト値:なし
JMX_SYSTEM_CONNECTOR_PORT=value
このプロパティーは、JMXコネクターがリッスンするポート番号を指定します。
型:Integer
指定できる値を次に示します。
-
1〜65535
デフォルト値:なし
-
- --properties name=value[:name=value]...
-
クラスターのプロパティーを定義します。
指定形式は、name=valueです。複数指定する場合は、コロン(:)で区切ります。同じプロパティー名を複数指定した場合は、最後に指定したプロパティーの値が有効となります。
プロパティー名とvalueに指定できる値を次に示します。
GMS_DISCOVERY_URI_LIST=value
クラスターを検出するために使用されるクラスター内のサーバインスタンスの場所を一覧表示します。このプロパティーは、メッセージをブロードキャストするためにグループ管理サービスでマルチキャストを使用しない場合にだけ必要です。
型:String
指定できる値を次に示します。
Uniform Resource Identifier(URI)のコンマ区切りリスト。各URIはサーバインスタンスまたはドメイン管理サーバを特定する必要があります。複数のサーバインスタンスが同じホストで実行されている場合は、この形式が必須です。
リスト内の各URIの形式は次のとおりです。
scheme://host-name-or -IP-address:port
-
schemeはURIのスキームで、tcpです。
-
host-name-or -IP-addressはインスタンスが実行されているホストのホスト名またはIPアドレスです。
-
portはインスタンスがグループ管理サービスからのメッセージをリッスンするポートのポート番号です。システムプロパティーGMS_LISTENER_PORT-cluster-nameをインスタンスに対して設定する必要があります。
ドメイン管理サーバまたはインスタンスが稼働しているホストのIPアドレスまたはホスト名のコンマ区切りリスト。リストには、IPアドレスとホスト名を混在させることができます。この形式は、クラスター化された1つのインスタンスが各ホストで実行されている場合にだけ使用できます。GMS_LISTENER_PORTプロパティーの値は、ドメイン内の各クラスターで一意である必要があります。
キーワードgenerate。この形式は、クラスター内の1つのインスタンスが各ホストで実行されていてドメイン管理サーバが別のホストで稼働している場合にだけ使用できます。同じホスト上の複数のインスタンスは、同じクラスターのメンバーにできません。GMS_LISTENER_PORTプロパティーの値は、ドメイン内の各クラスターで一意である必要があります。
デフォルト値:なし
GMS_LISTENER_PORT=value
クラスターがグループ管理サービスからのメッセージをリッスンするポートのポート番号を指定します。
デフォルト値はGMS_LISTENER_PORT-cluster-nameシステムプロパティーへの参照です。デフォルトでは、このシステムプロパティーは設定されていません。この状況では、グループ管理サービスはGMS_TCPSTARTPORTプロパティーおよびGMS_TCPENDPORTプロパティーで定義された範囲から空きポートを選びます。デフォルトでは、範囲は9090〜9200です。
メッセージをブロードキャストするためにグループ管理サービスでマルチキャストを使用しない場合、GMS_LISTENER_PORTプロパティーは、クラスター内のすべてのサーバインスタンスに対して有効なポート番号を指定する必要があります。
この要件を満たすデフォルト値を使用するには、システムプロパティーを使用してインスタンスごとに個別にポート番号を設定します。
例えば、create-system-propertiesサブコマンドを使用して、GMS_LISTENER_PORT-cluster-nameシステムプロパティーをドメイン管理サーバに対して作成します。次に、クラスター内の各インスタンスについて、GMS_LISTENER_PORT-cluster-nameシステムプロパティーを、そのインスタンスがグループ管理サービスからのメッセージをリッスンするポート番号に設定します。クラスターのGMS_LISTENER_PORTプロパティーのデフォルト値は、このシステムプロパティーを参照します。
型:Integer
指定できる値を次に示します。
-
1〜65535
デフォルト値:なし
GMS_LOOPBACK=value
インスタンスがクラスターにブロードキャストしたアプリケーションレベルのメッセージを、そのインスタンスが自身から受信できるかどうかを指定します。
型:Boolean
指定できる値を次に示します。
-
true
インスタンスは自身からメッセージを受信できます。インスタンスがクラスター内の唯一のインスタンスである場合に、インスタンスをテストするときに、この設定を使用します。
-
false
インスタンスは自身からメッセージを受信できません。
デフォルト値:false
GMS_MULTICAST_TIME_TO_LIVE=value
次のタイプのイベントのマルチキャストメッセージを反復処理または伝送する最大数を指定します。この数を超えるとメッセージは破棄されます。
-
グループの検出
-
メンバーのハートビート
-
メンバーシップの変更
ドメイン管理サーバおよびクラスター化されたインスタンスがデプロイされているネットワークの構成に一致させるには、この値をできる限り小さく設定します。システムに設定できる最小値を判定するには、validate-multicastサブコマンドを使用します。値に0を指定すると、マルチキャストメッセージはブロードキャスト元のホストから送信されません。
値に1を指定すると、スイッチまたはルーターで接続された同じサブネット上のホスト間でメッセージがブロードキャストされなくなる場合があります。
デフォルト値の4を指定すると、ホストがスイッチまたはルーターで接続されているネットワークのすべてのクラスター構成のインスタンスにメッセージが正常にブロードキャストされます。
型:Integer
指定できる値を次に示します。
-
0〜255
デフォルト値:4
GMS_TCPENDPORT=value
GMS_LISTENER_PORT-cluster-nameシステムプロパティーが設定されていない場合に、グループ管理サービスが空きポートを選択する範囲の最大のポート番号を指定します。
型:Integer
指定できる値を次に示します。
-
1〜65535
デフォルト値:9200
GMS_TCPSTARTPORT=value
GMS_LISTENER_PORT-cluster-nameシステムプロパティーが設定されていない場合に、グループ管理サービスが空きポートを選択する範囲の最小のポート番号を指定します。
型:Integer
指定できる値を次に示します。
-
1〜65535
デフォルト値:9090
-
- --gmsenabled={true|false}
-
グループ管理サービスがクラスターに有効であるかどうかを指定します。
型:Boolean
指定できる値を次に示します。
-
true
グループ管理サービスはクラスターに有効です。グループ管理サービスがクラスターに有効な場合、クラスターおよびドメイン管理サーバで、グループ管理サービスは各サーバインスタンスを始動します。ドメイン管理サーバは、このオプションがTrueに設定されている各クラスターに関与します。
-
false
グループ管理サービスはクラスターに無効です。
デフォルト値:true
-
- --multicastaddress multicast-address
-
グループ管理サービスがグループイベントをリッスンするアドレスを指定します。
型:String
指定できる値を次に示します。
-
224.0.0.0〜239.255.255.255
デフォルト値:228.9.XX.YY
ただし、XXおよびYYは、0〜255の範囲で自動生成される独立した値
-
- --multicastport multicast-port
-
グループ管理サービスがグループイベントをリッスンする通信ポートのポート番号を指定します。
型:Integer
指定できる値を次に示します。
-
2048〜49151
デフォルト値:指定範囲内で自動生成される値
-
- --bindaddress bind-address
-
グループ管理サービスがバインドするネットワークインターフェースのIPアドレスを指定します。
型:String
デフォルト値:すべてのパブリックネットワークインターフェースのIPアドレス
- cluster-name
-
クラスター名を指定します。
型:String
指定できる値を次に示します。
-
クラスター名
デフォルト値:なし
-
使用例
次の例では、クラスターを作成します。
asadmin create-cluster --systemproperties IIOP_SSL_LISTENER_PORT=1169 ltscluster
戻り値
戻り値 |
説明 |
---|---|
0 |
サブコマンドの実行に成功しました。 |
1 |
サブコマンドの実行中にエラーが発生しました。 |