APIs in Category: sis
 Vserver API version 1.15

 
sis-disable
sis-enable
sis-get
sis-get-iter
sis-policy-create
sis-policy-delete
sis-policy-get
sis-policy-get-iter
sis-policy-modify
sis-set-config
sis-start
sis-status
sis-stop
These APIs can be used to manage deduplication and compression on flexible volumes. In the following API descriptions, these space saving technologies are collectively referred to as "sis".

A "sis volume" refers to a flexible volume on which deduplication and/or compression has been enabled. It can also refer to volumes where deduplication and/or compression are currently disabled (say, temporarily), but the volume has compressed and/or shared data. Currently, compression can be enabled on a volume, only when deduplication is also enabled on the volume.

A "sis operation" refers to a background operation that is running on a volume to deduplicate and/or compress data in the volume.

In future, the sis APIs may be extended to support other storage entities like aggregates. Hence, all sis APIs accept a "path" argument instead of a volume name.

NetApp Manage ONTAP
 
sis-disable [top]

Disable sis 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
 EVOLUMENOTONLINE
 EOBJECTNOTFOUND
 EVSERVERNOTFOUND
 EVSERVER_OP_NOT_ALLOWED
 EINVALIDINPUTERROR
 Vfiler-enabled
 Yes

 
sis-enable [top]
Enable sis on a volume.

On a non-SnapVault secondary volume, the sis operation will be started periodically according to a per-volume schedule. By default, this schedule is sun-sat@0. (Everyday at 0:00 hours) On a SnapVault secondary volume, the sis operation will be kicked off at the end of the SnapVault transfer. This API does not enable compression on the volume. See the "sis-set-config" API for options to enable compression and for modifying the default schedule set on the volume. A sis operation can also be manually started using the 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 on the volume.
 Errno  Description
 EAPIMISSINGARGUMENT
 EAPIERROR
 EONTAPI_EINVAL
 EINTERNALERROR
 EVOLUMENOTONLINE
 EOBJECTNOTFOUND
 EVSERVERNOTFOUND
 EVSERVER_OP_NOT_ALLOWED
 EINVALIDINPUTERROR
 Vfiler-enabled
 Yes

 
sis-get [top]
Get status of a sis volume.
Input Name Range Type Description
desired-attributes sis-status-info
optional
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
path volume-path
optional
Volume for which sis information is returned. Path is of the format /vol/<vol_name>.
 
Output Name Range Type Description
attributes sis-status-info
The attributes to return with this call.
 Errno  Description
 EAPIMISSINGARGUMENT
 EONTAPI_EINVAL
 EOBJECTNOTFOUND
 EINTERNALERROR
 EVSERVERNOTFOUND
 EVSERVER_OP_NOT_ALLOWED
 EINVALIDINPUTERROR

 
sis-get-iter [top]
Iterate over a list of sis volumes.
Input Name Range Type Description
desired-attributes sis-status-info
optional
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
max-records [1..50] integer
optional
The maximum number of records to return in this call. Default: 20
query sis-status-info
optional
A query that specifies which objects to return. A query could be specified on any number of attributes. All sis objects matching this query up to 'max-records' will be returned.
tag string
optional
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
 
Output Name Range Type Description
attributes-list sis-status-info[]
optional
The list of attributes of sis objects.
next-tag string
optional
Tag for the next call. Not present when there are no more sis objects to return.
num-records [0..50] integer
The number of records returned in this call.
 Errno  Description
 EINTERNALERROR
 EAPIMISSINGARGUMENT
 EONTAPI_EINVAL
 EOBJECTNOTFOUND
 EVSERVERNOTFOUND
 EVSERVER_OP_NOT_ALLOWED
 EINVALIDINPUTERROR

 
sis-policy-create [top]
Create a new sis policy.
Input Name Range Type Description
comment string
optional
A brief description of the policy.
duration string
optional
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 '-' is specified as the duration, the sis operation will run till it completes. Otherwise, the duration has to be an integer greater than 0. By default, the operation runs till it completes.
enabled boolean
optional
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 hence will be inactive. A policy can be assigned to managed objects although it is disabled. Default is "true".
policy-name string
sis policy name.
schedule string
Cron type job schedule name. When the associated policy is set on a volume, the sis operation will be triggered for the volume on this schedule. These schedules can be created using the job-schedule-cron-create API. Existing schedules can be queried using the job-schedule-cron-get-iter API.
 Errno  Description
 EOBJECTNOTFOUND
 EINTERNALERROR
 EVSERVERNOTFOUND
 EVSERVER_OP_NOT_ALLOWED
 EINVALIDINPUTERROR

 
