PowerCLI Reference

New-VirtualPortGroup

Synopsis

This cmdlet creates a new port group on the specified host.

Syntax

New-VirtualPortGroup [-Name] <String> [-VirtualSwitch] <VirtualSwitch> [-VLanId <Int32>] [-Server <VIServer[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Remove-VirtualPortGroup
Set-VirtualPortGroup
Get-VirtualPortGroup

Detailed Description

This cmdlet creates a new port group on the host using the provided parameters.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
NameStringSpecifies a name for the new port group.truefalse
VirtualSwitchVirtualSwitchSpecifies the virtual switch for which you want to create a new port group.truetrue (ByValue)
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
ServerVIServer[]Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.falsefalse
VLanIdInt32Specifies the VLAN ID for ports using this port group. The following values are valid:

0 - specifies that you do not want to associate the port group with a VLAN.
1 to 4094 - specifies a VLAN ID for the port group.
4095 - specifies that the port group should use trunk mode, which allows the guest operating system to manage its own VLAN tags.
falsefalse
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falsefalse

Return Type

The newly created VirtualPortGroup object

Notes

Examples

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

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

$vportgroup =  New-VirtualPortGroup -VirtualSwitch $vswitch  -Name VPortGroup

Creates a virtual port group named VPortGroup on the virtual switch VSwitch.


Copyright © VMware, Inc. All rights reserved.