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

Enable-StorageEnclosureIdentification

storageenclosure.cdxml

Synopsis

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

Syntax

Enable-StorageEnclosureIdentification [-FriendlyName] [-AsJob] [-CimSession] [-PassThru] [-SlotNumbers] [-ThrottleLimit] [<CommonParameters>]

Enable-StorageEnclosureIdentification [-AsJob] [-CimSession] [-PassThru] [-SlotNumbers] [-ThrottleLimit] [-InputObject] [<CommonParameters>]

Enable-StorageEnclosureIdentification [-AsJob] [-CimSession] [-PassThru] [-SlotNumbers] [-ThrottleLimit] [-UniqueId] [<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 <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 an array of friendly names. This cmdlet enables identification 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 enables identification 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 <SwitchParameter>

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 disables identification 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

Input Type


Return Type

MSFT_StorageEnclosure[]

Notes

None

Examples

Example 1: Enable identification of an enclosure

This command enables identification for the enclosure named E11.

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.

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

Online Version
Disable-StorageEnclosureIdentification
Get-StorageEnclosure
Get-StorageEnclosureVendorData