sis-policy-delete [top]
Delete a sis policy.
Input Name Range Type Description
policy-name string
sis policy name.
 Errno  Description
 EOBJECTNOTFOUND
 EINTERNALERROR
 EVSERVERNOTFOUND
 EVSERVER_OP_NOT_ALLOWED
 EINVALIDINPUTERROR

 
sis-policy-get [top]
Get attributes of a sis policy.
Input Name Range Type Description
desired-attributes sis-policy-info
optional
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
policy-name string
sis policy name.
 
Output Name Range Type Description
attributes sis-policy-info
The attributes of the sis-policy.
 Errno  Description
 EOBJECTNOTFOUND
 EINTERNALERROR
 EVSERVERNOTFOUND
 EVSERVER_OP_NOT_ALLOWED
 EINVALIDINPUTERROR

 
sis-policy-get-iter [top]
Iterate over a list of sis policy objects.
Input Name Range Type Description
desired-attributes sis-policy-info
optional
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
max-records [1..20] integer
optional
The maximum number of records to return in this call. Default: 20
query sis-policy-info
optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the sis policy. All sis policy objects matching this query up to 'max-records' will be returned.
tag string
optional
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
 
Output Name Range Type Description
attributes-list sis-policy-info[]
optional
The list of attributes of sis policy objects.
next-tag string
optional
Tag for the next call. Not present when there are no more sis policy objects to return.
num-records [0..20] integer
The number of records returned in this call.
 Errno  Description
 EINTERNALERROR
 EVSERVERNOTFOUND
 EVSERVER_OP_NOT_ALLOWED
 EINVALIDINPUTERROR

 
sis-policy-modify [top]
Modify the attributes of a sis policy.
Input Name Range Type Description
comment string
optional
A brief description of the policy. If a value is not provided the current settings are retained. An empty string can be used to clear the current settings.
duration string
optional
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 '-' is specified as the duration, the sis operation will run till it completes. If duration is not provided the current setting is not modified.
enabled boolean
optional
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 hence will be inactive. A policy can be assigned to managed objects although it is disabled. If the value is not specified, the current settings are retained.
policy-name string
sis policy name. Attributes: key, non-modifiable
schedule string
optional
Cron type job schedule name. When the associated policy is set on a volume, the sis operation will be triggered for the volume on this schedule. If this field is not set, the existing value is not modified.
 Errno  Description
 EOBJECTNOTFOUND
 EINTERNALERROR
 EVSERVERNOTFOUND
 EVSERVER_OP_NOT_ALLOWED
 EINVALIDINPUTERROR

 
sis-set-config [top]
Setup or modify sis policy, schedule or options for a volume.
Input Name Range Type Description
enable-compression boolean
optional
Enable compression on the sis volume. If true, compression will be enabled on the sis volume. If false, compression will be disabled on the volume. If the value is not specified compression state will be unchanged.
enable-inline-compression boolean
optional
Enable inline compression on the sis volume. To enable inline compression, compression must be enabled either in this API call or by a previous call to sis-set-config. 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 not specified, inline-compression state will be unchanged.
path string
The full path of the sis volume, /vol/<vol_name>.
policy-name string
optional
The sis policy name to be attached to the volume. The policy name will determine which M-Host sis policy will trigger the scheduled sis operations. In Data ONTAP Cluster-Mode, policy-name and schedule must not be specified together in the same API call. If policy-name is passed, any previous schedule set on the volume is automatically reset.
schedule string
optional
The schedule string for the sis operation.

The format of the schedule:

day_list[@hour_list] or hour_list[@day_list] or - or auto or manual

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 conjunction 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. In Data ONTAP Cluster-Mode, policy-name and schedule must not be specified together in the same API call. If schedule is passed, any previous policy-name set on the volume is 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.

