5.11.9 データストア削除
機能
VMware vSphere環境において,VMware vSphere ESXi(またはVMware ESX Server)からデータストアを削除します。
この部品が前提とするサーバを以下に示します。
・vCenterサーバ
VMware vCenter Serverがインストールされているサーバです。
・ESXサーバ
VMware vSphere ESXi(またはVMware ESX Server)がインストールされているサーバです。
・vCenter操作サーバ(実行対象サーバ)
VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによりこのサーバに部品が転送され,実行されます。
利用場面
仮想サーバ削除によりデータストアが不用になった場合などの契機で,データストアを削除する際に利用できます。
前提条件
【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については,リリースノートを参照してください。
【システム内前提製品】
JP1/Automatic Operation 10-00以降
【実行対象システム内前提製品】
(1)vCenterサーバの前提製品
・VMware vCenter Server 6.0,5.5,5.1,5.0,4.1,4.0
(2)ESXサーバの前提製品
・VMware vSphere ESXi 6.0,5.5,5.1,5.0 またはVMware ESX Server 4.1,4.0
【実行対象システム内前提製品の使用条件】
(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。
【実行対象サーバ内前提製品】
・VMware vSphere PowerCLI 6.0 Release1,5.8 Release1,5.5 Release2,5.5 Release1,5.1 Release2,5.0
【実行対象サーバ内前提製品の稼働OS】
・Windows Server 2008 R2 Standard/Enterprise/Datacenter
・Windows Server 2012 Standard/Datacenter,Windows Server 2012 R2 Standard/Datacenter
注意事項
(1)使用中の仮想サーバが削除対象のデータストアに格納されていないことを確認してください。
実行権限
(1)VMware vCenter Serverに接続するユーザーに,以下の権限が必要です。
対象とするESXサーバに対して「データストア−データストアの削除」の権限を持つロール,またはシステム管理者ロール
バージョン
01.00.04
カテゴリ
VirtualMachine/vSphere
タスクログに表示される部品の名称
vsphereDeleteDatastore
戻り値
戻り値 |
説明 |
---|---|
0 |
正常 |
21 |
異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知) |
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.vmHostName |
ESXサーバ名 |
VMware vCenter Serverが管理する[ホストおよびクラスタ]に表示されるESXサーバ名を指定します。 |
− |
入力 |
○ |
VMware.dataStoreName |
データストア名 |
削除するデータストアの名称を指定します。 |
− |
入力 |
○ |
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |