Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: New-NcVscanOnAccessPolicy


NAME
New-NcVscanOnAccessPolicy

SYNOPSIS
Create a Vscan On-Access policy.

SYNTAX
New-NcVscanOnAccessPolicy [-Name] <String> [-Protocol] <String> [-Filter <St
ring[]>] [-MaxFileSize <Int64>] [-ExcludePath <String[]>] [-ExcludeExtension
<String[]>] [-VserverContext <String>] [-Controller <NcController[]>] [<Com
monParameters>]


DESCRIPTION
Create a Vscan On-Access policy.


PARAMETERS
-Name <String>
Name of the policy.

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

-Protocol <String>
File-Access protocol to monitor for On-Access scanning.
Possible values:
'cifs' - CIFS Protocol

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

-Filter <String[]>
Filters to apply.

Possible values:
'scan_mandatory' - Enable mandatory scan,
'scan_ro_volume' - Enable scans for read-only volume,
'scan_execute_access' - Scan only files opened with execute-access (CIFS
only)

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

-MaxFileSize <Int64>
Max file-size (in bytes) allowed for scanning. The default value is 2GB
.

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

-ExcludePath <String[]>
File paths for which On-Access scanning must not be performed.

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

-ExcludeExtension <String[]>
File extensions for which On-Access scanning must not be performed.

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.Vscan.VscanOnAccessPolicyInfo


NOTES


Category: vscan
API: vscan-on-access-policy-create
Family: vserver

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

C:\PS>New-NcVscanOnAccessPolicy -Name pstk_policy1 -Protocol cifs -MaxFileSi
ze 3GB -Filter scan_execute_access -ExcludeExtension vhd,vhdx


Create a new Vscan On-Access policy.


AdminOwner : vserver
FileExtToExclude : {vhd, vhdx}
Filters : {scan_execute_access}
IsPolicyEnabled : False
MaxFileSize : 3221225472
NcController : 10.63.10.33
PathsToExclude :
PolicyName : pstk_policy1
Protocol : cifs
Vserver : pstk01



RELATED LINKS
Get-NcVscanOnAccessPolicy
Set-NcVscanOnAccessPolicy
Enable-NcVscanOnAccessPolicy
Disable-NcVscanOnAccessPolicy
Remove-NcVscanOnAccessPolicy







 Data ONTAP® PowerShell Toolkit