The "manual" schedule string prevents SIS from automatically triggering any operations and disables change-logging. This schedule string can only be used on SnapVault destination volumes. The use of this schedule is mainly desirable when inline compression is enabled on a SnapVault destination volume and background processing is not necessary.

 Errno  Description
 EAPIMISSINGARGUMENT
 EONTAPI_EINVAL
 EAPIERROR
 EVOLUMENOTONLINE
 EOBJECTNOTFOUND
 EVSERVERNOTFOUND
 EVSERVER_OP_NOT_ALLOWED
 EINVALIDINPUTERROR
 Vfiler-enabled
 Yes

 
sis-start [top]
Start a sis operation on a volume. The volume must have sis enabled, before starting a sis operation. 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 the sis operation.
queue-operation boolean
optional
If this is "true", the requested sis operation will be queued if a sis operation is already running on the volume, and the running operation is in the fingerprint verification phase. Default Value: "false"
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.

The scan will include whatever is enabled on the volume. For example: If compression is not enabled on the volume, the scan will not include compression. This default behavior can be changed by using the run-dedupe-scan and run-compression-scan parameters.

If scan is false only data added since the last sis operation will be processed. Default Value: "false"

 Errno  Description
 EAPIMISSINGARGUMENT
 EONTAPI_EINVAL
 EAPIERROR
 EVOLUMEBUSY
 EVOLUMENOTONLINE
 EDENSE_CONCURRENT_LIMIT
 EOBJECTNOTFOUND
 EVSERVERNOTFOUND
 EVSERVER_OP_NOT_ALLOWED
 EINVALIDINPUTERROR
 Vfiler-enabled
 Yes

 
sis-status [top]
Get Status of a sis volume This API is not optimal for use in Data ONTAP Cluster-Mode systems, and is deprecated. Use sis-get and sis-get-iter APIs for Data ONTAP Cluster Mode systems. This API is still supported for Data ONTAP 7-Mode systems.
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 online sis 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
 EVOLUMENOTONLINE
 EOBJECTNOTFOUND
 EVSERVERNOTFOUND
 EVSERVER_OP_NOT_ALLOWED
 EINVALIDINPUTERROR
 Vfiler-enabled
 Yes

 
sis-stop [top]
Abort currently active sis operation on the volume. The sis operation will remain paused and the operation can be resumed by "sis-start", SnapVault transfer, or the scheduler.
Input Name Range Type Description
all-operations boolean
optional
If this is "true", both active and queued sis operation will be stopped. Default Value: "false"
path string
The full path of the sis volume, /vol/<vol_name>.
 Errno  Description
 EAPIMISSINGARGUMENT
 EONTAPI_EINVAL
 EAPIERROR
 EVOLUMENOTONLINE
 EOBJECTNOTFOUND
 EVSERVERNOTFOUND
 EVSERVER_OP_NOT_ALLOWED
 EINVALIDINPUTERROR
 Vfiler-enabled
 Yes

 
Element definition: dense-status [top]
Name Range Type Description
blocks-skipped-sharing [0..2^32-1] integer
optional
Number of blocks not considered for sharing because contiguous duplicate blocks were less than the value set for minimum-blocks-shared. Returned only if verbose option is set.
changelog-used-percent [0..100] integer
optional
Percentage of changelog used. Returned only if verbose option is set.
checkpoint-op-type string
optional
Checkpoint Operation Type. Possible values: "-", "Scan", "Start", "Check","Undo" and "Downgrade" Returned only if verbose option is set. This field is deprecated in Data ONTAP 8.1 and later.
checkpoint-progress string
optional
Checkpoint Stage Progress with information as to which stage of sis is checkpointed and how much data is processed for that stage. For example: 25 MB Scanned, 20 MB Searched, 40 MB (20%) Done, 30 MB Verified. Returned only if verbose option is set. This field is deprecated in Data ONTAP 8.1 and later.
checkpoint-stage string
optional
Checkpoint Stage information. Possible values: "-", "Gathering", "Sorting", "Saving_pass1", "Saving_pass2", "Checking", "Checking_pass1" , "Checking_pass2", "Compress_preproc", "Compressing", "Saving_sharing", "Saving_end", "Unknown_stage" Returned only if verbose option is set. This field is deprecated in Data ONTAP 8.1 and later.
checkpoint-sub-stage string
optional
Checkpoint Sub Stage information. Possible values: "-", "Sort_pass2" Returned only if verbose option is set. This field is deprecated in Data ONTAP 8.1 and later.
checkpoint-time [0..2^63-1] integer
optional
Checkpoint creation timestamp. The value is in seconds since January 1, 1970. Returned only if verbose option is set. This field is deprecated in Data ONTAP 8.1 and later.
is-compression-enabled boolean
optional
compression state of the volume Attributes: non-creatable, non-modifiable
is-inline-compression-enabled boolean
optional
inline compression state of the volume Attributes: non-creatable, non-modifiable
last-operation-begin-timestamp [0..2^31-1] integer
optional
Start timestamp of the last sis operation. The value is in seconds since January 1, 1970. Returned only if verbose option is set.
last-operation-end-timestamp [0..2^31-1] integer
optional
End timestamp of the last sis operation. The value is in seconds since January 1, 1970. Returned only if verbose option is set.
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 set. and when there is a valid error.
last-operation-size-bytes [0..2^63-1] integer
optional
The size in bytes of the last sis operation. Returned only if verbose option is set.
last-operation-state string
optional
Completion status for the last operation. Possible values: "success","failure" Returned only if verbose option is set and when there is last completed operation.
last-success-operation-begin-timestamp [0..2^31-1] integer
optional
Start timestamp of the last successful sis operation. The value is in seconds since January 1, 1970. Returned only if verbose option is set and when there is last successfully completed operation.
last-success-operation-end-timestamp [0..2^31-1] integer
optional
End timestamp of the last successful sis operation. The value is in seconds since January 1, 1970. Returned only if verbose option is set and when there is last successfully completed operation.
logical-data sis-logical-data
optional
This contains logical size attributes of a volume. Returned only if verbose option is set.
minimum-blocks-shared [0..2^32-1] integer
optional
The minimum number of contiguous blocks in a file that will be considered for block sharing. If the number of contiguous duplicate blocks is less than this number, then they won't be considered for sharing. Returned only if verbose option is set.
path string
Volume for which sis information is returned.
progress string
The progress of the current sis operation with information as to which stage is currently in progress and how much data is processed for that stage. For example: 25 MB Scanned, 20 MB Searched, 40 MB (20%) Done, 30 MB Verified.
queued-job-type string
Type of sis operation that is queued for the volume. Possible values: "-", "scan", "start", "check", "downgrade". If "-", then no sis operation is queued for the volume. Returned only if verbose option is set.
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 set.
stale-fingerprint-percentage [0..100] integer
optional
Percentage of fingerprints that are stale in the fingerprint database. Returned only if verbose option is set.
state string
Possible values: "Enabled", or "Disabled".
status string
Possible values: "Idle", "Initializing", "Active", "Pending", "Undoing" , "Downgrading" or "Disabled"
type string
optional
Possible values: "Regular" or "SnapVault". Any sis 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 set.

 
Element definition: sis-policy-info [top]
sis-policy-info typedef When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller.

When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.

When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

Name Range Type Description
comment string
optional
A brief description of the policy. Attributes: optional-for-create, modifiable
duration string
optional
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 there is no duration set on the volume, the operation will run till it completes. Attributes: optional-for-create, modifiable
enabled boolean
optional
If the value is true, the sis policy is active and sis operations will be triggered on the volume on the specified schedule. If the value is false, the sis policy will be inactive and sis operations will not be triggered on the volume on the specified schedule. Attributes: optional-for-create, modifiable
policy-name string
optional
sis policy name. Attributes: key, required-for-create, non-modifiable
schedule string
optional
Cron type job schedule name. When the associated policy is set on a volume, the sis operation will be triggered for the volume on this schedule. These schedules can be created using the job-schedule-cron-create API. Existing schedules can be queried using the job-schedule-cron-get-iter API. Attributes: required-for-create, modifiable
vserver vserver-name
optional
Vserver name. Attributes: key, non-creatable, non-modifiable

 
Element definition: sis-status-info [top]

When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller.

When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.

When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

Name Range Type Description
blocks-skipped-sharing [0..2^32-1] integer
optional
Number of blocks not considered for sharing because contiguous duplicate blocks were less than the value set for minimum-blocks-shared.
changelog-used-percent [0..100] integer
optional
Percentage of changelog used.
checkpoint-op-type sis-checkpoint-op-type
optional
Checkpoint operation Type. Attributes: non-creatable, non-modifiable Possible values:
  • "Scan" - Scanning volume for fingerprints,
  • "Start" - Starting a sis operation,
  • "Check" - Checking for stale data in the fingerprint database,
  • "Undo" - Undoing sis on the volume,
  • "Downgrade" . Downgrading sis metafiles to a previous Data ONTAP release.
checkpoint-progress string
optional
Checkpoint Stage Progress with information as to which stage of deduplication is checkpointed and how much data is processed for that stage. For ex: 25 MB Scanned, 20 MB Searched, 40 MB (20%) Done, 30 MB Verified. Attributes: non-creatable, non-modifiable
checkpoint-stage sis-checkpoint-stage
optional
Checkpoint stage information. Attributes: non-creatable, non-modifiable Possible values:
  • "Gathering" - Scanning the volume for fingerprints,
  • "Sorting" - Sorting the gathered fingerprints,
  • "Compress_preproc" - Preprocessing volume data for compression,
  • "Compressing" - Compressing the volume data,
  • "Saving_pass1" - Creating duplicate list from the newly gathered fingerprints,
  • "Saving_pass2" - Creating duplicate list from the fingerprint database,
  • "Saving_sharing" - Creating shared data structures in the volume,
  • "Saving_end" - Completing sis operations,
  • "Checking_pass0" - Organizing data in the fingerprint database for block sharing,
  • "Checking_pass1" - Organizing data in the fingerprint database for block sharing,
  • "Checking_pass2" - Organizing data in the fingerprint database for block sharing,
  • "Unknown_stage" - Invalid stage
checkpoint-sub-stage sis-checkpoint-substage
optional
Checkpoint sub-stage information. Attributes: non-creatable, non-modifiable Possible values:
  • "Sort_pass2" - Sorting the fingerprints for deduplication
checkpoint-time [0..2^63-1] integer
optional
Checkpoint creation timestamp. The value is in seconds since January 1, 1970. Attributes: non-creatable, non-modifiable
is-compression-enabled boolean
optional
Compression state of the volume Attributes: non-creatable, modifiable
is-content-available boolean
optional
When returned as part of the output, this indicates if the value of other elements in this sis-info object are valid. Attributes: non-creatable, non-modifiable

A "true" value for this field indicates a normal case when everything went fine while fetching the status values for this volume. All values returned are valid. A "false" value for this field indicates something went wrong while fetching the status values for this volume. Not all values returned are valid. The volume returned may not be a sis volume. Default: true

is-inline-compression-enabled boolean
optional
Inline compression state of the volume Attributes: non-creatable, modifiable
last-op-begin-timestamp [0..2^63-1] 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. Attributes: non-creatable, non-modifiable
last-op-end-timestamp [0..2^63-1] integer
optional
End timestamp of the last sis operation. Attributes: non-creatable, non-modifiable
last-op-error string
optional
A human readable error message of the last sis operation. Present when there was an error. Attributes: non-creatable, non-modifiable
last-op-size size
optional
The amount of data processed in bytes for the last sis operation. Attributes: non-creatable, non-modifiable
last-op-state string
optional
Completion status for the last operation. Possible values: "success","failure" Returned only if verbose option is set and when there is last completed operation.
last-success-op-begin-timestamp [0..2^31-1] integer
optional
Start timestamp of the last successful sis operation. The value is in seconds since January 1, 1970. Returned only if verbose option is set and when there is last successfully completed operation.
last-success-op-end-timestamp [0..2^31-1] integer
optional
End timestamp of the last successful sis operation. The value is in seconds since January 1, 1970. Returned only if verbose option is set and when there is last successfully completed operation.
logical-data-limit [0..2^63-1] integer
optional
Dedupe logical data limit in bytes.
logical-data-size [0..2^63-1] integer
optional
The size of logical data in the volume in bytes. This is calculated as [size-saved + size-used + + compressed-data bytes].
minimum-blocks-shared [0..2^32-1] integer
optional
The minimum number of contiguous blocks in a file that will be considered for block sharing. If the number of contiguous duplicate blocks is less than this number, then they won't be considered for sharing.
path volume-path
optional
Volume for which sis information is returned. Path is of the format /vol/<vol_name>. Attributes: key, non-creatable, non-modifiable
policy string
optional
sis policy name. Attributes: non-creatable, modifiable
progress string
optional
The progress of the current sis operation with information as to which stage of sis process is currently in progress and how much data is processed for that stage. For ex: 25 MB Scanned, 20 MB Searched, 40 MB (20%) Done, 30 MB Verified. Attributes: non-creatable, non-modifiable
queued-job-type string
optional
Type of sis operation that is queued for the volume. Possible values: "-", "scan", "start", "check", "downgrade". If "-", then no sis operation is queued for the volume.
schedule string
optional
The schedule for sis operation on the volume. See sis-set-config for the format of the schedule. Attributes: non-creatable, modifiable
stale-fingerprint-percentage [0..100] integer
optional
Percentage of fingerprints that are stale in the fingerprint database.
state sis-state
optional
State of sis configured on the volume. Attributes: non-creatable, non-modifiable Possible values:
  • "Disabled" ,
  • "Enabled"
