5.8.11 仮想サーバの情報一覧取得
機能
OpenStack管理下の，指定したプロジェクトに含まれるインスタンス情報一覧をCSV形式でファイルに出力します。
このドキュメント内で使用しているOpenStackに関する用語は，OpenStackのDashboardで使用されている表示名です。OpenStackに関する用語を次に示します。
・Identity
OpenStackではIdentityまたはKeyStoneと記載されています。
・プロジェクト
OpenStackではプロジェクトまたはテナントと記載されています。
この部品が前提とするサーバを次に示します。
・OpenStackサーバ
OpenStackがインストールされているサーバです。
・KVMサーバ
Kernel-based Virtual Machineがインストールされているサーバです。
・OpenStack操作サーバ(実行対象サーバ)
OpenStackサーバにREST-APIを実行するサーバです。
・インスタンス
OpenStackサーバおよびKVMによって管理されているインスタンスです。一般的な仮想サーバのことです。
出力するCSVファイルの項目を次に示します。
項目はコンマ区切りで出力します。
(a) Hypervisorのホスト名 (ヘッダー名：HostName)
(b) インスタンス名 (ヘッダー名：InstanceName)
(c) イメージ名 (ヘッダー名：ImageName)
(d) インスタンスの状態 (ヘッダー名：Status)
(e) インスタンスのCPU数※ (ヘッダー名：NumCpu)
(f) インスタンスのメモリ容量(MB)※ (ヘッダー名：MemoryMB)
(g) インスタンスのディスクサイズ(GB)※ (ヘッダー名：TotalDiskOfFlavorGB)
(h) フレーバー名 (ヘッダー名：FlavorName)
注※：「インスタンスのCPU数」「インスタンスのメモリ容量(MB)」「インスタンスのディスクサイズ(GB)」はインスタンスの起動時に指定したフレーバーの情報です。
利用場面
この部品は，OpenStack環境でインスタンス情報を取得する場合に使用できます。
前提条件
【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。
【システム内前提製品】
JP1/Automatic Operation 11-00以降
【実行対象サーバ内前提製品】
(1)OpenStackサーバの前提製品
・OpenStack
(2)インスタンスを管理する仮想化環境
・Kernel-based Virtual Machine
・VMware vCenter Server
・VMware vSphere ESXi
(3)OpenStack操作サーバ(実行対象サーバ)
・Microsoft .Net Framework 3.5以降
(4)インスタンスの前提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)
【実行対象サーバ内前提製品の稼動OS】
(1)OpenStack操作サーバ(実行対象サーバ)
・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ファイルではインスタンスを特定できません。
実行権限
(1)OpenStackサーバにログインするユーザーに次の権限が必要です。
admin権限
バージョン
02.00.00
部品のタグ
Gather VM information,OpenStack
タスクログに表示される部品の名称
openstackOutputVmSpec
戻り値
|
戻り値 |
説明 |
|---|---|
|
0 |
正常 |
|
12 |
異常(ユーザーミス) プロパティ不正 |
|
23 |
異常(環境不正) 前提環境不正 |
|
27 |
異常(エラー内容はタスクログで確認) |
|
41 |
異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知) |
プロパティ一覧
プロパティ一覧を次の表に示します。
|
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
|---|---|---|---|---|---|
|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名または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.vmInfoListOutputFileName |
インスタンス情報一覧出力ファイル名 |
インスタンス情報一覧を出力するファイル名をフルパスで指定します。 |
− |
入力 |
○ |
|
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |