|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Get-NcVolFootprint
NAME
Get-NcVolFootprint
SYNOPSIS
Get a list of volumes and their data and metadata footprints in their parent
aggregate.
SYNTAX
Get-NcVolFootprint [[-Name] <String[]>] [-Vserver <String[]>] [-Attributes <
FootprintInfo>] [-VserverContext <String>] [-Controller <NcController[]>] [<
CommonParameters>]
Get-NcVolFootprint -Template [-VserverContext <String>] [-Controller <NcCont
roller[]>] [<CommonParameters>]
Get-NcVolFootprint -Query <FootprintInfo> [-Attributes <FootprintInfo>] [-Vs
erverContext <String>] [-Controller <NcController[]>] [<CommonParameters>]
DESCRIPTION
Get a list of volumes and their data and metadata footprints in their parent
aggregate. The term footprint is used to refer to space that is considered
used in an aggregate due to data in a specific volume.
PARAMETERS
-Name <String[]>
The name of one or more volumes for which the space usage is requested..
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 <FootprintInfo>
For improved scalability in large clusters, provide a FootprintInfo obje
ct with various fields set to indicate which fields to return on all obj
ects. Undesired fields should remain set to null. Use "Get-NcVolFootpr
int -Template" to get the initially empty FootprintInfo object. If not
specified, all 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 FootprintInfo object for use with advanced queri
es involving the Query attribute.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Query <FootprintInfo>
For advanced queries, provide a FootprintInfo object with various fields
set to indicate which records to retrieve. Other fields should remain
set to null. Use "Get-NcVolFootprint -Template" to get the initially em
pty FootprintInfo 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.FootprintInfo
NOTES
Category: volume
API: volume-footprint-get-iter
Family: cluster,vserver
-------------- Example 1 --------------
C:\PS>Get-NcVolFootprint -Vserver beam01
Get the volume footprint of all the volumes on the given Vserver.
Volume TotalFootprint VolumeBlocksFootprint Fl
exvolMetadataFootprint Vserver
------ -------------- --------------------- --
---------------------- -------
beam01_rootvol 1 GB 2 MB
9 MB beam01
luns 196 MB 5 MB
40 MB beam01
luns_clone 86 MB 4 MB
40 MB beam01
-------------- Example 2 --------------
C:\PS>$query = Get-NcVolFootprint -Template
$query.TotalFootprint = ">500GB"
Get-NcVolFootprint -Query $query
Get the footprint of volumes with a total footprint greater than 500GB.
Volume TotalFootprint VolumeBlocksFootprint Fl
exvolMetadataFootprint Vserver
------ -------------- --------------------- --
---------------------- -------
vol0 1 TB 7 GB
8 GB sfp-cmode-02-01
vol0 1 TB 6 GB
8 GB sfp-cmode-02-02
RELATED LINKS
| Copyright © 2013 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|