Share via

Remove-SCStoragePool

  • Reference
Module:
VirtualMachineManager

Deletes a storage pool and returns capacity.

Syntax

Remove-SCStoragePool
      [-StoragePool] <StoragePool>
      [-RunAsynchronously]
      [-PROTipID <Guid>]
      [-JobVariable <String>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-SCStoragePool cmdlet deletes storage pools and returns the capacity .

Examples

Example 1: Remove a storage pool

PS C:\> $Pool = Get-SCStoragePool -Name "Pool01"
PS C:\> Remove-SCStoragePool -StoragePool $Pool

The first command gets the storage pool object named Pool01 and stores the object in the $Pool variable.

The second command deletes the storage pool stored in $Pool.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-JobVariable

Specifies that job progress is tracked and stored in the variable named by this parameter.

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

-PROTipID

Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.

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

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

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

-StoragePool

Specifies a storage pool object.

Type:StoragePool
Position:0
Default value:None
Required:True
Accept pipeline input:True
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

StoragePool

This cmdlet returns a StoragePool object.