Input Name	Range	Type	Description
path		string	Path of the directory to be created. The value is expected to begin with /vol/.
perm		string	Permission of the directory to be created. It's similar to Unix style permission bits: 0755 gives read/write/execute permissions to owner and read/execute to group and other users. It consists of 4 octal digits derived by adding up bits 4, 2 and 1. Omitted digits are assumed to be zeros. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. The second digit selects permission for the owner of the file: read (4), write (2) and execute (1); the third selects permissions for other users in the same group; the fourth for other users not in the group. Note: Prior to Data ONTAP 7.3.1 this value was treated as a base-10 number.

Errno	Description
EONTAPI_EINVAL
EONTAPI_EPERM
EONTAPI_EEXIST
EONTAPI_ENOENT
EONTAPI_ENOSPC
EINTERNALERROR
EVSERVERNOTFOUND
EAPIVSERVERMISSING
EVOLUMEQUIESCED
EVOLUMEBUSY

Vfiler-enabled

Yes

Create a symlink.

Input Name	Range	Type	Description
path		string	Path of the symlink file to create. The value is expected to begin with /vol/.
symlink		string	Value of the symlink.

Errno	Description
EVOLUMEQUIESCED
EVOLUMEBUSY

Vfiler-enabled

Yes

Delete a directory.

Input Name	Range	Type	Description
path		string	Path of the directory to delete. The value is expected to begin with /vol/. The directory must be empty in order for this API to succeed.

Errno	Description
EONTAPI_ENOENT
EVSERVERNOTFOUND
EAPIVSERVERMISSING
EVOLUMEQUIESCED
EVOLUMEBUSY
EINTERNALERROR

Vfiler-enabled

Yes

Delete a file.

Input Name	Range	Type	Description
path		string	Path of the file or symlink to delete. The value is expected to begin with /vol/.

Errno	Description
EONTAPI_ENOENT
EVOLUMEQUIESCED
EVOLUMEBUSY
EVSERVERNOTFOUND
EAPIVSERVERMISSING
EINTERNALERROR

Vfiler-enabled

Yes

Obtains the file information or properties.

Input Name	Range	Type	Description
path		string	Pathname of the directory to list. The value is expected to begin with /vol/.
Output Name	Range	Type	Description
file-info		file-info	File information from the stat() function.

Errno	Description
EONTAPI_ENOENT
EVOLUMEQUIESCED
EVOLUMEBUSY
EVSERVERNOTFOUND
EAPIVSERVERMISSING
EINTERNALERROR
EVOL_NOT_MOUNTED

Vfiler-enabled

Yes

Get the fingerprint or digest of a file. Fingerprint is calculated using md5 or sha-256 digest algorithm depending on the algorithm specified. Fingerprint is calculated over the file data or metadata or on both data and metadata depending on the scope selected. Data fingerprint is calculated over file contents. Metadata fingerprint is calculated over the selected attributes of the file. Attributes used for metadata fingerprint calculations are file type (file-type), file size (file-size), file crtime (creation-time), file mtime (modified-time), file ctime (changed-time), file retention time (retention-time, is-wraparound), file uid (owner-id), file gid (group-id). File retention time is applicable to worm protected files only. The fingerprints are base64 encoded.

Input Name	Range	Type	Description
fingerprint-algorithm		digest-algorithm optional
fingerprint-scope		file-scope optional
path		string	Full path of the file to be fingerprinted. The value is expected to begin with /vol/.
Output Name	Range	Type	Description
fingerprint		fingerprint-info	Fingerprint, system, volume and file related information.

Errno	Description
EONTAPI_EINVAL
EONTAPI_ENOENT
EONTAPI_EIO
EONTAPI_EOFFLINE
EINTERNALERROR

Vfiler-enabled

Yes

Queries the space reservation settings for the named file.

Input Name	Range	Type	Description
path		string	File to be queried.
Output Name	Range	Type	Description
is-fill-enabled		boolean	Whether or not the file is set with fill.
is-overwrite-enabled		boolean	Whether or not the file is set with overwrite.

Errno	Description
EOPNOTSUPPORTED
EFILENOTFOUND
EINTERNALERROR
EVOLUMEBUSY
EVOLUMEDOESNOTEXIST

Vfiler-enabled

Yes

Get parent information for a given inode. This API corresponds to the "inodepath" diagnostic-level CLI in ONTAP-Classic, and has the same defaults. The input is: Required, a volume identifier. A volume may be specified by name, fsid, or (in some ONTAP products) UUID/DSID. Required, an inode number. Optional, a snapshot identifier to get information from a snapshot rather than the active volume. A snapshot may be specified by name or by id. Optional, various reporting flags (see below) to enable or disable optional output information. The output is: All volume identifiers, the one used as input plus the values of the others. Optionally, all snapshot identifiers; the one used as input plus the value of the other. The number of parents for the inode. Optionally, one or more volume relative pathnames to the inode Optionally, one or more leaf names for the inode. Optionally, one or more of the actual parent info stored for the inode, in the form of the parent dir inode number and the parent directory cookie (fbn and offset into the fbn) used to find the dir entry that refers to the inode in the parent directory (ie. the info used to get the leaf name).

Input Name	Range	Type	Description
generation		integer optional	The generation number for this inode. Range: [1..2^32-1]
inode-number		integer	The inode number for which information is desired.
logical-snap-id		integer optional	All snapshots are associated with an internal index. "logical-snap-id" is the client-visible index that maps the the underlying internal index. Range: [1..255].
report-leaf-name		boolean optional	If set to true, report the leaf name of the given inode. The leaf name is equivalent to the final component of a full pathname. For example, the leaf name of: /vol/vol0/foo/bar/baz is: baz By default, the inode's leaf name is not shown.
report-no-pathname		boolean optional	If set to true, do not report on the given inode's full pathname. By default, the inode's full pathname is reported.
report-other-parents		boolean optional	If set to true, report the requested information for all of the parents for the given inode. By default, only information about one of the given inode's parents is reported.
report-parent-data		boolean optional	If set to true, report various other pieces of information about the given inode. This information includes the inode of the parent directory containing the given inode, along with the directory cookie by which the given inode is known in that parent directory inode. By default, this other information is not reported for the given inode.
snap-id		integer optional	The snapshot number within the given volume in which the given inode is to be referenced. At most, one of snap-id or snap-name can be provided. If neither is provided, we reference the given inode within the active file system of the given volume. Valid snapshot ids have a range of 0 to (WAFL_SNAP_CNT - 1) (currently 255). A value of 0 will refer to the active file system of the given volume. This refers to the physical snapshot identifier.
snap-name		string optional	A snapshot name within the given volume in which the given inode is to be referenced. At most, one of snap-id or snap-name can be provided. If neither is provided, we reference the given inode within the active file system of the given volume.
volume-dsid		string optional	The DSID (Data Set IDentifier) of the volume containing the given inode. Exactly one of volume-fsid, volume-name, volume-uuid or volume-dsid must be specified. DSIDs are formatted as 18-character strings composed of 16 hex characters prefixed with '0x'. NOTE: This form of volume identification is only supported in some ONTAP products (ONTAP-NG).
volume-fsid		integer optional	The FSID (file system identifier) of the volume containing the given inode. Exactly one of volume-fsid, volume-name, volume-uuid, or volume-dsid must be specified. An FSID may have any uint32_t value.
volume-name		string optional	The name of the volume containing the given inode. Exactly one of volume-fsid, volume-name, volume-uuid, or volume-dsid must be specified.
volume-uuid		string optional	The UUID (Universally Unique IDentifier) of the volume containing the given inode. Exactly one of volume-fsid, volume-name, volume-uuid or volume-dsid must be specified. UUIDs are formatted as 36-character strings. These strings are composed of 32 hexadecimal characters broken up into five groupings separated by '-'s. The first grouping has 8 hex characters, the second through fourth groupings have four hex characters each, and the fifth and final grouping has 12 hex characters. Note that a leading '0x' is not used. An example UUID is 532ad684-c8ec-11d9-945f-00065b8c8a1e. NOTE: This form of volume identification is only supported in some ONTAP products (ONTAP-NG).
Output Name	Range	Type	Description
inode-number		integer	The number identifying the inode.
inode-paths		inode-parent-info[]	List of requested paths and parent information for the given inode.
logical-snap-id		integer optional	Logical snapshot index. This index maps to the above internal index. Logical index allows users to choose the same snapshot index across all members of a striped volume. This index is also useful for logical volume replication. A logical snapshot index of 0 implies that the snapshot is is not client-visible i.e. this is a un-coordinated snapshot. Range: [0..255].
number-of-parents		integer	The number of parents for the inode. For a file, this is the number of links to the file.
snapshot-id		integer optional	The snapshot id, if requested info is from a snapshot. This is the physical snapshot identifier.
snapshot-name		string optional	The name of the snapshot, if requested info is from a snapshot.
volume-dsid		string optional	The volume DSID.
volume-fsid		integer	The volume FSID.
volume-name		string	The volume name.
volume-uuid		string	The volume UUID.

