5.11.22 Change the network adapter settings
Function
This plugin changes the network adapter settings allocated to virtual servers in a VMware vSphere environment.
Use one of the following methods to specify the connection destination network:
(1) Specify the port group name of the standard virtual switch (VMware.connectionPortGroupName property).
(2) Specify the distributed port group name (VMware.connectionVDPortGroupName property).
(3) Specify the distributed virtual switch name (VMware.distributedSwitchName property) and port ID (VMware.portID property).
If you do not specify the connection destination network, the connection destination network will not be changed.
This plugin requires the following servers:
- vCenter server
A server on which VMware vCenter Server is installed
- vCenter control server (execution target server)
A server on which VMware vSphere PowerCLI is installed. The plugin is transferred to and executed on this server by JP1/AO.
- Virtual server
A virtual server managed by the vCenter server and VMware vSphere ESXi
The following describes the network adapter type (VMware.vNetworkAdapterType property).
- Specify the type of the network adapter. The values you can specify for this property are e1000, e1000e, Flexible, EnhancedVmxnet, and Vmxnet3. However, some types of network adapters cannot be specified depending on the version of a prerequisite product. Confirm the types of network adapters that can be specified for the prerequisite products, and then specify the appropriate value.
- To specify VMXNET2 (Enhanced) as the network adapter type, specify EnhancedVmxnet.
Use situation
This plugin can be used to change the network adapter settings allocated to a virtual server.
Prerequisites
See the Release Notes for the latest support statuses of prerequisite products for the system, prerequisite products for the execution-target system, prerequisite products on the execution-target server, and the supported OSs for the prerequisite products for the execution-target server.
Prerequisite products for the system:
JP1/Automatic Operation 11-10 or later
Prerequisite products for the execution-target system:
(1) Prerequisite product for the vCenter server
- VMware vCenter Server 7.0, 6.7, 6.5, 6.0, 5.5, 5.1, 5.0
(2) Prerequisite product for VMware vSphere ESX to manage virtual servers
- VMware vSphere ESXi 7.0, 6.7, 6.5, 6.0, 5.5, 5.1, 5.0
Conditions for using the prerequisite products for the execution-target system:
(1) VMware vSphere ESX must be managed by VMware vCenter Server.
(2) Conditions for settings on VMware vCenter Server
- Virtual server names must be unique.
- The VMware-related names shown below are case sensitive in VMware, but the specified names are not case sensitive in the vSphere PowerCLI instance that is executed by this plugin.
Therefore, this plugin cannot be used in an environment in which duplicate names with different case letters are used.
- Virtual server name
- Port group name
- Distributed port group name
- Distributed virtual switch name
Prerequisite products on the execution-target server:
- VMware vSphere PowerCLI 6.3 Release1, 6.0 Release3, 6.0 Release1, 5.8 Release 1, 5.5 Release 2, 5.5 Release 1, 5.1 Release 2, 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
Supported OSs for the prerequisite products for 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) Do not specify a string containing a double-quotation mark (") or single quotation mark (') for a property of this plugin.
(2) If you use multiple methods to specify the connection destination network, this plugin ends abnormally.
(3) If the plugin for which the connection destination network is specified ends abnormally with return value 27, a configuration change might have failed after the network adapter was connected to the specified network. In this case, remove the cause of the error according to the error message in the task log, and then execute the plugin again.
(4) Do not execute multiple instances of this plugin simultaneously for the same network adapter. If you do so, this plugin ends normally, but invalid values might be set for the network adapter.
Execution privilege
(1) Users who connect to VMware vCenter Server must have system administrator permissions.
Version
02.11.00
Plug-in tags
Modify VM,VMware vSphere
Plug-in name displayed in the task log
vsphereSetNetworkAdapter
Return code
0: Normal
12: Error (Mistake by user) Invalid property
23: Error (Invalid environment) The environment requirements are not met.
27: Error (Check with the task log about the error details.) Unidentified error
41: Error (An error was detected in the component.) Property not entered (An error was detected in the component script.)
Property list
The following table lists the properties:
|
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
|---|---|---|---|---|---|
|
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 |
|
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.vmName |
Virtual server name |
Specify the name of the virtual server. (This is the virtual server name in VMware vCenter Server. Do not specify a host name.) |
-- |
Input |
R |
|
VMware.targetNetworkAdapter |
Network adapter name |
Specifies the name of the network adapter whose settings you want to change. |
-- |
Input |
R |
|
VMware.connectionPortGroupName |
Port group name of the standard virtual switch |
Specifies the port group name of the standard virtual switch that connects to the network adapter. |
-- |
Input |
O |
|
VMware.connectionDVPortGroupName |
Distributed port group name |
Specifies the name of the distributed port group that connects to the network adapter. |
-- |
Input |
O |
|
VMware.dVSwitchName |
Distributed virtual switch name |
Specifies the name of the distributed virtual switch to be connected to the network adapter. If you specify this property, you must also specify the port ID. |
-- |
Input |
O |
|
VMware.portID |
Port ID |
Specifies the port ID of the distributed virtual switch to be connected to the network adapter. |
-- |
Input |
O |
|
VMware.startConnetedSwitch |
Whether to connect a network adapter at virtual server startup |
To connect a network adapter when the virtual server starts, specify "true". To not connect a network adapter when the virtual server starts, specify "false". |
-- |
Input |
O |
|
VMware.vNetworkAdapterType |
Network adapter type |
Specifies the network adapter type. You can specify e1000, e1000e, Flexible, EnhancedVmxnet, or Vmxnet3. |
-- |
Input |
O |
|
VMware.wakeOnLanSwitch |
Setting Wake-on-LAN |
To enable the Wake-on-LAN function of the network adapter, specify "true". To disable the function, specify "false". |
-- |
Input |
O |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |