asadmin ユーティリティー

asadmin ユーティリティーを使用すると、Application Server の管理タスクを実行できます。この asadmin ユーティリティーは、管理者インタフェースの代わりに使用できます。

asadmin ユーティリティーは、ユーザーの実行する操作やタスクを特定するサブコマンドを呼び出します。サブコマンドは大文字と小文字を区別します。短形式のオプションの引数にはダッシュ (-) が、長形式のオプションの引数には二重ダッシュ (--) が付いています。オプションによって、ユーティリティーによるサブコマンドの実行方法を制御します。オプションでも大文字と小文字を区別します。機能のオン/オフを切り替えるブール型のオプションを除いて、大部分のオプションには引数値が必要です。オペランドは引数値の後ろに表示され、空白、タブ、または二重ダッシュ (--) で区切られます。asadmin ユーティリティーでは、オプションとその値の後ろに続くものをオペランドとして処理します。

asadmin は、コマンドシェルを呼び出して、またはマルチコマンドモード (multimode コマンドと呼ばれる) で使用できます。コマンドシェルの呼び出しを使用する場合は、コマンドシェルから asadmin ユーティリティーを呼び出します。asadmin がコマンドを実行し、終了します。マルチコマンドモードでは、一度 asadmin を呼び出すと、asadmin が終了するまで複数のコマンドが受け入れられます。終了後は通常のコマンドシェルの呼び出しに戻ります。マルチコマンドモードで設定した環境変数は、multimode を終了するまで、あとに続くすべてのコマンドに使用されます。また、あらかじめ準備したコマンドの一覧をファイルまたは標準入力から渡す (パイプする) ことによって、コマンドを提供することもできます。また、マルチモードセッション内から multimode を呼び出すこともできます。2 つ目のマルチモード環境を終了すると、元のマルチモード環境に戻ります。

また、asadmin ユーティリティーは、対話型オプションまたは非対話型オプションで実行できます。デフォルトでは、対話型オプションが有効になっています。対話型オプションでは、必要な引数を入力するように求められます。対話型オプションは、すべての環境のコマンドシェルの呼び出しで使用することができます。コマンドプロンプトから一度に 1 つのサブコマンドを実行したり、ファイルから multimode で実行したりするときは、multimode で対話型オプションを使用できます。multimode のサブコマンド (入力ストリームからパイプされた場合) や、別のプログラムから呼び出されたサブコマンドは、対話型オプションでは実行できません。

ローカルサブコマンドは、管理サーバーが存在しなくても実行できます。ただし、サブコマンドを実行したり、インストールディレクトリやドメインディレクトリに対するアクセス権を得たりするには、ドメインをホストしているマシンにユーザーがログインする必要があります。リモートサブコマンドの実行は、管理サーバーに接続してサブコマンドを実行することによって常に行われます。稼働中の管理サーバーが必要です。すべてのリモートサブコマンドで、次のオプションが必須になります。

• -u -‐user 認証されたドメインアプリケーションサーバーの管理ユーザー名。

• -‐passwordfile ドメインアプリケーションサーバーのパスワードを格納したファイル。形式は AS_ADMIN_PASSWORD= password です。password には、実際の管理者パスワードを指定します。

• -H -‐host ドメインアプリケーションサーバーが稼働しているマシン名。

• -p -‐port 管理要求を待機しているドメインアプリケーションサーバーのポート番号。デフォルトのポート番号は 4848 です。

• -s -‐secure true の場合、SSL/TLS を使用してドメインアプリケーションサーバーと通信します。

• -t -‐terse 出力データを簡潔にします。通常、人間が読みやすい文を避けて、スクリプトで使用するために整形されたデータを優先します。デフォルトは false です。

• -e -‐echo true に設定すると、コマンド行の文が標準出力にエコーされます。デフォルトは false です。

• -I -‐interactive true に設定した場合 (デフォルト)、必須パスワードオプションのみの入力が要求されます。

• -h -‐help コマンドに関するヘルプテキストが表示されます。

ローカルまたはリモートで実行できるサブコマンドの場合、環境内またはコマンド行のどちらかで、--host、--port、--user、および --passwordfile オプションのいずれか 1 つが設定されていれば、そのサブコマンドはリモートモードで実行されます。さらに、ローカルまたはリモートで実行できるサブコマンドの場合、--local オプションが true に設定されていると、そのサブコマンドはローカルで実行されます。また、コマンド行または環境内で、ローカルオプションが何も設定されていない場合でも、デフォルトでサブコマンドはローカルで実行されます。--local オプションが true に設定されていると、ローカルの --host、--port、--user、および --passwordfile の設定が指定されている場合でも、それらより優先されます。サブコマンドはローカルモードで実行されます。

ローカルで実行できるサブコマンドでは、対象のドメインを指定する --domain オプションを使用でき、ドメインが 1 つだけの場合は、そのドメインがデフォルトドメインとみなされます。複数のドメインが存在する場合、--domain オプションは必須オプションになります。ローカルまたはリモートで実行できるサブコマンドの場合、リモートで --host、--port、--user、および --passwordfile オプションを指定して実行すると、--domain オプションは無視されます。サブコマンドがリモートモードで実行される場合、--domain オプションは無視されます。ドメインごとに 1 つの管理インスタンスがあるため、1 つのマシンに複数のドメインがある場合、ローカルでの実行するときはドメインを指定し、リモートで実行するときはそのドメインの管理インスタンスの --host、--port、--user、および --passwordfile オプションを指定してください。

セキュリティーのため、コマンド行でパスワードを入力する代わりに、ファイルからサブコマンドのパスワードを設定することができます。--passwordfile オプションを使用すると、パスワードを格納したファイルを取得できます。このファイルの有効な内容は次のとおりです。

例 C–1 パスワードファイルの内容

AS_ADMIN_PASSWORD=value
AS_ADMIN_ADMINPASSWORD=value
AS_ADMIN_USERPASSWORD=value
AS_ADMIN_MASTERPASSWORD=value

AS_ADMIN_PASSWORD がグローバル環境にエクスポートされている場合、--passwordfile オプションを指定すると、--password オプションの使用に関する警告が表示されます。この警告が表示されないようにするには、AS_ADMIN_PASSWORD の設定を取り消します。マスターパスワードは、コマンド行または環境変数では伝達されませんが、passwordfile で指定できます。

--secure オプションを使用するには、set コマンドを使用して、domain.xml 内の admin http-listener でセキュリティーの --enabled フラグを有効にします。asadmin のサブコマンドを使用して作成や削除を行った場合、新しく作成したコマンドを有効にするには、サーバーを再起動する必要があります。サーバーを再起動するには、start-domain コマンドを使用します。

Solaris プラットフォーム上の Application Server のコマンド行インタフェースサブコマンドのマニュアルページにアクセスするには、MANPATH 環境変数に $AS_INSTALL/man を追加します。

asadmin ユーティリティーサブコマンドの全体的な使用法の情報は、--help オプションを呼び出すことで取得できます。サブコマンドを指定すると、そのサブコマンドの使用法が表示されます。サブコマンドを指定せずに --help オプションを実行すると、使用可能なすべてのサブコマンドの一覧が表示されます。