Rename-VMSwitch
Renames a virtual switch.
Syntax
Rename-VMSwitch
[-ComputerName <String[]>]
[-Name] <String>
[-NewName] <String>
[-Passthru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Rename-VMSwitch
[-VMSwitch] <VMSwitch>
[-NewName] <String>
[-Passthru]
[-WhatIf]
[-Confirm]
[<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.
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: | . |
Required: | False |
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: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
Specifies the name of the virtual switch to be renamed.
Type: | String |
Aliases: | SwitchName |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-NewName
Specifies the name to which the virtual switch is to be renamed.
Type: | String |
Position: | 2 |
Default value: | None |
Required: | True |
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 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-VMSwitch
Specifies the virtual switch to be renamed.
Type: | VMSwitch |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
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: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Outputs
None by default; Microsoft.HyperV.PowerShell.EthernetSwitch if -PassThru is specified.