Export (0) Print
Expand All
Expand Minimize

Get-StorageEnclosure

Windows Server 2012 R2 and Windows 8.1

Updated: June 4, 2014

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Get-StorageEnclosure

Gets storage enclosures.

Syntax

Parameter Set: ByUniqueId
Get-StorageEnclosure [-AsJob] [-CimSession <CimSession[]> ] [-HealthStatus <HealthStatus[]> ] [-Manufacturer <String[]> ] [-Model <String[]> ] [-ThrottleLimit <Int32> ] [-UniqueId <String[]> ] [ <CommonParameters>]

Parameter Set: ByFriendlyName
Get-StorageEnclosure [[-FriendlyName] <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-HealthStatus <HealthStatus[]> ] [-Manufacturer <String[]> ] [-Model <String[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByPhysicalDisk
Get-StorageEnclosure [-AsJob] [-CimSession <CimSession[]> ] [-HealthStatus <HealthStatus[]> ] [-Manufacturer <String[]> ] [-Model <String[]> ] [-PhysicalDisk <CimInstance> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByStorageNode
Get-StorageEnclosure [-AsJob] [-CimSession <CimSession[]> ] [-HealthStatus <HealthStatus[]> ] [-Manufacturer <String[]> ] [-Model <String[]> ] [-StorageNode <CimInstance> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByStorageSubSystem
Get-StorageEnclosure [-AsJob] [-CimSession <CimSession[]> ] [-HealthStatus <HealthStatus[]> ] [-Manufacturer <String[]> ] [-Model <String[]> ] [-StorageSubSystem <CimInstance> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]




Detailed Description

The Get-StorageEnclosure cmdlet gets storage enclosures that are visible to your computer.

Parameters

-AsJob

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. The cmdlet gets storage enclosures that the names specify.


Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

true

-HealthStatus<HealthStatus[]>

Specifies an array of health status values. The acceptable values for this parameter are: 

-- Healthy
-- Warning
-- Unhealthy
-- Unknown

Health status describes the health of an enclosure. This cmdlet gets the enclosures that have health statuses that this parameter specifies.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Manufacturer<String[]>

Specifies the name of a manufacturer. This cmdlet gets enclosures for the manufacturers that this parameter identifies.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

true

-Model<String[]>

Specifies an array of model IDs. This cmdlet gets enclosures that the model IDs specify.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

true

-PhysicalDisk<CimInstance>

Specifies a physical disk as a CimInstance object. The cmdlet gets storage enclosures that contain the disk that the object specifies. To obtain a physical disk object, use the Get-PhysicalDisk cmdlet.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-StorageNode<CimInstance>

Specifies a storage node as a CimInstance object. The cmdlet gets storage enclosures connected to the storage node that the object specifies. To obtain a storage node object, use the Get-StorageNode cmdlet.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-StorageSubSystem<CimInstance>

Specifies a storage subsystem as a CimInstance object. This cmdlet gets storage enclosures that belong to the subsystem that the object specifies. To obtain a storage subsystem object, use the Get-StorageSubSystem cmdlet.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

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 gets the enclosures that the IDs specify.


Aliases

Id

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

true

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

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


Examples

Example 1: Get all enclosures

This command gets all the enclosures visible to your computer.


PS C:\> Get-StorageEnclosure

Example 2: Get an enclosure by using a friendly name

This command gets the enclosure named E1.


PS C:\> Get-StorageEnclosure -FriendlyName "E1"

Example 3: Get an enclosure by using an ID

This command gets the enclosure that has the specified UniqueId.


PS C:\> Get-StorageEnclosure -UniqueId "{b2c21800-b833-11e2-9981-806e6f6e6963}"

Example 4: Get unhealthy enclosures

This command gets enclosures that have the health status of Unhealthy.


PS C:\> Get-StorageEnclosure -HealthStatus "Unhealthy"

Example 5: Get enclosures from a manufacturer

This command gets enclosures from a specific manufacturer.


PS C:\> Get-StorageEnclosure -Manufacturer "Fabrikam"

Example 6: Get an enclosure that contains a specified disk

This command uses the Get-PhysicalDisk cmdlet to get the disk named PhysicalDisk35, and then passes that object to the current cmdlet by using the pipeline operator. The current cmdlet gets the enclosure that contains the disk named PhysicalDisk35.


PS C:\> Get-PhysicalDisk -FriendlyName "PhysicalDisk35" | Get-StorageEnclosure

Example 7: Get enclosures attached to a storage node

This command uses the Get-StorageNode cmdlet to get the storage node named Node14, and then passes that object to the current cmdlet by using the pipeline operator. The current cmdlet gets enclosures attached to the node named Node14.


PS C:\> Get-StorageNode -Name "Node14" | Get-StorageEnclosure

Example 8: Get enclosures on a subsystem

This command uses the Get-StorageSubSystem cmdlet to get the storage subsystem that has the specified friendly name, and then passes that object to the current cmdlet by using the pipeline operator. The current cmdlet gets enclosures on the specified subsystem.


PS C:\> Get-StorageSubSystem -FriendlyName "Clustered storage spaces on main cluster" | Get-StorageEnclosure

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft