Freigeben über

Set-SCVirtualNetworkAdapter

Module:
VirtualMachineManager Module

Changes properties of a virtual network adapter associated with a virtual machine, a virtual machine template, or a hardware profile used to create virtual machines in VMM.

Syntax

SlotIdSpecified 

Set-SCVirtualNetworkAdapter
    -SlotID <Int32>
    -JobGroup <Guid>
    [-IPv4AddressType <EthernetAddressType>]
    [-IPv6AddressType <EthernetAddressType>]
    [-EnableMACAddressSpoofing <Boolean>]
    [-EnableGuestIPNetworkVirtualizationUpdates <Boolean>]
    [-EnableVMNetworkOptimization <Boolean>]
    [-VMNetwork <VMNetwork>]
    [-VMNetworkServiceSetting <String>]
    [-PortClassification <PortClassification>]
    [-VMSubnet <VMSubnet>]
    [-VLanEnabled <Boolean>]
    [-VLanID <UInt16>]
    [-DevicePropertiesAdapterNameMode <DevicePropertiesAdapterNameMode>]
    [-AdapterFlags <VirtualNetworkAdapterFlags>]
    [-VMMServer <ServerConnection>]
    [-VirtualNetwork <String>]
    [-RequiredBandwidth <Decimal>]
    [-NoConnection]
    [-MACAddress <String>]
    [-MACAddressType <String>]
    [-LogicalNetwork <LogicalNetwork>]
    [-NoLogicalNetwork]
    [-VMwarePortGroup <String>]
    [-NetworkLocation <String>]
    [-NetworkTag <String>]
    [-NoPortClassification]
    [-DevicePropertiesAdapterName <String>]
    [-PortACL <PortACL>]
    [-RemovePortACL]
    [-RunAsynchronously]
    [-PROTipID <Guid>]
    [-JobVariable <String>]
    [-OnBehalfOfUser <String>]
    [-OnBehalfOfUserRole <UserRole>]
    [<CommonParameters>]

VirtualNicSpecified 

Set-SCVirtualNetworkAdapter
    [-VirtualNetworkAdapter] <VirtualNetworkAdapter>
    [-IPv4AddressType <EthernetAddressType>]
    [-IPv6AddressType <EthernetAddressType>]
    [-EnableMACAddressSpoofing <Boolean>]
    [-EnableGuestIPNetworkVirtualizationUpdates <Boolean>]
    [-EnableVMNetworkOptimization <Boolean>]
    [-VMNetwork <VMNetwork>]
    [-VMNetworkServiceSetting <String>]
    [-PortClassification <PortClassification>]
    [-VMSubnet <VMSubnet>]
    [-VLanEnabled <Boolean>]
    [-VLanID <UInt16>]
    [-DevicePropertiesAdapterNameMode <DevicePropertiesAdapterNameMode>]
    [-AdapterFlags <VirtualNetworkAdapterFlags>]
    [-VMMServer <ServerConnection>]
    [-VirtualNetwork <String>]
    [-RequiredBandwidth <Decimal>]
    [-NoConnection]
    [-MACAddress <String>]
    [-MACAddressType <String>]
    [-LogicalNetwork <LogicalNetwork>]
    [-NoLogicalNetwork]
    [-JobGroup <Guid>]
    [-VMwarePortGroup <String>]
    [-NetworkLocation <String>]
    [-NetworkTag <String>]
    [-NoPortClassification]
    [-IPv4Addresses <System.Collections.Generic.List`1[System.String]>]
    [-IPv6Addresses <System.Collections.Generic.List`1[System.String]>]
    [-IPv4AddressPools <System.Collections.Generic.List`1[Microsoft.SystemCenter.VirtualMachineManager.StaticIPAddressPool]>]
    [-IPv6AddressPools <System.Collections.Generic.List`1[Microsoft.SystemCenter.VirtualMachineManager.StaticIPAddressPool]>]
    [-DevicePropertiesAdapterName <String>]
    [-PortACL <PortACL>]
    [-RemovePortACL]
    [-RunAsynchronously]
    [-PROTipID <Guid>]
    [-JobVariable <String>]
    [-OnBehalfOfUser <String>]
    [-OnBehalfOfUserRole <UserRole>]
    [<CommonParameters>]

IsCheckpoint 

Set-SCVirtualNetworkAdapter
    [[-VirtualNetworkAdapter] <VirtualNetworkAdapter>]
    -VirtualNetwork <String>
    [-VLanEnabled <Boolean>]
    [-VLanID <UInt16>]
    [-VMMServer <ServerConnection>]
    [-Checkpoint]
    [-RunAsynchronously]
    [-PROTipID <Guid>]
    [-JobVariable <String>]
    [-OnBehalfOfUser <String>]
    [-OnBehalfOfUserRole <UserRole>]
    [<CommonParameters>]

Description

The Set-SCVirtualNetworkAdapter cmdlet changes one or more properties of a virtual network adapter associated with a virtual machine, virtual machine template, or hardware profile used to create virtual machines in a Virtual Machine Manager (VMM) environment.

Operations you can perform include the following:

  • Connect a virtual network adapter to a virtual network.

  • Disconnect a virtual network adapter from a virtual network.

  • Specify a network location and network tag on a virtual network adapter.

  • Specify a MAC address on the virtual network adapter.

  • Enable the use of a virtual local area network (VLAN) and specify a VLAN ID (numerical identifier) for that VLAN on the virtual network adapter.

Examples

Example 1: Connect a virtual network adapter to a virtual network

PS C:\> $VM = Get-SCVirtualMachine -Name "VM01"
PS C:\> $Adapter = Get-SCVirtualNetworkAdapter -VM $VM | where { $_.PhysicalAddress -eq "00:16:D3:CC:00:1B" }
PS C:\> Set-SCVirtualNetworkAdapter -VirtualNetworkAdapter $Adapter -VirtualNetwork "ExternalVirtualNetwork01"

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, selects the adapter object with the physical (MAC) address of 00:16:D3:CC:00:1B, and then stores the object in the $Adapter variable.

The last command connects the virtual network adapter stored in $Adapter to the virtual network named ExternalVirtualNetwork01 on the host that contains VM01.

Example 2: Specify a static MAC address for a virtual network adapter

PS C:\> $VM = Get-SCVirtualMachine -Name "VM02"
PS C:\> $Adapter = Get-SCVirtualNetworkAdapter -VM $VM | where { $_.ID -eq "5c0ee80a-731f-41c8-92f0-85a1619f9a1b" }
PS C:\> Set-SCVirtualNetworkAdapter -VirtualNetworkAdapter $Adapter -PhysicalAddressType "Static" -PhysicalAddress "00:16:D3:CC:00:1C"

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

The second command gets all virtual network adapter objects on VM02, selects the virtual network adapter with the specified ID, and then stores the object in the $Adapter variable. This example assumes that this adapter currently has a dynamic MAC address.

The last command specifies that the virtual network adapter stored in $Adapter use the static MAC address 00:16:D3:CC:00:1C.

Example 3: Specify a static MAC address and assign it to an existing virtual network adapter

PS C:\> $VM = Get-SCVirtualMachine -Name "VM03"
PS C:\> Set-SCVirtualNetworkAdapter -VirtualNetworkAdapter (Get-VirtualNetworkAdapter -VM $VM | where { $_.ID -eq "95e9cfda-861c-44a3-b2ba-2f796dfe691c"}) -MACAddressType "Static" -MACAddress "00-00-00-00-00-00"

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

The second command gets the virtual network adapter object on VM03 by ID, specifies that the adapter uses a static MAC address type, and assigns it a MAC address.

Example 4: Disconnect the specified virtual network adapter from the virtual network

PS C:\> $VM = Get-SCVirtualMachine -Name "VM04"
PS C:\> $Adapters = Get-SCVirtualNetworkAdapter -VM $VM
PS C:\> Set-SCVirtualNetworkAdapter -VirtualNetworkAdapter $Adapters[1] -NoConnection

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

The second command gets all virtual network adapter objects on VM04 and stores the adapter objects in $Adapters. This example assumes that VM04 has at least two virtual network adapters.

The last command uses the NoConnection parameter to disconnect the second virtual network adapter (Adapters[1]) from any virtual network that it is connected to.

Example 5: Specify a VMware port group for an existing virtual machine

PS C:\> $VM = Get-SCVirtualMachine -Name "VM05"
PS C:\> $Adapter = $VM.VirtualNetworkAdapters[0]
PS C:\> Set-SCVirtualNetworkAdapter -VirtualNetworkAdapter $Adapter -VMwarePortGroup "VM Network"

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

The second command stores the first [0] virtual network adapter on VM05 in the $Adapter variable.

The last command sets the virtual network adapter for the adapter stored in $Adapter to VM Network, which is the name of the VMware port group that you want this adapter to connect to.

Parameters

-AdapterFlags

{{Fill AdapterFlags Description}}

