Cosminexus アプリケーションサーバ V8 リファレンス 定義編(サーバ定義)

[目次][索引][前へ][次へ]

4.10.1 J2EEアプリケーションを実行するシステムで指定できるタグ

ここでは,J2EEアプリケーションを実行するシステムで指定できるタグについて説明します。

<この項の構成>
(1) Webシステムの属性定義
(2) 負荷分散機の定義
(3) 物理ティアの定義
(4) サービスユニットの定義
(5) ホストの定義

(1) Webシステムの属性定義

Webシステムの属性として定義できる内容を次の表に示します。

タグ名称 内容 簡易構築定義ファイル 構成定義変更ファイル デフォルト
P U
web-system Webシステムを定義します。
複数のWebシステムを定義する場合は,<web-system>タグを複数指定します。
※1 ※2 なし
name Webシステムを識別するための名称を32文字以下で指定します。運用管理ドメイン内でユニークな名称を指定する必要があります。Smart Composer機能のコマンドの-sオプションには,ここで指定した名称を指定します。指定できる文字は,英数字,アンダースコア「_」,ハイフン「-」の組み合わせです。 なし
addition-mode 追加モードを指定します。
  • DEPLOYED※3
    JP1/SC/DPMを使用してディスクイメージのスケールアウトをする場合に指定します。この指定によって,システム構築時のJ2EEアプリケーションおよびリソースアダプタでのデプロイが不要になります。
  • NORMAL
    通常のスケールアウトの場合に指定します。
NORMAL
display-name Webシステムの表示名を128文字以下で指定します。指定する文字に制限はありません。 なし
description Webシステムのコメントを1,024文字以下で指定します。指定する文字に制限はありません。 なし

(凡例)
P:論理サーバのパラメタ変更用の構成定義変更ファイルを示します。
U:サービスユニット・ホスト追加用の構成定義変更ファイルを示します。
◎:Webシステムを定義する場合は,必ず指定します。
△:省略できます。
−:該当しません。

注※1
Smart Composer機能で定義済みのWebシステムを利用する場合は省略できます。

注※2
サービスユニットを追加しない場合は省略できます。

注※3
この設定を有効にする場合,Smart Composer機能のコマンドを使用したインポートと一括開始をしておく必要があります。詳細については,マニュアル「Cosminexus アプリケーションサーバ システム構築・運用ガイド」の「8.9 システムの一括起動(サービスユニットの開始)」を参照してください。

 

(2) 負荷分散機の定義

負荷分散機の定義は,<load-balancer>以下のタグで定義します。定義できる内容を次の表に示します。

タグ名称 内容 簡易構築定義ファイル 構成定義変更ファイル デフォルト
P U
load-balancer 負荷分散機を定義します。
Smart Composer機能で負荷分散機の設定,および実サーバポートの開始・閉塞をしない場合は,負荷分散機の定義(<load-balancer>タグから</load-balancer>タグまで)は必要ありません。
なし
name 負荷分散機の名称を32文字以下で指定します。指定できる文字は,英数字,アンダースコア「_」,ハイフン「-」の組み合わせです。 なし
load-balancer-type 負荷分散機の種類を次のどれかで指定します。
  • BIG-IPv9
  • BIG-IPv10.1
  • BIG-IPv10.2
  • ACOS
Smart Composer機能で負荷分散機の設定をする場合は,必ず指定してください。
なし
display-name 負荷分散機の表示名を128文字以下で指定します。指定する文字に制限はありません。 なし
description 負荷分散機のコメントを1,024文字以下で指定します。指定する文字に制限はありません。 なし
cookie-switching Cookieスイッチング機能を使用する場合に定義します。
この設定によって,一連のHTTPリクエストが一つのWebサーバまたはJ2EEサーバで処理されます。
なし
cookie-switching-enabled Cookieスイッチング機能を使用する場合はtrueを,使用しない場合はfalseを指定します。 false
cookie-name cookieの名称を指定します。指定できる文字は,英数字,アンダースコア「_」の組み合わせです。ただし,次の名前はWebコンテナが使用するため,大文字・小文字の区別なく使用できません。
  • JSESSIONID

