| Sun ONE Application Server 7, Enterprise Edition 管理者ガイド |
付録 A
コマンド行インタフェースの使用ここでは、コマンド行インタフェースである asadmin ユーティリティの使い方について、システムプロンプトからのシングルモード (コマンドプロンプトから、一度に 1 つのコマンドを実行する方法)、マルチモード (環境レベルの情報の再入力なしに、複数のコマンドを実行する方法) に加え、スクリプトやプログラムから実行する方法を説明します。コマンド行インタフェースは、管理インタフェース画面の代わりに使用できます。
この付録には次の節があります。
コマンド行インタフェースについてこの節には次の項目があります。
asadmin ユーティリティについて
asadmin ユーティリティを使うと、すべての設定タスクおよび管理タスクを実行できます。このユーティリティは、管理インタフェースの代わりに使用できます。
Ant タスクについて
多くの開発者は、Ant を使って、J2EE アプリケーションの開発プロセスにかかる時間を短縮しています。Ant スクリプトは、いくつかのタスクで asadmin ユーティリティを利用します。開発者は Ant タスクを使って、アプリケーションの構築、モジュールやアプリケーションの配備または配備の取り消し、および Sun ONE Application Server の制御を行います。
Ant タスクの詳細は、『Sun ONE Application Server 開発者ガイド』を参照してください。
Ant の詳細は、Jakarta プロジェクトのサイト (http://jakarta.apache.org/ant/) を参照してください。
その他のコマンド行ユーティリティについて
Sun ONE Application Server には、追加のコマンド行ユーティリティが付属しています。ユーティリティの一覧とそれぞれの簡単な説明を次の表に示します。
これらのユーティリティの詳細は、それぞれのオンラインヘルプを参照してください。
asadmin の使用asadmin ユーティリティは、管理タスクを実行するためのコマンドセットを備えています。管理インタフェースで実行できるほとんどのタスクが、これらのコマンドで実行できます。asadmin ユーティリティは install_dir/bin に格納されているため、その場所から実行できます。HTTP サーバー関連のプロパティと管理サーバーのプロパティには、コマンド行で設定できないものがあります。これらの設定には、管理インタフェースを使用してください。server.xml 設定ファイルに保存されているすべてのプロパティを設定できますが、init.conf と obj.conf に保存されているプロパティを設定することはできません。設定ファイルの詳細は、『Sun ONE Application Server 管理者用構成ファイルリファレンス』を参照してください。
各コマンドの詳細は、「コマンドリファレンス」とコマンドのヘルプを参照してください。
この節には次の項目があります。
コマンド構文について
asadmin ユーティリティの構文は次のとおりです。
asadmin command -short-option argument --long-option argument operand
コマンド
コマンドとは、実行される操作またはタスクのことです。コマンドには、大文字と小文字の区別があります。
オプション
オプションによって、ユーティリティによるコマンドの実行方法を変更できます。アルファベットの大文字と小文字は区別されます。短形式のオプションの前にはダッシュを 1 つ付けます (-)。長形式のオプションの前にはダッシュを 2 つ付けます (--)。多くのオプションは、短形式でも長形式でも使用できます。たとえば、--user と -u のどちらを使用してもかまいません。オプションには、必須オプションと省略できるオプションがあります。コマンド構文では、省略できるオプションをかっこで囲んで表しています。コマンドの実行時にはすべての必須オプションを指定する必要があります。指定しないと、エラーメッセージが返され、コマンドは実行されません。
使用可能な長形式および短形式のオプション名については、「コマンドリファレンス」の「各オプションに対応する短形式、長形式、デフォルト値、および環境変数」の表を参照してください。
ほとんどのオプションには引数が必要です。たとえば --port には引数 port_number を指定します。ただし、ブール型のオプションは、機能のオンまたはオフを切り替えるために使用されるため、引数を必要としません。
オプションを環境変数に保存することもできます。詳細は、「環境コマンドの使用」を参照してください。オプションに対応する環境変数については、「各オプションに対応する長形式、短形式、デフォルト値、および環境変数」を参照してください。
ブール型のオプション
ブール型のオプションでは、オンまたはオフを切り替えます。たとえば、--interactive を指定すると対話モードに切り替わります。--no-interactive を指定すると対話モードがオフになります。対話モードでは、オプションに関してプロンプトが表示されます。長形式のオプションの前に --no- を指定すると、そのオプションがオフになります。短形式のオプション名を指定すると、常にデフォルト値の逆の設定になります。
短形式のブール型オプションはまとめて指定できます。たとえば、対話モード (短形式のオプション名 -I) とエコー (短形式のオプション名 -e) を指定したい場合、-Ie と指定することができます。
オペランド
オペランドは、空白文字またはタブで区切って指定します。コマンド構文内にどの順番で指定してもかまいません。オペランドに続いてオプションを指定せずに -- を記述すると、オプションとオペランドを区別できます。その後に続く引数は、ダッシュ (-) で始まるものも含め、すべてオペランドとして扱われます。例を示します。
asadmin> create-jvm-options --instance server1 -- -Xmx1500m
-XMx1500m はダッシュで始まっていますが、オペランドとして扱われます。
構文例
asadmin create-instance [--user admin_user] [--password admin_password] [-H host_name] [--port port_number] [--sysuser sys_user] [--domain domain_name] [--local=true/false] [--passwordfile file_name] [--secure | -s] --instanceport instance_port instance_name
この構文例では、-H はホスト名の短形式のオプション、--user は admin_user を引数とする長形式のオプション、instance_name はオペランドです。省略できるオプションは、かっこで囲まれています。
次に、構文に実際の値を指定した例を示します。この例では、省略できるオプションの一部が指定されていません。
asadmin create-instance --user admin --password password -H austen --port 4848 --instanceport 1024 server2
シングルモードとマルチモードの使用
asadmin は、シングルモードまたはマルチモードで実行できます。シングルモードでは、コマンドプロンプトからコマンドを 1 つずつ実行します。マルチモードでは、環境レベルの情報を繰り返し入力することなく、複数のコマンドを実行できます。
シングルモードでファイルからの入力を使用している場合、コマンドの実行に失敗するとプログラムは終了します。マルチモードでコマンドの実行に失敗すると、asadmin のプロンプトが再度表示されます。
シングルモード
シングルモードでは、コマンド行インタフェースを使ってコマンドプロンプトから単一のコマンドを呼び出します。コマンド行インタフェースによってコマンドが実行され、再びコマンドプロンプトが表示されます。コマンドプロンプトからコマンド行インタフェースを実行するには、install_dir/appserv/bin ディレクトリに移動し、次のようにコマンドを入力します。
> asadmin command options arguments
次に例を示します。
> asadmin create-instance --user admin --password password -H austen --port 4848 --instanceport 1024 server2
マルチモード
マルチモードでは、最初に環境設定を行うことにより、サーバー名、ポート、パスワードなどの環境レベルの情報を再入力することなく、複数のコマンドを実行できます。マルチモードを使用する利点は、asadmin がメモリにとどまるため、コマンドの入力と実行が非常に速くなる点です。環境変数がオペレーティングシステムのレベルで設定されている場合、マルチモードではそれらの設定が取り込まれます。それらの設定は、変更されないかぎり asadmin ユーティリティによって引き続き使用されます。
UNIX では、asadmin ユーティリティをコマンド行からマルチモードで実行するには、次のコマンドを入力します。
> asadmin multimode
マルチモードの場合は、コマンドプロンプトが asadmin に変わります。次に、asadmin プロンプトにコマンドを入力します。ユーティリティ名を入力する必要はありません。次に例を示します。
asadmin> create-instance --user admin --password password -H austen --port 4848 --instanceport 1024 server2
exit または quit と入力すると、マルチモードが終了します。コマンドプロンプトに戻ります。
複数のマルチモード
マルチモードセッション内で次のコマンドを入力すると、さらにマルチモードを呼び出すこともできます。
asadmin> multimode
2 番目のマルチモード環境を終了すると、最初のマルチモード環境に戻ります。
たとえば、server1 をマルチモードで管理しているとき、server2 を使って両者を比較したい場合は、server1 のマルチモードで server2 のマルチモードを呼び出します。現在のマルチモードセッションを終了する必要がないので、環境設定をそのまま保持できます。server2 のマルチモードセッションを終了すると、server1 のマルチモード環境に戻ります。
対話型オプションと非対話型オプションの使用
コマンド行インタフェースは、対話型モードまたは非対話型モードで使用できます。対話型モードでは、パスワードが指定されていない場合、パスワードの入力を求めるメッセージが表示されます。対話型モードはデフォルトで有効になっています。
export コマンドを使って対話型環境変数を設定することにより、対話型モードを有効および無効に切り替えることができます。詳細は、「export コマンドに指定する環境変数」の表を参照してください。
どのような場合でも、シングルモードで対話型オプションを使用できます。マルチモードで対話型オプションを使用できるのは、コマンドプロンプトからコマンドを 1 つずつ実行する場合と、ファイルからマルチモードで実行する場合です。ただし、マルチモードでは、入力ストリームからパイプされたコマンドや、別のプログラムから呼び出されたコマンドを対話型モードで実行できません。
環境コマンドの使用
asadmin ユーティリティには、環境コマンドを使用して設定できる一連の環境変数が含まれます。マルチモードでは、これらの変数を設定したあと、マルチモードを終了するまで環境を設定し直す必要はありません。環境変数をオペレーティングシステムのレベルで設定することもできます。その場合、マルチモードに入ると、それらの環境変数は自動的に読み込まれ、マルチモードを終了するまで保持されます。
環境変数は名前と値の組み合わせであり、いつでも値を割り当てて設定できます。環境変数には、AS_ADMIN_ というプレフィックスが付けられて、大文字を使用したオプション名となります。たとえば、管理サーバーのユーザーを設定する場合は、次のように入力します。
export AS_ADMIN_USER=administrator
administrator は管理者のユーザー名です。
これによって、次のように AS_ADMIN_USER の値を asadmin コマンドにも使用できます。
asadmin multimode
asadmin> export AS_ADMIN_HOST=austen管理サーバーのホスト名は、新たに割り当てないかぎり、マルチモードセッションを終了するまで austen になります。
次の例のように、複数の環境変数をまとめて設定し、エクスポートすることもできます。
asadmin> export AS_ADMIN_PORT=4848 AS_ADMIN_USER=admin
現在の環境変数の設定を確認するには、引数を指定しないで export コマンドを実行します。
asadmin> export
AS_ADMIN_HOST=austen
AS_ADMIN_PORT=4848
AS_ADMIN_USER=admin変数とその値を環境から削除するには、unset コマンドを使用します。次に例を示します。
asadmin> unset AS_ADMIN_HOST
環境変数の値は、変数を設定し直すか、asadmin コマンドの一部として別の値を設定することにより、オーバーライドできます。次に例を示します。
asadmin> export AS_ADMIN_HOST=dickens
asadmin> show-instance-status --host austen instance-nameこの例では、管理サーバーホスト austen のインスタンスの状態が示されます。この値によって、以前のホストの値 dickens がオーバーライドされているためです。
エクスポートされた変数を使用しない場合は、ほとんどのコマンドで、次に示すオプションを指定するか、デフォルト値を使用する必要があります (デフォルト値の一覧については、「各オプションに対応する長形式、短形式、デフォルト値、および環境変数」を参照)。
次の表「export コマンドに指定する環境変数」では、export コマンドに指定できる環境変数について説明します。これらの変数は、環境設定用としてもっとも一般的に使用される変数です。第 1 列は環境変数名を、第 2 列は用途と、値が設定されていない場合のデフォルト値を示します。環境変数については、「各オプションに対応する長形式、短形式、デフォルト値、および環境変数」を参照してください。
パスワードファイルオプションの使用
コマンド行でパスワードを入力したくない場合やパスワードの環境変数を設定したくない場合は、パスワードファイルを作成しておき、そのファイルをコマンド行のオプションとして使用できます。
password オプションを指定できるコマンドには、passwordfile オプションを代わりに指定できます。パスワードファイルには、次の行を含めます。
AS_ADMIN_PASSWORD=value
AS_ADMIN_ADMINPASSWORD=value
AS_ADMIN_USERPASSWORD=value
passwordfile オプションを使用すると、ファイル内に記述したパスワードはマルチモード環境にエクスポートされるため、後続の password オプションを指定していないコマンドでも、これらの値が使用されます。
コマンド行に password オプションと passwordfile オプションを同時に指定した場合は、パスワードファイルに記述された値がマルチモード環境にエクスポートされますが、そのコマンドでは password オプションに指定されているパスワードが使用されます。password オプションが passwordfile オプションよりも優先されるためです。
ローカルまたはリモートでの asadmin の実行
通常、asadmin ユーティリティは、管理サーバーを介してコマンドを受け渡します。このため、Sun ONE Application Server がインストールされているシステムで asadmin を実行する必要はありません。ただし、ほとんどの asadmin コマンドが動作するには、管理サーバーが実行中であることが必要です。
create-instance など、一部のコマンドには、ローカルで実行するためのオプションを指定できます。--local=true オプションを指定して create-instance コマンドを使用する場合は、管理サーバーがインストールされているマシン上で実行する必要があります。ただし、管理サーバーを実行して、インスタンスを作成する必要はありません。
一部のコマンドは、ローカルで実行する必要があります。たとえば、管理サーバーを起動し、すべてのインスタンスを作成する start-appserv をリモートで実行することはできません。これは、このコマンドによって起動するまで、管理サーバーは実行されていないためです。
管理サーバーの詳細は、第 2 章「管理サーバーの設定」を参照してください。
次のコマンドは、ローカルとリモートの両方で実行できます。
これらのコマンドは、local オプションを指定しなくても、ローカルで実行できます。デフォルトでは、コマンド構文でユーザー、パスワード、ホスト、またはポートの値を指定すると、コマンドはリモートコマンドとして扱われます。ただし、これらのオプションにローカルの値を指定することも可能です。デフォルトでは、これらのオプションに値を指定しない場合、コマンドはローカルで実行されます。
domain オプションを指定できるコマンドをローカルで実行するときには、ドメインが 1 つだけの場合でも domain オプションを指定する必要があります。コマンドをリモートで実行するときには、domain オプションを指定しても無視されます。
コマンド行呼び出しの使用
コマンド行の呼び出しには、さまざまな方法があります。次の各項目で説明します。
コマンド行からの asadmin の使用
もっとも単純なコマンドの使用方法は、コマンド行から 1 つずつ実行する方法です。ユーティリティ名に続けて、コマンドとそのオプションおよび引数を指定します。マルチモードでは、ユーティリティ名と環境オプションを繰り返し入力することなく、複数のコマンドを実行できます (環境変数を設定済みの場合)。シングルモードのコマンドもマルチモードのコマンドも、対話型形式 (パスワードなどの追加入力を求めるプロンプトを表示する) または非対話型形式で実行できます。
シングルモードとマルチモードの詳細は、「シングルモードとマルチモードの使用」を参照してください。
コマンドを対話型形式で使用する方法については、「対話型オプションと非対話型オプションの使用」を参照してください。
コマンド行の使用例
> asadmin create-instance --user admin --password password --host austen --port 4848 --instanceport 1024 server2
コマンドの実行が完了すると、オペレーティングシステムのプロンプトに戻ります。
ファイルからの入力 (スクリプト) での asadmin の使用
複数の asadmin コマンドを含むスクリプトを作成できます。スクリプトを使うと、バッチモードでのコマンド処理、ジョブの実行回数の設定、管理タスクの単純化および自動化を行うことができます。
ファイル内のスクリプトを呼び出すには、次の構文を使用します。
> asadmin multimode --file filename
次に、この方法で呼び出せる、ファイル内の単純なスクリプトの例を示します。
# Create new instance and start it.
export AS_ADMIN_USER=admin AS_ADMIN_PASSWORD=mypassword AS_ADMIN_HOST=austen AS_ADMIN_PORT=4848
create-instance --instanceport 9000 austen3
start-instance austen3このスクリプトは、環境設定を行い、austen3 というインスタンスを作成し、新しいインスタンスを起動します。ハッシュ記号 (#) で始まる行はコメントと見なされ、無視されます。
標準入力 (パイプ) での asadmin の使用
入力を asadmin ユーティリティにパイプすることができます。次の構文を使用します。
cat filename | asadmin multimode
エスケープ文字の使用
エスケープ文字で区切らずにコロン (:)、アスタリスク (*)、および円記号 (¥) などの文字をコマンド構文で使用すると、エラーが発生します。エスケープ文字が必要となる場面は、プラットフォームやシングルモードとマルチモードの違いによって変わります。
この節には次の項目があります。
UNIX のシングルモードでのエスケープ文字
Solaris では、二重の円記号 (¥¥) または二重引用符 (" ") を使用して、予約されている文字をエスケープします。
円記号 (¥¥) によるエスケープ
たとえば、値にコロンを含むオプションを指定して JDBC 接続プールを作成するときに、バックスラッシュを使用できます (一部のプロパティに関して環境変数が設定されていることが必要)。
asadmin create-jdbc-connection-pool --instance server1 --datasourceclassname oracle.jdbc.pool.OracleDataSource --failconnection=true --isconnectvalidatereq=true --property url=jdbc¥¥:oracle¥¥:thin¥¥:@asperfsol8¥¥:1521¥¥:V8i:user=staging_look up_app:password=staging_lookup_app OraclePoollookup
引用符によるエスケープ
上記の例と同じ内容に対して引用符を使用するには、値を引用符 (") で囲み、さらにこれらの引用符をバックスラッシュでエスケープします。
asadmin create-jdbc-connection-pool --instance server1 --datasourceclassname oracle.jdbc.pool.OracleDataSource --failconnection=true --isconnectvalidatereq=true --property url=¥"jdbc:oracle:thin:@asperfsol8:1521:V8i¥":user=staging_lookup_ap p:password=staging_lookup_app OraclePoollookup
「プラットフォームを問わないシングルモードでのエスケープ文字」で説明している方法を使用することもできます。
プラットフォームを問わないシングルモードでのエスケープ文字
どのプラットフォームでも、バックスラッシュを文字の前に使い、その文字を含む値を二重引用符で囲むことによって、エスケープできます。たとえば、値にコロンを含むオプションを指定して JDBC 接続プールを作成するときに、次のようにエスケープ文字を使用できます (一部のプロパティに関して環境変数が設定されていることが必要)。
asadmin create-jdbc-connection-pool --instance server1 --datasourceclassname oracle.jdbc.pool.OracleDataSource --failconnection=true --isconnectvalidatereq=true --property url="jdbc¥:oracle¥:thin¥:@iasperfsol8¥:1521¥:V8i":user=staging_looku p_app:password=staging_lookup_app OraclePoollookup
プラットフォームを問わないマルチモードでのエスケープ文字
マルチモードでは、スラッシュやバックスラッシュなどを必要とせずに、引用符だけの次のような構文を使うことができます。
asadmin> create-jdbc-connection-pool --instance server1 --datasourceclassname oracle.jdbc.pool.OracleDataSource --failconnection=true --isconnectvalidatereq=true --property url="jdbc:oracle:thin:@asperfsol8:1521:V8i":user=staging_lookup_app :password=staging_lookup_app OraclePoollookup
get コマンドと set コマンドの使用
get コマンドと set コマンドを使うと、Sun ONE Application Server の設定情報にアクセスおよび変更できます。ほとんどの場合、asadmin コマンドは必須プロパティだけを設定します。オプションのプロパティの値を変更するには、set コマンドを使用します。
表 A-3 get コマンドと set コマンド
コマンド
引数
用途
get
(scope) scope は属性を表す有効な名前
属性の値を取得する
set
(scope=value) scope は属性を表す有効な名前。value はその属性に設定する値
属性の値を設定する
reconfig
instance-name
設定ファイルの内容を変更するコマンドを実行したあと、サーバーに変更を適用するには、reconfig を実行することが必要。サーバーの変更および再設定の適用については、「アプリケーションサーバーインスタンスの変更の適用」を参照
1 つのコマンドで、属性と属性の間に空白文字を使うことにより、複数の属性値を取得または設定できます。次に例を示します。
set server1.appReloadPollInterval=20 server1.mime.mime1.file=mime.types
また、AS_ADMIN_PREFIX 環境変数を使って、後続の get コマンドや set コマンドが使うプレフィックスを設定することもできます。プレフィックス文字列と、get コマンドまたは set コマンドのオペランドとの間にピリオド (".") が挿入されます。次に例を示します。
asadmin>export AS_ADMIN_PREFIX=server1
asadmin>get *
server1.locale = en_US
server1.appReloadPollInterval = 2
server1.name = server1
...get コマンドと set コマンドは区切り文字としてピリオドを必要とするため、アイテム名にピリオドが含まれる場合は、含まれるピリオドの前にエスケープ文字の円記号 (¥) を記述する必要があります。サーバーインスタンス名 server2.sun.com のピリオドの前にバックスラッシュを記述した例を、次に示します。
get server2¥.sun¥.com.*
バックスラッシュを挿入しないと、エラーメッセージが表示されます。
get コマンドと set コマンドの例
次に、get コマンドを使って属性値を取得する例と、set コマンドを使って値を設定する例を示します。
MDB コンテナサービスの例
アプリケーションサーバーインスタンスが server1 の場合、環境を設定し、次のコマンドをマルチモードで実行することにより、すべての mdb-container 属性の値を取得できます。
asadmin> get server1.mdb-container.*
次に、このコマンドの出力例を示します。出力には現在の属性値が示されます。
server1.mdb-container.logLevel = null
server1.mdb-container.steadyPoolSize = 10
server1.mdb-container.idleInPoolTimeoutInSeconds = 600
server1.mdb-container.maxPoolSize = 60
server1.mdb-container.monitoringEnabled = false
server1.mdb-container.poolResizeQuantity = 2MDB コンテナ属性の monitoringEnabled の値だけを取得するには、次のコマンドを使用します。
asadmin> get server1.mdb-container.montioringEnabled
monitoringEnabled 属性の値を true に設定するには、次のコマンドを使用します。
asadmin> set server1.mdb-container.montioringEnabled=true
JMS リソースの例
リソースを設定するには、次のように属性を指定します。
instancename.resource.primary_key_value.attribute_name
次に例を示します。
asadmin> get server1.jms-resource.myjms.*
これにより、JMS 送信先リソース myjms のすべての属性を取得できます。次に例を示します。
server1.jms-resource.myjms.resType = javax.jms.Topic
server1.jms-resource.myjms.enabled = true
server1.jms-resource.myjms.name = myjms
server1.jms-resource.myjms.description = nullresType など、単一の属性の値を取得するには、次のように入力します。
asadmin> get server1.jms-resource.myjms.resType
description 属性を設定するには、次のように入力します。
asadmin> set server1.jms-resource.myjms.description=mydescription
この例では、mydescription に説明が設定されます。
複数の値の取得例と設定例
1 つのコマンドで複数の値を取得および設定することができます。同時に 2 つの属性を設定するには、属性の間を空白文字で区切ります。次に例を示します。
set server1.appReloadPollInterval=20 server1.mime.mime1.file=mime.types
また、AS_ADMIN_PREFIX 環境変数を使って、複数の get コマンドや set コマンドが使うプレフィックスを設定することもできます。
get コマンドと set コマンドによる監視
get コマンドおよび set コマンドを使って、実行中のサーバーを監視することもできます。list コマンドで、監視することもできます。monitor オプションを true または false に設定します。true に設定した場合は、指定された属性を監視できます。コマンド行インタフェースを使って Sun ONE Application Server を監視する方法の詳細は、「CLI を使用した監視データの抽出」を参照してください。
ヘルプの使用
個々の asadmin コマンドのヘルプを表示するには、コマンドプロンプトで -h または --help と入力します。たとえば、asadmin のヘルプを表示するには、次のコマンドを入力します。
asadmin --help
すべての asadmin コマンドが一覧表示されます。
特定の asadmin コマンドのヘルプを表示するには、次のように入力します。
asadmin command -h
または
asadmin command --help
ヘルプには、構文、コマンドの説明、構文の説明、使用例、および関連コマンドが表示されます。
コマンド内の任意の位置に -h または --help を指定すると、そのコマンドのヘルプが表示されます。コマンドは実行されません。
UNIX 環境では、マニュアルページとしてコマンド行のヘルプページにアクセスすることもできます。アンバンドル版では、install_dir/man を MANPATH 環境変数に追加してください。一度追加すると、Sun ONE Application Server ユーティリティのマニュアルページにアクセスできるようになります。たとえば、コマンドプロンプトで man asadmin と入力するとアクセスできます。
出力とエラーの表示
コマンドが正常に実行されると、実行内容を知らせるメッセージが表示されます。コマンドの実行に失敗すると、エラーメッセージが表示されます。
この節には次の項目があります。
終了状態の表示
エラーメッセージに加えて、asadmin コマンドの終了時には、常に終了状態が返されます。終了状態は、コマンドの実行が成功した場合は 0、失敗した場合は 1 になります。
UNIX での終了状態
コマンドプロンプトで echo $? と入力することにより、終了状態をチェックできます。
スクリプトでも終了コードを使用できます。たとえば、次の Korn シェルスクリプトは、終了状態を使用して list-instances コマンドが成功であるか失敗であるかを示します。
#!/bin/ksh
asadmin list-instances
if [[ $? = 0 ]]
then
echo "success"
else
echo "error"
fi使用法の表示
引数を指定せずにコマンドを実行すると、コマンドの構文を示すエラーメッセージが表示されます。次に例を示します。
asadmin> create-instance
Invalid number of operands received
USAGE:create-instance [--user admin_user] [--password admin_password] [--host localhost] [--port 4848] [--sysuser sys_user] [--domain domain_name] [--local=false] [--passwordfile file_name] [secure | -s] --instanceport instanceport instancename
セキュリティに関する注意事項コマンド行からコマンド行インタフェースを実行する場合は、すべてのコマンドにパスワードが必要になります。マルチモードで実行する場合は、最初の環境設定時にパスワードを入力します。マルチモードをいったん終了して、もう一度開始するときは、再び環境設定を行い、パスワードを入力します。パスワードの設定には、環境コマンドを使います。詳細は、「環境コマンドの使用」を参照してください。
コマンド行でパスワードを入力しなくていいように、パスワードファイルを設定しておくこともできます。詳細は、「パスワードファイルオプションの使用」を参照してください。
有効なユーザー名およびパスワードの認証情報がなければ、コマンドは実行されません。
コマンド行インタフェースは、使用している Sun ONE Application Server 用に設定したセキュリティ基準に従います。Sun ONE Application Server のセキュリティ関連情報については、『Sun ONE Application Server セキュリティ管理者ガイド』を参照してください。
同時アクセスに関する注意事項コマンド行インタフェースや管理インタフェースを使って、複数のユーザーが同時にサーバーの設定を行う場合があります。この場合、2 番目の設定要求は、最初の要求が完了するまでキューに入ります。キュー内での待ち時間が長くなると、タイムアウトになります。
一部のコマンドについては、変更内容は reconfig コマンドを実行するまで適用されません。したがって、変更内容がサーバーに適用される前に、複数のユーザーが同じ属性を編集する可能性があります。reconfig の詳細は、「アプリケーションサーバーインスタンスの起動と停止」を参照してください。
コマンドリファレンスこの節には次の項目があります。
コマンドの一覧
次の表に、すべての asadmin コマンドとその用途を示します。コマンドの構文と使用方法については、オンラインヘルプを参照してください。
左側の列にはコマンド名、右側の列には用途が記述されています。
ドット表記名と属性の一覧
get コマンドおよび set コマンドを使用して属性を取得および設定するときには、該当のオブジェクトの属性を取得するために、asadmin がサービスやリソースなどに使用する名前を知っておく必要があります。
これらの名前を使用する構文はピリオドとピリオドの間に区切る名前を含むため、これらの名前をドット表記名と呼びます。
asadmin で使用されるドット表記名
asadmin でアイテムを設定するために使用する名前の一覧を、以下の各表で示します。これらの名前は、次の各カテゴリに分類されます。
サービス名
次の表では、サービスの属性を取得および設定するために使用するサービス名を示します。
リソース名
次の表では、リソースの属性を取得および設定するために使用するリソース名を示します。これらの名前は、そのままでは有効ではありません。リソース名を続けて記述する必要があります。
表 A-6 コマンド行インタフェースのリソース名
リソース
ドット表記名
JDBC リソース設定
JNDI リソース設定
JDBC 接続プールリソース設定
カスタムリソース設定
JMS リソース設定
持続マネージャファクトリリソース設定
Java メールサービスリソース設定
アプリケーション名
次の表では、アプリケーション関連設定の属性を取得および設定するために使用するドット表記名を示します。これらの名前は、そのままでは有効ではありません。アプリケーション名を続けて記述する必要があります。
その他の名前
次の表では、get および set を使って設定できるその他のアイテムのドット表記名を示します。これらの名前は、そのままでは有効ではありません。アプリケーション名を続けて記述する必要があります。たとえば、http-listener.listener_name、lifecycle-module.module-name などです。
表 A-8 その他のコマンド行インタフェースのアイテム名
アイテム
ドット表記名
HTTP リスナー
MIME タイプファイル
ACL
仮想サーバー
認証データベース
セキュリティレルム
ライフサイクルモジュール
プロファイラ設定
サーバーインスタンス設定
属性
ここでは、前述の各名前付きアイテムの属性と、その使用例を示します。一部の属性は読み取り専用です。つまり、get コマンドだけで使用でき、set コマンドでは使用できない属性があります。
jms-service
次の表では、属性の server.xml 名を左側の列に、asadmin で使用する名前を右側の列に示しています。
インスタンス (server1) からすべての属性を取得するには、次のように入力します。
asadmin> get server1.jms-service.*
adminPassword という属性を取得するには、次のように入力します。
asadmin> get server1.jms-service.adminPassword
adminPassword という属性に値 admin を設定するには、次のように入力します。
asadmin> set server1.jms-service.adminPassword=admin
transaction-service
次の表では、属性の server.xml 名を左側の列に、asadmin で使用する名前を右側の列に示しています。
インスタンス (server1) からすべての属性を取得するには、次のように入力します。
asadmin> get server1.transaction-service.*
transactionRecoveryTimeout という属性を取得するには、次のように入力します。
asadmin> get server1.transaction-service.transactionRecoveryTimeout
transactionRecoveryTimeout という属性に値 49 を設定するには、次のように入力します。
asadmin> set server1.transaction-service.transactionRecoveryTimeout=49
mdb-container
次の表では、属性の server.xml 名を左側の列に、asadmin で使用する名前を右側の列に示しています。
インスタンス (server1) からすべての属性を取得するには、次のように入力します。
asadmin> get server1.mdb-container.*
steadyPoolSize という属性を取得するには、次のように入力します。
asadmin> get server1.mdb-container.steadyPoolSize
steadyPoolSize という属性に値 10 を設定するには、次のように入力します。
asadmin> set server1.mdb-container.steadyPoolSize=10
ejb-container
次の表では、属性の server.xml 名を左側の列に、asadmin で使用する名前を右側の列に示しています。
インスタンス (server1) からすべての属性を取得するには、次のように入力します。
asadmin> get server1.ejb-container.*
maxPoolSize という属性を取得するには、次のように入力します。
asadmin> get server1.ejb-container.maxPoolSize
maxPoolSize という属性に値 12 を設定するには、次のように入力します。
asadmin> set server1.ejb-container.maxPoolSize=12
web-container
次の表では、属性の server.xml 名を左側の列に、asadmin で使用する名前を右側の列に示しています。
表 A-13 Web コンテナの属性
server.xml 名
asadmin 名
log-level
logLevel
monitoring-enabled
monitoringEnabled (使用されない)
インスタンス (server1) からすべての属性を取得するには、次のように入力します。
asadmin> get server1.web-container.*
logLevel という属性を取得するには、次のように入力します。
asadmin> get server1.web-container.logLevel
monitoringEnabled という属性に WARNING を設定するには、次のように入力します。
asadmin> set server1.web-container.logLevel=WARNING
java-config
次の表では、属性の server.xml 名を左側の列に、asadmin で使用する名前を右側の列に示しています。
インスタンス (server1) からすべての属性を取得するには、次のように入力します。
asadmin> get server1.java-config.*
classpathprefix という属性を取得するには、次のように入力します。
asadmin> get server1.java-config.classpathprefix
classpathprefix という属性に値 com.sun を設定するには、次のように入力します。
asadmin> set server1.java-config.classpathprefix=com.sun
orb または iiop-service
次の表では、属性の server.xml 名を左側の列に、asadmin で使用する名前を右側の列に示しています。
インスタンス (server1) からすべての属性を取得するには、次のように入力します。
asadmin> get server1.orb.*
または
asadmin> get server1.iiop-service.*
msgSize という属性を取得するには、次のように入力します。
asadmin> get server1.orb.msgSize
または
asadmin> get server1.iiop-service.msgSize
idleThreadTimeout という属性に値 300 を設定するには、次のように入力します。
asadmin> set server1.orb.idleThreadTimeout=300
または
asadmin> set server1.iiop-service.idleThreadTimeout=300
orblistener または iiop-listener
次の表では、属性の server.xml 名を左側の列に、asadmin で使用する名前を右側の列に示しています。
インスタンス (server1) からすべての属性を取得するには、次のように入力します。
asadmin> get server1.orblistener.orb_listener_id.*
または
asadmin> get server1.iiop-listener.orb_listener_id.*
port という属性を取得するには、次のように入力します。
asadmin> get server1.orblistener.orb_listener_id.port
または
asadmin> get server1.iiop-listener.orb_listener_id.port
address という属性に bluestar を設定するには、次のように入力します。
asadmin> set server1.orblistener.orb_listener_id.address=bluestar
または
asadmin> set server1.iiop-listener.orb_listener_id.address=bluestar
log-service
次の表では、属性の server.xml 名を左側の列に、asadmin で使用する名前を右側の列に示しています。
インスタンス (server1) からすべての属性を取得するには、次のように入力します。
asadmin> get server1.log-service.*
level という属性を取得するには、次のように入力します。
asadmin> get server1.log-service.level
echoToStderr という属性に true を設定するには、次のように入力します。
asadmin> set server1.log-service.echoToStderr=true
security-service
次の表では、属性の server.xml 名を左側の列に、asadmin で使用する名前を右側の列に示しています。
インスタンス (server1) からすべての属性を取得するには、次のように入力します。
asadmin> get server1.security-service.*
anonymousRole という属性を取得するには、次のように入力します。
asadmin> get server1.security-service.anonymousRole
encryptPasswords という属性に true を設定するには、次のように入力します。
asadmin> set server1.security-service.auditEnabled=true
http-service
次の表では、属性の server.xml 名を左側の列に、asadmin で使用する名前を右側の列に示しています。
インスタンス (server1) からすべての属性を取得するには、次のように入力します。
asadmin> get server1.http-service.*
bandwidthLimit という属性を取得するには、次のように入力します。
asadmin> get server1.http-service.bandwidthLimit
qos-enabled という属性に true を設定するには、次のように入力します。
asadmin> set server1.http-service.qos-enabled=true
jdbc-resource
次の表では、属性の server.xml 名を左側の列に、asadmin で使用する名前を右側の列に示しています。
表 A-20 JDBC リソースの属性
server.xml 名
asadmin 名
jndi-name
name
pool-name
pool
enabled
enabled
description
description
インスタンス (server1) からすべての属性を取得するには、次のように入力します。
asadmin> get server1.jdbc-resource.jdbc_resource_name.*
pool という属性を取得するには、次のように入力します。
asadmin> get server1.jdbc-resource.jdbc_resource_name.pool
enabled という属性に true を設定するには、次のように入力します。
asadmin> set server1.jdbc-resource.jdbc_resource_name.enabled=true
jndi-resource
次の表では、属性の server.xml 名を左側の列に、asadmin で使用する名前を右側の列に示しています。
表 A-21 JNDI リソースの属性
server.xml 名
asadmin 名
jndi-name
name
jndi-lookup-name
LookupName
res-type
resType
factory-class
factory
enabled
enabled
description
description
インスタンス (server1) からすべての属性を取得するには、次のように入力します。
asadmin> get server1.jndi-resource.jndi_name.*
factory という属性を取得するには、次のように入力します。
asadmin> get server1.jndi-resource.jndi_name.factory
factory という属性に com.sun を設定するには、次のように入力します。
asadmin> set server1.jndi-resource.jndi_name.factory=com.sun
jdbc-connection-pool
次の表では、属性の server.xml 名を左側の列に、asadmin で使用する名前を右側の列に示しています。
インスタンス (server1) からすべての属性を取得するには、次のように入力します。
asadmin> get server1.jdbc-connection-pool.pool_name.*
dsClassName という属性を取得するには、次のように入力します。
asadmin> get server1.jdbc-connection-pool.pool_name.dsClassName
resizeValue という属性に値 2 を設定するには、次のように入力します。
asadmin> set server1.jdbc-connection-pool.pool_name.resizeValue=2
custom-resource
次の表では、属性の server.xml 名を左側の列に、asadmin で使用する名前を右側の列に示しています。
表 A-23 カスタムリソースの属性
server.xml 名
asadmin 名
jndi-name
name
res-type
resType
factory-class
factory
enabled
enabled
description
description
インスタンス (server1) からすべての属性を取得するには、次のように入力します。
asadmin> get server1.custom-resource.jndi_name.*
factory という属性を取得するには、次のように入力します。
asadmin> get server1.custom-resource.jndi_name.factory
factory という属性を設定するには、次のように入力します。
asadmin> set server1.custom-resource.jndi_name.factory=myclass
jms-resource
次の表では、属性の server.xml 名を左側の列に、asadmin で使用する名前を右側の列に示しています。
表 A-24 JMS リソースの属性
server.xml 名
asadmin 名
jndi-name
name
res-type
resType
enabled
enabled
description
description
インスタンス (server1) からすべての属性を取得するには、次のように入力します。
asadmin> get server1.jms-resource.jms_resource_name.*
res-type という属性を取得するには、次のように入力します。
asadmin> get server1.jms-resource.jms_resource_name.resType
enabled という属性に true を設定するには、次のように入力します。
asadmin> set server1.jms-resource.jms_resource_name.enabled=true
persistence-manager-factory-resource
次の表では、属性の server.xml 名を左側の列に、asadmin で使用する名前を右側の列に示しています。
表 A-25 持続マネージャファクトリリソースの属性
server.xml 名
asadmin 名
jndi-name
jndiName
jdbc-resource-jndi-name
JdbcResourceJndiName
factory-class
factoryClass
enabled
enabled
description
description
インスタンス (server1) からすべての属性を取得するには、次のように入力します。
asadmin> get server1.persistence-manager-factory-resource.jndi_name
factoryClass という属性を取得するには、次のように入力します。
asadmin> get server1.persistence-manager-factory-resource.jndi_name.factoryClass
enabled という属性に true を設定するには、次のように入力します。
asadmin> set server1.persistence-manager-factory-resource.jndi_name.enabled=true
mail-resource
次の表では、属性の server.xml 名を左側の列に、asadmin で使用する名前を右側の列に示しています。
インスタンス (server1) からすべての属性を取得するには、次のように入力します。
asadmin> get server1.mail-resource.jndi_name.*
host という属性を取得するには、次のように入力します。
asadmin> get server1.mail-resource.jndi_name.host
enabled という属性に true を設定するには、次のように入力します。
asadmin> set server1.mail-resource.jndi_name.enabled=true
application
次の表では、属性の server.xml 名を左側の列に、asadmin で使用する名前を右側の列に示しています。
表 A-27 アプリケーションの属性
server.xml 名
asadmin 名
name
name
location
location
virtual-servers
virtualServers
description
description
enabled
enabled
インスタンス (server1) からすべての属性を取得するには、次のように入力します。
asadmin> get server1.application.application_name.*
アプリケーションの location という属性を取得するには、次のように入力します。
asadmin> get server1.application.application_name.location
location という属性を設定するには、次のように入力します。
asadmin> set server1.application.application_name.location=
"/export/home/as7se/as1/repository/applications/ASConverter"ejb-module
次の表では、属性の server.xml 名を左側の列に、asadmin で使用する名前を右側の列に示しています。
表 A-28 EJB モジュールの属性
server.xml 名
asadmin 名
name
name
location
location
description
description
enabled
enabled
インスタンス (server1) 内にあるスタンドアロン EJB モジュールのすべての属性を取得するには、次のように入力します。
asadmin> get server1.ejb-module.ejb_jar_name.*
インスタンス (server1) に関する、アプリケーション内にある EJB モジュールのすべての属性を取得するには、次のように入力します。
asadmin> get server1.j2ee-application.application_name.ejb-module.ejb_jar_name.*
または
asadmin>get server1.application.application_name.ejb-module.ejb_jar_name.*
スタンドアロン EJB モジュールから location という属性を取得するには、次のように入力します。
asadmin> get server1.ejb-module.ejb_jar_name.location
アプリケーションの EJB モジュールから location という属性を取得するには、次のように入力します。
asadmin> get server1.j2ee-application.application_name.ejb-module.ejb_jar_name.
locationまたは
asadmin> get server1.application.application_name.ejb-module.ejb_jar_name.location
スタンドアロン EJB モジュールの location という属性を設定するには、次のように入力します。
asadmin> set server1.ejb-module.ejb_jar_name.location="/export/home/as7se/as1/repos itory/modules/ejb_jar_name"
アプリケーションにバンドルされている EJB モジュールの location という属性を設定するには、次のように入力します。
asadmin> set server1.j2ee-application.application_name.ejb-module.ejb_jar_name.
location="/export/home/as7se/as1/repository/modules/ejb_jar_name"または
asadmin>set server1.application.application_name.ejb-module.ejb_jar_name.location="/ex port/home/as7se/as1/repository/modules/ejb_jar_name"
web-module
次の表では、属性の server.xml 名を左側の列に、asadmin で使用する名前を右側の列に示しています。
表 A-29 Web モジュールの属性
server.xml 名
asadmin 名
name
name
location
location
context-root
contextRoot
virtual-servers
virtualServers
description
description
enabled
enabled
インスタンス (server1) 内にあるスタンドアロン Web モジュールのすべての属性を取得するには、次のように入力します。
asadmin> get server1.web-module.web_war_name.*
インスタンス (server1) に関する、アプリケーション内にある Web モジュールのすべての属性を取得するには、次のように入力します。
asadmin> get server1.web-module.application_name.web_war_name.*
スタンドアロン Web モジュールから location という属性を取得するには、次のように入力します。
asadmin> get server1.web-module.web_war_name.location
アプリケーションの Web モジュールから location という属性を取得するには、次のように入力します。
asadmin> get server1.web-module.application_name.web_war_name.location
スタンドアロン Web モジュールの location という属性を設定するには、次のように入力します。
asadmin> set server1.web-module.war-ic.location=
"/export/home/as7se/as1/repository/modules/web_war_name"アプリケーションにバンドルされている Web モジュールの location という属性を設定するには、次のように入力します。
asadmin> set server1.web-module.application_name.web_war_name.location=
"/export/home/as7se/as1/repository/modules/web_war_name"connector-module
次の表では、属性の server.xml 名を左側の列に、asadmin で使用する名前を右側の列に示しています。
表 A-30 コネクタモジュールの属性
server.xml 名
asadmin 名
name
name
location
location
description
description
enabled
enabled
インスタンス (server1) 内にあるスタンドアロンコネクタモジュールのすべての属性を取得するには、次のように入力します。
asadmin> get server1.connector-module.connector_rar_name.*
スタンドアロンコネクタモジュールから location という属性を取得するには、次のように入力します。
asadmin> get server1.connector-module.connector_rar_name.location
スタンドアロンコネクタモジュールの location という属性を設定するには、次のように入力します。
asadmin> set server1.connector-module.connector_rar_name.location=
"/export/home/as7se/as1/repository/modules/connector_rar_name"http-listener または http-server.http-listener
次の表では、属性の server.xml 名を左側の列に、asadmin で使用する名前を右側の列に示しています。
インスタンス (server1) からすべての属性を取得するには、次のように入力します。
asadmin> get server1.http-listener.http_listener_name.*
または
asadmin> get server1.http-server.http-listener.http_listener_name.*
factory という属性を取得するには、次のように入力します。
asadmin> get server1.httpl-listener.http_listener_name.address
または
asadmin> get server1.http-server.http-listener.http_listener_name.address
address という属性に IP アドレス 0.0.0.0 を設定するには、次のように入力します。
asadmin> set server1.http-listener.http_listener_name.address=0.0.0.0
または
asadmin> set server1.http-server.http-listener.http_listener_name.address=0.0.0.0
mime
次の表では、属性の server.xml 名を左側の列に、asadmin で使用する名前を右側の列に示しています。
インスタンス (server1) からすべての属性を取得するには、次のように入力します。
asadmin> get server1.mime.mime_name.*
file という属性を取得するには、次のように入力します。
asadmin> get server1.mime.mime_name.file
file という属性に mime.types を設定するには、次のように入力します。
asadmin> set server1.mime.mime_name.file=mime.types
acl
次の表では、属性の server.xml 名を左側の列に、asadmin で使用する名前を右側の列に示しています。
インスタンス (server1) からすべての属性を取得するには、次のように入力します。
asadmin> get server1.acl.acl_name.*
file という属性を取得するには、次のように入力します。
asadmin> get server1.acl.acl_name.file
file という属性を設定するには、次のように入力します。
asadmin> set server1.acl.acl_name.file=com/as1.acl
virtual-server
次の表では、属性の server.xml 名を左側の列に、asadmin で使用する名前を右側の列に示しています。
インスタンス (server1) からすべての属性を取得するには、次のように入力します。
asadmin> get instance_name.virtual-server.vserver_id.*
次に例を示します。
asadmin> get server1.virtual-server.server1.*
仮想サーバー server1 の httpListeners という属性を取得するには、次のように入力します。
asadmin> get server1.virtual-server.server1.httpListeners
acceptLanguage という属性に false を設定するには、次のように入力します。
asadmin> set server1.virtual-acceptLanguage=false
auth-db
次の表では、属性の server.xml 名を左側の列に、asadmin で使用する名前を右側の列に示しています。
インスタンスのすべての属性を確認するには、次のコマンドを使います。
asadmin> get instancename.virtual-server.vserver_id.auth-db.authdb_id.*
たとえば、インスタンス server1 の仮想サーバー server1 では、次のように入力します。
asadmin> get server1.virtual-server.server1.auth-db.authdb_id.*
database という属性を取得するには、次のように入力します。
asadmin> get server1.virtual-server.server1.auth-db.authdb_id.database
database という属性を設定するには、次のように入力します。
asadmin> set server1.virtual-server.server1.auth-db.authdb_id.database=Oracle
authrealm
次の表では、属性の server.xml 名を左側の列に、asadmin で使用する名前を右側の列に示しています。
インスタンス (server1) からすべての属性を取得するには、次のように入力します。
asadmin> get server1.authrealm.authrealm_id.*
classname という属性を取得するには、次のように入力します。
asadmin> get server1.authrealm.authrealm_id.classname
classname という属性を設定するには、次のように入力します。
asadmin> set server1.authrealm.authrealm_id.classname=com.sun.as.security.auth.real m.sharedpassword.SharedPasswordRealm
lifecycle-module
次の表では、属性の server.xml 名を左側の列に、asadmin で使用する名前を右側の列に示しています。
表 A-37 ライフサイクルモジュールの属性
server.xml 名
asadmin 名
name
name
enabled
enabled
class-name
className
classpath
classPath
load-order
loadOrder
is-failure-fatal
isFailureFatal
description
description
インスタンス (server1) からすべての属性を取得するには、次のように入力します。
asadmin> get server1.lifecycle-module.lifecycle_module_id.*
ライフサイクルモジュールの className という属性を取得するには、次のように入力します。
asadmin> get server1.lifecycle-module.lifecycle_module_id.className
className という属性を設定するには、次のように入力します。
asadmin> set server1.lifecycle-module.lifecycle_module_id.className=com.lifecycle_module_id. lifecycle
profiler
次の表では、属性の server.xml 名を左側の列に、asadmin で使用する名前を右側の列に示しています。
表 A-38 JVM プロファイラ設定の属性
server.xml 名
asadmin 名
name
name
classpath
classPath
native-library-path
nativeLibraryPath
enabled
enabled
インスタンス (server1) からすべての属性を取得するには、次のように入力します。
asadmin> get server1.profiler.*
enabled という属性を取得するには、次のように入力します。
asadmin> get server1.profiler.enabled
enabled という属性に false を設定するには、次のように入力します。
asadmin> set server1.profiler.enabled=false
サーバー設定 (サーバーインスタンス名)
次の表では、属性の server.xml 名を左側の列に、asadmin で使用する名前を右側の列に示しています。
インスタンス (server1) からすべての属性を取得するには、次のように入力します。
asadmin> get server1.*
logRoot という属性を取得するには、次のように入力します。
asadmin> get server1.logRoot
logRoot という属性を設定するには、次のように入力します。
asadmin> set server1.logRoot="/space/log"
各オプションに対応する長形式、短形式、デフォルト値、および環境変数
次の表に、コマンド行オプションの長形式と短形式を示します。短形式が記載されていない場合、短形式のオプションは使用できません。
