Get-NetworkAdapter

NAME Get-NetworkAdapter



SYNOPSIS

This cmdlet retrieves the virtual network adapters available on a vCenter Server system.





SYNTAX

Get-NetworkAdapter [[-VM] <VirtualMachine[]>] [[-Template] <Template[]>] [[-Snapshot] <Snapshot[]>] [-Id

<String[]>] [-Name <String[]>] [-Server <VIServer[]>] [<CommonParameters>]



Get-NetworkAdapter -RelatedObject <NetworkAdapterRelatedObjectBase[]> [<CommonParameters>]





DESCRIPTION

This cmdlet retrieves the virtual network adapters available on a vCenter Server system. The cmdlet returns a set

of virtual network adapters assigned to the virtual machines, templates, and snapshots specified by the

VirtualMachine, Template, and Snapshot parameters. At least one of these parameters must be provided. To specify a

server different from the default one, use the Server parameter.





PARAMETERS

-Id <String[]>

Specifies the IDs of the network adapters you want to retrieve.



Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that

matches exactly one of the string values in that list.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? true



-Name <String[]>

Specifies the names of the network adapters you want to retrieve.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? true



-RelatedObject <NetworkAdapterRelatedObjectBase[]>

Specify an object to retrieve one or more network adapters that are related to the object. This parameter

accepts standard and distributed port groups.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-Server <VIServer[]>

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.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? true



-Snapshot <Snapshot[]>

Specifies the snapshots from which you want to retrieve virtual network adapters.



Required? false

Position? 3

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-Template <Template[]>

Specifies the templates from which you want to retrieve virtual network adapters.



Required? false

Position? 2

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? true



-VM <VirtualMachine[]>

Specifies the virtual machines from which you want to retrieve virtual network adapters.



Required? false

Position? 1

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? true



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

Zero or more NetworkAdapter objects







NOTES









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



Get-NetworkAdapter -VM MyVM



Retrieves the network adapters added to the the MyVM virtual machine.

-------------------------- Example 2 --------------------------



$myVDPortgroup = Get-VDPortGroup -Name "MyVDPortGroup"

$myNetworkAdapters = Get-NetworkAdapter -RelatedObject $myVDPortgroup



Retrieves all network adapters connected to the specified port group and stores them in the myNetworkAdapters

variable.



RELATED LINKS

Online Version: https://code.vmware.com/doc/preview?id= ... apter.html

New-NetworkAdapter

Remove-NetworkAdapter

Set-NetworkAdapter