Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Enable-PhysicalDiskIndication

Enable-PhysicalDiskIndication

physicaldisk.cdxml

Synopsis

Enables the identification LED on the specified physical disk.

Syntax

Enable-PhysicalDiskIndication [-FriendlyName] [-AsJob] [-CimSession] [-PassThru] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Enable-PhysicalDiskIndication [-AsJob] [-CimSession] [-PassThru] [-ThrottleLimit] [-InputObject] [-Confirm] [-WhatIf] [<CommonParameters>]

Enable-PhysicalDiskIndication [-AsJob] [-CimSession] [-PassThru] [-ThrottleLimit] [-UniqueId] [-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 <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

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 <SwitchParameter>

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 <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_PhysicalDisk

Return Type

Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_PhysicalDisk

Notes

None

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-PhysicalDiskIndication -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 disk 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

Online Version
Where-Object
Disable-PhysicalDiskIndication
Get-StoragePool
Get-VirtualDisk