Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Get-NcFileDirectorySecurityPolicy


NAME
Get-NcFileDirectorySecurityPolicy

SYNOPSIS
Get information about one or more security policies.

SYNTAX
Get-NcFileDirectorySecurityPolicy [[-Name] <String[]>] [-Vserver <String[]>]
[-Attributes <FileDirectorySecurityPolicy>] [-VserverContext <String>] [-Co
ntroller <NcController[]>] [<CommonParameters>]

Get-NcFileDirectorySecurityPolicy -Template [-VserverContext <String>] [-Con
troller <NcController[]>] [<CommonParameters>]

Get-NcFileDirectorySecurityPolicy -Query <FileDirectorySecurityPolicy> [-Att
ributes <FileDirectorySecurityPolicy>] [-VserverContext <String>] [-Controll
er <NcController[]>] [<CommonParameters>]


DESCRIPTION
Get information about one or more security policies. To preserve the securit
y configuration of a file(or, folder) or set of files(or, folders) security
policy has been defined. Policy is a container for tasks and a task associat
es a file/folder path name and the security descriptor that needs to be set
on the file/folder. Every task in a policy is uniquely identified by the fil
e/folder path. Policy can't have duplicate task entries and there is only on
e task per path.


PARAMETERS
-Name <String[]>
Get one or more policy names. 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 <FileDirectorySecurityPolicy>
For improved scalability in large clusters, provide an FileDirectorySecu
rityPolicy object with various fields set to indicate which fields to re
turn on all objects. Undesired fields should remain set to null. Use "
Get-NcFileDirectorySecurityPolicy -Template" to get the initially empty
FileDirectorySecurityPolicy object. If not specified, all data is retur
ned 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 FileDirectorySecurityPolicy 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 <FileDirectorySecurityPolicy>
For advanced queries, provide an FileDirectorySecurityPolicy object with
various fields set to indicate which records to retrieve. Other fields
should remain set to null. Use "Get-NcFileDirectorySecurityPolicy -Tem
plate" to get the initially empty FileDirectorySecurityPolicy 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.FileDirectorySecurity.FileDirectorySecurityPolicy


NOTES


Category: file directory security
API: file-directory-security-policy-get-iter
Family: cluster,vserver

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

C:\PS>Get-NcFileDirectorySecurityPolicy -Name policy_1


Get the security policy.


PolicyName Vserver
---------- -------
policy_1 beam01



RELATED LINKS
New-NcFileDirectorySecurityPolicy
Remove-NcFileDirectorySecurityPolicy







 Data ONTAP® PowerShell Toolkit