機能説明
Systemwalker IT Service Managementなどのインシデント管理製品に対してインシデントの発行を依頼します。
オプション
基本オプション
運用操作部品を実行する対象のホスト名またはIPアドレスです。
または、インシデント管理を行っているサーバのホスト名またはIPアドレスです。
ホスト名またはIPアドレスを省略した場合、引数エラーとなります。
ホスト名またはIPアドレスの文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。
発行するインシデントの概要です。
概要を省略した場合、引数エラーとなります。
概要の文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。
Systemwalker IT Service Managementでインシデントを発行する場合、文字数の上限は80文字です。
概要に改行が含まれた場合、空白に変換します。
発行するインシデントの内容です。
内容の文字数の上限は、2048文字です。それより大きい場合、引数エラーとなります。
インシデントを発行する依頼者です。
Systemwalker IT Service Managementでインシデントを発行する場合、依頼者のメールアドレスを指定します。
Systemwalker IT Service Managementでインシデントを発行するかつ、依頼者のメールアドレスを省略した場合、引数エラーとなります。
Systemwalker IT Service Management以外のインシデント管理製品の場合は、本オプションの指定は無視します。
指定する文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。
発行したインシデントを管理する管理者です。
Systemwalker IT Service Managementでインシデントを発行する場合、管理者のメールアドレスを指定します。
Systemwalker IT Service Managementでインシデントを発行するかつ、管理者のメールアドレスを省略した場合、引数エラーとなります。
Systemwalker IT Service Management以外のインシデント管理製品の場合は、本オプションの指定は無視します。
指定する文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。
Systemwalker IT Service Managementでインシデントを発行する場合は、送信メール(SMTP)サーバのホスト名またはIPアドレスです。
Systemwalker IT Service Managementでインシデントを発行するかつ、ホスト名またはIPアドレスを省略した場合、引数エラーとなります。
Systemwalker IT Service Management以外のインシデント管理製品の場合は、本オプションの指定は無視します。
ホスト名またはIPアドレスの文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。
拡張オプション
運用操作部品を実行する対象のホストのOS種別です。
Windows、Linux、Solarisを指定します。なお、大文字／小文字は区別しません。
OS種別の入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得したOS種別の値をSystemwalker Runbook Automationが自動的に設定します。
OS種別の文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
Systemwalker IT Service Managementがインシデント管理製品の場合は、本オプションの指定は無視します。
運用操作部品を実行する対象のホストへSSHを利用して接続するユーザー名です。
接続ユーザー名および接続に必要なパスワードの入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した接続ユーザー名の値をSystemwalker Runbook Automationが自動的に設定します。
ファイル転送基盤を利用して接続する場合は、接続ユーザー名は以下のようになり変更できません。このため、ユーザー名を指定しても無効になります。
業務サーバがWindowsの場合: Administrator
業務サーバがLinux、Solarisの場合: root
接続ユーザー名の文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
Systemwalker IT Service Managementがインシデント管理製品の場合は、本オプションの指定は無視します。
運用操作部品を実行する対象のホストへSSHを利用して接続するユーザーのパスワードです。
接続ユーザー名および接続に必要なパスワードの入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した接続パスワードの値をSystemwalker Runbook Automationが自動的に設定します。
ファイル転送基盤を利用して接続する場合は、パスワードを指定しても無効になります。
接続に必要なパスワードの文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
Systemwalker IT Service Managementがインシデント管理製品の場合は、本オプションの指定は無視します。
運用操作部品を実行する対象のホストでコマンドを実行するユーザー名です。
実行ユーザー名およびexecpasswordの入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した管理者ユーザーの値をSystemwalker Runbook Automationが自動的に設定します。CMDBに登録されていない場合は、接続ユーザー名で実行します。
hostnameに指定したホストがWindowsで、ファイル転送基盤を利用して接続する場合は、Administratorユーザーで実行します。このため、ユーザー名を指定しても無効になります。
実行ユーザー名の文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
Systemwalker IT Service Managementがインシデント管理製品の場合は、本オプションの指定は無視します。
本運用操作部品ではexecpasswordの値を使用しません。execpasswordの値を指定した場合、無効となります。
送信メール(SMTP)サーバのホストへSMTP認証を行うユーザー名です。
ユーザー名を省略した場合、SMTP認証を利用しないメール送信を行います。
Systemwalker IT Service Management以外のインシデント管理製品の場合は、本オプションの指定は無視します。
ユーザー名の文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
送信メール(SMTP)サーバのホストへSMTP認証を行うユーザーのパスワードです。
パスワードを省略した場合、SMTP認証を利用しないメール送信を行います。
Systemwalker IT Service Management以外のインシデント管理製品の場合は、本オプションの指定は無視します。
認証に必要なパスワードの文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
Systemwalker IT Service Managementでインシデントを発行する場合における、送信メール(SMTP)サーバへ接続するポート番号です。
ポート番号は整数型で、0～65535の間で指定します。TCPのポート番号を指定します。
ポート番号を省略した場合、“25”を使用します。
Systemwalker IT Service Management以外のインシデント管理製品の場合は、本オプションの指定は無視します。
本運用操作部品の連携対象となるインシデント管理を行っている運用管理製品名を指定します。
Systemwalker IT Service Managementでインシデント管理を行っている場合は、"ITSM"を指定します。なお、大文字／小文字は区別しません。
本運用操作部品の連携対象はSystemwalker IT Service Managementだけです。
運用管理製品名の指定を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した値をSystemwalker Runbook Automationが自動的に設定します。
指定できる運用管理製品名の文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
本運用操作部品と連携するコマンドのインストールパスを指定します。
mwtypeの設定により、本運用操作部品の連携対象であるインシデント管理製品がSystemwalker IT Service Managementである場合は、省略することができます。
本運用操作部品の連携対象はSystemwalker IT Service Managementだけです。
指定できるインストールパスの上限は、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 | インシデントの発行に成功しました。 |
| 失敗 | 161 | インシデントの発行に失敗しました。リトライ回数を指定した場合、リトライします。 |
187 | 運用操作部品による操作を実施する際、インシデント管理サーバにネットワーク接続(SSH)時の認証に失敗しました。 または、運用操作部品による操作を実施する際に、業務サーバとの通信処理（ファイル転送基盤）で異常が発生しました。実行結果にファイル転送基盤のエラーコードを出力します。エラーコードについては、“3.22 ファイル転送基盤の詳細コード”を参照してください。 | ||
188 | RBAエージェントが導入されていないインシデント管理サーバに対して運用操作部品による操作を実施中に、インシデント管理サーバとのネットワーク通信(SSH)が切断しました。 または、メール送信中に通信が切断しました。 | ||
189 | 運用操作部品による操作を実施する際、インシデント管理サーバにネットワーク接続(SSH)できませんでした。 または、運用操作部品による操作を実施する際に、インシデント管理サーバとの通信処理（ファイル転送基盤）で異常が発生しました。実行結果にファイル転送基盤のエラーコードを出力します。エラーコードについては、“3.22 ファイル転送基盤の詳細コード”を参照してください。 または、メール(SMTP)サーバに接続できませんでした。 | ||
197 | オプションの指定に誤りがありました。もしくは、構成管理データベース(CMDB)の登録情報に問題があります。 | ||
200 | インシデントの発行が異常終了しました。 | ||
－ | － | 201 | 運用操作部品の実行がタイムアウトしました。 |
202 | 運用操作部品が実行されませんでした。運用操作部品を実行するための設定に問題があります。 | ||
203 | 運用操作部品の実行が失敗しました。管理サーバの環境に問題があります。 | ||
205 | 運用操作部品が実行されませんでした。運用操作部品の入力情報の指定に問題があります。 | ||
206 | 運用操作部品を正常に実行できませんでした。運用操作部品の出力情報の指定に問題があります。 | ||
207 | 運用操作部品が実行されませんでした。運用操作部品が管理サーバに登録されていない可能性があります。 | ||
208 | 運用操作部品の実行途中に自動運用プロセスのリカバリが行われたため、自動運用プロセスを中止状態にしました。 |
出力情報
変数 | 意味 |
|---|---|
message | インシデントの発行に成功した場合、以下のメッセージを設定します。 The operation component was successful. インシデントの発行に失敗した場合、エラー内容を文字列として設定します。 |
returnCode | 復帰値を設定します。 |
注意事項
各オプションには、半角カナ文字および以下の記号は使用しないでください。半角カナ文字および以下の記号を使用すると、運用操作部品の実行に失敗する場合があります。
「～」「￡」「―」「∥」「￠」「￢」「￣」「￥」「〃」
復帰値の確認は、Webコンソールで行います。詳細については、“Systemwalker Runbook Automation 運用ガイド”の“運用操作部品の実行状況・実行結果を確認する”を参照してください。
201～208の復帰値が出力された場合は自動運用プロセスが中止状態またはエラー状態となり、以下の場所にエラーメッセージが出力されます。
管理サーバのイベントログ(管理サーバがWindows(R)の場合)
管理サーバのシスログ(管理サーバがLinuxの場合)
BPMNのカスタムメッセージ
上記いずれかの場所でメッセージを確認し、適切な対処を実施してください。メッセージの詳細については、“Systemwalker Runbook Automation メッセージ集”を参照してください。
Systemwalker IT Service Managementでインシデント管理を行っている場合、連携可能なバージョンはV13.4.0です。
本運用操作部品は、事前にSystemwalker IT Service Managementのメール受信設定をする必要があります。詳細は、Systemwalker IT Service Managementの管理者ガイドを参照してください。
本運用操作部品は、インシデントの発行を依頼するものであり、実際にインシデントが発行されたかどうかについては、インシデント管理製品で確認してください。
本運用操作部品は、SMTP通信を利用して動作を実現しています。事前にSMTPサーバの構築および設定を行ってください。なお、SSLまたはTLSによるSMTP通信の暗号化には対応していません。SSLまたはTLSによる暗号化が必要なSMTPサーバに通信を行った場合は、復帰値189または197のエラーになります。
本運用操作部品の使用にあたり、SMTPサーバで通信の許可が必要になる通信ポートはportオプションで指定した番号です。省略時はTCPの25番です。
本運用操作部品は、hostnameに管理サーバ以外の情報を入力した場合、ファイル転送基盤またはSSH通信を利用して動作を実現しています。少なくともどちらか片方では通信可能となるように設定してください。各通信方法の注意事項については、“3.17 各通信方法の注意事項”を参照してください。
接続ユーザーと実行ユーザーが異なる場合、“3.17.7 接続ユーザーと実行ユーザーが異なる場合の注意事項”を参照してください。
