| Sun ONE Web Server 6.1 管理者ガイド |
付録 A
コマンド行ユーティリティこの付録では、HttpServerAdmin コマンド行ユーティリティの使用方法について説明します。
HttpServerAdmin (仮想サーバーの管理)HttpServerAdmin は、サーバーマネージャとクラスマネージャでの仮想サーバーのユーザーインタフェースと同じ管理機能を実行するコマンド行ユーティリティです。コマンド行インタフェースを使用して仮想サーバーを設定する場合は、HttpServerAdmin を使用します。
The HttpServerAdmin コマンド行ユーティリティは、server_root/bin/https/httpadmin/bin ディレクトリにあります。
HttpServerAdmin を実行するには、使用している環境でサーバーのルートディレクトリに環境変数 IWS_SERVER_HOME を設定する必要があります。
たとえば、UNIX/Linux システムでは、次のように設定します。
setenv IWS_SERVER_HOME /usr/sun/servers
Windows の場合は、次のようにして設定します。
HttpServerAdmin の構文
HttpServerAdmin の構文を以下に示します。
HttpServerAdmin command_name command_options -d server_root -sinst http_instance
次のコマンドを入力すると、コマンドパラメータのオンラインヘルプを参照できます。
./HttpServerAdmin -h
command_name パラメータとして使用可能な 4 つの値は、次のとおりです。
各コマンドには、独自のコマンドオプションのセットがあります。詳細については、この章の各コマンドについて説明している節を参照してください。
コマンドパラメータの値に関わらず、表 A-1 に示されるパラメータは、HttpServerAdmin コマンドのすべての使用に適用できます。
表 A-1 HttpServerAdmin パラメータ
パラメータ
値
-d server_root
(必須) このパラメータはサーバールート (サーバーがインストールされている場所) へのパスを指定する
-sinst http_instance
(必須) このパラメータは、HttpServerAdmin によって影響を受けるインスタンスを指定する
control コマンド
control コマンドを使用して、クラスと仮想サーバーの開始、停止、無効化を実行します。仮想サーバーを指定しない場合、クラス内のすべての仮想サーバーに対してコマンドの開始、停止、または無効化を行います。
オプション
表 A-2 に示すオプションとともに control コマンドを使用すると、クラスと仮想サーバーを制御できます。
構文
HttpServerAdmin control -cl classname, -control_option [-id virtual_server] -d server_root -sinst http_instance
パラメータ
これらのパラメータをコマンドオプションとともに使用して、仮想サーバーを制御します。
表 A-3 control コマンドのパラメータ
パラメータ
値
-cl classname
仮想サーバークラスを指定する
-id virtual_server
(オプション) 制御している仮想サーバーの IDを指定する
例
create コマンド
create コマンドを使用して、仮想サーバーのクラス、仮想サーバー、および待機ソケットを作成します。
オプション
表 A-4 に示すオプションとともに create コマンドを使用すると、クラス、待機ソケット、仮想サーバー、リソースを作成できます。
オプションにはそれぞれパラメータがあります。次の節で各パラメータについて説明します。
仮想サーバークラスの作成
create コマンドのこのオプションを使用して、仮想サーバークラスを作成します。
構文
HttpServerAdmin create -c -cl classname -docroot document_root [-obj obj.conf_file] [-acptlang accept_language] -d server_root -sinst http_instance
パラメータ
表 A-5 に示すパラメータを create -c コマンドオプションとともに使用し、クラスを作成します。
表 A-5 仮想サーバークラス作成のパラメータ
パラメータ
値
-cl classname
作成するクラス名
-docroot document_root
クラスのドキュメントルート。これは絶対パスにする必要がある
-obj obj.conf_file
(オプション) クラスの obj.conf ファイル。このパラメータを指定しない場合、サーバーは classname.obj.conf という名前で obj.conf ファイルを作成する。クラスの obj.conf ファイルに別の名前を付ける場合は、ここで指定する
-acptlang accept_language
(オプション) このパラメータを指定しない場合、acptlang はデフォルトでオフになる
例
待機ソケットの作成
create コマンドのこのオプションを使用して、待機ソケットを作成します。
構文
HttpServerAdmin create -l -ip ip_address -port port_number -sname server_name -id default_virtual_server [-sec security] [-acct number_of_accept_threads] -d server_root -sinst http_instance
パラメータ
表 A-6 に示すパラメータを create -l コマンドオプションとともに使用し、待機ソケットを作成します。
表 A-6 待機ソケット作成のパラメータ
パラメータ
値
-ip ip_address
待機ソケットの IP アドレス
-port port_number
待機ソケットのポート番号
-sname server_name
待機ソケットに関連付けるサーバー名
-id default_virtual_server
デフォルトの仮想サーバーの ID。待機ソケットを作成できるようにするには、この仮想サーバーがすでに存在することが必要
-acct number_of_accept_threads
(オプション) 待機ソケットの受け入れスレッド数
-sec on
(オプション) 指定されている場合は、待機ソケットに対するセキュリティを有効にするために使用する。指定されていない場合は、セキュリティが有効になっていない
例
HttpServerAdmin create -l -id ls3 -ip 0.0.0.0 -port 1333 -sname austen -defaultvs vs2 -sec on -acct 4 -d /export/carey/server6 -sinst https-austen.com
仮想サーバーの作成
create コマンドのこのオプションを使用して、仮想サーバーを作成します。
省略可能なパラメータの一部に値を指定しない場合、デフォルト値が使用されます。仮想サーバーが作成されたあと、いつでもデフォルト値を変更することができます。
構文
HttpServerAdmin create -v -id virtual_server -cl classname -urlh urlhosts [-state state][-docroot document_root] [-mime mime_types_file] [-aclid acl_ID] -d server_root -sinst http_instance
パラメータ
表 A-7 に示すパラメータを create -v コマンドオプションとともに使用し、仮想サーバーを作成します。
表 A-7 待機ソケット作成のパラメータ
パラメータ
値
-id virtual_server
作成する仮想サーバーの ID
-cl classname
仮想サーバーがメンバーとなるクラス
-urlh URL_hosts
仮想サーバーの URL ホスト。コンマで区切ることによって、複数の URL ホストを指定できる
-state state
(オプション) 有効な値は、「on」、「off」、および「disable」
-docroot document_root
(オプション) 仮想サーバーのドキュメントルートを指定する場合は、このパラメータを使用する。絶対パスを指定することが必要
-mime mime_types_file
(オプション) 仮想サーバーの MIME タイプのファイル名
-aclid acl_ID
(オプション) server.xml ファイルで使用される ACL ファイルの ID <ACLID>
例
HttpServerAdmin create -v -id vs3 -cl class1 -urlh annh -d /export/sun/server6 -sinst https-sun.com
HttpServerAdmin create -v -id vs4 -cl class1 -urlh annh,annh2 -state off -mime mime.types -d /export/sun/server6 -sinst https-sun.com
JDBC 接続プールの作成
create -r コマンドを使用して、コマンド行インタフェースから JDBC 接続プールを新規作成します。
構文
HttpServerAdmin -create -r -jdbcconnectionpool -poolname jdbcpoolname -classname classname [-steadypoolsize steadypoolsize] [-maxpoolsize maxpoolsize] [-poolresizequantity poolresizequantity] [-idletimeout idletimeout] [-maxwaittime maxwaittime] [-connectionvalidation true/false] [-connectionvalidationmethod connectionvalidationmethod] [-validationtablename validationtablename] [-failall true/false] [-desc description] [[-property propertyname=value],...]
オプション
次の表は、create -r コマンドオプションを使用して接続プールを作成するときに必要なすべてのオプションを示しています。
表 A-8 接続プール作成のパラメータ
パラメータ
値
poolname jdbcpoolname
JDBC 接続プールのプール名
classname classname
データソースを実装するベンダー固有のクラス名
steadypoolsize steadypoolsize
プール内で維持する必要がある最小接続数
maxpoolsize maxpoolsize
プールに許容される最大接続数
poolresizequantity poolresizequantity
steadypoolsize 値に達した場合にプールサイズを変更するバッチのサイズ
idletimeout idletimeout
接続がプール内でアイドル状態でいられる最大時間 (秒)
maxwaittime maxwaittime
接続がタイムアウトになるまで、呼び出し側が待機する時間
connectionvalidation true/false
アプリケーションに渡す前に接続を検証するかどうかを指定する
connectionvalidationmethod connectionvalidationmethod
データベース接続の検証方法。有効な値は auto-commit、meta-data、table
validationtablename validationtablename
connectionvalidationmethod を table に設定した場合のテーブル名
failall true/false
プールの単一の接続が不良であることが確認される場合、そのプールのすべての接続を無効にして再確立するかどうかを指定します。
desc description
プールの説明
property propertyname=value
JDBC 接続プールの標準プロパティと独自のプロパティを指定する、名前と値のペア
例
HttpServerAdmin create -r -jdbcconnectionpool -poolname testpool -classname "oracle.jdbc.pool.OracleDataSource" -property "URL=jdbc:oracle:thin:@dbhost:1521:ORCL,user=scott,password=tige r" -d /opt/Sun/S1WS6.1 -sinst testinstance
JDBC リソースの作成
create -r コマンドを使用して、コマンド行インタフェースから JDBC リソースを新規作成します。
構文
HttpServerAdmin -create -r -jdbc -jndiname jndiname -poolname poolname [-desc description] [-enabled true/false]
オプション
次の表は、create -r コマンドオプションを使用して JDBC リソースを新規作成するときに必要なすべてのオプションを示しています。
表 A-9 JDBC リソース作成のパラメータ
パラメータ
値
jndiname jndiname
リソースの JNDI 名
poolname poolname
JDBC 接続プールのプール名
desc description
プールの説明
enabled true/false
実行時にリソースを有効にするか、無効にするかを指定する
JDBC リソースが無効な場合、どのアプリケーションコンポーネントもこのリソースに接続できませんが、設定はサーバーインスタンスで維持されます。
例
HttpServerAdmin create -r -jdbc -jndiname "jdbc/testjdbcresource" -poolname testpool -d /opt/Sun/S1WS6.1 -sinst testinstance
カスタムリソースの作成
create -r コマンドを使用して、コマンド行インタフェースからカスタムリソースを新規作成します。
構文
HttpServerAdmin -create -r -custom -jndiname jndiname -resourcetype resourcetype -factoryclass factoryclassname [-enabled true/false] [-desc description] [[-property propertyname=value],...]
オプション
次の表は、create -r コマンドオプションを使用して JDBC リソースを新規作成するときに必要なすべてのオプションを示しています。
表 A-10 カスタムリソース作成のパラメータ
パラメータ
値
jndiname jndiname
リソースの JNDI 名
resourcetype resourcetype
リソースのタイプ
factoryclassname factoryclassname
オブジェクトファクトリのクラス名
enabled true/false
実行時にリソースを有効にするか、無効にするかを指定する
desc description
プールの説明
property propertyname=value
カスタムリソースのプロパティを指定する、名前と値のペア
例
HttpServerAdmin create -r -custom -jndiname "testcustomresource" -resourcetype "java.lang.String" -factoryclass "com.mycom.test.StringFactory" -d /opt/Sun/S1WS6.1 -sinst testinstance
外部 JNDI リソース
create -r コマンドを使用して、コマンド行インタフェースから外部 JNDI リソースを新規作成します。
構文
HttpServerAdmin -create -r -external -jndiname jndiname -jndilookupname jndilookupname -restype restype -factoryclass factoryclass [-enabled true/false] [-desc description] [[-property propertyname=value],...]
オプション
次の表は、create -r コマンドオプションを使用して外部 JNDI リソースを新規作成するときに必要なすべてのオプションを示しています。
表 A-11 外部 JNDI リソース作成のパラメータ
パラメータ
値
jndiname jndiname
リソースの JNDI 名
jndilookupname jndilookupname
リソースの JNDI 検索名
restype restype
リソースのタイプ
factoryclass factoryclass
オブジェクトファクトリのクラス名
enabled true/false
実行時にリソースを有効にするか、無効にするかを指定する
desc description
プールの説明
property propertyname=value
カスタムリソースのプロパティを指定する、名前と値のペア
例
HttpServerAdmin create -r -external -jndiname "testexternalresource" -jndilookupname "rmiconverter" -restype "samples.rmi.simple.ejb.ConverterHome" -factoryclass "com.sun.jndi.cosnaming.CNCtxFactory" -property "java.naming.provider.url=iiop://localhost:3700" -d /opt/Sun/S1WS6.1 -sinst testinstance
メールリソースの作成
create -r コマンドを使用して、コマンド行インタフェースからメールリソースを新規作成します。
構文
HttpServerAdmin -create -r -mail -jndiname jndiname -host host -user user -from from [-storeprotocol storeprotocol] [-storeprotocolclass storeprotocolclass] [-transportprotocol transportprotocol] [-transportprotocolclass transportprotocolclass] [-enabled true/false] [-desc description] [[-property propertyname=value]...]
オプション
次の表は、create -r コマンドオプションを使用してメールリソースを新規作成するときに必要なすべてのオプションを示しています。
表 A-12 メールリソース作成のパラメータ
パラメータ
値
jndiname jndiname
リソースの JNDI 名
host host
メールサーバーのホスト名
user user
メールサーバーのユーザー名
from from
メールサーバーがメッセージ送信者の指定に使用する電子メールアドレス
storeprotocol storeprotocol
メールサーバーへの接続、メッセージの取得、フォルダへのメッセージの保存を行うストレージプロトコルサービス。たとえば、imap や pop3 などの値
storeprotocolclass storeprotocolclass
ストレージのサービスプロバイダ実装クラス
このクラスは、次のサイトで特定できる
transportprotocol transportprotocol
メッセージを送信するトランスポートプロトコルサービス
transportprotocolclass transportprotocolclass
トランスポートのサービスプロバイダ実装クラス
このクラスは、次のサイトで特定できる
enabled true/false
実行時にこのリソースを有効にするかどうかを指定する。有効な値は、on、off、yes、no、1、0、true、false です。
desc description
リソースの説明
property propertyname=value
カスタムリソースのプロパティを指定する、名前と値のペア
例
HttpServerAdmin create -r -mail -jndiname "localmail" -host localhost -user mailid -from mailid@mailhost -d /opt/Sun/S1WS6.1 -sinst testinstance
delete コマンド
delete コマンドを使用して、仮想サーバーのクラス、仮想サーバー、および待機ソケットを削除します。
オプション
表 A-13 に示すオプションを delete コマンドとともに使用し、クラス、待機ソケット、および仮想サーバーを削除します。
表 A-13 delete コマンドのオプション
オプション
値
-c
指定された仮想サーバークラスを削除
-l
指定された待機ソケット ID を削除
-v
指定された仮想サーバーを削除
-r
指定されたリソースを削除
クラスの削除
delete コマンドのこのオプションを使用して、仮想サーバークラスを削除します。
構文
HttpServerAdmin delete -c -cl classname -d server_root -sinst http_instance
パラメータ
表 A-13 に示すパラメータを delete コマンドとともに使用し、クラスを削除します。
例
待機ソケットの削除
delete コマンドのこのオプションを使用して、待機ソケットを削除します。
構文
HttpServerAdmin delete -l -id listen_socket -d server_root -sinst http_instance
パラメータ
表 A-13 に示すパラメータを delete コマンドとともに使用し、クラスを削除します。
例
仮想サーバーの削除
delete コマンドのこのオプションを使用して、仮想サーバーを削除します。
構文
HttpServerAdmin delete -v -id virtual_server -cl classname -d server_root -sinst http_instance
パラメータ
表 A-13 に示すパラメータを delete コマンドとともに使用し、仮想サーバーを削除します。
例
JDBC 接続プールの削除
delete コマンドのこのオプションを使用して、接続プールを削除します。
構文
HttpServerAdmin delete -r jdbcconnectionpoolname
パラメータ
表 A-13 に示すパラメータを delete コマンドとともに使用し、接続プールを削除します。
例
JNDI リソースの削除
delete コマンドのこのオプションを使用して、JNDI リソースを削除します。
構文
HttpServerAdmin delete -r jndiname
パラメータ
表 A-13 に示すパラメータを delete コマンドとともに使用し、JNDI リソースを削除します。
例
list コマンド
list コマンドを使用して、仮想サーバーのクラス、仮想サーバー、待機ソケット、リソースをリスト表示します。
構文
HttpServerAdmin list -command_option -d server_root -sinst http_instance
オプション
表 A-19 List コマンドオプション
オプション
値
-c
すべての仮想サーバークラスをリスト表示する
-l
すべての待機ソケットをリスト表示する
-v
すべての仮想サーバーをリスト表示する
-r
指定されたリソースをリスト表示する
例
HttpServerAdmin list -c -d /export/sun/server6 -sinst https-sun.com
HttpServerAdmin list -l -d /export/sun/server6 -sinst https-sun.com
情報のリストは、コマンドウィンドウに表示されます。