BIG-IPの場合,1〜64文字の文字列で指定します。なお,先頭1文字は大文字または小文字の英字を指定する必要があります。
ACOSの場合,1〜63文字の文字列で指定します。
CMX_SERVER_ID
server-id-rule 08-53以降は,このタグに値を指定しないでください。値を指定した場合,指定された値は無効になります。 なし
management-host 負荷分散機に設定した管理IPアドレスまたはホスト名を指定します。管理IPアドレスはドット記法(xxx.xxx.xxx.xxx)で指定します。xxxには0〜255の整数を指定します。ホスト名に指定できる文字は,英数字,アンダースコア「_」,ハイフン「-」の組み合わせです。
複数のWebシステムで負荷分散機を共有する場合は,共有するWebシステムで同じ管理IPアドレスまたはホスト名を指定してください。
なし
redundant-management-host 負荷分散機を冗長化したシステムの場合に,2台目の負荷分散機に設定した管理IPアドレスまたはホスト名を指定します。管理IPアドレスはドット記法(xxx.xxx.xxx.xxx)で指定します。xxxには0〜255の整数を指定します。ホスト名に指定できる文字は,英数字,アンダースコア「_」,ハイフン「-」の組み合わせです。
複数のWebシステムで負荷分散機を共有する場合は,共有するWebシステムで同じ管理IPアドレスまたはホスト名を指定してください。
なし
virtual-server 仮想サーバを定義します。 なし
virtual-server-name 仮想サーバ名を1〜31文字で指定します。指定できる文字は,英数字,アンダースコア「_」,ハイフン「-」,ピリオド「.」の組み合わせです。
複数のWebシステムで負荷分散機を共有する場合は,共有するWebシステムで仮想サーバ名が重複しないように指定してください。
なし
display-name 仮想サーバの表示名を指定します。 なし
description 仮想サーバのコメントを指定します。 なし
ip-address 仮想サーバのIPアドレスを指定します。
複数のWebシステムで負荷分散機を共有する場合は,共有するWebシステムで仮想サーバのIPアドレスが重複しないように指定してください。
なし
http-port 仮想サーバのhttpポート番号を1〜65535の間で指定します。
BIG-IP v9,ACOSの場合で,複数のWebシステムで負荷分散機を共有するときは,共有するWebシステムで仮想サーバのhttpポート番号が重複しないように指定してください。
なし

(凡例)
P:論理サーバのパラメタ変更用の構成定義変更ファイルを示します。
U:サービスユニット・ホスト追加用の構成定義変更ファイルを示します。
◎:負荷分散機を定義する場合は,必ず指定します。
△:省略できます。
−:該当しません。

注※
負荷分散機のCookieスイッチング機能を使用しない場合は省略できます。

(3) 物理ティアの定義

構築するシステムの構成に合わせて,物理ティアを定義します。物理ティアは<tier>以下のタグで定義します。定義できる内容を次の表に示します。

タグ名称 内容 簡易構築定義ファイル 構成定義変更ファイル デフォルト
P U
tier 物理ティアを定義します。
物理ティアには,combined-tier,http-tier,j2ee-tier,sfo-tier,ctm-tier,およびfree-tierの6種類があります。それぞれの物理ティアは,単独,または複数を組み合わせて,Webシステムを構成します。
指定できる物理ティアの構成を次に示します。
  • combined-tier構成
  • http-tierとj2ee-tierの構成
  • j2ee-tier構成
  • combined-tierにsfo-tierを組み合わせた構成
  • http-tierとj2ee-tierにsfo-tierを組み合わせた構成
  • ctm-tier構成
  • free-tier構成

combined-tier構成の場合
サービスユニット内のWebサーバとJ2EEサーバを1ホストで構成し,一つの<tier>タグで定義します。

http-tierとj2ee-tierの構成の場合
サービスユニット内のWebサーバとJ2EEサーバを別々のホストで構成し,二つの<tier>タグで定義します。

