Edit

Share via

Enable-PhysicalDiskIdentification

  • Reference
Module:
Storage

Enables the identification LED on the specified physical disk.

Syntax

Enable-PhysicalDiskIdentification
      [-FriendlyName] <String>
      [-CimSession <CimSession>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [<CommonParameters>]
Enable-PhysicalDiskIdentification
      -UniqueId <String>
      [-CimSession <CimSession>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [<CommonParameters>]
Enable-PhysicalDiskIdentification
      -InputObject <CimInstance[]>
      [-CimSession <CimSession>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [<CommonParameters>]

Description

The Enable-PhysicalDiskIdentification 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).

Examples

Example 1: Enable the identification LED on all physical disks with certain FriendlyName

PS C:\> Enable-PhysicalDiskIdentification -FriendlyName ST2000LM015-2E8174

This example enables the identification LED on all physical disks with FriendlyName ST2000LM015-2E8174.

Example 2: Enable the identification LED on physical disk with certain UniqueId

sPS C:\> Enable-PhysicalDiskIndication -UniqueId 5000C500B1DA75F6

This example enables the identification LED physical disk with UniqueId 5000C500B1DA75F6.

Example 3: Enable the identification LED on all disks that are not healthy

PS C:\>Get-PhysicalDisk | Where-Object -FilterScript { $_.HealthStatus -Ne "healthy" } | Enable-PhysicalDiskIndication

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.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

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

Type:CimSession
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-FriendlyName

Specifies the friendly name of the disk on which to enable the identification LED.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-InputObject

Specifies the input object that is used in a pipeline command.

Type:CimInstance[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ThrottleLimit

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.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UniqueId

Specifies an ID used to uniquely identify a Disk object in the system. The ID persists through restarts.

Type:String
Aliases:Id
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

CimInstance

You can pipe a Disk object to the InputObject parameter.

Outputs

CimInstance

This cmdlet outputs an object that represents the physical disk for which you enabled the identification LED.

Notes

  • The Microsoft.Management.Infrastructure.CimInstance object 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.
  • When used in Failover Cluster, cmdlets from the Storage module operate on cluster level (all servers in the cluster).