test

Sun GlassFish Enterprise Server v3 管理ガイド

asadmin ユーティリティーの使用

Sun GlassFish Enterprise Server の管理タスクを実行するには、コマンド行またはスクリプトから asadmin ユーティリティーを使用します。このユーティリティーは、管理コンソール インタフェースの代わりに使用できます。

ここでは、次のテーマを取り上げます。

asadmin ユーティリティーのパス

asadmin ユーティリティは、as-install /bin ディレクトリにあります。パスを指定せずに asadmin ユーティリティーを実行するには、このディレクトリをパスに入れてください。

asadmin ユーティリティーの構文

asadmin ユーティリティーを実行するための構文は次のとおりです。


asadmin [asadmin-util-options] [subcommand [subcommand-options] [operands]]

この構文で置き換え可能な項目については、以降の項で説明します。この構文の詳細については、asadmin(1M) のマニュアルページを参照してください。

asadmin ユーティリティーのサブコマンド

次の「サブコマンド」は、実行する動作またはタスクを指定します。サブコマンドは大文字と小文字を区別します。サブコマンドは、ローカルサブコマンドとリモートサブコマンドのいずれかです。

このリリースの Enterprise Server のサブコマンドリストについては、『Sun GlassFish Enterprise Server v3 Reference Manual』の第 1 節を参照してください。

asadmin ユーティリティーのオプションとサブコマンドのオプション

オプションは、asadmin ユーティリティーとそのサブコマンドの動作を制御します。オプションは大文字と小文字を区別します。

asadmin ユーティリティーには、次のタイプのオプションがあります。

サブコマンドオプションの名前が、asadmin ユーティリティーのオプションの名前と同じ場合がありますが、2 つのオプションの効果は異なります。

オプションには、長形式と省略形式があります。

たとえば、terse 出力を指定するオプションの省略形式と長形式は次のとおりです。

論理型オプションを除く多くのオプションには、機能の有効と無効を切り替える引数の値が必要です。

asadmin ユーティリティーのサブコマンドのオペランド

オペランドは、サブコマンドの動作対象となる項目を指定します。オペランドは、サブコマンドオプションの引数の後に指定する必要があり、空白 1 文字、タブ 1 文字、またはダッシュ 2 文字 (--) で区切ります。asadmin ユーティリティーは、サブコマンドオプションとその値に続くものはすべて、オペランドとして扱います。

Procedureシングルモードで asadmin ユーティリティーのサブコマンドを実行する

シングルモードでは、使用するサブコマンドについて個々に asadmin コマンドを入力する必要があります。 サブコマンドの実行後は、オペレーティングシステムのコマンドシェルに戻ります。asadmin ユーティリティーのオプションは、実行する asadmin コマンドについて個々に指定する必要があります。複数のサブコマンドについて同じ asadmin ユーティリティーのオプションが必要な場合は、マルチモードで asadmin ユーティリティーを使用します。詳細については、「マルチモードセッションを開始する」を参照してください。

  1. オペレーティングシステムのコマンドシェルで、asadmin ユーティリティーを実行してサブコマンドを指定します。

    必要に応じて、必須の asadmin ユーティリティーのオプション、サブコマンドのオプション、およびオペランドも指定します。

例 2–1 シングルモードでの asadmin ユーティリティーのサブコマンド実行

この例は、シングルモードでサブコマンド list-applications(1) を実行します。この例では、すべてのオプションでデフォルト値を使用します。

この例は、ローカルホストでアプリケーション hello が配備されていることを示します。


asadmin list-applications
hello <web>

Command list-applications executed successfully.
例 2–2 シングルモードでの asadmin ユーティリティーオプションとサブコマンドの指定

この例は、シングルモードで asadmin ユーティリティーのオプション --host とサブコマンド list-applications を指定します。この例では、DAS はホスト srvr1.example.com で稼働中です。

この例は、アプリケーション basic-ezcomp、scrumtoys、ejb31-war、および automatic-timer-ejb がホスト srvr1.example.com に配備されていることを示します。


asadmin --host srvr1.example.com list-applications
basic-ezcomp <web>
scrumtoys <web>
ejb31-war <ejb, web>
automatic-timer-ejb <ejb>

Command list-applications executed successfully.
例 2–3 シングルモードでの asadmin ユーティリティーオプションとサブコマンドオプションの指定

この例は、シングルモードで asadmin ユーティリティーオプション --host、サブコマンドオプション --type、およびサブコマンド list-applications を指定します。この例では、DAS がホスト srvr1.example.com で稼働し、web タイプのアプリケーションが一覧表示されます。


asadmin --host srvr1.example.com list-applications --type web
basic-ezcomp <web>
scrumtoys <web>
ejb31-war <ejb, web>

Command list-applications executed successfully.

Procedureasadmin ユーティリティーまたはサブコマンドのヘルプ情報を表示する

Enterprise Server には、asadmin ユーティリティーとそのサブコマンドの構文、目的、およびオプションに関するヘルプ情報が用意されています。このヘルプ情報は、UNIX® プラットフォームのマニュアルページのスタイルで作成されています。このヘルプ情報は、『Sun GlassFish Enterprise Server v3 Reference Manual』にも記載されています。

  1. リモートサブコマンドのヘルプ情報を表示する場合は、サーバーが稼働中であることを確認してください。

    リモートサブコマンドを実行するには、稼働中のサーバーが必要です。

  2. 対象のサブコマンドを、help サブコマンドのオペランドとして指定します。

    オペランドを指定せずに help サブコマンドを実行した場合、asadmin ユーティリティーのヘルプ情報が表示されます。

例 2–4 asadmin ユーティリティーのヘルプ情報の表示

この例は、asadmin ユーティリティーのヘルプ情報を表示します。


asadmin help
例 2–5 asadmin ユーティリティーサブコマンドのヘルプ情報表示

この例は、サブコマンド create-jdbc-resource のヘルプ情報を表示します。


asadmin help create-jdbc-resource
参照

使用できるサブコマンドを表示するには、サブコマンド list-commands(1) を使用します。ローカルサブコマンドが、リモートサブコマンドの前に表示されます。サーバーが稼働していない場合は、ローカルサブコマンドのみが表示されます。

Procedureマルチモードセッションを開始する

asadmin ユーティリティーは、複数コマンドモード、つまりマルチモードで使用できます。マルチモードでは、asadmin ユーティリティーを一度実行してマルチモードセッションを開始します。セッションを終了してオペレーティングシステムのコマンドシェルに戻るまでの間、asadmin ユーティリティーは継続してサブコマンドを受け取ります。マルチモードセッションで設定した asadmin ユーティリティーのオプションは、セッションの後続のサブコマンドすべてについて使用されます。

注 –

マルチモードセッションを開始するには、稼働中の DAS は「不要」です。

  1. 次のいずれかの操作を行います。

    • サブコマンドを指定せずに asadmin ユーティリティーを実行します。

    • サブコマンド multimode(1) を使用します。

    必要に応じて、マルチモードセッション全体に適用する asadmin ユーティリティーのオプションも指定します。

    マルチモードセッションでは、コマンド行に asadmin> プロンプトが表示されます。このプロンプトに asadmin のサブコマンドを入力して Enterprise Server を管理できます。

例 2–6 asadmin ユーティリティーオプションによるマルチモードセッション開始

この例は、マルチモードセッションを開始し、asadmin ユーティリティーのオプション --user および --passwordfile をこのセッションに設定します。


asadmin --user admin1 --passwordfile pwd.txt multimode
例 2–7 サブコマンド multimode によるマルチモードセッションの開始

この例は、サブコマンド multimode を使用して、デフォルトの asadmin ユーティリティーのオプションを使用するマルチモードセッションを開始します。


asadmin multimode

コマンド行に asadmin> プロンプトが表示されます。

例 2–8 マルチモードセッションでのサブコマンドの実行

この例は、マルチモードセッションを開始し、そのセッションでサブコマンド list-domains を実行します。


asadmin
Enter commands one per "line", ^D to quit
asadmin> list-domains
Name: domain1 Status: Running
Command list-domains executed successfully.
asadmin>
既存のマルチモードセッションからのマルチモードセッション開始

既存のセッションからマルチモードセッションを開始するには、既存のセッションからサブコマンド multimode を実行します。2 つ目のマルチモードセッションを終了すると、元のマルチモードセッションに戻ります。

参照

また、コマンド行に asadmin help multimode を入力して、サブコマンドの詳細構文とオプションも表示できます。

Procedureマルチモードセッションを終了する

  1. asadmin> プロンプトに、次のコマンドまたはキーコンビネーションのいずれかを入力します。

    • exit

    • quit

    • UNIX および Linux システム: Ctrl-D

    • Windows システム: Ctrl-Z

    オペレーティングシステムのコマンドシェルに戻ります。asadmin> プロンプトは表示されなくなります。asadmin> プロンプトがまだ表示されている場合は、マルチモードセッションからマルチモードセッションを開いた可能性があります。この場合は、この手順を繰り返して残りのマルチモードセッションを終了します。

Procedureファイルから asadmin の一連のサブコマンドを実行する

ファイルから asadmin の一連のサブコマンドを実行すると、繰り返し実行するタスクを自動化できます。

  1. 実行するサブコマンドのシーケンスを含むプレーンテキストファイルを作成します。

  2. 作成したファイルを指定して、サブコマンド multimode(1) を実行します。

    必要に応じて、ファイル内のサブコマンドを実行可能にするために必要な asadmin ユーティリティーのオプションも指定します。

例 2–9 ファイルからの asadmin の一連のサブコマンドの実行

この例には、次のものが含まれます。

commands_file.txt ファイルには、次の動作シーケンスを実行するための asadmin ユーティリティーのサブコマンドがあります。

  1. ドメイン customdomain の作成

  2. ドメイン customdomain の開始

  3. 使用できるすべてのサブコマンドの一覧表示

  4. ドメイン customdomain の停止

  5. ドメイン customdomain の削除

ファイル commands_file.txt の内容は次のとおりです。

create-domain --portbase 9000 customdomain
start-domain customdomain
list-commands
stop-domain customdomain
delete-domain customdomain

この例は、commands_file.txt ファイル内のサブコマンドのシーケンスを実行します。ファイル内のサブコマンド create-domain にオプション --portbase が指定されているので、asadmin ユーティリティーのオプション --port も設定する必要があります。


asadmin --port 9048 multimode --file commands_file.txt
参照

上の例のサブコマンドの詳細については、次のマニュアルページを参照してください。