4. 運用管理コマンドリファレンス

4.1. はじめに

ここでは、ローカル/リモートのWebOTXサーバに対する運用と開発のタスク両面を支援する、構成管理コマンドについて説明します。

otxadmin コマンドは、サーバ側の機能構成に関する全般的なユーティリティを提供します。 例えば、ドメインの開始や停止、サーバ構成情報の設定、アプリケーションの配備などがあります。

JNDIサービス、JDBCデータソース、JMSは、さらに各機能に対してプラスアルファの管理機能を提供します。

4.2. 運用管理コマンド(otxadmin)

4.2.1. 使用方法

4.2.1.1. 運用管理コマンドの使用例

WebOTXで提供している運用管理コマンドの使用例を示します。
なお運用管理コマンドが提供する各コマンドの詳細については「4. 運用管理コマンドリファレンス」を、管理対象オブジェクト(Managed Object:MO)については、「2. MO定義リファレンス」参照してください。

以下では、例としてJDBCデータソースのログレベルを参照・設定する場合の具体的操作の説明をします。

一般に、運用管理コマンドにより属性の参照・設定を行う場合は、その設定項目を管理対象オブジェクト(Managed Object:MO)のDottedname および属性名により指定します。
JDBCデータソースのログレベルの場合、MOのDottedNameおよび属性名は以下のようになります。

この2つを’.’でつないだ名前

server.log-service.module-log-levels.jdbc-datasource

を指定することになります。

  1. 運用管理コマンドの起動
    「スタートメニュー」-「プログラム」-「WebOTX」から「運用管理コマンド」を選択、または、コマンドプロンプト上で「otxadmin.bat」と入力し「運用管理コマンド」を起動します。

  2. ドメインへのログイン
    loginコマンドによりドメインにログインしてください。ただし、ログインするドメインの環境として以下を想定しています。


    otxadmin > login --user admin --password adminadmin --host localhost --port 6212

    (*) ログインするドメインの選択はポート番号により選択します。上の例では「domain1」のポート番号6212を指定しましたが、 管理ドメイン「WebOTXAdmin」にログインする場合はポート番号として「6202 (WebOTXAdminの既定ポート番号)」を指定することになります。

  3. ログレベルの参照
    getコマンドにより設定するJDBCデータソースの現在のログレベルを参照します。
    otxadmin > get server.log-service.module-log-levels.jdbc-datasource

  4. ログレベルの設定
    setコマンドによりJDBCデータソースのログレベルを設定します。
    otxadmin > set server.log-service.module-log-levels.jdbc-datasource=INFO

  5. ログレベルの確認
    再びgetコマンドにより設定したJDBCデータソースのログレベルを参照します。
    otxadmin > get server.log-service.module-log-levels.jdbc-datasource

  6. 運用管理コマンドの終了
    exitにより運用管理コマンドを終了します。
    otxadmin > exit

display image
図4.2.1.1-1

以上が、運用管理コマンドを用いた運用設定変更の流れです。
必要に応じ属性名の指定等を変更してください。操作対象となるMOの詳細は「2. MO定義リファレンス」を参照してください。
また、運用管理コマンドの詳細な説明は「運用管理コマンド」の本編を参照してください。

以下で、helpコマンドの使用法と運用上よく用いられるget,listコマンドのワイルドカードを用いた便利な使い方を示します。

helpコマンド

運用管理コマンドで提供されているコマンドの詳細を調べるにはhelpコマンドを用います。helpコマンドの構文は以下のようになります。

otxadmin > help コマンド名

例えば、getコマンドについて調べたい場合は以下のようにします。

otxadmin > help get

helpコマンドの詳細については「4.2.1.13. ヘルプ」を参照してください。

項目の参照

項目を参照するには、get コマンドを使用してください。

otxadmin > get mo-dottedname.attribute-name

getコマンドでは*をワイルドカードとして利用することが可能です。
以下に*を利用したgetコマンドの使用例を示します。

管理対象オブジェクトの一覧取得

WebOTX Application Serverで管理されているMOを調べるにはlistコマンドを用います。
なお、listコマンドも*をワイルドカードとして利用することができます。

otxadmin > list *

※シングルモードで実行する場合は、* を "*" のように二重引用符で囲んでください。

項目の設定
項目を設定するには、set コマンドを使用してください。

otxadmin > get mo-dottedname.attribute-name

setコマンドでは*をワイルドカードとして利用することが可能です。
setコマンドで*を用いる場合は、操作ミスにより重要な属性を変更してしまうことを防ぐために、設定ファイルcli_restrictionに許可パターン文字列を定義する必要があります。
また、*はDottednameには使用可能ですが、属性名に使用することはできません。
以下に設定ファイルの定義方法について記します。
設定ファイル内には実際に運用管理コマンド上で実行したいコマンドのオペランド文字列を定義します。
たとえば、以下のようなコマンドを実行する場合、

otxadmin > set server.applications.web-module.*.description=Sample

設定ファイルには以下の定義行を追記します。

server.applications.web-module.*.description

行の先頭にTABまたは空白文字が入らないように気をつけてください。
また複数行定義する場合は1行につき1つの定義を追記してください。
設定ファイルは各ドメインの${INSTANCE_ROOT}/config配下にあり、設定の変更にはドメインの再起動が必要となります。
また、設定ファイルによる制限の解除は設定ファイルを${INSTANCE_ROOT}/config配下から削除することで可能となります。
ただし、その際にはsetコマンドに対する全ての制限が解除されますので、運用操作には十分な注意が必要です。


関連情報
運用管理コマンドリファレンス
MO定義リファレンス

4.2.1.2. コマンドの構文

otxadminの構文を以下に示します

otxadmin command -short-option argument --long-option argument operand

コマンド

コマンドとは、実行される操作またはタスクのことです。コマンドには、大文字と小文字の区別があります。

オプション

オプションによって、ユーティリティによるコマンドの実行方法を変更できます。アルファベットの大文字と小文字は区別されます。短形式のオプションの前にはダッシュを 1 つ付けます (-)。長形式のオプションの前にはダッシュを 2 つ付けます (--)。多くのオプションは、短形式でも長形式でも使用できます。たとえば、--user と -u のどちらを使用してもかまいません。オプションには、必須オプションと省略できるオプションがあります。コマンド構文では、省略できるオプションをかっこで囲んで表しています。コマンドの実行時にはすべての必須オプションを指定する必要があります。指定しないと、エラーメッセージが返され、コマンドは実行されません。
使用可能な長形式および短形式のオプション名については、「4. 運用管理コマンドリファレンス」を参照してください。
ほとんどのオプションには引数が必要です。たとえば --port には引数 port_number を指定します。ただし、ブール型のオプションは、機能のオンまたはオフを切り替えるために使用されるため、引数を必要としません。
オプションを環境変数に保存することもできます。詳細については、「4.2.1.5. 環境コマンド」を参照してください。

ブール型のオプション

ブール型のオプションでは、オンまたはオフを切り替えます。たとえば、 --interactive を指定すると対話モードに切り替わります。--no-interactive を指定すると対話モードがオフになります。対話モードでは、オプションに関してプロンプトが表示されます。長形式のオプションの前に --no- を指定すると、そのオプションがオフになります。短形式のオプション名を指定すると、常にデフォルト値の逆の設定になります。
短形式のブール型オプションはまとめて指定できます。たとえば、対話モード (短形式のオプション名 -I) とエコー (短形式のオプション名 -e) を指定したい場合、-Ie と指定することができます。

オペランド

オペランドは、空白文字またはタブで区切って指定します。コマンド構文内にどの順番で指定してもかまいません。オペランドの前に -- を記述すると、オプションとオペランドを区別できます。その後に続く引数は、ダッシュ (-) で始まるものも含め、すべてオペランドとして扱われます。例を示します。

otxadmin > create-jvm-options -- -Xss1024k

-Xss1024k はダッシュで始まっていますが、オペランドとして扱われます。

共通オプション

すべてのコマンドは以下の共通オプションを指定できます。コマンドヘルプ上では [otxadmin-utility-options] で表されます。
コマンドヘルプの詳細については「4.2.1.13. ヘルプ」を参照してください。

表4.2.1.2-1
オプション名 用途
-u / --user ドメインの運用管理エージェントの管理ユーザ名。

既にotxadmin loginコマンドでログインしている場合は、
--userオプションの指定は不要です。
-w / --password ドメインの運用管理エージェントの管理ユーザのパスワード。
-H / --host ドメインの運用管理エージェントが起動しているマシン名。
-p / --port ドメインの運用管理エージェントのポート番号。既定値は 6212 です。
--protocol ドメインの運用管理エージェントとの接続プロトコルを選択します。
指定できるプロトコルは、rmi、jmxmpです。
既定値はrmiです。
-W /--passwordfile ドメインの運用管理エージェントのパスワードを含むファイル。
--encrypted ドメインの運用管理エージェントのパスワードに
暗号化されたパスワードを利用する場合に指定します。
既定値はfalseです。暗号化されたパスワードの生成には
encryptコマンドを使用してください。
このオプションはpasswordfileオプションが指定されている場合のみ有効です。
-t / --terse trueを指定すると、出力データがスクリプトによる処理のための
簡潔なデータとなります。
既定値はfalseです。
-e / --echo trueを指定すると、標準出力でコマンドライン文が表示されます。
既定値はfalseです。
-I / --interactive true(既定値)を指定すると、パスワードオプション入力用の
プロンプトを表示します。
-s / --secure trueを指定すると、ドメインの運用管理エージェントとの通信に
SSL/TLSを利用します。既定値はfalseです。
構文例

create-file-user --user admin_user [--password admin_password] [-H host_name]
[--port port_number] [--passwordfile file_name] [--terse=true|false] [--echo=true|false]
[--interactive=true|false] [--userpassword user_password] [--groups user_groups[:user_groups]*]
[--authrealmname authrealm_name] username

この構文例では、-H はホスト名の短形式のオプション、--user は admin_user を引数とする長形式のオプション、username はオペランドです。省略できるオプションは、かっこで囲まれています。
次に、構文に実際の値を指定した例を示します。この例では、省略できるオプションの一部が指定されていません。

otxadmin create-file-user -H hostname --port 6212 --userpassword userpassword sampleuser


関連情報

運用管理コマンドリファレンス
MO定義リファレンス

4.2.1.3. シングルモードとマルチモード

otxadmin は、シングルモードまたはマルチモードで実行できます。シングルモードでは、コマンドプロンプトからコマンドを 1 つずつ実行します。マルチモードでは、環境レベルの情報を繰り返し入力することなく、複数のコマンドを実行できます。
シングルモードでファイルからの入力を使用している場合、コマンドの実行に失敗するとプログラムは終了します。マルチモードでコマンドの実行に失敗すると、otxadmin のプロンプトが再度表示されます。

シングルモード

シングルモードでは、コマンド行インタフェースを使ってコマンドプロンプトから単一のコマンドを呼び出します。コマンド行インタフェースによってコマンドが実行され、再びコマンドプロンプトが表示されます。コマンドプロンプトからコマンド行インタフェースを実行するには、${AS_INSTALL}/bin ディレクトリに移動し、次のようにコマンドを入力します。

> otxadmin command options arguments

次に例を示します。

> otxadmin create-file-user --user admin --password adminapassword --host host1 --port 6212 --userpassword samplepassword --groups otxadmin sampleuser

マルチモード

マルチモードでは、最初に環境設定を行うことにより、サーバ名、ポート、パスワードなどの環境レベルの情報を再入力することなく、複数のコマンドを実行できます。マルチモードを使用する利点は、otxadmin がメモリにとどまるため、コマンドの入力と実行が非常に速くなる点です。環境変数がオペレーティングシステムのレベルで設定されている場合、マルチモードではそれらの設定が取り込まれます。それらの設定は、変更されないかぎり otxadmin ユーティリティによって引き続き使用されます。
Windows では、otxadmin.bat ファイルを実行すると、自動的にマルチモードになります。UNIX では、otxadmin ユーティリティを実行すると、自動的にマルチモードになります。
これは、次のコマンドを入力するのと同じです。

> otxadmin multimode

マルチモードの場合は、コマンドプロンプトが otxadmin に変わります。次に、otxadmin プロンプトにコマンドを入力します。ユーティリティ名を入力する必要はありません。次に例を示します。

otxadmin > create-file-user -H host1 --port 6212 --userpassword samplepassword sampleuser

exit または quit と入力すると、マルチモードが終了します。コマンドプロンプトに戻ります。

複数のマルチモード

マルチモードセッション内で次のコマンドを入力すると、さらにマルチモードを呼び出すこともできます。

otxadmin > multimode

2 番目のマルチモード環境を終了すると、最初のマルチモード環境に戻ります。たとえば、server1をマルチモードで管理しているとき、server2 を使って両者を比較したい場合は、server1 のマルチモードで server2のマルチモードを呼び出します。現在のマルチモードセッションを終了する必要がないので、環境設定をそのまま保持できます。server2のマルチモードセッションを終了すると、server1 のマルチモード環境に戻ります。


関連情報

運用管理コマンドリファレンス
MO定義リファレンス

4.2.1.4. 対話型オプションと非対話型オプション

コマンド行インタフェースは、対話型モードまたは非対話型モードで使用できます。対話型モードでは、パスワードが指定されていない場合、パスワードの入力を求めるメッセージが表示されます。対話型モードはデフォルトで有効になっています。

exportコマンドを使って対話型環境変数を設定することにより、対話型モードを有効および無効に切り替えることができます。

どのような場合でも、シングルモードで対話型オプションを使用できます。マルチモードで対話型オプションを使用できるのは、コマンドプロンプトからコマンドを1つずつ実行する場合と、ファイルからマルチモードで実行する場合です。ただし、マルチモードでは、入力ストリームからパイプされたコマンドや、別のプログラムから呼び出されたコマンドを対話型モードで実行できません。


関連情報

運用管理コマンドリファレンス
MO定義リファレンス

4.2.1.5. 環境コマンド

otxadmin ユーティリティには、環境コマンドを使用して設定できる一連の環境変数が含まれます。マルチモードでは、これらの変数を設定したあと、マルチモードを終了するまで環境を設定し直す必要はありません。環境変数をオペレーティングシステムのレベルで設定することもできます。その場合、マルチモードに入ると、それらの環境変数は自動的に読み込まれ、マルチモードを終了するまで保持されます。

環境変数は名前と値の組み合わせであり、いつでも値を割り当てて設定できます。環境変数には、OTX_ADMIN_ というプレフィックスが付けられて、大文字を使用したオプション名となります。たとえば、運用管理エージェントのユーザを設定する場合は、次のように入力します。

export OTX_ADMIN_USER=administrator

administrator は管理者のユーザ名です。

これによって、次のように OTX_ADMIN_USER の値を otxadmin コマンドにも使用できます。

otxadmin multimode
otxadmin > export OTX_ADMIN_HOST=host1

運用管理エージェントのホスト名は、新たに割り当てないかぎり、マルチモードセッションを終了するまで host1 になります。

次の例のように、複数の環境変数をまとめて設定し、エクスポートすることもできます。

otxadmin > export OTX_ADMIN_PORT=6212 OTX_ADMIN_USER=admin

現在の環境変数の設定を確認するには、引数を指定しないで export コマンドを実行します。

otxadmin > export
OTX_ADMIN_HOST=host1
OTX_ADMIN_PORT=6212
OTX_ADMIN_USER=admin

変数とその値を環境から削除するには、unset コマンドを使用します。次に例を示します。

otxadmin > unset OTX_ADMIN_HOST

環境変数の値は、変数を設定し直すか、otxadmin コマンドの一部として別の値を設定することにより、オーバーライドできます。次に例を示します。

otxadmin > export OTX_ADMIN_HOST=host2
otxadmin > list-file-users --host host1

この例では、運用管理エージェントのホスト host1のユーザのリストが示されます。この値によって、以前のホストの値host2がオーバーライドされているためです。
エクスポートされた変数を使用しない場合は、ほとんどのコマンドで、次に示すオプションを指定するか、デフォルト値を使用する必要があります。

次の表「exportコマンドに指定する環境変数」では、export コマンドに指定できる環境変数について説明します。これらの変数は、環境設定用としてもっとも一般的に使用される変数です。第1列は環境変数名を、第2列は用途と、値が設定されていない場合のデフォルト値を示します。

表4.2.1.5-1
環境変数 用途
OTX_ADMIN_HOST 運用管理エージェントのホスト名。値を指定しない場合は、localhostが使用されます。
OTX_ADMIN_PORT 運用管理エージェントのポート番号。値を指定しない場合は、6212 が使用されます
OTX_ADMIN_USER コマンドを実行するユーザの名前
OTX_ADMIN_PASSWORD コマンドを実行するユーザのパスワード。ユーザ名とパスワードは、ユーザを認証するため、つまりユーザに運用管理エージェントの管理が許可されているかどうかを確認するために使用されます。これは、管理インタフェースから運用管理エージェントにアクセスするときに行われる認証と同じです
OTX_ADMIN_LEGACY コマンドの実行先のサーバがV8か、V9か確認するかを判断するために使用されます。値を指定しない場合は、false が使用されます。
  • trueの場合

    接続先のサーバで動作するWebOTXのバージョンを確認した後、V8以前であればコマンドは旧互換動作を行います。V9の場合旧互換動作を行いません。

  • falseの場合

    サーバのバージョンを確認せず、V9の動作を行います。

OTX_ADMIN_DEBUG デバッグ用メッセージの出力。値を指定しない場合は、false が使用されます。

関連情報
運用管理コマンドリファレンス
MO定義リファレンス

4.2.1.6. パスワードファイルオプション

コマンド行でパスワードを入力したくない場合やパスワードの環境変数を設定したくない場合は、パスワードファイルを作成しておき、そのファイルをコマンド行のオプションとして使用できます。
password オプションを指定できるコマンドには、passwordfile オプションを代わりに指定できます。パスワードファイルには、次の行を含めます。

OTX_ADMIN_PASSWORD=value
OTX_ADMIN_USERPASSWORD=value

passwordfile オプションを使用すると、ファイル内に記述したパスワードはマルチモード環境にエクスポー トされるため、後続の password オプションを指定していないコマンドでも、これらの値が使用されます。 コマンド行に password オプションと passwordfile オプションを同時に指定した場合は、パスワードファ イルに記述された値がマルチモード環境にエクスポートされますが、そのコマンドでは password オプシ ョンに指定されているパスワードが使用されます。password オプションが passwordfile オプションよりも 優先されるためです。


関連情報

運用管理コマンドリファレンス
MO定義リファレンス

4.2.1.7. ログイン

マルチモードで実行する場合、最初にログインを行えば以降のコマンドについてはログインしたユーザで指定したドメイン(ホスト、ポートで指定)に対してコマンドを実行できるようになります。
ログインコマンドは指定されたドメインに対してユーザ、パスワードのチェックを行い、問題なければその環境のexport を行います。


otxadmin > login --user username --password password --host hostname --port port

と実行すると以下の環境をexport します。

export OTX_ADMIN_USER=username
export OTX_ADMIN_PASSWORD=password
export OTX_ADMIN_HOST=hostname
export OTX_ADMIN_PORT=port


関連情報

運用管理コマンドリファレンス
MO定義リファレンス

4.2.1.8. デフォルトパスワード設定

otxadmin コマンドを実行するユーザのプロファイルにあらかじめユーザやパスワードを記述しておくと、コマンド実行時オプション指定が不要になります。パスワードを記述した場合は--passwordfile の指定も必要ありません。

Windows : %USERPROFILE%\.otxadminprefs
UNIX、Linux: ~/.otxadminprefs
OTX_ADMIN_USER=username
OTX_ADMIN_PASSWORD=password

Windows の場合、エクスプローラからドットで始まるファイルを新規作成できないときは、新規でnotepadを開いて名前をつけて保存する、別名ファイルで作ってリネームするなどの方法で作成してください。


関連情報

運用管理コマンドリファレンス
MO定義リファレンス

4.2.1.9. ローカルコマンドとリモートコマンド

otxadmin コマンドは、 運用管理エージェントを使用せず、ローカル環境にて実行するローカルコマンドと、 運用管理エージェントを介してコマンドを受け渡すリモートコマンドの二種類に分類されます。 リモートコマンドが動作するには、運用管理エージェントが実行中であることが必要です。
次のコマンドは、ローカルで実行されます。

次のコマンドは管理ドメインが起動しているときのみ、リモートモードで実行することができます。 リモートモードで実行するには、オプションを用いて管理ドメインに接続することが必要です。


関連情報

運用管理コマンドリファレンス
MO定義リファレンス

4.2.1.10. コマンド行呼び出し

コマンド行からの otxadmin の使用

もっとも単純なコマンドの使用方法は、コマンド行から 1 つずつ実行する方法です。ユーティリティ名に続けて、コマンドとそのオプションおよび引数を指定します。マルチモードでは、ユーティリティ名と環境オプションを繰り返し入力することなく、複数のコマンドを実行できます (環境変数を設定済みの場合)。シングルモードのコマンドもマルチモードのコマンドも、対話型形式 (パスワードなどの追加入力を求めるプロンプトを表示する) または非対話型形式で実行できます。シングルモードとマルチモードの詳細については、「4.2.1.3. シングルモードとマルチモード」を参照してください。
コマンドを対話型形式で使用する方法については、「4.2.1.4. 対話型オプションと非対話型オプション」を参照してください。

コマンド行の使用例

> otxadmin create-file-user -H host1 --port 6212 --userpassword samplepassword sampleuser

コマンドの実行が完了すると、オペレーティングシステムのプロンプトに戻ります。
ファイルからの入力 (スクリプト) での otxadmin の使用
複数の otxadmin コマンドを含むスクリプトを作成できます。スクリプトを使うと、バッチモードでのコマン
ド処理、ジョブの実行回数の設定、管理タスクの単純化および自動化を行うことができます。
ファイル内のスクリプトを呼び出すには、次の構文を使用します。

> otxadmin multimode --file filename

次に、この方法で呼び出せる、ファイル内の単純なスクリプトの例を示します。


# Create new user and display it.
export OTX_ADMIN_USER=admin OTX_ADMIN_PASSWORD=mypassword
OTX_ADMIN_HOST=host1 OTX_ADMIN_PORT=6212
create-file-user --userpassword samplepassword sampleuser
list-file-users

このスクリプトは、環境設定を行い、sampleuser というユーザを作成し、そのマシンのユーザ一覧を表示します。ハッシュ記号 (#) で始まる行はコメントと見なされ、無視されます。

標準入力 (パイプ) での otxadmin の使用
入力を otxadmin コマンドにパイプすることができます。次の構文を使用します。

cat filename | otxadmin multimode

関連情報

運用管理コマンドリファレンス
MO定義リファレンス

4.2.1.11. エスケープ文字

エスケープ文字で区切らずにコロン (:)、アスタリスク (*)、イコール (=)、およびバックスラッシュ (\) などの文字をコマンド構文で使用すると、エラーが発生します。エスケープ文字が必要となる場面は、プラットフォームやシングルモードとマルチモードの違いによって変わります。 両者のモードの詳細は、「シングルモードとマルチモード」を参照してください。

シングルモード

どのプラットフォームでも、シングルモードで行う場合は、バックスラッシュを文字の前に使い、その文字を含む値を二重引用符で囲むことによって、エスケープできます。たとえば、値にコロンを含むオプションを指定して JDBC データソースを作成するときに、次のようにエスケープ文字を使用できます (一部のプロパティに関して環境変数が設定されていることが必要です)。

otxadmin create-jdbc-datasource --dataSourceType JDBCEX_Oracle --jdbcMajorVersion 3 --minPoolSize 16 --maxPoolSize 32 --useJTA --property userName=scott:password=tiger:dataSourceName="jdbc\:oracle\:thin\:@host1\:1521\:ORCL" jdbc/Oracle

また、プラットフォームにより、上記とは異なる方法でバックスラッシュや二重引用符を使用することでもエスケープできます。値の内容によっては、これらの方法によりエスケープ作業を簡素化できます。

JVM オプションの空白文字

空白を含むJVMオプションを設定するときには、JVM オプションの値を二重引用符 (")で囲むことによって設定することができます。

otxadmin create-jvm-options -Dwo.home="D\:\\wo jvm\\jvm value"

マルチモード

どのプラットフォームでも、マルチモードで行う場合は、バックスラッシュを文字の前に使い、その文字を含む値を二重引用符で囲むことによって、エスケープできます。たとえば、値にコロンを含むオプションを指定して JDBC データソースを作成するときに、次のようにエスケープ文字を使用できます (一部のプロパティに関して環境変数が設定されていることが必要です)。

otxadmin > create-jdbc-datasource --dataSourceType JDBCEX_Oracle --jdbcMajorVersion 3
--minPoolSize 16 --maxPoolSize 32 --useJTA --property userName=scott:password=tiger:dataSourceName="jdbc\:oracle\:thin\:@host1\:1521\:ORCL" jdbc/Oracle

※マルチモードで実行している以外は、「シングルモード」での記述と、コマンドライン(otxadmin の記述を除く以外)は同じです。

また、二重引用符を使わずにエスケープする場合は二重のバックスラッシュが必要になります。

otxadmin > create-jdbc-datasource --dataSourceType JDBCEX_Oracle --jdbcMajorVersion 3
--minPoolSize 16 --maxPoolSize 32 --useJTA --property userName=scott:password=tiger:dataSourceName=jdbc\\:oracle\\:thin\\:@host1\\:1521\\:ORCL jdbc/Oracle

※マルチモードで実行している以外は、「シングルモード」での「二重のバックスラッシュ(\\) によるエスケープ」と、コマンドライン(otxadmin の記述を除く以外)は同じです。

上記の例と同じ内容に対して二重引用符を使用するには、値を二重引用符 (") で囲み、さらにこれらの二重引用符をバックスラッシュでエスケープします。

otxadmin > create-jdbc-datasource --dataSourceType JDBCEX_Oracle --jdbcMajorVersion 3 --minPoolSize 16 --maxPoolSize 32 --useJTA --property userName=scott:password=tiger:dataSourceName=\"jdbc:oracle:thin:@host1:1521:ORCL\" jdbc/Oracle

※マルチモードで実行している以外は、「シングルモード」での「二重引用符(")によるエスケープ」と、コマンドライン(otxadminの記述を除く以外)は同じです。


関連情報

運用管理コマンドリファレンス
MO定義リファレンス

4.2.1.12. getコマンド、setコマンド

get コマンドと set コマンドを使うと、 運用管理エージェントの設定情報にアクセスおよび変更できます。ほとんど の場合、otxadmin コマンドは必須プロパティだけを設定します。オプションのプロパティの値を変更する には、set コマンドを使用します。

表4.2.1.12-1
コマンド 引数 用途
get (scope) scopeは属性を表す有効な名前 属性の値を取得する
set (scope=value) scopeは属性を表す有効な名前。valueはその属性に設定する値 属性の値を設定する

1 つのコマンドで、属性と属性の間に空白文字を使うことにより、複数の属性値を取得または設定できます。次に例を示します。

set server.resources.jdbc-datasource.jdbc/Oracle.maxPoolSize=32
server.resources.jdbc-datasource.jdbc/Oracle.minPoolSize=16

get コマンドと set コマンドは区切り文字としてピリオドを必要とするため、アイテム名にピリオドが含まれる場合は、含まれるピリオドの前にエスケープ文字のバックスラッシュ (\) を記述する必要があります。サーバインスタンス名 server.nec.com のピリオドの前にバックスラッシュを記述した例を、次に示します。

get server\.nec\.com.*

バックスラッシュを挿入しないと、エラーメッセージが表示されます。

get コマンドと set コマンドの例

次に、get コマンドを使って属性値を取得する例と、set コマンドを使って値を設定する例を示します。なおgetおよびsetコマンドで利用可能な属性名(dottedname)については [ リファレンス集 運用管理・設定編 > 1. コンフィグレーション(設定一覧) > 1.2. 運用管理エージェント > 1.2.2. 運用管理エージェント設定項目一覧 ] を参照してください。

MDB コンテナサービスの例

server インスタンス名が server の場合、環境を設定し、次のコマンドをマルチモードで実行することにより、すべての mdb-container属性の値を取得できます。

otxadmin > get server.mdb-container.*

次に、このコマンドの出力例を示します。出力には現在の属性値が示されます。

server.mdb-container.idle-timeout-in-seconds = 600
server.mdb-container.max-pool-size = 32
server.mdb-container.pool-resize-quantity = 8
server.mdb-container.steady-pool-size = 0

MDB コンテナ属性の max-pool-size の値だけを取得するには、次のコマンドを使用します。

otxadmin > get server.mdb-container.max-pool-size

max-pool-size 属性の値を 16 に設定するには、次のコマンドを使用します。

otxadmin > set server.mdb-container.max-pool-size=16

JMS リソースの例

リソースを設定するには、次のように属性を指定します。

instancename.resource.primary_key_value.attribute_name

次に例を示します。

otxadmin > get server.resources.jms-resource.jms-logical-destination.myjms.*

これにより、JMS 送信先リソース myjms のすべての属性を取得できます。次に例を示します。

server.resources.jms-resource.jms-logical-destination.myjms.description = <null>
server.resources.jms-resource.jms-logical-destination.myjms.jndi-name = myjms
server.resources.jms-resource.jms-logical-destination.myjms.res-type = javax.jms.Queue
server.resources.jms-resource.jms-logical-destination.myjms.wojmsDestinationDescription = <null>
server.resources.jms-resource.jms-logical-destination.myjms.wojmsDestinationName = myjms

res-type など、単一の属性の値を取得するには、次のように入力します。

otxadmin > get server.resources.jms-resource.jms-logical-destination.myjms.res-type

description 属性を設定するには、次のように入力します。

otxadmin > set server.resources.jms-resource.jms-logical-destination.myjms.description=mydescription

この例では、説明にmydescription が設定されます。

複数の値の取得例と設定例

1 つのコマンドで複数の値を取得および設定することができます。同時に 2つの属性を設定するには、属性の間を空白文字で区切ります。次に例を示します。

set server.appReloadPollInterval=20 server.mime.mime1.file=mime.types

配列形式の値の取得例と設定例

取得した属性が配列形式の場合、配列の各要素がカンマ (,) で区切られて表示されます。次に例を示します。

server.java-config.jvm-options = -server,-Xms64m,-Xmx512m,-XX:NewRatio=2, ...

配列形式の属性を設定するには、一次元配列の場合、取得時のようにカンマ (,) で配列の各要素を区切って指定します。

otxadmin > set server.sample.options=element1,element2,element3

但し、多次元配列の場合は、{{要素1-1,要素1-2},{要素2-1,要素2-2},...}といったように、次元ごとに中カッコ({}) で囲んで指定します。

otxadmin > set server.sample.propertyList={{key1,value1},{key2,value2},{key3,value3}}

get コマンドと set コマンドによる監視

get コマンドおよび set コマンドを使って、実行中のサーバを監視することもできます。list コマンドで、監視することもできます。monitor オプションを true または false に設定します。true に設定した場合は、指定された属性を監視できます。


関連情報

運用管理コマンドリファレンス
MO定義リファレンス

4.2.1.13. ヘルプ

個々のotxadmin コマンドのヘルプを表示するには、コマンドプロンプトで -h または --help と入力します。たとえば、otxadminのヘルプを表示するには、次のコマンドを入力します。

otxadmin --help

すべての otxadmin コマンドが一覧表示されます。
特定の otxadmin コマンドのヘルプを表示するには、次のように入力します。

otxadmin command -h

または

otxadmin command --help

ヘルプには、構文、コマンドの説明、構文の説明、使用例、および関連コマンドが表示されます。コマンド内の任意の位置に -h または --help を指定すると、そのコマンドのヘルプが表示されます。コマンドは実行されません。


関連情報

運用管理コマンドリファレンス
MO定義リファレンス

4.2.1.14. 出力とエラー

コマンドが正常に実行されると、実行内容を知らせるメッセージが表示されます。コマンドの実行に失敗すると、エラーメッセージが表示されます。

終了状態の表示

エラーメッセージに加えて、otxadmin コマンドの終了時には、常に終了状態が返されます。終了状態は、コマンドの実行が成功した場合は 0、失敗した場合は 1 になります。

UNIX の終了状態

コマンドプロンプトで echo $? と入力することにより、終了状態をチェックできます。スクリプトでも終了コードを使用できます。たとえば、次の Kornシェルスクリプトは、終了状態を使用して list-domains コマンドが成功であるか失敗であるかを示します。

#!/bin/ksh
otxadmin list-domains
if [[ $? = 0 ]]
then
echo "success"
else
echo "error"
fi
Windows の終了状態

Windows では、独自の .bat スクリプトを使って終了状態をチェックできます。成功するスクリプトとその出力、および失敗するスクリプトとその出力を、次に示します。

成功するスクリプト
myscript.bat

@echo off
echo Processing Command
call otxadmin.bat list-components --user admin --password password
if not %errorlevel% EQU 0 goto end
echo Command ‘Successful
goto program-end
:end
echo Command Failed
:program-end

出力


Processing Command
admin <web-module>
manager <web-module>
Command list-components executed successfully.
Command ‘Successful

失敗するスクリプト (modulename 指定なし)
myscript.bat

@echo off
echo Processing Command
call otxadmin.bat list-sub-components --user admin --password password
if not %errorlevel% EQU 0 goto end
echo Command ‘Successful
goto program-end
:end
echo Command Failed
:program-end

出力


Processing Command
Usage: list-sub-components --user admin_user [--password admin_password] [--host host_name]
[--port port_number] [--passwordfile file_name] [--terse=true|false] [--echo=true|false]
[--interactive=true|false] [--type ejbs|servlets] [--appname appname] modulename
CLI020 Operand is required.
Command Failed

使用法の表示

引数を指定せずにコマンドを実行すると、コマンドの構文を示すエラーメッセージが表示されます。次に例を示します。
otxadmin > list-components
Usage: list-components --user admin_user [--password admin_password] [--host host_name] [--port
port_number] [--passwordfile file_name] [--terse=true|false] [--echo=true|false]
[--interactive=true|false] [--type application|ejb|web|connector]
CLI152 user is a required option.


関連情報
運用管理コマンドリファレンス
MO定義リファレンス

4.2.1.15. セキュリティに関する注意事項

コマンド行からコマンド行インタフェースを実行する場合は、コマンドにパスワードが必要になります。 マルチモードで実行する場合は、最初にloginコマンドを実行することでユーザ名、パスワードが設定されます。 マルチモードをいったん終了して、もう一度開始するときは、再びloginコマンドを実行します。
コマンド行でパスワードを入力しないために、パスワードファイルを設定しておくこともできます。有効なユーザ名およびパスワードの認証情報がなければ、コマンドは実行されません。


関連情報

運用管理コマンドリファレンス
MO定義リファレンス

4.2.1.16. JMX Remoteの通信相手状態チェック機能の設定

JMX Remote インタフェースは、主に運用管理コマンドなどの各ツールとサーバ間の通信に利用されます。JMX Remote では、サーバログイン後に通信相手の状態チェックのため、独自のアライブチェック機能が動作します。例えば、通信相手のサーバマシンの電源が落ちて、コネクションの切断処理が行われないままとなった場合、この機能によりJMX Remote コネクションの切断が自動的に行われます。

サーバ側の設定

サーバ側のタイムアウト時間をミリ秒単位で指定します。既定値は120000 ミリ秒です。なお、0を指定した場合、既定値が設定されます。この時間内にクライアント側からデータを受信しなかった場合、サーバ側のコネクションを終了します。

サーバ側の設定方法

サーバ側のJVM オプション設定に次のプロパティ設定を行います。

-Djmx.remote.x.server.connection.timeout=120000

※上記設定では、タイムアウト時間として120 秒を設定しています。
例えば、統合運用管理ツールを使用して設定変更を行う場合、
[domain]-[アプリケーションサーバ]-[JVM 構成]-[システム JVM オプション](または[JVM オプション])に上記プロパティ情報を設定してください。

クライアント側の設定

クライアント側のアライブチェック時間をミリ秒単位で指定します。クライアントは、この設定値に従ってサーバ側に対して定期的に通信を行います。サーバからの応答がない場合、クライアントはコネクションを終了させます。既定値は60000 ミリ秒です。なお、0 を指定した場合、既定値が設定されます。通常、サーバ側のタイムアウト時間よりも小さい値を設定します。なお、この設定値はアライブチェック用データの送信間隔時間であり、MO の実データを自動的にサーバ側から取得する時間ではありません。

クライアント側の設定

クライアント側のJVM オプション設定に次のプロパティ設定を追加します。クライアント側のJVM オプションの設定方法については、各クライアントのヘルプ/マニュアルを参照してください。

-Djmx.remote.x.client.connection.check.period=60000

※上記設定では、アライブチェックを60 秒に1 回行う設定となります。
例えば、運用管理コマンドのアライブチェック設定を変更する場合には、
${INSTALL_ROOT}\bin\otxadmin.bat (Windows) または ${INSTALL_ROOT}/bin/otxadmin.sh (UNIX)に上記プロパティ情報を追記してください。


関連情報

運用管理コマンドリファレンス
MO定義リファレンス

4.2.1.17. コマンドのタイムアウト設定

コマンドでのドメインの運用操作に対するタイムアウト時間を設定することができます。

※これは、コマンドを実行してその応答が返るまでの時間に対する設定であり、タイムアウトが発生しても、ドメイン側では要求されたコマンドに対する処理が継続されます。

JRMPプロトコルを利用してドメインに接続を行う場合

タイムアウト設定項目は以下の3つのプロパティがあります。

以下の手順でタイムアウト時間の設定を行ってください。

  1. ${INSTALL_ROOT}\config\otxadmin.propertiesを作成
  2. 作成したotxadmin.propertiesに <プロパティ>=<タイムアウト時間> を記述
JMXMPプロトコルを利用してドメインに接続を行う場合

以下の手順でタイムアウト時間の設定を行ってください。

  1. ${INSTALL_ROOT}\config\otxadmin.propertiesを作成
  2. 作成したotxadmin.propertiesに jmx.remote.x.request.timeout=<タイムアウト時間(ミリ秒)> を記述

なお、JMXMPプロトコルを利用した接続を行う手順は「ドメイン構築・基本設定ガイド > 3. ドメイン > 3.12. 接続プロトコルの変更 > 3.12.1. JMXMPを利用する手順」を参照してください。


関連情報

運用管理コマンドリファレンス
MO定義リファレンス

4.2.1.18. パスワードの暗号化

ドメインの管理ユーザのパスワードを暗号化したい場合、あらかじめ暗号化したパスワードをパスワードファイルに記載し、読み込ませる必要があります。

事前準備
  1. パスワードの暗号化

    encryptコマンドを使用し、暗号化したパスワードを生成します。

    otxadmin> encrypt  
    CLI261 暗号化する文字を入力してください:
    CLI262 もう一度入力してください:
    <暗号化されたパスワード>
    
  2. パスワードファイルへの記載

    任意の名前で作成したパスワードファイルに、以下のように暗号化したパスワードを記載します

    OTX_ADMIN_PASSWORD=<暗号化されたパスワード>
実行方法

コマンド実行時にpasswordfileオプション、およびencryptedオプションを指定することで、暗号化されたパスワードを読み込みコマンドを実行します。

以下は、getコマンドで、パスワードファイル( /home/user/passwordfile )を使用する例です。パスワードファイル内には暗号化されたパスワードが記載されています。

otxadmin> get --user <ユーザ名> --encrypted=true --passwordfile "/home/user/passwordfile" domain.name

4.2.1.19. V8以前のサーバに対するコマンド操作

コマンド実行時に共通オプション --legacy=trueを指定した場合、コマンドの接続先のサーバがV8か、V9か確認します。確認後V8であれば旧互換動作を行い、V9であればV9の動作を行います。--legacyオプションを指定しない場合は--legacy=false を指定した場合と同様に、コマンドの接続先のサーバを確認せずにV9の動作を行います。

また、--legacy=trueを設定した場合、コマンド実行時に接続先サーバのバージョン名が表示されます。

なお、マルチモードにおいてloginコマンドに対して--legacy=trueを設定し、その時の接続先サーバがV8であった場合、その後のコマンドには--legacy=trueを設定しなくても接続先サーバのバージョン確認が行われます。

また、V8のサーバに対して--legacy=trueを指定せずに接続を試みた場合、以下のようなエラーが表示されます。

otxadmin> get --user <ユーザ名> --password <パスワード> --host <ホスト名> domain.name
javax.management.InstanceNotFoundException: MBean instance not found: :type=WebOTXCommandAdapter

4.2.2. otxadminサブコマンド一覧

運用管理コマンド (otxadmin) リファレンス

4.3. JDBCデータソース

4.3.1. dsadm

User Commands dsadm(1)
名称
dsadm - JDBCデータソースの定義情報の管理を行います。
UNIX版のコマンド名は、dsadm.sh です。
構文
dsadm [-url url_string] [-user admin_user] [-password admin_password] [-secure] [-nosecure] [operation]
説明
JDBCデータソースの定義情報の登録と再登録、削除、一覧表示を行います。
オプション
-url
ドメインの運用管理エージェントと接続するためのURLを指定します。
(既定値: rmi:///jndi/rmi://localhost:6212/jmxrmi)

-user
ドメインの運用管理エージェントの管理ユーザ名を指定します。
(既定値: admin)

-password
ドメインの運用管理エージェントの管理ユーザのパスワードを指定します。
(既定値: adminadmin)

-secure
ドメインの運用管理エージェントとSSLで通信を行う場合に指定します。
(既定値: 指定なし)

-nosecure
V8以降のドメインの運用管理エージェントと、security-enabled=falseのJMXMPプロトコルで通信を行う場合に指定します。
(既定値: 指定なし)


各オプションの既定値は、次のファイルに格納されています。必要に応じて変更してください。
   ${AS_INSTALL}/config/jdbc/dsadm.properties

オプションの先頭には、"--"を指定することができます。

オペランド
operation
次のいずれかのオペレーションを指定します。

bind file ... 指定したプロパティファイルに定義された設定で、JDBCデータソースを、ドメインの運用管理エージェントに登録します。
rebind file ... 指定したプロパティファイルに定義された設定で、JDBCデータソースを、ドメインの運用管理エージェントに上書きで登録します。
unbind name ... 指定した名前のJDBCデータソースを、ドメインの運用管理エージェントから削除します。
list [name ...] ドメインの運用管理エージェントに登録されている、全てまたは特定のJDBCデータソースの一覧を表示します。
help 使用方法を表示します。


ドメインの運用管理エージェントに対するオペレーション(bind, rebind, unbind)は、同様に、JNDIサーバに対して行われます。

プロパティファイルのサンプル(テンプレートファイル)は、次のディレクトリに格納されています。
   ${AS_INSTALL}/config/jdbc

旧バージョンのプロパティファイルをそのまま指定することができます。
例1: 登録
> dsadm bind ../config/jdbc/oracle.properties

例2: 削除
> dsadm unbind jdbc/Oracle

終了ステータス
0 : コマンド実行成功
1 : コマンド実行失敗 オペレーション実行時にエラーが発生しています。
2 : コマンド実行失敗 指定された名前が見つかりません。または既に登録されています。
関連事項
create-jdbc-datasource(1) delete-jdbc-datasource(1) list-jdbc-datasources(1)
ping-jdbc-datasource(1) reset-jdbc-datasource(1) reset-all-jdbc-datasources(1)
注意事項
接続テストやコネクション破棄といった運用操作を行う場合は、運用管理コマンドを使用してください。また、定義情報の管理を行うために、運用管理エージェントの運用管理コマンドを使用することもできます。

4.4. JMS

4.4.1. wojmsbrokerd

名称
wojmsbrokerd - JMS サーバユーティリティ
形式
wojmsbrokerd [-D<property>=<value>][-dbuser <username>] [-dbpassword <password>] [-force] [-h] [-javahome <javahome> | -jrehome <jrehome>] [-loglevel <level>] [-metrics <#>] [-name <name>] [-otxdomain <domain>] [-passfile <passfile>] [-password <keystorepass>] [-port <#>] [-remove instance] [-reset <data>] [-shared] [-silent] [-tty] [-version] [-vmargs <vmarguments>]
説明
JMS サーバを起動します。wojmsbrokerd コマンドのオプションを使用して、追加の設定情報を指定したりします。
オプション
-D<property>=<value>
システムプロパティ <property> を <value> で設定します。
指定した値で設定ファイルの値がオーバーライドされますが、オーバーライドの対象は、現在の JMS サーバセッションだけです。インスタンス設定ファイルには書き込まれません。

-dbuser <username>
プラグインされたデータベースのアクセスのためのユーザ名を指定します。

-dbpassword <password>
プラグインされたデータベースのアクセスのためのパスワードを指定します。

-force
ユーザの確認なしでアクションを実行します。

-javahome <javahome>
使用する代替 Java ランタイムを指定します。<javahome> は JDK への パスです。デフォルトではインストール時に指定されたランタイムを使用します。

-jrehome <jrehome>
<jrehome> が JRE へのパスということ以外は -javahome と同じです。

-loglevel <level>
ログレベルを <level> に設定します。 <level> は NONE, ERROR, WARNING, INFO, DEBUG, DEBUGMED, DEBUGHIGH のいずれかです。
デフォルトは INFO です。

-metrics <#>
<#> 秒おきにパフォーマンスのメトリックをログします。

-name <name>
この JMS サーバのインスタンス名を <name> に設定し、対応する プロパティの設定を使用します。
デフォルトは、 wojmsbroker です。

-otxdomain <domain>
WebOTX のドメイン名を指定します。

-passfile <passfile>
<passfile> から SSL キーストアパスワードを読み取ります。

-password <keystorepass>
SSL キーストアファイルへのアクセスに <keystorepass> を パスワードとして使用します。

-port <#>
JMS サーバのプライマリポートを <#> に設定します。

-remove instance
JMS サーバのインスタンスが削除されます。
インスタンスの設定ファイル、ログファイル永続ストア、 およびその他の関連ファイルとディレクトリを削除します。

-reset <data>
動的に作成された JMS サーバのデータをリセットまたはクリアします。
reset は以下の引数をサポートしています。

store
メッセージを含むすべての永続データと、永続サブスクリプション、 トランザクション情報のような、JMS サーバの関連データをクリア します。
messages
JMS サーバにすべての永続メッセージをクリアさせます。
durables
JMS サーバにすべての永続サブスクリプションをクリアさせます。
props
JMS サーバにストアされたすべてのインスタンスのプロパティをクリアさせます。

-shared
共有スレッドプールモデルを使用して jms サービスを実行します。

-silent
端末コンソールに出力を表示しません。

-tty
端末コンソール (追加としてログファイル)にすべてのメッセージを 表示します。デフォルトでは WARNING と ERROR のみが表示されます。

-version
バージョン情報を表示して終了します。

-vmargs <vmarguments>
Java VM に <vmarguments> を渡します。<vmarguments> にスペースが 含まれている場合は、二重引用符で囲まれる必要があります。
使用例
例1: デフォルトの JMS サーバ名と、設定を使用して JMS サーバを起動
> wojmsbrokerd

プライマリポートが 9700、インスタンス名が wojmsbroker の JMS サーバが起動されます。


例2: ドメイン名を指定して、JMS サーバを起動
> wojmsbrokerd -otxdomain domain1

domain1 のインスタンス名 wojmsbrokerd の JMS サーバが起動されます。


例3: Java VM に渡す引数を指定して起動
> wojmsbrokerd -vmargs "-Xms384m -Xmx384m -Xmn128m"

Java VM に渡す引数はスペースで区切ります。複数の引数を渡す場合や、引数にスペースが 含まれる場合は、二重引用符で囲みます。
関連事項
wojmscmd
: コマンドユーティリティ (JMS サーバの管理)

4.4.2. wojmscmd

名称
wojmscmd - コマンドユーティリティ
形式
wojmscmd <subcommand> <argument> [<options>]
wojmscmd -h
wojmscmd -H
wojmscmd -v
説明
JMS サーバの起動後に、物理的な送信先の管理や、 JMS サーバと JMS サーバのコネクションサービスの管理、 および JMS サーバのリソースの管理を行います。

管理対象は、大きく分けると、以下の 7 つになります。() 内は、各サブコマンドの引数 (argument) になります。
各サブコマンドについては、該当する説明のページを参照してください。
サブコマンドと引数

オプション
-b <hostName:port>
JMS サーバのホスト名とポート番号を指定します。デフォルトは、localhost:9700 です。
ポートだけを指定する場合 : -b :7878
ホスト名だけを指定する場合 : -b somehost

-c <clientID>
クライアント ID を指定します。

-d <destinationName>
トピック名を指定します。永続サブスクリプションをリストする場合にのみ使用します。

-f
ユーザの確認なしにアクションを実行します。

-from <index>
メッセージリストで、送信先における表示開始点(この値を含みます)を指定します。

-h, -help
使用法のヘルプを表示します。コマンド行ではそれ以外のことは実行されません。

-H, -Help
使用法のヘルプ、属性リスト、および例を表示します。コマンド行ではそれ以外のことは実行されません。

-int <interval>
メトリックを表示する間隔を秒単位で指定します。デフォルトは、5秒です。

-javahome <javahome>
使用する JRE を指定します。 デフォルトではインストール時に指定されたランタイムを使用します。

-m <metricType>
表示するメトリック情報のタイプを指定します。
JMS サーバ/サービスに有効な値 = {cxn, rts, ttl}
送信先に有効な値 = {con, dsk, rts, ttl}
con = 送信先のコンシューマ情報
cxn = コネクション/VM ヒープ/スレッド
dsk = 送信先のディスク使用状況
rts = 率
ttl = 合計 (デフォルト)

-mbody
メッセージリストにメッセージボディを表示します。

-mid <messageID>
メッセージ ID を指定します。1 件のメッセージをパージする場合にのみ使用します。

-msp <numSamples>
表示するメトリックサンプルの数を指定します。デフォルト値は -1 (無制限) です。

-n <argumentName>
引数の名前を指定します。
これはサブコマンドに応じて、物理的な送信先、永続サブスクリプション、コネクション ID、 またはトランザクション ID の名前になります。

-o <attribute>=<value>
引数のプロパティを指定します。
これはサブコマンドの引数に応じて、 JMS サーバの属性、サービスの属性、または送信先の属性になります。

-otxdomain <domainName>
WebOTX のドメイン名を指定します。

-otxdomainroot <domainRoot>
WebOTX のドメインルートディレクトリを指定します。ドメインディレクトリを既定値 (${AS_INSTALL}/domains) から変更している場合には、ドメイン名を含めた絶対パスの指定が必要です。このオプションが指定された場合、-otxdomain オプションの値は無視します。

-p <password>
管理者パスワードを指定します。この値を省略すると、管理者名の入力を要求されます。

-pst <pauseType>
送信先の一時停止タイプを指定します。
有効な値 = {PRODUCERS, CONSUMERS, ALL}
PRODUCERS = プロデューサからのメッセージを一時停止
CONSUMERS = コンシューマへのメッセージを一時停止
ALL = 両方を一時停止 (デフォルト)

-rtm <timeout>
wojmscmd のサブコマンドの初期 (再試行) タイムアウト期間を秒単位で指定します。
タイムアウトとは、wojmscmd のサブコマンドが JMS サーバへの要求を作成した後、 待機している時間の長さのことです。
それ以降、サブコマンドが再試行されるたびに、タイムアウト値として初期タイムアウト値の 倍数が使用されます。
デフォルト値は10秒です。

-rtr
wojmscmd のサブコマンドが最初にタイムアウトになった後の再試行回数を指定します。
デフォルト値は5回です。

-s
サイレントモード。出力は表示されません。

-secure
JMS サーバ上の SSL/TLS ベースの管理サービス (ssladmin) を使用します (先に ssladmin サービスを有効にしておく必要があります)。

-selector <messageSelector>
メッセージリストのセレクタを指定します。

-svn <serviceName>
サービス名を指定します。コネクションのリスト時にのみ有効です。

-t <destType>
送信先のタイプを指定します。 有効な値 = {q, t}
q = キュー
t = トピック

-tmp
一時的な送信先も表示します。

-to <index>
メッセージリストで、送信先における表示終了点(この値を含みます)を指定します。

-u <userName>
管理者のユーザ名を指定します。この値を省略すると、管理者名の入力を要求されます。

-v, -version
バージョン情報を表示します。コマンド行ではそれ以外のことは実行されません。
使用例
例1: localhost のポート 9700 で実行している JMS サーバのプロパティを一覧表示する場合
> wojmscmd query bkr -u admin -p adminadmin


例2: myserver のポート 1564 で、ユーザ名が alladin、ユーザパスワードが abracadabra で実行しているJMS サーバのプロパティを一覧表示する場合
> wojmscmd query bkr -b myserver:1564 -u alladin -p abracadabra


例3: WebOTX のドメイン domain1 に対して、コマンドの初期タイムアウトが 20 秒、再試行回数を 7 に設定して JMS サーバのプロパティを一覧表示する場合
> wojmscmd query bkr -otxdomain domain1 -u admin -p adminadmin -rtm 20 -rtr 7
関連事項
wojmsusermgr : ユーザマネージャユーティリティ
注意事項

wojmscmd コマンドを使用して JMS サーバを管理する場合、次のタスクを実行する必要があります。



以下の操作は、WebOTX 運用管理コマンド (otxadmin) か、統合運用管理ツールから実行します。



4.4.2.1. commit txn

名称
wojmscmd commit txn - トランザクションのコミット
形式
wojmscmd commit txn -n <transaction_id>
説明
分散トランザクションをコミットします。
コミットできるのは、PREPARED 状態になっているトランザクションだけです。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmscmdオプションを参照してください。

-n <transaction_id>
トランザクション ID を指定します。
使用例
例1: デフォルトの JMS サーバ (localhost:9700) 上のトランザクションをコミットする。
> wojmscmd commit txn -n 64248349708800


関連事項
wojmscmd list txn : トランザクションのリスト
wojmscmd rollback txn : トランザクションのロールバック

4.4.2.2. compact dst

名称
wojmscmd compact dst - 送信先の圧縮
形式
wojmscmd compact dst [-t <destType> -n <destName>]
説明
ひとつ、またはすべての送信先を圧縮します。
送信先のタイプと名前が指定されていない場合は、すべての送信先が圧縮されます。

永続ストアとして、ファイルストアを使用している場合のみ、必要に応じてディスクを圧縮できます。
なお、ディスク利用率の監視については、 wojmscmd metrics dst を参照してください。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmscmdオプションを参照してください。

-t <destType>
送信先のタイプを指定します。 有効な値 = {q, t}
q = キュー
t = トピック

-n <destName>
送信先の名前を指定します。
使用例
例1: キューのディスクを圧縮する
> wojmscmd compact dst -t q -n myQueue -u admin -p adminadmin
Compacting the destination where:

-----------------
送信先名       送信先タイプ
-----------------
myQueue    キュー

指定されたブローカ上で:

---------------------
ホスト          プライマリポート
---------------------
localhost    9700

Are you sure you want to compact this destination? (y/n) y

Successfully compacted the destination.
関連事項
wojmscmd pause dst : 送信先の停止
wojmscmd resume dst : 送信先の再開
注意事項
圧縮する前に、あらかじめ送信先を停止しておく必要があります。
送信先の停止については、 wojmscmd pause dst を参照してください。

4.4.2.3. destroy dur

名称
wojmscmd destroy dur - 永続サブスクリプションの破壊
形式
wojmscmd destroy dur -n <subscrName> -c <client_id>
説明
永続サブスクリプションを破壊します。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmscmdオプションを参照してください。

-n <subscrName>
永続サブスクリプションの名前を指定します。

-c <clientID>
クライアント識別子を指定します。
使用例
例1: 永続サブスクリプションを破壊する
> wojmscmd destroy dur -n myDurable -c myClientID -u admin -p adminadmin
永続サブスクリプションを破壊中:

--------------------------
永続サブスクリプション名    クライアント ID
--------------------------
myDurable       myClientID

指定されたブローカ上で:

---------------------
ホスト          プライマリポート
---------------------
localhost    9700

この永続サブスクリプションを破壊してもよろしいですか ? (y/n) y

永続サブスクリプションの破壊に成功しました。

list dur サブコマンドから返される情報を使用して、破棄する必要がある 永続サブスクリプションを識別することができます。
サブスクリプションを識別するには、サブスクリプションの名前とクライアント ID を使用します。
関連事項
wojmscmd list dur : 永続サブスクリプションのリスト
wojmscmd purge dur : 永続サブスクリプションのメッセージのパージ

4.4.2.4. dump thd

名称
wojmscmd dump thd - スレッドダンプの取得
形式
wojmscmd dump thd [-b <hostName:port>] [-otxdomain <domainName>]
説明
JMSサーバのスレッドダンプを取得します。

取得したスレッドダンプは、${AS_INSTALL}/domains/${DOMAIN_NAME}/logs/wojms/std.logファイルへ出力されます。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmscmdオプションを参照してください。

-b <hostName:port>
JMS サーバのホスト名とポート番号を指定します。デフォルトは、localhost:9700 です。
ポートだけを指定する場合 : -b :7878
ホスト名だけを指定する場合 : -b somehost

-otxdomain <domainName>
WebOTX のドメイン名を指定します。
使用例
例1: doamin2 で実行している JMS サーバのスレッドダンプを取得する。
> wojmscmd dump thd -u admin -p adminadmin -otxdomain domain2
スレッドダンプ生成中:

---------------------
ホスト          プライマリポート
---------------------
myhost    9700

スレッドダンプ生成に成功しました。

上記の例の場合、スレッドダンプは、${AS_INSTALL}/domains/domain2/logs/wojms/std.log へ出力されます。

4.4.2.5. list cxn

名称
wojmscmd list cxn - コネクションのリスト
形式
wojmscmd list cxn [-svn <serviceName>] [-b <hostName:port>] [-otxdomain <domainName>]
説明
指定したサービス名のすべてのコネクションを一覧表示します。
サービス名を指定しない場合は、すべてのサービスのコネクションが一覧表示されます。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmscmdオプションを参照してください。

-svn <serviceName>
サービス名を指定します。

-b <hostName:port>
JMS サーバのホスト名とポート番号を指定します。デフォルトは、localhost:9700 です。
ポートだけを指定する場合 : -b :7878
ホスト名だけを指定する場合 : -b somehost

-otxdomain <domainName>
WebOTX のドメイン名を指定します。
使用例
例1: domain1 の jms サービスのコネクションを表示する
> wojmscmd list cxn -svn jms -otxdomain domain1 -u admin -p adminadmin
Listing all the connections on the service where:

-----
サービス名
-----
jms

指定されたブローカ上で:

------------------
ホスト       プライマリポート
------------------
myhost    9700

--------------------------------------------------------------------
Connection ID        User   Service  Producers  Consumers  Host
--------------------------------------------------------------------
2078692185634545664  guest  jms      1          1          127.0.0.1
2078692185634671360  guest  jms      0          1          127.0.0.1

Successfully listed connections.
関連事項
wojmscmd query cxn : コネクションの情報照会

4.4.2.6. list dst

名称
wojmscmd list dst - 送信先のリスト
形式
wojmscmd list dst [-t <destType>] [-tmp]
説明
JMS サーバの送信先をリストします。

送信先の現在の属性値、送信先に関連付けられているプロデューサ またはコンシューマの数、送信先内のメッセージの数とサイズなどの メッセージングメトリックスに関する情報を取得できます。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmscmdオプションを参照してください。

-t <destType>
送信先のタイプを指定します。 有効な値 = {q, t}
q = キュー
t = トピック

-tmp
一時的な送信先も表示します。

使用例
例1: domain1 の JMS サーバ上のすべての送信先を表示する
> wojmscmd list dst -otxdomain domain1 -u admin -p adminadmin
指定されたブローカ上のすべての送信先のリスト:

------------------
ホスト       プライマリポート
------------------
myhost    9700

------------------------------------------------------------------
Name        Type    State      アクティブコンシューマの最大数    バックアップコンシューマの最大数
------------------------------------------------------------------
myQueue1    キュー     RUNNING    無制限 (-1)           0
myQueue2    キュー     RUNNING    無制限 (-1)           0
myTopic1    トピック    RUNNING    -                  -

送信先のリストに成功しました。


例2: 一時送信先を含めたキューを表示する
> wojmscmd list dst -t q -tmp -u admin -p adminadmin
Listing all the queue destinations on the broker specified by:

---------------------
ホスト          プライマリポート
---------------------
localhost    9700

--------------------------------------------------------------------------------
Name                                                   Type         State
アクティブコンシューマの最大数    バックアップコンシューマの最大数
--------------------------------------------------------------------------------
myQueue1                                               キュー          RUNNING
  無制限 (-1)           0
myQueue2                                               キュー          RUNNING
  無制限 (-1)           0
temporary_destination://queue/172.16.254.242/1127/1    キュー (一時的)    RUNNING
    1                   0

送信先のリストに成功しました。
関連事項
wojmscmd query dst : 送信先情報の表示

4.4.2.7. list dur

名称
wojmscmd list dur - 永続サブスクリプションのリスト
形式
wojmscmd list dur -d <destinationName>
説明
トピックの永続サブスクリプションをリストします。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmscmdオプションを参照してください。

-d <destinationName>
トピック名を指定します。
使用例
例1: トピック MyTopic の永続サブスクリプションを一覧表示する
> wojmscmd list dur -d MyTopic
ユーザ名:admin
パスワード:adminadmin
次で指定されたブローカ上のトピック 'myTopic' にあるすべての
永続サブスクリプションをリストしています:

---------------------
ホスト          プライマリポート
---------------------
localhost    9700

---------------------------------------------------
永続サブスクリプション名   クライアント ID    メッセージの数   永続サブスクリプション状態
---------------------------------------------------
myDurable      myClientID   0         INACTIVE

永続サブスクリプションのリストに成功しました。

トピックの永続サブスクリプションごとに、永続サブスクリプションの名前、 ユーザのクライアント ID、このトピックのキューに入っているメッセージの数、 および永続サブスクリプションの状態 (アクティブまたは非アクティブ) を返します。

関連事項
wojmscmd destroy dur : 永続サブスクリプションの破壊
wojmscmd purge dur : 永続サブスクリプションのメッセージのパージ

4.4.2.8. list msg

名称
wojmscmd list msg - 送信先のメッセージのリスト
形式
wojmscmd list msg -t <destType> -n <destName> [-from <index>] [-to <index>] [-selector <messageSelector>] [-mbody]
説明
送信先に滞留しているメッセージをリストします。

メッセージごとにタイムスタンプ、メッセージタイプ、メッセージ ID、相関 ID、配信モード、有効期間、優先度、および、プロパティを表示します。また、-mbody オプションを指定することで、メッセージボディの一部も表示します。

-from、-to オプションで送信先上の表示開始位置、表示終了位置を指定することができます。指定しない場合は、表示開始位置は 1 、表示終了位置は、最大でJMSサーバのプロパティ (wojms.display.message.count) で指定された値になります。

-selector オプションでメッセージセレクタを指定すると、セレクタに該当するメッセージだけを表示します。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmscmdオプションを参照してください。

-t <destType>
送信先のタイプを指定します。 有効な値 = {q, t}
q = キュー
t = トピック

-n <destName>
送信先の名前を指定します。

-from <index>
メッセージリストで、送信先における表示開始点(この値を含みます)を指定します。

-to <index>
メッセージリストで、送信先における表示終了点(この値を含みます)を指定します。

-selector <messageSelector>
メッセージリストのセレクタを指定します。

-mbody
メッセージリストにメッセージボディを表示します。
使用例
例1: メッセージセレクタを指定してメッセージをリストする
> wojmscmd list msg -u admin -p adminadmin -t q -n MyQueue -selector "NewsType = 'Sports' OR NewsType = 'Business'"
送信先のすべてのメッセージをリストしています:

-----------------
送信先名       送信先タイプ
-----------------
MyQueue    キュー

指定されたブローカ上で:

---------------------
ホスト          プライマリポート
---------------------
localhost    9700

----------------------------------------------------------------------------------------------------------------------------------------------------------------
Timestamp      Type             Message ID                                              Correlation ID  Delivery Mode  Expiration  Priority  Property
----------------------------------------------------------------------------------------------------------------------------------------------------------------
1148448522480  TEXT_MESSAGE(1)  9-172.16.254.239(a6:91:b2:a5:e:a9)-1515-1148448522480                   PERSISTENT     0           4         {NewsType=Sports}
1148448522540  TEXT_MESSAGE(1)  11-172.16.254.239(a6:91:b2:a5:e:a9)-1515-1148448522540                  PERSISTENT     0           4         {NewsType=Business}
1148448522560  TEXT_MESSAGE(1)  12-172.16.254.239(a6:91:b2:a5:e:a9)-1515-1148448522560                  PERSISTENT     0           4         {NewsType=Sports}
1148448522590  TEXT_MESSAGE(1)  14-172.16.254.239(a6:91:b2:a5:e:a9)-1515-1148448522590                  PERSISTENT     0           4         {NewsType=Business}
1148448522610  TEXT_MESSAGE(1)  15-172.16.254.239(a6:91:b2:a5:e:a9)-1515-1148448522610                  PERSISTENT     0           4         {NewsType=Sports}

メッセージのリストに成功しました。
関連事項
wojmscmd query dst : 送信先情報の表示

4.4.2.9. list svc

名称
wojmscmd list svc - サービスのリスト
形式
wojmscmd list svc [-b <hostName:port>] [-otxdomain <domainName>]
説明
JMS サーバのサービスをリストします。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmscmdオプションを参照してください。

-b <hostName:port>
JMS サーバのホスト名とポート番号を指定します。デフォルトは、localhost:9700 です。
ポートだけを指定する場合 : -b :7878
ホスト名だけを指定する場合 : -b somehost

-otxdomain <domainName>
WebOTX のドメイン名を指定します。
使用例
例1: JMS サーバの使用可能なコネクションサービスを一覧表示する
> wojmscmd list svc -u admin -p adminadmin
指定されたブローカ上のすべてのサービスのリスト:

---------------------
ホスト          プライマリポート
---------------------
localhost    9700

--------------------------------
サービス名       ポート番号        サービス状態
--------------------------------
admin       2037 (動的)    RUNNING
jms         2036 (動的)    RUNNING
ssladmin    動的           UNKNOWN
ssljms      動的           UNKNOWN
関連事項
wojmscmd query svc : サービスの情報照会

4.4.2.10. list txn

名称
wojmscmd list txn - トランザクションのリスト
形式
wojmscmd list txn
説明
JMS サーバのトランザクションを一覧表示します。
トランザクションごとに、トランザクション ID、状態、ユーザ名、メッセージまたは通知の数、および作成時間を返します。
使用例
例1: JMS サーバのすべてのトランザクションを一覧表示する
> wojmscmd list txn -u admin -p adminadmin
指定されたブローカ上のすべてのトランザクションのリスト:

---------------------
ホスト          プライマリポート
---------------------
localhost    9700

-------------------------------------------------------------------------
トランザクション ID           状態        ユーザ名    # Msgs/# Acks   作成時刻
-------------------------------------------------------------------------
3624552822230839552   STARTED   guest   84/0            04/08/14 17:29:55
3624552822251128576   STARTED   guest   8/0             04/08/14 17:31:14

トランザクションのリストに成功しました。
トランザクションごとに、list サブコマンドは、トランザクション ID、状態、ユーザ名、メッセージまたは通知の数、および作成時間を返します。
関連事項
wojmscmd query txn : トランザクションの情報照会
wojmscmd commit txn : トランザクションのコミット
wojmscmd rollback txn : トランザクションのロールバック

4.4.2.11. metrics bkr

名称
wojmscmd metrics bkr - JMS サーバのメトリックス表示
形式
wojmscmd metrics bkr [-b <hostName:port>] [-otxdomain <domainName>] [-m <metricType>] [-int <interval>] [-msp <numSamples>]
説明
デフォルトの JMS サーバ、または指定したホストとポートの JMS サーバに対して、JMS サーバのメトリックスを表示します。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmscmdオプションを参照してください。

-b <hostName:port>
JMS サーバのホスト名とポート番号を指定します。デフォルトは、localhost:9700 です。
ポートだけを指定する場合 : -b :7878
ホスト名だけを指定する場合 : -b somehost

-otxdomain <domainName>
WebOTX のドメイン名を指定します。

-m <metricType>
表示するメトリック情報のタイプを指定します。指定できるのは、以下の3つです。
ttl
JMS サーバとの間のメッセージと、パケットのフローに関するメトリックスを表示します。 (デフォルトのメトリックスタイプ)
rts
JMS サーバとの間のメッセージと、パケットのフローレートに関するメトリックスを表示します。 (秒単位)
cxn
コネクション、仮想メモリーヒープ、およびスレッドを表示します。

-int <interval>
メトリックを表示する間隔を秒単位で指定します。デフォルトは、5秒です。

-msp <numSamples>
表示するメトリックサンプルの数を指定します。デフォルト値は -1 (無制限) です。
使用例
例1: JMS サーバに入力するメッセージフローと JMS サーバから出力されるメッセージのフローレートを 10 秒間隔で取得する
> wojmscmd metrics bkr -m rts -int 10 -u admin -p adminadmin
ブローカのメトリックを表示する:

---------------------
ホスト          プライマリポート
---------------------
localhost    9700

--------------------------------------------------------
 Msgs/sec    Msg Bytes/sec    Pkts/sec    Pkt Bytes/sec
 In   Out     In      Out     In   Out     In      Out
--------------------------------------------------------
 10    10    1639    1684     24    24    3365    3259
 0     0      29      57      1     1     146      161
 0     0      29      58      0     0      40      67
関連事項
wojmscmd metrics svc : コネクションサービスのメトリックス
wojmscmd metrics dst : 送信先のメトリックス

4.4.2.12. metrics dst

名称
wojmscmd metrics dst - 送信先のメトリックス表示
形式
wojmscmd metrics dst -t <destType> -n <destName> [-m <metricType>] [-int <interval>] [-msp <numSamples>]
説明
送信先のメトリックスを表示します。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmscmdオプションを参照してください。

-t <destType>
送信先のタイプを指定します。 有効な値 = {q, t}
q = キュー
t = トピック

-n <destName>
送信先の名前を指定します。

-m <metricType>
表示するメトリックス情報のタイプを指定します。指定できるのは、以下の 4 つです。

ttl
送信先との間でやり取りされメモリーに常駐しているメッセージと パケットに関するメトリックスを表示します。
(デフォルトのメトリックスタイプ)
rts
送信先との間のメッセージとパケットのフローレート (秒単位) に関するメトリックスと、 その他のレート情報を表示します。
con
コンシューマ関連のメトリックスを表示します。
dsk
ディスク使用量のメトリックスを表示します。

-int <interval>
メトリックスを表示する間隔を秒単位で指定します。デフォルトは、5秒です。

-msp <numSamples>
表示するメトリックサンプルの数を指定します。デフォルト値は -1 (無制限) です。
使用例
例1: 送信先に関するメッセージメトリックス情報を取得する
> wojmscmd metrics dst -t q -n myQueue -m ttl -u admin -p adminadmin
Displaying destination metrics where:

-----------------
送信先名       送信先タイプ
-----------------
myQueue    キュー

指定されたブローカ上で:

---------------------
ホスト          プライマリポート
---------------------
localhost    9700

---------------------------------------------------------------------------
 Msgs     Msg Bytes       Msg Count         Total Msg Bytes (k)     Largest
In  Out   In    Out   Current  Peak  Avg  Current   Peak     Avg    Msg (k)
---------------------------------------------------------------------------
19  19   92826  92826     0      10    2      0       50      14        9
24  24   123588  123588     0      10    2      0       50      11        9
29  29   144336  144336     0      10    2      0       50      10        9
関連事項
wojmscmd metrics bkr : JMS サーバのメトリックス
wojmscmd metrics svc : コネクションサービスのメトリックス

4.4.2.13. metrics svc

名称
wojmscmd metrics svc - サービスのメトリック表示
形式
wojmscmd metrics svc -n <serviceName> [-b <hostName:port>] [-otxdomain <domainName>] [-m <metricType>] [-int <interval>] [-msp <numSamples>]
説明
サービスのメトリックスを表示します。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmscmdオプションを参照してください。

-n <serviceName>
サービス名を指定します。

-b <hostName:port>
JMS サーバのホスト名とポート番号を指定します。デフォルトは、localhost:9700 です。
ポートだけを指定する場合 : -b :7878
ホスト名だけを指定する場合 : -b somehost

-otxdomain <domainName>
WebOTX のドメイン名を指定します。

-m <metricType>
表示するメトリック情報のタイプを指定します。指定できるのは、以下の3つです。
ttl
指定したサービスを使って JMS サーバとの間で入出力されているメッセージと、 パケットのフローに関するメトリックスを表示します。 (デフォルトのメトリックスタイプ)
rts
指定したサービスを使って JMS サーバとの間で入出力されているメッセージと、 パケットのフローレートに関するメトリックスを表示します。 (秒単位)
cxn
コネクション、仮想メモリーヒープ、およびスレッドを表示します。

-int <interval>
メトリックを表示する間隔を秒単位で指定します。デフォルトは、5秒です。

-msp <numSamples>
表示するメトリックサンプルの数を指定します。デフォルト値は -1 (無制限) です。
使用例
例1: jms コネクションサービスによって処理されたメッセージとパケットの累計数を取得する
> wojmscmd metrics svc -n jms -m ttl -u admin -p adminadmin
サービスのメトリックを表示する:

-----
サービス名
-----
jms

指定されたブローカ上で:

---------------------
ホスト          プライマリポート
---------------------
localhost    9700

----------------------------------------------
  Msgs     Msg Bytes      Pkts     Pkt Bytes
In   Out   In     Out   In   Out   In     Out
----------------------------------------------
102  102  16128  16128  261  263  36059  34939
204  204  32256  32256  501  503  69349  66743
関連事項
wojmscmd metrics bkr : JMS サーバのメトリックス
wojmscmd metrics dst : 送信先のメトリックス

4.4.2.14. pause bkr

名称
wojmscmd pause bkr - JMS サーバのサービスの一時停止
形式
wojmscmd pause bkr [-b <hostName:port>] [-otxdomain <domainName>]
説明
JMS サーバのすべてのサービスを一時停止します。

JMS サーバを停止すると、JMS サーバのコネクションサービス (jms、ssljms) が中断されるため、JMS サーバはコネクションポートでの待機をやめます。
その結果、JMS サーバはそれ以上、新しいコネクションの受け入れ、メッセージの受信、メッセージの配信は行いません。

ただし、JMS サーバを停止しても管理コネクションサービス (admin、ssladmin) は中断されないため、JMS サーバへのメッセージを制限するために必要な管理タスクは実行できます。
たとえば、特定の送信先にメッセージが集中した場合には、 JMS サーバを停止し、問題の修復に役立つ、メッセージの送信元の追跡、送信先のサイズの制限、または送信先の破棄などの操作を行うことができます。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmscmdオプションを参照してください。

-b <hostName:port>
JMS サーバのホスト名とポート番号を指定します。デフォルトは、localhost:9700 です。
ポートだけを指定する場合 : -b :7878
ホスト名だけを指定する場合 : -b somehost

-otxdomain <domainName>
WebOTX のドメイン名を指定します。
使用例
例1: doamin1 で実行している JMS サーバを停止する
> wojmscmd pause bkr -otxdomain domain1 -u admin -p adminadmin
指定されたブローカを一時停止中:

------------------
ホスト       プライマリポート
------------------
myhost    9700

このブローカを一時停止してもよろしいですか ? (y/n) y

ブローカの一時停止に成功しました。
関連事項
wojmscmd pause svc : 個々のコネクションサービスの停止
wojmscmd resume bkr : JMS サーバのサービスの再開

4.4.2.15. pause dst

名称
wojmscmd pause dst - 送信先の一時停止
形式
wojmscmd pause dst [-t <destType> -n <destName>] [-pst <pauseType>]
説明
ひとつ、またはすべての送信先を一時停止します。
送信先のタイプと名前が指定されていない場合は、すべての送信先が一時停止されます。

本サブコマンドで、プロデューサから送信先、送信先からコンシューマ、または その両方のメッセージの配信を制御するために、送信先を停止できます。
特に、メッセージのプロデュースがコンシュームよりかなり高速な場合に、送信先が メッセージによって過負荷にならないように、送信先へのメッセージフローを停止できます。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmscmdオプションを参照してください。

-t <destType>
送信先のタイプを指定します。 有効な値 = {q, t}
q = キュー
t = トピック

-n <destName>
送信先の名前を指定します。

-pst <pauseType>
送信先の一時停止タイプを指定します。
有効な値 = {PRODUCERS, CONSUMERS, ALL}
PRODUCERS = プロデューサからのメッセージを一時停止
CONSUMERS = コンシューマへのメッセージを一時停止
ALL = 両方を一時停止 (デフォルト)
使用例
例1: キューの送信先のプロデューサからのメッセージを停止する
> wojmscmd pause dst -n myQueue -t q -pst PRODUCERS -u admin -p adminadmin
Pausing the destination where:

-----------------
送信先名       送信先タイプ
-----------------
myQueue    キュー

Using the following attribute:

Pause Type    PRODUCERS

指定されたブローカ上で:

---------------------
ホスト          プライマリポート
---------------------
localhost    9700

Are you sure you want to pause this destination? (y/n) y

Successfully paused the destination.

例2: トピックの送信先のコンシューマへのメッセージを停止する
> wojmscmd pause dst -n myTopic -t t -pst CONSUMERS -u admin -p adminadmin
Pausing the destination where:

-----------------
送信先名       送信先タイプ
-----------------
myTopic    トピック

Using the following attribute:

Pause Type    CONSUMERS

指定されたブローカ上で:

---------------------
ホスト          プライマリポート
---------------------
localhost    9700

Are you sure you want to pause this destination? (y/n) y

Successfully paused the destination.
関連事項
wojmscmd resume dst : 送信先の再開

4.4.2.16. pause svc

名称
wojmscmd pause svc - サービスの一時停止
形式
wojmscmd pause svc -n <serviceName> [-b <hostName:port>] [-otxdomain <domainName>]
説明
1 つのサービスを一時停止します。ただし、admin サービス、ssladmin サービスは停止できません。

サービスを停止すると、次のような結果になります。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmscmdオプションを参照してください。

-n <serviceName>
サービス名を指定します。

-b <hostName:port>
JMS サーバのホスト名とポート番号を指定します。デフォルトは、localhost:9700 です。
ポートだけを指定する場合 : -b :7878
ホスト名だけを指定する場合 : -b somehost

-otxdomain <domainName>
WebOTX のドメイン名を指定します。
使用例
例1: デフォルトの JMS サーバの jms コネクションサービスを停止する
> wojmscmd pause svc -n jms -u admin -p adminadmin
サービスを一時停止中:

-----
サービス名
-----
jms

指定されたブローカ上で:

---------------------
ホスト          プライマリポート
---------------------
localhost    9700

このサービスを一時停止してもよろしいですか ? (y/n) y

サービスの一時停止に成功しました。
関連事項
wojmscmd resume svc : サービスの再開

4.4.2.17. purge dst

名称
wojmscmd purge dst - 送信先のメッセージのパージ
形式
wojmscmd purge dst -t <destType> -n <destName> [-mid <messageID>]
説明
送信先を破壊しないで、送信先上のメッセージをパージします。

-mid オプションでメッセージ ID を指定すると、該当する 1 件のメッセージをパージします。省略すると、送信先のすべてのメッセージをパージします。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmscmdオプションを参照してください。

-t <destType>
送信先のタイプを指定します。 有効な値 = {q, t}
q = キュー
t = トピック

-n <destName>
送信先の名前を指定します。

-mid <messageID>
メッセージ ID を指定します。1 件のメッセージをパージする場合にのみ使用します。
使用例
例1: キューをパージする
> wojmscmd purge dst -n myQueue -t q -u admin -p adminadmin
送信先をパージ中:

-----------------
送信先名       送信先タイプ
-----------------
myQueue    キュー

指定されたブローカ上で:

---------------------
ホスト          プライマリポート
---------------------
localhost    9700

この送信先をパージしてもよろしいですか ? (y/n) y

送信先のパージに成功しました。

例2: トピックをパージする
> wojmscmd purge dst -n myTopic -t t -u admin -p adminadmin
送信先をパージ中:

-----------------
送信先名       送信先タイプ
-----------------
myTopic    トピック

指定されたブローカ上で:

---------------------
ホスト          プライマリポート
---------------------
localhost    9700

この送信先をパージしてもよろしいですか ? (y/n) y

送信先のパージに成功しました。

例3: キューに存在する 1 件のメッセージをパージする
> wojmscmd purge dst -u admin -p adminadmin -t q -n MyQueue -mid 19-172.16.254.239(fd:ed:6:83:8e:6b)-1501-1148447927875
送信先のメッセージをパージ中:

---------------------------------------------------------------------------
送信先名       送信先タイプ    Message ID
---------------------------------------------------------------------------
MyQueue    キュー       19-172.16.254.239(fd:ed:6:83:8e:6b)-1501-1148447927875

指定されたブローカ上で:

---------------------
ホスト          プライマリポート
---------------------
localhost    9700

このメッセージをパージしてもよろしいですか ? (y/n) y

送信先のパージに成功しました。

4.4.2.18. purge dur

名称
wojmscmd purge dur - 永続サブスクリプションのメッセージのパージ
形式
wojmscmd purge dur -n <subscrName> -c <client_id>
説明
永続サブスクリプションを破壊しないで、永続サブスクリプションのすべてのメッセージをパージします。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmscmdオプションを参照してください。

-n <subscrName>
永続サブスクリプションの名前を指定します。

-c <clientID>
クライアント ID を指定します。
使用例
例1: 永続サブスクリプションをパージする
> wojmscmd purge dur -n myDurable -c myClientID -u admin -p adminadmin
永続サブスクリプションをパージ中:

--------------------------
永続サブスクリプション名    クライアント ID
--------------------------
myDurable       myClientID

指定されたブローカ上で:

---------------------
ホスト          プライマリポート
---------------------
localhost    9700

この永続サブスクリプションをパージしてもよろしいですか ? (y/n)y

永続サブスクリプションのパージに成功しました。

list dur サブコマンドから返される情報を使用して、メッセージをパージする必要がある 永続サブスクリプションを識別することができます。
サブスクリプションを識別するには、サブスクリプションの名前とクライアント ID を使用します。
関連事項
wojmscmd list dur : 永続サブスクリプションのリスト
wojmscmd destroy dur : 永続サブスクリプションの破壊

4.4.2.19. query bkr

名称
wojmscmd query bkr - JMS サーバの情報照会
形式
wojmscmd query bkr [-b <hostName:port>] [-otxdomain <domainName>]
説明
JMS サーバの現在のプロパティ設定を一覧表示します。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmscmdオプションを参照してください。

-b <hostName:port>
JMS サーバのホスト名とポート番号を指定します。デフォルトは、localhost:9700 です。
ポートだけを指定する場合 : -b :7878
ホスト名だけを指定する場合 : -b somehost

-otxdomain <domainName>
WebOTX のドメイン名を指定します。
使用例
例1: doamin1 で実行している JMS サーバの情報を表示する
> wojmscmd query bkr -otxdomain domain1 -u admin -p adminadmin
指定されたブローカを照会中:

------------------
ホスト       プライマリポート
------------------
myhost    9700

バージョン                          6.1
インスタンス名                        wojmsbroker
プライマリポート                       9700

システム内の現在のメッセージ数                0
システム内の現在のメッセージのサイズ (バイト単位)     0

システム内のメッセージの最大数                無制限 (-1)
システム内のメッセージの最大サイズ              無制限 (-1)
最大メッセージサイズ                     70m

自動キュー作成                        true
自動トピック作成                       true
自動生成キューに対するアクティブコンシューマの最大数     1
自動生成キューに対するバックアップコンシューマの最大数    0

ログレベル                          INFO
ログロールオーバー 間隔 (秒単位)             604800
ログロールオーバーサイズ (バイト単位)           無制限 (-1)

ブローカの照会に成功しました。

4.4.2.20. query cxn

名称
wojmscmd query cxn - コネクションの情報照会
形式
wojmscmd query cxn -n <connectionID> [-b <hostName:port>] [-otxdomain <domainName>]
説明
コネクションの情報を照会し、表示します。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmscmdオプションを参照してください。

-n <connectionID>
コネクション ID を指定します。

-b <hostName:port>
JMS サーバのホスト名とポート番号を指定します。デフォルトは、localhost:9700 です。
ポートだけを指定する場合 : -b :7878
ホスト名だけを指定する場合 : -b somehost

-otxdomain <domainName>
WebOTX のドメイン名を指定します。
使用例
例1: domain1 上のコネクションに関する情報を表示する
> wojmscmd query cxn -n 2078692185634545664 -otxdomain domain1 -u admin -p adminadmin
Querying the connection where:

-------------------
Connection ID
-------------------
2078692185634545664

指定されたブローカ上で:

------------------
ホスト       プライマリポート
------------------
myhost    9700

Connection ID      2078692185634545664
User               guest
Service            jms
Producers          1
Consumers          1
Host               127.0.0.1
Port               3625
Client ID
Client Platform    WOJMS/6.1 (JMS; Windows 2000 5.0 x86)

Successfully queried the connection.
関連事項
wojmscmd list cxn : コネクションのリスト

4.4.2.21. query dst

名称
wojmscmd query dst - 送信先の情報照会
形式
wojmscmd query dst -t <destType> -n <destName>
説明
送信先の情報を照会し表示します。送信先の現在の属性値に関する情報を取得することができます。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmscmdオプションを参照してください。

-t <destType>
送信先のタイプを指定します。 有効な値 = {q, t}
q = キュー
t = トピック

-n <destName>
送信先の名前を指定します。

使用例
例1: キューの送信先に関する情報を表示する
> wojmscmd query dst -t q -n myQueue -u admin -p adminadmin
送信先を照会中:

-----------------
送信先名       送信先タイプ
-----------------
myQueue    キュー

指定されたブローカ上で:

---------------------
ホスト          プライマリポート
---------------------
localhost    9700

送信先名                           myQueue
送信先タイプ                         キュー
Destination State              RUNNING
Created Administratively       true

現在のメッセージ数                      0
現在のメッセージの合計サイズ (バイト単位)         0
Current Number of Producers    0
現在のアクティブコンシューマ数                0
現在のバックアップコンシューマ数               0

メッセージの最大数                      無制限 (-1)
メッセージの最大合計サイズ (バイト単位)          無制限 (-1)
1 メッセージ当たりの最大サイズ (バイト単位)       無制限 (-1)
プロデューサの最大数                     100
アクティブコンシューマの最大数                無制限 (-1)
バックアップコンシューマの最大数               0

制限到達時の振る舞い                     REJECT_NEWEST
コンシューマへのフロー制限数                 1000

送信先の照会に成功しました。
関連事項
wojmscmd list dst : 送信先のリスト

4.4.2.22. query svc

名称
wojmscmd query svc - サービスの情報照会
形式
wojmscmd query svc -n <serviceName> [-b <hostName:port>] [-otxdomain <domainName>]
説明
サービスの情報を照会し表示します。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmscmdオプションを参照してください。

-n <serviceName>
サービス名を指定します。

-b <hostName:port>
JMS サーバのホスト名とポート番号を指定します。デフォルトは、localhost:9700 です。
ポートだけを指定する場合 : -b :7878
ホスト名だけを指定する場合 : -b somehost

-otxdomain <domainName>
WebOTX のドメイン名を指定します。
使用例
例1: domain1 の JMS サーバ上の jms サービスの情報を表示する
> wojmscmd query svc -n jms -otxdomain domain1 -u admin -p adminadmin
サービスを照会中:

-----
サービス名
-----
jms

指定されたブローカ上で:

------------------
ホスト       プライマリポート
------------------
myhost    9700

サービス名           jms
サービス状態          PAUSED
ポート番号           0 (動的)

現在の割り当てスレッド数    8
現在のコネクション数      2

スレッドの最小数        10
スレッドの最大数        1000

サービスの照会に成功しました。
関連事項
wojmscmd update svc : サービスの属性更新

4.4.2.23. query txn

名称
wojmscmd query txn - トランザクションの情報照会
形式
wojmscmd query txn -n <transaction_id>
説明
トランザクションの情報を照会し表示します。

query サブコマンドを使用すると、list サブコマンドと同じ情報のほかに、 クライアント ID、コネクション識別子、分散トランザクション ID (XID) などの多数の追加された値を確認できます。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmscmdオプションを参照してください。

-n <transaction_id>
トランザクション ID を指定します。
使用例
例1: デフォルトの JMS サーバ (localhost:9700) 上のトランザクションの情報を表示する
> wojmscmd query txn -n 3624552822251128576 -u admin -p adminadmin
トランザクションを照会中:

-------------------
トランザクション ID
-------------------
3624552822251128576

指定されたブローカ上で:

---------------------
ホスト          プライマリポート
---------------------
localhost    9700

XID
クライアント ID
コネクション         guest@127.0.0.1:1799->jms:1202
トランザクション ID    3624552822251128576
メッセージの数        85
ユーザ名           guest
作成時刻           04/08/14 17:31:14
状態             STARTED
通知の数           0

トランザクションの照会に成功しました。
トランザクション ID は、list txn サブコマンドなどを利用して取得することができます。
関連事項
wojmscmd list txn : トランザクションのリスト
wojmscmd commit txn : トランザクションのコミット
wojmscmd rollback txn : トランザクションのロールバック

4.4.2.24. restart bkr

名称
wojmscmd restart bkr - JMS サーバの再起動
形式
wojmscmd restart bkr [-b <hostName:port>] [-otxdomain <domainName>]
説明
JMS サーバをシャットダウンして、再起動します。

このコマンドは、JMS サーバを最初に起動したときに指定したオプションを使用して、再起動します。
別のオプションを有効にする必要がある場合、いったん、JMS サーバをシャットダウンしてから、必要なオプションを指定して、 JMS サーバを起動し直す必要があります。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmscmdオプションを参照してください。

-b <hostName:port>
JMS サーバのホスト名とポート番号を指定します。デフォルトは、localhost:9700 です。
ポートだけを指定する場合 : -b :7878
ホスト名だけを指定する場合 : -b somehost

-otxdomain <domainName>
WebOTX のドメイン名を指定します。
使用例
例1: domain1 上の JMS サーバを再起動する
> wojmscmd restart bkr -otxdomain domain1 -u admin -p adminadmin
指定されたブローカの再起動:

------------------
ホスト       プライマリポート
------------------
myhost    9700

このブローカを再起動してもよろしいですか ? (y/n) y

ブローカの再起動に成功しました。

4.4.2.25. resume bkr

名称
wojmscmd resume bkr - JMS サーバのサービスの再開
形式
wojmscmd resume bkr [-b <hostName:port>] [-otxdomain <domainName>]
説明
JMS サーバのすべてのサービスを再開します。
JMS サーバを再開すると、 JMS サーバのサービスが再び有効になり、JMS サーバはポートでの待機を再開します。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmscmdオプションを参照してください。

-b <hostName:port>
JMS サーバのホスト名とポート番号を指定します。デフォルトは、localhost:9700 です。
ポートだけを指定する場合 : -b :7878
ホスト名だけを指定する場合 : -b somehost

-otxdomain <domainName>
WebOTX のドメイン名を指定します。
使用例
例1: domain1 上で実行していた JMS サーバを再開する
> wojmscmd resume bkr -otxdomain domain1 -u admin -p adminadmin
指定されたブローカを再開:

------------------
ホスト       プライマリポート
------------------
myhost    9700

このブローカを再開してもよろしいですか ? (y/n) y

ブローカの再開に成功しました。
関連事項
wojmscmd pause bkr : JMS サーバのサービスの一時停止

4.4.2.26. resume dst

名称
wojmscmd resume dst - 送信先の再開
形式
wojmscmd resume dst [-t <destType> -n <destName>]
説明
ひとつ、またはすべての送信先を再開します。
送信先のタイプと名前が指定されていない場合は、すべての送信先が再開されます。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmscmdオプションを参照してください。

-t <destType>
送信先のタイプを指定します。 有効な値 = {q, t}
q = キュー
t = トピック

-n <destName>
送信先の名前を指定します。
使用例
例1: キューを再開する
> wojmscmd resume dst -t q -n myQueue -u admin -p adminadmin
Resuming the destination where:

-----------------
送信先名       送信先タイプ
-----------------
myQueue    キュー

指定されたブローカ上で:

---------------------
ホスト          プライマリポート
---------------------
localhost    9700

Are you sure you want to resume this destination? (y/n) y

Successfully resumed the destination.
関連事項
wojmscmd pause dst : 送信先の一時停止

4.4.2.27. resume svc

名称
wojmscmd resume svc - サービスの再開
形式
wojmscmd resume svc -n <serviceName> [-b <hostName:port>] [-otxdomain <domainName>]
説明
1 つのサービスを再開します。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmscmdオプションを参照してください。

-n <serviceName>
サービス名を指定します。

-b <hostName:port>
JMS サーバのホスト名とポート番号を指定します。デフォルトは、localhost:9700 です。
ポートだけを指定する場合 : -b :7878
ホスト名だけを指定する場合 : -b somehost

-otxdomain <domainName>
WebOTX のドメイン名を指定します。
使用例
例1: デフォルトの JMS サーバの jms コネクションサービスを再開する
> wojmscmd resume svc -n jms -u admin -p adminadmin
サービスを再開:

-----
サービス名
-----
jms

指定されたブローカ上で:

---------------------
ホスト          プライマリポート
---------------------
localhost    9700

このサービスを再開してもよろしいですか ? (y/n)y

サービスの再開に成功しました。
関連事項
wojmscmd pause svc : サービスの停止

4.4.2.28. rollback txn

名称
wojmscmd rollback txn - トランザクションのロールバック
形式
wojmscmd rollback txn -n <transaction_id>
説明
分散トランザクションをロールバックします。 ロールバックできるのは、PREPARED 状態になっているトランザクションだけです。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmscmdオプションを参照してください。

-n <transaction_id>
トランザクション ID を指定します。
使用例
例1: デフォルトの JMS サーバ (localhost:9700) 上のトランザクションをロールバックする
> wojmscmd rollback txn -n 64248349708800


関連事項
wojmscmd list txn : トランザクションのリスト
wojmscmd commit txn : トランザクションのコミット

4.4.2.29. update svc

名称
wojmscmd update svc - サービスの属性更新
形式
wojmscmd update svc -n <serviceName> [-b <hostName:port>] [-otxdomain <domainName>] -o <attribute>=<value> [-o <attribute>=<value>] ...
説明
サービスの属性を更新します。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmscmdオプションを参照してください。

-n <serviceName>
サービス名を指定します。

-b <hostName:port>
JMS サーバのホスト名とポート番号を指定します。デフォルトは、localhost:9700 です。
ポートだけを指定する場合 : -b :7878
ホスト名だけを指定する場合 : -b somehost

-otxdomain <domainName>
WebOTX のドメイン名を指定します。

-o <attribute>=<value>
サービスのプロパティを指定します。
このコマンドで更新されるサービスのプロパティは、次のとおりです。

表4.4.2.29-1
プロパティ 説明
maxThreads サービスに割り当てられるスレッドの最大数
minThreads サービスに割り当てられるスレッドの最小数
port サービスに割り当てられるポート番号。
値 0 は、ポートマッパーによって動的に割り当てられることを示している。
使用例
例1: jms サービスに割り当てられたスレッドの最少数を 20 に設定する
> wojmscmd update svc -n jms -o "minThreads=20" -u admin -p adminadmin
以下の名前のサービスを更新中:

jms

以下の更新された属性で:

minThreads    20

指定されたブローカ上で:

---------------------
ホスト          プライマリポート
---------------------
localhost    9700

このサービスを更新してもよろしいですか ? (y/n) y

サービスの更新に成功しました。
関連事項
wojmscmd query svc : サービスの情報照会

4.4.3. wojmsdbmgr

名称
wojmsdbmgr - データベースマネージャ
形式
wojmsdbmgr <subcommand> <argument> [<options>]
wojmsdbmgr -h|-help
wojmsdbmgr -v|-version
説明
永続ストアとして JDBC ストアを利用する場合のデータベーススキーマの作成、および、管理を行います。

インストール直後は、ファイルストアを利用する設定になっていますので、JDBC ストアを利用する場合は、あらかじめ設定が必要になります。 設定の詳細については、 「リファレンス集 運用管理・設定編 > 1. コンフィグレーション(設定一覧) > 1.7. JMS > 1.7.3. その他の設定項目・設定方法 > 1.7.3.2. JDBCストアを利用するための設定 」 を参照してください。
サブコマンドと引数
create tbl
テーブルを作成します。
delete tbl
テーブルを削除します。
delete oldtbl
旧バージョンのテーブルを削除します。
recreate tbl
テーブルを削除してから作成します。
オプション
-b <instanceName>
JMS サーバのインスタンスの名前を指定し、対応するプロパティの設定に使用します。

-h, -help
使用法のヘルプを表示します。コマンド行ではそれ以外のことは実行されません。

-otxdomain <domainName>
WebOTX のドメイン名を指定し、対応するプロパティの設定に使用します。

-otxdomainroot <domainRoot>
WebOTX のドメインルートディレクトリを指定します。ドメインディレクトリを既定値 (${AS_INSTALL}/domains) から変更している場合には、ドメイン名を含めた絶対パスの指定が必要です。このオプションが指定された場合、-otxdomain オプションの値は無視します。

-p <password>
データベースのパスワードを指定します。

-u <userName>
データベースのユーザ名を指定します。

-v, -version
バージョン情報を表示します。コマンド行ではそれ以外のことは実行されません。

4.4.3.1. create tbl

名称
wojmsdbmgr create tbl - テーブルの作成
形式
wojmsdbmgr create tbl [<options>]
説明
既存のデータベースシステムに、JMS サーバの永続ストアのスキーマを作成します。
このコマンドは、外部データベースシステムで使用します。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmsdbmgrオプションを参照してください。

-b <instanceName>
JMS サーバのインスタンスの名前を指定し、対応するプロパティの設定に使用します。

-otxdomain <domainName>
WebOTX のドメイン名を指定し、対応するプロパティの設定に使用します。

-p <password>
データベースのパスワードを指定します。

-u <userName>
データベースのユーザ名を指定します。

使用例
例1: domain1 の設定の利用と、データベースのユーザ名、パスワードを指定してデータベースを作成する
> wojmsdbmgr create tbl -otxdomain domain1 -u scott -p tiger
関連事項
wojmsdbmgr delete tbl : テーブルの削除
wojmsdbmgr delete oldtbl : 旧バージョンのテーブルの削除
wojmsdbmgr recreate tbl : テーブルの再作成

4.4.3.2. delete tbl

名称
wojmsdbmgr delete tbl - テーブルの削除
形式
wojmsdbmgr delete tbl [<options>]
説明
現在の永続ストアのデータベース内に存在する JMS サーバのデータベーステーブルを削除します。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmsdbmgrオプションを参照してください。

-b <instanceName>
JMS サーバのインスタンスの名前を指定し、対応するプロパティの設定に使用します。

-otxdomain <domainName>
WebOTX のドメイン名を指定し、対応するプロパティの設定に使用します。

-p <password>
データベースのパスワードを指定します。

-u <userName>
データベースのユーザ名を指定します。

使用例
例1: データベースのユーザ名、パスワードを指定してデータベースを削除する
> wojmsdbmgr delete tbl -otxdomain domain1 -u scott -p tiger
関連事項
wojmsdbmgr create tbl : テーブルの作成
wojmsdbmgr delete oldtbl : 旧バージョンのテーブルの削除
wojmsdbmgr recreate tbl : テーブルの再作成

4.4.3.3. delete oldtbl

名称
wojmsdbmgr delete oldtbl - 旧バージョンのテーブル削除
形式
wojmsdbmgr delete oldtbl [<options>]
説明
V8.20 よりも前のバージョンの JDBC ストアで利用していた、次のテーブルを削除します。
表4.4.3.3-1
テーブル名 説明
WOJMSILIST35 配信対象の状態テーブル。V8.2以降では、WOJMSILIST82に変更しています。


オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmsdbmgrオプションを参照してください。

-b <instanceName>
JMS サーバのインスタンスの名前を指定し、対応するプロパティの設定に使用します。

-otxdomain <domainName>
WebOTX のドメイン名を指定し、対応するプロパティの設定に使用します。

-p <password>
データベースのパスワードを指定します。

-u <userName>
データベースのユーザ名を指定します。

使用例
例1: データベースのユーザ名、パスワードを指定してデータベースを削除する
> wojmsdbmgr delete oldtbl -otxdomain domain1 -u scott -p tiger
関連事項
wojmsdbmgr create tbl : テーブルの作成
wojmsdbmgr delete tbl : テーブルの削除

4.4.3.4. recreate tbl

名称
wojmsdbmgr recreate tbl - テーブルの再作成
形式
wojmsdbmgr recreate tbl [<options>]
説明
現在の永続ストアのデータベース内に存在する JMS サーバのデータベーステーブルを 削除した後、JMS サーバの永続ストアのスキーマを作成し直します。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmsdbmgrオプションを参照してください。

-b <instanceName>
JMS サーバのインスタンスの名前を指定し、対応するプロパティの設定に使用します。

-otxdomain <domainName>
WebOTX のドメイン名を指定し、対応するプロパティの設定に使用します。

-p <password>
データベースのパスワードを指定します。

-u <userName>
データベースのユーザ名を指定します。

使用例
例1: データベースのユーザ名、パスワードを指定してデータベースを再作成する
> wojmsdbmgr recreate tbl -otxdomain domain1 -u scott -p tiger
関連事項
wojmsdbmgr create tbl : テーブルの作成
wojmsdbmgr delete tbl : テーブルの削除
wojmsdbmgr delete oldtbl : 旧バージョンのテーブルの削除

4.4.4. wojmskeytool

名称
wojmskeytool - 自己署名型証明書の生成
形式
wojmskeytool [-broker]
説明
JMS サーバの自己署名型証明書を生成します。
SSL ベースのコネクション (ssljms、ssladmin) を利用するには、 このコマンドを利用して、自己署名型証明書を生成しておく必要があります。
オプション
-broker
JMS サーバの自己署名型証明書を作成します。
使用例
例1: 自己署名型証明書の作成
> wojmskeytool
Keystore: C:\WebOTX\wojms\etc\keystore
Generating keystore for the broker ...
キーストアのパスワードを入力してください:
新規パスワードを再入力してください:
姓名を入力してください。
  [Unknown]:  NIPPON Taro
組織単位名を入力してください。
  [Unknown]:  BU1
組織名を入力してください。
  [Unknown]:  NEC
都市名または地域名を入力してください。
  [Unknown]:  Minato-ku
都道府県名を入力してください。
  [Unknown]:  Tokyo
この単位に該当する2文字の国コードを入力してください。
  [Unknown]:  JP
CN=NIPPON Taro, OU=BU1, O=NEC, L=Minato-ku, ST=Tokyo, C=JPでよろしいですか。
  [いいえ]:  y

90日間有効な2,048ビットのRSAの鍵ペアと自己署名型証明書(SHA256withRSA)を生成しています
        ディレクトリ名: CN=NIPPON Taro, OU=BU1, O=NEC, L=Minato-ku, ST=Tokyo, C=JP
<wojms>の鍵パスワードを入力してください
        (キーストアのパスワードと同じ場合はRETURNを押してください):
新しい証明書(自己署名型):

    :

[C:\WebOTX\wojms\etc\keystoreを格納中]
wojmskeytool は、まず、キーストアに対するパスワードの入力を要求します。
次に一部の組織情報の入力、続いて確認を要求します。確認が取れると、 キーの組み合わせを生成している間、このコマンドは停止します。
その後、特定のキーの組み合わせをロックするためのパスワード (キーパスワード) の 入力を要求してくるので、Return キーを押します。
これで、キーパスワードに、キーストアと同じパスワードが設定されます。

注意事項
UNIX システムでは、キーストアを作成するアクセス権を取得するためにスーパーユーザ (root) として wojmskeytool を実行する必要があります。

4.4.5. wojmsusermgr

名称
wojmsusermgr - ユーザマネージャユーティリティ
形式
wojmsusermgr <subcommand> [<options>]
wojmsusermgr -h
wojmsusermgr -v
説明
ユーザの認証および承認に使用するファイルベースのユーザリポジトリを設定します。
各サブコマンドの詳細は、それぞれの説明ページを参照してください。
サブコマンド
add
ユーザを追加します。
delete
ユーザを削除します。
list
ユーザの情報を表示します。
update
ユーザのパスワード、状態を更新します。
オプション
-a <active_state>
ユーザのアクティブ状態を指定します。値が true の場合、状態はアクティブとなります。 有効な値は、true、false で、デフォルト値は、true です。

-f
ユーザの確認なしにアクションを実行します。

-g <group>
ユーザのグループを指定します。 有効な値は、admin、user、anonymous です。
デフォルト値は、user です。

表4.4.5-1
グループ名 説明
admin JMS サーバの管理者用。
このグループに割り当てられたユーザは、デフォルトで JMS サーバを 設定および管理できるようになっています。 複数のユーザを admin グループに割り当てることができます。
user 管理ユーザでない、通常のクライアントユーザ用。
デフォルトでは、このグループのユーザは、あらゆるトピックやキューに対する メッセージのプロデュース、あらゆるトピックやキューからのメッセージのコンシューム、 あるいは任意のキューのメッセージの検索を実行できます。
anonymous JMS サーバが認識しているユーザ名を使用しないクライアント用。
クライアントアプリケーションが実際に使用するユーザ名を認識していないなどの 理由がある場合に使います。このグループは、多くの FTP サーバにある 匿名アカウントに似ています。
一度に anonymous グループに割り当てられるのは、1 人のユーザだけです。

-h
使用法のヘルプを表示します。コマンド行ではそれ以外のことは実行されません。

-i <instanceName>
JMS サーバインスタンスを指定します。デフォルト値は、'wojmsbroker' です。

-otxdomain <domainName>
WebOTX のドメイン名を指定します。

-otxdomainroot <domainRoot>
WebOTX のドメインルートディレクトリを指定します。ドメインディレクトリを既定値 (${AS_INSTALL}/domains) から変更している場合には、ドメイン名を含めた絶対パスの指定が必要です。このオプションが指定された場合、-otxdomain オプションの値は無視します。

-p <password>
ユーザのパスワードを指定します。

-s
サイレントモード。出力は表示されません。

-u <userName>
ユーザ名を指定します。
名前に以下の文字を含めることはできません:
* , : <newline> <carriage return>

-au <adminUserName>
admin グループの管理者ユーザ名を指定します。

-ap <adminPassword>
管理者ユーザのパスワードを指定します。


-v
バージョン情報を表示します。コマンド行ではそれ以外のことは実行されません。
関連事項
wojmsusermgr add : ユーザの追加
wojmsusermgr delete : ユーザの削除
wojmsusermgr list : ユーザ情報の表示
wojmsusermgr update : ユーザ情報の更新

4.4.5.1. add

名称
wojmsusermgr add - ユーザの追加
形式
wojmsusermgr add -u <userName> -p <password> [-g <group>] [-s] -au <adminUserName> -ap <adminPassword> [-i <instanceName>] [-otxdomain <domainName>]
説明
ユーザとそのパスワードを指定して、JMS サーバインスタンスリポジトリに追加します。
オプションでユーザグループを指定することができます。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmsusermgrオプションを参照してください。

-g <group>
ユーザのグループを指定します。 有効な値は、admin、user、anonymous です。
デフォルト値は、user です。
グループの詳細に関しては、wojmsusermgr -g オプションの説明を参照してください。

-i <instanceName>
JMS サーバインスタンスを指定します。デフォルト値は、'wojmsbroker' です。

-otxdomain <domainName>
WebOTX のドメイン名を指定します。

-p <password>
ユーザのパスワードを指定します。

-s
サイレントモード。出力は表示されません。

-u <userName>
ユーザ名を指定します。
名前に以下の文字を含めることはできません:
* , : <newline> <carriage return>

-au <adminUserName>
admin グループの管理者ユーザ名を指定します。

-ap <adminPassword>
管理者ユーザのパスワードを指定します。

使用例
例1: domain1 の JMS サーバインスタンスリポジトリに対して、グループ admin に所属するユーザを追加する
> wojmsusermgr add -u bob -p bob -g admin -otxdomain domain1
User repository for broker instance: wojmsbroker
ユーザ bob の追加に成功しました。

関連事項
wojmsusermgr delete : ユーザの削除
wojmsusermgr list : ユーザ情報の表示
wojmsusermgr update : ユーザ情報の更新
注意事項
ユーザをリポジトリに追加した場合、デフォルトのユーザの状態はアクティブです。
ユーザを非アクティブにするには、更新コマンドを使用する必要があります。
更新については、wojmsusermgr update を参照してください。

4.4.5.2. delete

名称
wojmsusermgr delete - ユーザの削除
形式
wojmsusermgr delete -u <userName> [-s] [-f] [-i <instanceName>] -au <adminUserName> -ap <adminPassword> [-otxdomain <domainName>]
説明
指定したユーザを、JMS サーバインスタンスリポジトリから削除します。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmsusermgrオプションを参照してください。

-f
ユーザの確認なしにアクションを実行します。

-i <instanceName>
JMS サーバインスタンスを指定します。デフォルト値は、'wojmsbroker' です。

-otxdomain <domainName>
WebOTX のドメイン名を指定します。

-s
サイレントモード。出力は表示されません。

-u <userName>
ユーザ名を指定します。
名前に以下の文字を含めることはできません:
* , : <newline> <carriage return>

-au <adminUserName>
admin グループの管理者ユーザ名を指定します。

-ap <adminPassword>
管理者ユーザのパスワードを指定します。


使用例
例1: domain1 の JMS サーバインスタンスリポジトリからユーザを削除する
> wojmsusermgr delete -u bob -otxdomain domain1
User repository for broker instance: wojmsbroker
ユーザ bob を削除してもよろしいですか ? (y/n)y
ユーザ bob の削除に成功しました。
関連事項
wojmsusermgr add : ユーザの追加
wojmsusermgr list : ユーザ情報の表示
wojmsusermgr update : ユーザ情報の更新

4.4.5.3. list

名称
wojmsusermgr list - ユーザ情報の表示
形式
wojmsusermgr list [-i <instanceName>] -au <adminUserName> -ap <adminPassword> [-otxdomain <domainName>]

wojmsusermgr list -u <userName> [-i <instanceName>] -au <adminUserName> -ap <adminPassword> [-otxdomain <domainName>]
説明
指定したユーザ、またはすべてのユーザに関する情報を表示します。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmsusermgrオプションを参照してください。

-i <instanceName>
JMS サーバカインスタンスを指定します。デフォルト値は、'wojmsbroker' です。

-otxdomain <domainName>
WebOTX のドメイン名を指定します。

-u <userName>
ユーザ名を指定します。
名前に以下の文字を含めることはできません:
* , : <newline> <carriage return>

-au <adminUserName>
admin グループの管理者ユーザ名を指定します。

-ap <adminPassword>
管理者ユーザのパスワードを指定します。


使用例
例1: domain1 上の guest という名前のユーザに関する情報を表示する
> wojmsusermgr list -u guest -otxdomain domain1
User repository for broker instance: wojmsbroker
-----------------------------
ユーザ名     グループ         アクティブ状態
-----------------------------
guest    anonymous    true
関連事項
wojmsusermgr add : ユーザの追加
wojmsusermgr delete : ユーザの削除
wojmsusermgr update : ユーザ情報の更新

4.4.5.4. update

名称
wojmsusermgr update - ユーザのパスワード、状態更新
形式
wojmsusermgr update -u <userName> -p <new password> [-a <active_state>] [-s] [-f] -au <adminUserName> -ap <adminPassword> [-i <instanceName>] [-otxdomain <domainName>]

wojmsusermgr update -u <userName> -a <active state> [-p <new password>] [-s] [-f] -au <adminUserName> -ap <adminPassword> [-i <instanceName>] [-otxdomain <domainName>]
説明
指定ユーザのパスワードまたは状態、もしくは両方を更新します。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、wojmsusermgrオプションを参照してください。

-a <active_state>
ユーザのアクティブ状態を指定します。値が true の場合、状態はアクティブとなります。 有効な値は、true、false で、デフォルト値は、true です。

-f
ユーザの確認なしにアクションを実行します。

-i <instanceName>
JMS サーバインスタンスを指定します。デフォルト値は、'wojmsbroker' です。

-otxdomain <domainName>
WebOTX のドメイン名を指定します。

-p <password>
ユーザのパスワードを指定します。

-s
サイレントモード。出力は表示されません。

-u <userName>
ユーザ名を指定します。
名前に以下の文字を含めることはできません:
* , : <newline> <carriage return>

-au <adminUserName>
admin グループの管理者ユーザ名を指定します。

-ap <adminPassword>
管理者ユーザのパスワードを指定します。


使用例
例1: domain1 の ユーザ gest を非アクティブにする
> wojmsusermgr update -u guest -a false -otxdomain domain1
User repository for broker instance: wojmsbroker
ユーザ guest を更新してもよろしいですか ? (y/n)y
ユーザ guest の更新に成功しました。


例2: ユーザ gest のパスワードと状態を変更する
> wojmsusermgr update -u guest -p guestguest -a true
User repository for broker instance: wojmsbroker
ユーザ guest を更新してもよろしいですか ? (y/n)y
ユーザ guest の更新に成功しました。
関連事項
wojmsusermgr add : ユーザの追加
wojmsusermgr delete : ユーザの削除
wojmsusermgr list : ユーザ情報の表示
注意事項

4.5. パッケージ生成

4.5.1. makecpk

User Commands makecpk(1)
名称
makecpk - CORBAコンポーネントパッケージ(cpk)および共有コンポーネントパッケージ(spk)の生成
構文
CORBAコンポーネントパッケージ(cpk)生成(プロパティファイル指定)の場合
makecpk cpkfile module=modulefile if=iffile prop=propfile

CORBAコンポーネントパッケージ(cpk)生成(プロパティファイル指定なし)の場合
makecpk cpkfile module=modulefile if=iffile [id=compid] [initfunc=funcname] [useshareif={true|false}]

共有コンポーネントパッケージ(spk)生成の場合
makecpk spkfile module=modulefile [if=iffile] [prop=propfile]

共有コンポーネントパッケージ(spk)生成の場合
makecpk spkfile module=modulefile [if=iffile] [allModuleUse={true|false}]
説明
CORBAコンポーネントモジュールおよび共有コンポーネントモジュールをWebOTXに配備を行なうためにパッケージ化を行ないます。
オペランド
cpkfile
生成するCORBAコンポーネントパッケージ名を指定します。必ず拡張子は".cpk"としてください。

spkfile
生成する共有コンポーネントパッケージ名を指定します。必ず拡張子は".spk"としてください。

オプション
module=modulefile
CORBAコンポーネントおよび共有コンポーネントのモジュールファイル名を指定します。必ず指定してください。

if=iffile
CORBAコンポーネントおよび共有コンポーネントモジュールのインタフェースファイル(ifファイル)名を指定します。拡張子は必ず.ifである必要があります。CORBAコンポーネントパッケージ(cpk)の場合は必ず指定します。共有コンポーネントモジュールの場合は、CORBAインタフェースを持つモジュールの場合指定します。

prop=propfile
CORBAコンポーネントパッケージを生成する際のプロパティファイル名を指定します。 idやinitfuncやuseshareifオプションを指定する場合、またデフォルトで動作させる場合指定する必要がありません。このオプションはCORBAモジュールパッケージ作成時のみ指定可能です。


id=compid
コンポーネントIDを指定します。コンポーネントIDは必ず英数字2桁で指定してください。省略した場合は、WebOTXで任意に設定します。このオプションはCORBAモジュールパッケージ作成時のみ指定可能です。


initfunc=funcname
コンポーネント初期化関数(Javaの場合は初期化クラス)を設定してください。WebOTX Developerに付属しているIDLコンパイラ(woi2j,woigenxx)を用いずCORBAコンポーネントを作成した場合には必ず指定してください。このオプションはCORBAモジュールパッケージ作成時のみ指定可能です。


useshareif={true|false}
共有コンポーネントのインタフェースファイルを利用する場合はtrueを指定します(既定値:false)。trueを指定した場合にはifオプションには共有コンポーネントとして登録したifファイル名を指定します。このオプションはCORBAモジュールパッケージ作成時のみ指定可能です。


allModuleUse={true|false}
現在配備されているすべてのモジュールで使用する場合はtrueを指定します。falseの場合は特に設定は行いません。なお、設定後に配備したものには設定は適用されません。


例1: 既定値でCORBAモジュールパッケージ生成
>  makecpk corbaap.cpk module=corbaap.jar if=corbaap.if

例2: プロパティファイルを設定してCORBAモジュールパッケージ生成
>  makecpk corbaap.cpk module=corbaap.jar if=corbaap.if prop=corbaap.properties

例3: オプションを設定してCORBAモジュールパッケージ生成
>  makecpk corbaap.cpk module=corbaap.jar if=shareap.if id=AA initfunc=corbaap.create useshareif=true

例4: 共有コンポーネントパッケージ生成
>  makecpk shareap.spk module=shareap.jar

4.6. TPシステム

4.6.1. woiorgen

名称
woiorgen - IORの生成
形式
C++:
>woiorgen -r repositoryid -s server:port[:sslport:clcert][,server:port[:sslport:clcert]]* -i implementation [-t otspolicy] [-l lbpolicy] -f filename
Java:
>java -Dorg.omg.CORBA.ORBClass=jp.co.nec.orb.OSPORB -Dorg.omg.CORBA.ORBSingletonClass=jp.co.nec.orb.OSPORBSingleton jp.co.nec.WebOTX.WOIorgen -r repositoryid -s server:port[:sslport:clcert][,server:port[:sslport:clcert]]* -i implementation [-t otspolicy] [-l lbpolicy] -f filename
説明
IORを生成します。
オプション
-r
リポジトリIDを指定します。リポジトリIDの形式は、OMG IDL Formatです。
-s
接続サーバホスト名、平文ポート番号、SSLポート番号、クライアント認証の有無を順に : で区切って指定します。 接続サーバホスト名 server と平文ポート番号 port の指定は必須で、クライアント認証の有無については true または false で指定します。 ただし、port=0 は平文通信を行わず、SSL通信のみの指定とします。 SSL通信用のポート番号 sslport およびクライアント認証 (clcert) の有無は SSL を使用するときだけ値を記述して下さい。 複数のホスト情報を設定するときは , で区切る必要があります。この時、平文ポート使用の有無、SSL ポート使用の有無、クライアント認証使用の有無は統一する必要があります。 また、各ホストのOSとサーバコンポーネントの言語についても統一する必要があります。
-i
実装名を指定します。実装名は"リポジトリID;コンポーネントファイル名;実装識別名"からなります。コンポーネントファイル名、実装識別名は存在しないこともあります。使用できる文字はリポジトリIDで使用可能な文字と”;”のみで最大255文字まで指定可能です。
注)unixでは実装名を指定する場合は""(ダブルクォテーション)でくくるか、または";"の前に"\"をつけてください。
-t
トランザクションとの連携を3つの引数adapts,requires,forbidsにより指定します。
-l
LBコネクション制御ポリシーを指定します。ホスト単位の場合はByHost, オブジェクト単位の場合はByReference, コネクションを再利用しない場合はNoReuseを文字列で指定してください。 指定されていない場合の既定値はByHostです。
-f
IOR出力先ファイル名を指定します。指定がない場合は標準出力にIORを出力します。
表4.6.1-1
返却値 説明
152 リポジトリIDが指定されていません。
153 サーバホスト名が指定されていません。
154 平文ポート番号の指定がありません。
155 SSLポート番号の指定がありません。
156 クライアント認証の有無の指定がありません。
157 実装名が指定されていません。
158 ファイル名が指定されていません。
159 リポジトリIDが長すぎます(256文字以上)。
160 ホスト名が長すぎます(256以上)。
161 平文ポート番号が大きすぎます。
162 SSLポート番号が大きすぎます。
163 実装名が長すぎます(256以上)。
164 リポジトリIDで使用可能な文字ではありません(英数字:/_-.のみ)。
165 サーバホスト名で使用可能な文字ではありません(英数字_-.のみ)。
166 平文ポート番号は数値のみです。
167 SSLポート番号は数値のみです。
168 クライアント認証の有無はtrueまたはfalseを指定してください。
169 実装名で使用可能な文字ではありません(英数字:/_-.;のみ)。
173 SSLポートを指定するかどうか統一されていません。
174 SSLポートのみ使用の場合は全てのホストでport=0を指定してください。
175 クライアント認証をtrueかfalseで統一してください。
176 OTS policyが指定されていません。
177 OTS policyが重複して指定されています。
178 LB policyが指定されていません。
179 LB policyが重複して指定されています。
180 ファイルが見つかりません。
181 フロッピーディスクのディスク容量がいっぱいです。
182-183 ディレクトリのディスク容量がいっぱいです。書き込み権限のないフォルダ内にはファイルを作成できません。読み取り専用のファイルと同名のファイルは作成できません。
200 POAの生成に失敗しました。
201-206 CORBA例外が発生しました。リポジトリIDがOMG IDL Format形式で記述されていることを確認してください。
211 LB policyを設定時にエラーが発生しました。
247-248 その他の例外が発生しました。

使用例
C++の場合:
woiorgen -r "IDL:loopback:1.0" -s "host:5151" -i "IDL:loopback:1.0;loopback.dll" -f "D:\\file"
Javaの場合:
java -Dorg.omg.CORBA.ORBClass=jp.co.nec.orb.OSPORB -Dorg.omg.CORBA.ORBSingletonClass=jp.co.nec.orb.OSPORBSingleton jp.co.nec.WebOTX.WOIorgen -r "IDL:loopback:1.0" -s "host:5151" -i "IDL:loopback:1.0;loopback.jar" -f "D:\\file"
注意事項
Javaで本コマンドを使用するには以下のjarファイルをCLASSPATHに加える必要があります。 コマンドはWindowsでは${AS_INSTALL}\Trnsv\bin、UNIXでは${AS_INSTALL}/Trnsv/commandにあります。

4.6.2. woiorbind

名称
woiorbind - IORを名前サーバへ登録
形式
>woiorbind [-WOdomain WebOTXinstanceroot] -url url -f filename
説明
IORを名前サーバへ登録します。
オプション
-WOdomain
WebOTX instance rootを指定します(省略時はdomain1)。例えばunixでdomain1を使用している場合、/opt/WebOTX/domains/domain1となります。
-url
corbaname形式のURLを指定します。ただし、通常のcorbaname形式は参照用の形式であるため一部形式が異なります。
-f
IOR入力元のファイル名を指定します。このファイルはwoiorgenコマンドで生成できます。
表4.6.2-1
返却値 説明
170 urlが指定されていません。
171 ファイル名が指定されていません。
183 指定されたファイルが存在しません。読みとり権限がないファイルは読みこめません。
184 IORが正しく生成されていません。
207-208 CORBA例外が発生しました。URLの形式、URL中のサーバホスト名、ObjectBrokerの起動状況及び設定を確認してください。
220-226 corbaname関連の例外が発生しました。corbaname形式のURLを指定しているか確認してください。
249 その他の例外が発生しました。
使用例
woiorbind -url corbaname://hostname#foo -f D:\\file
名前サーバのポート番号(例:2809)を指定したい場合は-urlオプションのhostnameをhostname:2809のように指定してください。
hostnameに*は使用できません。
corbaname URL形式について
NamingContext 位置を表すために運用管理ツールで入力する文字列の形式を corbaname URL 形式といいます。 通常の corbaname URL 形式は複数ホストの記述が可能ですが、本コマンドでは1ホストの記述だけが使用できます。 複数のホストに登録する場合は、2回に分けて行います。

登録例)
woiorbind -url corbaname://abc.co.jp#foo/bar/FavoriteName -f D:\\file
woiorbind -url corbaname://xyz.co.jp#foo/bar/FavoriteName -f D:\\file
注意事項
コマンドはWindowsでは${AS_INSTALL}\Trnsv\bin、UNIXでは${AS_INSTALL}/Trnsv/commandにあります。

4.6.3. woiorunbind

名称
woiorunbind - 名前サーバからIORの削除
形式
>woiorunbind [-WOdomain WebOTXinstanceroot] -url url
説明
IORを名前サーバから削除します。
オプション
-WOdomain
WebOTX instance rootを指定します。例えばunixでdomain1を使用している場合、/opt/WebOTX/domains/domain1となります。
-url
corbaname形式のURLを指定します。ただし、通常のcorbaname形式は参照用の形式であるため一部形式が異なります。
表4.6.3-1
返却値 説明
170 urlが指定されていません。
207-208 CORBA例外が発生しました。CORBA例外が発生しました。URLの形式、URL中のサーバホスト名、ObjectBrokerの起動状況及び設定を確認してください。
220-226 corbaname関連の例外が発生しました。corbaname形式のURLを指定しているか確認してください。
249 その他の例外が発生しました。
使用例
woiorunbind -url corbaname://host#foo
corbaname URL形式について
NamingContext位置を表すために運用管理ツールで入力する文字列の形式をcorbaname URL形式とします。 ただし、通常のcorbaname URL形式は複数ホストの記述が可能ですが、本コマンドにおいては記述不可とします。 複数のホストに登録する場合は、2回に分けて行います。

登録例)
woiorunbind -url corbaname://abc.co.jp#foo/bar/FavoriteName
woiorunbind -url corbaname://xyz.co.jp#foo/bar/FavoriteName
注意事項
コマンドはWindowsでは${AS_INSTALL}\Trnsv\bin、UNIXでは${AS_INSTALL}/Trnsv/commandにあります。

4.6.4. woiorinfo

名称
woiorinfo - IORの登録状況の確認
形式
>woiorinfo [-WOdomain WebOTXinstanceroot] -url url
説明
IORの登録状況を表示します。
オプション
-WOdomain
WebOTX instance rootを指定します。例えばunixでdomain1を使用している場合、/opt/WebOTX/domains/domain1となります。
-url
corbaname形式のURLを指定します。ただし、通常のcorbaname形式は参照用の形式であるため一部形式が異なります。
使用例
確認する登録名が分かる場合:
woiorinfo -url corbaname://host#AAA/BBB/CCC
登録名が不明な場合(ホストの全登録名を確認):
woiorinfo -url corbaname://host(:port)
URLの指定で途中の階層まで指定した場合、配下に登録されている全てのオブジェクトリファレンスを確認することが出来ます(AAAまたはAAA/BBBの指定も可)。
名前サーバのポート番号を変更している場合は、portでポート番号を指定してください。
注意事項
コマンドはWindowsでは${AS_INSTALL}\Trnsv\bin、UNIXでは${AS_INSTALL}/Trnsv/commandにあります。

4.6.5. wostack

名称
wostack - JavaAP使用時にスタックトレースの出力
形式
Windows :
>wostack.bat systemname processid
Unix :
>wostack.sh processid
説明
JavaAP使用時にスタックトレースを出力します。スタック出力先は該当プロセスのアプリケーションログ及びシステムトレースです。
スタックトレースは任意のタイミングで採取することが出来ます。 無応答障害が発生した場合等に使用すると効果的です。
スタックトレースの採取は統合運用管理ツールからも実行できます。 プロセスグループを右クリックし「スタックトレースの採取」を実行してください。 この場合、プロセスグループ中で起動しているJavaアプリケーションのプロセス全てに対してスタックトレースが採取されます。
オペランド
systemname
Javaプロセスが動作しているWebOTXシステムの名前を指定します(例:MySystem)。システム名は統合運用管理ツールの[tpsystem]-[システム情報]-[システム名]で確認できます。
processid
JavaプロセスのプロセスIDです。プロセスIDはhistory.act、アプリケーションログ、タスクマネージャ(Windows)またはpsコマンド(unix)等などから間違えの無いように指定してください。
注意事項
コマンドはWindowsでは${AS_INSTALL}\Trnsv\bin、UNIXでは${AS_INSTALL}/Trnsv/commandにあります。UNIX版のWebOTXをご利用の場合は、WebOTX運用ユーザでコマンドを実行して下さい。 Windowsでコマンドからスタック採取を行う場合、WebOTXインストール時に設定したアカウント (WebOTX AS Agent Service サービスのアカウント)と異なるユーザでマシンにログインしていると スタックトレースを採取する事は出来ません。この場合は統合運用管理ツールからスタックトレースの採取を実行してください。

4.6.6. woomdump

名称
woomdump - プロセスグループの活性状態やコンポーネントのアイドル時間の取得
形式
>woomdump [-c component_name | -pg process_group_name ] -d catalog_dir -s tpsystem_name
説明
プロセスグループの活性状態やコンポーネントのアイドル時間の取得を行ないます。
コンポーネントのアイドル時間では、コンポーネントを最後に呼び出してからの経過時間(秒単位)がわかります。コンポーネントの動的削除を行う際に、そのコンポーネントを削除して構わないか(既に使用されていないか)の判断に使用できます。
プロセスグループの活性状態は主に障害時の解析に使用します。正常に起動してリクエストを処理できる状態であれば"ACT"となります。それ以外の場合は起動処理中または停止処理中となります。起動処理中または停止処理中が長期に渡って続く場合は何らかの問題が起きていると考えられるので、別の手段により調査する必要があります。
オプション
component_name
コンポーネントのアイドル時間を表示させる場合に、コンポーネント名を指定します。コマンド結果は次のようになります。

idletime = 250, lasttime = 1131442200

idletimeに続く値が、最終呼び出しからの経過時間(アイドル時間)となります。上記では250秒経過していることを意味します。
process_group_name
プロセスグループの活性状態を表示させる場合に、プロセスグループ名を指定します。コマンド結果は次のようになります。

PID = 22805, status = ACT

上記はプロセスID22805のコンテナ状態が、ACTだという意味になります。プロセスグループが複数プロセスで構成される場合は、複数行表示されます。
catalog_dir
次のディレクトリを指定します。
${INSTANCE_ROOT}/config/tpsystem
tpsystem_name
WebOTXシステム名を指定します。
実行例
woomdump -c sample.jar -d /opt/WebOTX/domains/domain1/config/tpsystem -s MySystem
woomdump -pg sampleAP -d C:\WebOTX\domains\domain1\config\tpsystem -s MySystem
注意事項
コマンドはWindowsでは${AS_INSTALL}\Trnsv\bin、UNIXでは${AS_INSTALL}/Trnsv/commandにあります。UNIX版のWebOTXをご利用の場合は、WebOTX運用ユーザでコマンドを実行して下さい。

4.7. JNDIサービス

4.7.1. JNDI管理ツール

JNDI管理ツールは、JNDIサーバの名前空間のブラウズ、名前削除、同期などの管理を行います。

4.7.1.1. GUI版

GUI版の起動方法
GUIツールの画面構成

display image
図4.7.1.1-1



JNDI管理ツールの画面は、以下の部分に大別されます。

メニューの説明

4.7.1.2. CUI版

CUI版の起動方法

オプションの説明

表4.7.1.2-1
オプション名 説明
-timeout 更新時のロックのタイムアウト時間。
(check、syncオペレーションに対してのみ有効)
-url CosNamingのURL


オペレーションの説明

表4.7.1.2-2
コマンド名 説明
check 各名前サーバに登録されている名前が一致しているか検査する。
list 各名前サーバに登録されている名前とその内容を表示する。
sync 名前空間の更新を一時的に禁止し、他のJNDI名前サーバとの同期を行う。
unbind 引数で指定した名前をJNDI名前サーバからアンバインドする。
alive 引数で指定したJNDI識別名を持つJNDIサーバの生死確認を行う。引数が省略された場合、-urlで指定されたURLでアクセス可能なJNDIサーバ全ての生死確認を行う。
listalljndiservers -urlで指定されたCosNamingサーバにリファレンス登録されたJNDIサーバを列挙する。


4.7.1.3. JNDI管理ツールのクラスパスへのライブラリJarの追加方法

「解決できないオブジェクト」などが表示され、JNDI管理ツールのJava VMのクラスパスへライブラリJarを追加したい場合、jndiadm.bat (WindowsのCUI版はjndiadmcui.bat, Unix/Linuxの場合はjndiadm)をエディタ等で開き、変数 "JNDI_USERCLASSPATH" に記述してください。

4.8. JSPの事前コンパイルコマンド

4.8.1. jspc

JSPファイルをコンパイルするためのコマンドです。
コマンドは Windows および Unix とも ${AS_INSTALL}\bin(/bin) にあります。

以下にjspcコマンドのインタフェースを示します。

形式

>jspc <options> [--] <jsp files>

JSPファイルの場所は次のいずれかの方法で指定します。
-webapp <dir>
Webアプリケーションを含むディレクトリを指定します。すべてのJSPファイルは再帰的に解析されます。
<file[ file...]>
<jsp files> の場所に JSPとして解析されるファイルを指定します。複数ある場合は半角スペースで区切って指定します。

説明

-help
このヘルプメッセージを表示します。

-v
Verboseモードを指定します。

-d <dir>
出力ディレクトリを指定します。

-l
コンパイルが失敗したJSPファイルの名前を出力します。

-s
コンパイルが成功したJSPファイルの名前を出力します。

-p <name>
ターゲットパッケージの名前を指定します(デフォルトは org.apache.jsp)。

-c <name>
ターゲットクラスの名前を指定します(最初のJSPファイルだけに適用されます)。

-mapped
JSPファイルのHTML行ごとにwrite()コールを生成します。

-die[#]
コンパイル時に致命的エラーが発生した場合の jspc のリターンコードを指定します。

-uriroot <dir>
-webappと同じです。

-compile
生成したサーブレットJavaコードをコンパイルします。

-webinc <file>
指定したファイルに部分的なサーブレットマッピングを作成します。

-webxml <file>
指定したファイルに完全な web.xml を作成します。

-classpath <path>
コンパイル時に参照するクラスパスを指定します。

-xpoweredBy
X-Powered-Byレスポンスヘッダを追加します。

-trimSpaces
アクションや指示子の間のテンプレートテキスト中のスペースを削除します。

-javaEncoding <enc>
指定した文字エンコーディングでJavaコードを生成します(デフォルトは UTF-8)。

-source <version>
JSPファイル中で利用するコードのJavaバージョンを指定します(デフォルトは 1.6)。

-target <version>
指定したJavaバージョンのクラスファイルを生成します(デフォルトは 1.6)。

-defaultEncoding <enc>
JSP内で文字エンコーディングが指定されていない場合のデフォルト文字エンコーディングを指定します。

-defaultBufferSize <size>
JSPのレスポンスバッファサイズのデフォルト値を指定します("4kb" のように "kb" を付ける)。


返却値

0 コンパイルが正常に終了しました。
1 コンパイル中に致命的エラーが発生しました(エラー番号は -die オプションで変更可能)。

※エラーの内容はコンソール上に表示されます。さらに詳しい情報を出力したい場合はログレベルを上げることができます。詳しくは「使用例」を参照してください。


使用例

使用例は「ドメイン構築・基本設定ガイド > 13. 付録 > 13.1. JSPの事前コンパイル方法」を参照してください。

4.9. Object Broker

WebOTX Object Broker が提供している以下のコマンドについて説明しています。

4.9.1. ORB運用コマンド

Windows版には、環境設定(Windows共通)を行う以下のコマンドがあります。

また、サーバアプリケーションに対してログ出力モードの切り替えを行う以下のコマンドがあります。

また、サーバプロセス情報のリスト表示を行う以下のコマンドがあります

4.9.1.1. orbcustm(Windows版)

名前
orbcustm - 環境設定(Windows共通)
形式
orbcustm
機能説明
orbcustmは、WebOTX Object Brokerの環境設定を行います。

「設定変更」について
WebOTX Object Brokerの設定を変更するときは、必ずWebOTX Object Brokerのサーバが終了していることを確認してください。WebOTX Object Brokerのサーバが動作している最中に設定を変更した場合の動作は保証しません。
WebOTX Object Brokerのサーバを終了するには「コントロールパネル」の「サービス」を開き、「ObjectSpinner」を選択した後に[停止]ボタンを押します。

注意事項
orbcustmは、ドメイン未使用のWebOTX Object Brokerの環境設定を行う事が出来ます。
ドメイン使用時のWebOTX Object Brokerの環境設定方法は、「リファレンス集 運用管理・設定編 > 1. コンフィグレーション(設定一覧) > 1.10. Object Broker」を参照して下さい。

4.9.1.2. chconf

名前
chconf - ログ出力モードの切り替え(Windows版)
chconf.sh - ログ出力モードの切り替え(UNIX版)
形式
chconf [Oad|InterfaceRepository|NameService|Corbaloc|CacheNameService] [-oblog none|error|warning|info] [-messagelog on|off] [-syslog on|off] -WOdomain WebOTXinstanceroot
※UNIX版では、拡張子(".sh")が付与されたコマンドを必ず使用してください。
機能説明
chconfは引数で指定した情報をもとに、それに対応するサーバアプリケーションに対してログ出力モードの切り替えを行います。

ログ出力モードの切り替えは、すでに起動しているサーバに対してのみ行うことができます。

各オプションの意味は以下のとおりです。
Oad OADサーバのログ出力モードの切り替えを行います。
InterfaceRepository IRサーバのログ出力モードの切り替えを行います。
NameService 名前サーバのログ出力モードの切り替えを行います。
Corbaloc corbalocサーバのログ出力モードの切り替えを行います。
CacheNameService キャッシュ名前サーバのログ出力モードの切り替えを行います。
-oblog ログファイルに出力するレベルを指定します。
none:情報出力を行いません。
error:エラー情報のみ出力します。
warning:エラーとワーニング情報を出力します。
info:すべての情報を出力します。
-messagelog 通信相手、通信量のログ出力を指定します。
on:情報出力を行います。
off:情報出力を行いません。
-syslog システムログ情報のログ出力を指定します。
on:情報出力を行います。
off:情報出力を行いません。
-WOdomain WebOTX instance rootを指定します。例えばunixでdomain1を使用している場合、/opt/WebOTX/domains/domain1となります。

また、以下のプロパティを事前に設定しておく事で、
各オプション-oblog、-messagelog、-syslogと同等の効果が得られます。

※各設定についての説明は、「リファレンス集 運用管理・設定編 > 1. コンフィグレーション(設定一覧) > 1.10. Object Broker」を参照して下さい。

4.9.1.3. listserv.bat(Windows版)

名前
listserv.bat - サーバインプリメンテーションのリスト表示
形式
listserv.bat
機能説明
listserv.batは、OAD(Object Activation Daemon : サーバプロセス情報を管理するもの)に登録されている情報を表示します。表示される情報は、OADに登録されているインプリメンテーション名と、それに対応したサーバプロセスの状態です。状態はリストの右側に表示され、サーバが動作中かそうでないかを表します。動作していないとは、インプリメンテーション名は登録されているが、それと一致するサーバプロセスが応答しないことを意味します。

参照するドメインを変更するには「File」→「Domain」を選択して下さい。
注意事項
listserv.batはウィンドウの内容を更新しません。最新の情報を表示するには一度終了して再起動する必要があります。

4.9.2. 名前サーバ関連のコマンド

Windows版には、名前サーバのブラウズを行う以下のコマンドがあります。

また、名前サーバのNDFファイルを変換するツールがあります。

4.9.2.1. orbmanag.bat(Windows版)

名前
orbmanag.bat - 名前サーバのブラウズ(Windows版)
形式
orbmanag.bat
機能説明
orbmanag.batは名前サーバに登録されている情報をディレクトリツリーのように表示します。このコマンドを使うには、名前サーバの動作するホスト名およびポート番号が適切に設定され、かつ、既に名前サーバが起動されている必要があります。

参照する名前サーバを変更するには「参照先(R)」→「ホスト名指定(H)」または「参照先(R)」→「URL指定(U)」を選択してください。「ホスト名指定(H)」ではホスト名を指定することができます。「URL指定(U)」ではURLを指定することができます。

URLで指定するには、名前サーバの動作しているホストでcorbalocサーバも動作している必要があります。

初期設定に戻すには「参照先(R)」→「デフォルト設定(D)」を選択してください。

また、参照するドメインを変更するには「参照先(R)」→「ドメイン指定(M)」を選択して下さい。

終了するにはメニューの「ファイル(F)」→「アプリケーションの終了(X)」を選択するか、クローズボックスをクリックしてください。「表示(V)」→「ステータスバー(S)」を選択するとステータスバーの表示/非表示を切り替えることができます。最新の情報に更新するにはメニューの「表示(V)」→「最新の情報に更新(R)F5」を選択してください。「ヘルプ(H)」→「バージョン情報(orbmanag)(A)...」を選択するとorbmanag.batのバージョンが表示されます。
関連項目
orbcustm(Windows版)

4.9.2.2. convndf

名前
convndf - 名前サーバのNDF変換ツール(Windows版)
convndf.sh - 名前サーバのNDF変換ツール(Unix版)
形式
convndf [-h hostname] [-p port-number] [-i ndf-file-path] [-o output-path]
※UNIX版では、拡張子(".sh")が付与されたコマンドを必ず使用してください。
機能説明
convndfは名前サーバのNDFファイル内に格納されているIOR情報のホスト名及びポート番号を変換するツールです。

変換元と変換先のファイルパスが同じ場合は、変換元NDFファイルを「namesv.ndf.org」として退避します。

各オプションの意味は以下のとおりです。
-h 変更するホスト名を指定します。
-p 変更するポート番号を指定します。
-i 変換するNDFファイルのパスを指定します。指定されていない場合は、環境変数OrbRootに指定されているパスのNDFファイルを変換対象とみなします。
-o 変換したNDFファイルの出力先パスを指定します。指定されていない場合は、変換対象NDFファイルの格納先を出力先とみなします。
実行例
例1)# convndf -h host01 環境変数OrbRootに指定されているパスに存在するNDFファイルのホスト名を変換します。変換元のNDFファイルは、namesv.ndf.orgとして退避されます。
例2)# convndf -p 9999 -i "C:\WebOTX\ObjectBroker\conf"

オプション「−i」に指定されているパスのNDFファイルのポート番号を変換します。変換元のNDFファイルは、namesv.ndf.orgとして退避されます。


例3)# convndf -h host02 -p 8888 -i "C:\WebOTX\ObjectBroker\conf" -o "C:\temp"

オプション「−i」に指定されているパスのNDFファイルのホスト名とポート番号を変換します。変換したNDFファイルはオプション「−o」に指定されたパスに格納されます。

4.9.3. if関連のコマンド

インタフェースリポジトリを操作する以下のコマンドがあります。

4.9.3.1. instif

名前
instif - インタフェース定義の登録(Windows版)
instif.sh - インタフェース定義の登録(UNIX版)
形式
instif FILENAME -WOdomain WebOTXinstanceroot
※UNIX版では、拡張子(".sh")が付与されたコマンドを必ず使用してください。


機能説明

instifは、IDLコンパイラが出力したインタフェース定義情報(*.ifファイル)をリポジトリに登録します。
各オプションの意味は以下のとおりです。
FILENAME IDLコンパイラが出力したインタフェース定義情報(*.ifファイル)を指定します。
-WOdomain WebOTX instance rootを指定します。例えばunixでdomain1を使用している場合、/opt/WebOTX/domains/domain1となります。
関連項目
rmif, listif, IDLコンパイラ

4.9.3.2. rmif

名前
rmif - インタフェース定義の削除(Windows版)
rmif.sh - インタフェース定義の削除(UNIX版)


形式

rmif FILENAME -WOdomain WebOTXinstanceroot
※UNIX版では、拡張子(".sh")が付与されたコマンドを必ず使用してください。


機能説明

rmifは、IDLコンパイラが出力したインタフェース定義情報(*.ifファイル)をリポジトリから削除します。
各オプションの意味は以下のとおりです。
FILENAME IDLコンパイラが出力したインタフェース定義情報(*.ifファイル)を指定します。
-WOdomain WebOTX instance rootを指定します。例えばunixでdomain1を使用している場合、/opt/WebOTX/domains/domain1となります。


関連項目

instif, listif, IDLコンパイラ

4.9.3.3. listif

名前
listif - インタフェース定義の表示(Windows版)
listif.sh - インタフェース定義の表示(UNIX版)
形式
listif -WOdomain WebOTXinstanceroot
※UNIX版では、拡張子(".sh")が付与されたコマンドを必ず使用してください。
機能説明
listifは、リポジトリに登録されているインタフェース定義情報を表示します。
各オプションの意味は以下のとおりです。
-WOdomain WebOTX instance rootを指定します。例えばunixでdomain1を使用している場合、/opt/WebOTX/domains/domain1となります。
関連項目
instif, rmif, IDLコンパイラ

4.9.4. oadj関連のコマンド

oadj/oadを操作する以下のコマンドがあります。

4.9.4.1. instimpl

名前
instimpl - インプリメンテーションの登録
形式
instimpl name command-line activation-policy [-host host-name] [ORB-properties]
機能説明
instimplはサーバのインプリメンテーション情報を登録します。 nameにはインプリメンテーション名を指定します。 command-lineにはサーバを起動するときのコマンドラインの文字列を指定します。 activation-policyにはサーバの活性化方針を指定します。 活性化方針にはつぎのものがあります。 -host オプションは、リモートホストにインプリメンテーションを登録するときに指定します。host-nameにはホスト名を指定します。
ORB-propertiesには、必要であればORBプロパティを指定します。

注意: 上記活性化方針の説明でPersistentServerとあるのは、ORBが自動起動を行わないサーバのことを指しています。POAのPersistentObjectポリシーとは独立した概念ですので、混同しないように注意してください。
関連項目
listimpl, rmimpl

4.9.4.2. rmimpl

名前
rmimpl - インプリメンテーションの削除
形式
rmimpl name [-host host-name] [ORB-properties]
機能説明
rmimplはサーバのインプリメンテーション情報を削除します。 nameにはインプリメンテーション名を指定します。
-host オプションは、リモートホストにインプリメンテーションを登録するときに指定します。host-nameにはホスト名を指定します。
ORB-propertiesには、必要であればORBプロパティを指定します。
関連項目
listimpl, instimpl

4.9.4.3. listimpl

名前
listimpl - インプリメンテーションの一覧
形式
listimpl [-l] [-host host-name][ORB-properties]
機能説明
listimplはサーバのインプリメンテーション一覧を表示します。-l オプションを指定すると詳細情報を表示します。
-host オプションは、リモートホストに登録されているインプリメンテーション情報を一覧するときに指定します。host-nameにはホスト名を指定します。
ORB-propertiesには、必要であればORBプロパティを指定します。
関連項目
instimpl, rmimpl

4.9.4.4. listserv(Windows版)

名前
listserv - サーバインプリメンテーションのリスト表示
形式
listserv
機能説明
listservは、OAD(Object Activation Daemon : サーバプロセス情報を管理するもの)に登録されている情報を表示します。表示される情報は、OADに登録されているインプリメンテーション名と、それに対応したサーバプロセスの状態です。状態はリストの右側に表示され、サーバが動作中かそうでないかを表します。動作していないとは、インプリメンテーション名は登録されているが、それと一致するサーバプロセスが応答しないことを意味します。
注意
listservはウィンドウの内容を更新しません。最新の情報を表示するには一度終了して再起動する必要があります。

4.9.5. IDLコンパイラ

IDLコンパイラとしては以下のコマンドがあります。

4.9.5.1. IDLコンパイラ(i2j)

名前
i2j - IDL定義ファイルからJavaソースコードを自動生成(Windows版)
i2j.sh - IDL定義ファイルからJavaソースコードを自動生成(UNIX版)
形式
i2j [-i] [-Idir] [-Dname[=val]] [-Uname] [-Rreffile] [-V] [-nocpp] [-tie] [-lstub] [-rppackage_name] [-noskel] [-ddir] [-notstream] [-oldname] [-nofactory] [-vsskel] [-vsinit] [-lcopy] [-noanycopy] [-Xmnum] FILENAME
※UNIX版では、拡張子(".sh")が付与されたコマンドを必ず使用してください。
機能説明
i2jはFILENAMEで指定されたIDL定義ファイルをもとに、ORBを利用したアプリケーションを作成するために必要なJavaマッピングのJavaソースコードを自動生成します。

生成されるファイル中のクラスの詳細は [ アプリケーション開発ガイド(CORBA) > 1. CORBA アプリケーション > 1.2. プログラミング・開発ガイド > 1.2.2. Object Broker > 1.2.2.11. Javaマッピング ] を参照してください。

各オプションの意味は以下のとおりです。
-i インタフェースリポジトリにインタフェース定義を登録するためのファイル(<FILENAME >.if)を生成します。
-Idir プリプロセッサがインクルードするファイルのディレクトリをdirで指定します。複数指定することも可能です。
-Dname[=val] #define同様にマクロを定義します。valが指定されていないときは値として1が指定されます。
-Uname #undef同様にプリプロセッサで既定義のマクロを無効にします。複数指定することも可能です。
-Rreffile reffileの定義を参照することができます。ただし、reffileのJavaソースコードは生成されません。
-V バージョンを表示します。
-nocpp プリプロセッサによる処理を省略します。
-tie tieクラスを出力します。
-lstub ローカルスタブコードを出力します。実装オブジェクトとそれを呼び出すクライアントが同一プロセス内で動作する時には、このオプションを指定しておくとネットワークを使用しないようになり、高速な呼び出しが可能となります。
-rppackage_name このオプション以降の-Rオプションで指定されるIDL定義が、package_nameで指定されたパッケージに置かれているものとしてコードを生成します。-rpオプションは複数指定することができます。-rpオプションにpackage_nameの指定がない場合にはデフォルトの設定に戻ります。
ex.) i2j -rpfoo.bar -RA.idl -RAA.idl -rp -RB.idl C.idl
上記の例では、A.idlとAA.idlがfoo.barというパッケージにおかれているものとし、B.idlはデフォルトのグローバルなパッケージにあるものとして、C.idlに対するJavaソースコードを生成します。
-noskel サーバのスケルトンコードを生成しません。このオプションは、クライアントプログラムの開発者がサーバ作成用のソースコードを必要としないときに使用します。(サーバプログラムはi2jの生成した全てのソースを使用するため、-nostubというようなオプションはありません)
-ddir javaソースコードの出力先を、dirで指定したディレクトリ配下に変更します。javaソースコード出力先のデフォルトは、i2jを起動したディレクトリです。
-notstream 従来のDII/DSIを使用したスタブ/スケルトンを生成するときに使用します。このオプションが指定されない場合はStreamベースのスタブ/スケルトンを出力します。パラメータレベルのフックを使用する場合は、本オプションを指定してください。
-oldname スケルトンおよびtieクラスの名前を旧形式の名前(POA_<interface名>, POA_<interface名>_tie)で出力します。このオプションが指定されない場合は、CORBA2.3形式の名前(<interface名>POA, <interface名>POATie)で出力します。
-nofactory valuetypeに対するバリューファクトリの実装クラスの雛形ファイルを生成しません。このオプションが指定されない場合、雛形ファイルは<valuetype名>DefaultFactoryという名前で生成されます。ただし、既にこの名前のファイルが存在する場合は上書きしません。
-vsskel スケルトンのinvokeメソッドに展開されている処理を内部メソッドに分割して出力します。1つのインタフェース内に多数のパラメータを持つメソッドを多量に定義すると、スケルトンのinvokeメソッドのコードが膨大になるためJava実行時に例外が発生する場合があります。このような場合、本オプションでinvokeメソッドのコード量を小さくすることにより、Java例外を避けることができます。
-vsinit パラメータ数が255以上となるstruct/exception定義のコンストラクタの出力を抑制します。1つのstruct/exception内に多数のメンバを定義すると、対応するコンストラクタのパラメータ数がJavaの制限を超え、Java実行時に例外が発生する場合があります。このような場合、本オプションでコンストラクタの出力を抑制することにより、Java例外を避けることができます。ただしこの場合は、メンバの初期化は利用者が直接行う必要があります。 本オプション指定時のコンストラクタ出力例は、-vsinit指定時のコンストラクタ出力例を参照してください。
-lcopy オペレーションのパラメータに対するローカルコピー処理を、スタブに生成します。ローカルコピーの対象となるのはinおよびinout属性のパラメータで、かつその型がvaluetype型、any型、およびそれらの型を含む型(struct、union、sequence、array、typedef)の場合です。
-noanycopy 本オプションは-lcopyオプションと合わせて使用するもので、any型およびany型を含む型のパラメータをローカルコピーの対象外にします。ただし、any型とvaluetype型の両方を含むような型については、本オプションを指定してもローカルコピー処理が展開されます。
-addpkgpackagename Java ソースファイルを packagename に指定したパッケージに生成します。このオプションを指定しても、リポジトリIDには影響はありません。
-not_strict_param オペレーションの引数の型名と大文字小文字のみが異なる名前を引数名として利用する場合に指定します。
-Xmnum プリプロセッサにおけるユーザ定義マクロ識別子数の最大値をnumで指定します。このオプションが指定されない場合の既定値は8191です。
その他
-vsinit指定時のコンストラクタ出力例

