5.4.8 仮想サーバの情報一覧取得
機能
この部品は，Hyper-Vサーバの管理下にある仮想サーバの情報一覧をCSV形式でファイルに出力します。
出力ファイルのエンコード形式は，Hyper-Vサーバのシステムのデフォルトエンコーディングです。
この部品が前提とするサーバを次に示します。
・Hyper-Vサーバ(実行対象サーバ)
Hyper-Vがインストールされているサーバです。
・仮想サーバ
Hyper-Vによって管理されている仮想サーバです。
出力するCSVファイルの項目を次に示します。
項目はコンマ区切りで出力します。
(a) Hyper-Vサーバ名 (ヘッダー名：HostName)
(b) 仮想サーバ名 (ヘッダー名：VmName)
(c) 仮想サーバの状態※1 (ヘッダー名：VmState)
(d) 仮想サーバのCPU数※2 (ヘッダー名：NumCpu)
(e) 仮想サーバのメモリ容量(MB)※3 (ヘッダー名：MemoryMB)
※1：仮想サーバの状態の詳細については，JP1/AOマニュアルの「Hyper-Vが管理している仮想サーバの状態一覧」を参照してください。
※2：CPU数の値は，仮想サーバに割り当てられている仮想プロセッサの数です。
※3：仮想サーバに動的メモリを設定している場合は，スタートアップRAMの値です。
利用場面
Hyper-Vサーバの管理下にある仮想サーバの情報を取得する場合に使用できます。
前提条件
【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。
【システム内前提製品】
JP1/Automatic Operation 11-00以降
【実行対象サーバ内前提製品】
(1)Hyper-Vサーバの前提製品
・Windows Server 2008 R2 Hyper-V
ただし，Server Coreインストール環境は除く。
(2)仮想サーバの前提OS
・Windows Server 2008 R2 Standard/Enterprise/Datacenter
ただし，Server Coreインストール環境は除く。
【実行対象サーバ内前提製品の稼働OS】
・Windows Server 2008 R2 Standard/Enterprise/Datacenter
【実行対象サーバ内前提製品の使用条件】
(1)仮想サーバ名はHyper-Vサーバ内で一意であること。
バージョン
02.00.00
部品のタグ
Gather VM information,Hyper-V 2008
タスクログに表示される部品の名称
hypervOutputVmSpec
戻り値
|
戻り値 |
説明 |
|---|---|
|
0 |
正常 |
|
12 |
異常(ユーザーミス) プロパティ不正 |
|
23 |
異常(環境不正) 前提環境不正 |
|
27 |
異常(エラー内容はタスクログで確認) |
|
28 |
異常(取得情報なし) 仮想サーバが一台も存在しない |
|
41 |
異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知) |
プロパティ一覧
プロパティ一覧を次の表に示します。
|
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
|---|---|---|---|---|---|
|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
|
common.fileName |
ファイル名 |
ファイル名をフルパスで指定します。 |
− |
入力 |
○ |
|
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |