3.8.1 Add virtual server (LU creation and data store creation)
Function
Create an LU on the storage system, and then create a data store in VMware vSphere ESXi (or VMware ESX Server, hereinafter "ESX").
This service template assumes the following servers:
• vCenter server
This is a server on which VMware vCenter Server is installed.
• vCenter control server
This is a server on which VMware vSphere PowerCLI is installed.
• ESX server
Server on which VMware vSphere ESXi (or VMware ESX Server) is installed
• HDvM server
This is a server on which Hitachi Device Manager Software is installed.
• HDvM CLI server
This is a server on which Hitachi Device Manager Software CLI is installed.
Perform the following:
(1) From the HDvM CLI server, create a virtual volume (DP volume) on the storage system.
(2) From the HDvM CLI server, add the created volume to the ESX host group.
(3) From the vCenter control server, have ESX recognize the added H-LUN.
(4) From the vCenter control server, add a data store to ESX.
(5) From the vCenter control server, set the FC path to the added data store to "Preferred".
If DP pool usage is over the warning threshold, you cannot create a DP volume.
Specify the capacity of the DP volume in GB.
Prerequisites
For the latest support information about [Required product for the system]/[Required products for the service template execution system]/[Prerequisite product OS running in the system executing the service template], see the release notes.
[Required product for the system]
Job Management Partner 1/Automatic Operation 10-50 or later
[Required products for the service template execution system]
(1) Required product for the vCenter server
• VMware vCenter Server 5.5, 5.1, 5.0, 4.1, or 4.0
(2) VMware vSphere ESXi (or VMware ESX Server) that manages virtual servers
• VMware vSphere ESXi 5.5, 5.1 or 5.0 or VMware ESX Server 4.1 or 4.0
(3) Required product for the vCenter control server
• VMware vSphere PowerCLI 5.5 Release1, 5.1 Release2, 5.0
(4) The product listed below must have already been set up on the servers in the system. Also, Hitachi Device Manager Software CLI must have already been set up on the HDvM CLI server.
• Hitachi Device Manager Software 07-00 or later
(5) One of the products listed below must have already been set up as the system's storage system (it must be an FC-SAN storage):
• Hitachi Adaptable Modular Storage 2000
• Hitachi Universal Storage Platform
• Hitachi Virtual Storage Platform
• Hitachi Unified Storage 100
• Hitachi Unified Storage VM
• Hitachi Virtual Storage Platform G1000
[Prerequisite product OS running in the system executing the service template]
(1) Required OS for the vCenter control server
• Windows Server 2008 R2 Standard/Enterprise/Datacenter
• Windows Server 2012 Standard/Datacenter
(2) Required OS for the HDvM CLI server
• Windows Server 2003, Standard Edition/Enterprise Edition (x86/x64) SP1 or later, Windows Server 2003 R2, or Standard Edition/Enterprise Edition (x86/x64)
• Windows Server 2008 Standard/Enterprise (x86/x64) or Windows Server 2008 R2 Standard/Enterprise/Datacenter
• Windows Server 2012 Standard/Datacenter,Windows Server 2012 R2 Standard/Datacenter
[Usage conditions for the required products for the service template execution system]
(1) VMware vSphere ESXi (or VMware ESX Server) is managed by vCenter.
(2) The storage system is managed by Hitachi Device Manager Software.
(3) DP pools and host groups have already been created in the storage system.
(4) The VMware-related names listed below are case-sensitive in VMware, but they are not case-sensitive in vSphere Power CLI that is executed from this service. For this reason, this service cannot be used in an environment where names can be used that are the same except for case differences.
• Data store name
• Resource pool name
• vApp name
Cautions
(1) A data store name cannot contain the following characters:
Forward slash (/), backslash (\), percent sign (%)
(2) If the version of VMware vSphere ESXi (or VMware ESX Server) is 5 or later, a VMFS of version 5 will be created.
(3) If the version of VMware vSphere ESXi (or VMware ESX Server) is less than 5, a VMFS of version 3 will be created.
Execution privilege
(1) The user who will be connecting to VMware vCenter Server must have the following permissions:
System administrator role
(2) The user who will be connecting to HDvM must have the following permissions:
User with All Resources assigned as the resource group, and Admin or Modify permissions granted
Version
01.50.01
Category
VM_Operations/Configuration/vSphere
Property list
The following shows the list of the property groups set in the property:
|
Property group |
Description |
Initial display |
|---|---|---|
|
Virtual system environment information |
Specify the information for HDvM and VMware vCenter Server. |
Y |
|
Storage information |
Specify the storage information asociated with the DP volume to be created. |
Y |
|
Virtual environment information |
Specify the virtual environment information asociated with the data store to be created. |
Y |
|
Custom option |
Specify the information of storage system that cannot be specified as the select list of hdvm.hdvmArrayFamily property. |
N |
The following shows the list of the properties to be displayed in the "Service Definition" dialog box:
- (Legend)
-
R: The property must be specified.
O: The property can be omitted. However, the property might be mandatory depending on what is specified for other properties. See the Description of each property.
|
Property key |
Property name |
Description |
I/O type |
Shared |
Required |
Property group |
|---|---|---|---|---|---|---|
|
hdvm.targetHost |
Host name of Device Manager CLI server |
Specify the host name or IP address of the server where Device Manager CLI is installed. You cannot specify an IPv6 address. |
Input |
Disabled |
R |
Virtual system environment information |
|
hdvm.cliInstallPath |
Installation path of Device Manager CLI |
Specify the installation path of Device Manager CLI. |
Input |
Disabled |
R |
Virtual system environment information |
|
hdvm.hdvmProtocol |
Protocol for HDvM communication |
Specify the protocol (http or https) to use when connecting to Device Manager server. |
Input |
Disabled |
R |
Virtual system environment information |
|
hdvm.hdvmHostName |
HDvM server host name |
Specify the host name or IP address of the Device Manager server. |
Input |
Disabled |
R |
Virtual system environment information |
|
hdvm.hdvmPortNumber |
Port number for HDvM connection |
Specify the port number used to connect to the Device Manager server. |
Input |
Disabled |
R |
Virtual system environment information |
|
hdvm.hdvmUserName |
User name for HDvM connection |
Specify the user ID to use when connecting to Device Manager server. |
Input |
Disabled |
R |
Virtual system environment information |
|
hdvm.hdvmPassword |
Password for HDvM connection |
Specify the password to use when connecting to Device Manager server. |
Input |
Disabled |
R |
Virtual system environment information |
|
vmware.targetHost |
Host name of VMware vCenter control server |
Specify the host name or IP address of the server (a server with vSphere PowerCLI installed) that will be used to control VMware vCenter. You cannot specify an IPv6 address. |
Input |
Disabled |
R |
Virtual system environment information |
|
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 |
Disabled |
R |
Virtual system environment information |
|
vmware.userName |
User name for VMware vCenter Server connection |
Specify the user name to use when connecting to the VMware vCenter server. |
Input |
Disabled |
R |
Virtual system environment information |
|
vmware.password |
Password for VMware vCenter Server connection |
Specify the password to use when connecting to the VMware vCenter server. |
Input |
Disabled |
R |
Virtual system environment information |
|
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. |
Input |
Disabled |
O |
Virtual system environment information |
|
vmware.protocol |
Protocol for VMware vCenter Server connection |
Specify the protocol to use when connecting to the VMware vCenter server. |
Input |
Disabled |
R |
Virtual system environment information |
|
hdvm.hdvmSerialNumber |
Storage system serial number |
Specify the serial number of the target storage system. |
Input |
Disabled |
R |
Storage information |
|
hdvm.hdvmArrayFamily |
Storage system family |
Specify the family name of the storage system. You can specify AMS, USP_V, USP_VM, VSP, HUS, HUS VM or VSP G1000. |
Input |
Disabled |
R |
Storage information |
|
vmware.blockSizeMB |
Block size (MB) |
Specify the block size of the data store. The upper limit of a file created on the VMFS is determined by its block size as follows: 1MB - 256GB, 2MB - 512GB, 4MB - 1024GB, 8MB - 2048GB. When not specified, it checks the default for VMware vCenter Server. |
Input |
Disabled |
O |
Virtual environment information |
|
vmware.storageIOControlEnabled |
Storage I/O control |
Specify "true" to enable storage I/O control in the datastore. Otherwise, specify "false". |
Input |
Disabled |
O |
Virtual environment information |
|
vmware.congestionThresholdMillisecond |
Congestion threshold (ms) |
Specify the latency period (in milliseconds) beyond which a datastore subject to storage I/O control by VMware vCenter server is considered congested. If you omit this property, the default value of the VMware vCenter server applies. |
Input |
Disabled |
O |
Virtual environment information |
|
hdvm.hdvmArrayFamilyText |
Storage system family name (custom option) |
Use this property to specify a storage system family name that is not included in the selection list for the hdvm.hdvmArrayFamily property. This property takes precedence over the hdvm.hdvmArrayFamily property. |
Input |
Disabled |
O |
Custom option |
The following shows the list of the properties to be displayed on the "Service Definition" dialog box and the "Submit Service" dialog box:
|
Property key |
Property name |
Description |
I/O type |
Shared |
Required |
Property group |
|---|---|---|---|---|---|---|
|
hdvm.hdvmCapacity |
DP volume (LU) capacity (in GB) |
Specify the capacity of the DP volume (LU) in GB. |
Input |
Disabled |
R |
Storage information |
|
hdvm.hdvmDevNumber |
DP volume (LU) device number |
Specify the device number of the DP volume (LU) as a decimal. |
Input |
Disabled |
R |
Storage information |
|
hdvm.hdvmPoolId |
ID of DP pool |
Specify the pool ID of the pool to be linked with the volume(LU) you are creating. |
Input |
Disabled |
R |
Storage information |
|
hdvm.hdvmPathPortName |
Path port name |
Specify the port name of the path to the DP volume (LU). |
Input |
Disabled |
R |
Storage information |
|
hdvm.hdvmDomainId |
Host group ID |
Specifies the ID, in decimal or hexadecimal, of the host group where the DP volume (LU) is to be added. In the case of hexadecimal, the prefix "0x" must be used. |
Input |
Disabled |
R |
Storage information |
|
hdvm.hdvmLun |
LU number (LUN) |
Specify the LU number (LUN). |
Input |
Disabled |
R |
Storage information |
|
vmware.vmHostName |
ESX server name |
Specify the ESX server name to be displayed in the Hosts and Clusters inventory view managed by VMware vCenter server. |
Input |
Disabled |
R |
Virtual environment information |
|
vmware.dataStoreName |
Datastore name |
Specify the datastore name. |
Input |
Disabled |
R |
Virtual environment information |
|
vmware.hbaName |
HBA name |
Specify the name of the preferred HBA, in the format displayed for the runtime name of the storage adapter in VMware vCenter Server. For example: vmhba0 |
Input |
Disabled |
R |
Virtual environment information |
|
vmware.controllerNumber |
Controller number |
Specify the controller number of the runtime name for the SCSI LUN. |
Input |
Disabled |
R |
Virtual environment information |
|
vmware.targetNumber |
Target number |
Specify the target number of the runtime name for the SCSI LUN. |
Input |
Disabled |
R |
Virtual environment information |
The following shows the list of properties used as variables for work to inherit the value in the processing. This property is displayed only in the task log.
|
Property key |
Property name |
Description |
I/O type |
Shared |
|---|---|---|---|---|
|
vmware.lunPath |
LUN path |
This property contains the canonical name of the LUN to be registered as a datastore. |
Variable |
Disabled |
The following shows the restrictions on inputs to the properties displayed in the "Service Definition" dialog box:
|
Property key |
Characters that can be input |
|---|---|
|
hdvm.targetHost |
A maximum of 255 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -. |
|
hdvm.cliInstallPath |
A character string of no more than 1024 characters can be entered. It cannot include <, >, |, ;, &, ^. |
|
hdvm.hdvmProtocol |
Select one of the following values: http,https |
|
hdvm.hdvmHostName |
A maximum of 255 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -. |
|
hdvm.hdvmPortNumber |
Integer between 1 and 65553 can be entered. |
|
hdvm.hdvmUserName |
A character string of between 1 and 256 characters can be entered. Characters that can be used include alphanumeric characters, as well as !, #, $, %, ', (, ), *, +, -, ., =, @, \, ^ and _. It cannot include a trailing \. |
|
hdvm.hdvmPassword |
A character string of between 4 and 256 characters can be entered. Characters that can be used include alphanumeric characters, as well as !, #, $, %, ', (, ), *, +, -, ., =, @, \, ^ and _. It cannot include a trailing \. |
|
vmware.targetHost |
A maximum of 256 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -. |
|
vmware.vCenterServerName |
A maximum of 256 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -. |
|
vmware.userName |
A maximum of 512 characters can be entered. Characters that can be used include alphanumeric characters and symbols. It cannot include <, >, |, ;, &, ', ", *, ?, [, ], `, /, :, =, , , +, %. |
|
vmware.password |
A maximum of 127 characters can be entered. Characters that can be used include alphanumeric characters and symbols. It cannot include <, >, |, ;, &, ', ", *, ?, [, ], `, %. |
|
vmware.portNumber |
Integer between 1 and 65535 can be entered. |
|
vmware.protocol |
Select one of the following values: http,https |
|
hdvm.hdvmSerialNumber |
Alphanumeric between 1 and 20 characters. |
|
hdvm.hdvmArrayFamily |
Select one of the following values: AMS,USP_V,USP_VM,VSP,HUS,HUS VM,VSP G1000 |
|
vmware.blockSizeMB |
Select one of the following values: 1,2,4,8 |
|
vmware.storageIOControlEnabled |
Select one of the following values: true,false |
|
vmware.congestionThresholdMillisecond |
Integer between 5 and 100 can be entered. |
|
hdvm.hdvmArrayFamilyText |
A string that has 255 or fewer single-byte alphanumeric characters and symbols. The following symbols cannot be used: < > | ; & ' " * ? [ ] ` % |
The following shows the restrictions on inputs to the property displayed on the "Service Definition" dialog box and the "Submit Service" dialog box:
|
Property key |
Characters that can be input |
|---|---|
|
hdvm.hdvmCapacity |
Integer between 1 and 65536can be entered. |
|
hdvm.hdvmDevNumber |
Integer between 0 and 524287 can be entered. |
|
hdvm.hdvmPoolId |
Integer between 0 and 2147483647 can be entered. |
|
hdvm.hdvmPathPortName |
A character string of no less than 1 characters can be entered. It cannot include <, >, |, ;, &, or a trailing \. |
|
hdvm.hdvmDomainId |
Alphanumeric characters more than 1 characters can be entered. Followin characters can be entered. 0-9, a-f, A-F, and x. |
|
hdvm.hdvmLun |
Integer between 0 and 255 can be entered. |
|
vmware.vmHostName |
A maximum of 256 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -. |
|
vmware.dataStoreName |
A maximum of 42 characters can be entered. Characters that can be used include alphanumeric characters and symbols. It cannot include <, >, |, ;, &, ', ", *, ?, [, ], `, %. |
|
vmware.hbaName |
Alphanumeric characters of no less than 1 characters can be entered. |
|
vmware.controllerNumber |
Integer more than 0. |
|
vmware.targetNumber |
Integer more than 0. |
Flow specification details
The following table shows the detailed specification of the flow:
|
Hierarchy |
Display name |
Plug-in |
|||
|---|---|---|---|---|---|
|
Plug-in name |
Version |
Description |
Error recovery method |
||
|
1 |
storageCreateLU |
Create DP volume |
01.13.00 |
Creates the specified DP volume in the storage system managed by Device Manager. |
Eliminate the cause of the error, and then re-execute the service. |
|
2 |
storageAddHostgroup |
Register LU in host group |
01.13.00 |
Adds a data store to VMware vSphere ESXi (or VMware ESX Server). |
Eliminate the cause of the error, and then manually create the data store. |
|
3 |
vsphereRecognizeLU |
Recognize LUN |
01.00.04 |
Recognizes the LUN that was added or deleted in VMware vSphere ESXi (or VMware ESX Server). |
Eliminate the cause of the error, delete the LU in HDvM, and then re-execute the service. |
|
4 |
vsphereGetCanonicalName |
Get canonical name of SCSI LUN |
01.00.04 |
Acquires the canonical name of the SCSI LUN recognized by VMware vSphere ESXi (or VMware ESX Server). |
Eliminate the cause of the error, delete the LU in HDvM, and then re-execute the service. |
|
5 |
vsphereCreateDataStore |
Create data store |
01.00.04 |
Adds a data store to VMware vSphere ESXi (or VMware ESX Server). |
Eliminate the cause of the error, and then manually create the data store. |
|
6 |
vsphereSetFcpath |
Set FC path priority |
01.00.04 |
Sets the FC path to "preferred" for the data store specified in VMware vSphere ESXi (or VMware ESX Server). |
Eliminate the cause of the error, and then manually set the preferred path. |