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

NAME

6       lsm_access_group_list - Retrieves a list of access groups.
7

SYNOPSIS

9       int  lsm_access_group_list  (lsm_connect *conn, const char *search_key,
10       const  char  *search_value,   lsm_access_group   **groups[],   uint32_t
11       *group_count, lsm_flag 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       groups[]    Output pointer of lsm_access_group array. It should be man‐
23                   ually freed by lsm_access_group_record_array_free.
24
25       group_count Output pointer of uint32_t. Number of access groups.
26
27       flags       Reserved for future use, must be LSM_CLIENT_FLAG_RSVD.
28

VERSION

30       1.0
31

DESCRIPTION

33       Gets  a  list  of access group on this connection. Access group is also
34       known as host group on some storage system, it defines a group of  ini‐
35       tiators sharing the same access to the volume.  Access group properties
36       could be retrieved by these functions:
37           * lsm_access_group_id_get
38           * lsm_access_group_name_get
39           * lsm_access_group_system_id_get
40           * lsm_access_group_initiator_id_get
41

CAPABILITY

43       LSM_CAP_ACCESS_GROUPS
44

RETURN

46       Error code as enumerated by 'lsm_error_number'.
47           * LSM_ERR_OK
48               On success.
49           * LSM_ERR_INVALID_ARGUMENT
50               When any argument is NULL or invalid flags or invalid search
51               key.
52           * LSM_ERR_NO_SUPPORT
53               Not supported.
54
55
56
57December 2019                lsm_access_group_list    lsm_access_group_list(3)
Impressum