名称
create-virtual-server - 名前付き仮想サーバーを作成します
形式
create-virtual-server [ --user admin_user ] [ --password
admin_password ] [ --host host_name ] [ --port port_number
] [ --protocol=rmi|jmxmp ] [ --passwordfile filename ] [
--encrypted=true|false ] [ --terse=true|false ] [ --
echo=true|false ] [ --interactive=true|false ] [ --
secure=true|false ] [ --legacy=true|false ] [ --help ] -
-hosts hosts [ --httplisteners http-listeners ] [ --
networklisteners network-listeners ] [ --defaultwebmodule
default-web-module ] [ --state={on|off} ] [ --logfile
log-file ] [ --property (name=value)[:name=value]* ] [ --
target target ] virtual-server-id
説明
create-virtual-serverサブコマンドは、名前付き仮想サーバー を
作成します。仮想化を行うことで、複数のホスト・アドレス上でリ
スニングしている単一のHTTPサーバー・プロセスによって、複数の
URLドメインを処理できるようになります。アプリケーションを2つ
の仮想サーバーで使用できる場合は、同じ物理リソース・プールを
共有します。このサブコマンドは、リモート・モードでのみサポー
トされています。
オプション
-u --user
ドメインの運用管理エージェントの管理ユーザ名。
既にotxadmin loginコマンドでログインしている場 合 は、
--userオプションの指定は不要です。
-w --password
ドメインの運用管理エージェントの管理ユーザのパ ス ワー
ド。
-H --host
ドメインの運用管理エージェントが起動しているマシン名。
-p --port
ドメインの運用管理エージェントのポート番号。既定 値 は
6212です。
--protocol
ドメインの運用管理エージェントとの接続プロトコルを選択
します。指定できるプロトコルは、rmi、jmxmpです。既定値
はrmiです。
-W --passwordfile
ドメインの運用管理エージェントのパスワードを含むファイ
ル。
--encrypted
ドメインの運用管理エージェントのパスワードに暗号化され
た パスワードを利用する場合に指定します。既定値はfalse
です。暗号化されたパスワードの生成にはencryptコマン ド
を 使 用してください。このオプションはpasswordfileオプ
ションが指定されている場合のみ有効です。
-t --terse
trueを指定すると、出力データがスクリプトによる処理のた
めの簡潔なデータとなります。既定値はfalseです。
-e --echo
trueを指定すると、標準出力でコマンドライン文が表示され
ます。既定値はfalseです。
-I --interactive
true(既定値)を指定すると、パスワードオプション入力用の
プロンプトを表示します。
-s --secure
trueを指定すると、ドメインの運用管理エージェントとの通
信にSSL/TLSを利用します。既定値はfalseです。
--legacy
trueを指定すると、コマンドの接続先のサーバがV8か、V9か
確認します。確認後V8であれば旧互換動作を行い、V9であれ
ばV9の動作を行います。falseの場合は接続先のサーバを 確
認せずにV9の動作を行います。既定値はfalseです。
--help
コマンドのヘルプを表示します。
--hosts
現在の仮想サーバーを選択するためにホスト・リクエ ス ト
・ヘッ ダー で 許可されている値のカンマ(,)区切りのリス
ト。同じ接続グループに対して構成された各仮想 サー バー
は、そのグループについて一意のホストを持つ必要がありま
す。
--httplisteners
HTTPリスナーIDのカンマ(,)区切りのリスト。デフォルト の
仮想サーバー以外の仮想サーバーでのみ必須です。HTTPリス
ナーはネットワーク・リスナーに変換されます。この オ プ
ションは下位互換性のために保持されていますが、使用は推
奨されません。かわりに、--networklistenersを使用してく
ださい。--networklistenersを使用した場合、このオプショ
ンは無視されます。
--networklisteners
ネットワーク・リスナーIDのカンマ(,)区切りのリスト。 デ
フォ ル トの仮想サーバー以外の仮想サーバーでのみ必須で
す。
--defaultwebmodule
デフォルトでこの仮想サーバーに関連付けられたスタンドア
ロンWebモジュール。
--state
仮想サーバーがアクティブ(on)か非アクティブ(off、無効 )
か を 指定します。デフォルトはonです。非アクティブの場
合、仮想サーバーはリクエストを処理しません。
--logfile
この仮想サーバーのログ・エントリが書き込まれるファイル
の名前。デフォルトではサーバー・ログです。アクセス・ロ
グが保存されるファイルおよびディレクトリは、サーバーの
実行に使用されるユーザー・アカウントにより書込み可能で
ある必要があります。
--property
仮想サーバーを構成するための属性名と値のペア(オプ ショ
ン)。次のプロパティが使用可能です:
sso-max-inactive-seconds: クライアントが活動を停止後、
何秒後にユーザーのシングル・サインオンの記録を削除可能
にするかを指定します。シングル・サインオンは同一 仮 想
サーバー上の複数のアプリケーションに適用されるので、こ
れらのアプリケーションのいずれかにアクセスすることでシ
ン グ ル・サインオンの記録は有効なまま確保されます。デ
フォルト値は300秒(5分)です。値を大きくするとユーザーの
シングル・サインオンの永続性は長くなりますが、サーバー
上のメモリー消費量も増加します。
sso-reap-interval-seconds: 有効期限が切れたシ ン グ ル
・サ イ ンオンの記録の削除を行う間隔を秒単位で指定しま
す。デフォルト値は60です。
setCacheControl: Cache-Controlレスポンス・ディレクティ
ブのカンマ区切りリストを指定します。有効なディレクティ
ブ の リ ス ト は、
http://www.ietf.org/rfc/rfc2616.txt(http://www.ietf.org/rfc/rfc2616.txt)
にあるドキュメントの第14.9項を参照してください。
allowLinking: このプロパティの値がtrueの場合、この仮想
サー バー 上 にデプロイされているすべてのWebアプリケー
ションに対し、シンボリック・リンクのリソースが提供され
ま す。個々のWebアプリケーションでこの設定をオーバーラ
イドするには、nec-web.xmlファイルのnec-web-app要素のプ
ロパティallowLinkingを使用します。
<nec-web-app>
<property name="allowLinking"
value="[true|false]"/>
</nec-web-app>
デフォルト値はtrueです。
accessLogWriteInterval: ログがディスクに書き込まれるま
での秒数を示します。アクセス・ログは、バッファがフルに
なるか、指定した時間が経過すると書き込まれます。値が0(
ゼ ロ)の場合、バッファがフルでなくても常に書き込まれま
す。つまり、サーバー・アクセスがあるたびに、ログ・メッ
セージはファイルに直接格納されます。
accessLogBufferSize: アクセス・ログの呼出しが格納さ れ
るバッファのサイズをバイト単位で指定します。
allowRemoteAddress: リモート・クライアントのIPアドレス
を比較する、正規表現パターンのカンマ区切りリストです。
このプロパティが指定されている場合、リクエストを受け入
れるためにはリモート・アドレスが一致している必要があり
ます。このプロパティが指定されていない場合、リ モー ト
・ア ドレスがdenyRemoteAddressパターンと一致していない
限り、すべてのリクエストが受け入れられます。このプロパ
ティのデフォルト値はnullです。
denyRemoteAddress: リモート・クライアントのIPアドレ ス
を比較する、正規表現パターンのカンマ区切りリストです。
このプロパティが指定されている場合、リクエストを受け入
れるためにはリモート・アドレスが一致していない必要があ
ります。このプロパティが指定されていない場合、リクエス
トの受入れはallowRemoteAddressプロパティのみで制御され
ます。このプロパティのデフォルト値はnullです。
allowRemoteHost: リモート・クライアント の ホ ス ト 名
(java.net.Socket.getInetAddress().getHostName() で返さ
れる)を比較する、正規表現パターンのカンマ区切りリス ト
です。このプロパティが指定されている場合、リクエストを
受け入れるためにはリモート・ホスト名が一致している必要
が あ ります。このプロパティが指定されていない場合、リ
モート・ホスト名がdenyRemoteHostパターンと一致していな
い限り、すべてのリクエストが受け入れられます。このプロ
パティのデフォルト値はnullです。
denyRemoteHost: リモート・クライアン ト の ホ ス ト 名
(java.net.Socket.getInetAddress().getHostName() で返さ
れる)を比較する、正規表現パターンのカンマ区切りリス ト
です。このプロパティが指定されている場合、リクエストを
受け入れるためにはリモート・ホスト名が一致していない必
要があります。このプロパティが指定されていない場合、リ
クエストの受入れはallowRemoteHostプロパティのみで制 御
されます。このプロパティのデフォルト値はnullです。
authRealm: auth-realmのname属性を指定します。これ は、
こ の 仮想サーバーにデプロイされているスタンドアロンの
Webアプリケーションについて、サーバー・インスタンス の
デフォルト・レルムをオーバーライドします。スタンドアロ
ンのWebアプリケーションのweb.xmlファイルに定義されてい
る レ ルムは、仮想サーバーのレルムをオーバーライドしま
す。
securePagesWithPragma: このプロパティをfalseに設定する
と、 こ の 仮想サーバー上のすべてのWebアプリケーション
で、SSLを使用したファイルのダウ ン ロー ド が Internet
Explorerで機能します。
alternatedocroot_n: 代替ドキュメント・ルート (docroot)
を 指定します。ここで、nは正の整数で複数の指定が可能に
なります。代替docrootにより、Webアプリケーションは特定
の リソースに対するそれぞれのdocroot以外からのリクエス
トに対応できます。これは、それらのリクエストがWebア プ
リケーションの代替docrootのURIパターンの1つ(または複数
)に一致するかに基づきます。
リクエストが代替docrootのURIパターンと一致する場合、リ
ク エストのURI(Webアプリケーションのコンテキスト・ルー
トをマイナスしたもの)を代替docrootの物理的な位置( ディ
レ ク ト リ ) に付加することによって、リクエストを代替
docrootにマップします。リクエストが複数のURIパターンに
一 致 す る場合、代替docrootは次の優先順位で判断されま
す。
・完全一致
・最長パス一致
・拡張一致
たとえば、次のプロパティは3つの代替docrootを指定 し ま
す。最初の代替docrootのURIパターンは完全一致を使用し、
2番目と3番目の代替docrootのURIパターンは拡張および最長
パス接頭辞一致をそれぞれ使用しています。
<property name="alternatedocroot_1"
value="from=/my.jpg dir=/srv/images/jpg"/>
<property name="alternatedocroot_2"
value="from=*.jpg dir=/srv/images/jpg"/>
<property name="alternatedocroot_3"
value="from=/jpg/* dir=/src/images"/>
各代替docrootのvalueには2つのコンポーネントが あ り ま
す。最初のコンポーネントのfromは代替docrootのURIパター
ンを指定し、2番目のコンポーネントのdirは代替docroot の
物 理的な位置(ディレクトリ)を指定します。dirコンポーネ
ントにはスペースが許容されています。
このプロパティは、特定のWebアプリケーションに対して 設
定できます。
send-error_n: 仮想サーバー上にデプロイされているすべて
の Webアプリケーションで継承する、仮想サーバーのカスタ
ム・エラー・ページのマッピングを指定します。Webアプ リ
ケー ションは、web.xmlデプロイメント記述子のこれらカス
タム・エラー・ページのマッピングをオーバーライドできま
す。 各send-error_nプロパティの値には3つのコンポーネン
トがあり、任意の順番で指定できます。
最初のコンポーネントのcodeは、レスポンスでカスタム・エ
ラー ・ペー ジ を返す必要がある3桁のHTTPレスポンス・ス
テータス・コードを指定します。
2番目のコンポーネントのpathは、カスタム・エラー ・ペー
ジの絶対、または相対ファイル・システム・パスを指定しま
す。相対ファイル・システム・パスは、 domain-dir/config
ディレクトリに相対的なものとして解釈されます。
3番目のコンポーネントのreasonはオプションで、返され る
理 由文字列のテキスト(UnauthorizedまたはForbidden)を指
定します。
例:
<property name="send-error_1" value="code=401
path=/myhost/401.html reason=MY-401-REASON"/>
この例のプロパティ定義では、/myhost/401.htmlの内 容 が
401 レスポンスで返されるとともに、HTTP/1.1 401 MY-401-
REASON が返されます。
redirect_n: 古いURLに対するリクエストを新しいURLに対す
るリクエストとして処理するように指定します。これらのプ
ロパティは、仮想サーバー上にデプロイされているすべての
Web アプリケーションで継承されます。各redirect_nプロパ
ティの値には2つのコンポーネントがあり、任意の順番で 指
定できます。
最初のコンポーネントのfromは、照合するリクエストされた
URIの接頭辞を指定します。
2番目のコンポーネントのurl-prefixはクライアントに返 す
新しいURL接頭辞を指定します。from接頭辞は、このURL接頭
辞で単純に置き換えられます。
例:
<property name="redirect_1"
value="from=/dummy url-prefix=http://etude"/>
valve_n: カスタム値の完全修飾クラス名を指定します。nは
正の整数で、複数の指定が可能です。
listener_n: カスタムCatalinaリスナーの完全修飾クラス名
を 指定します。nは正の整数で、複数の指定が可能です。リ
ス ナー ・ク ラ ス は、
org.apache.catalina.ContainerListener ま た は
org.apache.catalina.LifecycleListenerインタフェース を
実装する必要があります。
docroot: サーバーのルート・ドキュメント・ディレクト リ
へ の絶対パス。非推奨。virtual-server属性のdocrootに置
き換えられました。
accesslog: サーバー・アクセス・ログへの絶対パス。非 推
奨。 virtual-server 属性のaccess-logに置き換えられまし
た。
accessLoggingEnabled: trueの場合、この仮想サーバーに対
す る ア ク セ ス ・ロギングが有効になります。非推奨。
virtual-server属性のaccess-logging-enabledに置き換えら
れました。
sso-enabled: trueの場合、この仮想サーバー上の同じレ ル
ム で構成されたWebアプリケーションに対してシングル・サ
インオンが有効になります。非推奨。virtual-server属性の
sso-enabledに置き換えられました。
ssoCookieSecure: この仮想サーバーにデプロイされたWebア
プ リケーションに関連付けられた、JSESSIONIDSSOクッキー
のSecure属性を設定します。非推奨。virtual-server属性の
sso-cookie-secureに置き換えられました。
errorReportValve: この仮想サーバー上で、アプリケーショ
ンのデフォルトのエラー・ページを生成するカスタム値の完
全修飾クラス名を指定します。この仮想サーバーのデフォル
トのエラー・ページ・メカニズムを無効にするには、空の文
字列を指定します。
--target
指定したターゲットにのみ仮想サーバーを作成します。有効
な値は次のとおりです:
server: デフォルトのサーバー・インスタンスに仮 想 サー
バーを作成します。この値がデフォルト値です。
configuration-name: 指定した構成の仮想サーバーを作成し
ます。
オペランド
virtual-server-id
作成される仮想サーバーの一意のIDを識別します。このIDの
最初の文字に数字は使用できません。
使用例
例1: create-virtual-serverの使用法
otxadmin> create-virtual-server --hosts pigeon,localhost --property authRealm=ldap sampleServer
Command create-virtual-server executed successfully
sampleServerという名前の仮想サーバーを作成します。
終了ステータス
0 コマンド実行成功
1 コマンド実行失敗
関連事項
delete-virtual-server(1) list-virtual-servers(1) create-http-listener(1) create-network-listener(1) get(1) list(1) set(1)