Parameter properties

Type:VirtualNetworkAdapterFlags
Default value:None
Accepted values:None, ApplyInfrastructurePortProfileForNetworkController, ApplyNCPortProfileForNetworkController, ApplyInstaceIDPortProfileForNetworkController
Supports wildcards:False
DontShow:False

Parameter sets

SlotIdSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
VirtualNicSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AllowedVLanList

Specifies a list of virtual LANs allowed on a virtual machine network adapter.

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Checkpoint

Indicates to use the Can Checkpoint permission.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

IsCheckpoint
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DevicePropertiesAdapterName

Specifies the name of a network adapter.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SlotIdSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
VirtualNicSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DevicePropertiesAdapterNameMode

Specifies the adapter name mode.

Parameter properties

Type:DevicePropertiesAdapterNameMode
Default value:None
Accepted values:Disabled, VMNetwork, Custom
Supports wildcards:False
DontShow:False

Parameter sets

SlotIdSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
VirtualNicSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EnableGuestIPNetworkVirtualizationUpdates

Indicates whether IP network virtualization updates by a guest is enabled.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False
Aliases:GuestIPNetworkVirtualizationUpdatesEnabled

Parameter sets

SlotIdSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
VirtualNicSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EnableMACAddressSpoofing

Enables, when set to $True, MAC address spoofing.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False
Aliases:MACAddressesSpoofingEnabled

Parameter sets

SlotIdSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
VirtualNicSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EnableVMNetworkOptimization

Enables, when set to $True, virtual machine network optimization.

This feature improves network performance for virtual machines with network adapters that support virtual machine queue (VMQ) or TCP Chimney Offload. VMQ enables creating a unique network queue for each virtual network adapter. TCP Chimney Offload enables network traffic processing to be offloaded from the networking stack.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False
Aliases:VMNetworkOptimizationEnabled

Parameter sets

SlotIdSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
VirtualNicSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IPv4Addresses

Specifies a list of IPv4 addresses.

Parameter properties

Type:

System.Collections.Generic.List`1[System.String]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:IPv4Address

Parameter sets

VirtualNicSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IPv4AddressPools

Specifies a list of IPv4 address pools.

Parameter properties

Type:

System.Collections.Generic.List`1[Microsoft.SystemCenter.VirtualMachineManager.StaticIPAddressPool]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:IPv4AddressPool

Parameter sets

VirtualNicSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IPv4AddressType

Specifies an IPv4 address type. The acceptable values for this parameter are:

  • Dynamic
  • Static

Parameter properties

Type:EthernetAddressType
Default value:None
Accepted values:Dynamic, Static
Supports wildcards:False
DontShow:False

Parameter sets

SlotIdSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
VirtualNicSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IPv6Addresses

Specifies a list of IPv6 addresses.

Parameter properties

Type:

System.Collections.Generic.List`1[System.String]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:IPv6Address

Parameter sets

VirtualNicSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IPv6AddressPools

Specifies a list of IPv6 address pools.

Parameter properties

Type:

System.Collections.Generic.List`1[Microsoft.SystemCenter.VirtualMachineManager.StaticIPAddressPool]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:IPv6AddressPool

Parameter sets

VirtualNicSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IPv6AddressType

Specifies an IPv6 address type. The acceptable values for this parameter are:

  • Dynamic
  • Static

Parameter properties

Type:EthernetAddressType
Default value:None
Accepted values:Dynamic, Static
Supports wildcards:False
DontShow:False

Parameter sets

SlotIdSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
VirtualNicSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-JobGroup

Specifies an identifier for a series of commands that will run as a set just before the final command that includes the same job group identifier runs.

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SlotIdSpecified
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-JobVariable

Specifies that job progress is tracked and stored in the variable named by this parameter.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LogicalNetwork

Specifies a logical network. A logical network is a named grouping of IP subnets and VLANs that is used to organize and simplify network assignments.

Parameter properties

Type:LogicalNetwork
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SlotIdSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
VirtualNicSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MACAddress

Specifies the MAC address, or a set of MAC addresses, for a physical or virtual network adapter on a computer.

  • Example format for a single MAC address: -MACAddress "00-15-5D-B4-DC-00"
  • Example format for a set of MAC addresses: -MACAddress "00-15-5D-B4-DC-00", "00-1A-A0-E3-75-29"

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:EthernetAddress, PhysicalAddress

Parameter sets

SlotIdSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
VirtualNicSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MACAddressType

Specifies the type of MAC address to use for a virtual network adapter. Valid values are: Static, Dynamic.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:EthernetAddressType, PhysicalAddressType

