< Back
Remove-iBMCVolume
Post
NAME Remove-iBMCVolume
SYNOPSIS
Delete a specified volume of a server.
SYNTAX
Remove-iBMCVolume [-Session] <RedfishSession[]> [-StorageId] <String[]> [-VolumeId] <String[]> [<CommonParameters>]
DESCRIPTION
Delete a specified volume of a server.
This cmdlet works only after BIOS boot is complete when the RAID controller card supports out-of-band management
or after iBMA 2.0 has been installed and started.
PARAMETERS
-Session <RedfishSession[]>
iBMC redfish session object which is created by Connect-iBMC cmdlet.
A session object identifies an iBMC server to which this cmdlet will be executed.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-StorageId <String[]>
Indicates the identifier of the storage which the volume belongs to.
The Id properties of "Get-iBMCRAIDControllers" cmdlet's return value represents Storage ID.
Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-VolumeId <String[]>
Indicates the identifier of the volume to remove.
The Id properties of "Get-iBMCVolume" cmdlet's return value represents Storage ID.
Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
PSObject[]
Returns the remove volume task array if cmdlet executes successfully.
In case of an error or warning, exception will be returned.
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>$credential = Get-Credential
PS C:\\> $Session = Connect-iBMC -Address 10.1.1.2 -Credential $credential -TrustCert
PS C:\\> Remove-iBMCVolume -Session $session -StorageId RAIDStorage0 -VolumeId LogicDrive0
Host : 10.1.1.2
Id : 3
Name : volume deletion task
ActivityName : [10.1.1.2] volume deletion task
TaskState : Completed
StartTime : 2019-01-06T22:48:09+00:00
EndTime : 2019-01-06T22:48:13+00:00
TaskStatus : OK
TaskPercent :
RELATED LINKS
https://github.com/Huawei/Huawei-iBMC-Cmdlets
Get-iBMCVolume
Connect-iBMC
Disconnect-iBMC
SYNOPSIS
Delete a specified volume of a server.
SYNTAX
Remove-iBMCVolume [-Session] <RedfishSession[]> [-StorageId] <String[]> [-VolumeId] <String[]> [<CommonParameters>]
DESCRIPTION
Delete a specified volume of a server.
This cmdlet works only after BIOS boot is complete when the RAID controller card supports out-of-band management
or after iBMA 2.0 has been installed and started.
PARAMETERS
-Session <RedfishSession[]>
iBMC redfish session object which is created by Connect-iBMC cmdlet.
A session object identifies an iBMC server to which this cmdlet will be executed.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-StorageId <String[]>
Indicates the identifier of the storage which the volume belongs to.
The Id properties of "Get-iBMCRAIDControllers" cmdlet's return value represents Storage ID.
Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-VolumeId <String[]>
Indicates the identifier of the volume to remove.
The Id properties of "Get-iBMCVolume" cmdlet's return value represents Storage ID.
Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
PSObject[]
Returns the remove volume task array if cmdlet executes successfully.
In case of an error or warning, exception will be returned.
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>$credential = Get-Credential
PS C:\\> $Session = Connect-iBMC -Address 10.1.1.2 -Credential $credential -TrustCert
PS C:\\> Remove-iBMCVolume -Session $session -StorageId RAIDStorage0 -VolumeId LogicDrive0
Host : 10.1.1.2
Id : 3
Name : volume deletion task
ActivityName : [10.1.1.2] volume deletion task
TaskState : Completed
StartTime : 2019-01-06T22:48:09+00:00
EndTime : 2019-01-06T22:48:13+00:00
TaskStatus : OK
TaskPercent :
RELATED LINKS
https://github.com/Huawei/Huawei-iBMC-Cmdlets
Get-iBMCVolume
Connect-iBMC
Disconnect-iBMC