vSphere PowerCLI Cmdlets Reference

New-VirtualSwitch

Synopsis

Creates a new virtual switch.

Syntax

New-VirtualSwitch [-VMHost] <VMHost> [-Name] <String> [[-NumPorts] <Int32>] [[-Nic] <PhysicalNic[]>] [[-Mtu] <Int32>] [-Server <VIServer[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Get-VirtualSwitch

Detailed Description

Creates a new virtual switch on the host that is specified by the VMHost parameter.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
VMHostVMHostSpecify the host on which you want to create the new virtual switch.truetrue (ByValue)
NameStringSpecify a name for the new virtual switch.truefalse
NumPortsInt32Specify the virtual switch port number. The value is rounded to the closest exact power of two that is bigger than the given number (for example, if the user specifies 67, this number is rounded to 128). The value range is between 1 and 1024. Note that the port number displayed in the vSphere Client might differ from the value that you specified for the NumPorts parameter.falsefalse
NicPhysicalNic[]Specify the physical network interface cards you want to add to the Active NICs of the new virtual switch. This parameter accepts both objects and strings.falsefalse
MtuInt32Specify the maximum transmission unit (MTU) associated with the specified virtual switch (in bytes). The MTU value is always bigger than 0. This parameter is supported only on vCenter 2.5, ESX 3.5, and later..falsefalse
ConfirmSwitchParameterIf the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.falsefalse$true
ServerVIServer[]Specify the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.falsefalse
WhatIfSwitchParameterIndicate that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falsefalse

Return Type

VirtualSwitch

Notes

NumPorts are at least as many as the user specified. (The server rounds it up to the closest exact power of two, greater than the given number) MTU field is only available on vCenter 2.5 and ESX 3.5. For older API versi ons this field is expected to be null.

Examples

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

$vswitch =  New-VirtualSwitch -VMHost 10.23.112.234 -Name VSwitch

Creates a new virtual switch named VSwitch on the virtual machine host with IP address 10.23.112.234.

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

$network = Get-VMHostNetwork -VMHost 10.23.112.234 

$phNic = $network.PhysicalNic[0].DeviceName

$vswitch = New-VirtualSwitch -VMHost 10.23.112.234 -Name VSwitch -Nic $phNic

Creates a new virtual switch named VSwitch on the virtual machine host with IP address 10.23.112.234 with a physical network adapter.

-------------- Example 3 --------------

Get-VMHost *.128 | New-VirtualSwitch -Name VSwitch -Nic vmnic5,vmnic6

Create a virtual switch named VSwitch with two physical network adapters - 'vmnic5' and 'vmnic6'. Note that the 'vmnic5' and 'vmnic6' adapters must not be assigned to other virtual switches.


Copyright © 1998 - 2010 VMware, Inc. All rights reserved.