|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Get-NcVolSpace
NAME
Get-NcVolSpace
SYNOPSIS
Get a list of volumes and a breakup of their used space.
SYNTAX
Get-NcVolSpace [[-Name] <String[]>] [-Vserver <String[]>] [-Attributes <Spac
eInfo>] [-VserverContext <String>] [-Controller <NcController[]>] [<CommonPa
rameters>]
Get-NcVolSpace -Template [-VserverContext <String>] [-Controller <NcControll
er[]>] [<CommonParameters>]
Get-NcVolSpace -Query <SpaceInfo> [-Attributes <SpaceInfo>] [-VserverContext
<String>] [-Controller <NcController[]>] [<CommonParameters>]
DESCRIPTION
Get a list of volumes and a breakup of their used space. This information is
only available when the volume is online.
PARAMETERS
-Name <String[]>
The name of one or more volumes to for which the space usage is requeste
d. Data ONTAP wildcards are permitted.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Vserver <String[]>
Restrict results to the specified vserver(s). Data ONTAP wildcards are
permitted.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Attributes <SpaceInfo>
For improved scalability in large clusters, provide a SpaceInfo object w
ith various fields set to indicate which fields to return on all objects
. Undesired fields should remain set to null. Use "Get-NcVolSpace -Tem
plate" to get the initially empty SpaceInfo object. If not specified, a
ll data is returned for each object.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-VserverContext <String>
Vserver to which to direct this command. If the currently connected con
troller (as embodied by an NcController object) represents a cluster, th
ere are multiple means to address commands to one of its vservers. Eith
er set the Vserver field on the NcController object to direct all subseq
uent commands to that vserver, or supply the VserverContext parameter to
an individual cmdlet. Only cmdlets which may be invoked on vservers of
fer the VserverContext parameter.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Controller <NcController[]>
A clustered Data ONTAP controller to receive this cmdlet, as embodied by
an NcController object. This parameter is returned by the Connect-NcCo
ntroller cmdlet. If not specified, the value in the global variable Cur
rentNcController is used. In the latter case, if CurrentNcController co
ntains a collection of NcController objects, this cmdlet is invoked on e
ach controller in succession.
Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-Template
Specify to get an empty SpaceInfo object for use with advanced queries i
nvolving the Query attribute.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Query <SpaceInfo>
For advanced queries, provide a SpaceInfo object with various fields set
to indicate which records to retrieve. Other fields should remain set
to null. Use "Get-NcVolSpace -Template" to get the initially empty Spac
eInfo object.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".
INPUTS
OUTPUTS
DataONTAP.C.Types.Volume.SpaceInfo
NOTES
Category: volume
API: volume-space-get-iter
Family: cluster,vserver
-------------- Example 1 --------------
C:\PS>Get-NcVolSpace -Vserver beam01
Get the volume space for all of the volumes on beam01.
Volume TotalUsed UserData SnapshotReserve F
ilesystemMetadata Vserver
------ --------- -------- --------------- -
----------------- -------
beam01_rootvol 52 MB 20 KB 51 MB
280 KB beam01
luns 25 GB 76 KB 25 GB
844 KB beam01
luns_clone 25 GB 76 KB 25 GB
844 KB beam01
-------------- Example 2 --------------
C:\PS>$query = Get-NcVolSpace -Template
$query.SnapshotReservePercent = "5"
Get-NcVolSpace -Query $query
Get all of the volume space information for volumes with the default snapsho
t reserve percent.
Volume TotalUsed UserData SnapshotReserve F
ilesystemMetadata Vserver
------ --------- -------- --------------- -
----------------- -------
beam01_rootvol 52 MB 20 KB 51 MB
280 KB beam01
luns 25 GB 40 KB 25 GB
860 KB beam01
luns_clone 25 GB 40 KB 25 GB
860 KB beam01
dummy_root_vol 52 MB 20 KB 51 MB
280 KB dummy
vol1 4 MB 28 KB 4 MB
104 KB dummy
vol0 80 GB 9 GB 71 GB
86 MB sfp-cmode-02-01
vol0 79 GB 8 GB 71 GB
86 MB sfp-cmode-02-02
RELATED LINKS
| Copyright © 2013 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|