5.9.11 Add virtual disk to virtual server
Function
Adds a virtual disk to a virtual server in a VMware vSphere environment.
This plugin assumes the following servers:
• vCenter server
This is a server on which VMware vCenter Server is installed.
• vCenter control server (Execution target server)
This is a server on which VMware vSphere PowerCLI is installed.The plugin is sent to this server by JP1/AO and then is executed.
• Virtual server
This is a virtual server managed by the vCenter server and VMware vSphere ESX.
Use situation
You use this plugin to add a data disk to a virtual server, such as when you configure a new virtual server and add a disk.
Prerequisites
For the latest support information about [Required product in the System]/[Required products on the execution target server]/[Prerequisite product OS running in the execution target server], see the release notes.
[Required product in the System]
Job Management Partner 1/Automatic Operation 10-00 or later
[Required products on the execution target system]
(1) Prerequisite product of vCenter Server
• VMware vCenter Server 5.5, 5.1, 5.0, 4.1, 4.0
(2) VMware vSphere ESXi (or VMware ESX Server) that manages the virtual servers
• VMware vSphere ESXi 5.5, 5.1, 5.0 or VMware ESX Server 4.1, 4.0
(3) Prerequisite OS running in the virtual servers
The following OSs are supported, based on the required products for the vCenter server and the required products for the VMware vSphere ESXi (or VMware ESX Server)/vCenter control server that manages the virtual server.
• Windows Server 2003, Standard Edition/Enterprise Edition (x86/x64) SP1 or later,Windows Server 2003 R2, Standard Edition/Enterprise Edition (x86/x64)
• Windows Server 2008 Standard/Enterprise (x86/x64),Windows Server 2008 R2 Standard/Enterprise/Datacenter
• Windows Server 2012 Standard/Datacenter,Windows Server 2012 R2 Standard/Datacenter
• Red Hat Enterprise Linux 5 Advanced Platform (x86), Red Hat Enterprise Linux 5 (x86), Red Hat Enterprise Linux 5 Advanced Platform (AMD/Intel 64), Red Hat Enterprise Linux 5 (AMD/Intel 64)
• Red Hat Enterprise Linux Server 6 (32-bit x86),Red Hat Enterprise Linux Server 6 (64-bit x86_64)
[Usage conditions for required products in the execution target system]
(1) The power to the virtual server on which the virtual disk is to be added is off.
(2) VMware vSphere ESXi (or VMware ESX Server) is managed by VMware vCenter Server.
(3) The virtual server name is unique among the vCenter servers.
(4) VMwareTools has been installed on the target virtual server.
[Required products on the execution target server]
• VMware vSphere PowerCLI 5.5 Release1, 5.1 Release2, 5.0
[Prerequisite product OS running in the execution target server]
• Windows Server 2008 R2 Standard/Enterprise/Datacenter
• Windows Server 2012 Standard/Datacenter
Cautions
(1) This plugin does not initialize the virtual disk that is added to the virtual server. If necessary, log in to the virtual server's OS to initialize the disk.
Execution privilege
(1) The user who will be connecting to VMware vCenter Server must have the following permissions:
Role with new or existing disk addition permissions for the target virtual server or system administrator role
Version
01.00.04
Category
VirtualMachine/vSphere
Plug-in name displayed in the task log
vsphereAddVDisk
Return code
0: Normal
21: Error (invalid environment) Command cannot be found (error detected in the plugin script)
23: Error (invalid environment) Required environment is invalid
27: Error (check task logs for the nature of error)
41: Error (error detected in plugin) Missing property (error detected in plugin script)
Property list
The following table lists the properties:
|
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
|---|---|---|---|---|---|
|
VMware.vCenterServerName |
VMware vCenter server name |
Specify the host name or IP address of the VMware vCenter server. You cannot specify an IPv6 address. |
-- |
Input |
R |
|
VMware.userName |
User name for VMware vCenter Server connection |
Specify the user name to use when connecting to the VMware vCenter server. |
-- |
Input |
R |
|
VMware.password |
Password for VMware vCenter Server connection |
Specify the password to use when connecting to the VMware vCenter server. |
-- |
Input |
R |
|
VMware.portNumber |
Port number for VMware vCenter Server connection |
Specify the port number to use when connecting to the VMware vCenter server (specifically, the port number of the VMware vCenter server's Web service). If you omit this property, the default value of the VMware vCenter server applies. |
443 |
Input |
O |
|
VMware.protocol |
Protocol for VMware vCenter Server connection |
Specify the protocol to use when connecting to the VMware vCenter server. |
https |
Input |
R |
|
VMware.vmName |
Virtual server name |
Specify the name of the virtual server. This name is used to represent the virtual server in VMware vCenter server. It is not used as a host name by the OS. |
-- |
Input |
R |
|
VMware.dataStoreName |
Datastore name |
Specify the datastore name. |
-- |
Input |
R |
|
VMware.vHardDiskCapacity |
Virtual disk capacity |
Specify (in GB) the capacity of the virtual disk to be created. |
-- |
Input |
O |
|
VMware.vHardDiskType |
Virtual hard disk type |
Specify RawVirtual, RawPhysical, Flat, or Unknown as the type of the virtual disk to be created. |
-- |
Input |
O |
|
VMware.deviceName |
LUN device name |
Specifies the LUN device name where the virtual disk is to be created. Specified only if RawVirtual or RawPhysical is selected as the type of the virtual disk (example: /vmfs/devices/disks/naa.XXX). |
-- |
Input |
O |
|
plugin.destinationHost |
Host name of the execution target server |
Specify the host name or IP address of the server on which this plugin will be executed. IPv6 addresses are not supported. |
-- |
Input |
R |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |