table of contents
lsm_disk_list(3) | Libstoragemgmt C API Manual | lsm_disk_list(3) |
NAME¶
lsm_disk_list - Gets a list of disks on this connection.
SYNOPSIS¶
int lsm_disk_list (lsm_connect *conn, const char *search_key, const char *search_value, lsm_disk **disks[], 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.
- disks[]
- Output pointer of lsm_disk array. It should be manually freed by lsm_disk_record_array_free.
- count
- Output pointer of uint32_t. Number of disks.
- flags
- Reserved for future use, must be LSM_CLIENT_FLAG_RSVD.
VERSION¶
1.0
DESCRIPTION¶
Gets a list of disks on this connection. Disk properties could be
retrieved by these functions:
* lsm_disk_id_get
* lsm_disk_name_get
* lsm_disk_system_id_get
* lsm_disk_type_get
* lsm_disk_number_of_blocks_get
* lsm_disk_block_size_get
* lsm_disk_status_get
* lsm_disk_location_get
* lsm_disk_rpm_get
* lsm_disk_link_type_get
* lsm_disk_vpd83_get
CAPABILITY¶
LSM_CAP_DISKS
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.
lsm_disk_list | April 2023 |