1. structの例

struct定義に対しては、通常以下の2種類のコンストラクタが展開されます。

-vsinitオプションを指定すると、structのメンバが255個以上(注)定義された場合に後者のコンストラクタを展開しません。従って利用者がstructを初期化する場合は、引数なしのコンストラクタでstructのインスタンスを生成して、各メンバに直接値を設定するなどの必要があります。

(注)IDL double型およびlong long型のメンバは、それぞれ2個分にカウントされます。

// IDL 
struct StructType { 
    long field1; 
    long field2;
    :
    long field255;
}; 

// Generated Java 
final public class StructType implements org.omg.CORBA.portable.IDLEntity { 

    // instance variables 
    public int field1; 
    public int field2; 
    :
    public int field255; 

    // constructors 
    /* following constructor is deleted by -vsinit option. */ 
    /* public StructType(p1, ... , pN) {} */ 

    public StructType() {} 

}
2. exceptionの例

exception定義に対しては、通常以下の3種類のコンストラクタが展開されます。

-vsinitオプションを指定すると、以下のようにコンストラクタの抑制を行います。従って、利用者がexceptionを初期化する場合は、引数なしのコンストラクタでexceptionのインスタンスを生成して、各メンバに直接値を設定するなどの必要があります。

(注)IDL double型およびlong long型のメンバは、それぞれ2個分にカウントされます。

// IDL
exception ExceptionType {
    short field001;
    short field002;
    :
    short field255;
};

// Generated Java
final public class ExceptionType extends org.omg.CORBA.UserException { 

    /* instance variables*/ 
    public short field001; 
    public short field002; 
    : 
    public short field255; 

    /* constructors*/ 
    /* following constructor is deleted by -vsinit option. */ 
    /* public ExceptionType(p1, ... , pN) {} */ 

    /* instead of following original constructor, output that */ 
    /* has only "reason" parameter by -vsinit option. */ 
    /* public ExceptionType(reason, p1, ... , pN) {} */ 

    public ExceptionType(String reason) { 
        super(ExceptionTypeHelper.id()+" "+reason); 
    } 

    public ExceptionType() { 
        super(ExceptionTypeHelper.id()); 
    } 

}

4.9.5.2. IDLコンパイラ(i2cc)

名前
i2cc - IDL定義ファイルからC++ソースコードを自動生成
形式
i2cc [-i] [-Idir] [-Dname[=val]] [-Uname] [-Rreffile] [-PC] [-V] [-E] [-EC] [-EI] [-Xdii] [-Xdsi] [-TIE] [-lstub] [-no_env_skel] [-not_strict_param] [-init_member] [-separate_header] [-no_env_operation] [-no_env_cmn_func] [-use_out] [FILENAME]
機能説明
i2ccはFILENAMEで指定されたIDL定義ファイルをもとに、ORBを利用したアプリケーションを作成するために必要なC++マッピングのスタブ/スケルトンを自動生成します。