status sis-op-status
optional
Status of any sis operation running on the volume. Attributes: non-creatable, non-modifiable Possible values:
  • "Idle" - No sis operations are happening on this volume,
  • "Initializing" - sis operation is being initialized,
  • "Active" - sis operation is active on the volume,
  • "Undoing" - sis is being undone on the volume,
  • "Pending" - sis operations are scheduled for the volume,
  • "Downgrading" - The sis operation necessary to downgrade the volume is active,
  • "Disabled" - sis operation is disabled on the volume
type sis-type
optional
Any sis volume with Snapvault qtree in it would be marked as Snapvault and all others would be returned as type Regular. Attributes: non-creatable, non-modifiable Possible values:
  • "Regular" ,
  • "Snapvault"
vserver vserver-name
optional
A string identifying the vserver Attributes: key, non-creatable, non-modifiable

 
Element definition: volume-path [top]
Volume path name
[none]

 
Element definition: sis-checkpoint-op-type [top]
sis checkpoint type Possible values:
  • "Scan" - Scanning volume for fingerprints,
  • "Start" - Starting a sis operation,
  • "Check" - Checking for stale data in the fingerprint database,
  • "Undo" - Undoing sis on the volume,
  • "Downgrade" - Downgrading sis metafiles to a previous Data ONTAP release.
[none]

 
Element definition: sis-checkpoint-stage [top]
sis checkpoint stage Possible values:
  • "Gathering" - Scanning the volume for fingerprints,
  • "Sorting" - Sorting the gathered fingerprints,
  • "Compress_preproc" - Preprocessing volume data for compression,
  • "Compressing" - Compressing the volume data,
  • "Saving_pass1" - Creating duplicate list from the newly gathered fingerprints,
  • "Saving_pass2" - Creating duplicate list from the fingerprint database,
  • "Saving_sharing" - Creating shared data structures in the volume,
  • "Saving_end" - Completing sis operations,
  • "Checking_pass0" - Organizing data in the fingerprint database for block sharing,
  • "Checking_pass1" - Organizing data in the fingerprint database for block sharing,
  • "Checking_pass2" - Organizing data in the fingerprint database for block sharing,
  • "Unknown_stage" - Invalid stage
[none]

 
Element definition: sis-checkpoint-substage [top]
sis checkpoint sub-stage Possible values:
  • "Sort_pass2" - Sorting the fingerprints for deduplication
[none]

 
Element definition: sis-logical-data [top]
This contains logical size attributes of a volume.
Name Range Type Description
logical-data-limit [0..2^63-1] integer
Dedupe logical data limit in bytes.
logical-data-size [0..2^63-1] integer
The size of logical data in the volume in bytes. This is calculated as [size-saved + size-used + compressed-data bytes].

 
Element definition: sis-op-status [top]
Efficiency status Possible values:
  • "idle" - No storage efficiency operations are happening on this volume,
  • "initializing" - The storage efficiency operation is being initialized,
  • "active" - The storage efficiency operation is active on the volume,
  • "undoing" - The storage efficiency is being undone on the volume,
  • "pending" - The storage efficiency operation is scheduled for the volume,
  • "downgrading" - Storage efficiency actions necessary to downgrade the volume are being carried out,
  • "disabled" - Storage efficiency disabled on the volume
[none]

 
Element definition: sis-state [top]
Disabled|Enabled Possible values:
  • "disabled" ,
  • "enabled"
[none]

 
Element definition: sis-type [top]
Regular|SnapVault Possible values:
  • "regular" ,
  • "snapvault"
[none]

 
Element definition: size [top]
Size in bytes Range : [0..2^63-1].
[none]

 
Element definition: vserver-name [top]
The name of the Vserver.
[none]