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

NAME

6       lsm_volume_list - Gets a list of volumes on this connection.
7

SYNOPSIS

9       int  lsm_volume_list  (lsm_connect *conn, const char *search_key, const
10       char *search_value, lsm_volume **volumes[], uint32_t  *count,  lsm_flag
11       flags);
12

ARGUMENTS

14       conn        Valid lsm_connect pointer.
15
16       search_key  Search  key(NULL  for  all).   Valid search keys are: "id",
17                   "system_id" and "pool_id".
18
19       search_value
20                   Search value.
21
22       volumes[]   Output pointer of lsm_volume array. It should  be  manually
23                   freed by lsm_volume_record_array_free.
24
25       count       Output pointer of uint32_t. Number of volumes.
26
27       flags       Reserved for future use, must be LSM_CLIENT_FLAG_RSVD.
28

VERSION

30       1.0
31

DESCRIPTION

33       Gets  a list of volumes on this connection.  Volume properties could be
34       retrieved by these functions:
35           * lsm_volume_id_get
36           * lsm_volume_name_get
37           * lsm_volume_system_id_get
38           * lsm_volume_vpd83_get
39           * lsm_volume_number_of_blocks_get
40           * lsm_volume_block_size_get
41           * lsm_volume_admin_state_get
42           * lsm_volume_pool_id_get
43

CAPABILITY

45       LSM_CAP_VOLUMES
46

RETURN

48       Error code as enumerated by 'lsm_error_number'.
49           * LSM_ERR_OK
50               On success or searched value not found.
51           * LSM_ERR_INVALID_ARGUMENT
52               When any argument is NULL or invalid flags or invalid search
53               key.
54           * LSM_ERR_NO_SUPPORT
55               Not supported.
56
57
58
59November 2022                   lsm_volume_list             lsm_volume_list(3)