i2ccはC++コンパイラのプリプロセッサを使います。したがって、あらかじめC++コンパイラをインストールし、パスを設定しておく必要があります。

パスの設定方法はOSにより異なります。具体的な方法については各OSのマニュアルを参照してください。

各オプションの意味は以下のとおりです。
-i インタフェースリポジトリにインタフェース定義を登録するためのファイル(.if)を生成します。
-I プリプロセッサがインクルードするファイルのディレクトリをdirで指定します。複数指定することも可能です。
-D #define同様にマクロを定義します。valが指定されていないときは値として1が指定されます。
-U #undef同様にプリプロセッサで既定義のマクロを無効にします。複数指定することも可能です。
-R reffileに定義された定義を参照することができます。このオプションを指定することによって、reffileで定義されている型を利用したり、インタフェースを継承したりすることができます。
-PC プリコンパイル済みヘッダを利用するときに指定します。
-V i2ccのバージョンを表示します。
-E cmnファイルとimpファイルをVisual C++で作成するDLLに組み込むときに使用します。
-EC cmnファイルのみをVisual C++で作成するDLLに組み込むときに使用します。
-EI impファイルのみをVisual C++で作成するDLLに組み込むときに使用します。
-Xdii DIIを使用したスタブを生成するときに使用します。DIIを使用すると一般に性能は劣化しますので、このオプションは通常使う必要はありません。クライアントでフックを使用する場合は指定してください。
-Xdsi DSIを使用したスケルトンを生成するときに使用します。DSIを使用すると一般に性能は劣化しますので、このオプションは通常使う必要はありません。
-TIE TIEアプローチを使ったサーバを実現するときに使用します。TIEアプローチとは、スケルトンクラスを継承しないでサーバを実装する方法のひとつです。
-lstub ローカルスタブコードを出力します。実装オブジェクトとそれを呼び出すクライアントが同一プロセス内で動作する時には、このオプションを指定しておくとネットワークを使用しないようになり、高速な呼び出しが可能となります。
-no_env_skel CORBA::Environment引数を付加しないシグネチャのスケルトンを利用する場合に指定します。
-not_strict_param オペレーションの引数の型名と大文字小文字のみが異なる名前を引数名として利用する場合に指定します。
-init_member struct、union、およびexceptionのstring型のメンバ、またはstring型のsequenceの各要素を空文字列("")で初期化する場合に指定します。
-separate_header impファイル用のヘッダファイルを別ファイル(*_sk.h)に分離する場合に指定します。
-no_env_operation CORBA::Environment引数を付加しないシグネチャを持つオペレーションのスタブを利用する場合に指定します。
-no_env_cmn_func 各interface型について生成される共通関数(CORBA::release()、CORBA::is_nil()、_duplicate()、_nil())をCORBA::Environment引数を付加しないシグネチャにする場合に指定します。
-use_out オペレーションのout引数にout型を利用する場合に指定します。

