機能説明
指定したホストのOSに対して、指定された修正パッチを適用します。
オプション
基本オプション
運用操作部品を実行する対象のホスト名またはIPアドレスです。
管理サーバで運用操作部品を実行する場合、'localhost'または'127.0.0.1'を指定します。
ホスト名またはIPアドレスを省略した場合、引数エラーとなります。
ホスト名またはIPアドレスの文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。
適用する修正パッチの方法です。
wsus:Windows Server Update Services(WSUS)経由で修正を適用します。
mod :mod_targetdirオプションで指定されたディレクトリ内に格納されている修正パッチを適用します。
省略した場合は、wsusとなります。なお、大文字／小文字は区別しません。
wsusまたはmod以外が指定された場合、引数エラーとなります。
patch_kindの文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
修正パッチを適用するサーバ上に、修正パッチを格納するディレクトリの絶対パスです。
patch_kindオプションでmodが指定された場合だけ必須です。
文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。
修正パッチが格納されているホスト名またはIPアドレスです。
patch_kindオプションでmodが指定された場合だけ必須です。
管理サーバに修正パッチが格納されている場合、'localhost'または'127.0.0.1'を指定します。
ホスト名またはIPアドレスの文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。
mod_stragehostで指定した修正パッチが格納されているサーバ上のディレクトリの絶対パスです。
patch_kindオプションでmodが指定された場合だけ必須です。
文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。
注：mod_stragedir内に格納する修正パッチは、Microsoft Download Centerからダウンロードしてきた形式のまま格納してください。
＜例＞
<mod_stragedir>\Windows6.0-KB2522422-x86.msu
適用する修正パッチのファイル名です。
patch_kindオプションでmodが指定された場合だけ必須です。
修正パッチファイルの個数の上限は、100個です。それより大きい場合、引数エラーとなります。
重複した修正パッチファイルを指定した場合、引数エラーとなります。
指定は、CSV形式です。複数指定の例は、“3.18 入力パラメーターを複数指定する場合の注意事項”を参照してください。
拡張オプション
適用する修正パッチ番号です。
patch_kindオプションでwsusを指定した場合だけ有効です。
修正パッチ番号の個数の上限は、100個です。それより大きい場合、引数エラーとなります。
重複した修正パッチ番号を指定した場合、引数エラーとなります。
指定は、CSV形式です。複数指定の例は、“3.18 入力パラメーターを複数指定する場合の注意事項”を参照してください。
wsus_patchnoを指定すると、wsus_typeの指定は無効になります。
省略した場合は、wsus_typeの指定に従います。
(例) 修正パッチ番号としてKB000001～KB000005の5つを指定する場合
"KB000001","KB000002","KB000003","KB000004","KB000005"
wsusを使用して適用する修正パッチの種類です。
patch_kindオプションでwsusを指定し、かつ、wsus_patchnoを省略した場合だけ有効です。
wsus_patchnoオプションで修正パッチ番号を指定した場合は無効となります。
software：ソフトウェアの修正パッチを適用します。
driver：ドライバの修正パッチを適用します。
all：ソフトウェアとドライバのすべての修正パッチを適用します。
省略した場合は、allとなります。なお、大文字／小文字は区別しません。
software、driverまたは、all以外が指定された場合は引数エラーとなります。
修正パッチを適用するホストのOS種別です。
Windowsを指定します。なお、大文字／小文字は区別しません。
OS種別の入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得したOS種別の値をSystemwalker Runbook Automationが自動的に設定します。
Windows以外が指定された場合は、引数エラーとなります。
OS種別の文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
修正パッチを適用するホストへSSHを利用して接続するユーザー名です。
接続ユーザー名および接続に必要なパスワードの入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した接続ユーザー名の値をSystemwalker Runbook Automationが自動的に設定します。
ファイル転送基盤を利用して接続する場合は、接続ユーザー名は以下のようになり変更できません。このため、ユーザー名を指定しても無効になります。
業務サーバがWindowsの場合: Administrator
接続ユーザー名の文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
修正パッチを適用するホストへSSHを利用して接続するユーザーのパスワードを指定します。
接続ユーザー名および接続に必要なパスワードの入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した接続パスワードの値をSystemwalker Runbook Automationが自動的に設定します。
ファイル転送基盤を利用して接続する場合は、パスワードを指定しても無効になります。
接続に必要なパスワードの文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
修正パッチが格納されているホストのOS種別です。
Windows、Linuxを指定します。なお、大文字／小文字は区別しません。
OS種別の入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得したOS種別の値をSystemwalker Runbook Automationが自動的に設定します。
OS種別の文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
修正パッチが格納してあるホストへSSHを利用して接続するユーザー名です。
接続ユーザー名および接続に必要なパスワードを省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した接続ユーザー名の値をSystemwalker Runbook Automationが自動的に設定します。
ファイル転送基盤を利用して接続する場合は、mod_strage_usernameは以下のようになり変更できません。このため、ユーザー名を指定しても無効になります。
業務サーバがWindowsの場合: Administrator
接続ユーザー名の文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
修正パッチが格納してあるホストへSSHを利用して接続するユーザーのパスワードを指定します。
接続ユーザー名および接続に必要なパスワードを省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した接続パスワードの値をSystemwalker Runbook Automationが自動的に設定します。
ファイル転送基盤を利用して接続する場合は、パスワードを指定しても無効になります。
接続に必要なパスワードの文字列の上限は、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 | 修正パッチの適用が正常終了しました。 |
| 成功(再起動) | 1 | サーバの再起動が必要です。 |
| 失敗 | 161 | 業務サーバとの通信処理でエラーが発生しました。リトライ回数を指定した場合、リトライします。 |
171 | 1つまたは複数の修正パッチの適用が失敗しました。 | ||
172 | サーバの再起動が必要かつ、修正パッチの適用が失敗しました。 | ||
187 | 運用操作部品による操作を実施する際、業務サーバにネットワーク接続(SSH)時の認証に失敗しました。 または、運用操作部品による操作を実施する際に、業務サーバとの通信処理（ファイル転送基盤）で異常が発生しました。実行結果にファイル転送基盤のエラーコードを出力します。エラーコードについては、“3.21 ファイル転送基盤の詳細コード”を参照してください。 | ||
188 | RBAエージェントが導入されていない業務サーバに対して運用操作部品による操作を実施中に、業務サーバとのネットワーク通信(SSH)が切断されました。 | ||
189 | 運用操作部品による操作を実施する際、業務サーバにネットワーク接続(SSH)できませんでした。 または、運用操作部品による操作を実施する際に、業務サーバとの通信処理（ファイル転送基盤）で異常が発生しました。実行結果にファイル転送基盤のエラーコードを出力します。エラーコードについては、“3.21 ファイル転送基盤の詳細コード”を参照してください。 | ||
197 | オプションの内容に誤りがありました。 | ||
－ | － | 201 | 運用操作部品の実行がタイムアウトしました。 |
202 | 運用操作部品が実行されませんでした。運用操作部品を実行するための設定に問題があります。 | ||
203 | 運用操作部品を正常に実行できませんでした。管理サーバの環境に問題があります。 | ||
205 | 運用操作部品が実行されませんでした。運用操作部品の入力情報の指定に問題があります。 | ||
206 | 運用操作部品を正常に実行できませんでした。運用操作部品の出力情報の指定に問題があります。 | ||
207 | 運用操作部品が実行されませんでした。運用操作部品が管理サーバに登録されていない可能性があります。 | ||
208 | 運用操作部品の実行途中に自動運用プロセスのリカバリが行われたため、自動運用プロセスを中止状態にしました。 |
出力情報
変数 | 意味 |
|---|---|
message | すべてのサーバへの修正パッチで成功した場合、以下のメッセージを設定します。 The operation component was successful. １つでも修正パッチの適用が失敗した場合、エラー内容を文字列として設定します。 |
execution_result | 修正パッチの適用結果が格納されます。 以下の形式で出力します。 ＜例＞ 以下の指定で修正パッチを適用した場合(wsus指定) KB000001,KB000002,KB000003,KB000004,KB000005 以下が出力されます。 RC,PatchNo,Message 出力される情報の詳細を以下に説明します。
|
failure_patchlist | 修正パッチの適用が失敗または、中断した場合、以下がCSV形式で出力されます。 patch_kindの値が「wsus」の場合：修正パッチ番号 patch_kindの値が「mod」の場合：修正パッチファイル名 |
returnCode | 復帰値を設定します。 |
注意事項
本運用操作部品は、hostnameまたは、mod_stragehostに管理サーバ以外の情報を入力した場合、ファイル転送基盤またはSSH通信を利用して動作を実現しています。少なくともどちらか片方では通信可能となるように設定してください。各通信方法の注意事項については、“3.17 各通信方法の注意事項”を参照してください。
WSUS経由で修正パッチを適用する場合、事前に修正パッチを適用するサーバのWinHTTPプロキシの設定を行ってください。WinHTTPプロキシの設定は、以下の手順で実施します。
コマンドプロンプトにて、Windowsのnetshコマンドまたはproxycfgコマンドを実行し、プロキシの設定を行います。
[Windows Server 2008の場合の実行例]
netsh winhttp set proxy proxy-server="<servername>:<port number>" bypass-list="<bypass-list>"
[Windows Server 2003の場合の実行例]
proxycfg -p "<servername>:<port number>" "<bypass-list>"
<servername>は、プロキシサーバー名を指定します。
<port number>は、プロキシサーバーのポート番号を指定します。
<bypass-list>は、使用しないプロキシサーバーのアドレスをセミコロンで区切って指定します。
コマンドプロンプトにて、以下のコマンドを入力し、Automatic Updates サービスを再起動します。
net stop wuauserv net start wuauserv
本運用操作部品は、適用する修正パッチ数が多い場合や通信の速度の影響により、実行に時間がかかる場合があります。このためtimeoutに適切な値を設定してください。
修正パッチを適用するサーバにおいて、環境変数windirに指定されているフォルダのWindowsUpdate.logファイルに、修正パッチ適用の実行状況がOSによって記録されます。
運用操作部品の実行がタイムアウトとなった場合、運用プロセスは中断しますが、修正パッチ適用処理は継続します。この場合、修正パッチを適用するサーバのWindowsUpdate.logファイルを参照してパッチ適用処理が完了しているか確認してください。WindowsUpdate.logファイルに「reboot required = Yes」と記録されている場合は、サーバの再起動が必要です。パッチ適用処理が完了した後にパッチを適用したサーバを再起動してください。
修正パッチファイル名には、半角英数字、全角文字と以下の記号のみを利用してください。
利用可能な記号：「!」「~」「_」「-」「.」
各オプションには、半角カナ文字および以下の記号は使用しないでください。半角カナ文字および以下の記号を使用すると、運用操作部品の実行に失敗する場合があります。
「～」「￡」「―」「∥」「￠」「￢」「￣」「￥」「〃」
業務サーバにRBAエージェントが未導入の場合は、mod_targetdirオプションおよびmod_stragedirオプションに日本語を指定すると運用操作部品の操作結果は保証されません。日本語を指定する場合は業務サーバにRBAエージェントを導入してください。
復帰値の確認は、Webコンソールで行います。詳細については、“Systemwalker Runbook Automation 運用ガイド”の“運用操作部品の実行結果を確認する”を参照してください。
201～208の復帰値が出力された場合は自動運用プロセスが中止状態またはエラー状態となり、以下の場所にエラーメッセージが出力されます。
管理サーバのイベントログ(管理サーバがWindows(R)の場合)
管理サーバのシスログ(管理サーバがLinuxの場合)
BPMNのカスタムメッセージ
上記いずれかの場所でメッセージを確認し、適切な対処を実施してください。メッセージの詳細については、“Systemwalker Runbook Automation メッセージ集”を参照してください。
