Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Set-NcFileserviceAudit


NAME
Set-NcFileserviceAudit

SYNOPSIS
Modify audit configuration.

SYNTAX
Set-NcFileserviceAudit [-Destination <String>] [-RotateLimit <Int32>] [-Audi
tGuarantee [<Boolean>]] [-RotateSize <String>] [-Format <String>] [-VserverC
ontext <String>] [-Controller <NcController[]>] [<CommonParameters>]

Set-NcFileserviceAudit [-Destination <String>] [-RotateLimit <Int32>] [-Audi
tGuarantee [<Boolean>]] [-RotateMonth <Int64[]>] [-RotateDayOfMonth <Int64[]
>] [-RotateDayOfWeek <Int64[]>] [-RotateHour <Int64[]>] [-RotateMinute <Int6
4[]>] [-Format <String>] [-VserverContext <String>] [-Controller <NcControll
er[]>] [<CommonParameters>]


DESCRIPTION
Modify audit configuration.


PARAMETERS
-Destination <String>
Audit log destination path. This is the path where consolidated audit lo
gs are stored.

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

-RotateLimit <Int32>
Audit log files rotation Limit. A value of 0 indicates that all the file
s will be retained. Default: 0

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

-AuditGuarantee [<Boolean>]
Strict guarantee of auditing for a Vserver. If true, file access is deni
ed if audit record can not be generated. Otherwise, auditing is done on
a best effort basis. Default value: true

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

-RotateSize <String>
Audit log file size limit. By default rotation is done based on size. De
fault: 100MB

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

-Format <String>
The format in which the logs would be generated by consolidation process
. Default: evtx

Possible values:
'xml' - Data ONTAP-Specific XML Log Format,
'evtx' - Microsoft Windows EVTX Log Format

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

-RotateMonth <Int64[]>
Audit log rotation schedule: Month. Valid range: [-1, 11]. A value of
-1 indicates all months.

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

-RotateDayOfMonth <Int64[]>
Audit log rotation schedule: Day. Valid range: [1,31].

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

-RotateDayOfWeek <Int64[]>
Audit log rotation schedule: Day of Week. Valid range: [-1, 6]. A valu
e of -1 indicates all days of the week.

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

-RotateHour <Int64[]>
Audit log rotation schedule: Hour. Valid range: [0, 23].

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

-RotateMinute <Int64[]>
Audit log rotation schedule: Minute. Valid range: [0, 59].

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


NOTES


Category: fileservice audit
API: fileservice-audit-config-modify
Family: vserver

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

C:\PS>Set-NcFileserviceAudit -RotateDayOfWeek 0,3,5 -RotateHour 6 -RotateMin
ute 30


Set the rotate schedule for the fileservice audit configuration.


AuditGuarantee : True
Destination : /powershell/logs
IsEnabled : False
NcController : 10.63.165.62
RotateLimit : 20
RotateScheduleDay :
RotateScheduleDayofweek : {0, 3, 5}
RotateScheduleHour : {6}
RotateScheduleMinute : {30}
RotateScheduleMonth :
RotateSize :
RotationScheduleDescription : Sun,Wed,Fri@6:30
Vserver : beam01
AuditGuaranteeSpecified : True
IsEnabledSpecified : True
RotateLimitSpecified : True



RELATED LINKS
Get-NcFileserviceAudit
New-NcFileserviceAudit
Remove-NcFileserviceAudit







 Data ONTAP® PowerShell Toolkit