Errno	Description
EINVALIDINPUTERROR
EINODENUMBERTOOSMALL
EINODENUMBERTOOLARGE
EVOLUMEDOESNOTEXIST
ESNAPSHOTDOESNOTEXIST
EINVALIDINODE
EINELIGIBLEINODE
EPARENTINFONOTLOADED
EI2PNOTENABLED
EINTERNALERROR
EVOLUMEOFFLINE
EWRONGSTRIPE
EVOLUMEQUIESCED
EVOLUMEBUSY

Vfiler-enabled

Yes

Terminate a directory iteration.

Input Name	Range	Type	Description
tag		string	Tag from a previous file-list-directory-iter-start.

Errno	Description
EONTAPI_ENOENT

Vfiler-enabled

Yes

Obtain a list of files in a given directory.

Input Name	Range	Type	Description
maximum		integer	Maximum number of directory entries to retrieve.
tag		string	Tag from a previous file-list-directory-iter-start.
Output Name	Range	Type	Description
files		file-info[]	Array with information for each file in the named directory.
records		integer	This tells you how many records are being returned from this particular call to file-list-directory-iter-next. When this value is 0, you have retrieved everything.

Errno	Description
EONTAPI_ENOENT
EVOLUMEQUIESCED
EVOLUMEBUSY

Vfiler-enabled

Yes

Start in iteration through the list of files in a given directory.

Input Name	Range	Type	Description
path		string	Pathname of the directory to list. The value is expected to begin with /vol/.
Output Name	Range	Type	Description
records		integer	Number of items that have been saved for future retrieval with file-list-directory-iter-next.
tag		string	Tag to be used in subsequent iterations.

Errno	Description
EONTAPI_ENOENT
EVOLUMEQUIESCED
EVOLUMEBUSY

Vfiler-enabled

Yes

Punch hole in the file. Hole punching involves reclaiming of zero blocks (blocks filled with zeroes) by unallocating them and then direct or indirect blocks can be made to point to 0, instead of these zero blocks.

Input Name	Range	Type	Description
hole-info		hole-range-info[]	This is the array containing the ranges that need to be hole punched. Punching up to 16 holes is supported.
path		string	Path of the file. Format must be of the following: /vol/my_vol/path-to-file

Errno	Description
EINTERNALERROR
EONTAPI_EINVAL
EONTAPI_ENOENT
EONTAPI_EACCES
EONTAPI_ESTALE
EONTAPI_EPERM

Vfiler-enabled

Yes

Read data from a named file. API will fail if length exceeds 1 MB. This API should only be used on normal files. The results for other file types such as LUNs is undefined.

Input Name	Range	Type	Description
length	[0..1048576]	integer	Number of bytes to read from the file.
offset	[0..2^63-1]	integer	Offset into file to start reading from.
path		string	Name of the file to read. For example: "/vol/<volume>/<file>".
Output Name	Range	Type	Description
data		string	Data read from the file. The format of the data is ASCII hex characters, two characters representing one byte from the file. (This format allows the representation of 0-valued bytes.)
length	[0..1048576]	integer	Number of bytes actually read from the file. If this value is 0, then you have attempted to read at or past the end of the file.

Errno	Description
EONTAPI_EACCES
EONTAPI_ENOENT
EVSERVERNOTFOUND
EAPIVSERVERMISSING
EVOLUMEQUIESCED
EVOLUMEBUSY
EINTERNALERROR

Vfiler-enabled

Yes

Read the contents of a symlink.

Input Name	Range	Type	Description
path		string	Path of the symlink file to read. The value is expected to begin with /vol/.
Output Name	Range	Type	Description
symlink		string	Value of the symlink. In other words, this is the destination path contained in the symlink.

Errno	Description
EVOLUMEQUIESCED
EVOLUMEBUSY

Vfiler-enabled

Yes

