Enable-PhysicalDiskIndication
Enable-PhysicalDiskIndication
Enables the identification LED on the specified physical disk.
Syntax
Parameter Set: ByName
Enable-PhysicalDiskIndication [-FriendlyName] <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ByUniqueId
Enable-PhysicalDiskIndication -UniqueId <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: InputObject (cdxml)
Enable-PhysicalDiskIndication -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Enable-PhysicalDiskIndication cmdlet enables the identification LED on the specified physical disk. The LED is typically used for visual identification of the location of a physical disk in an enclosure for removal and replacement operations. This cmdlet requires a storage enclosure that supports SCSI Enclosure Services (SES).
Parameters
-AsJob
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CimSession<CimSession[]>
Runs 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.
Aliases |
Session |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-FriendlyName<String[]>
Specifies the friendly name of the disk on which to enable the identification LED.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-InputObject<CimInstance[]>
Specifies the Disk object on which to enable the LED. Enter a Disk CIM object, which you can get using the Get-Disk cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-PassThru
Specifies that the cmdlet should output an object representing the physical disk for which you enabled the identification LED. By default, this cmdlet does not generate any output.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ThrottleLimit<Int32>
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-UniqueId<String[]>
Specifies an ID used to uniquely identify a Disk object in the system. The ID persists through restarts.
Aliases |
Id |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_PhysicalDisk
You can pipe a Disk object to the InputObject parameter.
Outputs
The output type is the type of the objects that the cmdlet emits.
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_PhysicalDisk
This cmdlet outputs an object that represents the physical disk for which you enabled the identification LED.
Notes
- The
Microsoft.Management.Infrastructure.CimInstanceobject is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
Examples
Example 1: Enable the identification LED on all physical disks in a pool
This example enables the identification LED on all physical disks associated with the Storage Pool SpacePool. This is useful for identifying a specific virtual disk, when the LED on the disk in question is not functioning.
PS C:\> $stpool = (Get-StoragePool -FriendlyName "SpacePool")
PS C:\> Enable-PhsicalDiskIndication -StoragePool $stpool
Example 2: Enable the identification LED on all physical disks used by a virtual disk
This example enables the identification LED on all physical disks associated with the virtual disk named Bruce’s Music to visually identify the Physical Storage associated with the virtual disk.
PS C:\> $vdisk = (Get-VirtualDisk -FriendlyName "Bruce's Music")
PS C:\> Enable-PhysicalDiskIndication -VirtualDisk $vdisk
Example 3: Enable the identification LED on all disks that are not healthy
This example gets all physical disks with a health status that is not Healthy, and pipes the disks to the Enable-PhysicalDiskIndication cmdlet, enabling the LEDs on the disks, if supported by the drive enclosure.
PS C:\> Get-PhysicalDisk | Where-Object -FilterScript { $_.HealthStatus –Ne "healthy" } | Enable-PhysicalDiskIndication