Rename-VMSwitch

Renames a virtual switch.

Syntax

Rename-VMSwitch
      [-Name] <String>
      [-NewName] <String>
      [-CimSession <CimSession[]>]
      [-ComputerName <String[]>]
      [-Confirm]
      [-Credential <PSCredential[]>]
      [-Passthru]
      [-WhatIf]
      [<CommonParameters>]
Rename-VMSwitch
      [-VMSwitch] <VMSwitch>
      [-NewName] <String>
      [-Confirm]
      [-Passthru]
      [-WhatIf]
      [<CommonParameters>]

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
Aliases:SwitchName
Position:0
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-NewName

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

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

Specifies the virtual switch to be renamed.

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

Optional Parameters

-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-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:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-Credential

Specifies one or more user accounts that have permission to perform this action. The default is the current user.

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

Specifies that a Microsoft.HyperV.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
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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

Outputs

None by default; Microsoft.HyperV.PowerShell.EthernetSwitch if PassThru is specified.