5.12.2 Windows network settings
Function
This component sets the IP address for the NIC recognized by the OS of the virtual server (Windows). When setting the IP address, the domain can also be set.
The following server is required for this component:
- Execution target server
This is the virtual server that executes the component to obtain the IP address.
Up to 4 IP addresses can be set. If the NIC for which the IP address is to be set is disabled, first enable the NIC, and set the IP address. Depending on the number of NICs held by the virtual server, the setting order of the IP addresses are shown below:
- When the virtual server has one NIC
Set the IP addresses that were specified first in the order of IP address (for the first NIC)>IP address (for the second NIC)>IP address (for the third NIC)>IP address (for the fourth NIC). Note that the other IP addresses are discarded.
- When the virtual server has two or more NICs
Set the IP addresses in the order of IP address (for the first NIC)>IP address (for the second NIC)>IP address (for the third NIC)>IP address (for the fourth NIC). If a specified IP address is blank, set without leaving empty space. For example, if the specified IP addresses are IP address (for the first NIC), IP address (for the second NIC), and IP address (for the fourth NIC) (without any IP address for the third NIC), the IP address for the fourth NIC is set for 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.
If the same IP address has been already set for the specified NIC, do not set the IP address for the NIC.
Use situation
This component can be used to set an IP address for an NIC recognized by the OS, and also to join a domain
Prerequisites
For the latest support information about [Required product in the System]/[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
[Prerequisite product OS running in the execution target server]
- Windows Server 2008 R2 Standard/Enterprise/Datacenter
- Windows Server 2012 Standard/Datacenter
- Windows Server 2016 Standard/Datacenter
- Windows Server 2019 Standard/Datacenter
This does not apply to Server Core installation environments.
[Usage conditions for required products on the execution target server]
None.
Cautions
(1) Do not change the IP address of an NIC being used for communication with the JP1/AO server. If changed, communication with the JP1/AO server is severed and the task will terminate abnormally. For example, if the NIC in a LAN connection is being used for communication with the JP1/AO server, specify the already set IP address as the IP address (for the first VM), and thus prevent the IP address from being set for the NIC in the LAN connection.
(2) For the IP address set for the OS of a virtual server, do not enter a value that cannot be set as an IP address. 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.
(3) The IP address set for a 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 might become invalid, and the task will abnormally terminate.
(4) To join a domain, the domain name, domain user name, and domain password are required. If any of them is not specified or the processing to join the domain fails, the current OS settings are taken over.
(5) Specify the IP address, subnet mask. If one of these items is not specified, none of these items are set.
Version
02.00.00
Plug-in tags
Configure OS,Windows
Plug-in name displayed in the task log
osSetNetworkSetting
Return code
0: Normal
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 |
|
OS.ipAddressMan |
The 1st IP address |
Specify the 1st IP address for the virtual server. You cannot specify an IPv6 address. |
-- |
Input |
O |
|
OS.subnetMaskMan |
The 1st Subnet mask |
Specify the 1st subnet mask for the virtual server. You cannot specify an IPv6 address. |
-- |
Input |
O |
|
OS.defaultGWMan |
The 1st Default gateway |
Specify the 1st default gateway for the virtual server. You cannot specify an IPv6 address. |
-- |
Input |
O |
|
OS.dnsMan |
The 1st DNS server IP address |
Specify the 1st IP address of the DNS server for the virtual server. You cannot specify an IPv6 address. |
-- |
Input |
O |
|
OS.ipAddress2 |
IP address (for second NIC) |
Specifies the IP address set for the second NIC recognized by the virtual server OS. IPv6 addresses are not supported. |
-- |
Input |
O |
|
OS.subnetMask2 |
Subnet mask (for second NIC) |
Specifies the subnet mask that is set to the second NIC recognized by the virtual server OS. IPv6 addresses are not supported. |
-- |
Input |
O |
|
OS.defaultGW2 |
Default gateway (for second NIC) |
Specifies the default gateway that is set to the second NIC recognized by the virtual server OS. IPv6 addresses are not supported. |
-- |
Input |
O |
|
OS.dns2 |
DNS server IP address (for second NIC) |
Specifies the IP address of the DNS server that is set to the second NIC recognized by the virtual server OS. IPv6 addresses are not supported. |
-- |
Input |
O |
|
OS.ipAddress3 |
IP address (for third NIC) |
Specifies the IP address set for the third NIC recognized by the virtual server OS. IPv6 addresses are not supported. |
-- |
Input |
O |
|
OS.subnetMask3 |
Subnet mask (for third NIC) |
Specifies the subnet mask that is set to the third NIC recognized by the virtual server OS. IPv6 addresses are not supported. |
-- |
Input |
O |
|
OS.defaultGW3 |
Default gateway (for third NIC) |
Specifies the default gateway that is set to the third NIC recognized by the virtual server OS. IPv6 addresses are not supported. |
-- |
Input |
O |
|
OS.dns3 |
DNS server IP address (for third NIC) |
Specifies the IP address of the DNS server that is set to the third NIC recognized by the virtual server OS. IPv6 addresses are not supported. |
-- |
Input |
O |
|
OS.ipAddress4 |
IP address (for fourth NIC) |
Specifies the IP address set for the fourth NIC recognized by the virtual server OS. IPv6 addresses are not supported. |
-- |
Input |
O |
|
OS.subnetMask4 |
Subnet mask (for fourth NIC) |
Specifies the subnet mask that is set to the fourth NIC recognized by the virtual server OS. IPv6 addresses are not supported. |
-- |
Input |
O |
|
OS.defaultGW4 |
Default gateway (for fourth NIC) |
Specifies the default gateway that is set to the fourth NIC recognized by the virtual server OS. IPv6 addresses are not supported. |
-- |
Input |
O |
|
OS.dns4 |
DNS server IP address (for fourth NIC) |
Specifies the IP address of the DNS server that is set to the fourth NIC recognized by the virtual server OS. IPv6 addresses are not supported. |
-- |
Input |
O |
|
OS.domainName |
Domain name |
Specify whether the virtual server belongs to a workgroup or domain. |
-- |
Input |
O |
|
OS.domainUserName |
Domain user name |
Specifies the user name of the domain to which the virtual server belongs. You must enter this if "DOMAIN" was selected in the Workgroup/domain selection. |
-- |
Input |
O |
|
OS.domainUserPassword |
Domain password |
Specifies the password of the domain where the virtual server belongs. You must enter this if "DOMAIN" was selected in the Workgroup/domain selection. |
-- |
Input |
O |
|
common.flagSucceedDomain |
Domain join process successful |
The value stored for this property is TRUE when the domain was successfully joined, and FALSE when joining the domain failed. |
-- |
Output |
O |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |