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

NAME

6       lsm_pool_list - Query the list of storage pools on this connection.
7

SYNOPSIS

9       int   lsm_pool_list   (lsm_connect   *conn,   char   *search_key,  char
10       *search_value,  lsm_pool  **pool_array[],  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".
18
19       search_value
20                   Search value.
21
22       pool_array[]
23                   Output pointer of lsm_pool array.  It  should  be  manually
24                   freed by lsm_pool_record_array_free.
25
26       count       Output pointer of uint32_t. Number of storage pools.
27
28       flags       Reserved for future use, must be LSM_CLIENT_FLAG_RSVD.
29

VERSION

31       1.0
32

DESCRIPTION

34       Query  the  list of storage pools on this connection.  Pool is the only
35       place a volume or a file system could created  from.   Pool  properties
36       could be retrieved by these functions:
37           * lsm_pool_id_get
38           * lsm_pool_name_get
39           * lsm_pool_system_id_get
40           * lsm_pool_free_space_get
41           * lsm_pool_total_space_get
42           * lsm_pool_status_get
43           * lsm_pool_status_info_get
44           * lsm_pool_unsupported_actions_get
45           * lsm_pool_element_type_get
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
55
56
57February 2020                    lsm_pool_list                lsm_pool_list(3)
Impressum