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

NAME

6       lsm_fs_list - Gets a list of file systems on this connection.
7

SYNOPSIS

9       int  lsm_fs_list (lsm_connect *conn, const char *search_key, const char
10       *search_value, lsm_fs **fs[], uint32_t *fs_count, lsm_flag flags);
11

ARGUMENTS

13       conn        Valid connection.
14
15       search_key  Search key (NULL for all)  Valid  search  keys  are:  "id",
16                   "system_id" and "pool_id".
17
18       search_value
19                   Search value.
20
21       fs[]        Output pointer of lsm_fs array. It should be manually freed
22                   by lsm_fs_record_array_free.
23
24       fs_count    Number of file systems.
25
26       flags       Reserved for future use, must be LSM_CLIENT_FLAG_RSVD.
27

VERSION

29       1.0
30

DESCRIPTION

32       Gets a list of file systems on this connection.  Network Attached Stor‐
33       age  (NAS) Storage array can expose a Filesystem to host OS via IP net‐
34       work using NFS or CIFS protocol. The host OS treats it as a mount point
35       or  a  folder  containing  files  depending on client operating system.
36       File system properties could be retrieved by these functions:
37           * lsm_fs_id_get
38           * lsm_fs_name_get
39           * lsm_fs_system_id_get
40           * lsm_fs_pool_id_get
41           * lsm_fs_total_space_get
42           * lsm_fs_free_space_get
43

CAPABILITY

45       LSM_CAP_FS
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
59April 2023                        lsm_fs_list                   lsm_fs_list(3)