Rename-VMSwitch

Renames a virtual switch.

Syntax

Rename-VMSwitch
      [-Name] <String>
      [-NewName] <String>
      [-ComputerName <String[]>]
      [-Passthru]
Rename-VMSwitch
      [-VMSwitch] <VMSwitch>
      [-NewName] <String>
      [-Passthru]

Description

The Rename-VMSwitch cmdlet renames a virtual switch.

Examples

Example 1

PS C:\>Rename-VMSwitch "QoS Switch" -NewName "IIS Switch"

Renames virtual switch QoS Switch as IIS Switch.

Required Parameters

-Name

Specifies the name of the virtual switch to be renamed.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:True
-NewName

Specifies the name to which the virtual switch is to be renamed.

Type:String
Position:3
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-VMSwitch

Specifies the virtual switch to be renamed.

Type:VMSwitch
Position:1
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False

Optional Parameters

-ComputerName

Specifies one or more Hyper-V hosts on which the virtual switch is to be renamed. NetBIOS names, IP addresses, and fully-qualified domain names are allowable. The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly.

Type:String[]
Position:Named
Default value:.
Accept pipeline input:False
Accept wildcard characters:False
-Passthru

Specifies that a Microsoft.Virtualization.Powershell.EthernetSwitch object is to be passed through to the pipeline representing the virtual switch to be renamed.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Outputs

None by default; Microsoft.Virtualization.Powershell.EthernetSwitch if -PassThru is specified.