< Back
Get-NfPool
Post
NAME Get-NfPool
SYNOPSIS
Get pools for the current controller.
SYNTAX
Get-NfPool [-Name] <String> [<CommonParameters>]
Get-NfPool [-All] [<CommonParameters>]
DESCRIPTION
Retrieves one or more pools from the connected NexenaStor controller.
If no name is specified, all pools are retrieved with the exception of the pool hosting the controller's OS.
If no name is specified but the All switch is invoked, all pools are retrieved including the pool hosting the
controller's OS.
If a name is specified, only the named pool is retrieved.
PARAMETERS
-Name <String>
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-All [<SwitchParameter>]
Invoke to retrieve all pools
Required? false
Position? named
Default value False
Accept pipeline input? false
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
Nothing if no matching pools are found.
Otherwise, matching Pool objects
NOTES
Format-Table defaults to converting bytes to Mb/Gb/Tb
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-Pool
Name Health TotalSize Used %Used
---- ------ --------- ---- -----
p1 ONLINE 28.88 GB 100.30 MB 0
p2 ONLINE 28.88 GB 100.31 MB 0
Retrieve pools from current controller
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-Pool -all
Name Health TotalSize Used %Used
---- ------ --------- ---- -----
p1 ONLINE 28.88 GB 100.30 MB 0
p2 ONLINE 28.88 GB 100.31 MB 0
rpool ONLINE 9.63 GB 6.18 GB 41
Retrieve All pools from current controller
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-Pool -Name p2
Name Health TotalSize Used %Used
---- ------ --------- ---- -----
p2 ONLINE 28.88 GB 100.31 MB 0
Retrieve a named pool
RELATED LINKS
SYNOPSIS
Get pools for the current controller.
SYNTAX
Get-NfPool [-Name] <String> [<CommonParameters>]
Get-NfPool [-All] [<CommonParameters>]
DESCRIPTION
Retrieves one or more pools from the connected NexenaStor controller.
If no name is specified, all pools are retrieved with the exception of the pool hosting the controller's OS.
If no name is specified but the All switch is invoked, all pools are retrieved including the pool hosting the
controller's OS.
If a name is specified, only the named pool is retrieved.
PARAMETERS
-Name <String>
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-All [<SwitchParameter>]
Invoke to retrieve all pools
Required? false
Position? named
Default value False
Accept pipeline input? false
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
Nothing if no matching pools are found.
Otherwise, matching Pool objects
NOTES
Format-Table defaults to converting bytes to Mb/Gb/Tb
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-Pool
Name Health TotalSize Used %Used
---- ------ --------- ---- -----
p1 ONLINE 28.88 GB 100.30 MB 0
p2 ONLINE 28.88 GB 100.31 MB 0
Retrieve pools from current controller
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-Pool -all
Name Health TotalSize Used %Used
---- ------ --------- ---- -----
p1 ONLINE 28.88 GB 100.30 MB 0
p2 ONLINE 28.88 GB 100.31 MB 0
rpool ONLINE 9.63 GB 6.18 GB 41
Retrieve All pools from current controller
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-Pool -Name p2
Name Health TotalSize Used %Used
---- ------ --------- ---- -----
p2 ONLINE 28.88 GB 100.31 MB 0
Retrieve a named pool
RELATED LINKS