4.14.1 TELstaffによる通知
機能
この部品は，Windowsの実行対象サーバで，TELstaffによる通知を行います。
この部品が前提とするサーバを次に示します。
・実行対象サーバ
この部品を実行する対象となるサーバです。
この部品内のスクリプトでは次に示す処理を行います。
・次のコマンドを実行します。
teldial
-ni "連絡網ID(TELstaff.contactNetworkIDプロパティ)の値"
[-fm "メール通知文ファイル(TELstaff.notificationFileMailプロパティ)の値"]
[-fv "電話通知文ファイル(TELstaff.notificationFileVoiceプロパティ)の値"]
[-u "ユーザー付加情報(TELstaff.UserInformationプロパティ)の値"]
teldialコマンドは標準出力と標準エラー出力を出力しません。また，戻り値は通知の成否ではなく，コマンド受付の成否までになります。
このため，通知の成否についてはTELstaffのログビューアなどで確認する必要があります。
また，teldialコマンドを連続実行すると，TELstaffの発信制限機能によってコマンドの戻り値が0以外になる場合がありますが，この部品はteldialコマンドの戻り値を参照せず，連続実行しても発信制限機能によってエラーになることはありません。発信制限の発生状況についてもTELstaffのログビューアで確認してください。
teldialコマンドの詳細については，TELstaffのマニュアルを参照してください。
利用場面
システムの障害などをオペレータへ通知したい場合に使用できます。
前提条件
【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。
【システム内前提製品】
JP1/Automatic Operation 11-00以降
【実行対象サーバ内前提製品】
・JP1/TELstaff 11-00以降
【実行対象サーバの稼働OS】
(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter
(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter
(3) Windows Server 2016 Standard/Datacenter
(4) Windows Server 2019 Standard/Datacenter
注意事項
(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。
(2) その他の注意事項については，TELstaffマニュアルの同コマンドの注意事項を参照してください。
実行権限
Administratorsグループに属するユーザーであること。
バージョン
02.01.00
部品のタグ
Control JP1,TELstaff,Windows
タスクログに表示される部品の名称
TELstaffDial
戻り値
|
戻り値 |
説明 |
|---|---|
|
0 |
正常 |
|
21 |
異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知) |
|
41 |
異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知) |
プロパティ一覧
プロパティ一覧を次の表に示します。
|
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
|---|---|---|---|---|---|
|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
|
TELstaff.contactNetworkID |
連絡網ID |
TELstaffで定義されている連絡網IDを指定します。 |
− |
入力 |
○ |
|
TELstaff.notificationFileMail |
メール通知文ファイル |
実行対象サーバのメール通知文ファイル名(メールで送信するメッセージテキストを格納したファイル名)を，フルパスで指定します。指定しなかった場合には，標準提供の通知文ファイルを使用します。 |
− |
入力 |
△ |
|
TELstaff.notificationFileVoice |
電話通知文ファイル |
実行対象サーバの電話通知文ファイル名(電話で音声通知するメッセージテキストを格納したファイル名)を，フルパスで指定します。指定しなかった場合には，標準提供の通知文ファイルを使用します。 |
− |
入力 |
△ |
|
TELstaff.UserInformation |
ユーザー付加情報 |
通知文ファイル(通知するメッセージテキスト)中の~UserInformation~ 変数と置き換えられます。「;」(半角セミコロン)で区切ると，複数行に分割できます。 |
− |
入力 |
△ |
|
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |