機能説明
SNMPマネージャに、SNMPトラップを送信します。
オプション
基本オプション
運用操作部品を実行する対象のホスト名またはIPアドレスです。
管理サーバで運用操作部品を実行する場合、以下を指定します。
IPv4の場合: “localhost”または“127.0.0.1”
IPv6の場合: “localhost”または“::1”
ホスト名またはIPアドレスを省略した場合、引数エラーとなります。
ホスト名またはIPアドレスの文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。
SNMPプロトコルのバージョンです。
バージョンには、“v1”、“v2”または“v3”を指定します。なお、大文字／小文字は区別しません。
バージョンを省略した場合、引数エラーとなります。
SNMPのオブジェクトIDです。
オブジェクトIDは複数指定できます。
本オプションを省略した場合、引数エラーとなります。
本オプションの個数の上限は、100個です。それより大きい場合、引数エラーとなります。
指定は、CSV形式です。複数指定の例は、“3.18 入力パラメーターを複数指定する場合の注意事項”を参照してください。
オブジェクトIDを複数指定する場合は、以下のようにカンマで区切って指定します。
例) 1.3.6.1.2.1.1.5.0,1.3.6.1.2.1.1.6.0,1.3.6.1.2.1.1.3.0
設定するオブジェクトの値です。
オブジェクトの値は複数指定できます。指定する順番は、オブジェクトIDと同じ順番にします。
本オプションを省略した場合、“”が設定されます。
本オプションの個数の上限は、100個です。それより大きい場合、引数エラーとなります。
指定したオブジェクトの値は、UTF-8の文字コードに変換して通信を行います。
指定は、CSV形式です。複数指定の例は、“3.18 入力パラメーターを複数指定する場合の注意事項”を参照してください。
オブジェクトの値は、以下のように指定します。
(例) new_hostname,new_location,23:10:54.50
設定するオブジェクトの値のデータタイプです。
データタイプは複数指定できます。指定する順番は、オブジェクトIDと同じ順番にします。
データタイプとその意味を以下に示します。
type | 意味 |
|---|---|
i | INTEGER |
u | UNSIGNED |
s | STRING |
x | HEX STRING |
d | DECIMAL STRING |
n | NULLOBJ |
o | OBJID |
t | TIMETICKS |
a | IPADDRESS |
b | BITS |
上記以外を指定した場合、引数エラーとなります。
本オプションを省略した場合、“s”が設定されます。
本オプションの個数の上限は、100個です。それより大きい場合、引数エラーとなります。
指定は、CSV形式です。複数指定の例は、“3.18 入力パラメーターを複数指定する場合の注意事項”を参照してください。
拡張オプション
SNMPマネージャのコミュニティ名です。
SNMPプロトコルのバージョンがv1、v2の場合に指定可能です。v3の場合は、指定を無視します。
本オプションには“public”、“private”、またはその他カスタマイズ値を指定します。
本オプションを省略した場合、“public”が設定されます。
本オプションの文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。
SNMPマネージャの起動時刻からトラップ発生時刻までの時間です。単位は100分の1秒です。
本オプションを省略した場合、“0”が設定されます。
指定できる範囲は、0から2147483647までです。それ以外の値を指定した場合、引数エラーとなります。
SNMPのセキュリティレベルです。
SNMPプロトコルのバージョンがv3の場合に指定可能です。v1、v2の場合は、指定を無視します。
本オプションには“noAuthNoPriv”、“authNoPriv”または“authPriv”を指定します。なお、大文字／小文字は区別しません。
“noAuthNoPriv”を指定した場合、IDをチェックせず、送信するメッセージを暗号化しません。snmpusernameオプションの指定が必要です。
“authNoPriv”を指定した場合、IDをチェックし、送信するメッセージを暗号化しません。snmpusernameオプション、snmppasswordオプションおよびauthprotocolオプションの指定が必要です。
“authPriv” を指定した場合、IDをチェックし、送信するメッセージを暗号化します。snmpusernameオプション、snmppasswordオプション、authprotocolオプション、privpasswordオプションおよびprivprotocolオプションの指定が必要です。
本オプションを省略した場合、“noAuthNoPriv”が設定されます。
オブジェクト値を送信するホストのSNMPユーザー名です。
SNMPプロトコルのバージョンがv3の場合に指定可能です。v1、v2の場合は、指定を無視します。
SNMPプロトコルのバージョンがv3の場合は、本オプションを省略することはできません。
本オプションの文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。
オブジェクト値を送信するホストのSNMPユーザーのパスワードです。
SNMPプロトコルのバージョンがv3の場合に指定可能です。v1、v2の場合は、指定を無視します。
SNMPプロトコルのバージョンがv3、かつ、セキュリティレベルがauthNoPrivまたはauthPrivの場合は、本オプションを省略することはできません。
パスワードの長さが8文字未満の場合、引数エラーとなります。
パスワードの文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。
SNMPユーザーIDのチェックで用いられるプロトコルです。
SNMPプロトコルのバージョンがv3の場合に指定可能です。v1、v2の場合は、指定を無視します。
SNMPプロトコルのバージョンがv3、かつ、セキュリティレベルがauthNoPrivまたはauthPrivの場合は、本オプションを省略することはできません。
本オプションは、“MD5”または“SHA”を指定します，それ以外の場合、引数エラーとなります。なお、大文字／小文字は区別しません。
オブジェクト値を送信するホストのSNMPユーザーが送信するメッセージを暗号化するときに使用するパスワードです。
SNMPプロトコルのバージョンがv3の場合に指定可能です。v1、v2の場合は、指定を無視します。
SNMPプロトコルのバージョンがv3、かつ、セキュリティレベルがauthPrivの場合は、本オプションを省略することはできません。
パスワードの長さが8文字未満の場合、引数エラーとなります。
パスワードの文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。
SNMPメッセージを暗号化するのに使用されるプロトコルです。
SNMPプロトコルのバージョンがv3の場合に指定可能です。v1、v2の場合は、指定を無視します。
SNMPプロトコルのバージョンがv3、かつ、セキュリティレベルがauthPrivの場合は、本オプションを省略することはできません。
本オプションには、“DES”または“AES”を指定します。それ以外の場合、引数エラーとなります。なお、大文字／小文字は区別しません。
トラップ情報を送信するオブジェクトのIDです。
(例) 1.3.6.1.2.1.1.5.0
SNMPプロトコルのバージョンがv1の場合に指定可能です。v2、v3の場合は、指定を無視します。
SNMPプロトコルのバージョンがv1の場合は、本オプションを省略することはできません。
本オプションの文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。
トラップ情報のタイプです。
SNMPプロトコルのバージョンがv1の場合に指定可能です。v2、v3の場合は、指定を無視します。
タイプとその意味を以下に示します。
type | 意味 |
|---|---|
0 | Cold Start |
1 | Warm Start |
2 | Link Down |
3 | Link Up |
4 | Authentication Failure |
5 | EGP Neighbor Loss |
6 | Enterprise Specific |
上記以外を指定した場合、引数エラーとなります。
本オプションを省略した場合、“0”を設定します。
カスタマイズしたトラップ情報のタイプです。
SNMPプロトコルのバージョンがv1の場合に指定可能です。v2、v3の場合は、指定を無視します。
SNMPプロトコルのバージョンがv1かつtraptypeが6の場合、本オプションを省略することはできません。
traptypeが6以外の場合、指定を無視します。
指定できる範囲は、0から2147483647までです。それ以外の値を指定した場合、引数エラーとなります。
トラップの情報フラグです。
(例) 1.3.6.1.2.1.1.5.0
SNMPプロトコルのバージョンがv2、v3の場合に指定可能です。v1の場合は、指定を無視します。
SNMPプロトコルのバージョンがv2、v3の場合は、本オプションを省略することはできません。
本オプションの文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。
SNMPエンジンの識別名です。
(例) 43:05:A8:3F:40:BC
SNMPプロトコルのバージョンがv3の場合に指定可能です。v1、v2の場合は、指定を無視します。
本オプションの文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。
運用操作部品の実行の完了待ち合わせ時間(秒)です。
300～86,400(1日)の範囲で指定が可能です。
(例) 完了待合せを10分間行う場合：600
指定した時間を経過しても運用操作部品の実行が完了しない場合は、運用操作部品の処理を復帰値：201で中断します。
運用操作部品の実行の起動リトライ回数です。
運用操作部品が復帰値：161で終了した場合に、起動リトライを行う回数を指定します。0～5の範囲で指定が可能です。
起動リトライにより再実行した結果、運用操作部品が161以外の復帰値で終了した場合は、指定した起動リトライ回数に達していなくても運用操作部品の実行は終了します。運用操作部品の復帰値は最後に実行した値になります。
(例) 起動リトライを2回行う場合：2
運用操作部品のリトライ間隔(秒)です。
運用操作部品が復帰値：161で終了した場合に、起動リトライを行うまでの間隔を指定します。1～14400の範囲で指定が可能です。
(例) 300秒間隔でリトライを行う場合：300
timeout、retry、およびretry_intervalについて、指定を省略した場合や、範囲外の値を入力した場合は、運用操作部品実行定義ファイルで指定した値が有効になります。詳細は、“2.5 運用操作部品実行定義ファイル”を参照してください。
復帰値
アイコン | シンボル名 | 復帰値 | 意味 |
|---|---|---|---|
| 成功 | 0 | SNMPトラップの送信に成功しました。 |
| 失敗 | 161 | SNMPトラップの送信に失敗しました。リトライ回数を指定した場合、リトライします。 |
197 | 入力情報に誤りがありました。 | ||
200 | SNMPトラップの送信が異常終了しました。 | ||
－ | － | 201 | 運用操作部品の実行がタイムアウトしました。 |
202 | 運用操作部品が実行されませんでした。運用操作部品を実行するための設定に問題があります。 | ||
203 | 運用操作部品を正常に実行できませんでした。管理サーバの環境に問題があります。 | ||
205 | 運用操作部品が実行されませんでした。運用操作部品の入力情報の指定に問題があります。 | ||
206 | 運用操作部品を正常に実行できませんでした。運用操作部品の出力情報の指定に問題があります。 | ||
207 | 運用操作部品が実行されませんでした。運用操作部品が管理サーバに登録されていない可能性があります。 | ||
208 | 運用操作部品の実行途中に自動運用プロセスのリカバリが行われたため、自動運用プロセスを中止状態にしました。 |
出力情報
変数 | 意味 |
|---|---|
message | SNMPトラップの送信に成功した場合、以下のメッセージを設定します。 The operation component was successful. SNMPトラップの送信に失敗した場合、エラー内容を文字列として設定します。 |
returnCode | 復帰値を設定します。 |
注意事項
実行する対象のホストに、事前にSNMPマネージャのインストールおよび設定を行ってください。
本運用操作部品は、UDPのポート番号：162を利用します。
各オプションには、半角カナ文字および以下の記号は使用しないでください。半角カナ文字および以下の記号を使用すると、運用操作部品の実行に失敗する場合があります。
“～”、“￡”、“―”、“∥”、“￠”、“￢”、“￣”、“￥”、“〃”
復帰値の確認は、Webコンソールで行います。詳細については、“Systemwalker Runbook Automation 運用ガイド”の“運用操作部品の実行状況・実行結果を確認する”を参照してください。
201～208の復帰値が出力された場合は自動運用プロセスが中止状態またはエラー状態となり、以下の場所にエラーメッセージが出力されます。
管理サーバのイベントログ(管理サーバがWindows(R)の場合)
管理サーバのシスログ(管理サーバがLinuxの場合)
BPMNのカスタムメッセージ
上記いずれかの場所でメッセージを確認し、適切な対処を実施してください。メッセージの詳細については、“Systemwalker Runbook Automation メッセージ集”を参照してください。
