5.11.46 仮想サーバへの仮想ディスク追加
機能
VMware vSphere環境で，仮想サーバに仮想ディスクを追加します。
追加した仮想ディスクは，次のどちらかの方法でSCSIコントローラに接続します。
・既存のSCSIコントローラに接続する
SCSIコントローラの追加要否(VMware.createScsiControllerプロパティ)にfalseを指定した場合，既存のSCSIコントローラに接続します。
仮想ディスクを接続するSCSIコントローラを指定するときは，SCSIコントローラ名(VMware.attachedScsiControllerNameプロパティ)を指定してください。
SCSIコントローラ名の指定を省略した場合，任意のSCSIコントローラに仮想ディスクを接続します。
・新規にSCSIコントローラを追加し，追加したSCSIコントローラに接続する
SCSIコントローラの追加要否(VMware.createScsiControllerプロパティ)にtrueを指定した場合，新規にSCSIコントローラを追加し，追加したSCSIコントローラに接続します。
この場合，次のプロパティをどちらも指定してください。
- SCSIバスの共有(VMware.scsiBusSharingModeプロパティ)
- SCSIコントローラタイプ(VMware.scsiControllerTypeプロパティ)
この部品が前提とするサーバを次に示します。
・vCenterサーバ
VMware vCenter Serverがインストールされているサーバです。
・vCenter操作サーバ(実行対象サーバ)
VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。
・仮想サーバ
vCenterサーバおよびVMware vSphere ESXによって管理されている仮想サーバです。
・データストア名(VMware.dataStoreNameプロパティ)について次に示します。
仮想ディスクを作成するデータストアの名称を指定します。
RDMディスクを作成する場合は，マッピングファイルの格納先データストアを指定します。
・仮想ディスクの容量(VMware.vHardDiskCapacityプロパティ)について次に示します。
作成する仮想ディスクの容量(単位:GB)を指定します。仮想ディスクの種別がFlatの場合，必ず指定してください。
RDMディスクを作成する場合は，このプロパティを指定する必要はありません。
・仮想ディスクの種別(VMware.vHardDiskTypeプロパティ)について次に示します。
作成する仮想ディスクの種別をRawVirtual，RawPhysical，Flatのどれかで指定します。指定を省略した場合，仮想ディスクの種別はFlatになります。
RDMディスクを仮想モードで接続する場合はRawVirtualを，RDMディスクを物理モードで接続する場合はRawPhysicalを，仮想ディスクを接続する場合はFlatを指定してください。
利用場面
仮想サーバの新規構築時やディスク増設時など，仮想サーバにデータディスクを追加する場合に使用できます。
前提条件
【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働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)仮想ディスクの追加対象となる仮想サーバの電源がOFFになっていること。
(2)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。
(3)仮想サーバ名はvCenterサーバ内で一意になっていること。
(4)対象となる仮想サーバに，VMwareToolsがインストールされていること。
【実行対象サーバ内前提製品】
・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)仮想サーバに追加した仮想ディスクの初期化は行いません。必要に応じて仮想サーバのOSにログインし，ディスクの初期化を実行してください。
(3)VMware vSphere PowerCLIのバージョンが5.1 Release2未満の場合，仮想ディスクのフォーマット種別(VMware.vDiskStorageFormatプロパティ)に"EagerZeroedThick"は指定できません。指定した場合，この部品は異常終了します。
(4)SCSIコントローラの追加要否(VMware.createScsiControllerプロパティ)にtrueを指定した場合，SCSIバスの共有(VMware.scsiBusSharingModeプロパティ)とSCSIコントローラタイプ(VMware.scsiControllerTypeプロパティ)を両方とも指定してください。どれか1つでも指定しない場合，この部品は異常終了します。
(5)SCSIコントローラの追加要否(VMware.createScsiControllerプロパティ)にtrueを指定し，戻り値27で部品が異常終了した場合，任意のSCSIコントローラに接続された仮想ディスクが作成されているおそれがあります。その場合，タスクログのエラーメッセージに従い原因を取り除いたあと，仮想ディスクを削除し，再度部品を実行してください。なお，仮想ディスクの削除が必要な場合は，タスクログにKNAE06478-Eのメッセージが出力されます。
(6)この部品を同一の仮想サーバに対し，複数同時に実行しないでください。同時に実行した場合，この部品は異常終了するか，仮想ディスク名(VMware.createdVHardDiskNameプロパティ)，SCSIコントローラ名(VMware.connectedScsiConNameプロパティ)に不正な値が格納されるおそれがあります。
実行権限
(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。
対象とする仮想サーバに対して「新規ディスクの追加/既存ディスクの追加」の権限を持つロール，またはシステム管理者ロール
バージョン
02.11.00
部品のタグ
Modify VM,VMware vSphere
タスクログに表示される部品の名称
vsphereAddVDisk
戻り値
|
戻り値 |
説明 |
|---|---|
|
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.vmName |
仮想サーバ名 |
仮想サーバの名称を指定します(VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。 |
− |
入力 |
○ |
|
VMware.dataStoreName |
データストア名 |
データストアの名称を指定します。 |
− |
入力 |
○ |
|
VMware.vHardDiskCapacity |
仮想ディスクの容量 |
作成する仮想ディスクの容量（単位:GB）を整数値で指定します。 |
− |
入力 |
△ |
|
VMware.vHardDiskType |
仮想ディスクの種別 |
作成する仮想ディスクの種別をRawVirtual, RawPhysical, Flatのどれかで指定します。 |
− |
入力 |
△ |
|
VMware.deviceName |
LUNのデバイス名 |
仮想ディスクを作成するLUNのデバイス名を指定します。仮想ディスクの種別でRawVirtualまたはRawPhysicalを選択した場合だけ指定します（例:/vmfs/devices/disks/naa.XXX）。 |
− |
入力 |
△ |
|
VMware.vDiskStorageFormat |
仮想ディスクのフォーマット種別 |
仮想ディスクのフォーマット種別を指定します。指定可能な値は，Thin，Thick，EagerZeroedThickです。仮想ディスクをシンプロビジョニングでフォーマットする場合はThinを，シックプロビジョニング(Lazy Zeroed)でフォーマットする場合はThickを，シックプロビジョニング(Eager Zeroed)でフォーマットする場合はEagerZeroedThickを指定してください。このプロパティは仮想ディスクの種別がFlatのときだけ指定してください。 |
− |
入力 |
△ |
|
VMware.attachedScsiControllerName |
SCSIコントローラ名 |
仮想ディスクを接続するSCSIコントローラ名を指定してください(例:SCSI コントローラ X)。省略した場合，仮想ディスクは任意のSCSIコントローラに接続されます。SCSIコントローラの追加要否にtrueを指定する場合，このプロパティの指定は無視されます。 |
− |
入力 |
△ |
|
VMware.createScsiController |
SCSIコントローラの追加要否 |
作成する仮想ディスクに対し，新規にSCSIコントローラを割り当てるか否かを指定します。新規にSCSIコントローラを追加する場合はtrueを，追加しない場合はfalseを指定してください。このプロパティを指定する場合は，SCSIバスの共有およびSCSIコントローラタイプも必ず併せて指定してください。 |
false |
入力 |
○ |
|
VMware.scsiBusSharingMode |
SCSIバスの共有 |
SCSIコントローラのバス共有方式を指定します。指定可能な値は，NoSharing，Virtual，Physicalです。SCSI接続されている仮想ディスクを仮想サーバ間で共有しない場合はNoSharingを，同じESXサーバ上の仮想サーバ間で共有する場合はVirtualを，すべてのESXサーバ上の仮想サーバ間で共有する場合はPhysicalを指定してください。 |
− |
入力 |
△ |
|
VMware.scsiControllerType |
SCSIコントローラタイプ |
SCSIコントローラのタイプを指定します。指定可能な値は，VirtualLsiLogicSAS，VirtualLsiLogic，ParaVirtual，VirtualBusLogicです。タイプを"LSI Logic SAS"にする場合はVirtualLsiLogicSASを，"LSI Logic パラレル"にする場合はVirtualLsiLogicを，"VMware 準仮想化"にする場合はParaVirtualを，"BusLogic パラレル"にする場合はVirtualBusLogicを指定してください。 |
− |
入力 |
△ |
|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
|
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |
|
VMware.createdVHardDiskName |
仮想ディスク名 |
新規に追加した仮想ディスクの名前が格納されます。 |
− |
出力 |
△ |
|
VMware.connectedScsiConName |
SCSIコントローラ名 |
新規に追加した仮想ディスクと接続するSCSIコントローラの名前が格納されます。 |
− |
出力 |
△ |