Rename a directory. Note that this API cannot be used to rename a directory to a different volume.

Input Name	Range	Type	Description
from-path		string	Original path of the directory. The value must begin with /vol/.
to-path		string	Final path of the directory. The value must begin with /vol/. All path components except the final directory name must already exist.

Errno	Description
EONTAPI_ENOENT
EONTAPI_EINVAL
EONTAPI_ENOTDIR
EONTAPI_EEXIST
EONTAPI_EXDEV
EVOLUMEQUIESCED
EVOLUMEBUSY

Vfiler-enabled

Yes

Sets the space reservation settings for the named file. is-overwrite-enabled and is-fill-enabled both must be the same value.

Input Name	Range	Type	Description
is-fill-enabled		boolean optional	Whether or not to set the file with fill.
is-overwrite-enabled		boolean optional	Whether or not to set the file with overwrite.
path		string	File to be queried.

Errno	Description
EFILENOTFOUND
EINTERNALERROR
EINVALIDINPUTERROR
ESETSPCRESERROR
EONTAPI_ENOSPC
EONTAPI_EROFS
EVOLUMEBUSY
EONTAPI_EISVDISK
EVOLUMEDOESNOTEXIST

Vfiler-enabled

Yes

Truncate a file. Any data past the truncation point will be lost, of course.

Input Name	Range	Type	Description
path		string	Path of the file to truncate. The value is expected to begin with /vol/.
size		string optional	If provided, the file size is set to this value. The default value is 0.

Errno	Description
EONTAPI_ENOENT
EVOLUMEQUIESCED
EVOLUMEBUSY
EVSERVERNOTFOUND
EAPIVSERVERMISSING

Vfiler-enabled

Yes

Reports unique bytes held in a file.

Input Name	Range	Type	Description
length		integer optional	Length of the range in bytes. If it is not specified, the range that is reported is from start-offset to end-of-file. Range : [0..2^63-1].
path		string	File name to generate report: E.g., /vol/vol1/file1
start-offset		integer optional	Start range of file in bytes. If this is not specified, it is assumed to be beginning of file (offset 0). Range : [0..2^63-1].
Output Name	Range	Type	Description
total-bytes		integer	Number of bytes held by this file. Range : [0..2^63-1].
unique-bytes		integer	Number of bytes 'uniquely' held by this file. Range : [0..2^63-1].

Errno	Description
EVSERVERNOTFOUND
EINVALIDINPUTERROR
EINTERNALERROR
EONTAPI_ENOENT
EONTAPI_EINVAL
EONTAPI_EAGAIN

Used to poll and retrieve results for a previous file-usage-start call. EINPROGRESS indicates that the background job has not finished yet.

Input Name	Range	Type	Description
cookie		string	Cookie that was returned in an earlier file-usage-start call.
Output Name	Range	Type	Description
total-bytes		integer	Number of bytes held by this file. Range : [0..2^63-1].
unique-bytes		integer	Number of bytes 'uniquely' held by this file. Range : [0..2^63-1].

Errno	Description
EVSERVERNOTFOUND
EINVALIDINPUTERROR
EINTERNALERROR
EONTAPI_EINVAL
EONTAPI_ESTALE
EONTAPI_EINPROGRESS

Starts a background job to compute unique bytes held in a file. The result can be obtained by passing the cookie to file-usage-result-get call.

Input Name	Range	Type	Description
length		integer optional	Length of the range in bytes. If it is not specified, the range that is reported is from start-offset to end-of-file. Range : [0..2^63-1].
path		string	File name to generate report: E.g., /vol/vol1/file1
start-offset		integer optional	Start range of file in bytes. If this is not specified, it is assumed to be beginning of file (offset 0). Range : [0..2^63-1].
Output Name	Range	Type	Description
cookie		string	Cookie to be used with subsequent file-usage-result-get call.

Errno	Description
EVSERVERNOTFOUND
EINVALIDINPUTERROR
EINTERNALERROR
EONTAPI_ENOENT
EONTAPI_EINVAL
EONTAPI_EAGAIN

Write data into a named file. If the file does not previously exist, it will be created - the owner of the file will be root and it will not be readable or writable by non-root users. API will fail if data exceeds 1 MB. This API should only be used on normal files. The results for other file types such as LUNs is undefined.

