Get-StorageNode

Get-StorageNode

Gets storage nodes.

Syntax

Parameter Set: ByName
Get-StorageNode [-AsJob] [-CimSession <CimSession[]> ] [-Name <String[]> ] [-OperationalStatus <OperationalStatus[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByPhysicalDisk
Get-StorageNode [-AsJob] [-CimSession <CimSession[]> ] [-OperationalStatus <OperationalStatus[]> ] [-PhysicalDisk <CimInstance> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByStorageEnclosure
Get-StorageNode [-AsJob] [-CimSession <CimSession[]> ] [-OperationalStatus <OperationalStatus[]> ] [-StorageEnclosure <CimInstance> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByStoragePool
Get-StorageNode [-AsJob] [-CimSession <CimSession[]> ] [-OperationalStatus <OperationalStatus[]> ] [-StoragePool <CimInstance> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByStorageSubSystem
Get-StorageNode [-AsJob] [-CimSession <CimSession[]> ] [-OperationalStatus <OperationalStatus[]> ] [-StorageSubSystem <CimInstance> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByUniqueId
Get-StorageNode [-AsJob] [-CimSession <CimSession[]> ] [-OperationalStatus <OperationalStatus[]> ] [-ThrottleLimit <Int32> ] [-UniqueId <String[]> ] [ <CommonParameters>]

Parameter Set: ByVirtualDisk
Get-StorageNode [-AsJob] [-CimSession <CimSession[]> ] [-OperationalStatus <OperationalStatus[]> ] [-ThrottleLimit <Int32> ] [-VirtualDisk <CimInstance> ] [ <CommonParameters>]

Detailed Description

The Get-StorageNode cmdlet gets objects that represent storage nodes and their operational statuses. Use this cmdlet to get storage nodes to pass to the Get-PhysicalDisk cmdlet or the Get-VirtualDisk cmdlet to get the physical or virtual disks connected to storage nodes. Use the current cmdlet with the Get-StoragePool cmdlet to get the storage pools that storage nodes own.

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

-Name<String[]>

Specifies an array of names. The cmdlet gets the storage nodes that you specify by name.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-OperationalStatus<OperationalStatus[]>

Specifies an array of OperationStatus objects. The cmdlet gets storage nodes that match the operational statuses that you specify. The acceptable values for this parameter are:

-- Dormant
-- Down
-- LowerLayerDown
-- NotPresent
-- Testing
-- Unknown
-- Up

Aliases

none

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 the storage nodes that correspond to the disk that you specify. 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

-StorageEnclosure<CimInstance>

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-StoragePool<CimInstance>

Specifies a storage pool as a CimInstance object. The cmdlet gets storage node associated with storage pool that you specify. To obtain a storage pool object, use the Get-StoragePool 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. The cmdlet gets the storage nodes that belong to the subsystem that you specify. 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 unique IDs, as strings. The cmdlet gets the storage nodes that have the IDs that you specify.

Aliases

Id

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-VirtualDisk<CimInstance>

Specifies a virtual disk as a CimInstance object. The cmdlet gets the storage nodes that correspond to the disk that you specify. To obtain a virtual disk object, use the Get-VirtualDisk cmdlet.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

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_StorageNode[]

    This cmdlet outputs an array of objects that represent storage nodes and their operational statuses.

Examples

Example 1: Get a storage node

This command gets a storage node named StorageNode21.

PS C:\> Get-StorageNode -Name "StorageNode21"

Example 2: Get the operational statuses for all physical disks

This command uses the Get-PhysicalDisk cmdlet to obtain all the physical disks, and then passes them to the current cmdlet by using the pipeline operator. The cmdlet gets the storage nodes and operational statuses for the physical disks.

PS C:\> Get-PhysicalDisk | Get-StorageNode

Get-PhysicalDisk

Get-StoragePool

Get-StorageSubSystem

Get-VirtualDisk