5.11.9 Recognize LUN
Function
Causes VMware vSphere ESXi (or VMware ESX Server) to recognize addition or deletion of an LU.
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
You use this plugin to cause VMware vSphere ESXi (or VMware ESX Server) to recognize creation or deletion of an LU for storing virtual server data during virtual server operation.
The related plugins are as follows:
• storageCreateLU2
• storageAddHostgroupLU
• vsphereGetCanonicalName
• vsphereCreateDatastore
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
Execution privilege
(1) The user who will be connecting to VMware vCenter Server must have the following permissions:
Role with host - configuration - storage partition 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
vsphereRecognizeLU
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 |
|
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 |