3.16.11 Pre-check for Datastore Creation on VMware vSphere

Function

Checks the environment prerequisites for the virtual server addition service (LU and data store creation).

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.

• Virtual server

This is a virtual server managed by the vCenter server and VMware vSphere ESX.

• 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.

The following provides an overview of the processing.

(1) Checks whether connection can be established from the HDvM CLI server to the HDvM server.

(2) Checks whether connection can be established from the vCenter control server to a vCenter server.

(3) Checks whether virtual volumes (DP volumes) can be created on the storage system.

This service checks the following items:

• Whether a storage system with the specified serial number and family name has been registered into HDvM

If the storage system is not registered in HDvM, the result is false.

• Whether the device number of the specified DP volume is already in use in the storage system

If the device number is already in use in the storage system, the result is false.

• Whether a DP pool with the specified DP pool ID and the specified host group ID has already been registered in the storage system

The service template checks if the specified LU number is already in use in the storage system.

If either the DP pool ID or the host group ID does not exist or the LU number is already in use, the result is false.

• Whether the DP pool in the specified storage system has enough free space to create the DP volume

If the size of the DP volume is greater than the free space in the DP pool, the result is false.

(4) Checks whether the specified data store can be added to ESX.

This service checks the following items:

• Whether the specified ESX server has been registered into the vCenter server

If the ESX server is not registered in the vCenter server, the result is false.

• Whether the specified data store name is already in use in the data center to which the target ESX server to which the data store is to be added belongs

If the data store name is already in use at the data center, the result is false.

• Whether the correspondence between the specified block size and the data store capacity is valid

If the correspondence between the specified block size and the data store capacity is not valid, the result is false.

For details about the correspondence between block size and data store capacity, see the description of the block size (MB) property.

• Whether the specified HBA has been registered into the ESX server

If the HBA is not registered in the ESX server, the result is false.

The property to be used for specifying the family name of storage system varies depending on the type of storage system to be operated. For the following storage systems, specify the family name of the storage system for the family name of the storage system (custom option) (the property hdvm.familyText):

- For Hitachi Virtual Storage Platform G1500, specify VSP G1500.

- For Hitachi Virtual Storage Platform F1500, specify VSP F1500.

- For Hitachi Virtual Storage Platform G200/G400/G600/G800, specify VSP Gx00.

- For Hitachi Virtual Storage Platform F400/F600/F800, specify VSP Fx00.

For storage systems other than the above, specify the family name of the storage system for the family name of the storage system (the property hdvm.family).

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 12-00 or later

[Required products for the service template execution system]

(1) Required product for the vCenter server

• VMware vCenter Server 7.0, 6.7, 6.5, 6.0, 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 7.0, 6.7, 6.5, 6.0, 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 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

(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 2100/2300/2500/2010

• Hitachi Unified Storage 110/130/150

• Hitachi Unified Storage VM

• Hitachi Universal Storage Platform V/VM

• Hitachi Virtual Storage Platform

• Hitachi Virtual Storage Platform G1000/G1500/F1500

• Hitachi Virtual Storage Platform G200/G400/G600/G800

• Hitachi Virtual Storage Platform F400/F600/F800

[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, Windows Server 2012 R2 Standard/Datacenter

• Windows Server 2016 Standard/Datacenter

• Windows Server 2019 Standard/Datacenter

(2) Required OS for the HDvM CLI server

• 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) 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) If the version of VMware vSphere ESXi (or VMware ESX Server) is 5, specify 1 as the block size.

(2) Do not specify an unsupported storage system for the hdvm.hdvmArrayFamilyText property.

Execution privilege

(1)The user who will be connecting to VMware vCenter Server must have the following permissions:

Read-only role

(2) The user who will be connecting to Device Manager must belong to a user group with the following permissions:

User group with All Resources assigned as the resource group and Admin, Modify, or View permissions granted

Version

02.11.00

Tags

Gather VM information,VMware 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 environment information for checking	Specify the information for storage devices associated with the DP volume to be checked.	Y
Virtual environment information for checking	Specify the information for the virtual environment associated with the data store to be checked.	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" window:

(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 environment information for checking
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 environment information for checking
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 for checking
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" window and the "Submit Service" window:

Property key	Property name	Description	I/O type	Shared	Required	Property group
hdvm.hdvmCapacity	DP volume (LU) capacity (in GB)	Specifies the size in gigabytes of the DP volume (LU) before determining whether it can be created.	Input	Disabled	R	Storage environment information for checking
hdvm.hdvmDevNumber	DP volume (LU) device number	Specifies the device number in decimal of the DP volume (LU) before determining whether it can be used.	Input	Disabled	R	Storage environment information for checking
hdvm.hdvmPoolId	ID of DP pool	Specifies the pool ID of the DP pool before determining whether the DP volume (LU) can be created there.	Input	Disabled	R	Storage environment information for checking
hdvm.hdvmPathPortName	Path port name	Specify the port name of the path to the DP volume (LU).	Input	Disabled	R	Storage environment information for checking
hdvm.hdvmDomainId	Host group ID	Specifies the ID in decimal or hexadecimal of the host group before determining whether the DP volume (LU) can be added there. In the case of hexadecimal, the prefix "0x" must be used.	Input	Disabled	R	Storage environment information for checking
hdvm.hdvmLun	LU number (LUN)	Specify the LU number (LUN).	Input	Disabled	R	Storage environment information for checking
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 for checking
vmware.dataStoreName	Datastore name	Specify the datastore name.	Input	Disabled	R	Virtual environment information for checking
vmware.hbaName	HBA name	Specifies the name of the HBA in the form in which it appears in the Runtime Name of the storage adapter in VMware vCenter Server (for example: vmhba0), before determining whether that HBA exists.	Input	Disabled	R	Virtual environment information for checking

The following shows the list of the properties to be displayed in the "Task Details" window only:

Property key	Property name	Description	I/O type	Shared
hdvm.checkConnectResult	Result of checking HDvM connectivity	Stores the result of determining whether a connection to the HDvM server can be established.	Output	Disabled
vmware.checkConnectResult	Result of checking vSphere connectivity	Stores the result of determining whether a connection to the VMware vCenter Server can be established.	Output	Disabled
hdvm.checkLUResult	Result of checking creation of LU	Stores the result of determining whether or not a DP volume (LU) can be created.	Output	Disabled
vmware.checkDatastoreResult	Result of checking creation of data store	Stores the result of determining whether a data store can be added.	Output	Disabled

The following shows the restrictions on inputs to the properties displayed in the "Service Definition" window:

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
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" window and the "Submit Service" window:

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.

Flow specification details

The following table shows the detailed specification of the flow:

Hierarchy	Display name	Plug-in
Hierarchy	Display name	Plug-in name	Description	Error recovery method
1	hdvmConnectChallenge	Check HDvM connectivity	Determines whether a connection to the HDvM server can be established.	Eliminate the cause of the error, and then re-execute the service.
2	vsphereConnectChallenge	Check VMware vCenter Server connectivity	Determines whether a connection can be established to the vCenter server.	Eliminate the cause of the error, and then re-execute the service.
3	hdvmCheckStorageSpec	Check LU creation	Determines whether the DP volume (LU) can be created.	Eliminate the cause of the error, and then re-execute the service.
4	vsphereCheckDataStore	Check data store creation	Determines whether a data store can be added.	Eliminate the cause of the error, and then re-execute the service.

To Page Top