j2ee-tierの構成の場合
サービスユニット内のJ2EEサーバを1ホストで構成し,一つの<tier>タグで定義します。j2ee-tier構成を使用する場合は,インプロセスHTTPサーバ機能を有効に設定しておく必要があります。

combined-tierまたはhttp-tierとj2ee-tierに組み合わせて構成するsfo-tierの場合
サービスユニット内のセッションフェイルオーバサーバ(SFOサーバ)を1ホストで構成し,一つの<tier>タグで定義します。

ctm-tier構成の場合
ctm-tierは,combined-tier,http-tier,j2ee-tier,sfo-tierを定義するWebシステムとは別のWebシステムで定義します。ctm-tierは,統合ネーミングスケジューラサーバ用およびCTM用のWebシステムに分けて,それぞれ定義します。
  • 統合ネーミングスケジューラサーバ用のWebシステム
    サービスユニット内のCTM関連の論理サーバ※1を1ホストで構成し,一つの<tier>タグで定義します。
  • CTM用のWebシステム
    サービスユニット内のCTM関連の論理サーバ※1とJ2EEサーバを1ホストで構成し,一つの<tier>タグで定義します。

free-tier構成の場合
ほかのどの物理ティアの定義にも当てはまらない構成が,一つの<tier>タグで定義されます。
※2 なし
tier-type 物理ティアの種類を次のどれかで指定します。
  • combined-tier
  • http-tier
  • j2ee-tier
  • sfo-tier
  • ctm-tier
  • free-tier
なし
j2ee-server-count <tier-type>タグでctm-tierを指定した場合に,1ホストに配置するJ2EEサーバの数を0〜32の整数で指定します。
  • 統合ネーミングスケジューラサーバ用のWebシステムの場合
    0を指定します。
  • CTM用のWebシステムの場合
    Webシステムごとに,1ホスト内に配置するJ2EEサーバの数を指定します。
なお,Webシステムの構成変更時,J2EEサーバの数は変更できません。
1
configuration 物理ティアに属するすべての論理サーバに適用するコンフィグレーションを,論理サーバの種類ごとに定義します。例えば,WebサーバとJ2EEサーバの二つのコンフィグレーションを定義する場合は,<configuration>タグを二つ定義し,一つをWebサーバ用,もう一つをJ2EEサーバ用として定義します。 ※3 ※4 なし
logical-server-type コンフィグレーションを定義する論理サーバの種類を指定します。指定できる論理サーバの種類を次に示します。
  • web-server:Webサーバ
  • j2ee-server:J2EEサーバ
  • sfo-server:セッションフェイルオーバサーバ(SFOサーバ)
  • performance-tracer:パフォーマンストレーサ
  • ctm-domain-manager:CTMドメインマネジャ
  • component-transaction-monitor:CTM
  • smart-agent:スマートエージェント
物理ティアの種類によって,コンフィグレーションが定義できる論理サーバが異なります。

combined-tierの場合
Webサーバ,J2EEサーバとパフォーマンストレーサ

http-tierの場合
Webサーバとパフォーマンストレーサ

j2ee-tierの場合
J2EEサーバとパフォーマンストレーサ

sfo-tierの場合
セッションフェイルオーバサーバ(SFOサーバ)とパフォーマンストレーサ

ctm-tierの場合
Webシステムごとに定義できる論理サーバが異なります。
  • 統合ネーミングスケジューラサーバ用のWebシステムの場合
    CTMドメインマネジャ,CTM,スマートエージェントとパフォーマンストレーサ
  • CTM用のWebシステムの場合
    CTMドメインマネジャ,CTM,スマートエージェント,J2EEサーバとパフォーマンストレーサ
