Syntax
Set-VirtualPortGroup [-Name <String>] [-VLanId <Int32>] [-VirtualPortGroup] <VirtualPortGroup[]> [-WhatIf] [-Confirm] [<CommonParameters>]Related Commands
Online versionDetailed Description
This cmdlet modifies the properties of the specified virtual port group.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| VirtualPortGroup | VirtualPortGroup[] | Specifies the virtual port group whose properties you want to change. | true | true (ByValue) | |
| 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. | false | false | |
| Name | String | Specifies a new name for the virtual port group. | false | false | |
| 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. | false | false | |
| WhatIf | SwitchParameter | Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified. | false | false |
Return Type
Zero or more modified VirtualPortGroup objectsNotes
Examples
-------------- Example 1 --------------
$vswitch = New-VirtualSwitch -VMHost 10.23.112.36 -Name VSwitch $vportgroup1 = New-VirtualPortGroup -VirtualSwitch $vswitch -Name VPortGroup1 $vportgroup2 = Set-VirtualPortGroup -VirtualPortGroup $vportgroup1 -VLanId 1
Creates a new virtual switch named VSwitch on the virtual machine host with IP address 10.23.112.36. Creates a new virtual port group for the new switch named VPortGroup1. Sets the VLAN ID for the ports using the VPortGroup1 group.