NAME¶

lsm_volume_list - Gets a list of volumes on this connection.

SYNOPSIS¶

int lsm_volume_list (lsm_connect *conn, const char *search_key, const char *search_value, lsm_volume **volumes[], 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" and "pool_id".

search_value

Search value.

volumes[]

Output pointer of lsm_volume array. It should be manually freed by lsm_volume_record_array_free.

count

Output pointer of uint32_t. Number of volumes.

flags

Reserved for future use, must be LSM_CLIENT_FLAG_RSVD.

VERSION¶

1.0

DESCRIPTION¶

Gets a list of volumes on this connection. Volume properties could be retrieved by these functions:
* lsm_volume_id_get
* lsm_volume_name_get
* lsm_volume_system_id_get
* lsm_volume_vpd83_get
* lsm_volume_number_of_blocks_get
* lsm_volume_block_size_get
* lsm_volume_admin_state_get
* lsm_volume_pool_id_get

CAPABILITY¶

LSM_CAP_VOLUMES

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.
* LSM_ERR_NO_SUPPORT
Not supported.