APIs in Category: sis | API version 1.6

sis-disable sis-enable sis-set-config sis-start 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 |  |

> License
> nearstore_asis2

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 |  |

> License
> nearstore_asis2

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 |  |

> License
> nearstore_asis2

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
> path |  | string | The full path of the SIS volume, /vol/<vol_name>. The volume must be online in order to start SIS operation.
> scan |  | boolean optional | If this is "true", the SIS operation will scan the file system to process all the existing data.

> Errno | Description
> EAPIMISSINGARGUMENT |  |
> EONTAPI_EINVAL |  |
> EAPIERROR |  |

> License
> nearstore_asis2

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 |  |

> License
> nearstore_asis2