Hitachi

JP1 Version 12 JP1/Automatic Operation Service Template Reference


5.6.6 Virtual server virtual switch settings

Function

This plug-in sets virtual switches on a virtual server in a Hyper-V environment.

The following describes the servers that this plug-in requires:

- Hyper-V server (execution target server)

A Windows server on which Hyper-V is installed.

- Virtual server

A virtual server managed by Hyper-V.

Virtual switches are set for the NICs that are set on the virtual server and have the specified MAC addresses.

The virtual switches that have already been set for the NICs are overwritten with the new ones.

If the virtual switch specification is missing, connections to the virtual switches are not established.

If an invalid value or no value is specified for MAC addresses, the NICs for which virtual switches are to be set are determined in the order of NICs Hyper-V recognizes.

A maximum of four virtual switches can be set. Note that if you specify more virtual switches than the number of NICs on the virtual server, the settings of the virtual switches that cannot be allocated to NICs do not take effect.

Use situation

This plug-in can be used to set virtual switches on a virtual server in a Hyper-V environment.

Prerequisites

For the most recent information about the prerequisite products for the system, prerequisite products for the execution-target server, and the supported OSs for the prerequisite products for the execution-target server, see the Release Notes.

Prerequisite products for the system:

JP1/Automatic Operation 11-00 or later

Prerequisite products for the execution-target server:

(1) Prerequisite products for the Hyper-V server

- Windows Server 2016 Hyper-V

(2) Prerequisite OS for the virtual server

- Windows Server 2012 Standard/Datacenter or Windows Server 2012 R2 Standard/Datacenter

- Windows Server 2016 Standard/Datacenter

Note: Exceptions are environments in which Server Core/Nano Server is installed.

Supported OSs for the prerequisite products for the execution-target server:

- Windows Server 2016 Standard/Datacenter

Note: Exceptions are environments in which Server Core/Nano Server is installed.

Conditions for using prerequisite 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.12.00

Plug-in tags

Modify VM,Hyper-V 2016

Plug-in name displayed in the task log

hyperv2016SetVirtualSwitch

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 detail) Unidentified error

41: Error (An error has been detected in the component) Property not entered (An error has been 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

common.returnValue

Return value for the plugin

The return value of this plugin stored.

--

Output

--