5.11.32 仮想サーバのクローン削除
機能
VMware vSphere環境において仮想サーバのクローンを削除します。
この部品が前提とするサーバを次に示します。
・vCenterサーバ
VMware vCenter Serverがインストールされているサーバです。
・vCenter操作サーバ
VMware vSphere PowerCLIがインストールされているサーバです。
・クローン対象となる仮想サーバ
vCenterサーバおよびVMware vSphere ESXi(またはVMware ESX Server)によって管理されている仮想サーバです。
・クローン
クローン対象となる仮想サーバの複製です。クローン名は仮想サーバの複製の名称です。
利用場面
クローンを削除する場合に使用します。
前提条件
【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については,リリースノートを参照してください。
【システム内前提製品】
JP1/Automatic Operation 11-10以降
【実行対象システム内前提製品】
(1)vCenterサーバの前提製品
・VMware vCenter Server 6.5,6.0,5.5,5.1,5.0,4.1,4.0
(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)
・VMware vSphere ESXi 6.5,6.0,5.5,5.1,5.0 またはVMware ESX Server 4.1,4.0
(3)仮想サーバの前提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
・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)
・CentOS 6 (64-bit x86_64)
・CentOS 7 (64-bit x86_64)
【実行対象システム内前提製品の使用条件】
(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。
(2)同一のvCenterの管理下において,クローン名が重複しないこと。既存の仮想サーバ名とも重複しないこと。
(3)クローンの電源状態がOFFであること。
(4)対象となる仮想サーバに,VMware Toolsがインストールされていること。
【実行対象サーバ内前提製品】
・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
・PackageManagementがインストールされていること。
【実行対象サーバ内前提製品の稼働OS】
・Windows Server 2008 R2 Standard/Enterprise/Datacenter
・Windows Server 2012 Standard/Datacenter,Windows Server 2012 R2 Standard/Datacenter
・Windows Server 2016 Standard/Datacenter
注意事項
(1)クローン削除中は,他のサービスから当該クローンの操作を行わないでください。クローン削除に失敗するおそれがあります。vCenterサーバからも直接操作を行わないでください。
(2)クローン名とクローン作成元の仮想サーバ名に同じ名称を指定すると,クローンの削除を行ないません。
(3)クローン名とクローン作成元の仮想サーバ名は大文字と小文字を区別しない。
実行権限
(1)VMware vCenter Serverに接続するユーザーに,システム管理者ロールの権限が必要です。
バージョン
02.11.00
部品のタグ
Delete Cloned VM,VMware vSphere
タスクログに表示される部品の名称
vsphereDeleteClone
戻り値
戻り値 |
説明 |
---|---|
0 |
正常 |
12 |
異常(ユーザーミス) プロパティ不正 |
23 |
異常(環境不正) 前提環境不正 |
27 |
異常(エラー内容はタスクログで確認) |
41 |
異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知) |
プロパティ一覧
プロパティ一覧を次の表に示します。
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
---|---|---|---|---|---|
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で設定されているデフォルト値で接続します。 |
443 |
入力 |
△ |
VMware.protocol |
VMware vCenter Server接続用プロトコル |
VMware vCenter Serverに接続するためのプロトコルを指定します。 |
https |
入力 |
○ |
VMware.cloneName |
クローン名 |
削除するクローンの名称を指定します(VMware vCenter Serverにおけるクローンの表示名称です。OS上のホスト名ではありません)。 |
− |
入力 |
○ |
VMware.vmName |
クローン作成元の仮想サーバ名 |
クローン作成元の仮想サーバの名称を指定します(VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。誤ってクローン作成元を削除しないため確認用として指定してください。この仮想サーバは削除されません。クローン作成元の仮想サーバが既に削除されているか,名称が不明の場合は,仮想サーバ削除サービスを使用してクローンを削除して下さい。 |
− |
入力 |
○ |
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |