get/set/listサブコマンドを使用することで、コマンドラインから定義値の参照や更新を行うことができます。
これらのサブコマンドには、以下の特徴があります。
getサブコマンドを使用することで、定義項目の値を取得できます。
listサブコマンドを使用することで、カテゴリの一覧を確認できます。
getやlistサブコマンドで指定する定義項目名がわからない場合でも、ワイルドカード(*)により、複数の定義情報を一括で獲得できます。
オプションの指定により、出力結果をファイルに記録できます。
オプションの指定により、設定内容を記述したファイルを読み込んで定義更新できます。
定義項目
定義項目は以下のようにカテゴリごとに階層化されており、カテゴリとプロパティ名はピリオド(.)で区切られます。
clusterName.category1.category3.property1 |
最上位のカテゴリ一覧とInterstage Java EE管理コンソールとの対応を以下に示します。操作可能な定義項目については、「13.2 asadminコマンドで操作できる定義項目」を参照してください。
カテゴリ名 | 操作対象 | Interstage Java EE管理コンソール定義箇所 |
|---|---|---|
configs.config.http-service | HTTPサービス | 設定 > ${設定名} > HTTPサービス |
configs.config.iiop-service | IIOPサービス | 設定 > ${設定名} > ORB |
configs.config.admin-service | 管理サービス | 設定 > ${設定名} > 管理サービス |
configs.config.connector-service | コネクタサービス | 設定 > ${設定名} > コネクタサービス |
configs.config.web-container | Webコンテナ | 設定 > ${設定名} > Webコンテナ |
configs.config.ejb-container | EJBコンテナ | 設定 > ${設定名} > EJBコンテナ |
configs.config.mdb-container | MDBコンテナ | 設定 > ${設定名} > EJBコンテナのMDB設定タブ |
configs.config.jms-service | JMSサービス | 設定 > ${設定名} > Java メッセージサービス |
configs.config.log-service | ログ | 設定 > ${設定名} > ロガーの設定 |
configs.config.security-service | セキュリティ | 設定 > ${設定名} > セキュリティ |
configs.config.transaction-service | トランザクションサービス | 設定 > ${設定名} > トランザクションサービス |
configs.config.monitoring-service | 監視サービス | 設定 > ${設定名} > 監視 |
configs.config.java-config | Java | 設定 > ${設定名} > JVM設定 |
configs.config.thread-pools | スレッドプール | 設定 > ${設定名} > スレッドプール |
configs.config.group-management-service | グループ管理サービス | 設定 > ${設定名} > グループ管理サービス |
configs.config.system-property | システムプロパティ | 設定 > ${設定名} > システム設定 |
configs.config.ijserver-control | プロセス制御設定 | 設定 > ${設定名} > プロセス制御 |
resources.custom-resource | カスタムリソース | リソース > JNDI > カスタムリソース |
resources.external-jndi-resource | 外部JNDIリソース | リソース > JNDI > 外部リソース |
resources.jdbc-resource | JDBCリソース | リソース > JDBC > JDBCリソース |
resources.mail-resource | JavaMailセッション | リソース > JavaMailセッション |
resources.admin-object-resource | 管理オブジェクトリソース | リソース > コネクタ > 管理オブジェクトリソース |
resources.connector-resource | コネクタリソース | リソース > コネクタ > コネクタリソース |
resources.resource-adapter-config | コネクタモジュール(リソースアダプタ) | アプリケーション > コネクタモジュール |
resources.jdbc-connection-pool | JDBC接続プール | リソース > JDBC > 接続プール |
resources.connector-connection-pool | コネクタ接続プール | リソース > コネクタ > コネクタ接続プール |
定義項目名に指定可能な文字
定義項目名には、以下の文字を指定できます。
英小文字 abcdefghijklmnopqrstuvwxyz
英大文字 ABCDEFGHIJKLMNOPQRSTUVWXYZ
数字 0123456789
記号 (){}[];<>@$#-_/.
ワイルドカードやエスケープ文字について
get/listサブコマンドは、以下のようにカテゴリや定義項目名の末尾にピリオドとアスタリスクを指定できます。
asadmin list IJServer001.* |
この場合、アスタリスクがワイルドカードの働きをします。
指定したカテゴリの配下の要素を表示したい場合は、末尾に「.*」を指定します。
例えば、以下の例ではIJServer001配下のカテゴリがすべて表示されます。
asadmin list IJServer001.* |
サブカテゴリも含めてすべてを表示したい場合は、末尾に「.*.*」を指定します。
例えば、以下の例ではIJServer001配下のプロパティがすべて表示されます。
asadmin get IJServer001.*.* |
以下のようにget/listサブコマンドの引数にアスタリスクだけを指定した場合、カレントディレクトリのファイル一覧がコマンドの引数となり、オペランドが不正となるためエラーとなります。
asadmin list * |
なお、コマンドをマルチモードで実行している場合は問題ありません。
また、名前にピリオド(.)を含んだカテゴリやプロパティを指定する場合は、エスケープ文字として'\'を指定します。
asadmin set IJServer001.http-service.property.dot\.sample=value |
getサブコマンドによる定義参照時、setサブコマンドで指定したエスケープ文字は表示されません。getサブコマンドで表示された定義内容を修正してsetサブコマンドで再設定する場合は、必要に応じてエスケープ文字を再度指定してください。エスケープ文字の指定方法の詳細は、「エスケープ文字の利用」を参照してください。
サーバーインスタンス/IJServerクラスタ/設定の指定方法について
サーバーインスタンス/IJServerクラスタ/設定の配下の項目を参照/更新する場合、以下のように指定します。
操作対象が「サーバーインスタンス」の場合
サーバーインスタンス名を指定して参照/更新します。
例) asadmin get Server001.start-instance-in-startup
サーバーインスタンス名を指定して参照/更新します。
例) asadmin get Server001.application-ref.MEjbApp.enabled
操作対象が「IJServerクラスタ」の場合
IJServerクラスタ名を指定して参照/更新します。
例) asadmin get IJServer001.heartbeat-enabled
操作対象が「設定」の場合
設定名を指定して参照/更新します。
例) asadmin get IJServer001-config.dynamic-reconfiguration-enabled
サーバーインスタンス名、IJServerクラスタ名、設定名のいずれかを指定して参照/更新します。
サーバーインスタンス名、IJServerクラスタ名を指定した場合、参照している設定を指定したのと同じ意味となります。
例1) asadmin get Server001.http-service.access-log.log-backup-size
例2) asadmin get IJServer001.http-service.access-log.log-backup-size
例3) asadmin get IJServer001-config.http-service.access-log.log-backup-size
形式
get [--terse[=true|=false]] [--echo[=true|=false]] [--interactive[=true|=false]] [--host host] [--port port] [--secure[=true|=false]] [--user admin_user] [--passwordfile file_name] [--help] [--file filename] [--encoding {UTF-8|SJIS|EUC}] property_name[ property_name]...
機能説明
指定した定義項目の値を表示します。
asadminコマンドの利用方法・注意事項については、「13.1 asadmin」も参照してください。
オプション
オプション名 | 簡略名 | 説明 |
|---|---|---|
--terse | -t | 「13.1.2 asadminコマンドの共通オプション」を参照してください。 |
--echo | -e | 「13.1.2 asadminコマンドの共通オプション」を参照してください。 |
--interactive | -I | 「13.1.2 asadminコマンドの共通オプション」を参照してください。 |
--host | -H | 「13.1.2 asadminコマンドの共通オプション」を参照してください。 |
--port | -p | 「13.1.2 asadminコマンドの共通オプション」を参照してください。 |
--secure | -s | 「13.1.2 asadminコマンドの共通オプション」を参照してください。 |
--user | -u | 「13.1.2 asadminコマンドの共通オプション」を参照してください。 |
--passwordfile | なし | 「13.1.2 asadminコマンドの共通オプション」を参照してください。 |
--help | -? | 「13.1.2 asadminコマンドの共通オプション」を参照してください。 |
--file | -f | 指定した外部ファイルへ結果が出力されます。 |
--encoding | なし | 外部ファイルのエンコーディングを指定します。 Windows: SJIS |
オペランド
オペランド名 | 省略 | 説明 |
|---|---|---|
property_name | 不可 | 値を表示したい定義項目を指定します。 |
戻り値
0: 正常終了
1: 異常終了
注意事項
getサブコマンドによる定義参照時、setサブコマンドで指定したエスケープ文字は表示されません。getサブコマンドで表示された定義内容を修正してsetサブコマンドで再設定する場合は、必要に応じてエスケープ文字を再度指定してください。エスケープ文字の指定方法の詳細は、「エスケープ文字の利用」を参照してください。
使用例
定義項目jvm-optionsの値を表示するには以下のように実行します。
> asadmin get IJServer001.java-config.jvm-options |
以下のように定義項目名の一部にアスタリスクを使用することもできます。
> asadmin get IJServer001.*.* |
コマンドの表示結果をファイルへ出力したい場合は以下のようにファイル名を指定します。
> asadmin get --file config.txt IJServer001.*.* |
定義項目を複数指定する場合は以下のように定義項目を指定します。
> asadmin get resources.jdbc-connection-pool.DerbyPool.name resources.jdbc-resource.jdbc/__default.jndi-name |
形式
set [--terse[=true|=false]] [--echo[=true|=false]] [--interactive[=true|=false]] [--host host] [--port port] [--secure[=true|=false]] [--user admin_user] [--passwordfile file_name] [--help] [--encoding {UTF-8|SJIS|EUC}] {--file filename|property_name=value[ property_name=value]...}
機能説明
指定した定義項目の値を設定します。
asadminコマンドの利用方法・注意事項については、「13.1 asadmin」も参照してください。
オプション
オプション名 | 簡略名 | 説明 |
|---|---|---|
--terse | -t | 「13.1.2 asadminコマンドの共通オプション」を参照してください。 |
--echo | -e | 「13.1.2 asadminコマンドの共通オプション」を参照してください。 |
--interactive | -I | 「13.1.2 asadminコマンドの共通オプション」を参照してください。 |
--host | -H | 「13.1.2 asadminコマンドの共通オプション」を参照してください。 |
--port | -p | 「13.1.2 asadminコマンドの共通オプション」を参照してください。 |
--secure | -s | 「13.1.2 asadminコマンドの共通オプション」を参照してください。 |
--user | -u | 「13.1.2 asadminコマンドの共通オプション」を参照してください。 |
--passwordfile | なし | 「13.1.2 asadminコマンドの共通オプション」を参照してください。 |
--help | -? | 「13.1.2 asadminコマンドの共通オプション」を参照してください。 |
--encoding | なし | 外部ファイルのエンコーディングを指定します。 Windows: SJIS |
--file | -f | 外部ファイルから定義項目と値の一覧を読み込みます。 オペランドのプロパティ名と本オプションのどちらかを指定できます。 |
オペランド
オペランド名 | 省略 | 説明 |
|---|---|---|
property_name=value | 不可 | 定義項目名と値を「=」で区切って指定します。 (注) --fileオプションと本オペランドのどちらかを指定できます。 |
注) 値を省略して定義項目名と「=」だけを指定した場合、定義項目によって以下のような動作となります。
定義項目の種類 | 動作 |
|---|---|
値を省略できない定義項目の場合 | エラーとなります。 |
値を省略可能、かつデフォルト値のある定義項目の場合 | デフォルト値で初期化されます。 |
値を省略可能、かつデフォルト値のない定義項目の場合 | 空文字列""が設定されます。 |
システムプロパティ、または追加プロパティの場合 | property_nameで指定したシステムプロパティ、または追加プロパティを削除します。 |
戻り値
0: 正常終了
1: 異常終了
注意事項
追加プロパティの値を設定する場合、指定された値の範囲に対するチェックは実施されません。任意のプロパティ名・値を指定可能です。有効ではないプロパティが設定された場合、そのプロパティは無視されます。
コマンド実行時に以下のメッセージが出力された場合、"定義項目名"で示された項目はIJServerクラスタごとの設定はできません。IJServerクラスタから参照されているリソースやアプリケーションを直接指定して値を変更する必要があります。
The attribute "定義項目名" can only be modified at the domain level(注). |
「IJServerクラスタ名.XXX.YYY」ではなく、以下のように「XXX.YYY」で設定してください。
> asadmin set XXX.YYY |
注) domain levelは、すべてのIJServerクラスタで有効な定義です。以下に例を示します。
applications.web-module.admingui.object-type |
コマンドのオペランドに2バイト文字を指定することはできません。
getサブコマンドによる定義参照時、setサブコマンドで指定したエスケープ文字は表示されません。getサブコマンドで表示された定義内容を修正してsetサブコマンドで再設定する場合は、必要に応じてエスケープ文字を再度指定してください。エスケープ文字の指定方法の詳細は、「エスケープ文字の利用」を参照してください。
使用例
定義項目maximum-processing-timeの値を設定するには以下のように実行します。
> asadmin set IJServer001.ijserver-control.maximum-processing-time=480 |
省略可能な項目については、以下のように値を省略して定義項目名と「=」だけを指定することでデフォルト値を設定できます。
> asadmin set IJServer001.ejb-container.max-pool-size= |
定義項目と値の一覧を外部ファイルから読み込む場合は、以下のようにファイル名を指定します。
> asadmin set --file config.txt |
定義項目を複数指定する場合は以下のように定義項目を指定します。
> asadmin set resources.jdbc-connection-pool.DerbyPool.allow-non-component-callers=false resources.jdbc-resource.jdbc/__default.enabled=true |
形式
list [--terse[=true|=false]] [--echo[=true|=false]] [--interactive[=true|=false]] [--host host] [--port port] [--secure[=true|=false]] [--user admin_user] [--passwordfile file_name] [--help] [category_name[ category_name]...]
機能説明
カテゴリの一覧を表示します。
asadminコマンドの利用方法・注意事項については、「13.1 asadmin」も参照してください。
オプション
オプション名 | 簡略名 | 説明 |
|---|---|---|
--terse | -t | 「13.1.2 asadminコマンドの共通オプション」を参照してください。 |
--echo | -e | 「13.1.2 asadminコマンドの共通オプション」を参照してください。 |
--interactive | -I | 「13.1.2 asadminコマンドの共通オプション」を参照してください。 |
--host | -H | 「13.1.2 asadminコマンドの共通オプション」を参照してください。 |
--port | -p | 「13.1.2 asadminコマンドの共通オプション」を参照してください。 |
--secure | -s | 「13.1.2 asadminコマンドの共通オプション」を参照してください。 |
--user | -u | 「13.1.2 asadminコマンドの共通オプション」を参照してください。 |
--passwordfile | なし | 「13.1.2 asadminコマンドの共通オプション」を参照してください。 |
--help | -? | 「13.1.2 asadminコマンドの共通オプション」を参照してください。 |
オペランド
オペランド名 | 省略 | 説明 |
|---|---|---|
category_name | 可 | 表示したいカテゴリの親カテゴリを指定します。 |
戻り値
0: 正常終了
1: 異常終了
使用例
IJServerクラスタ配下のカテゴリ一覧を表示するには以下のように実行します。
> asadmin list IJServer001.* |
カテゴリを複数指定する場合は以下のようにカテゴリを指定します。
> asadmin list resources.jdbc-connection-pool resources.jdbc-resource |
