Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Set-NcSisPolicy


NAME
Set-NcSisPolicy

SYNOPSIS
Modify the attributes of a SIS (dedupe) policy.

SYNTAX
Set-NcSisPolicy [-Name] <String> [[-Schedule] <String>] [-Enabled [<Boolean>
]] [-DurationHours <UInt32>] [-Comment <String>] [-VserverContext <String>]
[-Controller <NcController[]>] [-WhatIf] [-Confirm] [<CommonParameters>]


DESCRIPTION
Modify the attributes of a SIS (dedupe) policy.


PARAMETERS
-Name <String>
The name of the dedupe policy to modify.

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

-Schedule <String>
Cron type job schedule name. When the associated policy is set on a vol
ume, the SIS operation will be triggered for the volume on this schedule
. If this field is not set, the existing value is not modified.

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

-Enabled [<Boolean>]
If the value is true, the SIS policy is active in this cluster. If the
value is false this policy will not be activated by the schedulers and h
ence will be inactive. A policy can be assigned to managed objects alth
ough it is disabled. If the value is not specified, the current setting
s are retained.

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

-DurationHours <UInt32>
The duration in hours for which the scheduled SIS operation should run.
After this time expires, the SIS operation will be stopped even if the
operation is incomplete. If 0 is specified as the duration, the SIS ope
ration will run until it completes. If duration is not provided the cur
rent setting is not modified.

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

-Comment <String>
A brief description of the policy. If a value is not provided the curre
nt settings are retained. An empty string can be used to clear the curr
ent comment setting.

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

-WhatIf


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

-Confirm


Required? false
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.Sis.SisPolicyInfo


NOTES


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

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

C:\PS>Set-NcSisPolicy dailyDedupe -DurationHours 8 -Comment ""


Change the duration of dedupe policy "dailyDedupe" to 8 hours and clear the
associated comment.


NcController : vxeRubble
Comment :
Duration : 8
DurationTS : 08:00:00
Enabled : True
PolicyName : dailyDedupe
Schedule : daily
Vserver : costea01
EnabledSpecified : True



RELATED LINKS
New-NcSisPolicy
Get-NcSisPolicy
Remove-NcSisPolicy







 Data ONTAP® PowerShell Toolkit