Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Get-NcFlexcache


NAME
Get-NcFlexcache

SYNOPSIS
Get a list of flexcache objects.

SYNTAX
Get-NcFlexcache [[-Vserver] <String[]>] [[-CacheVolume] <String[]>] [[-Origi
nVolume] <String[]>] [-Attributes <FlexcacheInfo>] [-VserverContext <String>
] [-Controller <NcController[]>] [<CommonParameters>]

Get-NcFlexcache -Template [-VserverContext <String>] [-Controller <NcControl
ler[]>] [<CommonParameters>]

Get-NcFlexcache -Query <FlexcacheInfo> [-Attributes <FlexcacheInfo>] [-Vserv
erContext <String>] [-Controller <NcController[]>] [<CommonParameters>]


DESCRIPTION
Get a list of flexcache objects.


PARAMETERS
-Vserver <String[]>
The name of the managing vserver(s). Data ONTAP wildcards are permitted
.

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

-CacheVolume <String[]>
The name of one or more cache volumes. Data ONTAP wildcards are permitt
ed.

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

-OriginVolume <String[]>
The name of one or more origin volumes. Data ONTAP wildcards are permit
ted.

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

-Attributes <FlexcacheInfo>
For improved scalability in large clusters, provide an FlexcacheInfo obj
ect with various fields set to indicate which fields to return on all ob
jects. Undesired fields should remain set to null. Use "Get-NcFlexcach
e -Template" to get the initially empty FlexcacheInfo object. If not sp
ecified, 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 FlexcacheInfo 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 <FlexcacheInfo>
For advanced queries, provide an FlexcacheInfo object with various field
s set to indicate which records to retrieve. Other fields should remain
set to null. Use "Get-NcFlexcache -Template" to get the initially empt
y FlexcacheInfo 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.Flexcache.FlexcacheInfo


NOTES


Category: flexcache
API: flexcache-get-iter
Family: cluster, vserver

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

C:\PS>Get-NcFlexcache -Vserver lemon


Get all of the FlexCache objects for vserver lemon.


CacheVolume CacheState CacheSize CachePercentUsed C
onnectionStatus Vserver
----------- ---------- --------- ---------------- -
--------------- -------
cifs_cache_aggr1 online 30.4 MB 0%
ok lemon


-------------- Example 2 --------------

C:\PS>$q = Get-NcFlexcache -Template
$q.ConnectionStatus = "ok"
Get-NcFlexcache -Query $q


Get all of the FlexCache objects with an "ok" connection status.


CacheVolume CacheState CacheSize CachePercentUsed C
onnectionStatus Vserver
----------- ---------- --------- ---------------- -
--------------- -------
cifs_cache_aggr1 online 30.4 MB 0%
ok lemon



RELATED LINKS
New-NcFlexcache
Remove-NcFlexcache







 Data ONTAP® PowerShell Toolkit