Get-SCVirtualNetworkAdapter

Gets VMM virtual network adapter objects from a virtual machine, virtual machine template, or hardware profile.

Syntax

Get-SCVirtualNetworkAdapter [-All] [-OnBehalfOfUser <String>] [-OnBehalfOfUserRole <UserRole>]
 [-ParentTypeVMOrHost] [-VMMServer <ServerConnection>] [<CommonParameters>]
Get-SCVirtualNetworkAdapter -HardwareProfile <HardwareProfile> [-OnBehalfOfUser <String>]
 [-OnBehalfOfUserRole <UserRole>] [-VMMServer <ServerConnection>] [<CommonParameters>]
Get-SCVirtualNetworkAdapter [-ID] <Guid> [[-Name] <String>] [-OnBehalfOfUser <String>]
 [-OnBehalfOfUserRole <UserRole>] [-VMMServer <ServerConnection>] [<CommonParameters>]
Get-SCVirtualNetworkAdapter [-OnBehalfOfUser <String>] [-OnBehalfOfUserRole <UserRole>] -VM <VM>
 [-VMMServer <ServerConnection>] [<CommonParameters>]
Get-SCVirtualNetworkAdapter [-OnBehalfOfUser <String>] [-OnBehalfOfUserRole <UserRole>] -VMHost <Host>
 [-VMMServer <ServerConnection>] [<CommonParameters>]
Get-SCVirtualNetworkAdapter [-OnBehalfOfUser <String>] [-OnBehalfOfUserRole <UserRole>]
 [-VMMServer <ServerConnection>] -VMTemplate <Template> [<CommonParameters>]

Description

The Get-SCVirtualNetworkAdapter cmdlet gets one or more virtual network adapter objects from a virtual machine object, a virtual machine template object, or a hardware profile object in a Virtual Machine Manager (VMM) environment.

Examples

Example 1: Get virtual network adapters from a virtual machine

PS C:\> $VM = Get-SCVirtualMachine -Name "VM01"
PS C:\> Get-SCVirtualNetworkAdapter -VM $VM

The first command gets the virtual machine object named VM01 and stores the object in the $VM variable.

The second command gets all virtual network adapter objects on VM01 and displays information about the adapters to the user.

Example 2: Get virtual network adapters from a virtual machine template

PS C:\> $VMTemplate = Get-SCVMTemplate | where { $_.Name -eq "VMTemplate01" }
PS C:\> Get-SCVirtualNetworkAdapter -Template $VMTemplate

The first command gets all virtual machine template objects from the VMM library, selects the template object named VMTemplate01, and stores the object in the $VMTemplate variable.

The last command gets all virtual network adapter objects VMTemplate01 and displays information about these adapters to the user.

Example 3: Get virtual network adapters from a hardware profile

PS C:\> $HWProfile = Get-SCHardwareProfile | where { $_.Name -eq "NewHWProfile01" }
PS C:\> Get-SCVirtualNetworkAdapter -HardwareProfile $HWProfile

The first command gets all hardware profile objects in the VMM library, selects the profile object named NewHWProfile01, and then stores the object in the $HWProfile variable.

The second command gets all virtual network adapter objects NewHWProfile01 and displays information about these adapters to the user.

Parameters

-All

Indicates that this cmdlet gets all subordinate objects independent of the parent object.

For example, the command Get-SCVirtualDiskDrive -All gets all virtual disk drive objects regardless of the virtual machine object or template object that each virtual disk drive object is associated with.

Type:SwitchParameter
Required:True
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-HardwareProfile

Specifies a hardware profile object.

Type:HardwareProfile
Required:True
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-ID

Specifies the numerical identifier as a globally unique identifier, or GUID, for a specific object.

Type:Guid
Required:True
Position:0
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-Name

Specifies the name of a network object.

Type:String
Required:False
Position:1
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-OnBehalfOfUser

Specifies a user name. This cmdlet operates on behalf of the user that this parameter specifies.

Type:String
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-OnBehalfOfUserRole

Specifies a user role. To obtain a user role, use the Get-SCUserRole cmdlet. This cmdlet operates on behalf of the user role that this parameter specifies.

Type:UserRole
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ParentTypeVMOrHost

Indicates that the parent type is a virtual machine or a host.

Type:SwitchParameter
Required:False
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-VM

Specifies a virtual machine object.

Type:VM
Required:True
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-VMHost

Specifies a virtual machine host object. VMM supports Hyper-V hosts, VMware ESX hosts, and Citrix XenServer hosts.

For more information about each type of host, see the Add-SCVMHost cmdlet.

Type:Host
Required:True
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-VMMServer

Specifies a VMM server object.

Type:ServerConnection
Required:False
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-VMTemplate

Specifies a VMM template object used to create virtual machines.

Type:Template
Aliases:Template
Required:True
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False

Outputs

VirtualNetworkAdapter

This cmdlet returns a **VirtualNetworkAdapter** object.

Notes

* Requires a VMM virtual machine object, virtual machine template object, or hardware profile object, which can be retrieved by using the **Get-SCVirtualMachine**, **Get-SCVMTemplate**, or **Get-SCHardwareProfile** cmdlets, respectively.