機能説明
指定したホストのOSに対して、指定された修正パッチを適用します。
指定したホストのOSがWindowsの場合、Windows UpdateやMicrosoft UpdateをWSUS経由で適用します。また、修正パッチが格納されているホストから、修正パッチを指定したホストのOSに適用します。
指定したホストのOSがLinuxの場合、インストール済みのパッケージに対して、yumリポジトリサーバ経由でRPMパッケージを適用します。
オプション
基本オプション
運用操作部品を実行する対象のホスト名またはIPアドレスです。
管理サーバで運用操作部品を実行する場合、以下を指定します。
IPv4の場合: 'localhost'または'127.0.0.1'
IPv6の場合: 'localhost'または'::1'
ホスト名またはIPアドレスを省略した場合、引数エラーとなります。
ホスト名またはIPアドレスの文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。
適用する修正パッチの方法です。
wsus:Windows Server Update Services(WSUS)経由で修正を適用します。
yum :Yellow dog Updater, Modified(yum)リポジトリサーバ経由で修正を適用します。
mod :mod_targetdirオプションで指定されたディレクトリ内に格納されている修正パッチを適用します。
省略した場合は、以下の設定となります。なお、大文字／小文字は区別しません。
ostypeオプションでWindowsが指定された場合: wsus
ostypeオプションでLinuxが指定された場合: yum
wsus、yumまたはmod以外が指定された場合、引数エラーとなります。
patch_kindの文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
修正パッチを適用するサーバ上に、修正パッチを格納するディレクトリの絶対パスです。
patch_kindオプションでmodが指定された場合だけ必須です。
patch_kindオプションでmod以外が指定された場合、mod_targetdirの指定は無効になります。
文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。
修正パッチが格納されているホスト名またはIPアドレスです。
patch_kindオプションでmodが指定された場合だけ必須です。
patch_kindオプションでmod以外が指定された場合、mod_stragehostの指定は無効になります。
管理サーバに修正パッチが格納されている場合、以下を指定します。
IPv4の場合: 'localhost'または'127.0.0.1'
IPv6の場合: 'localhost'または'::1'
ホスト名またはIPアドレスの文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。
mod_stragehostで指定した修正パッチが格納されているサーバ上のディレクトリの絶対パスです。
patch_kindオプションでmodが指定された場合だけ必須です。
patch_kindオプションでmod以外が指定された場合、mod_stragedirの指定は無効になります。
文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。
注：mod_stragedir内に格納する修正パッチは、Microsoft Download Centerからダウンロードしてきた形式のまま格納してください。
＜例＞
<mod_stragedir>\Windows6.0-KB2522422-x86.msu
適用する修正パッチのファイル名です。
patch_kindオプションでmodが指定された場合だけ必須です。
patch_kindオプションでmod以外が指定された場合、mod_patchfilename指定は無効になります。
修正パッチファイルの個数の上限は、100個です。それより大きい場合、引数エラーとなります。
重複した修正パッチファイルを指定した場合、引数エラーとなります。
指定は、CSV形式です。複数指定の例は、“3.18 入力パラメーターを複数指定する場合の注意事項”を参照してください。
指定したファイル名の順番で、修正パッチを適用します。
拡張オプション
適用する修正パッチ番号(KBから始まる番号)または、更新プログラムID(8文字の英数字-4文字の英数字-4文字の英数字-4文字の英数字-12文字の英数字。"-"はハイフン、英文字は、AからFの範囲で指定。大文字 小文字は区別しません。)です。
修正パッチ番号と更新プログラムIDを混在して指定した場合、引数エラーとなります。
patch_kindオプションでwsusを指定した場合だけ有効です。
patch_kindオプションでwsus以外が指定された場合、wsus_patchnoの指定は無効になります。
修正パッチ番号または、更新プログラムIDの個数の上限は、100個です。それより大きい場合、引数エラーとなります。
重複した修正パッチ番号または、更新プログラムIDを指定した場合、引数エラーとなります。
指定は、CSV形式です。複数指定の例は、“3.18 入力パラメーターを複数指定する場合の注意事項”を参照してください。
wsus_patchnoを指定すると、wsus_typeの指定は無効になります。
省略した場合は、wsus_typeの指定に従います。
(例) 修正パッチ番号としてKB000001～KB000005の5つを指定する場合
"KB000001","KB000002","KB000003","KB000004","KB000005"
wsusを使用して適用する修正パッチの種類です。
patch_kindオプションでwsusを指定し、かつ、wsus_patchnoを省略した場合だけ有効です。
patch_kindオプションでwsus以外が指定された場合、wsus_typeの指定は無効になります。
wsus_patchnoオプションで修正パッチ番号または、更新プログラムIDを指定した場合は無効となります。
software：ソフトウェアの修正パッチを適用します。
driver：ドライバの修正パッチを適用します。
all：ソフトウェアとドライバのすべての修正パッチを適用します。
省略した場合は、allとなります。なお、大文字／小文字は区別しません。
software、driverまたは、all以外が指定された場合は引数エラーとなります。
適用するパッケージ名です。
patch_kindオプションでyumを指定した場合だけ有効です。
patch_kindオプションでyum以外が指定された場合、yum_packagenameの指定は無効になります。
パッケージ名の個数の上限は、100個です。それより大きい場合、引数エラーとなります。
重複したパッケージ名を指定した場合、引数エラーとなります。
指定は、CSV形式です。複数指定の例は、“3.18 入力パラメーターを複数指定する場合の注意事項”を参照してください。
指定するパッケージ名によって適用順序を入れ替えて実行します。
省略した場合は、適用可能なパッケージすべてが対象となります。
＜名前＞.＜アーキテクチャ＞
(例) パッケージ名としてopenssh.i386、openssh-askpass.i386、openssh-clients.i386、openssh-server.i386の4つの最新のパッチを適用する場合
"openssh.i386","openssh-askpass.i386","openssh-clients.i386","openssh-server.i386"
＜名前＞/＜エポック番号＞:＜バージョン番号＞/＜リリース番号＞/＜アーキテクチャ＞
または、
＜名前＞/＜バージョン番号＞/＜リリース番号＞/＜アーキテクチャ＞
(例) パッケージ名としてopenssh.i386、openssh-askpass.i386、openssh-clients.i386、openssh-server.i386の4つの特定のバージョン、リリースのパッチを適用する場合
"openssh/4.3p2/41.el5/i386","openssh-askpass/4.3p2/41.el5/i386","openssh-clients/4.3p2/41.el5/i386","openssh-server/4.3p2/41.el5/i386"
修正パッチを適用するホストのOS種別です。
Windows、Linuxを指定します。なお、大文字／小文字は区別しません。
OS種別の入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得したOS種別の値をSystemwalker Runbook Automationが自動的に設定します。
Windows、Linux以外が指定された場合は、引数エラーとなります。
patch_kindでwsusまたはmodを指定し、Windows以外を指定した場合は、引数エラーとなります。
patch_kindでyumを指定し、Linux以外を指定した場合は、引数エラーとなります。
OS種別の文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
修正パッチを適用するホストへSSHを利用して接続するユーザー名です。
接続ユーザー名および接続に必要なパスワードの入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した接続ユーザー名の値をSystemwalker Runbook Automationが自動的に設定します。
ファイル転送基盤を利用して接続する場合は、接続ユーザー名は以下のようになり変更できません。このため、ユーザー名を指定しても無効になります。
業務サーバがWindowsの場合: Administrator
業務サーバがLinuxの場合: root
接続ユーザー名の文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
修正パッチを適用するホストへSSHを利用して接続するユーザーのパスワードを指定します。
接続ユーザー名および接続に必要なパスワードの入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した接続パスワードの値をSystemwalker Runbook Automationが自動的に設定します。
ファイル転送基盤を利用して接続する場合は、パスワードを指定しても無効になります。
接続に必要なパスワードの文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
修正パッチが格納されているホストのOS種別です。
Windows、Linux、Solarisを指定します。なお、大文字／小文字は区別しません。
OS種別の入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得したOS種別の値をSystemwalker Runbook Automationが自動的に設定します。
OS種別の文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
修正パッチが格納してあるホストへSSHを利用して接続するユーザー名です。
接続ユーザー名および接続に必要なパスワードを省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した接続ユーザー名の値をSystemwalker Runbook Automationが自動的に設定します。
ファイル転送基盤を利用して接続する場合は、mod_strage_usernameは以下のようになり変更できません。このため、ユーザー名を指定しても無効になります。
修正パッチが格納してあるホストがWindowsの場合: Administrator
修正パッチが格納してあるホストがLinux、Solarisの場合: root
接続ユーザー名の文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
修正パッチが格納してあるホストへSSHを利用して接続するユーザーのパスワードを指定します。
接続ユーザー名および接続に必要なパスワードを省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した接続パスワードの値をSystemwalker Runbook Automationが自動的に設定します。
ファイル転送基盤を利用して接続する場合は、パスワードを指定しても無効になります。
接続に必要なパスワードの文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
運用操作部品を実行する対象のホストでコマンドを実行するユーザー名です。
実行ユーザー名の入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した管理者ユーザーの値をSystemwalker Runbook Automationが自動的に設定します。CMDBに登録されていない場合は、接続ユーザー名で実行します。
ostypeオプションでLinuxを指定した場合だけ有効です。
ostypeオプションでLinux以外が指定された場合、patchexecusernameの指定は無効になります。
実行ユーザー名の文字列の上限は、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 | サーバの再起動が必要かつ、修正パッチの適用が失敗しました。 | ||
173 | 適用前の準備中に、yumコマンドの実行に失敗しました。 | ||
187 | 運用操作部品による操作を実施する際、業務サーバにネットワーク接続(SSH)時の認証に失敗しました。 または、運用操作部品による操作を実施する際に、業務サーバとの通信処理（ファイル転送基盤）で異常が発生しました。実行結果にファイル転送基盤のエラーコードを出力します。エラーコードについては、“3.22 ファイル転送基盤の詳細コード”を参照してください。 | ||
188 | RBAエージェントが導入されていない業務サーバに対して運用操作部品による操作を実施中に、業務サーバとのネットワーク通信(SSH)が切断されました。 | ||
189 | 運用操作部品による操作を実施する際、業務サーバにネットワーク接続(SSH)できませんでした。 または、運用操作部品による操作を実施する際に、業務サーバとの通信処理（ファイル転送基盤）で異常が発生しました。実行結果にファイル転送基盤のエラーコードを出力します。エラーコードについては、“3.22 ファイル転送基盤の詳細コード”を参照してください。 | ||
197 | オプションの内容に誤りがありました。 | ||
－ | － | 201 | 運用操作部品の実行がタイムアウトしました。 |
202 | 運用操作部品が実行されませんでした。運用操作部品を実行するための設定に問題があります。 | ||
203 | 運用操作部品を正常に実行できませんでした。管理サーバの環境に問題があります。 | ||
205 | 運用操作部品が実行されませんでした。運用操作部品の入力情報の指定に問題があります。 | ||
206 | 運用操作部品を正常に実行できませんでした。運用操作部品の出力情報の指定に問題があります。 | ||
207 | 運用操作部品が実行されませんでした。運用操作部品が管理サーバに登録されていない可能性があります。 | ||
208 | 運用操作部品の実行途中に自動運用プロセスのリカバリが行われたため、自動運用プロセスを中止状態にしました。 |
出力情報
変数 | 意味 |
|---|---|
message |
|
execution_result | 修正パッチの適用結果が格納されます。 以下の形式で出力します。 [RC(修正パッチ適用リターンコード)],[PatchNo(適用修正番号)],[Message(メッセージ)] |
failure_patchlist | 修正パッチの適用が失敗、中断または、適用可能な一覧に存在しなかった場合、以下がCSV形式で出力されます。オプションに指定した順番で出力されます。 notexist_patchlistに出力する修正パッチも含まれます。
|
notexist_patchlist | 指定した修正パッチが、wsusが返す適用可能な一覧に存在しなかった場合、以下がCSV形式で出力されます。オプションに指定した順番で出力されます。 修正パッチ番号または、更新プログラムID |
returnCode | 復帰値を設定します。 |
execution_resultの出力形式は以下です。
[RC(修正パッチ適用リターンコード)],[PatchNo(適用修正番号)],[Message(メッセージ)]
wsus_patchnoオプションに以下の指定で修正パッチを適用した場合
"KB000001","KB000002","KB000003","KB000004","KB000005"
以下が出力されます。
＜例＞
RC,PatchNo,Message
0,KB000001,"The update was installed normally."
2,KB000002,"Failed to install the update."
3,KB000003,"Installation of the update was interrupted."
4,KB000004,"The specified update does not exist."
1,KB000005,"The update was installed normally, however it is necessary to restart the server."
RC(修正パッチ適用リターンコード)と、Message(メッセージ)の意味は以下のとおりです。
0: 修正パッチは正常に適用されました。
1: 修正パッチは正常に適用されましたが、サーバの再起動が必要です。
2: 修正パッチの適用に失敗しました。
3: 修正パッチの適用が中断しました。
4：指定された修正パッチが存在しません。
patch_kindの値がwsusの場合は、PatchNo(適用修正番号)には修正パッチ番号または、更新プログラムIDが出力されます。
patch_kindの値がmodの場合は、PatchNo(適用修正番号)には修正パッチのファイル名が出力されます。
yum_packagenameオプションに以下の指定で修正パッチを適用した場合
"openssh.i386","openssh-askpass.i386","openssh-clients.i386","openssh-server.i386"
以下が出力されます。
＜例＞
RC,PatchNo,Message
0,openssh.i386,"The update was installed normally."
1,openssh-askpass.i386,"Failed to install the update."
2,openssh-clients.i386,"Installation of the update was interrupted."
3,openssh-server.i386,"The specified update does not exist."
RC(修正パッチ適用リターンコード)と、Message(メッセージ)の意味は以下のとおりです。
0: 修正パッチは正常に適用されました。
1: 修正パッチの適用に失敗しました。
2: 修正パッチの適用が中断しました。
3：指定された修正パッチが存在しません。
patch_kindの値がyumの場合は、PatchNo(適用修正番号)にはパッケージ名が出力されます。
注意事項
本運用操作部品は、hostnameまたは、mod_stragehostに管理サーバ以外の情報を入力した場合、ファイル転送基盤またはSSH通信を利用して動作を実現しています。少なくともどちらか片方では通信可能となるように設定してください。各通信方法の注意事項については、“3.17 各通信方法の注意事項”を参照してください。
本運用操作部品は、適用する修正パッチ数が多い場合や通信の速度の影響により、実行に時間がかかる場合があります。このためtimeoutに適切な値を設定してください。
すでに適用済みの修正パッチを適用した場合は、正常終了になります。
修正パッチファイル名には、半角英数字、空白文字、全角文字と以下の記号だけを利用してください。
利用可能な記号：「!」「~」「_」「-」「.」
各オプションには、半角カナ文字および以下の記号は使用しないでください。半角カナ文字および以下の記号を使用すると、運用操作部品の実行に失敗する場合があります。
「～」「￡」「―」「∥」「￠」「￢」「￣」「￥」「〃」
業務サーバにRBAエージェントが未導入の場合は、mod_targetdirオプションおよびmod_stragedirオプションに日本語を指定すると運用操作部品の操作結果は保証されません。日本語を指定する場合は業務サーバにRBAエージェントを導入してください。
復帰値の確認は、Webコンソールで行います。詳細については、“Systemwalker Runbook Automation 運用ガイド”の“運用操作部品の実行状況・実行結果を確認する”を参照してください。
201～208の復帰値が出力された場合は自動運用プロセスが中止状態またはエラー状態となり、以下の場所にエラーメッセージが出力されます。
管理サーバのイベントログ(管理サーバがWindows(R)の場合)
管理サーバのシスログ(管理サーバがLinuxの場合)
BPMNのカスタムメッセージ
上記いずれかの場所でメッセージを確認し、適切な対処を実施してください。メッセージの詳細については、“Systemwalker Runbook Automation メッセージ集”を参照してください。
修正パッチを適用するサーバがWindowsの場合の注意事項
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
修正パッチを適用するサーバにおいて、環境変数windirに指定されているフォルダのWindowsUpdate.logファイルに、修正パッチ適用の実行状況がOSによって記録されます。
運用操作部品の実行がタイムアウトとなった場合、運用プロセスは中断しますが、修正パッチ適用処理は継続します。この場合、修正パッチを適用するサーバのWindowsUpdate.logファイルを参照してパッチ適用処理が完了しているか確認してください。WindowsUpdate.logファイルに「reboot required = Yes」と記録されている場合は、サーバの再起動が必要です。パッチ適用処理が完了したあとにパッチを適用したサーバを再起動してください。
修正パッチを適用するサーバがLinuxの場合の注意事項
運用前に、yumリポジトリサーバの環境が必要となります。yumリポジトリサーバはイントラネット内に構築します。
yumリポジトリサーバ経由で修正パッチを適用する場合、事前に修正パッチを適用するサーバにyumの設定を行ってください。yumの設定は、以下の手順で実施します。
yumリポジトリサーバに関する設定ファイルを、以下のディレクトリに作成します。
/etc/yum.repos.d
設定ファイルは、以下の内容で作成します。
"VT"、"Cluster"、"ClusterStorage"は必要であれば記述します。基本パッケージのみ必要な場合は不要です。
[Server] <=リポジトリID（任意の名前でかつ、一意にします） name=RHELT Server <=リポジトリの意味がわかるような任意の名前にします baseurl=ftp://10.0.0.1/pub/i386/RHEL5.1/Server <=アクセスするyumリポジトリサーバのディレクトリ（FTP） enabled=1 <=パッケージ取得の有効/無効（0の場合は取得しない） gpgcheck=0 <=GPGキーのチェックをするかどうか（yum.confを上書き） [VT] name=RHEL5 VT baseurl=ftp://10.0.0.1/pub/i386/RHEL5.1/VT enabled=1 gpgcheck=0 [Cluster] baseurl=ftp://10.0.0.1/pub/i386/RHEL5.1/Cluster enabled=1 gpgcheck=0 [ClusterStorage] baseurl=ftp://10.0.0.1/pub/i386/RHEL5.1/ClusterStorage enabled=1 gpgcheck=0
適用前の準備として、以下の4種類のコマンドを実行します。コマンドの実行時にエラーとなった場合、復帰値173のエラーとなります。
yum clean all （キャッシュのクリア） yum list installed （インストール済みパッケージ一覧の取得） yum list updates （アップデート可能一覧） yum deplist （依存関係の取得）
修正パッチを適用するサーバにおいて、適用する前に過去の修正パッチのキャッシュをクリアします。
修正パッチを適用するサーバにおいて、/var/logディレクトリのyum.logファイルに、修正パッチ適用の実行状況が記録されます。
指定したパッケージに依存関係があるパッケージが存在する場合、同時に依存関係のパッケージの修正パッチも適用します。そのため、依存関係のパッケージは事前にインストールしてください。依存関係のパッケージの修正パッチの適用結果は、/var/logディレクトリのyum.logファイルを確認してください。
運用操作部品の実行がタイムアウトとなった場合、運用プロセスは中断しますが、修正パッチ適用処理は継続します。この場合、修正パッチを適用するサーバのyum.logファイルを参照してパッチ適用処理が完了しているか確認してください。
yumリポジトリサーバのソフトウェア条件は以下を対象としています。以下のソフトウェアにインストール済のyumパッケージを利用します。
Red Hat Enterprise Linux 5.0～5.7
Red Hat Enterprise Linux 6.0～6.2
