Rename-VMSan

Renames a virtual storage area network (SAN).

Syntax

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

Description

The Rename-VMSan cmdlet renames a virtual storage area network (SAN).

Examples

Example 1

PS C:\> Rename-VMSan -Name Production -NewName Test

Renames a virtual storage area network from Production to Test.

Required Parameters

-Name

Specifies the current name of the virtual storage area network (SAN) to be renamed.

Type:String
Aliases:SanName
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-NewName

Specifies the new name of the virtual storage area network (SAN) to be renamed.

Type:String
Position:1
Default value:None
Accept pipeline input:False
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:True (ByPropertyName)
Accept wildcard characters:False
-ComputerName

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.

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 an object is to be passed through to the pipeline representing the renamed virtual storage area network (SAN).

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.VMSan if PassThru is specified.