< Back
Get-StorageEnclosure
Post
NAME Get-StorageEnclosure
SYNOPSIS
Gets storage enclosures.
SYNTAX
Get-StorageEnclosure [-CimSession <CimSession[]>] [-HealthStatus <HealthStatus[]>] [-Manufacturer <String[]>] [-Model <String[]>] [-ThrottleLimit
<Int32>] [-UniqueId <String[]>] [<CommonParameters>]
Get-StorageEnclosure [-CimSession <CimSession[]>] [-HealthStatus <HealthStatus[]>] [-Manufacturer <String[]>] [-Model <String[]>] [-StorageSubSystem
<CimInstance>] [-ThrottleLimit <Int32>] [<CommonParameters>]
Get-StorageEnclosure [[-FriendlyName] <String[]>] [[-SerialNumber] <System.String[]>] [-CimSession <CimSession[]>] [-HealthStatus <HealthStatus[]>]
[-Manufacturer <String[]>] [-Model <String[]>] [-ThrottleLimit <Int32>] [<CommonParameters>]
Get-StorageEnclosure [-CimSession <CimSession[]>] [-HealthStatus <HealthStatus[]>] [-Manufacturer <String[]>] [-Model <String[]>] [-PhysicalDisk
<CimInstance>] [-ThrottleLimit <Int32>] [<CommonParameters>]
Get-StorageEnclosure [-CimSession <CimSession[]>] [-HealthStatus <HealthStatus[]>] [-Manufacturer <String[]>] [-Model <String[]>] [-PhysicallyConnected]
[-StorageNode <CimInstance>] [-ThrottleLimit <Int32>] [<CommonParameters>]
DESCRIPTION
The Get-StorageEnclosure cmdlet gets storage enclosures that are visible to your computer.
PARAMETERS
-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.
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.
Required? false
Position? 1
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-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.
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Model [<String[]>]
Specifies an array of model IDs. This cmdlet gets enclosures that the model IDs specify.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-PhysicallyConnected [<SwitchParameter>]
Indicates that this cmdlet gets storage enclosures that are physically connected to a storage node.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-SerialNumber [<System.String[]>]
Specifies the serial number of the storage enclosure to get.
Required? false
Position? 2
Default value none
Accept pipeline input? true(ByPropertyName)
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.
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.
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.
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.
Required? false
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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
MSFT_StorageEnclosure[]
This cmdlet returns an array of StorageEnclosure objects.
Example 1: Get all enclosures
PS C:\\>Get-StorageEnclosure
This command gets all the enclosures visible to your computer.
Example 2: Get an enclosure by using a friendly name
PS C:\\>Get-StorageEnclosure -FriendlyName "E1"
This command gets the enclosure named E1.
Example 3: Get an enclosure by using an ID
PS C:\\>Get-StorageEnclosure -UniqueId "{b2c21800-b833-11e2-9981-806e6f6e6963}"
This command gets the enclosure that has the specified UniqueId.
Example 4: Get unhealthy enclosures
PS C:\\>Get-StorageEnclosure -HealthStatus "Unhealthy"
This command gets enclosures that have the health status of Unhealthy.
Example 5: Get enclosures from a manufacturer
PS C:\\>Get-StorageEnclosure -Manufacturer "Fabrikam"
This command gets enclosures from a specific manufacturer.
Example 6: Get an enclosure that contains a specified disk
PS C:\\>Get-PhysicalDisk -FriendlyName "PhysicalDisk35" | Get-StorageEnclosure
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.
Example 7: Get enclosures attached to a storage node
PS C:\\>Get-StorageNode -Name "Node14" | Get-StorageEnclosure
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.
Example 8: Get enclosures on a subsystem
PS C:\\>Get-StorageSubSystem -FriendlyName "Clustered storage spaces on main cluster" | Get-StorageEnclosure
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=816399
Get-StorageEnclosureVendorData
Disable-StorageEnclosureIdentification
Enable-StorageEnclosureIdentification
Get-PhysicalDiskStorageNodeView
Get-StorageNode
Get-StorageSubsystem
SYNOPSIS
Gets storage enclosures.
SYNTAX
Get-StorageEnclosure [-CimSession <CimSession[]>] [-HealthStatus <HealthStatus[]>] [-Manufacturer <String[]>] [-Model <String[]>] [-ThrottleLimit
<Int32>] [-UniqueId <String[]>] [<CommonParameters>]
Get-StorageEnclosure [-CimSession <CimSession[]>] [-HealthStatus <HealthStatus[]>] [-Manufacturer <String[]>] [-Model <String[]>] [-StorageSubSystem
<CimInstance>] [-ThrottleLimit <Int32>] [<CommonParameters>]
Get-StorageEnclosure [[-FriendlyName] <String[]>] [[-SerialNumber] <System.String[]>] [-CimSession <CimSession[]>] [-HealthStatus <HealthStatus[]>]
[-Manufacturer <String[]>] [-Model <String[]>] [-ThrottleLimit <Int32>] [<CommonParameters>]
Get-StorageEnclosure [-CimSession <CimSession[]>] [-HealthStatus <HealthStatus[]>] [-Manufacturer <String[]>] [-Model <String[]>] [-PhysicalDisk
<CimInstance>] [-ThrottleLimit <Int32>] [<CommonParameters>]
Get-StorageEnclosure [-CimSession <CimSession[]>] [-HealthStatus <HealthStatus[]>] [-Manufacturer <String[]>] [-Model <String[]>] [-PhysicallyConnected]
[-StorageNode <CimInstance>] [-ThrottleLimit <Int32>] [<CommonParameters>]
DESCRIPTION
The Get-StorageEnclosure cmdlet gets storage enclosures that are visible to your computer.
PARAMETERS
-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.
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.
Required? false
Position? 1
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-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.
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Model [<String[]>]
Specifies an array of model IDs. This cmdlet gets enclosures that the model IDs specify.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-PhysicallyConnected [<SwitchParameter>]
Indicates that this cmdlet gets storage enclosures that are physically connected to a storage node.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-SerialNumber [<System.String[]>]
Specifies the serial number of the storage enclosure to get.
Required? false
Position? 2
Default value none
Accept pipeline input? true(ByPropertyName)
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.
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.
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.
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.
Required? false
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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
MSFT_StorageEnclosure[]
This cmdlet returns an array of StorageEnclosure objects.
Example 1: Get all enclosures
PS C:\\>Get-StorageEnclosure
This command gets all the enclosures visible to your computer.
Example 2: Get an enclosure by using a friendly name
PS C:\\>Get-StorageEnclosure -FriendlyName "E1"
This command gets the enclosure named E1.
Example 3: Get an enclosure by using an ID
PS C:\\>Get-StorageEnclosure -UniqueId "{b2c21800-b833-11e2-9981-806e6f6e6963}"
This command gets the enclosure that has the specified UniqueId.
Example 4: Get unhealthy enclosures
PS C:\\>Get-StorageEnclosure -HealthStatus "Unhealthy"
This command gets enclosures that have the health status of Unhealthy.
Example 5: Get enclosures from a manufacturer
PS C:\\>Get-StorageEnclosure -Manufacturer "Fabrikam"
This command gets enclosures from a specific manufacturer.
Example 6: Get an enclosure that contains a specified disk
PS C:\\>Get-PhysicalDisk -FriendlyName "PhysicalDisk35" | Get-StorageEnclosure
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.
Example 7: Get enclosures attached to a storage node
PS C:\\>Get-StorageNode -Name "Node14" | Get-StorageEnclosure
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.
Example 8: Get enclosures on a subsystem
PS C:\\>Get-StorageSubSystem -FriendlyName "Clustered storage spaces on main cluster" | Get-StorageEnclosure
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=816399
Get-StorageEnclosureVendorData
Disable-StorageEnclosureIdentification
Enable-StorageEnclosureIdentification
Get-PhysicalDiskStorageNodeView
Get-StorageNode
Get-StorageSubsystem