vSphere PowerCLI Cmdlets Reference

Set-VMGuestNetworkInterface

Synopsis

Configures the network settings of a virtual machine using VMware Tools.

Syntax

Set-VMGuestNetworkInterface -VmGuestNetworkInterface <VMGuestNetworkInterface[]> [-WinsPolicy <DhcpPolicy>] [-Wins <String[]>] [-DnsPolicy <DhcpPolicy>] [-Dns <String[]>] [-IPPolicy <DhcpPolicy>] [[-Gateway] <Object>] [[-Netmask] <String>] [[-Ip] <IPAddress>] [-ToolsWaitSecs <Int32>] [-GuestPassword <SecureString>] [-GuestUser <String>] [-GuestCredential <PSCredential>] [-HostPassword <SecureString>] [-HostUser <String>] [-HostCredential <PSCredential>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Get-VMGuestNetworkInterface

Detailed Description

Configures the network settings of a virtual machine using VMware Tools. The cmdlet allows IP and routing configuration. You can modify Wins settings only for Windows virtual machines. The cmdlet sends a remote script which executes inside the virtual machine in the context of the specified user account. This cmdlet supports only Windows XP, Windows Server 2003, and Linux RedHat Enterprise 5. You can enhance this cmdlet to support other guest operating systems by modifying or adding custom scripts. The custom scripts are located in the "Scripts" folder in the PowerCLI installation directory and their names have the following format:

<CmdletName>_<OS_Identifier>

<OSIdentifier> is the guest family or the guest ID as returned by Get-VMGuest.
<CmdletName> is the name of the cmdlet without a hyphen, for example SetVMGuestNetworkInterface.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
VmGuestNetworkInterface	Specify the guest network interface you want to configure.	true	true (ByValue)
WinsPolicy	Specify the Wins policy. The valid values are Static and Dhcp.	false	false
Wins	Specify WINS servers. Use this parameter only if The WinsPolicy parameter is set to Static.	false	false
DnsPolicy	Specify the DNS policy. The valid values are Static and Dhcp.	false	false
Dns	Specify DNS addresses. Use this parameter only if The DnsPolicy parameter is set to Static.	false	false
IPPolicy	Specify the IP policy. The valid values are Static and Dhcp.	false	false
Gateway	Specify a gateway.	false	false
Netmask	Specify a net mask.	false	false
Ip	Specify an IP address. Use this parameter only if The IpPolicy parameter is set to Static.	false	false
ToolsWaitSecs	Specify the time in seconds to wait for a response from the VMware Tools. If a non-positive value is provided, the system waits infinitely long time.	false	false
GuestPassword	Specify the password you want to use for authenticating with the guest OS.	false	false
GuestUser	Specify the user name you want to use for authenticating with the guest OS.	false	false
GuestCredential	Specify a PSCredential object that contains credentials for authenticating with the guest OS. Do not use this parameter if the -GuestUser and -GuestPassword parameters are used.	false	false
HostPassword	Specify the password you want to use for authenticating with the host.	false	false
HostUser	Specify the user name you want to use for authenticating with the host.	false	false
HostCredential	Specify a PSCredential object that contains credentials for authenticating with the host. Do not use this parameter if the -HostUser and -HostPassword parameters are used.	false	false
WhatIf	Indicate that the cmdlet is run only to display the changes that would be made and actually no objects are modified.	false	false
Confirm	If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.	false	false	$true

Return Type

VMGuestNetwork

Notes

Supported on ESX 3.5 Update 2 and newer. Consider that this functionality i s experimental.

Examples

-------------- Example 1 --------------

Set-VMGuestNetworkInterface -VMGuestNetworkInterface $vmGuestNetworkInterface -HostUser Admin -HostPassword Pass01 -GuestUser User -GuestPassword Pass02 -Netmask 255.255.255.255 -Gateway 10.23.112.58

Changes the net mask and the gateway of the specified guest network interface,