vSphere PowerCLI Reference

Get-VMGuestNetworkInterface

Synopsis

This cmdlet etrieves information about the network configuration of the specified virtual machines or guests.

Syntax

Get-VMGuestNetworkInterface [-Name <String[]>] [[-VM] <VirtualMachine[]>] [-VMGuest <VMGuest[]>] [-Server <VIServer[]>] [-ToolsWaitSecs <Int32>] [-GuestPassword <SecureString>] [-GuestUser <String>] [-GuestCredential <PSCredential>] [-HostPassword <SecureString>] [-HostUser <String>] [-HostCredential <PSCredential>] [<CommonParameters>]

Related Commands

Online version
Set-VMGuestNetworkInterface

Detailed Description

This cmdlet is deprecated. Use Invoke-VMScript instead.

This cmdlet retrieves information about the network configuration of the specified virtual machines or guests. For a list of supported operating systems, see the PowerCLI User's Guide.

To run this cmdlet against vCenter Server/ESX/ESXi versions earlier than 5.0, you need to meet the following requirements:
*You must run the cmdlet on the 32-bit version of Windows PowerShell.
*You must have access to the ESX that hosts the virtual machine over TCP port 902.
*For vCenter Server/ESX/ESXi versions earlier than 4.1, you need VirtualMachine.Interact.ConsoleInteract privilege. For vCenter Server/ESX/ESXi 4.1 and later, you need VirtualMachine.Interact.GuestControl privilege.

To run this cmdlet against vCenter Server/ESXi 5.0 and later, you need VirtualMachine.GuestOperations.Execute and VirtualMachine.GuestOperations.Modify privileges.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
VMVirtualMachine[]Specifies the virtual machines for which you want to retrieve the network configuration.falsetrue (ByValue)
GuestCredentialPSCredentialSpecifies 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.falsefalse
GuestPasswordSecureStringSpecifies the password you want to use for authenticating with the guest OS.falsefalse
GuestUserStringSpecifies the user name you want to use for authenticating with the guest OS.falsefalse
HostCredentialPSCredentialSpecifies a PSCredential object that contains credentials for authenticating with the host. Do not use this parameter if the HostUser and HostPassword parameters are used. You need to specify host credentials only if the version of the vCenter Server or ESX you are authenticating with is earlier than 4.0, or the VIX version you have installed is earlier than 1.10.falsefalse
HostPasswordSecureStringSpecifies the password you want to use for authenticating with the host. You need to specify host credentials only if the version of the vCenter Server or ESX you are authenticating with is earlier than 4.0, or the VIX version you have installed is earlier than 1.10.falsefalse
HostUserStringSpecifies the user name you want to use for authenticating with the host. You need to specify host credentials only if the version of the vCenter Server or ESX you are authenticating with is earlier than 4.0, or the VIX version you have installed is earlier than 1.10.falsefalse
NameString[]Specifies the names of the guest network interfaces you want to retrieve.falsefalse
ServerVIServer[]Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.falsefalse
ToolsWaitSecsInt32Specifies 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.falsefalse
VMGuestVMGuest[]Specifies the guest OS for which you want to retrieve the network configuration.falsetrue (ByValue)

Return Type

Zero or more VMGuestNetworkInterface objects

Notes

This cmdlet is not compatible with IPv6 environments.

Examples

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

Get-VMGuestNetworkInterface -VM $vm -GuestUser User -GuestPassword pass2

Retrieves the guest network interface of the $vm virtual machine.


Copyright © VMware, Inc. All rights reserved.