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

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

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

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

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

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

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

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

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


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

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

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

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

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

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


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

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

helpコマンド

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

otxadmin > help コマンド名

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

otxadmin > help get

helpコマンドの詳細については「運用管理コマンド」−「ヘルプ」を参照してください。

項目の参照

項目を参照するには、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行につき１つの定義を追記してください。
設定ファイルは各ドメインの${INSTANCE_ROOT}/config配下にあり、設定の変更にはドメインの再起動が必要となります。
また、設定ファイルによる制限の解除は設定ファイルを${INSTANCE_ROOT}/config配下から削除することで可能となります。
ただし、その際にはsetコマンドに対する全ての制限が解除されますので、運用操作には十分な注意が必要です。

関連情報

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