Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Remove-VMResourcePool

Last Updated: 3/8/2017

SYNOPSIS

Deletes a resource pool from one or more virtual machine hosts.

SYNTAX

ComputerName (Default)

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

CimSession

Remove-VMResourcePool [-CimSession <CimSession[]>] [-Name] <String> [-ResourcePoolType] <VMResourcePoolType[]>
 [-Passthru] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The Remove-VMResourcePool cmdlet deletes a resource pool from one or more virtual machine hosts.

EXAMPLES

Example 1

PS C:\> Remove-VMResourcePool Test VHD

Removes a virtual hard disk resource pool named Test.

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[]
Parameter Sets: CimSession
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ComputerName

Specifies one or more Hyper-V hosts that run this cmdlet. 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[]
Parameter Sets: ComputerName
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
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[]
Parameter Sets: ComputerName
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

Specifies the name of the resource pool.

Type: String
Parameter Sets: (All)
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Passthru

Specifies that a VMResourcePool object is to be passed through to the pipeline representing the removed resource pool.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ResourcePoolType

Specifies the type of the resource pool to be deleted.

Type: VMResourcePoolType[]
Parameter Sets: (All)
Aliases: 
Accepted values: Memory, Processor, Ethernet, VHD, ISO, VFD, FibreChannelPort, FibreChannelConnection, PciExpress

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

None by default; VMResourcePool if PassThru is specified.

NOTES

© 2017 Microsoft