< Back
Set-iBMCVolume
Post
NAME Set-iBMCVolume
SYNOPSIS
Modify properties of the specified volume.
SYNTAX
Set-iBMCVolume [-Session] <RedfishSession[]> [-StorageId] <String[]> [-VolumeId] <String[]> [[-VolumeName]
<String[]>] [[-DefaultReadPolicy] {NoReadAhead | ReadAhead}] [[-DefaultWritePolicy] {WriteThrough |
WriteBackWithBBU | WriteBack}] [[-DefaultCachePolicy] {CachedIO | DirectIO}] [[-AccessPolicy] {ReadWrite |
ReadOnly | Blocked}] [[-DriveCachePolicy] {Unchanged | Enabled | Disabled}] [[-BootEnabled] <Boolean[]>]
[[-BGIEnabled] <Boolean[]>] [[-SSDCachingEnabled] <Boolean[]>] [<CommonParameters>]
DESCRIPTION
Modify properties of the specified volume.
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 be modified.
The Id properties of "Get-iBMCRAIDControllers" cmdlet's return value represents Storage ID.
Required? true
Position? 3
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-VolumeName <String[]>
Indicates the Volume name.
It is a string of up to 15 bytes.
Value range: ASCII code corresponding to 0x20 to 0x7E.
Required? false
Position? 4
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-DefaultReadPolicy
Indicates the default read policy of the volume.
Available Value Set: NoReadAhead, ReadAhead.
- ReadAhead: The RAID controller pre-reads sequential data or the data predicted to be used and saves it in
the cache.
- NoReadAhead: disables the Read Ahead feature.
Required? false
Position? 5
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-DefaultWritePolicy
Indicates the default write policy of the volume.
Available Value Set: WriteThrough, WriteBackWithBBU, WriteBack.
- WriteThrough: After the drive receives all data, the controller sends the host a message indicating that
data transmission is complete.
- WriteBackWithBBU: When no battery backup unit (BBU) is configured or the configured BBU is faulty, the RAID
controller automatically switches to the WriteThrough mode.
- WriteBack: After the controller cache receives all data, the controller sends the host a message indicating
that data transmission is complete.
Required? false
Position? 6
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-DefaultCachePolicy
Indicates the default cache policy of the volume.
- CachedIO: All the read and write requests are processed by the cache of the RAID controller.
Select this value only when CacheCade 1.1 is configured.
- DirectIO: This value has different meanings in read and write scenarios.
* In read scenarios, data is directly read from physical drives.
(If Read Policy is set to Read Ahead, data read requests are processed by the cache of the RAID
controller.)
* In write scenarios, data write requests are processed by the cache of the RAID controller.
(If Write Policy is set to WriteThrough, data is directly written to physical drives.)
Required? false
Position? 7
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-AccessPolicy
Indicates the volume access policy.
Available Value Set: ReadWrite, ReadOnly, Blocked.
- ReadWrite: Read and write operations are allowed.
- ReadOnly: It is read-only.
- Blocked: Access is denied.
Required? false
Position? 8
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-DriveCachePolicy
Indicates the cache policy for member disks.
Available Value Set: Unchanged, Enabled, Disabled.
- Unchanged: uses the default cache policy.
- Enabled: writes data to the cache before writing data to the hard drive.
This option improves data write performance.
However, data will be lost if there is no protection mechanism against power failures.
- Disabled: writes data to a hard drive without caching the data.
Data is not lost if power failures occur.
Required? false
Position? 9
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-BootEnabled <Boolean[]>
Indicates whether the volume is the boot device.
Support values are powershell boolean value: $true(1), $false(0).
Required? false
Position? 10
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-BGIEnabled <Boolean[]>
Indicates whether background initialization is enabled.
Support values are powershell boolean value: $true(1), $false(0).
Required? false
Position? 11
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-SSDCachingEnabled <Boolean[]>
Indicates whether the CacheCade volume is used as the cache.
Support values are powershell boolean value: $true(1), $false(0).
Required? false
Position? 12
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
Null
Returns null 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:\\> Set-iBMCVolume -Session $session -StorageId RAIDStorage0 -VolumeId LogicalDrive0 -VolumeName Volume1 `
-DefaultCachePolicy CachedIO -DefaultWritePolicy WriteBack -DefaultReadPolicy ReadAhead `
-AccessPolicy ReadOnly -DriveCachePolicy Enabled `
-BootEnabled $true -BGIEnabled $true
RELATED LINKS
https://github.com/Huawei/Huawei-iBMC-Cmdlets
Get-iBMCVolume
Connect-iBMC
Disconnect-iBMC
SYNOPSIS
Modify properties of the specified volume.
SYNTAX
Set-iBMCVolume [-Session] <RedfishSession[]> [-StorageId] <String[]> [-VolumeId] <String[]> [[-VolumeName]
<String[]>] [[-DefaultReadPolicy] {NoReadAhead | ReadAhead}] [[-DefaultWritePolicy] {WriteThrough |
WriteBackWithBBU | WriteBack}] [[-DefaultCachePolicy] {CachedIO | DirectIO}] [[-AccessPolicy] {ReadWrite |
ReadOnly | Blocked}] [[-DriveCachePolicy] {Unchanged | Enabled | Disabled}] [[-BootEnabled] <Boolean[]>]
[[-BGIEnabled] <Boolean[]>] [[-SSDCachingEnabled] <Boolean[]>] [<CommonParameters>]
DESCRIPTION
Modify properties of the specified volume.
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 be modified.
The Id properties of "Get-iBMCRAIDControllers" cmdlet's return value represents Storage ID.
Required? true
Position? 3
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-VolumeName <String[]>
Indicates the Volume name.
It is a string of up to 15 bytes.
Value range: ASCII code corresponding to 0x20 to 0x7E.
Required? false
Position? 4
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-DefaultReadPolicy
Indicates the default read policy of the volume.
Available Value Set: NoReadAhead, ReadAhead.
- ReadAhead: The RAID controller pre-reads sequential data or the data predicted to be used and saves it in
the cache.
- NoReadAhead: disables the Read Ahead feature.
Required? false
Position? 5
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-DefaultWritePolicy
Indicates the default write policy of the volume.
Available Value Set: WriteThrough, WriteBackWithBBU, WriteBack.
- WriteThrough: After the drive receives all data, the controller sends the host a message indicating that
data transmission is complete.
- WriteBackWithBBU: When no battery backup unit (BBU) is configured or the configured BBU is faulty, the RAID
controller automatically switches to the WriteThrough mode.
- WriteBack: After the controller cache receives all data, the controller sends the host a message indicating
that data transmission is complete.
Required? false
Position? 6
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-DefaultCachePolicy
Indicates the default cache policy of the volume.
- CachedIO: All the read and write requests are processed by the cache of the RAID controller.
Select this value only when CacheCade 1.1 is configured.
- DirectIO: This value has different meanings in read and write scenarios.
* In read scenarios, data is directly read from physical drives.
(If Read Policy is set to Read Ahead, data read requests are processed by the cache of the RAID
controller.)
* In write scenarios, data write requests are processed by the cache of the RAID controller.
(If Write Policy is set to WriteThrough, data is directly written to physical drives.)
Required? false
Position? 7
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-AccessPolicy
Indicates the volume access policy.
Available Value Set: ReadWrite, ReadOnly, Blocked.
- ReadWrite: Read and write operations are allowed.
- ReadOnly: It is read-only.
- Blocked: Access is denied.
Required? false
Position? 8
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-DriveCachePolicy
Indicates the cache policy for member disks.
Available Value Set: Unchanged, Enabled, Disabled.
- Unchanged: uses the default cache policy.
- Enabled: writes data to the cache before writing data to the hard drive.
This option improves data write performance.
However, data will be lost if there is no protection mechanism against power failures.
- Disabled: writes data to a hard drive without caching the data.
Data is not lost if power failures occur.
Required? false
Position? 9
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-BootEnabled <Boolean[]>
Indicates whether the volume is the boot device.
Support values are powershell boolean value: $true(1), $false(0).
Required? false
Position? 10
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-BGIEnabled <Boolean[]>
Indicates whether background initialization is enabled.
Support values are powershell boolean value: $true(1), $false(0).
Required? false
Position? 11
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-SSDCachingEnabled <Boolean[]>
Indicates whether the CacheCade volume is used as the cache.
Support values are powershell boolean value: $true(1), $false(0).
Required? false
Position? 12
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
Null
Returns null 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:\\> Set-iBMCVolume -Session $session -StorageId RAIDStorage0 -VolumeId LogicalDrive0 -VolumeName Volume1 `
-DefaultCachePolicy CachedIO -DefaultWritePolicy WriteBack -DefaultReadPolicy ReadAhead `
-AccessPolicy ReadOnly -DriveCachePolicy Enabled `
-BootEnabled $true -BGIEnabled $true
RELATED LINKS
https://github.com/Huawei/Huawei-iBMC-Cmdlets
Get-iBMCVolume
Connect-iBMC
Disconnect-iBMC