N1 Service Provisioning System 4.1 リファレンスガイド

第 14 章 rule: 通知を行う CLI コマンド

この章では、イベント通知の管理に必要なコマンドについて説明します。

rule コマンドの概要

rule コマンドを使用すると、N1 Service Provisioning System software で特定のタイプのイベントが発生したときに電子メールの通知が送信されるように構成できます。

表 14–1 では、通知の規則を管理する CLI コマンドの概要を説明します。

表 14–1 rule コマンドの概要

コマンド 

説明 

rule.add 

通知規則を追加する 

rule.del 

通知規則を削除する 

rule.la 

すべての通知規則を一覧表示する 

rule.lo 

特定の規則を検出する 

rule.mod 

既存の規則を変更する 

rule.add

このコマンドは、電子メール通知送信の新しい規則を追加します。

表 14–2 rule.add コマンドの引数と結果

引数/結果 

構文 

説明 

[R] 

文字列 

規則の名前 

[O] 

文字列 

規則の説明 

tf 

[O] 

CriteriaShorthand 

規則イベントタイプフィルタ 

mf 

[O] 

文字列 

規則メッセージフィルタ 

haf 

[O] 

HostIDArray 

規則ホストフィルタ 

hsf 

[O] 

HostSetID 

規則ホストセットフィルタ 

sf 

[O] 

文字列 

規則重要度フィルタ 

ea 

[R] 

文字列 

通知先の電子メールアドレス 

result 

RuleMetaData 

新しい規則 

表 14–3 には、規則が適用されるイベントのタイプを指定するために -tf 引数と共に指定できるキーワードを示します。

表 14–3 -tf 引数の CriteriaShorthand

条件の短縮形 

イベント 

any 

すべてのイベント 

planStart 

プランの開始 

planEndAbnormal 

プランの異常終了 

planEndNormal 

プランの正常終了 

cmpStart 

比較の開始 

cmpEndAbnormal 

比較の異常終了 

cmpEndNormal 

比較の正常終了 

system 

すべてのシステムイベント 

admin 

すべての管理イベント 

custom 

すべてのカスタムイベント 

rule.del

このコマンドは、指定された規則を削除します。

表 14–4 rule.del コマンドの引数

引数 

構文 

説明 

ID 

[R] 

RuleID 

規則の ID 

rule.la

このコマンドは、N1 Service Provisioning System software で定義されたすべての規則を一覧表示します。

表 14–5 rule.la コマンドの結果

結果 

構文 

説明 

result 

RuleMetaDataArray 

規則 

rule.lo

このコマンドは、ID によって指定される規則を検出します。

表 14–6 rule.lo コマンドの引数と結果

引数/結果 

構文 

説明 

ID 

[R] 

RuleID 

規則の ID 

result 

RuleMetaData 

規則 

rule.mod

このコマンドは、既存の規則の指定された属性を変更します。 省略された引数は、現在の値を保持します。

表 14–7 rule.mod コマンドの引数と結果

引数/結果 

構文 

説明 

ID 

[R] 

RuleID 

規則の ID 

[O] 

文字列 

規則の名前 

[O] 

文字列 

規則の説明 

tf 

[O] 

CriteriaShorthand 

規則イベントタイプフィルタ 

mf 

[O] 

文字列 

規則メッセージフィルタ 

haf 

[O] 

HostIDArray 

規則ホストフィルタ 

hsf 

[O] 

HostSetID 

規則ホストセットフィルタ 

sf 

[O] 

文字列 

規則重要度フィルタ 

ea 

[O] 

文字列 

通知先の電子メールアドレス 

result 

RuleMetaData 

変更された規則