Edit

Share via


Get-StorageFirmwareInformation

Gets information about firmware on a storage object.

Syntax

ByName (Default)

Get-StorageFirmwareInformation
    [-FriendlyName] <String>
    [-CimSession <CimSession>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

ByUniqueId

Get-StorageFirmwareInformation
    -UniqueId <String>
    [-CimSession <CimSession>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

ByInputObject

Get-StorageFirmwareInformation
    -InputObject <CimInstance[]>
    [-CimSession <CimSession>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

Description

The Get-StorageFirmwareInformation cmdlet gets information about firmware on storage objects. On Non-Volatile Memory Express (NVMe) devices, it lists the number of firmware slots, the active firmware image, and slots that are writeable.

Examples

Example 1: Get firmware information for physical disks

PS C:\>Get-PhysicalDisk | Get-StorageFirmwareInformation

This command uses the Get-PhysicalDisk cmdlet to get all physical disks in the system, and uses the pipeline operator to pass them to Get-StorageFirmwareInformation to get the firmware information for each disk.

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 Get-StorageFirmwareInformation cmdlet gets information about firmware on storage objects. On Non-Volatile Memory Express (NVMe) devices, it lists the number of firmware slots, the active firmware image, and slots that are writeable.

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 Get-StorageFirmwareInformation cmdlet gets information about firmware on storage objects. On Non-Volatile Memory Express (NVMe) devices, it lists the number of firmware slots, the active firmware image, and slots that are writeable.

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

-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

-ThrottleLimit

The Get-StorageFirmwareInformation cmdlet gets information about firmware on storage objects. On Non-Volatile Memory Express (NVMe) devices, it lists the number of firmware slots, the active firmware image, and slots that are writeable.

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 ID used to uniquely identify a Disk object in the system. The ID persists through restarts.

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

PSCustomObject

This cmdlet returns the following firmware information for a storage object:

  • SupportsUpdate. Indicates whether the device is capable of a Windows-compliant firmware update process.
  • NumberOfSlots. The number of firmware slots the device has.
  • ActiveSlotId. Identifies the slot id that corresponds to the slot containing the currently active firmware image.
  • SlotId[] - Array listing all slot IDs.
  • IsSlotWritable[]. Indicates if a firmware image can be downloaded to the slot represented by the ID in the SlotId[] array at the corresponding index.
  • FirmwareVersionInSlot[]. Array showing the firmware revision in each slot.
  • Extended Status. Error information from the storage provider.

Notes

  • This cmdlet is currently limited to use on PhysicalDisk objects.
  • When used in Failover Cluster, cmdlets from the Storage module operate on cluster level (all servers in the cluster).