なお、i2ccは文字列定数として2048文字までの大きさしか扱えません。

例)

  // IDL

  const string str = "abcdefg..."; // 2048文字まで

また、IDL定義に次元数が大変多い多次元配列を定義するときは注意が必要です。たとえば、100次元の多次元配列を定義したとき、IDLコンパイラは正常にソースコードを出力しますが、その出力コードをC++コンパイラがコンパイルできるかどうかはC++コンパイラに依存します。

4.9.6. 情報採取、解析コマンド

Object Brokerで障害を検出した場合、ツールを使用し情報の採取、解析を行うことができます。

WindowsコマンドとUNIXコマンドの拡張子がそれぞれ異なります。Windowsの場合は「cmd」UNIXの場合は「sh」です。

環境設定を行うコマンド
情報採取を行うコマンド
解析を行うコマンド

各コマンドの詳細については、 [ トラブルシューティングガイド > 1. 障害時の操作 > 1.1. 情報採取 > 1.1.2. 手動で情報採取する場合は > 1.1.2.10. Object Broker ] を参照してください。

その他のコマンド

指定された名前サーバのNDFファイルを解析し、結果をファイルへ出力するコマンドがあります。

Object Broker C++関連のログに出力された、エラーコード(マイナー)を解析し、結果をファイルへ出力するコマンドがあります。

