2.26.1　create-event-hook

書式

asadmin [asadmin-options] create-event-hook --messageid=messageid
    --script=script-file-path
    [--monitoring-time-span=monitoring-time-span
    --monitoring-max-count=monitoring-max-count] event-hook-name

格納先

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

機能

create-event-hookサブコマンドは、ドメイン管理サーバでイベントが発生したときに、自動で実行される「イベント検知時コマンド」を登録します。イベント検知時コマンドには、ユーザーが作成した任意のスクリプトファイルを指定します。

イベント検知時には、指定したスクリプトファイルの配置場所で、登録したコマンドを実行します。

イベント検知時コマンドには任意の名称を指定できますが、次の引数の指定が同じ値のイベント検知時コマンドがすでに登録されている場合は、未登録の名称でもエラーとします。

• --messageid

イベント検知時コマンドのタイムアウト時間は600秒です。イベント検知時コマンドが600秒以内に完了しない場合はタイムアウトが発生し、KDKD10153-Eメッセージがドメイン管理サーバのメッセージログに出力されます。このメッセージが出力されてもイベント検知時コマンドの処理は続行されます。

このコマンドはリモートモードだけサポートします。

実行権限

一般ユーザー

引数

--messageid=messageid

イベント検知時コマンドを実行させる契機となるメッセージIDを指定します。

型：String

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

• システムで公開されているメッセージID

デフォルト値：なし（必須）

--script=script-file-path

イベント検知時コマンドとして登録するスクリプトファイルを指定します。ドメイン管理サーバ上での絶対パスで指定してください。

型：String

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

• 存在するファイルの絶対パス

デフォルト値：なし（必須）

--monitoring-time-span=monitoring-time-span

このオプションで指定した時間ごとにイベント検知時コマンドが実行される回数を監視します。

値は秒数で指定します。0を指定した場合は、常にイベント検知時コマンドの実行を許可します（監視しません）。

イベント検知時コマンドを実行したことによってイベント検知対象のイベントが発生し、この繰り返しで無限にイベント検知時コマンドが実行される場合があります。このオプションと--monitoring-max-countオプションを同時に指定することで、イベント検知時コマンドが無限に繰り返されることを防げます。

型：Integer

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

• 0 〜 2147483647

デフォルト値：0

--monitoring-max-count=monitoring-max-count

--monitoring-time-spanオプションで指定した時間内に、同じ種類のイベントに対するイベント検知時コマンドを実行する回数の上限を指定します。0を指定した場合は、常にイベント検知時コマンドの実行を許可します。

同じ種類のイベントとは、次に示す条件を満たすイベントのことです。

サーバに関するイベントの場合、次のすべてが同じイベント

• イベントの契機となったメッセージID

• イベントが発生したサーバのサーバ名

ノードに関するイベントの場合、次のすべてが同じイベント

• イベントの契機となったメッセージID

• イベントが発生したノード名

サーバやノードとは関係ないイベントの場合、次の内容が同じイベント

• イベントの契機となったメッセージID

型：Integer

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

• 0 〜 256

デフォルト値：0

event-hook-name

イベント検知時コマンドの名称を指定します。

型：String

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

• ASCII文字であること。

• 名称は次の文字で構成すること。

  英小文字<a〜z>

  英大文字<A〜Z>

  数字<0〜9>

  ハイフン<->

  アンダースコア<_>

• 先頭文字は英大文字または英小文字を使用すること。

• ドメインに存在する次の名称は指定できません。

  ノード名

  JavaEEサーバ名

  Webサーバ名

  PRFのサーバ名

  クラスター名

  サーバ間関連名

  JavaEEサーバの構成名

• 次に示す名称はシステムで使用済みまたは予約語のため指定できません。

  domain

  server

  default

  server-config

  default-config

  default-webserver-config

  default-prf-config

  javaee

  webserver

  prf

  cluster

  redirect

  prf-relation

  HJES_で始まる名称

  構築済みWebサーバ名-config

  構築済みPRF名-config

デフォルト値：なし（必須）

asadmin create-event-hook --messageid KDKD10083-I
 --script /work/failure-script.sh Event01

asadmin create-event-hook --messageid KDKD10094-I
--script /work/failure-script.sh --monitoring-time-span=180
--monitoring-max-count=3  Event02

戻り値

戻り値	説明
0	正常終了
1	異常終了

注意事項

• 登録したイベント検知時コマンドのスクリプトは、イベント検知時コマンドの登録を解除するまで、削除しないでください。