asadminコマンドは、Java EEの実行環境のための統合コマンドであり、Java EEの実行環境の構築や、システム稼動後の運用操作を行うことができます。
以下について説明します。
コマンドの実行権限 
本コマンドはOSのシステム管理者のみ実行可能です。
コマンド利用時のログイン認証
本コマンドの利用時はログイン認証が必要となります。
ログイン認証ついての詳細は「6.1.5.1 asadminコマンドのログイン認証」を参照してください。
コマンド構成
asadminコマンドは、複数のサブコマンドから構成されています。それぞれのサブコマンドはJava EE運用環境の操作と対応しています。なお、サブコマンドごとに指定できるオプションは異なります。
コマンドの実行時には、以下のように共通オプション、サブコマンド、サブコマンドのオプション、オプション、オペランドを指定します。
C:\Interstage\F3FMisje6\glassfish\bin\asadmin 共通オプション サブコマンド サブコマンドのオプション オペランド |
/opt/FJSVisje6/glassfish/bin/asadmin 共通オプション サブコマンド サブコマンドのオプション オペランド |
注意
Java EEの実行環境の操作は、Interstage Java EE 6 DASサービスを経由して行われます。
そのため、一部のサブコマンドを除き、asadminコマンドの実行時にはInterstage Java EE 6 DASサービスが起動している必要があります。
サブコマンド
サブコマンドは、以下のように操作と操作対象の名前をハイフンでつないだ形式です。
C:\Interstage\F3FMisje6\glassfish\bin\asadmin start-domain |
/opt/FJSVisje6/glassfish/bin/asadmin start-domain |
start: 操作名
domain: 操作対象
サブコマンドの詳細については、「9.1.1 asadminコマンドのサブコマンド一覧」と各サブコマンドの説明を参照してください。
コマンドプロセスのJavaVMオプション設定
asadminコマンドを起動する場合、通常のJavaアプリケーションと同様に内部的にJavaアプリケーションの起動コマンド(Javaコマンド)を使用します。
このJavaアプリケーションの起動コマンドで指定可能なオプション(-Xmxオプションなど)を指定する場合には、環境変数VMARGSを指定してください。以下にオプションの指定例を示します。
VMARGS= -Xmx512m |
注意
-classpathオプションは指定しないでください。
以下のように不当な値を指定した場合、javaコマンドのエラーが発生します。オプションの指定方法はjavaコマンドの説明を参照してください。空白を含む値を指定する場合、値をダブルコーテーション(")で囲む必要があります。
無効なオプションを指定した場合
set VMARGS=-option |
set VMARGS=-option |
不当な空白を指定した場合
set VMARGS=option1 option2 |
set VMARGS=option1 option2 |
オプション
asadminコマンドのオプションは、「--user」のようにキーワードの先頭にハイフンを2つ付加した形式です。
値の指定方法について以下に説明します。
オプション種別 | 値の指定方法 | 使用例 |
|---|---|---|
文字列・数値を指定するオプション | オプションと値の間を空白または「=」で区切って指定する。(注) | --user admin |
注)ハイフン(「-」)から始まるオプションの値を指定する場合、オプション名と値を「=」で区切って指定してください。
Boolean値を指定するオプションは、値を省略してオプションだけを指定できるものがあります。オプションだけを指定する場合は、「=」も省略します。値の指定を省略した場合、デフォルト値としてtrueが設定されます。
これにより、以下の2つの入力は同じ意味になります。
C:\Interstage\F3FMisje6\glassfish\bin\asadmin deploy --enabled=true
|
/opt/FJSVisje6/glassfish/bin/asadmin deploy --enabled=true
|
省略不可のオプションを省略した場合は、オプションの入力が求められます。
C:\Interstage\F3FMisje6\glassfish\bin\asadmin create-jdbc-resource test Enter the value for the connectionpoolid option> DerbyPool JDBC resource test created successfully. Command create-jdbc-resource executed successfully. |
/opt/FJSVisje6/glassfish/bin/asadmin create-jdbc-resource test Enter the value for the connectionpoolid option> DerbyPool JDBC resource test created successfully. Command create-jdbc-resource executed successfully. |
頻繁に使用されるオプションは、英単語一文字の簡略名を指定できます。簡略名の場合は、先頭のハイフンは1つです。簡略名の使用例を以下に示します。
C:\Interstage\F3FMisje6\glassfish\bin\asadmin -p=12011 list-components |
/opt/FJSVisje6/glassfish/bin/asadmin -p=12011 list-components |
複数のオプションを同時に指定したい場合は、空白で区切って指定します。同じオプションが複数指定された場合はエラーになります。
例えば、以下のケースでは、エラーメッセージを表示してコマンドが終了します。
C:\Interstage\F3FMisje6\glassfish\bin\asadmin --port=12011 --port=12011 list-domains |
/opt/FJSVisje6/glassfish/bin/asadmin --port=12011 --port=12011 list-domains |
コマンド実行時に不正なオプションを指定した場合は、サブコマンドのエラーメッセージが表示されてコマンドが終了します。正しいオプションは、「9.1.1 asadminコマンドのサブコマンド一覧」のそれぞれのサブコマンドを参照してください。
オペランド
オペランドはコマンドの引数の最後尾に指定する文字列であり、操作対象の名前などを指定する時に使用します。
正しいオペランドは、「9.1.1 asadminコマンドのサブコマンド一覧」のそれぞれのサブコマンドを参照してください。
省略不可のオペランドを省略した場合は、オペランドの入力が求められます。
C:\Interstage\F3FMisje6\glassfish\bin\asadmin create-jdbc-resource --connectionpoolid DerbyPool Enter the value for the jndi_name operand> test JDBC resource test created successfully. Command create-jdbc-resource executed successfully. |
/opt/FJSVisje6/glassfish/bin/asadmin create-jdbc-resource --connectionpoolid DerbyPool Enter the value for the jndi_name operand> test JDBC resource test created successfully. Command create-jdbc-resource executed successfully. |
ユーザとパスワードの指定
asadminコマンド利用時、以下のいずれかの方法でInterstage Java EE 6 DASサービスへの認証に使用するユーザとパスワードを指定します。
asadminコマンドの実行時に以下のような問い合わせが行われますので、ユーザとパスワードをそれぞれ入力します。
C:\Interstage\F3FMisje6\glassfish\bin\asadmin login |
/opt/FJSVisje6/glassfish/bin/asadmin login |
--userオプションと--passwordfileオプションを指定することで、asadminコマンド実行時のユーザとパスワードの入力を省略できます。
以下に実行例を示します。
C:\Interstage\F3FMisje6\glassfish\bin\asadmin --user admin --passwordfile passwordfile.txt list-domains |
/opt/FJSVisje6/glassfish/bin/asadmin --user admin --passwordfile passwordfile.txt list-domains |
--passwordfileオプションで指定するパスワードファイルは、AS_ADMIN_PASSWORDを使用して記述します。
AS_ADMIN_PASSWORD=パスワード |
なお、指定したパスワードファイルが参照できない場合は、コマンドの実行に失敗します。出力されたエラーメッセージを参照して対処を行ってください。
また、ユーザのホームディレクトリに.asadminpassファイルが存在していても、--passwordfileオプションが指定された場合は--passwordfileオプションの内容が優先されます。
.asadminpassファイルの詳細は、loginサブコマンドを参照してください。
--userオプションと--passwordfileオプションについては「9.1.2 asadminコマンドの共通オプション」も参照してください。
注意
パスワードファイルに記述したパスワードを保護するため、テキストエディタにより作成したパスワードファイルのアクセス権を600に設定してください。
asadminコマンドのloginサブコマンドを利用することで、asadminコマンド実行時のInterstage Java EE 6 DASサービスの管理ユーザーIDとパスワードの入力を省略できます。詳細は、loginサブコマンドを参照してください。
セパレータ
asadminコマンドのオペランド、オプションには複数の値を指定できるものがあります。複数の値を指定する場合、セパレータを指定して各値を区切る必要があります。
セパレータの文字種別は各オペランド、オプションによって異なります。各オペランド、オプションのセパレータは以下の表のとおりになります。
setサブコマンドの場合
オペランド/オプション | セパレータ |
|---|---|
applications.application.${AppName}.libraries |
|
server.java-config.debug-options | 「 」(半角空白) |
server.java-config.javac-options |
setサブコマンド以外の場合
サブコマンド | オペランド/オプション | セパレータ |
|---|---|---|
create-system-properties | name=value | : |
create-jvm-options | jvm-option-name=jvm-option-value | |
delete-jvm-options | jvm-option-name[=jvm-option-value] | |
create-jdbc-connection-pool | --property | |
create-jms-resource | --property | |
create-javamail-resource | --property | |
create-connector-connection-pool | --property | |
create-admin-object | --property | |
create-file-user | --groups | |
update-file-user | --groups | |
create-connector-security-map | --principals | , |
--usergroups | ||
update-connector-security-map | --addprincipals | |
--addusergroups | ||
--removeprincipals | ||
--removeusergroups | ||
--usergroups | ||
set-log-attributes | attribute-name=attribute-value |
エスケープ文字の利用
コマンドのオプションまたはオペランドの値に以下に示す文字を利用する場合、エスケープ文字として'\'を指定する必要があります。
注意
get/set/listサブコマンドのオペランド（定義項目名）には指定できない文字があります。get/set/listサブコマンドのオペランド(定義項目名)で利用可能な文字については、「9.1.4 定義項目参照/更新」の「定義項目名に指定可能な文字」を参照してください。
文字の種類 | 説明 | 文字 |
|---|---|---|
メタ文字(Solaris/Linux) | メタ文字(Solaris/Linux)として利用される文字 | ;&()|><*?[]~+-@!"'\`${}^ (注) |
Javaエスケープシーケンス | Javaにおいてエスケープ文字として利用される文字 | \、"など |
asadminコマンドの区切り文字 | asadminコマンドの区切り文字である文字 | : |
asadminコマンドの特殊文字 | 以下のサブコマンドで、エスケープ文字として利用される特殊文字
| .-:= |
注) 利用しているShellの種類により、メタ文字(Solaris/Linux)として扱われる文字が異なります。Bourne ShellとC Shellのメタ文字(Solaris/Linux)について、以下に説明します。
| Bourne Shell | C Shell |
| Bourne Shell | C Shell |
| Bourne Shell | C Shell |
|---|---|---|---|---|---|---|---|---|
; | ○ | ○ | ? | × | ○ | " | ○ | ○ |
& | ○ | ○ | [ | × | ○ | ' | ○ | ○ |
( | ○ | ○ | ] | × | × | \ | ○ | ○ |
) | ○ | ○ | ~ | × | × | ` | ○ | ○ |
| | ○ | ○ | + | × | － | $ | ○ | ○ |
> | ○ | ○ | - | × | － | { | － | ○ |
< | ○ | ○ | @ | × | － | } | － | × |
* | × | ○ | ! | ○ | ○ | ^ | － | × |
○:エスケープが必要
×:エスケープは不要
－:メタ文字(Solaris/Linux)ではない
例
エスケープ文字の利用の実行例
実行例を以下に示します。
オプションの値に「c:\foo\bar」を指定する場合、以下のようにエスケープ文字を使用します。
C:\Interstage\F3FMisje6\glassfish\bin\asadmin create-jvm-options -Dlocation=c\:\\foo\\bar |
/opt/FJSVisje6/glassfish/bin/asadmin create-jvm-options -Dlocation=c\\:\\\\foo\\\\bar |
propertyオプションに以下のnameとvalueを指定する場合について説明します。
user=scott:password=tiger:url=jdbc:oracle:thin:@//localhost:1521/sampledb |
以下のようにエスケープ文字を使用します。
C:\Interstage\F3FMisje6\glassfish\bin\asadmin create-jdbc-connection-pool --datasourceclassname oracle.jdbc.pool.OracleDataSource --restype javax.sql.DataSource --property user=scott:password=tiger:url=jdbc\:oracle\:thin\:@//localhost\:1521/sampledb SamplePool |
/opt/FJSVisje6/glassfish/bin/asadmin create-jdbc-connection-pool --datasourceclassname oracle.jdbc.pool.OracleDataSource --restype javax.sql.DataSource --property user=scott:password=tiger:url=jdbc\\:oracle\\:thin\\:@//localhost\\:1521/sampledb SamplePool |
C:\Interstage\F3FMisje6\glassfish\bin\asadmin create-jvm-options -e\:-Dlocation=c\:\\foo\\bar |
/opt/FJSVisje6/glassfish/bin/asadmin create-jvm-options -e\\:-Dlocation=c\\:\\\\foo\\\\bar |
この場合、'\'の本来の意味を表現するために4つのエスケープ文字(\\\\)を指定する必要があります。それぞれの'\'の意味は以下のとおりです。
1つ目の'\': メタ文字(Solaris/Linux)のエスケープ
2つ目の'\': Javaエスケープシーケンスのエスケープ
3つ目の'\': メタ文字(Solaris/Linux)のエスケープ
4つ目の'\': 本来の'\'を意味します
1つ目の'\'は2つ目の'\'に対するエスケープ、3つ目の'\'は4つ目の'\'に対するエスケープです。
'\'に対してJavaエスケープシーケンスを指定する場合、"\\"と表記します。
'\'はメタ文字(Solaris/Linux)に該当するため、Solaris/Linuxのasadminコマンドで上記を指定する場合はそれぞれの'\'に対してエスケープ文字として'\'を付加する必要があります。
get/set/listサブコマンドで、「sample.name」のようにピリオドが含まれた文字列をキー名に指定する場合、以下のようにエスケープ文字を使用します。
C:\Interstage\F3FMisje6\glassfish\bin\asadmin set applications.application.appName.property.sample\.name=samplevalue |
/opt/FJSVisje6/glassfish/bin/asadmin set testserver.property.sample\\.name=samplevalue |
オペランドに先頭が'-'である文字列を指定し、かつ、その文字列がコマンドオプションと合致する場合、先頭の'-'をエスケープする必要があります。
例えば、-s、-o=value、--switch、--option=valueなどをオペランドに指定する場合は、先頭の'-'をエスケープする必要があります。
以下に使用例で説明します。
create-jvm-options、delete-jvm-optionsサブコマンドで、オプションの値に「-Xmx512m」や「-Dlocation=c:\foo\bar」を指定する場合、以下のようにエスケープ文字を使用します。
C:\Interstage\F3FMisje6\glassfish\bin\asadmin create-jvm-options \-Dlocation=c\:\\foo\\bar (注1) |
/opt/FJSVisje6/glassfish/bin/asadmin create-jvm-options \\-Dlocation=c\\:\\\\foo\\\\bar (注1) |
注1) create-jvm-optionsサブコマンドで、「-xxxx=yyyy」(xxxxはオプション、yyyyは指定値)の形式のオペランド(Java VMのオプション)を指定する場合は、以下のようにオプションの「-」部分についてはエスケープ文字を使用しないで指定することもできます。
C:\Interstage\F3FMisje6\glassfish\bin\asadmin create-jvm-options -Dlocation=c\:\\foo\\bar |
/opt/FJSVisje6/glassfish/bin/asadmin create-jvm-options -Dlocation=c\\:\\\\foo\\\\bar |
注2) create-jvm-optionsサブコマンドで、「-xxxx」(xxxxはオプション)の形式のオペランドを指定する場合は、注1)の場合と異なり、例のようにオプションの「-」部分についてエスケープ文字を使用する必要があります。
空白を含む文字列の指定
list-domainsサブコマンドで、オプション「passwordfile」の値に「sample password.txt」を指定する場合、以下のように実行します。
C:\Interstage\F3FMisje6\glassfish\bin\asadmin --passwordfile "sample password.txt" list-domains |
コマンドラインでは、コマンドオプションに空白を含む文字列を指定できません。
注意
空白を含む文字列を指定する場合の注意
末尾が空白である値は指定できません。指定した場合、末尾の空白が取り除かれた値が有効になります。
入力文字列長の上限
asadminコマンド実行時の入力文字列長の上限を以下に示します。
|
|
|---|---|
6984バイト | 256バイト |
asadminコマンドの注意事項
注意
asadminコマンドの競合操作は行わないでください。
動作不定となるため、asadminコマンドの実行画面でCtrl+Cの操作を行わないでください。
