3.11.5 仮想サーバの情報一覧取得
機能
このサービステンプレートは，Hyper-V環境の仮想サーバの情報一覧を取得します。
このサービステンプレートが前提とするサーバを次に示します。
・Hyper-Vサーバ
Hyper-Vがインストールされているサーバです。
・仮想サーバ
Hyper-Vによって管理されている仮想サーバです。
処理の概要を次に示します。
(1) 仮想サーバの情報一覧をCSV形式で指定されたリモートの一時ファイルに出力します。出力ファイルのエンコード形式は，Hyper-Vサーバのシステムのデフォルトエンコーディングです。
(2) リモートの一時ファイルを指定されたローカルの出力ファイルに転送します。
(3) リモートの一時ファイルを削除します。
出力する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)です。
前提条件
【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。
【システム内前提製品】
JP1/Automatic Operation 12-00以降
【サービステンプレート実行システム内前提製品】
(1)Hyper-Vサーバの前提製品
・Windows Server 2016 Hyper-V
【サービステンプレート実行システム内前提製品の稼働OS】
(1)Hyper-Vサーバの前提OS
・Windows Server 2016 Standard/Datacenter
ただし，Server Core/Nano Serverインストール環境は除く。
(2)仮想サーバの前提OS
・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter
・Windows Server 2016 Standard/Datacenter
ただし，Server Core/Nano Serverインストール環境は除く。
【サービステンプレート実行システム内前提製品の使用条件】
なし。
注意事項
(1)リモートおよびローカルに指定するファイル名が既に存在する場合，既存のファイルを上書きします。また，リモート側のファイルは削除します。そのため，指定したファイル名に誤りがないか，十分に確認してください。
(2)リモートに指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。
(3)同名の仮想サーバが2つ以上ある場合，出力するCSVファイルでは仮想サーバを特定できません。
バージョン
02.12.00
タグ
Gather VM information,Hyper-V 2016
プロパティ一覧
プロパティに設定されているプロパティグループの一覧を次に示します。
|
プロパティグループ |
説明 |
初期表示 |
|---|---|---|
|
仮想システム環境情報 |
Hyper-Vの情報を指定してください。 |
表示されます。 |
|
出力ファイル格納情報 |
出力ファイルの格納先を指定してください。 |
表示されます。 |
［サービス設定］画面に表示されるプロパティの一覧を次に示します。
- （凡例）
-
○：プロパティの指定は必須です。
△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。
|
プロパティキー |
プロパティ名 |
説明 |
入出力種別 |
共有設定 |
必須区分 |
プロパティグループ |
|---|---|---|---|---|---|---|
|
hyperv.targetHost |
Hyper-Vサーバのホスト名 |
Hyper-Vサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
入力 |
無効 |
○ |
仮想システム環境情報 |
［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。
|
プロパティキー |
プロパティ名 |
説明 |
入出力種別 |
共有設定 |
必須区分 |
プロパティグループ |
|---|---|---|---|---|---|---|
|
hyperv.listOutputFileNameRemote |
出力ファイル名(リモート) |
仮想サーバ情報をHyper-Vサーバに出力する際の一時ファイル名をフルパスで指定します。 |
入力 |
無効 |
○ |
出力ファイル格納情報 |
|
hyperv.listOutputFileNameLocal |
出力ファイル名(ローカル) |
仮想サーバ情報をローカルサーバに格納する際のファイル名をフルパスで指定します。 |
入力 |
無効 |
○ |
出力ファイル格納情報 |
［サービス設定］画面に表示されるプロパティの入力制限を次に示します。
|
プロパティキー |
入力可能文字 |
|---|---|
|
hyperv.targetHost |
256文字以内の半角英数字および「.」，「-」。 |
［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。
|
プロパティキー |
入力可能文字 |
|---|---|
|
hyperv.listOutputFileNameRemote |
256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」，「'」，「[」，「]」，「`」および末尾の「¥」を除く。 |
|
hyperv.listOutputFileNameLocal |
256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。 |
フロー仕様詳細
フロー仕様詳細を次の表に示します。
|
階層 |
[タスク詳細]画面での表示名 |
ステップ名 |
部品 |
||
|---|---|---|---|---|---|
|
部品名 |
説明 |
エラー時の回復方法 |
|||
|
1 |
仮想サーバの情報一覧取得 |
仮想サーバの情報一覧取得 |
仮想サーバの情報一覧取得 |
仮想サーバの情報一覧をHyper-Vサーバの一時ファイルに出力します。 |
エラーの原因を取り除いたあと，サービスを再実行してください。 |
|
2 |
ファイル転送 |
ファイル転送 |
ファイル転送部品 |
リモートの一時ファイルをローカルの指定された出力ファイルに転送します。 |
Hyper-Vサーバ上の一時ファイルをローカルサーバに転送し，そのあとHyper-Vサーバ上の一時ファイルを手動で削除してください。 |
|
3 |
一時ファイル削除 |
一時ファイル削除 |
ファイル削除 |
リモートの一時ファイルを削除します。 |
Hyper-Vサーバ上の一時ファイルを手動で削除してください。 |