|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Set-NcSis
NAME
Set-NcSis
SYNOPSIS
Set up or modify SIS (dedupe) policy, schedule or options for a volume.
SYNTAX
Set-NcSis [-Name] <String> [-Schedule <String>] [-Policy <String>] [-Compres
sion [<Boolean>]] [-InlineCompression [<Boolean>]] [-EnableIdd [<Boolean>]]
[-QuickCheckFileSize <String>] [-VserverContext <String>] [-Controller <NcCo
ntroller[]>] [<CommonParameters>]
Set-NcSis [-Name] <String> [-Schedule <String>] [-Policy <String>] [-Compres
sion [<Boolean>]] [-InlineCompression [<Boolean>]] -InfiniteVolume [-EnableI
dd [<Boolean>]] [-QuickCheckFileSize <String>] [-VserverContext <String>] [-
Controller <NcController[]>] [<CommonParameters>]
DESCRIPTION
Set up or modify SIS (dedupe) policy, schedule or options for a volume.
When run with the InfiniteVolume switch, the cmdlet runs asynchronously. A
job is returned. The status of the job can be tracked using the Job cmdlets
.
PARAMETERS
-Name <String>
The volume on which to configure SIS operations.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Schedule <String>
The schedule string for the SIS operation.
The format of the schedule: day_list[@hour_list] or hour_list[@day_list]
or "-" or "auto".
The day_list specifies which days of the week the SIS operation should r
un. It is a comma-separated list of the first three letters of the day:
sun, mon, tue, wed, thu, fri, sat. The names are not case sensitive.
Day ranges such as mon-fri can also be given. The default day_list is s
un-sat.
The hour_list specifies which hours of the day the SIS operation should
run on each scheduled day. The hour_list is a comma-separated list of t
he integers from 0 to 23. Hour ranges such as 8-17 are allowed. Step v
alues can be used in conjunction with ranges. For example, 0-23/2 means
"every two hours". The default hour_list is 0, i.e. midnight on the mo
rning of each scheduled day.
If "-" is specified, no schedule is set.
A policy name and schedule must not be specified together in the same ca
ll. If schedule is passed, any previous policy name set on the volume i
s automatically reset.
The "auto" schedule string means the SIS operation will be triggered by
the amount of new data written to the volume. The criterion is subject
to being changed later.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Policy <String>
The SIS policy name to be attached to the volume. The policy name will
determine SIS policy will trigger the scheduled SIS operations. Policy
and Schedule must not be specified together in the same API call. If Po
licy is specified, any previous schedule set on the volume is automatica
lly reset.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Compression [<Boolean>]
If true, compression will be enabled on the SIS volume. If false, compr
ession will be disabled on the volume. If the value is not specified th
e compression state will be unchanged.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-InlineCompression [<Boolean>]
If true, inline compression will be enabled on the SIS volume. If false
, inline compression will be disabled on the volume. If the value is no
t specified, the inline compression state will be unchanged. To enable
inline compression, compression must be enabled either in this call or b
y a previous call to Set-NcSis.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-EnableIdd [<Boolean>]
Enables file level incompressible data detection and quick check incompr
essible data detection for large files. This is per volume option. Once
this set to true, inline compression will do a 4k compression quick che
ck for large files before proceeding with full CG compression. If quick
check finds a 4k within a CG as incompressible, inline compression won't
attempt to compress the CG. And the blocks are written in uncompressed
form to disk. Also once this is enabled, if inline compression encounter
s a incompressible CG within small files, it will mark the file with do
not compress flag. As long as this flag is set on a small file, inline c
ompression won't attempt further compression on the file.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-QuickCheckFileSize <String>
Quick check file size for Incompressible Data Detection. If Incompressib
le data detection is enabled and if the file size is >= QuickCheckFileSi
ze, inline compression will do a 4k quick check before doing full CG com
pression.
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
-InfiniteVolume
Specify the InfiniteVolume parameter to indicate the volume is an Infini
te Volume. If a VolumeAttributes object is piped to this cmdlet, the In
finiteVolume switch will be automatically set.
Required? true
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.Volume.VolumeAttributes
NOTES
Category: sis
API: sis-set-config, sis-set-config-async
Family: vserver
-------------- Example 1 --------------
C:\PS>Set-NcSis testvol2 -Schedule "mon-fri@0,12" -Compression $false | Get-
NcSis
Set dedupe to run Monday through Friday at noon and midnight on the volume '
testvol2'. Also disable compression on this volume.
Path State Status ScheduleOrPolicy Progress
---- ----- ------ ---------------- --------
/vol/testvol2 enabled idle mon-fri@0,12 Idle for 00:39:51
RELATED LINKS
Get-NcSis
Get-NcSisPolicy
| Copyright © 2013 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|