Hitachi

JP1 Version 12 JP1/Automatic Operation Service Template Reference


5.11.17 Create data store

Function

Adds a data store to VMware vSphere ESXi (or VMware ESX Server).

This plugin 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 plugin is transferred from JP1/AO to this server and then is executed.

Use situation

When you add a new virtual server, you use this plugin to add a data store to the ESX server.

When you use VMFS to create a data store, you must specify the SCSI LUN canonical name in VMware.lunPath.

In this case, you can use the value of the VMware.canonicalName output property (which is obtained by executing vsphereGetCanonicalName).

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 in 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 in 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 (%).

(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:

Role with data store - data store configuration permissions for the target ESX server or system administrator role

Version

02.11.00

Plug-in tags

Add New Storage,VMware vSphere

Plug-in name displayed in the task log

vsphereCreateDataStore

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

R

VMware.dataStoreName

Datastore name

Specify the name of the data store to be created.

--

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

R

VMware.dataStoreReadOnlyMode

Datastore read-only mode

To create a read-only datastore, specify ReadOnly. In other cases, specify ReadWrite.

ReadWrite

Input

O

VMware.lunPath

LUN path

If the datastore type is VMFS, specify the canonical name of the LU on which the datastore will be created. If the datastore type is NFS, specify the mount point.

--

Input

R

VMware.blockSizeMB

Block size

[Only if the datastore is VMFS] Specify the block size. According to the specified block size, the upper limit of the size of each file that will be created in the VMFS is determined as follows:1 MB: 256 GB, 2 MB: 512 GB, 4 MB: 1,024 GB, 8 MB: 2,048 GB

--

Input

O

VMware.vmfsFileSystemVersion

File system version (VMFS)

VMFS version of the datastore to be created.

--

Input

O

VMware.nfsHostNameOrIpAddress

NFS host name

[Only if the datastore type is NFS] Specify the host name or IP address of the NFS server on which the datastore will be created. IPv6 addresses are not supported.

--

Input

O

VMware.storageIOControlEnabled

Whether storage I/O control is enabled

To enable storage I/O control for datastores, specify "true". In other cases, specify "false".

false

Input

O

VMware.congestionThresholdMillisecond

Datastore congestion threshold

Specify (in ms) the threshold for determining whether the storage I/O control assumes that the datastore is congested.

--

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