5.4.4 Virtual server virtual switch settings
Function
This component sets a virtual switch in a virtual server in the Hyper-V environment.
The following servers are required for this component:
- Hyper-V server (Execution target server)
This is the Windows server where Hyper-V is installed.
- Virtual server
This is a virtual server managed by Hyper-V.
For the NIC of the specified MAC address among the NICs set in the virtual server, set a virtual switch.
The virtual switch already set for the NIC is overwritten with the specified virtual switch.
If no virtual switch is specified, the virtual switch connection is disconnected.
If an invalid or no value is specified for the MAC address, set the virtual switches according to the order of NICs that Hyper-V recognizes.
Up to 4 virtual switches can be set. If the number of specified virtual switches exceeds the number of NICs held by the virtual server, the settings for virtual switches not assigned to NICs are invalid.
Use situation
This component can be used to set a virtual switch in a virtual server in the Hyper-V environment.
Prerequisites
For the latest support information about [Required product in the 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-00 or later
[Required products on the execution target server]
(1)Prerequisite product of Hyper-V Server
- Windows Server 2008 R2 Hyper-V
(2)Prerequisite OS running in the virtual servers
- Windows Server 2008 R2 Standard/Enterprise/Datacenter
This does not apply to Server Core installation environments.
[Prerequisite product OS running in the execution target server]
- Windows Server 2008 R2 Standard/Enterprise/Datacenter
This does not apply to Server Core installation environments.
[Usage conditions for required products on the execution target server]
(1) The virtual server name must be unique within the Hyper-V server.
(2) The virtual switch name must be unique within the Hyper-V server.
(3) No legacy network adapter is set in the virtual server.
Version
02.00.00
Plug-in tags
Modify VM,Hyper-V 2008
Plug-in name displayed in the task log
hypervSetVirtualSwitch
Return code
0: Normal
12: Error (Mistake by user) A property is invalid.
23: Error (Invalid environment) The environment requirements are not met.
27: Error (Check the task log for error details.)
41: Error (An error was detected in the component.) A property was 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 |
|
hyperv.vmName |
Virtual server name |
Specifies the name of the virtual server. (This is the name of the virtual server as it is displayed in Hyper-V. This is not the host name in the OS.) |
-- |
Input |
R |
|
hyperv.virtualSwitch1 |
Virtual switch name (for first NIC) |
Specifies the virtual switch name (for first NIC) set for the first NIC that is set for the virtual server. |
-- |
Input |
O |
|
OS.nic1MacAddress |
NIC MAC address (for first NIC) |
Specifies the MAC address of the NIC that sets the virtual switch name (for first NIC). |
-- |
Input |
O |
|
hyperv.virtualSwitch2 |
Virtual switch name (for second NIC) |
Specifies the virtual switch name (for second NIC) set for the second NIC that is set for the virtual server. |
-- |
Input |
O |
|
OS.nic2MacAddress |
NIC MAC address (for second NIC) |
Specifies the MAC address of the NIC that sets the virtual switch name (for second NIC). |
-- |
Input |
O |
|
hyperv.virtualSwitch3 |
Virtual switch name (for third NIC) |
Specifies the virtual switch name (for third NIC) set for the third NIC that is set for the virtual server. |
-- |
Input |
O |
|
OS.nic3MacAddress |
NIC MAC address (for third NIC) |
Specifies the MAC address of the NIC that sets the virtual switch name (for third NIC). |
-- |
Input |
O |
|
hyperv.virtualSwitch4 |
Virtual switch name (for fourth NIC) |
Specifies the virtual switch name (for fourth NIC) set for the fourth NIC that is set for the virtual server. |
-- |
Input |
O |
|
OS.nic4MacAddress |
NIC MAC address (for fourth NIC) |
Specifies the MAC address of the NIC that sets the virtual switch name (for fourth NIC). |
-- |
Input |
O |
|
hyperv.checkJobStateCountNewSw |
Job monitoring count (ModifyVirtualSystemResources method) |
This property adjusts the job monitoring count for monitoring requests to Hyper-V for processing (ModifyVirtualSystemResources method). You do not need to change the value of this property. |
1200 |
Input |
R |
|
hyperv.checkJobStateIntervalNewSw |
Monitor interval (ModifyVirtualSystemResources method) |
This property adjusts the job monitoring interval for monitoring requests to Hyper-V for processing (ModifyVirtualSystemResources method). You do not need to change the value of this property. |
3 |
Input |
R |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |