Rename-VMResource Pool

Module:: hyper-v

Renames a resource pool on one or more Hyper-V hosts.

Syntax

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

Description

The Rename-VMResourcePool cmdlet renames a resource pool on one or more Hyper-V hosts.

Examples

Example 1

PS C:\> Rename-VMResourcePool Test VHD Production

Renames a VHD resource pool from Test to Production.

Required Parameters

-Name

Specifies the friendly name of the resource pool to be renamed.

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

-NewName

Specifies the name to which the specified resource pool is to be renamed.

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

-ResourcePoolType

Specifies the type of the resource pool to be renamed.

Type:	VMResourcePoolType
Parameter Sets:	Memory, Processor, Ethernet, VHD, ISO, VFD, FibreChannelPort, FibreChannelConnection, PciExpress
Position:	1
Default value:	None
Accept pipeline input:	True (ByPropertyName)
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 one or more Hyper-V hosts on which the resource pool 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 VMResourcePool object is to be passed through to the pipeline representing the resource pool 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; VMResourcePool if PassThru is specified.