5.5.54 Set the physical adapter
Function
This plugin sets the status of a physical adapter connected to the standard virtual switch (vNetwork standard switch or vSphere standard switch) in a VMware vSphere environment.
The status that can be set is Active, Standby, or Unused.
This plugin requires the following servers:
- vCenter server
A server on which VMware vCenter Server is installed
- ESX server
A server on which VMware vSphere ESXi 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 status to be set (VMware.physicalAdapterStatus property).
- You can specify one of the following statuses:
Active
Standby
Unused
Use situation
This plugin can be used to block or unblock a physical adapter on an ESX server.
Prerequisites
See the Release Notes for the latest support statuses of 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.
In addition, the following OS and products use abbreviations. For the abbreviations of OS and products, see the "Preface".
Prerequisite products for the execution-target system:
(1) Prerequisite product for the vCenter server
- VMware vCenter Server
(2) VMware vSphere ESXi to manage virtual servers
Conditions for using the prerequisite products for the execution-target system:
(1) VMware vSphere ESXi must be managed by VMware vCenter Server.
(2) Conditions for settings on VMware vSphere ESXi
- The VMware-related name shown below is case sensitive in VMware, but the specified name is 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.
- Standard virtual switch name
Prerequisite products on the execution-target server:
- VMware PowerCLI
Supported OSs for the prerequisite products for the execution-target server:
- Windows Server
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 set the status of the physical adapter to Standby or Unused, that physical adapter can no longer be used for communication. Make sure that the physical adapter is not used by a virtual server or ESX in advance.
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
vsphereSetPhysicalAdapterStatus
Return code
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.vmHostName |
Host name of the ESX server |
Specify the host name of the ESX server. |
-- |
Input |
R |
|
VMware.virtualSwitchName |
Standard virtual switch name |
Specifies the name of the standard virtual switch that connects to the physical adapter for which you want to set the state. |
-- |
Input |
R |
|
VMware.physicalAdapterName |
Physical adapter name |
Specifies the name of the physical adapter for which you want to set the state. |
-- |
Input |
R |
|
VMware.physicalAdapterStatus |
State to be set |
Specifies the state that you want to set for the physical adapter. You can specify Active, Standby, or Unused. |
-- |
Input |
R |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |