NAME¶

lsm_access_group_list - Retrieves a list of access groups.

SYNOPSIS¶

int lsm_access_group_list (lsm_connect *conn, const char *search_key, const char *search_value, lsm_access_group **groups[], uint32_t *group_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.

groups[]

Output pointer of lsm_access_group array. It should be manually freed by lsm_access_group_record_array_free.

group_count

Output pointer of uint32_t. Number of access groups.

flags

Reserved for future use, must be LSM_CLIENT_FLAG_RSVD.

VERSION¶

1.0

DESCRIPTION¶

Gets a list of access group on this connection. Access group is also known as host group on some storage system, it defines a group of initiators sharing the same access to the volume. Access group properties could be retrieved by these functions:
* lsm_access_group_id_get
* lsm_access_group_name_get
* lsm_access_group_system_id_get
* lsm_access_group_initiator_id_get

CAPABILITY¶

LSM_CAP_ACCESS_GROUPS

RETURN¶

Error code as enumerated by 'lsm_error_number'.
* LSM_ERR_OK
On success.
* LSM_ERR_INVALID_ARGUMENT
When any argument is NULL or invalid flags or invalid search
key.
* LSM_ERR_NO_SUPPORT
Not supported.