5.5.10 Get canonical name of SCSI LUN
Function
Acquires a SCSI LUN canonical name that is recognized by VMware vSphere ESXi.
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 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 use VMFS to create a data store in VMware vSphere ESXi by using the vsphereCreateDatastore plugin, you must specify the canonical name of the LUN for which the data store is to be created.
This plugin outputs the canonical name required for data store creation to the VMware.canonicalName property.
Prerequisites
For the latest support information about [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.
In addition, the following OS and products use abbreviations. For the abbreviations of OS and products, see the "Preface".
[Required products on the execution target system]
(1) Prerequisite product of vCenter Server
• VMware vCenter Server
(2) Prerequisite product of ESX Server
• VMware vSphere ESXi
[Usage conditions for required products in the execution target system]
(1) VMware vSphere ESXi is managed by VMware vCenter Server.
[Required products on the execution target server]
• VMware PowerCLI
[Prerequisite product OS running in the execution target server]
• Windows Server
Execution privilege
(1) The user who will be connecting to VMware vCenter Server must have the following permissions:
System administrator role
Version
04.00.00
Plug-in tags
Gather VM information,VMware vSphere
Plug-in name displayed in the task log
vsphereGetCanonicalName
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.hbaName |
HBA name |
Specify the HBA name of the ESX server. |
-- |
Input |
R |
VMware.controllerNumber |
SCSI LUN's controller number |
Specify the SCSI LUN's controller number. |
-- |
Input |
R |
VMware.targetNumber |
SCSI LUN's target number |
Specify the SCSI LUN's target number. |
-- |
Input |
R |
VMware.luNumber |
SCSI LUN's LU number |
Specify the SCSI LUN's LU number. |
-- |
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 |
VMware.canonicalName |
Canonical name |
Specify the SCSI LUN's canonical name. |
-- |
Output |
O |