lsm_pool_list man page

lsm_pool_list — Query the list of storage pools on this connection.

Synopsis

int lsm_pool_list (lsm_connect *conn, char *search_key, char *search_value, lsm_pool **pool_array[], uint32_t *count, lsm_flag flags);

Arguments

conn

Valid lsm_connect pointer.

search_key

Search key(NULL for all). Valid search keys are: "id", "system_id".

search_value

Search value.

pool_array[]

Output pointer of lsm_pool array. It should be manually freed by lsm_pool_record_array_free.

count

Output pointer of uint32_t. Number of storage pools.

flags

Reserved for future use, must be LSM_CLIENT_FLAG_RSVD.

Version

1.0

Description

Query the list of storage pools on this connection. Pool is the only place a volume or a file system could created from. Pool properties could be retrieved by these functions:
   * lsm_pool_id_get
   * lsm_pool_name_get
   * lsm_pool_system_id_get
   * lsm_pool_free_space_get
   * lsm_pool_total_space_get
   * lsm_pool_status_get
   * lsm_pool_status_info_get
   * lsm_pool_unsupported_actions_get
   * lsm_pool_element_type_get

Return

Error code as enumerated by 'lsm_error_number'.
   * LSM_ERR_OK
       On success or searched value not found.
   * LSM_ERR_INVALID_ARGUMENT
       When any argument is NULL or invalid flags or invalid search
       key.

Info

lsm_pool_list October 2017 Libstoragemgmt C API Manual