5.6.3 Windows更新プログラムのインストール
機能
Windows環境で,Windows Update機能を使用して更新プログラムを自動インストールします。
インストール対象は,実行対象サーバに対し次の条件をすべて満たす更新プログラムです。
・Microsoftが自動更新の対象としている更新プログラム
・未インストールの更新プログラム
・インストール済みソフトウェアの更新プログラム
ただし,次の更新プログラムをインストール対象から除外します。
・除外リストに指定した更新プログラム番号に完全一致した更新プログラム
・ユーザー入力が必要な更新プログラム(例:サービスパック等)
除外リストは,Windows.updateProgramExclusionListプロパティにインストールしない更新プログラム番号(例:KB9999999)を指定します。更新プログラム番号が複数ある場合は,コンマ区切りで指定します。コンマも含めて1024バイト以下で指定してください。
Windows Updateを実施したあとは,Windows.updateResultOutputFolderプロパティに指定する実行対象サーバ上のフォルダに,除外リスト,更新プログラムの検索結果,インストールした更新プログラム,インストールできなかった更新プログラムの一覧をテキストファイルとして出力します。ファイル名は「<年月日時分>.txt」です。
例:201312312345.txt
・出力されるファイルには,次の項目が記述されます。
(a)ホスト名
(b)除外リスト
(c)検索結果の更新プログラムタイトル一覧
検索結果は,1更新プログラムごとに1行記述されます。
各プログラムごとに,その更新プログラムがadding(インストール対象)なのか,skipping(インストール非対象)なのかが記述されています。
skippingの場合は,ユーザー入力が必要なためなのか,除外リストによって除外されたためなのか,その理由が記述されています。
(d)更新プログラムインストール全体のResultCode
ResultCodeの意味は次のとおりです。
0:インストール処理未実行 1:インストール処理中 2:正常終了 3:処理は完了したが一部エラー 4:インストール処理エラー 5:インストール処理キャンセル
(e)インストールした更新プログラムタイトル一覧
各プログラムごとに,その更新プログラムのResultCodeが記述されています。
(f)再起動要否
再起動が必要(Necessary)か不必要(Unnecessary)かが記述されています。
(g)スクリプト自体の終了コード
スクリプト自体の終了コードが出力されます。
終了コードの意味は次のとおりです。
0:正常 27:異常(エラー内容はタスクログで確認) 41:異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)
(h)検索されたが除外された,もしくはインストール処理がエラーになったためインストールできなかった更新プログラムのタイトル
実行対象サーバのOSがWindowsの場合,この部品の実行にはAdministratorユーザ(ビルトインAdministratorアカウント)が必要です。実行対象サーバにAdministratorユーザ(ビルトインAdministratorアカウント)が存在しない場合,または,無効の場合,システムアカウントで実行を行う部品「Windows更新プログラムのインストール(SYSTEM)」を実行してください。
利用場面
Windowsの更新プログラムが発行された際に,更新プログラムを適用する場合に使用できます。
前提条件
【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については,リリースノートを参照してください。
また、OSおよび製品について略称を用いています。対象とするOSおよび製品については「はじめに」を参照してください。
【実行対象サーバ内前提製品】
なし。
【実行対象サーバの稼働OS】
(1) Windows Server
【実行対象サーバの使用条件】
(1)実行対象サーバが起動していること。
(2)実行対象サーバがプロキシサーバーを使用せずにWindows Updateを実施するためのWebサイトにアクセスできること。
(3)実行対象サーバがブラウザーからWindows Updateを実施するためのWebサイトにアクセスできること。
(4)次に示すサービスが起動していること。
・Windows Update
注意事項
(1)自動的に再起動する更新プログラムをインストールした場合,Windowsによって実行対象サーバが自動で再起動します。
(2)この部品を同一の実行対象サーバに対して多重実行しないでください。
実行権限
ビルトイン Administrator
バージョン
02.00.00
部品のタグ
Configure OS,Windows
タスクログに表示される部品の名称
osWindowsUpdate
戻り値
戻り値 |
説明 |
---|---|
0 |
正常 |
27 |
異常(エラー内容はタスクログで確認) |
41 |
異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知) |
プロパティ一覧
プロパティ一覧を次の表に示します。
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
---|---|---|---|---|---|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
Windows.updateResultOutputFolder |
結果情報ファイル出力先フォルダ名 |
Windows Update実施のあとにインストール結果情報を出力するための,実行対象サーバ上のフォルダ名をフルパスで指定します。 |
− |
入力 |
○ |
Windows.updateProgramExclusionList |
Windows Updateの適用除外リスト |
Windows Updateの適用を除外する更新プログラム番号を指定します。複数の番号を指定する場合はコンマで区切ります。 |
− |
入力 |
△ |
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
○ |
Windows.rebootNecessity |
再起動要否 |
更新の結果,再起動が必要かどうかを示す値(Necessary:必要,Unnecessary:不必要)が格納されます。 |
− |
出力 |
○ |