| description | external help file | Module Name | ms.date | online version | schema | title |
|---|---|---|---|---|---|---|
Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. |
StorageScripts-help.xml |
Storage |
12/20/2016 |
2.0.0 |
Get-PhysicalDisk |
Gets a list of all PhysicalDisk objects visible across any available Storage Management Providers, or optionally a filtered list.
Get-PhysicalDisk [-UniqueId <String>] [-Usage <PhysicalDiskUsage>] [-Description <String>]
[-Manufacturer <String>] [-Model <String>] [-CanPool <Boolean>] [-HealthStatus <PhysicalDiskHealthStatus>]
[-CimSession <CimSession>] [<CommonParameters>]
Get-PhysicalDisk [-ObjectId <String>] [-Usage <PhysicalDiskUsage>] [-Description <String>]
[-Manufacturer <String>] [-Model <String>] [-CanPool <Boolean>] [-HealthStatus <PhysicalDiskHealthStatus>]
[-CimSession <CimSession>] [<CommonParameters>]
Get-PhysicalDisk [[-FriendlyName] <String>] [[-SerialNumber] <String>] [-Usage <PhysicalDiskUsage>]
[-Description <String>] [-Manufacturer <String>] [-Model <String>] [-CanPool <Boolean>]
[-HealthStatus <PhysicalDiskHealthStatus>] [-CimSession <CimSession>] [<CommonParameters>]
Get-PhysicalDisk -InputObject <CimInstance> [-CimSession <CimSession>] [<CommonParameters>]
Get-PhysicalDisk -StorageSubsystem <CimInstance> [-Usage <PhysicalDiskUsage>] [-Description <String>]
[-Manufacturer <String>] [-Model <String>] [-CanPool <Boolean>] [-HealthStatus <PhysicalDiskHealthStatus>]
[-CimSession <CimSession>] [<CommonParameters>]
Get-PhysicalDisk -StorageEnclosure <CimInstance> [-Usage <PhysicalDiskUsage>] [-Description <String>]
[-Manufacturer <String>] [-Model <String>] [-CanPool <Boolean>] [-HealthStatus <PhysicalDiskHealthStatus>]
[-CimSession <CimSession>] [<CommonParameters>]
Get-PhysicalDisk -StorageNode <CimInstance> [-PhysicallyConnected] [-Usage <PhysicalDiskUsage>]
[-Description <String>] [-Manufacturer <String>] [-Model <String>] [-CanPool <Boolean>]
[-HealthStatus <PhysicalDiskHealthStatus>] [-CimSession <CimSession>] [<CommonParameters>]
Get-PhysicalDisk -StoragePool <CimInstance> [-Usage <PhysicalDiskUsage>] [-Description <String>]
[-Manufacturer <String>] [-Model <String>] [-CanPool <Boolean>] [-HealthStatus <PhysicalDiskHealthStatus>]
[-CimSession <CimSession>] [<CommonParameters>]
Get-PhysicalDisk -VirtualDisk <CimInstance> [-VirtualRangeMin <UInt64>] [-VirtualRangeMax <UInt64>]
[-HasAllocations <Boolean>] [-SelectedForUse <Boolean>] [-NoRedundancy] [-Usage <PhysicalDiskUsage>]
[-Description <String>] [-Manufacturer <String>] [-Model <String>] [-CanPool <Boolean>]
[-HealthStatus <PhysicalDiskHealthStatus>] [-CimSession <CimSession>] [<CommonParameters>]
The Get-PhysicalDisk cmdlet gets a list of all PhysicalDisk objects visible across any available Storage Management Providers, or optionally a filtered list of disks.
PS C:\> Get-PhysicalDisk
FriendlyName CanPool OperationalStatus HealthStatus Usage Size
------------ -------- ----------------- ------------ ----- ----
PhysicalDisk4 False OK Healthy Data Store 25 GB
This example returns an array of all PhysicalDisk objects present in the computer. A storage management provider is required to manage physical disks.
PS C:\>Get-PhysicalDisk -CanPool $True
This example returns an array of PhysicalDisk objects that are available for adding to a storage pool (they are in a primordial pool).
Gets physical disks that are available for use in a storage pool.
Type: Boolean
Parameter Sets: ByUniqueId, ByObjectId, ByName, ByStorageSubsystem, ByStorageEnclosure, ByStorageNode, ByStoragePool, ByVirtualDisk
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseRuns the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
Type: CimSession
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseGets the physical disks that contain the specified description. Enter a description or use wildcard characters to enter a description pattern.
Type: String
Parameter Sets: ByUniqueId, ByObjectId, ByName, ByStorageSubsystem, ByStorageEnclosure, ByStorageNode, ByStoragePool, ByVirtualDisk
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseGets the physical disk with the specified friendly name. Enter a friendly name or use wildcard characters to enter a name pattern.
Type: String
Parameter Sets: ByName
Aliases:
Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseIndicates whether the cmdlet gets a list of physical disks that host the extents of the virtual disk that you specify by using the VirtualDisk parameter.
Type: Boolean
Parameter Sets: ByVirtualDisk
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the health status of physical disks. The acceptable values for this parameter are:
- Healthy
- Unhealthy
- Unknown
- Warning
Type: PhysicalDiskHealthStatus
Parameter Sets: ByUniqueId, ByObjectId, ByName, ByStorageSubsystem, ByStorageEnclosure, ByStorageNode, ByStoragePool, ByVirtualDisk
Aliases:
Accepted values: Healthy, Warning, Unhealthy, Unknown
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the input object that is used in a pipeline command.
Type: CimInstance
Parameter Sets: ByInputObject
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseGets the physical disks with the specified manufacturer. Enter a manufacturer string or use wildcard characters to enter a pattern.
Type: String
Parameter Sets: ByUniqueId, ByObjectId, ByName, ByStorageSubsystem, ByStorageEnclosure, ByStorageNode, ByStoragePool, ByVirtualDisk
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseGets the physical disks of the specified model. Enter a model string or use wildcard characters to enter a pattern.
Type: String
Parameter Sets: ByUniqueId, ByObjectId, ByName, ByStorageSubsystem, ByStorageEnclosure, ByStorageNode, ByStoragePool, ByVirtualDisk
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIndicates that this cmdlet gets physical disks that contain the last remaining copy of the data of a virtual disk.
Type: SwitchParameter
Parameter Sets: ByVirtualDisk
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the ID of the physical disk to get.
Type: String
Parameter Sets: ByObjectId
Aliases: PhysicalDiskObjectId
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseIndicates that this cmdlet gets physical disks that are physically connected to the specified storage node.
Type: SwitchParameter
Parameter Sets: ByStorageNode
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIndicates whether the cmdlet gets a list of physical disks to host the extents that belong to the virtual disk specified by the VirtualDisk parameter. Specify the physical disks to host the extents of a virtual disk by using the PhysicalDisksToUse parameter of the New-VirtualDisk cmdlet.
Type: Boolean
Parameter Sets: ByVirtualDisk
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the serial number of the physical disk to get.
Type: String
Parameter Sets: ByName
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSpecifies a storage enclosure associated with the physical disk that this cmdlet gets. To obtain a StorageEnclosure object, use the Get-StorageEnclosure cmdlet.
Type: CimInstance
Parameter Sets: ByStorageEnclosure
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSpecifies a storage node as a CimInstance object. The cmdlet gets the physical disk connected to the node that you specify. To obtain a storage node object, use the Get-StorageNode cmdlet.
Type: CimInstance
Parameter Sets: ByStorageNode
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseAccepts a StoragePool object as input and gets the physical disks that belong to the pool. The Storage Pool CIM object is exposed by the Get-StoragePool cmdlet.
Type: CimInstance
Parameter Sets: ByStoragePool
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSpecifies a storage subsystem. This cmdlet gets physical disks attached to the storage subsystem that you specify. To obtain a StorageSubsystem object, use the Get-StorageSubSystem cmdlet.
Type: CimInstance
Parameter Sets: ByStorageSubsystem
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseGets only the physical disks with the specified IDs. Type one or more IDs (separated by commas), or use wildcard characters to enter a pattern.
Type: String
Parameter Sets: ByUniqueId
Aliases: Id
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSpecifies an allocation method or usage. This cmdlet gets the physical disks that have the specified allocation method. The acceptable values for this parameter are:
- AutoSelect
- HotSpare
- Journal
- ManualSelect
- Retired
- Unknown
Type: PhysicalDiskUsage
Parameter Sets: ByUniqueId, ByObjectId, ByName, ByStorageSubsystem, ByStorageEnclosure, ByStorageNode, ByStoragePool, ByVirtualDisk
Aliases:
Accepted values: Unknown, AutoSelect, ManualSelect, HotSpare, Retired, Journal
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseAccepts a VirtualDisk object as input and gets the physical disks used by the virtual disk. The VirtualDisk object is exposed by the Get-VirtualDisk cmdlet.
Type: CimInstance
Parameter Sets: ByVirtualDisk
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseThis parameter is reserved for future use.
Type: UInt64
Parameter Sets: ByVirtualDisk
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis parameter is reserved for future use.
Type: UInt64
Parameter Sets: ByVirtualDisk
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
You can use the pipeline operator to pass an MSFT_StoragePool object to the StoragePool parameter.
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_StorageSubsystem
You can use the pipeline operator to pass an MSFT_StorageSubsystem object to the StorageSubsystem parameter.
You can use the pipeline operator to pass an MSFT_VirtualDisk object to the VirtualDisk parameter.
The Get-PhysicalDisk cmdlet returns objects that represent physical disks.
- When used in Failover Cluster, cmdlets from the Storage module operate on cluster level (all servers in the cluster).