< Back

New-VirtualPortGroup

Sun Jan 19, 2020 7:01 pm

NAME New-VirtualPortGroup



SYNOPSIS

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





SYNTAX

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

[-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

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





PARAMETERS

-Name <String>

Specifies a name for the new port group.



Required? true

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Server <VIServer[]>

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.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? true



-VirtualSwitch <VirtualSwitch>

Specifies the virtual switch for which you want to create a new port group.



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? true



-VLanId <Int32>

Specifies 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.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

If 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.



Required? false

Position? named

Default value $true

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are

modified.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

The newly created VirtualPortGroup object







NOTES









-------------------------- 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.



RELATED LINKS

Online Version: https://code.vmware.com/doc/preview?id= ... Group.html

Remove-VirtualPortGroup

Set-VirtualPortGroup

Get-VirtualPortGroup