5.11.30 Set OS init. settings and IP addr. of virtual servers (Windows)
Function
For a (Windows) virtual server in the VMware vSphere environment, perform the initial OS settings (the computer name, company name, organization name, and time zone) and the IP address settings.
Start the newly created virtual server and use the sysprep utility to initialize the OS and perform customization.
This component requires the following servers:
- vCenter server
This is the server on which VMware vCenter Server is installed.
- ESX server
This is the server on which VMware vSphere ESXi (or VMware ESX Server) is installed.
- vCenter control server (Execution target server)
This is the server on which VMware vSphere PowerCLI is installed. JP1/AO transfers the component to this server and executes it.
- Virtual server
This is the virtual server that is managed by the vCenter server and VMware vSphere ESX (or VMware ESX Server).
Up to 4 IP addresses can be set for the virtual server. For the first IP address (for management), set the IP address for managing the virtual server that was deployed. For the second to fourth IP addresses for the second, third, and fourth NICs, set IP addresses for management and applications based on the operations being performed by the users. Depending on how many NICs the virtual server has, the setting order of the IP addresses is as follows.
- If the virtual server has one NIC
Set the IP addresses that were specified first in the following order: the IP address for management, the IP address for the second NIC, the IP address for the third NIC, the IP address for the fourth NIC. Note that the other IP addresses are discarded.
- If the virtual server has two or more NICs
Set the IP addresses in the following order: the IP address for management, the IP address for the second NIC, the IP address for the third NIC, the IP address for the fourth NIC. If a specified IP address is blank, set the IP addresses without leaving empty spaces. For example, if the specified IP addresses are the IP address for management, the IP address for the second NIC, and the IP address for the fourth NIC (without any IP address for the third NIC), set the IP address for the fourth NIC to the third NIC of the virtual machine. Note that, if the number of entered IP addresses exceeds the number of NICs held by the virtual server, the excess IP addresses are discarded.
The time zones that can be specified are shown below.
Alaskan
Central (U.S. and Canada)
Central America+B28
China
Eastern (U.S. and Canada)
GMT (Greenwich Mean Time)
Hawaii
India
Mountain (U.S. and Canada)
Pacific
Singapore
Tokyo
U.S. Eastern: Indiana (East)
U.S. Mountain: Arizona
If nothing is specified, the time zone "International Date Line: Western side" is set.
Use situation
This can be used for creating the virtual server for Windows. Calling this after executing the component, vsphereCreateVM, enables you to perform the OS initial settings.
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
(3) Prerequisite OS running in the virtual servers
The following OSs are supported, based on the required products for the vCenter server and the required products for the VMware vSphere ESXi (or VMware ESX Server)/vCenter control server that manages the virtual 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
[Usage conditions for required products in the execution target system]
(1) VMware vSphere ESXi (or VMware ESX Server) must be managed by VMware vCenter Server.
(2) Requirements for the VMware vSphere ESXi (or VMware ESX Server) settings
- The data store has been registered.
- The port group has been set. For the port group to be set in the virtual server, specify the port group on the network using the standard virtual switch (vNetwork standard switch/vSphere standard switch).
(3) Virtual server requirements
- VMware Tools has been installed.
- The remote commands have been set to be executable (Administrative share is enabled).
- The NICs must be already set (up to a maximum of four).
- The administrator password must be left blank.
- The number of times that Windows initialization was executed must not have reached the limit (three times).
(4) Virtual server requirements
- Duplicate virtual server names must not be managed under the same vCenter.
[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
Cautions
(1) If the virtual server that is created uses Windows, the organization name and owner name are required. If the organization name is not specified, "Organization" is set. If the owner name is not specified, "Owner" is set.
(2) If the virtual server that is created uses Windows, entry and re-entry of the OS user password are required. If both are not entered, "Password123" is set as the password. Also, if the two values do not match, "Password123" is set as the password.
(3) If the virtual server that is created uses Windows, the WORKGROUP or DOMAIN must be specified in the OS.selectWorkgroupDomain selection list. If neither is specified, "WORKGROUP" is set as the workgroup. Also, if nothing is entered for the workgroup name or domain name, "WORKGROUP" is set as the workgroup.
(4) If the virtual server that is created uses Windows, when WORKGROUP is selected in the OS.selectWorkgroupDomain selection list, the workgroup name can be specified using a maximum of 15 bytes. If 15 bytes are exceeded, "WORKGROUP" is set.
(5) If the virtual server that is created uses Windows, when DOMAIN is selected in the OS.selectWorkgroupDomain selection list, the domain name, domain user name, and domain password are required. If one of these is not specified, or if the entered value is invalid, "WORKGROUP" is set as the workgroup.
(6) Specify the IP address, subnet mask, default gateway, and DNS server at the same time. If one of these items is not specified, none of these items are set.
(7) In the OS initial setting process (2), confirm whether the initial settings were completed based on whether the information set to the OS can be obtained. The time required for confirming the completion of the initial settings is determined by the time specified for the repeat time for obtaining OS information (VMware.checkOSInitCountInterval property) and the count specified for the repeat count for obtaining OS information (VMware.checkOSInitCount). Set the value according to your computer environment so that the processing is not terminated.
(8) If the repeat count for obtaining OS information is not specified, "72" is set.
(9) If the repeat execution interval for obtaining OS information is not specified, "5" is set.
(10) Do not enter values that cannot be set as IP addresses for the IP address that is set to the OS of the virtual server. For example, network addresses, broadcast addresses, and special addresses such as "0.0.0.0" and "255.255.255.255" cannot be specified. If one of these addresses is entered, an error will occur in the deployment of the virtual server. Also, for the IP address for management, enter an IP address capable of communication with the JP1/AO server. Even if the address is correct, the virtual server might fail to deploy.
(11) The IP address is set as described in "Functions", but depending on the order that the NICs were set in the OS of the virtual server, the IP addresses might not be set properly. Make sure that the IP addresses were set after the virtual server is created. If the IP addresses were not set properly, change them manually.
(12) The IP address that is set to the virtual server must not duplicate the IP address of any other server. If another server has the same IP address, the NIC of the virtual server is invalid, and the task is abnormally terminated.
Execution privilege
(1) The following privilege is required for users connected to VMware vCenter Server:
System administrator role
Version
02.11.00
Plug-in tags
Modify VM,VMware vSphere
Plug-in name displayed in the task log
vsphereSetOsinfoWin
Return code
0: Normal
23: Error (Environmental error) Invalid pre-conditioned environment
27: Error (Check with the task log about the error detail)
28: Error (Network start error) The network did not start after the power turned on
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 |
|---|---|---|---|---|---|
|
VMware.vmName |
Virtual server name |
Specify the name of the virtual server. This name is used to represent the virtual server in VMware vCenter server. It is not used as a host name by the OS. |
-- |
Input |
R |
|
common.computerName |
Computer/Host name |
Specify the computer name (host name) used by the operating system. The computer name of a maximum of 15 characters is specified, in the case of Windows. The computer name of a maximum of 63 characters is specified, in the case of Linux. |
-- |
Input |
R |
|
Windows.orgName |
Organization (company name) :Windows only |
Specify the organization name for the virtual server OS (Windows only). When there is no input, "Organization" is set up. |
-- |
Input |
O |
|
Windows.ownerName |
Owner name :Windows only |
Specify the owner name for the OS on the virtual server (Windows only). When there is no input, "Owner" is set as the Owner name. |
-- |
Input |
O |
|
OS.ipAddressMan |
IP address (management LAN) |
Specify the IP address for the management LAN of the virtual server. You cannot specify an IPv6 address. |
-- |
Input |
O |
|
OS.subnetMaskMan |
Subnet mask (management LAN) |
Specify the subnet mask for the management LAN of the virtual server. You cannot specify an IPv6 address. |
-- |
Input |
O |
|
OS.defaultGWMan |
Default gateway (management LAN) |
Specify the default gateway for the management LAN of the virtual server. You cannot specify an IPv6 address. |
-- |
Input |
O |
|
OS.dnsMan |
DNS server IP address (management LAN) |
Specify the IP address of the DNS server for the management LAN of the virtual server. You cannot specify an IPv6 address. |
-- |
Input |
O |
|
OS.ipAddress2 |
The 2nd IP address |
Specify the 2nd IP address for the virtual server. You cannot specify an IPv6 address. |
-- |
Input |
O |
|
OS.subnetMask2 |
The 2nd Subnet mask |
Specify the 2nd subnet mask for the virtual server. You cannot specify an IPv6 address. |
-- |
Input |
O |
|
OS.defaultGW2 |
The 2nd Default gateway |
Specify the 2nd default gateway for the virtual server. You cannot specify an IPv6 address. |
-- |
Input |
O |
|
OS.dns2 |
The 2nd DNS server IP address |
Specify the 2nd IP address of the DNS server for the virtual server. You cannot specify an IPv6 address. |
-- |
Input |
O |
|
OS.workgroupNameDomainName |
Workgroup/domain name |
Specify the name of the workgroup or domain of virtual server. A workgroup is specified a maximum of 15 characters. A domain of a maximum of 63 characters is specified in Windows. In Linux, a domain of a maximum of 256 characters is specified. |
-- |
Input |
O |
|
OS.domainUserName |
Domain user name :Windows only |
Specify the domain user name for the virtual server (Windows only). When "DOMAIN" is chosen by selection of a workgroup/domain, it is necessary to input. |
-- |
Input |
O |
|
OS.domainUserPassword |
Domain password :Windows only |
Specify the domain password for the virtual server (Windows only). When "DOMAIN" is chosen by selection of a workgroup/domain, it is necessary to input. |
-- |
Input |
O |
|
OS.selectWorkgroupDomain |
Select workgroup or domain :Windows only |
Specify whether the virtual server belongs to a workgroup or domain (Windows only). |
-- |
Input |
O |
|
common.osUserPassword |
Administrator password: Windows setting |
Specifies the administrator password that is set for the OS (for Windows only). If nothing is entered, "Password123" is set. |
-- |
Input |
O |
|
common.osUserPasswordReEnter |
Re-enter administrator password: Windows setting |
Re-enter the administrator password that is set for the OS (for Windows only). If nothing is entered, "Password123" is set. |
-- |
Input |
O |
|
OS.productKey |
Windows product key: Windows-specific |
Specifies the Windows product key. Input format is XXXXX-XXXXX-XXXXX-XXXXX-XXXXX (Windows only). |
-- |
Input |
O |
|
VMware.checkOSInitCount |
Number of attempts to acquire OS information |
Specify the number of times the service attempts to acquire OS information to confirm that the OS has been initialized. The maximum wait time is determined by this property and the property that defines the checkOSInitCountInterval. |
72 |
Input |
O |
|
VMware.checkOSInitInterval |
Interval for acquiring OS information (minutes) |
Specify the interval at which the service attempts to acquire OS information to confirm that the OS has been initialized. |
5 |
Input |
O |
|
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 |
|
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 |
|
OS.timeZone |
Time Zone |
Specifies the time zone that is set for the OS of the virtual server. If nothing is entered, the time zone "International Date Line: Western side" is set. |
-- |
Input |
O |
|
OS.ipAddress3 |
The 3rd IP address |
Specify the 3rd IP address for the virtual server. You cannot specify an IPv6 address. |
-- |
Input |
O |
|
OS.subnetMask3 |
The 3rd Subnet mask |
Specify the 3rd subnet mask for the virtual server. You cannot specify an IPv6 address. |
-- |
Input |
O |
|
OS.defaultGW3 |
The 3rd Default gateway |
Specify the 3rd default gateway for the virtual server. You cannot specify an IPv6 address. |
-- |
Input |
O |
|
OS.dns3 |
The 3rd DNS server IP address |
Specify the 3rd IP address of the DNS server for the virtual server. You cannot specify an IPv6 address. |
-- |
Input |
O |
|
OS.ipAddress4 |
The 4th IP address |
Specify the 4th IP address for the virtual server. You cannot specify an IPv6 address. |
-- |
Input |
O |
|
OS.subnetMask4 |
The 4th Subnet mask |
Specify the 4th subnet mask for virtual server. You cannot specify an IPv6 address. |
-- |
Input |
O |
|
OS.defaultGW4 |
The 4th Default gateway |
Specify the 4th default gateway for the virtual server. You cannot specify an IPv6 address. |
-- |
Input |
O |
|
OS.dns4 |
The 4th DNS server IP address |
Specify the 4th IP address of the DNS server for the virtual server. You cannot specify an IPv6 address. |
-- |
Input |
O |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |
|
common.flag2IPsSetup |
Multiple IP setting for virtual server |
A work property that indicates whether the virtual server has multiple IP addresses (true), or not (false). |
-- |
Output |
O |