5.3.10 仮想サーバの情報一覧取得
機能
この部品は,Hyper-Vサーバの管理下にある仮想サーバの情報一覧をCSV形式でファイルに出力します。
出力ファイルのエンコード形式は,Hyper-Vサーバのシステムのデフォルトエンコーディングです。
この部品が前提とするサーバを次に示します。
・Hyper-Vサーバ(実行対象サーバ)
Hyper-Vがインストールされているサーバです。
・仮想サーバ
Hyper-Vによって管理されている仮想サーバです。
出力するCSVファイルの項目を次に示します。
項目はコンマ区切りで出力します。
(a) Hyper-Vサーバ名 (ヘッダー名:ComputerName)
(b) 仮想サーバ名 (ヘッダー名:VMName)
(c) 仮想サーバの状態 (ヘッダー名:State)
(d) 仮想サーバのCPU使用率(%) (ヘッダー名:CPUUsage)
(e) 仮想サーバのメモリ割り当て(MB)※1 (ヘッダー名:MemoryAssigned)
(f) 仮想サーバの稼働時間 (ヘッダー名:Uptime)
(g) 仮想サーバの状況 (ヘッダー名:Status)
(h) 仮想サーバの仮想プロセッサ数 (ヘッダー名:ProcessorCount)
(i) 仮想サーバのスタートアップRAM(MB) (ヘッダー名:MemoryStartup)
(j) 仮想サーバの動的メモリの有効 (ヘッダー名:DynamicMemoryEnabled)
※1:仮想サーバが実際に使用しているメモリの容量(MB)です。
利用場面
Hyper-Vサーバの管理下にある仮想サーバの情報を取得する場合に使用できます。
前提条件
【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については,リリースノートを参照してください。
【実行対象サーバ内前提製品】
(1)Hyper-Vサーバの前提製品
・Windows Server 2016 Hyper-V
(2)仮想サーバの前提OS
・Windows Server 2016 Standard/Datacenter
ただし,Server Core/Nano Serverインストール環境は除く。
【実行対象サーバ内前提製品の稼働OS】
・Windows Server 2016 Standard/Datacenter
ただし,Server Core/Nano Serverインストール環境は除く。
【実行対象サーバ内前提製品の使用条件】
なし。
注意事項
(1)指定したファイル名が既に存在する場合,既存のファイルを上書きします。そのため,指定したファイル名に誤りがないか,十分に確認してください。
(2)指定したパスのフォルダが存在しない場合は,そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。
(3)同名の仮想サーバが2つ以上ある場合,出力するCSVファイルでは仮想サーバを特定できません。
バージョン
02.12.00
部品のタグ
Gather VM information,Hyper-V 2016
タスクログに表示される部品の名称
hyperv2016OutputVmSpec
戻り値
戻り値 |
説明 |
---|---|
0 |
正常 |
12 |
異常(ユーザーミス) プロパティ不正 |
23 |
異常(環境不正) 前提環境不正 |
27 |
異常(エラー内容はタスクログで確認) |
41 |
異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知) |
プロパティ一覧
プロパティ一覧を次の表に示します。
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
---|---|---|---|---|---|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
hyperv.vmInfoListOutputFileName |
仮想サーバ情報一覧出力ファイル名 |
仮想サーバ情報一覧を出力するファイル名をフルパスで指定します。 |
− |
入力 |
○ |
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
− |