vSphere PowerCLI Reference

Set-VirtualSwitch

Synopsis

Changes the properties of the specified virtual switch.

Syntax

Set-VirtualSwitch [-VirtualSwitch] <VirtualSwitch[]> [[-NumPorts] <Int32>] [[-Nic] <String[]>] [[-Mtu] <Int32>] [-Server <VIServer[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Get-VirtualSwitch
New-VirtualSwitch
Remove-VirtualSwitch

Detailed Description

Changes the properties of the specified virtual switch. The server rounds the value of the NumPorts parameter up to the closest exact power of two, greater than the given number. When updating NumPorts, the user needs to restart the ESX host for the change to take effect.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
VirtualSwitchVirtualSwitch[]Specify the virtual switch you want to configure.truetrue (ByValue)
NumPortsInt32Specify the VirtualSwitch port number. The value is rounded to the closest exact power of two, greater 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. The ESX host the virtual switch belongs to, must be restarted for the change to take effect. Note that the port number displayed in the vSphere Client might differ from the value that you specified for the NumPorts parameter.falsefalse
NicString[]Specify new network interface cards for the virtual switch. The old NICs are replaced by the specified ones.falsefalse
MtuInt32Specify the maximum transmission unit (MTU) associated with the specified virtual switch (in bytes). The MTU value must be greater than 0. This parameter is valid only on VPX 2.5.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

The MTU field is only available on VPX 2.5 and ESX 3.5 . For older VPX ver sions, this field is expected to be null.

Examples

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

$vswitch = New-VirtualSwitch -Host 10.23.115.67 -Name VSwitch

Set-VirtualSwitch -VirtualSwitch $vswitch -MTU 500

Creates a new virtual switch named VSwitch on the virtual machine host on IP address 10.23.115.67. Then sets the virtual switch MTU to 500.

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

$vswitch = New-VirtualSwitch -VMHost 10.23.115.67

$networkAdapters = Get-VMHostNetworkAdapter -VMHost 10.23.115.67 -Physical

$phNic = $networkAdapters[0]

$vSwitch | Set-VirtualSwitch -Nic $phNic

Creates a new virtual switch named VSwitch on the virtual machine host on IP address 10.23.115.67. Then assigns to it a network adapter.

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

Get-VMHost *.128 | Get-VirtualSwitch | Select-Object -First 1 | Set-VirtualSwitch -Nic vmnic5

Add a physical network adapter named 'vmnic5' to the first switch of the host. Note that the 'vmnic5' adapter must not be assigned to other virtual switches.


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