4.9.6.1. ospi_ndfcheck

名前
ospi_ndfcheck - NDFファイル解析ツール
形式
ospi_ndfcheck [-file filename] [-path dir]
機能説明
ospi_ndfcheckはfilenameで指定されたNDFファイルを解析し結果をファイルに出力します。

出力されるファイル名は、指定されたNDFファイル名に「_check_info.txt」を付加したファイル名です。
例) namesv.ndf_check_info.txt
出力される情報は、[Fileversion],[Hostname],[Portnumber],[ContextInfo],[BindingIteraterInfo],[ObjectInfo]です。

[BindingIteraterInfo]が含まれる場合は、警告として「Warning:BindingIterator information is left. There is a possibility that enlargement causes.」が出力されます。

指定されたログファイルが壊れている場合は、コンソールに「Datafile is broken」が出力されます。

また、予期せぬエラーが発生した場合は、コンソールに「An Unexpected Error (has occured)」が出力されます。

各オプションの意味は以下のとおりです。
-file 解析するNDFファイル名を指定します。
-path 解析するNDFファイルのディレクトリ指定。省略時、実行カレントに配置されているNDFファイルを解析します。
-dump IORのダンプを出力します。
-v ospi_ndfcheckのバージョンを表示します。
-h ospi_ndfcheckのヘルプを表示します。