Input Name	Range	Type	Description
data		string	Data to be written. The format of the data is ASCII hex characters, two characters representing one byte. Whitespace characters, for convenience in formatting, can be present in the value and are ignored.
offset	[-1..2^63-1]	integer	Offset into file at which to start writing. If the offset is -1, the data is appended to the file.
overwrite		boolean optional	If false, and the file already exists, then the API will fail, with an errno of EEXIST. This allows the client to ensure that it was the exclusive creator of the file. The default value is true.
path		string	Pathname of the file to write. For example: "/vol/<volume>/<file>".
Output Name	Range	Type	Description
length	[0..1048576]	integer	Number of bytes actually written.

Errno	Description
EONTAPI_EACCES
EONTAPI_ENOENT
EBADFILELENGTH
EVOLUMEQUIESCED
EVOLUMEBUSY
EVSERVERNOTFOUND
EAPIVSERVERMISSING
EINTERNALERROR

Vfiler-enabled

Yes

Digest algorithm used for fingerprint computation. Possible values: "sha-256" or "md5".

[none]

Information about a single file.

Name	Range	Type	Description
accessed-timestamp	[0..2^32-1]	integer	Last asscess time of the file. The value is in seconds since January 1, 1970.
acl-type		string	The type of access control list (acl) on the file. Possible values are: "no_acl", "nt_acl", "nfs_acl", and goddess forbid, "unknown".
bytes-used	[0..2^63-1]	integer optional	returns the number of bytes actually used on disk by this file
changed-timestamp	[0..2^32-1]	integer	Last changed time of the file. The value is in seconds since January 1, 1970.
creation-timestamp	[0..2^32-1]	integer	Creation time of the file. The value is in seconds since January 1, 1970.
file-size	[0..2^63-1]	integer	The size of the file in bytes.
file-type		string	Type of the file. Possible values: file, directory, blockdev, chardev, symlink, socket, fifo, stream, lun. A cluster-mode volume can also return "junction".
group-id	[0..2^32-1]	integer	The integer id of the group owner of the file.
hard-links-count	[0..2^32-1]	integer	The number of hard links to the file.
inode-gen-number	[0..2^32-1]	integer optional	Inode generation number
inode-number	[0..2^32-1]	integer	The file node number.
is-empty		boolean optional	This element tells whether directory is empty or not. Directory is considered empty if it only contains entries for "." and "..". This element is present if file is directory. In some special error cases like volume goes offline in between or directory is moved in the middle of getting this info, this field might not get set.
modified-timestamp	[0..2^32-1]	integer	Last modification time of the file. The value is in seconds since January 1, 1970.
name		string	Name of the file.
owner-id	[0..2^32-1]	integer	The integer id of the owner of the file.
perm		string	File permission bits. It's similar to Unix style permission bits: 0755 gives read/write/execute permissions to owner and read/execute to group and other users. It consists of 4 octal digits derived by adding up bits 4, 2 and 1. Omitted digits are assumed to be zeros. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. The second digit selects permission for the owner of the file: read (4), write (2) and execute (1); the third selects permissions for other users in the same group; the fourth for other users not in the group.

Part of the file for which fingerprint is computed. Possible values: "metadata_only", "data_only", "data_and_metadata".

[none]

Fingerprint information.

