Enable-StorageEnclosureIdentification
Enables the identification LED on a storage enclosure or the slots for individual disks.
Syntax
ByFriendlyName (Default)
Enable-StorageEnclosureIdentification
[-FriendlyName] <String[]>
[-SlotNumbers <UInt32[]>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[<CommonParameters>]
ByUniqueId
Enable-StorageEnclosureIdentification
-UniqueId <String[]>
[-SlotNumbers <UInt32[]>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[<CommonParameters>]
InputObject (cdxml)
Enable-StorageEnclosureIdentification
-InputObject <CimInstance[]>
[-SlotNumbers <UInt32[]>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[<CommonParameters>]
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).
Examples
Example 1: Enable identification of an enclosure
PS C:\>Enable-StorageEnclosureIdentification -FriendlyName "E11"
This command enables identification for the enclosure named E11.
Example 2: Enable identification of specified slot numbers
PS C:\>Enable-StorageEnclosureIdentification -FriendlyName "E11" -SlotNumbers @(20, 14)
This command enables identification for the slots numbers 20 and 14 of the enclosure named E11.
Parameters
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
Parameter properties
Type: | SwitchParameter |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | 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.
Parameter properties
Type: | CimSession[] |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Aliases: | Session |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-FriendlyName
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.
Parameter properties
Type: | String[] |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
ByFriendlyName
Position: | 0 |
Mandatory: | True |
Value from pipeline: | False |
Value from pipeline by property name: | True |
Value from remaining arguments: | False |
-InputObject
Specifies the input object that is used in a pipeline command.
Parameter properties
Type: | CimInstance[] |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
InputObject (cdxml)
Position: | Named |
Mandatory: | True |
Value from pipeline: | True |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-PassThru
Returns an array of StorageEnclosure objects. By default, this cmdlet does not generate any output.
Parameter properties
Type: | SwitchParameter |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-SlotNumbers
Specifies an array of slot numbers. This cmdlet turns on the identification LEDs for the slots that the numbers identify.
Parameter properties
Type: | UInt32[] |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | 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.
Parameter properties
Type: | Int32 |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-UniqueId
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.
Parameter properties
Type: | String[] |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Aliases: | Id |
Parameter sets
ByUniqueId
Position: | Named |
Mandatory: | True |
Value from pipeline: | False |
Value from pipeline by property name: | True |
Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Outputs
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.
Notes
- When used in Failover Cluster, cmdlets from the Storage module operate on cluster level (all servers in the cluster).