Data ONTAP® PowerShell Toolkit

Switch to clustered Data ONTAP documentation.

Cmdlet: Start-NaSis


NAME
Start-NaSis

SYNOPSIS
Start SIS operation on a SIS volume.

SYNTAX
Start-NaSis [-Path] <String> [-Scan] [-RestartCheckpoint] [-DeleteCheckpoint
] [-Queue] [-ScanAll] [-BuildMetadata] [-QosPolicy <String>] [-Controller <N
aController>] [<CommonParameters>]

Start-NaSis [-Volume] <VolumeInfo> [-Scan] [-RestartCheckpoint] [-DeleteChec
kpoint] [-Queue] [-ScanAll] [-BuildMetadata] [-QosPolicy <String>] [-Control
ler <NaController>] [<CommonParameters>]


DESCRIPTION
Start SIS operation on a SIS volume. The SIS operation must be enabled by En
able-NaSis already. If the SIS operation is already active on the volume, th
is API will fail.


PARAMETERS
-Path <String>
The full path of the SIS volume, /vol/<vol_name>. The volume must be on
line in order to start SIS operation. The /vol/ prefix may be omitted.

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

-Scan
If this is "true", the SIS operation will scan the file system to proces
s all the existing data.

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

-RestartCheckpoint
If specified, the SIS operation will restart from previous checkpoint wi
thout checking for validity. This option should be used along with -Sca
n.

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

-DeleteCheckpoint
If specified, the SIS operation will delete any existing checkpoint and
start the SIS operation from the beginning.

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

-Queue
If specified, the requested SIS operation will be queued if a SIS operat
ion is already running on the volume and the running operation is in the
fingerprint verification phase.

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

-ScanAll
If true, scanner will scan entire volume without applying shared block o
ptimization.

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

-BuildMetadata
If true, scanner will scan the entire volume and generate fingerprint da
tabase without attempting the sharing.

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

-QosPolicy <String>
QoS policy for the sis operation.

Possible values:
"background" - sis operation will run in background with minimal or no i
mpact on data serving client operations
"best-effort" - sis operations may have some impact on data serving clie
nt operations.


Default value: "best-effort"

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

-Controller <NaController>
The Data ONTAP controller object, embodied by an NaController object. T
his parameter is returned by the Connect-NaController cmdlet. If not sp
ecified, the value in the global variable CurrentNaController is used.

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

-Volume <VolumeInfo>
Rather than specifying the volume name, this cmdlet alternatively accept
s a VolumeInfo object.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
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.Types.Volume.VolumeInfo


NOTES


Category: sis
API: sis-start

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

C:\PS>Start-NaSis vol2


Start dedupe on volume 'vol2'.






RELATED LINKS
Get-NaSis
Stop-NaSis







 Data ONTAP® PowerShell Toolkit