なし
server-no 物理ティア内の特定のJ2EEサーバで,共通のコンフィグレーションを指定する場合に,J2EEサーバを識別するための番号を指定します。指定できる範囲は,1〜<j2ee-server-count>の指定値です。物理ティア内で番号が重複しないように指定してください。このタグは,<tier-type>タグでctm-tierを指定して,<j2ee-server-count>タグを指定した場合にだけ指定できます。
物理ティア内のすべてのJ2EEサーバで,共通のコンフィグレーションを指定する場合は,このタグを指定する必要はありません。
なし
param※5 論理サーバの環境を設定するパラメタを,パラメタ名と値で定義します。1種類のパラメタごとに<param>タグで囲んで定義します。 なし
param-name※5 論理サーバの環境を設定するパラメタの名称を指定します。 なし
param-value※5 <param-name>タグで指定したパラメタへの設定値を指定します。パラメタによっては,複数の値を設定する場合,<param-value>タグを複数指定します。 ※6 なし

(凡例)
P:論理サーバのパラメタ変更用の構成定義変更ファイルを示します。
U:サービスユニット・ホスト追加用の構成定義変更ファイルを示します。
◎:Webシステムを定義する場合は,必ず指定します。
△:省略できます。
−:該当しません。

物理ティアの定義では,ユーザサーバ,およびfree-tier構成に含まれる論理サーバのコンフィグレーションが設定できません。これらの論理サーバのコンフィグレーションはユニットの定義で設定してください。

注※1
CTM関連の論理サーバには,CTMドメインマネジャ,CTMおよびスマートエージェントがあります。

注※2
物理ティアの定義を変更しない場合は省略できます。

注※3
Management Serverが論理サーバ作成時に仮定する,環境設定値で運用する場合は省略できます。

注※4
cmx_trans_paramコマンドを使用して,抽象パラメタを展開して物理ティアのコンフィグレーションを生成する場合は省略できます。

注※5
<param>タグに指定できるパラメタは論理サーバの種類によって異なります。また,定義する論理サーバはシステムの構成パターンによって異なります。「4.11 システムの構成パターンと定義する論理サーバ」を参照して,定義する論理サーバを確認してください。それぞれの論理サーバに設定できるパラメタについては,使用する論理サーバの種類に応じて4.12以降の節を参照してください。

注※6
<param-name>タグで指定したパラメタを削除する場合は省略できます。

(4) サービスユニットの定義

サービスユニットは<unit>以下のタグに定義します。定義できる内容を次の表に示します。

タグ名称 内容 簡易構築定義ファイル 構成定義変更ファイル デフォルト
P U
unit サービスユニットを定義します。
複数のサービスユニットを定義する場合は,<unit>タグを複数指定します。
※1 なし
name サービスユニットを識別するための名称を32文字以下で指定します。Webシステム内でユニークな名称を指定する必要があります。Smart Composer機能のコマンドの-unitオプションには,ここで指定した名称を指定します。指定できる文字は,英数字,アンダースコア「_」,ハイフン「-」の組み合わせです。 ※2 なし
display-name サービスユニットの表示名を128文字以下で指定します。指定する文字に制限はありません。 なし
description サービスユニットのコメントを1,024文字以下で指定します。指定する文字に制限はありません。 なし
allocated-host サービスユニットを構成するホストのリファレンスを定義します。<allocated-host>タグは一つだけ指定します。free-tier構成のWebシステムでは,<allocated-host>タグを複数指定できます。 なし
host-ref ホスト定義の<name>タグに指定したホスト名,構築済みのWebシステムで定義されているホスト名,または@myhostを指定します。
@myhostを指定していると,システム構築時に,ホストの定義の<host-name>タグの値が自動で設定されます。
なお,複数ホストがある場合,一つのサービスユニット内で同じホストを共有することはできません。
なし
hosts-for <host-ref>タグで指定したホストが属する物理ティアの種類を,次のどれかで指定します。
  • combined-tier
  • http-tier
  • j2ee-tier
  • sfo-tier
  • ctm-tier
  • free-tier
