2.2.2　asadmin

管理タスクの実行

書式

asadmin [--host host] [--port port] [--user admin-user]
    [--passwordfile filename] [--terse={true|false}]
    [--secure={false|true}] [--echo={true|false}]
    [--interactive={true|false}] [--detach={true|false}]
    {--help|subcommand [options] [operands]}

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

asadminユーティリティーコマンドを使用して、Java EE Serverの管理タスクを実行します。

asadminユーティリティーコマンドには次のオプションがあります：

asadminオプション

asadminユーティリティーコマンドの動作を制御しますが、サブコマンドの動作は制御しません。asadminオプションはサブコマンドの前後に指定できますが、サブコマンドのあとにasadminオプションを指定することは推奨しません。また、asadminオプションはサブコマンドの前または後ろのどちらか一方に統一して指定しなければなりません。サブコマンドの前後ばらばらにasadminオプションを指定すると、エラーが発生します。
サブコマンドオプション

サブコマンドの動作を制御しますが、asadminユーティリティーコマンドの動作は制御しません。サブコマンドオプションはサブコマンドの後ろに指定します。

asadminオプションと一部のサブコマンドオプションには長形式と短形式があります。

長形式の場合

2つのハイフン（--）の後にオプション文字列が続きます。
短形式の場合

1つのハイフン（-）の後に単一文字が続きます。

Booleanオプション（機能の有効・無効を切り替えるオプション）を除く、ほとんどのオプションでは引数値が必要となります。

オペランドにはサブコマンドが処理する項目を指定します。オペランドはサブコマンドオプションの引数値に続いて指定し、スペース、タブ、または2つのハイフン（--）で区切ります。asadminユーティリティーはサブコマンドオプションやその値に続く文字列をオペランドとして処理します。

asadminサブコマンドには、サーバ間の通信またはコマンド処理の時間に対して、タイムアウトが設定されています。すべてのサブコマンドに共通のタイムアウトとしては「リードタイムアウト」および「リクエストタイムアウト」があります。

asadminプロセスに適用するリードタイムアウトの値は、環境変数AS_ADMIN_READTIMEOUTに指定できます。リクエストタイムアウトの値は、asadminユーティリティーのsetサブコマンドおよびgetサブコマンドの次のプロパティーで設定および確認できます。

configs.config.name.network-config.protocols.protocol.admin-listener.http.request-timeout-seconds
configs.config.name.network-config.protocols.protocol.sec-admin-listener.http.request-timeout-seconds

コロン（:）を区切り文字として使用するオプションでは、シングルクォーテーション（'）やダブルクォーテーション（"）の前に円記号付きのエスケープ文字（\）が必要です。

asadminユーティリティーでは、コロン（:）を区切り文字として使用するオプションがあります。コロン（:）がJava VMのプロパティーまたはオプションの一部である場合は、円記号付きのエスケープ文字（\）が必要です。円記号付きのエスケープ文字（\）の代わりに、ダブルクォーテーション（"）やシングルクォーテーション（'）を使用できます。これら2種類の文字での円記号（\）の扱いを次に示します。

ダブルクォーテーション（"）で囲まれている場合、円記号（\）は特殊文字として扱われます。
シングルクォーテーション（'）で囲まれている場合、円記号（\）は特殊文字として扱われません。

前提条件

ローカルモードの場合、サブコマンドを実行してインストールディレクトリーやドメインディレクトリーにアクセスするには、ユーザーはそのドメインのホストマシンにログインする必要があります。

環境変数

次に示す環境変数を使って、asadminオプションのデフォルト値を変更できます。

AS_ADMIN_TERSE
AS_ADMIN_ECHO
AS_ADMIN_INTERACTIVE
AS_ADMIN_HOST
AS_ADMIN_PORT
AS_ADMIN_SECURE
AS_ADMIN_USER
AS_ADMIN_PASSWORDFILE
AS_ADMIN_HELP
AS_ADMIN_READTIMEOUT

ファイル

--passwordfileオプションにはパスワードエントリーを含んだファイルが必要です。

引数

--help | -?

asadminユーティリティーのヘルプテキストを表示します。

--host host | -H host

ドメイン管理サーバが起動しているマシンの名称を指定します。

型：String

指定できる値を次に示します。

ドメイン管理サーバが起動しているマシン名

デフォルト値：localhost

--port port | -p port

管理用HTTPポートまたはHTTPSポートを指定します。

型：String

指定できる値を次に示します。

管理用HTTPポートまたはHTTPSポート

デフォルト値：4848

--user admin-user | -u admin-user

ドメイン管理サーバの権限を持つ管理ユーザーのユーザー名を示します。loginサブコマンドを使用してドメイン認証が完了している場合は、ドメイン上の後続のオペレーションに対して--userオプションを指定する必要はありません。

型：String

指定できる値を次に示します。

ユーザー名

デフォルト値：なし

--passwordfile filename | -W filename

特定の形式のパスワードエントリーを含んでいるファイルの名称をフルパスで指定します。これらのパスワードエントリーは平文でパスワードファイルに格納されています。セキュリティーに関する追加設定をする場合は、create-password-aliasサブコマンドを使用して、リモートサブコマンドが使用するパスワードのエイリアスを作成します。エイリアス作成済みのパスワードは暗号化されて格納されます。

パスワードに対しエイリアスが存在する場合は、次に示すように、そのパスワードエントリーにエイリアスを指定します。

AS_ADMIN_password-name=${ALIAS=password-alias-name}

型：String

指定できる値を次に示します。

パスワードファイル名のフルパス

デフォルト値：なし

--terse={true|false} | -t={true|false}

trueを設定した場合、簡潔で、スクリプトでの利用に最適化した形式のデータを出力します。この形式で出力したデータは、ユーザーが参照するには適していません。通常、説明文と詳細なステータスメッセージはこの出力データから省略されます。

型：Boolean

指定できる値を次に示します。

true
false

デフォルト値：false

--secure={true|false} | -s={true|false}

trueを設定した場合、ドメイン管理サーバとの通信でSSL/TLSを使用します。

型：Boolean

指定できる値を次に示します。

true
false

デフォルト値：false

--echo={true|false} | -e={true|false}

trueを設定した場合、標準出力時にコマンドライン文を出力します。

型：Boolean

指定できる値を次に示します。

true
false

デフォルト値：false

--interactive={true|false} | -I={true|false}

必要なオプションだけをプロンプト表示するかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true
false

デフォルト値：

asadminユーティリティーをコンソール画面から起動している場合：true
asadminユーティリティーをスクリプト内から起動している場合：false

--detach={true|false}

trueを設定した場合、指定したasadminサブコマンドをバックグラウンドでデタッチおよび実行します。この処理はデタッチモードで行われます。--detachオプションは長時間実行のサブコマンドを使用する場合に活用できます。また、1つのコンソールまたはスクリプトから複数の独立したサブコマンドを実行できます。--detachオプションはサブコマンドの前に指定します。

型：Boolean

指定できる値を次に示します。

true
false

デフォルト値：false

使用例

次の例では、ローカルホストにデプロイされているすべてのアプリケーションを表示します。

asadmin list-applications

2.2.2 asadmin

2.2.2　asadmin