lsm_fs_clone man page

lsm_fs_clone — Clones an existing file system

Synopsis

int lsm_fs_clone (lsm_connect *conn, lsm_fs *src_fs, const char *name, lsm_fs_ss *optional_ss, lsm_fs **cloned_fs, char **job, lsm_flag flags);

Arguments

conn

Valid connection.

src_fs

Pointer of lsm_fs for source file system.

name

String. Human recognizable name for new file system, might be altered or ignored by certain storage system.

optional_ss

Pointer of lsm_fs_ss. File system snapshot to base clone from. Set to NULL of not needed..

cloned_fs

Output pointer of lsm_fs for the newlly created file system. Will be NULL if storage system support asynchronous action on this. Returned value must be freed with a call to lsm_fs_record_free.

job

Output pointer of string. If storage system support asynchronous action on this, a job will be created and could be tracked via lsm_job_status_fs_get. NULL if storage system does not support asynchronous action on this.

flags

Reserved for future use, must be LSM_CLIENT_FLAG_RSVD.

Version

1.0

Description

Create a point in time read writeable space efficient copy of specified file system, also know as read writeable snapshot. The new file system will reside in the same pool of specified file system.

Capability

LSM_CAP_FS_CLONE

Return

Error code as enumerated by 'lsm_error_number'.
   * LSM_ERR_OK
       On success.
   * LSM_ERR_JOB_STARTED
       A job is started. Please check the 'job' output pointer.
   * LSM_ERR_INVALID_ARGUMENT
       When any argument is NULL or not a valid lsm_connect pointer
       or invalid flags.
   * LSM_ERR_NOT_FOUND_FS
       When file system not found.
   * LSM_ERR_NOT_ENOUGH_SPACE
       Pool does not have enough space.
   * LSM_ERR_POOL_NOT_READY
       Pool is not ready.
   * LSM_ERR_NO_SUPPORT
       Not supported.

Info

lsm_fs_clone October 2017 Libstoragemgmt C API Manual