Rename-VMSan
Rename-VMSan
Renames a virtual storage area network (SAN).
Syntax
Parameter Set: Default
Rename-VMSan [-Name] <String> [-NewName] <String> [-ComputerName <String[]> ] [-Passthru] [ <CommonParameters>]
Detailed Description
The Rename-VMSan cmdlet renames a virtual storage area network (SAN).
Parameters
-ComputerName<String[]>
Specifies the name of the Hyper-V host on which the virtual storage area network (SAN) 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 current name of the virtual storage area network (SAN) to be renamed.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-NewName<String>
Specifies the new name of the virtual storage area network (SAN) to be renamed.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Passthru
Specifies that an object is to be passed through to the pipeline representing the renamed virtual storage area network (SAN).
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
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.SAN if –PassThru is specified.
Examples
Example 1
Renames a virtual storage area network from Production to Test.
PS C:\> Rename-VMSan –Name Production –NewName Test