3.16.10 仮想サーバ情報一覧取得
機能
仮想サーバ情報の一覧を取得します。
・ESXサーバ名を指定しなかった場合は，指定されたvCenterサーバ内のすべてのESXサーバに存在する仮想サーバの情報を取得します。
・ESXサーバ名を指定した場合は，指定されたESXサーバに存在する仮想サーバの情報だけ取得します。
このサービステンプレートが前提とするサーバを次に示します。
・vCenterサーバ
VMware vCenter Serverがインストールされているサーバです。
・vCenter操作サーバ
VMware vSphere PowerCLIがインストールされているサーバです。
・仮想サーバ
vCenterサーバおよびVMware vSphere ESXによって管理されている仮想サーバです。
処理の概要を次に示します。
(1) 仮想サーバ情報の一覧をCSV形式で指定されたリモートの一時ファイルに出力します。
(2) リモートの一時ファイルを指定されたローカルの出力ファイルに転送します。
(3) リモートの一時ファイルを削除します。
出力するCSVファイルの項目を次に示します。
項目はコンマ区切りで出力します。
(a) ESXサーバ名 (ヘッダー名：HostName)
(b) 仮想サーバ名 (ヘッダー名：VMName)
(c) 仮想サーバの電源状態 (ヘッダー名：PowerState)
(d) 仮想サーバのCPU数※1 (ヘッダー名：NumCpu)
(e) 仮想サーバのメモリ容量(MB) (ヘッダー名：MemoryMB)
※1：CPU数の値はVMware vCenter Serverのバージョンによって異なります。
・VMware vCenter Serverのバージョンが4.1以前の場合，仮想プロセッサ数の値です。
・VMware vCenter Serverのバージョンが5.0以降の場合，コアの合計数(仮想ソケット数×ソケットあたりのコアの数)の値です。
前提条件
【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。
【システム内前提製品】
JP1/Automatic Operation 12-00以降
【サービステンプレート実行システム内前提製品】
(1)vCenterサーバの前提製品
・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0
(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)
・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0
(3)vCenter操作サーバの前提製品
・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0
・VMware PowerCLI 6.5 Release1
・VMware PowerCLI 6.5.1，6.5.4
・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0
【サービステンプレート実行システム内前提製品の稼働OS】
(1)仮想サーバの前提OS
vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。
・Windows Server 2008 R2 Standard/Enterprise/Datacenter
・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter
・Windows Server 2016 Standard/Datacenter
・Windows Server 2019 Standard/Datacenter
・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)(vCenter4.1以降。vCenter4.0では未サポート)
・Red Hat Enterprise Linux Server 7 (64-bit x86_64)
・Red Hat Enterprise Linux Server 8 (64-bit x86_64)
・CentOS 6 (64-bit x86_64)
・CentOS 7 (64-bit x86_64)
・CentOS 8 (64-bit x86_64)
(2)vCenter操作サーバの前提OS
・Windows Server 2008 R2 Standard/Enterprise/Datacenter
・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter
・Windows Server 2016 Standard/Datacenter
・Windows Server 2019 Standard/Datacenter
【サービステンプレート実行システム内前提製品の使用条件】
(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。
(2)仮想マシン名はvCenterサーバ内で一意になっていること。
(3)対象となる仮想サーバに，VMware Toolsがインストールされていること。
注意事項
(1)リモートおよびローカルに指定するファイル名が既に存在する場合，既存のファイルを上書きします。また，リモート側のファイルは削除します。そのため，指定したファイル名に誤りがないか，十分に確認してください。
(2)リモートに指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。
実行権限
(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。
読み取り専用ロール
バージョン
02.11.00
タグ
Gather VM information,VMware vSphere
プロパティ一覧
プロパティに設定されているプロパティグループの一覧を次に示します。
|
プロパティグループ |
説明 |
初期表示 |
|---|---|---|
|
仮想システム環境情報 |
VMware vCenter Serverの情報を指定してください。 |
表示されます。 |
|
仮想環境情報 |
一覧を取得する仮想環境の情報を指定してください。 |
表示されます。 |
［サービス設定］画面に表示されるプロパティの一覧を次に示します。
- （凡例）
-
○：プロパティの指定は必須です。
△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。
|
プロパティキー |
プロパティ名 |
説明 |
入出力種別 |
共有設定 |
必須区分 |
プロパティグループ |
|---|---|---|---|---|---|---|
|
vmware.targetHost |
VMware vCenter操作サーバのホスト名 |
VMware vCenter Serverを操作するサーバ(vSphere PowerCLIインストール済みサーバ)のホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
入力 |
無効 |
○ |
仮想システム環境情報 |
|
vmware.vCenterServerName |
vCenterサーバ名 |
VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
入力 |
無効 |
○ |
仮想システム環境情報 |
|
vmware.userName |
VMware vCenter Serverに接続するためのユーザー名 |
VMware vCenter Serverに接続するためのユーザー名を指定します。 |
入力 |
無効 |
○ |
仮想システム環境情報 |
|
vmware.password |
VMware vCenter Serverに接続するためのパスワード |
VMware vCenter Serverに接続するためのパスワードを指定します。 |
入力 |
無効 |
○ |
仮想システム環境情報 |
|
vmware.portNumber |
VMware vCenter Server接続用ポート番号 |
VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。 |
入力 |
無効 |
△ |
仮想システム環境情報 |
|
vmware.protocol |
VMware vCenter Server接続用プロトコル |
VMware vCenter Serverに接続するためのプロトコルを指定します。 |
入力 |
無効 |
○ |
仮想システム環境情報 |
［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。
|
プロパティキー |
プロパティ名 |
説明 |
入出力種別 |
共有設定 |
必須区分 |
プロパティグループ |
|---|---|---|---|---|---|---|
|
vmware.vmHostName |
ESXサーバ名 |
VMware vCenter Serverが管理する［ホストおよびクラスタ］に表示されるESXサーバ名を指定します。 |
入力 |
無効 |
△ |
仮想環境情報 |
|
vmware.listOutputFileNameRemote |
出力ファイル名(リモート) |
仮想サーバ情報をVMware vCenter操作サーバに出力する際の一時ファイル名をフルパスで指定します。 |
入力 |
無効 |
○ |
仮想環境情報 |
|
vmware.listOutputFileNameLocal |
出力ファイル名(ローカル) |
仮想サーバ情報を取得するローカルサーバのファイル名をフルパスで指定します。 |
入力 |
無効 |
○ |
仮想環境情報 |
［サービス設定］画面に表示されるプロパティの入力制限を次に示します。
|
プロパティキー |
入力可能文字 |
|---|---|
|
vmware.targetHost |
256文字以内の半角英数字および「.」，「-」。 |
|
vmware.vCenterServerName |
256文字以内の半角英数字および「.」，「-」。 |
|
vmware.userName |
512文字以内の半角英数字および半角記号。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「/」，「:」，「=」，「,」，「+」，「%」を除く。 |
|
vmware.password |
127文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。 |
|
vmware.portNumber |
1〜65535の整数値。 |
|
vmware.protocol |
次の値のどれかを選択する。 http,https |
［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。
|
プロパティキー |
入力可能文字 |
|---|---|
|
vmware.vmHostName |
256文字以内の半角英数字および「.」，「-」。 |
|
vmware.listOutputFileNameRemote |
256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」，「'」，「[」，「]」，「`」および末尾の「¥」を除く。 |
|
vmware.listOutputFileNameLocal |
256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。 |
フロー仕様詳細
フロー仕様詳細を次の表に示します。
|
階層 |
[タスク詳細]画面での表示名 |
ステップ名 |
部品 |
||
|---|---|---|---|---|---|
|
部品名 |
説明 |
エラー時の回復方法 |
|||
|
1 |
仮想サーバ情報一覧取得 |
仮想サーバ情報一覧取得 |
仮想サーバ情報一覧取得 |
仮想サーバ情報の一覧をVMware vCenter操作サーバの一時ファイルに出力します。 |
エラーの原因を取り除いたあと，サービスを再実行してください。 |
|
2 |
ファイル転送 |
ファイル転送 |
ファイル転送部品 |
リモートの一時ファイルを指定されたローカルの出力ファイルに転送します。 |
エラーの原因を取り除いたあと，サービスを再実行してください。 |
|
3 |
一時ファイル削除 |
一時ファイル削除 |
ファイル削除 |
リモートの一時ファイルを削除します。 |
エラーの原因を取り除いたあと，サービスを再実行してください。 |