lsm_fs_delete man page

lsm_fs_delete — Deletes a file system

Synopsis

int lsm_fs_delete (lsm_connect *conn, lsm_fs *fs, char **job, lsm_flag flags);

Arguments

conn

Valid connection.

fs

Pointer of lsm_fs that is to be deleted.

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

Deletes a file system and its data is lost! When file system has snapshot attached, all its snapshot will be deleted also. When file system is exported, all its exports will be deleted also. If specified file system is has child dependency, it cannot be deleted. You may use `lsm_fs_child_dependency` and `lsm_fs_child_dependency_delete` before `lsm_fs_delete`.

Capability

LSM_CAP_FS_DELETE

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_POOL_NOT_READY
       Pool is not ready.
   * LSM_ERR_NO_SUPPORT
       Not supported.
   * LSM_ERR_HAS_CHILD_DEPENDENCY
       Specified volume has child dependencies.

Info

lsm_fs_delete October 2017 Libstoragemgmt C API Manual