5.11.36 仮想サーバのスナップショット削除
機能
VMware vSphere環境で，仮想サーバの指定されたスナップショットを削除します。
現在使用中のスナップショットを削除対象に指定した場合は，スナップショット作成元の仮想ディスクに変更が確定されます。
削除するスナップショットは，スナップショットのIDか，スナップショット名を指定することができます。
スナップショットのIDを指定する場合は，スナップショットのID(VMware.snapshotIdプロパティ)を使用してください。
スナップショット名を指定する場合，スナップショット名(VMware.snapshotNameプロパティ)を使用してください。
両方を指定した場合，またはどちらも指定しない場合，部品は異常終了します。
この部品が前提とするサーバを次に示します。
・vCenterサーバ
VMware vCenter Serverがインストールされているサーバです。
・ESXサーバ
VMware vSphere ESXi(またはVMware ESX Server)がインストールされているサーバです。
・vCenter操作サーバ(実行対象サーバ)
VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。
・仮想サーバ
vCenterサーバおよびVMware vSphere ESXi(またはVMware ESX Server)によって管理されている仮想サーバです。
利用場面
スナップショットの削除に使用できます。
前提条件
【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。
【システム内前提製品】
JP1/Automatic Operation 11-10以降
【実行対象システム内前提製品】
(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)仮想サーバの前提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)
・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)
【実行対象システム内前提製品の使用条件】
(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。
(2)仮想サーバに関する条件
・同一のvCenterの管理下において，仮想サーバ名が重複しないこと。
・同一の仮想サーバ上において，スナップショット名が重複しないこと。
・仮想サーバに，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
・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0
【実行対象サーバ内前提製品の稼働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)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。
(2)Rawディスク，RDM物理モードディスク，および独立ディスクが設定されている仮想サーバを対象にしないでください。
実行権限
(1)VMware vCenter Serverに接続するユーザーに，システム管理者ロールの権限が必要です。
バージョン
02.11.00
部品のタグ
Delete VM Snapshot,VMware vSphere
タスクログに表示される部品の名称
vsphereRemoveSnapshot
戻り値
|
戻り値 |
説明 |
|---|---|
|
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.vmName |
仮想サーバ名 |
仮想サーバの名称を指定します(VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。 |
− |
入力 |
○ |
|
VMware.snapshotId |
スナップショットのID |
スナップショットのIDを指定します。 |
− |
入力 |
△ |
|
VMware.snapshotName |
スナップショット名 |
スナップショットの名称を指定します。 |
− |
入力 |
△ |
|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
|
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |