Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Set-NcFpolicyPolicy


NAME
Set-NcFpolicyPolicy

SYNOPSIS
Modify a policy.

SYNTAX
Set-NcFpolicyPolicy [-Name] <String> [[-Event] <String[]>] [[-EngineName] <S
tring>] [-Mandatory [<Boolean>]] [-AllowPrivilegedAccess [<Boolean>]] [-Priv
ilegedUserName <String>] [-VserverContext <String>] [-Controller <NcControll
er[]>] [<CommonParameters>]


DESCRIPTION
Modify a policy.


PARAMETERS
-Name <String>
Name of the policy.

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

-Event <String[]>
Events for file access monitoring.

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

-EngineName <String>
Name of the Engine. Default Engine is 'native'.

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

-Mandatory [<Boolean>]
Indicator if the screening with this policy is required, i.e. it will fa
il if no servers are able process the notification registered as a part
of external engine. If set to true, the request will fail if there is no
server to evaluate it. If it's false, the request will succeed.

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

-AllowPrivilegedAccess [<Boolean>]
Indicator if privileged access should be given to FPolicy servers regist
ered for the policy.

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

-PrivilegedUserName <String>
User name for privileged access.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
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

<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.FpolicyPolicyInfo


NOTES


Category: fpolicy
API: fpolicy-policy-modify
Family: vserver

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

C:\PS>Set-NcFpolicyPolicy -Name test_policy -Mandatory $true


Set the given FPolicy policy to mandatory.


AllowPrivilegedAccess : False
EngineName : native
Events : {cifs_event}
IsMandatory : True
NcController : 10.63.165.62
PolicyName : test_policy
PrivilegedUserName :
Vserver : beam01
AllowPrivilegedAccessSpecified : True
IsMandatorySpecified : True



RELATED LINKS
Get-NcFpolicyPolicy
New-NcFpolicyPolicy
Remove-NcFpolicyPolicy







 Data ONTAP® PowerShell Toolkit