1lsm_volume_delete(3)      Libstoragemgmt C API Manual     lsm_volume_delete(3)
2
3
4

NAME

6       lsm_volume_delete - Delete a volume.
7

SYNOPSIS

9       int  lsm_volume_delete  (lsm_connect  *conn,  lsm_volume  *volume, char
10       **job, lsm_flag flags);
11

ARGUMENTS

13       conn        Valid lsm_connect pointer.
14
15       volume      Pointer of lsm_volume that is to be deleted.
16
17       job         Output pointer of string. If storage system  support  asyn‐
18                   chronous action on this, a job will be created and could be
19                   tracked via lsm_job_status_get. NULL if storage system does
20                   not support asynchronous action on this.
21
22       flags       Reserved for future use, must be LSM_CLIENT_FLAG_RSVD.
23

VERSION

25       1.0
26

DESCRIPTION

28       Deletes  a  volume/LUN  and  its  data is lost!  If specified volume is
29       masked to  any  access_group,  it  cannot  be  deleted.   You  may  use
30       `lsm_access_groups_granted_to_volume`  and  `lsm_volume_unmask`  before
31       `lsm_volume_delete`.  If specified volume is has child  dependency,  it
32       cannot  be  deleted.   You  may  use  `lsm_volume_child_dependency` and
33       `lsm_volume_child_dependency_delete` before `lsm_volume_delete`.
34

CAPABILITY

36       LSM_CAP_VOLUME_DELETE
37

RETURN

39       Error code as enumerated by 'lsm_error_number'.
40           * LSM_ERR_OK
41               On success.
42           * LSM_ERR_JOB_STARTED
43               A job is started. Please check the 'job' output pointer.
44           * LSM_ERR_INVALID_ARGUMENT
45               When any argument is NULL or not a valid lsm_connect pointer
46               or invalid flags.
47           * LSM_ERR_NOT_FOUND_VOLUME
48               When volume not found.
49           * LSM_ERR_POOL_NOT_READY
50               Pool is not ready.
51           * LSM_ERR_NO_SUPPORT
52               Not supported.
53           * LSM_ERR_HAS_CHILD_DEPENDENCY
54               Specified volume has child dependencies.
55
56
57
58May 2018                       lsm_volume_delete          lsm_volume_delete(3)
Impressum