Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Get-NcFpolicyScope


NAME
Get-NcFpolicyScope

SYNOPSIS
Get a list of FPolicy scope options.

SYNTAX
Get-NcFpolicyScope [[-PolicyName] <String[]>] [[-Vserver] <String[]>] [-Attr
ibutes <FpolicyScopeConfig>] [-VserverContext <String>] [-Controller <NcCont
roller[]>] [<CommonParameters>]

Get-NcFpolicyScope -Template [-VserverContext <String>] [-Controller <NcCont
roller[]>] [<CommonParameters>]

Get-NcFpolicyScope -Query <FpolicyScopeConfig> [-Attributes <FpolicyScopeCon
fig>] [-VserverContext <String>] [-Controller <NcController[]>] [<CommonPara
meters>]


DESCRIPTION
Get a list of FPolicy scope options. FPolicy scope consists of share, volume
, export policy, volume, file extension.


PARAMETERS
-PolicyName <String[]>
One or more Fpolicy policies for which to get scope information. Data O
NTAP wildcards are permitted.

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

-Vserver <String[]>
Restrict the results to one or more vservers. Data ONTAP wildcards are
permitted.

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

-Attributes <FpolicyScopeConfig>
For improved scalability in large clusters, provide an FpolicyScopeConfi
g object with various fields set to indicate which fields to return on a
ll objects. Undesired fields should remain set to null. Use "Get-NcFpo
licyScope -Template" to get the initially empty FpolicyScopeConfig objec
t. 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 FpolicyScopeConfig object for use with advanced
queries involving the Query attribute.

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

-Query <FpolicyScopeConfig>
For advanced queries, provide an FpolicyScopeConfig object with various
fields set to indicate which records to retrieve. Other fields should r
emain set to null. Use "Get-NcFpolicyScope -Template" to get the initia
lly empty FpolicyScopeConfig 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.Fpolicy.FpolicyScopeConfig


NOTES


Category: fpolicy
API: fpolicy-policy-scope-get-iter
Family: vserver,cluster

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

C:\PS>Get-NcFpolicyScope -PolicyName test_policy


Get the FPolicy scope for the given policy.


CheckExtensionsOnDirectories : False
ExportPoliciesToExclude :
ExportPoliciesToInclude :
FileExtensionsToExclude : {txt}
FileExtensionsToInclude : {vhd, vhdx, vmdk}
NcController : 10.63.165.62
PolicyName : test_policy
SharesToExclude :
SharesToInclude :
VolumesToExclude :
VolumesToInclude : {powershell}
Vserver : beam01


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

C:\PS>$q = Get-NcFpolicyScope -Template
$q.FileExtensionsToInclude = @('vhd', 'vhdx')
Get-NcFpolicyScope -Query $q


Get the FPolicy scope for policies that include the vhd and vhdx file extens
ions.


CheckExtensionsOnDirectories : False
ExportPoliciesToExclude :
ExportPoliciesToInclude :
FileExtensionsToExclude : {txt}
FileExtensionsToInclude : {vhd, vhdx, vmdk}
NcController : 10.63.165.62
PolicyName : test_policy
SharesToExclude :
SharesToInclude :
VolumesToExclude :
VolumesToInclude : {powershell}
Vserver : beam01



RELATED LINKS
New-NcFpolicyScope
Set-NcFpolicyScope
Remove-NcFpolicyScope







 Data ONTAP® PowerShell Toolkit