運用コマンドレファレンス Vol.1
監視するシステムメッセージを登録します。
[関数名]
regist_sysmsg( bcu_number = eventmonitor.DEFAULT, dup_status = eventmonitor.DEFAULT, event_level = eventmonitor.DEFAULT, message_type = "" message_type_detail = "", message_id = eventmonitor.DEFAULT, additional_info_upper = eventmonitor.DEFAULT, additional_info_lower = eventmonitor.DEFAULT, message_text = "", priority = eventmonitor.NORMAL)
[引数]
- bcu_number
- 監視するシステムメッセージの系番号(BCU番号)を数値で指定します。指定できる値の範囲は,1〜2です。
- この引数のデフォルト値はeventmonitor.DEFAULTです。eventmonitor.DEFAULTを指定した場合,すべての系番号が監視対象となります。
- dup_status
- 監視するシステムメッセージの系状態を指定します。
- eventmonitor.ACT:運用系
- eventmonitor.SBY:待機系
- この引数のデフォルト値はeventmonitor.DEFAULTです。eventmonitor.DEFAULTを指定した場合,すべての系状態が監視対象となります。
- event_level
- 監視するイベントレベルを指定します。監視するイベントレベルが一つの場合は数値,複数の場合はタプル型で,イベントレベル(S0〜S7)の先頭のSを除いた数値(0〜7)を指定します。例えば,event_level = (0,3,4)を指定した場合,監視対象はS0,S3,S4です。
- この引数のデフォルト値はeventmonitor.DEFAULTです。eventmonitor.DEFAULTを指定した場合,すべてのイベントレベルが監視対象となります。
- message_type
- 監視するメッセージ種別を最大24文字で指定します。指定した文字列と完全一致したメッセージ種別だけを監視対象にします。
- この引数のデフォルト値は「""」です。「""」を指定した場合,すべてのメッセージ種別が監視対象となります。
- なお,本装置で定義されていない文字列を指定しても,例外(ValueError)にはなりません。
- message_type_detail
- 監視するメッセージ種別詳細情報を,最大32文字の正規表現文字列で指定します。指定した文字列と正規表現で一致したメッセージ種別詳細情報だけを監視対象にします。
- この引数の指定には,引数message_typeの指定が必要です。指定がない(デフォルト値)場合,例外(ValueError)を返します。
- この引数のデフォルト値は「""」です。「""」を指定した場合,すべてのメッセージ種別詳細情報が監視対象となります。
- なお,正規表現は,POSIX 1003.2のBasic Regular Expressionに準拠します。
- message_id
- 監視するメッセージ識別子を16進数で指定します。指定できる値の範囲は,0x0〜0xffffffffです。
- この引数のデフォルト値はeventmonitor.DEFAULTです。eventmonitor.DEFAULTを指定した場合,すべてのメッセージ識別子が監視対象となります。
- additional_info_upper
- 監視する付加情報上位2桁を16進数で指定します。指定できる値の範囲は,0x0〜0xffです。
- この引数のデフォルト値はeventmonitor.DEFAULTです。eventmonitor.DEFAULTを指定した場合,すべての付加情報の上位2桁が監視対象となります。
- additional_info_lower
- 監視する付加情報下位12桁を16進数で指定します。指定できる値の範囲は,0x0〜0xffffffffffffです。
- この引数のデフォルト値はeventmonitor.DEFAULTです。eventmonitor.DEFAULTを指定した場合,すべての付加情報下位12桁が監視対象となります。
- message_text
- 監視するメッセージテキストを,最大128文字の正規表現文字列で指定します。指定した文字列と正規表現で一致したメッセージテキストだけを監視対象にします。
- この引数の指定には,引数message_idの指定が必要です。指定がない(デフォルト値)の場合,例外(ValueError)を返します。
- この引数のデフォルト値は「""」です。「""」を指定した場合,すべてのメッセージテキストが監視対象となります。
- なお,正規表現は,POSIX 1003.2のBasic Regular Expressionに準拠します。
- priority
- 本監視イベントが発生したときの通知優先度を指定します。
- eventmonitor.HIGH:高
- eventmonitor.NORMAL:中(デフォルト値)
- eventmonitor.LOW:低
- eventmonitor.LAST:最低
- 通知優先度が高/中/低のイベントは,次の割合で通知します。
- 高:中:低 = 6:3:1
- 通知優先度が最低のイベントは,高/中/低のイベントをすべて通知したあと,通知します。
[戻り値]
- 整数型
- 監視イベントID(一意の値)
[例外]
表20-7 eventmonitor.regist_sysmsgの例外クラス一覧
例外クラス名 説明 TypeError 引数の型に誤りがあります。 ValueError 引数に不正な値が指定されています。 SystemError システムエラーが発生しました。 KeyboardInterrupt [Ctrl+C]の入力によってコマンドが中断されました。 eventmonitor.RegisterMax イベント登録数が上限に達しています。 eventmonitor.RegistrationError イベント登録に失敗しました。
[詳細]
引数に指定したシステムメッセージを監視します。
引数bcu_number,dup_status,event_level,message_type,message_type_detail,message_id,additional_info_upper,additional_info_lower,およびmessage_textのAND条件でシステムメッセージを監視します。
正常終了の場合,戻り値に監視イベントID(正の整数)の値が格納されます。異常終了の場合,例外を返します。
システムメッセージ監視登録は,装置当たり最大256件登録できます。256件を超えた場合は例外(eventmonitor.RegisterMax)を返します。
[注意事項]
- 次に示すメッセージ種別のシステムメッセージは監視できません。
- KEY,SCR-KEY(入力コマンド)
- CONFIGERR,SCR-CNFERR(コンフィグレーションエラーメッセージ)
- CMDRSP,SCR-CMDRSP(コマンド応答メッセージ)
- 引数priorityを除く,すべての引数がデフォルト値の場合,例外(ValueError)を返します。
[備考]
- この関数で指定した引数とシステムメッセージとの対応を次に示します。
yyyy/mm/dd hh:mm:ss zzzz 1-b(c) Se kkkkkkkk [iii...iii] xxxxxxxx yy zzzzzzzzzzzz ttt...ttt 1 2 3 4 5 6 7 8 9
- bcu_number
- dup_status
- event_level
- message_type
- message_type_detail
- message_id
- additional_info_upper
- additional_info_lower
- message_text
- 出力されるシステムメッセージが多い場合,監視登録数や監視条件によっては,スクリプトへの通知遅延や廃棄が発生することがあります。
All Rights Reserved, Copyright(C), 2014, 2019, ALAXALA Networks, Corp.