APIs in Category: sis
 API version 1.9

 
sis-disable
sis-enable
sis-set-config
sis-start
sis-status
sis-stop
Single Instance Storage (SIS) is a method of reducing disk space usage by eliminating duplicate data blocks that have the same content on a volume. The Advanced SIS is available on NearStore platforms. Currently it only applies to flexible volume, but in the future we anticipate that the APIs will be extended to cover aggregate and perhaps other things. Hence, all the sis APIs take a full path instead of a volume name as argument.

NetApp Manage ONTAP
 
sis-disable [top]

Disables SIS operation on a volume. If the SIS operation is active on the volume, it needs to be stopped by "sis-stop" API before disabling.
Input Name Range Type Description
path string
The full path of the SIS volume, /vol/<vol_name>. Only one path can be specified at a time.
 Errno  Description
 EAPIMISSINGARGUMENT
 EONTAPI_EINVAL
 EAPIERROR
 Vfiler-enabled
 Yes
 License
 a_sis

 
sis-enable [top]
Enables SIS on a volume. On a non-SnapVault secondary volume, the SIS operation will be started periodically according to a per-volume schedule. On a SnapVault secondary volume, the SIS operation will be kicked off at the end of the SnapVault transfer. See the "sis-set-config" API for the details about the schedule. Users can also start SIS operation with "sis-start" API.
Input Name Range Type Description
path string
The full path of the SIS volume, /vol/<vol_name>. Only one path can be specified at a time. The volume must be online to enable SIS operation.
 Errno  Description
 EAPIMISSINGARGUMENT
 EAPIERROR
 EONTAPI_EINVAL
 Vfiler-enabled
 Yes
 License
 a_sis

 
sis-set-config [top]
Setup or modify the SIS operation schedule or options for a SIS volume. Currently, only used to config schedule.
Input Name Range Type Description
path string
The full path of the SIS volume, /vol/<vol_name>.
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 run. 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 sun-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 the integers from 0 to 23. Hour ranges such as 8-17 are allowed. Step values can be used in conjuction with ranges. For example, 0-23/2 means "every two hours". The default hour_list is 0, i.e. midnight on the morning of each scheduled day. If "-" is specified, no schedule is set. When a non-SIS volume is enabled the first time, an initial schedule is assigned to the volume. This initial schedule is sun-sat@0, that means "once everyday at midnight". 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 be changed later.
 Errno  Description
 EAPIMISSINGARGUMENT
 EONTAPI_EINVAL
 EAPIERROR
 Vfiler-enabled
 Yes
 License
 a_sis

 
sis-start [top]
Start SIS operation on a SIS volume. The SIS operation must be enabled by sis-enable already. If the SIS operation is already active on the volume, this API will fail.
Input Name Range Type Description
delete-checkpoint boolean
optional
If this is "true", the SIS operation will delete existing checkpoint and start the SIS operation from the beginning. Default Value: "false"
path string
The full path of the SIS volume, /vol/<vol_name>. The volume must be online in order to start SIS operation.
restart-checkpoint boolean
optional
If this is "true", the SIS operation will restart from previous checkpoint without checking for validity. This option should be used along with "scan" option. Default Value: "false"
scan boolean
optional
If this is "true", the SIS operation will scan the file system to process all the existing data. Default Value: "false"
 Errno  Description
 EAPIMISSINGARGUMENT
 EONTAPI_EINVAL
 EAPIERROR
 Vfiler-enabled
 Yes
 License
 a_sis

 
sis-status [top]
Get Status of a SIS volume The same information is available through volume-list-info api but is kept here for the sake of parity with CLI where status is part of SIS command not Vol
Input Name Range Type Description
path string
optional
The full path of the SIS volume, /vol/<vol_name>. Only one path can be specified at a time. The volume must be online if not then an error will be returned. If path variable is not used then the status for all SIS enabled -Online- volumes in the filer will be returned.
verbose boolean
optional
If set to true the output is detailed. Default Value: "false"
 
Output Name Range Type Description
sis-object dense-status[]
Sis status objects returned.
 Errno  Description
 EAPIMISSINGARGUMENT
 EAPIERROR
 EONTAPI_EINVAL
 Vfiler-enabled
 Yes
 License
 a_sis

 
sis-stop [top]
Abort currently active SIS operation on the volume. The SIS operation will remain enabled and the operation can be resumed by "sis-start", SnapVault transfer, or the scheduler.
Input Name Range Type Description
path string
The full path of the SIS volume, /vol/<vol_name>.
 Errno  Description
 EAPIMISSINGARGUMENT
 EONTAPI_EINVAL
 EAPIERROR
 Vfiler-enabled
 Yes
 License
 a_sis

 
Element definition: dense-status [top]
Name Range Type Description
checkpoint-op-type string
optional
Checkpoint Operation Type. Possible values: "-", "Scan", "Start" or "Check" Returned only if verbose option is requested.
checkpoint-progress string
optional
Checkpoint Stage Progress with information as to which stage of de-duplication is checkpointed and how much data is processed for that stage. For eg: 25 MB Scanned, 20 MB Searched, 40 MB (20%) Done, 30 MB Verified. Returned only if verbose option is requested.
checkpoint-stage string
optional
Checkpoint Stage information. Possible values: "-", "Gathering", "Sorting", "Saving_pass1", "Saving_pass2", "Checking", "Checking_pass1" or "Checking_pass2" Returned only if verbose option is requested.
checkpoint-sub-stage string
optional
Checkpoint Sub Stage information. Possible values: "-", "Sort_pass2" Returned only if verbose option is requested.
checkpoint-time integer
optional
Checkpoint creation timestamp. The value is in seconds since January 1, 1970. Returned only if verbose option is requested. Range : [0..2^64-1].
last-operation-begin-timestamp integer
optional
Start timestamp of the last SIS operation. The value is in seconds since January 1, 1970. Returned only if verbose option is requested. Range : [0..2^31-1]
last-operation-end-timestamp integer
optional
End timestamp of the last SIS operation. The value is in seconds since January 1, 1970. Returned only if verbose option is requested. Range : [0..2^31-1]
last-operation-error string
optional
A human readable error message of the last SIS operation. Present when there was an error. Returned only if verbose option is requested and when there is a valid error.
last-operation-size integer
optional
The size in bytes of the last SIS operation. Returned only if verbose option is requested. Range : [0..2^64-1].
path string
Volume for which we SIS information is returned.
progress string
The progress of the current SIS operation with with information as to which stage of de-duplication is currently in progress and how much data is processed for that stage. For eg: 25 MB Scanned, 20 MB Searched, 40 MB (20%) Done, 30 MB Verified.
schedule string
optional
The schedule for SIS operation on the volume. See sis-set-config for the format of the schedule. Returned only if verbose option is requested.
state string
Possible values: "Enabled", or "Disabled".
status string
Possible values: "Idle", "Initializing", "Active", "Pending", or "Undoing".
type string
optional
Possible values: "Regular" or "SnapVault". Any ASIS volume with Snapvault qtree in it would be marked as Snapvault and all others would be returned as type Regular. Returned only if verbose option is requested.