なし
define-server <hosts-for>タグで指定した物理ティアに属する論理サーバごとに,コンフィグレーションを定義します。例えば,<hosts-for>タグがhttp-tierの場合は,Webサーバ用と,パフォーマンストレーサ用にそれぞれ一つずつ論理サーバを定義できます。複数の論理サーバを定義する場合は,<define-server>タグを複数指定します。 ※3 ※3 なし
logical-server-name 論理サーバまたはクラスタを識別するための名称を128文字以下で指定します。Smart Composer機能のコマンドの-sオプションには,ここで指定した名称を指定します。指定できる文字は,英数字,アンダースコア「_」,ハイフン「-」の組み合わせです。 cmx_<Webシステム名>_<サービスユニット名>_<種別>_<通番>
display-name 論理サーバの表示名を128文字以下で指定します。指定する文字に制限はありません。 なし
description 論理サーバのコメントを1,024文字以下で指定します。指定する文字に制限はありません。 なし
logical-server-type コンフィグレーションを定義する論理サーバの種類を指定します。指定できる論理サーバの種類を次に示します。
  • web-server:Webサーバ
  • j2ee-server:J2EEサーバ
  • sfo-server:セッションフェイルオーバサーバ(SFOサーバ)
  • performance-tracer:パフォーマンストレーサ
  • ctm-domain-manager:CTMドメインマネジャ
  • component-transaction-monitor:CTM
  • smart-agent:スマートエージェント
  • naming-service:ネーミングサービス
  • user-server:ユーザサーバ
ホストが属する物理ティアの種類によって,コンフィグレーションが定義できる論理サーバが異なります。

combined-tierの場合
Webサーバ,J2EEサーバ,パフォーマンストレーサとユーザサーバ

http-tierの場合
Webサーバ,パフォーマンストレーサとユーザサーバ

j2ee-tierの場合
J2EEサーバ,パフォーマンストレーサとユーザサーバ

sfo-tierの場合
セッションフェイルオーバサーバ(SFOサーバ),パフォーマンストレーサとユーザサーバ

ctm-tierの場合
Webシステムごとに定義できる論理サーバが異なります。
  • 統合ネーミングスケジューラサーバ用のWebシステムの場合
    CTMドメインマネジャ,CTM,スマートエージェント,パフォーマンストレーサとユーザサーバ
  • CTM用のWebシステムの場合
    CTMドメインマネジャ,CTM,スマートエージェント,J2EEサーバ,パフォーマンストレーサとユーザサーバ

free-tierの場合
Webサーバ,J2EEサーバ,セッションフェイルオーバサーバ(SFOサーバ),CTMドメインマネジャ,CTM,スマートエージェント,ネーミングサービス,パフォーマンストレーサ,Webサーバクラスタ,J2EEサーバクラスタとユーザサーバ
なし
cluster-ref 論理サーバをクラスタのメンバにする場合に,クラスタ名を指定します。
クラスタのメンバにする論理サーバがJ2EEサーバの場合はJ2EEサーバクラスタ名を,Webサーバの場合はWebサーバクラスタ名を指定します。
J2EEサーバおよびWebサーバ以外の論理サーバは,クラスタのメンバとして設定できません。
free-tier構成の場合だけに定義されます。
× × なし
server-no サービスユニット内の特定のJ2EEサーバのコンフィグレーションを指定する場合に,J2EEサーバを識別するための番号を指定します。指定できる範囲は,1〜<j2ee-server-count>の指定値です。1ホスト内で番号が重複しないように指定してください。このタグは,物理ティアの定義で<j2ee-server-count>タグを指定した場合に,J2EEサーバのコンフィグレーションを指定するときは,必ず指定してください。 なし
configuration 論理サーバごとに適用するコンフィグレーションを定義します。
なお,物理ティアの定義で定義した環境設定値で運用する場合は,<configuration>タグの定義は不要です。
<logical-server-type>でJ2EEサーバクラスタまたはWebサーバクラスタを指定していた場合は指定できません。
なし
param※4 論理サーバの環境を設定するパラメタを,パラメタ名と値で定義します。1種類のパラメタごとに<param>タグで囲んで定義します。 なし
param-name※4 論理サーバの環境を設定するパラメタの名称を指定します。指定できるパラメタ名については,「4.11 システムの構成パターンと定義する論理サーバ」を参照してください。 なし
param-value※4 <param-name>タグで指定したパラメタへの設定値を指定します。パラメタによっては,複数の値を設定する場合,<param-value>タグを複数指定します。それぞれのパラメタの設定値については,「4.11 システムの構成パターンと定義する論理サーバ」を参照してください。 ※5 なし