4.9.6.2. ospi_loganalyze

名前
ospi_loganalyze - ログ解析ツール
形式
ospi_loganalyze [-file filename] [-path dir]
機能説明
ospi_loganalyzeはfilenameで指定されたログのエラーコード(マイナー)を解析し結果をファイルに出力します。

出力されるファイル名は、指定されたログファイル名に「_convminercode_info.txt」を付加したファイル名です。

例) oad.log_convminercode_info.txt

出力されるフォーマットは、以下です。

行数 -> 日付 -> (マイナーコード) -> 例外情報の詳細

※ 「->」はデリミタ。

予期せぬエラーが発生した場合は、コンソールに「An Unexpected Error (has occured)」が出力されます。

各オプションの意味は以下のとおりです。
-file 解析するログファイル名を指定します。
-path 解析するログファイルのディレクトリ指定。省略時、実行カレントに配置されているログファイルを解析します。
-v ospi_loganalyzeのバージョンを表示します。
-h ospi_loganalyzeのヘルプを表示します。

4.10. ライセンス管理コマンド

ライセンス管理コマンドは、ライセンスの追加、削除、確認を行う際に利用します。
また、WebOTX製品をインストールした仮想化環境を複製する場合に、 ライセンス入れ替えを行うツールとして利用します。

なお、WindowsにWebOTXをインストールする場合は、インストール画面からライセンスキーを 入力することでライセンス登録を行いますが、Linux、HP-UX、SolarisにWebOTXをインストールする場合は 本コマンドでライセンスの登録が必要となります。

ライセンス管理コマンドは以下のディレクトリにインストールされます。

ライセンス管理ではWebOTX 製品を識別するために、ライセンスキーとは別の「製品コード」という3ケタの数字からなる識別子を利用します。
インストールされているWebOTX 製品の製品コードの確認は OTXLChkコマンドを利用してください。

4.10.1. OTXLAdd

名称
OTXLAdd
 
形式
OTXLAdd [ライセンスキー]
 
説明
指定したWebOTX製品のライセンスを登録します。
オペランドを指定しない場合は入力を促します。
 
オペランド
ライセンスキー
登録するWebOTX製品のライセンスキー

使用例
ライセンスキーを指定した場合
> OTXLAdd 123456
Command succeeded.

ライセンスキーを指定しない場合
> OTXLAdd
Please Input License Code.
123456
Command succeeded.

不正なライセンスキーを指定した場合
> OTXLAdd aaaaa
Input Code is not WebOTX Licence Code.
終了ステータス
正常終了時:
登録した製品の製品コード
 
異常終了時:
0

関連事項
OTXLDel
ライセンスの削除
OTXLChk
ライセンスの確認

注意事項
OTXLAddコマンド実行時に入力したライセンスキーを確認することはできません。

4.10.2. OTXLDel

名称
OTXLDel
 
形式
OTXLDel <製品コード|ALL>
 
説明
指定したWebOTX製品のライセンスを削除します。
 
オペランド
製品コード
削除するライセンスの製品コードを指定します。 製品コードはOTXLChkコマンドで確認してください。
ALL
全てのWebOTX製品のライセンスを削除する場合に指定します。
使用例
登録されている製品コードを指定した場合
> OTXLDel 1
Command succeeded.
登録されていない製品コードを指定した場合
> OTXLDel 11
Command failure.
不正な値を指定した場合
> OTXLDel a
Parameter Error.
終了ステータス
正常終了時:
1
異常終了時:
0

関連事項
OTXLAdd
ライセンスの登録
OTXLChk
ライセンスの確認

注意事項
特になし。

4.10.3. OTXLChk

名称
OTXLChk
 
形式
OTXLChk
 
説明
ライセンスが登録されているWebOTX 製品の一覧を以下の形式で表示します。
製品コード : 製品名 または 製品コード : 製品名 (ライセンス数)
オペランド
なし
 
使用例
> OTXLChk
002:WebOTX Application Server Express 9.2 (* 1License)
終了ステータス
正常終了時:
1
異常終了時:
0

関連事項
OTXLAdd
ライセンスの登録
OTXLDel
ライセンスの削除

注意事項
OTXLAddコマンドの実行時に入力したライセンスキーは確認できません。

4.10.4. OTXCuChk

名称
OTXCuChk
 
形式
OTXCuChk <製品コード>
 
説明
指定したWebOTX製品のCPUライセンスまたは、CUライセンスの登録状況を確認します。
 
オペランド
製品コード
確認するライセンスの製品コードを指定します。 製品コードはOTXLChkコマンドで確認してください。

使用例
登録されている製品コードを指定した場合
> OTXCuChk 67
License OK.
登録されていない製品コードを指定した場合
> OTXCuChk 1
No License.
不正な値を指定した場合
> OTXCuChk a
Parameter Error.
終了ステータス
ライセンスが登録されている場合
1
ライセンスが登録されていない、もしくは不足している場合
0

関連事項
OTXLAdd
ライセンスの登録
OTXLDel
ライセンスの削除
OTXLChk
ライセンスの確認

注意事項
特になし。

4.11. インメモリデータグリッド連携部品コマンド

4.11.1. JPAランキング情報生成コマンド

4.11.1.1. create-jpa-ranking

名称
create-jpa-ranking - JPAの性能情報のランキング情報を、採取した性能情報プロファイルデータから生成します。
UNIX版のコマンド名は、create-jpa-ranking.sh です。
Windows版のコマンド名は、create-jpa-ranking.bat です。
構文
create-jpa-ranking -type type -domain domainname [-d outputdirectory] [-startdate collection_start_date] [-enddate collection_end_date] [-order order] [-target target]
説明
JPAのランキング情報を生成します。
インメモリデータグリッド連携部品の性能情報採取機能により出力した、JPAの性能情報データをもとに データの集計と並べ替えを行いファイルへ出力します。
オプション
-type
生成するランキング情報を指定します。指定可能な値は以下の3つです。
ENTITY エンティティのランキングを生成します。
API API情報のランキングを生成します.
EXCEPTION 例外情報のランキングを生成します。





-domain
生成するランキング情報の対象となるドメイン名を指定します。

-d
ランキングの出力フォルダを指定します。
(既定値: [性能情報出力フォルダ]/Profile/Ranking)


-startdate
ランキング情報の集計期間の開始日時を指定します。
YYYYMMDDまたはYYYYMMDDHHmmssで指定します。
YYYYMMDDで指定した場合は、YYYYMMDD000000が指定された場合と同じとなります。

-enddate
ランキング情報の集計期間の終了日時を指定します。
YYYYMMDDまたはYYYYMMDDHHmmssで指定します。
YYYYMMDDで指定した場合は、YYYYMMDD000000が指定された場合と同じとなります。

-order
ランキング情報の出力順序を指定。
指定可能な項目は type で指定した値により以下の項目となります。
TYPE 出力順序 説明
ENTITY ENTITY_TIME エンティティ寿命の昇順
ENTITY_REF_COUNT エンティティ参照回数の昇順[既定値]
API API_TIME API処理時間の昇順[既定値]
API_COUNT API呼び出し回数の昇順
EXCEPTION EXCEPTION_COUNT 例外発生回数の昇順 [既定値]









-target
ランキング情報の生成対象を指定します。
THREAD 「type」がAPIの場合のみ指定できます。
スレッド内のランキングを生成します。 集計データは、スレッドID毎に生成されます。
APSERVER アプリケーションサーバ内のランキングを生成します。
ALL 分散環境にあるすべてのマシンのランキングを生成します。






使用例
create-jpa-ranking.sh -domain domain1 -type ENTITY -target APSERVER

出力先
既定値では、${ AS_INSTALL }/config/jpa/Profile/Ranking/配下に出力されます。
出力先は、コマンドオプションで変更できます。
JPAランキング情報生成コマンドを複数回、実行した場合、ENTITY_ranking.datファイルは、最後にコマンドを実行したランキング情報となりますのでご注意ください。
既存のファイルは、ファイル名を時刻を付与した形式、[対象]_ranking_[YYYYMMDDHHmmSS]でリネームし、${ AS_INSTALL }/config/jpa/Profile/Ranking/backupディレクトリ配下に移動されます。
複数のドメインで利用する環境の場合、出力先を変更することを推奨します。
出力ファイル
JPAのランキング情報は、CSV形式で出力されます。
エンティティのランキング情報は、データプリロードの読み込む順番として利用することができます。
出力されるtype別のファイルを以下に示します。
typeファイル名説明
ENTITYENTITY_ranking.datエンティティランキングデータ
APIAPI_ranking.datAPIランキングデータ
EXCEPTIONEXCEPTION_ranking.dat例外ランキングデータ

各ランキングデータの出力項目
それぞれのランキングデータの出力項目は以下の通りです。
エンティティランキングデータ 出力項目
名前説明
NO順位。1〜ランキング作成コマンドのオプションで指定した範囲 ランキング作成コマンドのオプションで指定した優先順位(エンティティ寿命、参照回数)で並べ替えた順序
エンティティ名エンティティ名
エンティティIDエンティティID
エンティティ寿命このエンティティがキャッシュに登録されてから削除されるまでの時間(ミリ秒)  複数回キャッシュへの登録と削除が繰り返される場合はその合計時間
参照回数このエンティティを参照した回数の累計
更新回数このエンティティを更新した回数の累計
キャッシュのヒット数このエンティティをキャッシュから取得した回数の累計
キャッシュの未ヒット数このエンティティをキャッシュから取得できなかった回数の累計

APIランキングデータ 出力項目
名前説明
NO順位。1〜ランキング作成コマンドのオプションで指定した範囲 ランキング作成コマンドのオプションで指定した優先順位(エンティティ寿命、参照回数)で並べ替えた順序
API名API名(:エンティティ名:追加情報)
API処理時間APIの処理時間の合計(ナノ秒)
API呼び出し回数APIの呼び出し回数の累計

例外ランキングデータ 出力項目
名前説明
NO順位。1〜ランキング作成コマンドのオプションで指定した範囲 ランキング作成コマンドのオプションで指定した優先順位(エンティティ寿命、参照回数)で並べ替えた順序
API名API名(:エンティティ名:追加情報)
例外クラス名例外クラス名。例外クラス名(:例外メッセージ)
例外発生回数例外が発生した回数の累計


コマンド作業用フォルダ
JPAランキング情報生成コマンドでは、以下のディレクトリを作業用ディレクトリとして使用します。
コマンド実行中にファイルにアクセスしないでください。

終了ステータス
0 : コマンド実行成功
1 : コマンド実行失敗



関連事項
start-jpa-performanceinfomation(1) stop-jpa-performanceinfomation(1) reset-jpa-performanceinfomation(1)

注意事項
JPAランキング情報生成コマンドは、複数同時に実行することはできません。
コマンド実行中に、コマンド作業用フォルダ配下のファイルにアクセスしないで下さい。


4.12. 付録

4.12.1. 運用管理コマンド例外メッセージ

運用管理コマンド例外メッセージ一覧

運用管理コマンドの実行時に出力される場合がある例外メッセージを記載します。

サーバ接続失敗
例外メッセージ
指定された管理サーバに接続できません。ホスト:[xxxx] ポート:[xxxx]
サーバが起動していること、指定したホストとポートが正しいことを確認してください。
説明
サーバとの接続に失敗しました。
対処
コマンドのパラメータに指定したポート番号(--port)やホスト名(--host)を確認してください。
またサーバが起動しているかを list-domainsコマンドで確認してください。
ユーザ名/パスワード不正
例外メッセージ
com.nec.webotx.enterprise.security.auth.login.common.LoginException:
Login failed: javax.security.auth.login.LoginException: Failed file login for xxxx.
説明
ユーザ名(--user)またはパスワード(--password)が異なります。
対処
正しいユーザ名およびパスワードを指定してください。
なお、ユーザ名はlist-file-usersコマンドで確認できます。
URL不正
例外メッセージ
com.nec.webotx.as.api.admin.CommandException: java.net.MalformedURLException: xxxx
説明
コマンド接続用のURL情報(--URL または --protocol)が不正です。
対処
正しいURL情報を指定してください。