Update-StorageFirmware
Updates the firmware on a storage device.
Syntax
ByName (Default)
Update-StorageFirmware
[-FriendlyName] <String>
[-ImagePath <String>]
[-SlotNumber <UInt16>]
[-CimSession <CimSession>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
ByUniqueId
Update-StorageFirmware
-UniqueId <String>
[-ImagePath <String>]
[-SlotNumber <UInt16>]
[-CimSession <CimSession>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
ByInputObject
Update-StorageFirmware
-InputObject <CimInstance[]>
[-ImagePath <String>]
[-SlotNumber <UInt16>]
[-CimSession <CimSession>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
Description
The Update-StorageFirmware cmdlet updates the firmware on a storage device with the specified firmware image.
You can also use Update-StorageFirmware to load firmware that is already on the device but in a non-active slot. The update operation consists of a download step and an activation step that are both performed by this cmdlet.
Examples
Example 1: Update a physical disk
PS C:\>Get-PhysicalDisk -FriendlyName "PhysicalDisk0" | Update-StorageFirmware -ImagePath "C:\Users\Contoso\Desktop\Image.bin" -SlotNumber 0
This command uses the Get-PhysicalDisk cmdlet to get a physical disk, and then uses the pipeline operator to pass the disk to Update-StorageFirmware, which updates the physical disk with the firmware in Image.bin.
Example 2: Activate a firmware image in a different slot
PS C:\>Get-PhysicalDisk -FriendlyName "PhysicalDisk1" | Update-StorageFirmware -SlotNumber 2
This command uses the Get-PhysicalDisk cmdlet to get a physical disk, and then uses the pipeline operator to pass the disk to Update-StorageFirmware, which activates the firmware in slot 2.
Parameters
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
Parameter properties
Type: | SwitchParameter |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-CimSession
The Update-StorageFirmware cmdlet updates the firmware on a storage device with the specified firmware image.
You can also use Update-StorageFirmware to load firmware that is already on the device but in a non-active slot. The update operation consists of a download step and an activation step that are both performed by this cmdlet.
Parameter properties
Type: | CimSession |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-FriendlyName
The Update-StorageFirmware cmdlet updates the firmware on a storage device with the specified firmware image.
You can also use Update-StorageFirmware to load firmware that is already on the device but in a non-active slot. The update operation consists of a download step and an activation step that are both performed by this cmdlet.
Parameter properties
Type: | String |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
ByName
Position: | 0 |
Mandatory: | True |
Value from pipeline: | True |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-ImagePath
The Update-StorageFirmware cmdlet updates the firmware on a storage device with the specified firmware image.
You can also use Update-StorageFirmware to load firmware that is already on the device but in a non-active slot. The update operation consists of a download step and an activation step that are both performed by this cmdlet.
Parameter properties
Type: | String |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-InputObject
Specifies the input object that is used in a pipeline command.
Parameter properties
Type: | CimInstance[] |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
ByInputObject
Position: | Named |
Mandatory: | True |
Value from pipeline: | True |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-SlotNumber
The Update-StorageFirmware cmdlet updates the firmware on a storage device with the specified firmware image.
You can also use Update-StorageFirmware to load firmware that is already on the device but in a non-active slot. The update operation consists of a download step and an activation step that are both performed by this cmdlet.
Parameter properties
Type: | UInt16 |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-ThrottleLimit
The Update-StorageFirmware cmdlet updates the firmware on a storage device with the specified firmware image.
You can also use Update-StorageFirmware to load firmware that is already on the device but in a non-active slot. The update operation consists of a download step and an activation step that are both performed by this cmdlet.
Parameter properties
Type: | Int32 |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-UniqueId
Specifies an array of IDs, as strings.
Parameter properties
Type: | String |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Aliases: | Id |
Parameter sets
ByUniqueId
Position: | Named |
Mandatory: | True |
Value from pipeline: | True |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Outputs
String
This cmdlet returns extended status error information as a String from the storage provider.
Notes
- This cmdlet currently operates on physical disks only.
- When used in Failover Cluster, cmdlets from the Storage module operate on cluster level (all servers in the cluster).