3.13.4 仮想サーバの情報一覧取得
機能
このサービステンプレートは，OpenStack管理下のKVM環境の，指定したプロジェクトに含まれるインスタンス情報一覧を取得します。
このドキュメント内で使用しているOpenStackに関する用語は，OpenStackのDashboardで使用されている表示名です。OpenStackに関する用語を次に示します。
・Identity
OpenStackではIdentityまたはKeyStoneと記載されています。
・プロジェクト
OpenStackではプロジェクトまたはテナントと記載されています。
このサービステンプレートが前提とするサーバを次に示します。
・OpenStackサーバ
OpenStackがインストールされているサーバです。
・KVMサーバ
Kernel-based Virtual Machineがインストールされているサーバです。
・OpenStack操作サーバ
OpenStackサーバにREST-APIを実行するサーバです。
・インスタンス
OpenStackサーバおよびKVMによって管理されているインスタンスです。一般的な仮想サーバのことです。
処理の概要を次に示します。
(1) インスタンスの情報一覧を取得します。
1. インスタンスの情報一覧をCSV形式で指定されたリモートのファイルに出力します。出力ファイルのエンコード形式は，OpenStack操作サーバのデフォルトエンコーディングです。
(2) リモートの一時ファイルを指定されたローカルの出力ファイルに転送します。
(3) リモートの一時ファイルを削除します。
出力するCSVファイルの項目を次に示します。
項目はコンマ区切りで出力します。
(a) Hypervisorのホスト名 (ヘッダー名：HostName)
(b) インスタンス名 (ヘッダー名：InstanceName)
(c) イメージ名 (ヘッダー名：ImageName)
(d) インスタンスの状態 (ヘッダー名：Status)
(e) インスタンスのCPU数※ (ヘッダー名：NumCpu)
(f) インスタンスのメモリ容量(MB)※ (ヘッダー名：MemoryMB)
(g) インスタンスのディスクサイズ(GB)※ (ヘッダー名：TotalDiskOfFlavorGB)
(h) フレーバー名 (ヘッダー名：FlavorName)
注※：「インスタンスのCPU数」「インスタンスのメモリ容量(MB)」「インスタンスのディスクサイズ(GB)」はインスタンスの起動時に指定したフレーバーの情報です。
前提条件
【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。
【システム内前提製品】
JP1/Automatic Operation 12-00以降
【サービステンプレート実行システム内前提製品】
(1)OpenStackサーバの前提製品
・OpenStack
(2)インスタンスを管理する仮想化環境
・Kernel-based Virtual Machine
・VMware vCenter Server
・VMware vSphere ESXi
(3)OpenStack操作サーバ
・Microsoft .Net Framework 3.5以降
【サービステンプレート実行システム内前提製品の稼働OS】
(1)インスタンスの前提OS
・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)
・Red Hat Enterprise Linux Server 7 (64-bit x86_64)
(2)OpenStack操作サーバの前提OS
・Windows Server 2008 R2 Standard/Enterprise/Datacenter
・Windows Server 2012 Standard/Datacenter
・Windows Server 2012 R2 Standard/Datacenter
ただし，Server Coreインストール環境は除く。
【サービステンプレート実行システム内前提製品の使用条件】
なし。
注意事項
(1)リモートおよびローカルに指定するファイル名が既に存在する場合，既存のファイルを上書きします。また，リモート側のファイルは削除します。そのため，指定したファイル名に誤りがないか，十分に確認してください。
(2)リモートに指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。
(3)同名のインスタンスが2つ以上ある場合，出力するCSVファイルではインスタンスを特定できません。
実行権限
admin権限
バージョン
02.00.00
タグ
Gather VM information,OpenStack
プロパティ一覧
プロパティに設定されているプロパティグループの一覧を次に示します。
|
プロパティグループ |
説明 |
初期表示 |
|---|---|---|
|
クラウド基盤環境情報 |
OpenStackの情報を指定してください。 |
表示されます。 |
|
出力ファイル格納情報 |
出力ファイルの格納先を指定してください。 |
表示されます。 |
|
インスタンス情報 |
インスタンスの情報を指定してください。 |
表示されます。 |
［サービス設定］画面に表示されるプロパティの一覧を次に示します。
- （凡例）
-
○：プロパティの指定は必須です。
△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。
|
プロパティキー |
プロパティ名 |
説明 |
入出力種別 |
共有設定 |
必須区分 |
プロパティグループ |
|---|---|---|---|---|---|---|
|
openstack.targetHost |
OpenStack操作サーバのホスト名 |
OpenStack操作サーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
入力 |
無効 |
○ |
クラウド基盤環境情報 |
|
openstack.identityServerHostName |
Identityサーバのホスト名 |
Identityサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
入力 |
無効 |
○ |
クラウド基盤環境情報 |
|
openstack.userName |
Identityサーバにログインするためのユーザー名 |
Identityサーバにログインするためのユーザー名を指定します。 |
入力 |
無効 |
○ |
クラウド基盤環境情報 |
|
openstack.password |
Identityサーバにログインするためのパスワード |
Identityサーバにログインするためのパスワードを指定します。 |
入力 |
無効 |
○ |
クラウド基盤環境情報 |
|
openstack.protocol |
Identityサーバ接続用プロトコル |
Identityサーバに接続するためのプロトコルを指定します。 |
入力 |
無効 |
○ |
クラウド基盤環境情報 |
|
openstack.portNumber |
Identityサーバ接続用ポート番号 |
Identityサーバに接続するためのポート番号を指定します。 |
入力 |
無効 |
○ |
クラウド基盤環境情報 |
|
openstack.projectName |
プロジェクト名 |
プロジェクトの名称を指定します。 |
入力 |
無効 |
○ |
インスタンス情報 |
［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。
|
プロパティキー |
プロパティ名 |
説明 |
入出力種別 |
共有設定 |
必須区分 |
プロパティグループ |
|---|---|---|---|---|---|---|
|
openstack.listOutputFileNameRemote |
出力ファイル名(リモート) |
インスタンス情報をOpenStack操作サーバに出力する際の一時ファイル名をフルパスで指定します。 |
入力 |
無効 |
○ |
出力ファイル格納情報 |
|
openstack.listOutputFileNameLocal |
出力ファイル名(ローカル) |
インスタンス情報を取得するローカルサーバのファイル名をフルパスで指定します。 |
入力 |
無効 |
○ |
出力ファイル格納情報 |
［サービス設定］画面に表示されるプロパティの入力制限を次に示します。
|
プロパティキー |
入力可能文字 |
|---|---|
|
openstack.targetHost |
256文字以内の半角英数字および「.」，「-」。 |
|
openstack.identityServerHostName |
256文字以内の半角英数字および「.」，「-」。 |
|
openstack.userName |
64文字以内の半角英数字。 |
|
openstack.password |
256文字以内の半角英数字。 |
|
openstack.protocol |
次の値のどれかを選択する。 http,https |
|
openstack.portNumber |
1〜65535の整数値。 |
|
openstack.projectName |
80文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。 |
［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。
|
プロパティキー |
入力可能文字 |
|---|---|
|
openstack.listOutputFileNameRemote |
256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」，「'」，「[」，「]」，「`」および末尾の「¥」を除く。 |
|
openstack.listOutputFileNameLocal |
256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。 |
フロー仕様詳細
フロー仕様詳細を次の表に示します。
|
階層 |
[タスク詳細]画面での表示名 |
ステップ名 |
部品 |
||
|---|---|---|---|---|---|
|
部品名 |
説明 |
エラー時の回復方法 |
|||
|
1 |
仮想サーバの情報一覧取得 |
仮想サーバの情報一覧取得 |
仮想サーバの情報一覧取得 |
仮想サーバの情報一覧をOpenStack操作サーバの一時ファイルに出力します。 |
エラーの原因を取り除いたあと，サービスを再実行してください。 |
|
2 |
ファイル転送 |
ファイル転送 |
ファイル転送部品 |
リモートの一時ファイルをローカルの指定された出力ファイルに転送します。 |
エラーの原因を取り除いたあと，サービスを再実行してください。 |
|
3 |
一時ファイル削除 |
一時ファイル削除 |
ファイル削除 |
リモートの一時ファイルを削除します。 |
エラーの原因を取り除いたあと，サービスを再実行してください。 |