Rename-VMSwitch
Rename-VMSwitch
Renames a virtual switch.
Syntax
Parameter Set: SwitchName
Rename-VMSwitch [-Name] <String> [-NewName] <String> [-ComputerName <String[]> ] [-Passthru] [ <CommonParameters>]
Parameter Set: SwitchObject
Rename-VMSwitch [-VMSwitch] <VMSwitch> [-NewName] <String> [-Passthru] [ <CommonParameters>]
Detailed Description
The Rename-VMSwitch cmdlet renames a virtual switch.
Parameters
-ComputerName<String[]>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
. |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of the virtual switch to be renamed.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
true |
-NewName<String>
Specifies the name to which the virtual switch is to be renamed.
Aliases |
none |
Required? |
true |
Position? |
3 |
Default Value |
none |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VMSwitch<VMSwitch>
Specifies the virtual switch to be renamed.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- None by default; Microsoft.Virtualization.Powershell.EthernetSwitch if –PassThru is specified.
Examples
Example 1
Renames virtual switch QoS Switch as IIS Switch.
PS C:\> Rename-VMSwitch “QoS Switch” –NewName “IIS Switch”