Set-SCVMHostNetworkAdapter

Syntax

Set-SCVMHostNetworkAdapter
   [-VMHostNetworkAdapter] <HostNetworkAdapter>
   [-Description <String>]
   [-VLanMode <VlanMode>]
   [-AvailableForPlacement <Boolean>]
   [-UsedForManagement <Boolean>]
   [-SubnetVLan <SubnetVLan[]>]
   [-RemoveUnassignedVLan <UInt16[]>]
   [-AddOrSetLogicalNetwork <LogicalNetwork>]
   [-RemoveLogicalNetwork <LogicalNetwork>]
   [-EnableNetworkVirtualization <Boolean>]
   [-UplinkPortProfileSet <UplinkPortProfileSet>]
   [-RemoveUplinkPortProfileSet]
   [-JobGroup <Guid>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]

Set-SCVMHostNetworkAdapter
   [-VMHostNetworkAdapter] <HostNetworkAdapter>
   [-Description <String>]
   [-VLanEnabled <Boolean>]
   [-VLanMode <VlanMode>]
   [-VLanID <UInt16>]
   [-VLanTrunkID <UInt16[]>]
   [-AvailableForPlacement <Boolean>]
   [-UsedForManagement <Boolean>]
   [-RemoveUnassignedVLan <UInt16[]>]
   [-EnableNetworkVirtualization <Boolean>]
   [-UplinkPortProfileSet <UplinkPortProfileSet>]
   [-RemoveUplinkPortProfileSet]
   [-JobGroup <Guid>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]

Description

The Set-SCVMHostNetworkAdapter cmdlet changes network-related properties for a physical network adapter on a host managed by Virtual Machine Manager (VMM).

Properties that you can change with this cmdlet include:

• VLAN settings: You can use the VLAN parameters to create or modify a single VLAN or multiple VLANs. For an illustration of how to specify VLAN settings, see the examples.

For more information about VLANs and additional examples that illustrate VLAN settings, type Get-Help Add-SCVMHostNetworkAdapter -Detailed.

Examples

Example 1: Create a new virtual network on a host network adapter and specify a VLAN ID for the virtual network

PS C:\> $VMHost = Get-SCVMHost -Computername "VMHost02.Contoso.com"
PS C:\> $HostAdapter = Get-SCVMHostNetworkAdapter -VMHost $VMHost |  where {$_.Name -like "Intel(R) PRO/1000*" }
PS C:\> New-SCVirtualNetwork -Name "VirtualNetwork01" -VMHost $VMHost -VMHostNetworkAdapter $HostAdapter
PS C:\> Set-SCVMHostNetworkAdapter -VMHostNetworkAdapter $HostAdapter -VLanEnabled $True -VLanMode "Access" -VLANID 35

The first command gets the host object named VMHost02 and stores the object in the $VMHost variable.

The second command gets the host network adapter object with a name that begins with "Intel(R) PRO/1000 on VMHost02 and stores the object in the $HostAdapter variable.

The third command creates a virtual network named VirtualNetwork01 on VMHost02 that is bound to the host adapter stored in $HostAdapter.

The last command enables a VLAN, sets the mode to Access (which routes traffic internally within a single VLAN), and assigns the network adapter a VLANID of 35.

Note: This example assumes that that your host is already connected to a VLAN or, if not, that your host has two network adapters. If your host has a single network adapter, assigning the adapter to a VLAN that is unavailable to the VMM server will prevent VMM from managing the host.

Example 2: Add VLan tags to a host network adapter configured in Trunk mode

PS C:\> $VMHost = Get-SCVMHost -Computername "VMHost03.Contoso.com"
PS C:\> $VMHostNIC = Get-SCVMHostNetworkAdapter -VMHost $VMHost -Name "Adapter #3"
PS C:\> $NewVlanTags = $VMHostNIC.VlanTags + @(177,355,1012)
PS C:\> Set-SCVMHostNetworkAdapter -VMHostNetworkAdapter $VMHostNIC -VLANEnabled $TRUE -VLanMode "Trunk" -VLanTrunkID $NewVLanTags

The first command gets the host object named VMHost03 and stores the object in the $VMHost variable.

The second command gets the host network adapter object by specifying the adapter name and stores the object in the $VMHostNIC variable.

The third command uses the VlanTags property of the host network adapter object ($VMHostNIC.VlanTags) and concatenates a new array of tags. The updated array retains the exisiting VlanTags and adds the listed tags to the array. The result of the concatenation is stored in $NewVlanTags.

The last command passes the new list of VLAN tags to the VLANTrunkID parameter of Set-VMHostNetworkAdapter. The VLANMode parameter must specify the value "Trunk" whenever the VLANTrunkID parameter is used to modify the list of VLAN trunk numerical identifiers.

Parameters

-AddOrSetLogicalNetwork

-AvailableForPlacement

-Description

-EnableNetworkVirtualization

-JobGroup

-JobVariable

-PROTipID

-RemoveLogicalNetwork

-RemoveUnassignedVLan

-RemoveUplinkPortProfileSet

-RunAsynchronously

-SubnetVLan

-UplinkPortProfileSet

-UsedForManagement

-VLanEnabled

-VLanID

-VLanMode

-VLanTrunkID

-VMHostNetworkAdapter

Outputs

VMHostNetworkAdapter

This cmdlet returns a VMHostNetworkAdapter object.

Related Links

• Add-SCVMHostNetworkAdapter
• Get-SCVMHost
• Get-SCVMHostNetworkAdapter
• New-SCVirtualNetwork
• Remove-SCVMHostNetworkAdapter