Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Get-NcVolClone


NAME
Get-NcVolClone

SYNOPSIS
Display a list of FlexClone volumes.

SYNTAX
Get-NcVolClone [[-Name] <String[]>] [-Aggregate <String[]>] [-Vserver <Strin
g[]>] [-Attributes <VolumeCloneInfo>] [-VserverContext <String>] [-Controlle
r <NcController[]>] [<CommonParameters>]

Get-NcVolClone -Template [-Fill] [-VserverContext <String>] [-Controller <Nc
Controller[]>] [<CommonParameters>]

Get-NcVolClone -Query <VolumeCloneInfo> [-Attributes <VolumeCloneInfo>] [-Vs
erverContext <String>] [-Controller <NcController[]>] [<CommonParameters>]


DESCRIPTION
Display a list of FlexClone volumes.


PARAMETERS
-Name <String[]>
The name of one or more volume clones to get. Data ONTAP wildcards are
permitted.

Required? false
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Aggregate <String[]>
Restrict results to the specified aggregates. Data ONTAP wildcards are
permitted.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Vserver <String[]>
Restrict results to the specified vservers. Data ONTAP wildcards are pe
rmitted.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Attributes <VolumeCloneInfo>
For improved scalability in large clusters, provide a VolumeCloneInfo ob
ject with various fields set to indicate which fields to return on all o
bjects. Undesired fields should remain set to null. Use "Get-NcVolClon
e -Template" to get the initially empty VolumeCloneInfo 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 Data ONTAP cluster-mode controller to receive this cmdlet, as embodied
by an NcController object. This parameter is returned by the Connect-N
cController cmdlet. If not specified, the value in the global variable
CurrentNcController is used. In the latter case, if CurrentNcController
contains a collection of NcController objects, this cmdlet is invoked o
n each 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 VolumeCloneInfo object for use with advanced que
ries involving the Query attribute.

Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Fill
Specify when using the Template parameter to recursively fill in all obj
ect types.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Query <VolumeCloneInfo>
For advanced queries, provide a VolumeCloneInfo object with various fiel
ds set to indicate which records to retrieve. Other fields should remai
n set to null. Use "Get-NcVolClone -Template" to get the initially empt
y VolumeCloneInfo 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
NetApp.Ontapi.Filer.C.Volume810.VolumeCloneInfo


NOTES


Category: volume
API: volume-clone-get-iter
Family: cluster, vserver

-------------- Example 1 --------------

C:\PS>Get-NcVolClone


Get all FlexClone volumes.


Name ParentVolume ParentSnapshot Aggregate Vserver
---- ------------ -------------- --------- -------
vol2clone vol2 clone_vol2clone.4 aggr1 vserver1



RELATED LINKS
Get-NcVol
New-NcVolClone







 Data ONTAP® PowerShell Toolkit