Remove HPOVStorageVolume - HewlettPackard/POSH-HPEOneView GitHub Wiki

HPE OneView 4.10 Library

Remove-HPOVStorageVolume

Remove a Storage Volume

SYNTAX

Remove-HPOVStorageVolume [-InputObject] <Object>[ [-ExportOnly] <SwitchParameter>][ [-Async] <SwitchParameter>] [-ApplianceConnection] <Object>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]

Detailed Description

This cmdlet will remove storage volumes from the HPE OneView appliance. Volumes must first be removed from attached Server Profiles prior to deleting the Storage Volume.

Parameters

-ApplianceConnection <Object>

Aliases [-Appliance]

Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.

Default Value: ${Global:ConnectedSessions} | ? Default

Aliases	Appliance
Required?	true
Position?	named
Default value	(${Global:ConnectedSessions} \| ? Default)
Accept pipeline input?	true (ByPropertyName)
Accept wildcard characters?	False

-Async <SwitchParameter>

Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.

Aliases	None
Required?	false
Position?	named
Default value	false
Accept pipeline input?	false
Accept wildcard characters?	False

-Confirm <SwitchParameter>

Aliases	cf
Required?	false
Position?	named
Default value
Accept pipeline input?	false
Accept wildcard characters?	False

-ExportOnly <SwitchParameter>

Removes the volume from HPE OneView. The volume remains on the storage system, and must be managed manually until it is added back under management of HPE OneView. Default: Delete Export AND Volume from storage system.

Aliases	None
Required?	false
Position?	named
Default value	False
Accept pipeline input?	false
Accept wildcard characters?	False

-InputObject <Object>

Aliases [-StorageVolume, -Name, -URI] Storage Volume Name, URI or Object.

Aliases	uri, name, StorageVolume
Required?	true
Position?	named
Default value
Accept pipeline input?	true (ByValue)
Accept wildcard characters?	False

-WhatIf <SwitchParameter>

Aliases	wi
Required?	false
Position?	named
Default value
Accept pipeline input?	false
Accept wildcard characters?	False

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)

Input Types

HPOneView.Storage.System.Volume [System.Management.Automation.PSCustomObject]

Storage Volume resource object

Return Values

HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]

Async removal task

Examples

-------------------------- EXAMPLE 1 --------------------------

$VolumeToRemove = Get-HPOVStorageVolume -Name TestVol1 -ErrorAction Stop Remove-HPOVStorageVolume -InputObject $VolumeToRemove

Remove export and delete volume named "TestVol1".

-------------------------- EXAMPLE 2 --------------------------

Get-HPOVStorageVolume -Name TestVol1 -ErrorAction Stop | Remove-HPOVStorageVolume -exportonly

Remove export of volume named "TestVol1" only, which leaves the volume still provisioned on the array and is added back to the HPE OneView Storage Volumes pool.

HPE OneView 4.00 Library