Parameter sets

SlotIdSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
VirtualNicSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NativeVLanId

Specifies the native virtual LAN identifier for a virtual machine network adapter.

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NetworkLocation

Specifies the network location for a physical network adapter or for a virtual network adapter, or changes the default network location of a host's physical network adapter.

Example formats:

  • -NetworkLocation $NetLoc ($NetLoc might contain Corp.Contoso.com)
  • -OverrideNetworkLocation $True -NetworkLocation "HostNICNewLocation.Contoso.com"

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SlotIdSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
VirtualNicSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NetworkTag

Specifies a word or phrase to associate with a virtual network adapter that is configured to connect to a specific internal or external network on the host.

The NetworkTag parameter identifies all virtual machines with the same NetworkTag as members of the same network. VMM uses a NeworkTag (if one exists) when it evaluates hosts as possible candidates on which to deploy a virtual machine. If the host does not include virtual machines on the network with the same NetworkTag as the virtual machine to be placed, the host receives zero stars in the placement process.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Tag

Parameter sets

SlotIdSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
VirtualNicSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NoConnection

Disconnects a virtual network adapter from a virtual network.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SlotIdSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
VirtualNicSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NoLogicalNetwork

Indicates that no logical network is associated with this virtual network adapter.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:NoVMNetwork

Parameter sets

SlotIdSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
VirtualNicSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NoPortClassification

Indicates that a port classification is not provided.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SlotIdSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
VirtualNicSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OnBehalfOfUser

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:UserRole
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PhysicalNetworkAdapterName

Specifies the name of the physical network adapter.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PortACL

Specifies a port ACL object.

Parameter properties

Type:PortACL
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SlotIdSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
VirtualNicSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PortClassification

Specifies the port classification of the switch to which the virtual network adapter connects.

Parameter properties

Type:PortClassification
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SlotIdSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
VirtualNicSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PROTipID

Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RemovePortACL

Indicates that this operation removes the port access control list (ACL).

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SlotIdSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
VirtualNicSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RequiredBandwidth

Specifies the network bandwidth required by a network adapter.

Parameter properties

Type:Decimal
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SlotIdSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
VirtualNicSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SlotID

Specifies a numerical ID used to identify a device.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SlotIdSpecified
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VirtualNetwork

Specifies a virtual network object.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SlotIdSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
VirtualNicSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VirtualNetworkAdapter

Specifies a virtual network adapter object for a virtual machine.

Types of hosts support the following number of virtual network adapters:

  • Hyper-V. Up to four emulated adapters per virtual machine. There is no driver available for an emulated network adapter on a Windows Server 2003 x64 guest operating system.

  • Hyper-V. Up to eight synthetic adapters per virtual machine.

  • VMware ESX. Up to four emulated adapters per virtual machine.

  • Citrix XenServer. Up to seven emulated adapters per virtual machine.

Parameter properties

Type:VirtualNetworkAdapter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

VirtualNicSpecified
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-VLanEnabled

Indicates whether to enable a virtual LAN (VLAN) for use by virtual machines on a Hyper-V or Citrix XenServer host.

  • Example: -VLANEnabled -VLANID 35

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VLanID

Assigns a numerical identifier in the range 1-4094 to a virtual network adapter on a virtual machine or to a physical network adapter on a virtual machine host.

Configure a VLanID on a virtual network adapter of a virtual machine bound to a physical network adapter on the host, or bound to an internal virtual network on the host.

Example format: -VLanEnabled -VLANID 35

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VMMServer

Specifies a VMM server object.

Parameter properties

Type:ServerConnection
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-VMNetwork

Specifies a VM network object.

To get a VM network object, use the Get-SCVMNetwork cmdlet.

Parameter properties

Type:VMNetwork
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SlotIdSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
VirtualNicSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VMNetworkServiceSetting

Specifies a VM network service setting.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SlotIdSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
VirtualNicSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VMSubnet

Specifies a virtual machine subnet object.

To obtain a VMSubnet object, use the Get-SCVMSubnet cmdlet.

Parameter properties

Type:VMSubnet
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SlotIdSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
VirtualNicSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VMwarePortGroup

Specifies the VMware port group.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SlotIdSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
VirtualNicSpecified
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

VirtualNetworkAdapter

This cmdlet returns a VirtualNetworkAdapter object.

Notes

  • Requires a VMM virtual network adapter object, which can be retrieved by using the Get-SCVirtualNetworkAdapter cmdlet.