ユーザーフック

Luaスクリプトを実行する際、管理者はフォルダ内の全てのファイルシステム、およびServerがインストールされているコンピューターの一部のシステムコマンドにアクセスできます。

Luaコンソールへのアクセスを禁止するには、該当する管理者に対して 追加機能を使用 権限を無効にします(管理者と管理者グループ参照)。

ユーザーフックはluaスクリプトとして組み込まれ、管理者の操作を自動化することでDr.Web Serverの特定のタスクをより早く実行できるようになります。

ユーザーフックはサーバーインストールフォルダ内の以下のサブフォルダに置かれています。

Windows OSの場合:var\extensions

FreeBSD OSの場合:/var/drwcs/extensions

Linux OSの場合:/var/opt/drwcs/extensions

サーバーのインストール後、プリインストールされているユーザーフックがこのフォルダ内に置かれます。

Control Centerからユーザーフックの編集を行うことを推奨します。

ユーザーフックの実行を設定するには

1.Control Centerのメインメニューで 管理 を選択します。

2.開いたウィンドウのコントロールメニュー内で ユーザーフック を選択します。ユーザーフックの設定を行うためのウィンドウが開きます。

フックツリー

フックの階層的リストはツリー状になっています。ツリーのノードはフックのグループおよびそれらに含まれるユーザーフックです。

フックツリーには以下のグループがプリインストールされています。

Examples of the hooks - 使用可能なすべてのユーザーフックのテンプレートが含まれています。これらのテンプレートのベースで、独自のユーザーフックを作成できます。フックテンプレートを編集または実行することはできません。

IBM Syslog - IBM Tivoliシステムとの統合に使用するユーザーフックのテンプレートが含まれています。有効なフックに対応するイベントは、Syslog形式で記述されます。

全てのイベントは、次のパスの1つのファイルに書き込まれます。

Windows OS:
var\export\tivoli\syslog\drwcs_syslog.log

FreeBSD:
/var/drwcs/export/tivoli/syslog/drwcs_syslog.log

Linux:
/var/opt/drwcs/export/tivoli/syslog/drwcs_syslog.log

IBM W7Log - IBM Tivoliシステムとの統合に使用するユーザーフックのテンプレートが含まれています。有効なフックに対応するイベントは、IBM W7Log XML形式で記述されます。

イベントごとに、次のパスに個別のファイルが作成されます。

Windows OS:
var\export\tivoli\w7log\<event_name>_<unix_timestamp>

FreeBSD:
/var/drwcs/export/tivoli/w7log/<event_name>_<unix_timestamp>

Linux:
/var/opt/drwcs/export/tivoli/w7log/<event_name>_<unix_timestamp>

ツリーエレメントのアイコンはエレメントの種類や状態によって異なります(下の表参照)。

フックツリー内のエレメントのアイコン

アイコン

説明

フックグループ

実行が有効になっているフックグループです。

実行が無効になっているフックグループです。

Hooks

実行可能なフックです。

実行不可能なフックです。

フックツリーの管理

フックツリー内のオブジェクトを管理するには、ツールバーの以下の項目を使用します。

- フックツリーにエレメントを追加するためのドロップダウンリストです。

フックを追加 - 新しいユーザーフックを追加します。

フックグループを追加 - フックを中に含ませるための新しいユーザーグループを追加します。

選択したオブジェクトの削除 - フックツリー内で選択されたユーザーフックまたはフックグループを削除します。

フックの実行を有効にする - フックエディタ内で フックの実行を有効にする にチェックを入れた場合と同じアクションが実行されます。「フックの有効化」を参照してください。

フックの実行を無効にする - フックエディタ内で フックの実行を有効にする のチェックを外した場合と同じアクションが実行されます。「フックの有効化」を参照してください。

フックグループの管理

新しいグループを作成するには

1.ツールバーで、 フックグループを追加 を選択します。

2.表示されたウィンドウで以下のパラメータを設定しください。

このグループ内に含まれるフックを有効にするには、フックの実行を有効にする にチェックを入れます。「フックの有効化」を参照してください。

グループ名 フィールドで、作成するグループに任意の名前を指定します。

3.保存 をクリックします。

グループの順番を変更するには

1.フックツリー内でフックグループをドラッグ&ドロップし、必要な順番に並び替えます。

2.グループの順番を変えると、フックが実行される順番が自動的に変更されます(フックツリーの一番上にあるグループのフックが最初に実行されます)。

フックを別のグループに移動する

1.フックツリー内で、移動するフックを選択します。

2.開いたプロパティウィンドウの 親グループ ドロップダウンリストから、フックの移動先になるグループを選択します。

3.保存 をクリックします。

フックの管理

新しいフックを作成

1.ツールバーで、 フックを追加 を選択します。

2.表示されたウィンドウで以下のパラメータを設定しください。

作成するフックを有効にするには、フックの実行を有効にする にチェックを入れます。「フックの有効化」を参照してください。

親グループ ドロップダウンリストから、作成するフックを置くグループを選択します。後で、他のグループにフックを移動させることができます(参照)。

フック ドロップダウンリストからフックの種類を選択します。フックの種類によって、フックを呼び出すアクションが決定されます。

フックテキスト フィールドで、フックが呼び出された際に実行されるluaスクリプトを入力します。
フックの情報 サブセクションには、フックを呼び出すアクション、該当するフックに対してサーバーデータベースを使用可能かどうかという情報、そして該当するフックの種類における入力パラメータと戻り値のリストが含まれています。

3.保存 をクリックします。

フックを編集するには

1.フックツリー内で、編集するフックを選択します。

2.ウィンドウ右側に、この手順のプロパティペインが自動的に開きます。フックの作成時に指定した全てのパラメータを編集できますが、Hook パラメータは除きます。このパラメータはフックを呼び出すアクションを決定し、フックが作成された後には編集することができません。

3.保存 をクリックします。

フックの有効化

フックおよびフックグループの有効化は、該当するイベントに応じてフックが実行されるかどうかを決定します。

フックまたはフックグループを有効にするには

1.フックツリー内で、有効化するフックまたはフックグループを選択します。

2.以下のアクションのうちいずれか1つを実行します。

ツールバーで フックの実行を有効にする をクリックします。

ウィンドウ右側にある、選択したオブジェクトのプロパティペインで フックの実行を有効にする にチェックを入れます(チェックが入っていない場合)。保存 をクリックします。

フックの有効化の特徴

該当するイベントに応じてフックを実行するには、以下の条件を満たしている必要があります。

a)フック自体が有効化されている。

b)フックを含んでいるグループが有効化されている。

フックグループが無効になっている場合、そこに含まれるフックは有効化されている場合であっても実行されません。

グループが有効化されている場合、直接有効化されたフックのみが実行されます。