(凡例)
P:論理サーバのパラメタ変更用の構成定義変更ファイルを示します。
U:サービスユニット・ホスト追加用の構成定義変更ファイルを示します。
◎:Webシステムを定義する場合は,必ず指定します。
△:省略できます。
−:該当しません。

構成変更定義ファイルには,free-tier構成に含まれる論理サーバのコンフィグレーションが設定できません。

注※1
サービスユニットの定義を変更しない場合は省略できます。

注※2
クライアント設定プロパティファイルまたはクライアント共通設定プロパティファイルにcmx.websystem.nameを指定している場合は省略できます。

注※3
論理サーバごとにコンフィグレーションを定義しない場合は省略できます。

注※4
<param>タグに指定できるパラメタは論理サーバの種類によって異なります。また,定義する論理サーバはシステムの構成パターンによって異なります。「4.11 システムの構成パターンと定義する論理サーバ」を参照して,定義する論理サーバを確認してください。それぞれの論理サーバに設定できるパラメタについては,使用する論理サーバの種類に応じて4.12以降の節を参照してください。

注※5
<param-name>タグで指定したパラメタを削除する場合は省略できます。

(5) ホストの定義

使用するホストの情報は<host>以下のタグに定義します。定義できる内容を次の表に示します。

タグ名称 内容 簡易構築定義ファイル 構成定義変更ファイル デフォルト
P U
host ホストを定義します。
複数のホストを定義する場合は,hostタグを複数指定します。ホストは複数のWebシステムで共有できます。
※1 ※2 なし
host-name ホストを識別するための名称またはIPアドレスを32文字以下で指定します。
ホスト名に指定できる文字は,英数字,アンダースコア「_」,ハイフン「-」の組み合わせです。管理IPアドレスはドット記法(xxx.xxx.xxx.xxx)で指定します。xxxには0〜255の整数を指定します。
IPアドレス変換できないホスト名を指定した場合,システム構築時にエラーとなります。
<host-name>タグには@myhostも指定できます。@myhostを指定すると,システム構築時に,構築先の環境の運用管理サーバマシンのホスト名に自動で置換されます。
なし
display-name ホストの表示名を128文字以下で指定します。指定する文字に制限はありません。 なし
description ホストのコメントを1,024文字以下で指定します。指定する文字に制限はありません。 なし
agent-host Cosminexus運用管理エージェントのホスト名,またはIPアドレスを指定します。ホスト名を指定する場合は,32文字以下で指定します。指定できる文字は,英数字,アンダースコア「_」,ハイフン「-」の組み合わせです。IPアドレスを指定する場合は,ドット記法(xxx.xxx.xxx.xxx)で指定します。xxxには0〜255の整数を指定します。
<agent-host>タグには@myhostも指定できます。@myhostを指定していると,システム構築時に,ホストの定義の<host-name>タグの値が自動で設定されます。
host-nameで指定した値
agent-port Cosminexus運用管理エージェントのポート番号を1〜65535の間で指定します。 20295

(凡例)
P:論理サーバのパラメタ変更用の構成定義変更ファイルを示します。
U:サービスユニット・ホスト追加用の構成定義変更ファイルを示します。
◎:ホストを定義する場合は,必ず指定します。
△:省略できます。
−:該当しません。

ユニットの定義の<host-ref>タグで@myhostを指定して,ホストの定義の<display-name>タグ,<description>タグ,<agent-host>タグ,または<agent-port>タグの値を省略している場合,ホストの定義は出力されません。この場合,ホストの定義の<host-name>タグの値は,Management Serverが必要に応じて自動生成します。Management Serverが自動作成するホスト名は,Windowsの場合はコンピュータ名,UNIXの場合は,hostnameコマンドで設定したホスト名です。ホストの中に論理サーバが一つも含まれなくなったとき,Management Serverが,そのホストを自動で削除します。

注※1
Smart Composer機能で定義済みのホストを利用する場合は省略できます。

注※2
ホストの定義を変更しない場合は省略できます。