Enable-StorageEnclosureIdentification

Enable-StorageEnclosureIdentification

Enables the identification LED on a storage enclosure or the slots for individual disks.

Syntax

Parameter Set: ByFriendlyName
Enable-StorageEnclosureIdentification [-FriendlyName] <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-PassThru] [-SlotNumbers <UInt32[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByUniqueId
Enable-StorageEnclosureIdentification -UniqueId <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-PassThru] [-SlotNumbers <UInt32[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
Enable-StorageEnclosureIdentification -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-PassThru] [-SlotNumbers <UInt32[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Detailed Description

The Enable-StorageEnclosureIdentification cmdlet enables the identification LED on the specified storage enclosure and, optionally, on the slots for individual disks. Administrators typically use LEDs to locate a physical disk in an enclosure for removal or replacement. 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 an array of friendly names. This cmdlet turns on the identification LED for the enclosures that the names specify or for slots that belong to the specified enclosures.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-InputObject<CimInstance[]>

Specifies an array of storage enclosures as CimInstance objects. This cmdlet turns on the identification LED for the enclosures that the objects specify, or for slots that belong to the specified enclosures. To obtain a storage enclosure object, use the Get-StorageEnclosure cmdlet.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-PassThru

Returns an array of StorageEnclosure objects. 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

-SlotNumbers<UInt32[]>

Specifies an array of slot numbers. This cmdlet turns on the identification LEDs for the slots that the numbers identify.

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 array of IDs. This cmdlet turns on the identification LED for the enclosures that the IDs specify or for slots that belong to the specified enclosures.

Aliases

Id

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

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.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • MSFT_StorageEnclosure[]

    This cmdlet does not generate any output by default. If you specify the Passthru parameter, the cmdlet returns an array of MSFT_StorageEnclosure objects.

Examples

Example 1: Enable identification of an enclosure

This command enables identification for the enclosure named E11.

PowerShell
PS C:\> Enable-StorageEnclosureIdentification -FriendlyName "E11"

Example 2: Enable identification of specified slot numbers

This command enables identification for the slots numbers 20 and 14 of the enclosure named E11.

PowerShell
PS C:\> Enable-StorageEnclosureIdentification -FriendlyName "E11" -SlotNumbers @(20, 14)

Disable-StorageEnclosureIdentification

Get-StorageEnclosure

Get-StorageEnclosureVendorData