Name	Range	Type	Description
aggregate-uuid		string optional	Universal unique identifier (UUID) for the aggregate containing volume. The field is included for flexible volumes only.
filer-id		string	ID (NVRAM ID) of owner.
filer-name		string optional	Name of the filer. If the filer name has not been written to the disks, this will not be returned.
fingerprint-algorithm		digest-algorithm
fingerprint-end-time		integer	End time of fingerprint computation in seconds since January 1, 1970. Time is taken out of system clock. Range : [0..2^64-1].
fingerprint-input-path		string	Full path of the file to be fingerprinted. The value begins with /vol/.
fingerprint-scope		file-scope
fingerprint-start-time		integer	Start time of fingerprint computation in seconds since January 1, 1970. Time is taken out of system clock. Range : [0..2^64-1].
fingerprint-version		string	Version of the fingerprint output format.
formatted-fingerprint-end-time		string	End time of fingerprint computation in a human readable format :: in GMT timezone. Time is taken out of system clock.
formatted-fingerprint-start-time		string	Start time of fingerprint computation in a human readable format :: in GMT timezone. Time is taken out of system clock.
formatted-snaplock-system-compliance-clock		string optional	If System Compliance Clock is initialized then human readable time :: in GMT timezone. A value of "not_initalized" indicates that System Compliance Clock has not been initialized.
formatted-snaplock-volume-compliance-clock		string optional	Volume Compliance Clock time for SnapLock volumes in human readable format :: in GMT timezone. This field is not included for Non-SnapLock volumes.
formatted-volume-expiry-date		string optional	Expiry date of the SnapLock volume in a human-readable format :: in GMT timezone. A value of "infinite" indicates that the volume has an infinite expiry date. A value of "scan_in_progress" indicates that expiry date is not displayed since worm scan on the volume is in progress. A value of "no_expiry_date" indicates that expiry date is not displayed since the SnapLock volume has no WORM files and WORM snapshots. This field is not included if the volume is offline or the volume is regular volume.
is-volume-expiry-date-wraparound		boolean optional	True if the date represented in the field volume-expiry-date is a wraparound format. The wraparound format indicates that dates after 01/19/2038 are mapped from 01/01/1970 - 12/31/2002 to 01/19/2038 - 01/19/2071. The field is not included if volume-expiry-date is not included.
metadata-files		file-fingerprint-info[]	List of files and their fingerprint related information.
snaplock-license		string optional	Type of SnapLock license installed. Possible values: "compliance" that applies to SnapLock compliance restrictions and "enterprise" that applies to SnapLock enterprise restrictions and value "compliance and enterprise" if there are both licenses installed. This field is not included if SnapLock license is not installed.
snaplock-system-compliance-clock		integer optional	If System Compliance Clock is initialized then time in seconds in the standard UNIX format (since 01/01/1970 00:00:00) in GMT timezone. Range:[0..2^64-1].
snaplock-volume-compliance-clock		integer optional	Volume Compliance Clock time in seconds for the SnapLock volumes. The time is in the standard UNIX format (since 01/01/1970 00:00:00) in GMT timezone. This field is not included for Non-SnapLock volumes. Range:[0..2^64-1].
volume-containing-aggregate		string optional	Flexible volumes only. The name of the aggregate in which the given flexible volume resides.
volume-expiry-date		integer optional	Expiry date of the SnapLock volume in seconds in the standard UNIX format (since 01/01/1970 00:00:00). Range:[0..2^64-1]. This field is not included if 1. Volume is non Snaplock volume, or 2. Snaplock volume has an infinite expiry date, or 3. Snaplock volume has no worm files or snapshots, or 4. Snaplock volume has worm scanner in progress The volume expiry date can be in wraparound format. The wraparound format indicates that dates after 01/19/2038 are mapped from 01/01/1970 - 12/31/2002 to 01/19/2038 - 01/19/2071.
volume-name		string	Name of the volume.
volume-snaplock-type		string optional	The type of the Snaplock volume. It is present for Snaplock volumes only. Possible values: "compliance" or "enterprise"
volume-type		string	The type of volume. Possible values: "flexible" for flexible volumes, and "traditional" for traditional volumes.
volume-uuid		string	Universal unique identifier (UUID) for the volume.

The hole start need not be an integral multiple of the block size. It will be rounded up to the start of the next block. The hole-size does not need to be the size of a block. It will be rounded down to the beginning of the block. It is possible that after the adjustments there is nothing to punch. That is ok and will be treated as success. Note that presently in WAFL small files are entirely within the inode. It is possible to "hole punch" those however nothing happens. The data is left alone. Considering the use case fot this ZAPI and the amount of effort to code the "correct" solution this is deemed an acceptable condition.

Name	Range	Type	Description
hole-size		integer	Size of the hole in terms of bytes. If punching a hole WAFL presently limits this value to 4MB. Range : [0..2^63-1]
hole-start		integer	Starting offset of the hole. Range : [0..2^63-1]

Inode's path and parent information.

Name	Range	Type	Description
inode-name		string optional	Name of inode in parent directory.
inode-parent-cookie		integer optional	The opaque readdir cookie to determine the index of the inode in the parent directory tree. Note that this value is used as a testing hook, we do not plan to support its semantics and those semantics might change over time.
inode-parent-inode-number		integer optional	Inode number of the parent directory.
inode-path		string optional	Full path to inode

Digest algorithm used for fingerprint computation. Possible values: "sha-256" or "md5".

