Manual Pages


Table of Contents

NAME

na_clone - Manages file and sub-file cloning.

SYNOPSIS

clone start <src_path> <dest_path> [-n] [-l] <-s <snap_name>> |

clone start <src_path> [dest_path] [-n] [-l] <-r <src_fbn>:<dest_fbn>:<fbn_cnt> ...>

clone stop <vol_name> <ID>

clone status [vol_name [ID]]

clone clear <vol_name> <ID>

DESCRIPTION

Clone command can be used to manage file and sub-file clone operations. The cloning feature is based on constant time sis cloning storage (SIS) implementation and is the block sharing infrastructure provided by Data ONTAP. The feature allows for the cloning from either a file or a LUN. Also the user can clone the entire file or LUN (full range) or a portion of the file or LUN (sub range). In case of full range cloning, a new file/LUN will always be created in the same volume where the source file/LUN exists. In case of sub range cloning, the destination file can either be same as the source file/LUN or can be a different file/LUN within the same volume where the source file/LUN exists. Constant time SIS cloning supersedes the implementation of cloning in versions older than Data ONTAP 8.1. In Data ONTAP 8.0 the cloning implementation is an asynchronous operation. The clone-start API is used to start a clone operation. It returns a clone-id which is used for polling to get the status of the clone operation using the clone-list-status API. If this API returns success, the user can consider that clone operation has completed; if it returns failure, the user should clear the status of clone operation using clone-clear API. A clone operation in progress can be aborted using the clone-stop API. In Data ONTAP 8.1 the cloning implementation is a synchronous operation. The APIs to manage ongoing asynchronous operations are deprecated, but retained for backwards compatibility.

This feature requires the flex_clone license enabled. See na_license(1) for more details.

The clone subcommands are:

start <src_path> <dest_path> [-n] [-l] <-s <snap_name>>

start [dest_path] [-n] [-l] <-r <src_fbn>:<dest_fbn>:<fbn_cnt> ...>

Starts a clone operation. On success it returns a clone ID, which is used to see status, stop or clear a clone operation. In Data ONTAP 8.1 and later, this API performs a file/LUN or sub-file/sub-LUN clone operation synchronously. When this API returns successfully, the destination file is ready for use. The clone ID is maintained for compatibility.

    src_path   : Source path in format /vol/vol_name/filename.
    dest_path  : Destination path in format /vol/vol_name/filename.
    -s         : In case clone needs to be done from file in snapshot
    snap_name  : Snapshot name
    -n         : Do not use temporary snapshot for cloning. (Deprecated.)
    -l         : Do change logging for clone blocks. (Deprecated.)
    -r         : Specify block ranges for sub-file and sub-lun cloning.
    -o         : Skip space reservation on the clone when cloning entire file/LUN.
    src_fbn    : Starting fbn of the source block range.
    dest_fbn   : Starting fbn of the destination block range.
    fbn_cnt    : Number of blocks to be cloned.

stop <vol_name> <ID>

Aborts the currently active clone operation in the volume. (Deprecated.)

    vol_name : volume in which clone operation is running.
    ID       : ID of the clone operation.

status [vol_name [ID]]

Reports the status of running or failed clone operation for the particular ID in the specified volume. If no ID is specified, it reports status of all running and failed clone operations in the specified volume. If vol_name is also not specified, it reports status of all running and failed clone operations on the node. (Deprecated.)

    vol_name : volume in which clone operation is running.
    ID       : ID of the clone operation.

clear <vol_name> <ID>

Clears information of a failed clone operation. (Deprecated.)

    vol_name : volume in which clone operation is running.
    ID       : ID of the clone operation.

SEE ALSO

na_license(1)


Table of Contents