5.11.18 Check data store creation
Function
Verifies that a specified data store can be added to VMware vSphere ESXi (or VMware ESX Server).
This module assumes the following servers:
• vCenter server
This is a server on which VMware vCenter Server is installed.
• ESX server
This is a server on which VMware vSphere ESXi (or VMware ESX Server) is installed.
• vCenter control server (Execution target server)
This is a server on which VMware vSphere PowerCLI is installed. The module is transferred from JP1/AO to this server and then is executed.
This module checks the following:
• 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.
Use situation
When you intend to add a data store to an ESX server, this module enables you to first check whether the data store can be added to the ESX server.
Prerequisites
For the latest support information about [Required product in the System]/[Required products on the execution target system]/[Required products on the execution target server]/[Prerequisite product OS running on the execution target server], see the release notes.
[Required product in the System]
JP1/Automatic Operation 11-10 or later
[Required products on the execution target system]
(1) Prerequisite product of vCenter Server
• VMware vCenter Server 7.0, 6.7, 6.5, 6.0, 5.5, 5.1, 5.0, 4.1, 4.0
(2) Prerequisite product of ESX Server
• VMware vSphere ESXi 7.0, 6.7, 6.5, 6.0, 5.5, 5.1, 5.0 or VMware ESX Server 4.1, 4.0
[Usage conditions for required products in the execution target system]
(1)VMware vSphere ESXi (or VMware ESX Server) is managed by VMware vCenter Server.
[Required products on the execution target 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
[Prerequisite product OS running on the execution target 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
Cautions
(1) The following characters cannot be specified in a data store name (VMware.dataStoreName):
• Forward slash (/)
• Backslash (\)
• Percent sign (%)
Execution privilege
(1) The user who will be connecting to VMware vCenter Server must have the following permissions:
Role with data store - data store configuration permissions for the target ESX server or system administrator role
Version
02.11.00
Plug-in tags
Gather VM information,VMware vSphere
Plug-in name displayed in the task log
vsphereCheckDataStore
Return code
0: Normal
23: Error (invalid environment) Required environment is invalid
27: Error (check task logs for the nature of error)
41: Error (error detected in module) Missing property (error detected in module script)
Property list
The following table lists the properties:
|
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
|---|---|---|---|---|---|
|
VMware.vCenterServerName |
Host name of the vCenter server |
Specify the host name or IP address of the destination vCenter server. IPv6 addresses are not supported. |
-- |
Input |
R |
|
VMware.userName |
User name for connecting to the VMware vCenter Server |
Specify the user name for connecting to the VMware vCenter Server. |
-- |
Input |
R |
|
VMware.password |
Password for connecting to the VMware vCenter Server |
Specify the password for connecting to the VMware vCenter Server. |
-- |
Input |
R |
|
VMware.portNumber |
Port number for connecting to the VMware vCenter server |
Specify the number of the port for connecting to VMware vCenter Server (for the VMware vCenter Server Web service). |
443 |
Input |
O |
|
VMware.protocol |
Protocol for connecting to the VMware vCenter server |
Specify either HTTP or HTTPS as the protocol for connecting to VMware vCenter Server. |
https |
Input |
R |
|
VMware.vmHostName |
Host name of the ESX server |
Specify the ESX server name to be displayed in the Hosts and Clusters inventory view managed by VMware vCenter server. |
-- |
Input |
R |
|
VMware.dataStoreName |
Datastore name |
Specify the name of the data store. |
-- |
Input |
R |
|
VMware.dataStoreType |
Datastore type |
Specify the datastore type. If the datastore is in an FC-SAN or SCSI configuration, specify VMFS. If the datastore is in a NAS configuration, specify NFS. |
VMFS |
Input |
O |
|
HDvM.capacity |
Space on the DP volume (LU) (GB) |
Specify the space in gigabytes of the DP volume (LU) to be created. |
-- |
Input |
R |
|
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. |
1 |
Input |
O |
|
VMware.vmfsFileSystemVersion |
File system version (VMFS) |
VMFS version of the datastore to be created. |
-- |
Input |
O |
|
VMware.hbaName |
HBA name |
Specify the name of the HBA in the format in which it appears in the Runtime Name of the storage adapter in VMware vCenter Server (for example: vmhba0), before determining whether the HBA exists. |
-- |
Input |
R |
|
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 |
|
common.CheckDataStoreResult |
Data store creation check result |
Stores the result of determining whether a data store can be added. |
-- |
Output |
O |