[none]

Fingerprint information about single file.

Name	Range	Type	Description
access-time		integer optional	Last access time of the file attributes in seconds in the standard UNIX format since January 1, 1970 00:00:00. The field is included for regular files and files on Non-Snaplock volumes. Time is taken out of system clock. Range : [0..2^64-1]
changed-time		integer	Last changed time of the file attributes in seconds in the standard UNIX format since January 1, 1970 00:00:00. For WORM files last change time for file attributes occurs when file is committed to WORM. Time is taken out of system clock for regular files and time is taken out of Compliance Clock when file is committed to worm. The changed-time can be in wraparound format for WORM files. The flag is-changed-time-wraparound indicates that changed time is in the wraparound format. The wraparound format indicates that dates after 01/19/2038 are mapped from 01/01/1970 - 12/31/2002 to 01/19/2038 - 01/19/2071 Range : [0..2^64-1]
creation-time		integer	Creation time of the file in seconds in the standard UNIX format since January 1, 1970 00:00:00. Time is taken out of system clock. Range : [0..2^64-1]
data-fingerprint		string optional	The digest value of data of the file. The fingerprint is base64 encoded. This field is not included if scope is 'metadata_only'.
file-size		integer	The size of the file in bytes. Range : [0..2^64-1].
file-type		string	Type of the file. Possible values: "worm", "worm_appendable", "worm_log" and "regular".
fileid		integer	A unique number within filesystem identifying the file for fingerprint. Range : [0..2^31-1]
formatted-access-time		string	Last access time of the file formatted in a human-readable format :: in GMT timezone. The field is included for regular files and files on Non-Snaplock volumes.
formatted-changed-time		string	Last changed time of the file formatted in a human-readable format :: in GMT timezone.
formatted-creation-time		string	Creation time of the file formatted in a human-readable format :: in GMT timezone.
formatted-modified-time		string	Last modification time of the file formatted in a human-readable format :: in GMT timezone.
formatted-retention-time		string optional	Expiry date of the worm file formatted in a human-readable format. This takes care of wraparound dates and prints the expiry date of the file in the format :: in GMT timezone. A value of "infinite" indicates that this file has infinite retention time. This field is not included for regular files and files on Non-Snaplock volumes.
fsid		integer	Filesystem ID. Range : [0..2^31-1]
group-id		integer	The integer id of the group owner of the file. Range : [0..2^31-1]
is-changed-time-wraparound		boolean optional	This field is included for WORM files when changed-time is in wraparound format. This field is true if the date represented in changed-time is in wraparound format and false if changed-time is not is not in wraparound format. The wraparound format indicates that dates after 01/19/2038 are mapped from 01/01/1970 - 12/31/2002 to 01/19/2038 - 01/19/2071. This field is not included for regular files.
is-wraparound		boolean optional	True if the date represented in retention-time is in wraparound format. The wraparound format indicates that dates after 01/19/2038 are mapped from 01/01/1970 - 12/31/2002 to 01/19/2038 - 01/19/2071. This field is not included if retention-time is not included.
metadata-fingerprint		string optional	The digest value of metadata of the file The metadata fingerprint is calculated for file size, file ctime, file mtime, file crtime, file retention time, file uid, gid and file type. The fingerprint is base64 encoded. This field is not included if scope is 'data_only'.
modified-time		integer	Last modification time of the file in seconds in the standard UNIX format since January 1, 1970 00:00:00. Time is taken out of system clock. Range : [0..2^64-1]
owner-id		integer	The integer id of the owner of the file. Range : [0..2^31-1]
owner-sid		string	The owner SID of the file. This field is included in the case when file has NTFS security style.
path		string	Full path of the file that is fingerprinted. The value begins with /vol/.
retention-time		integer optional	Retention time of the file in seconds in the standard UNIX format since January 1, 1970 00:00:00. This field is not included for regular files, files on Non-Snaplock volumes and files with infinite retention. The flag is-wraparound indicates that retention is in the wraparound format. The wraparound format indicates that dates after 01/19/2038 are mapped from 01/01/1970 - 12/31/2002 to 01/19/2038 - 01/19/2071 The time is taken out of Compliance Clock. Range : [0..2^64-1]

Part of the file for which fingerprint is computed. Possible values: "metadata_only", "data_only", "data_and_metadata".

[none]