Scroll to navigation

lsm_access_group_initiator_delete(3) Libstoragemgmt C API Manual lsm_access_group_initiator_delete(3)

NAME

lsm_access_group_initiator_delete - Deletes an initiator from an access group

SYNOPSIS

int lsm_access_group_initiator_delete (lsm_connect *conn, lsm_access_group *access_group, const char *initiator_id, lsm_access_group_init_type init_type, lsm_access_group **updated_access_group, lsm_flag flags);

ARGUMENTS

Valid lsm_connect pointer.
Pointer of lsm_access_group to modify.
String. Initiator id to be deleted from group.
lsm_access_group_init_type. Valid initiator types are: * LSM_ACCESS_GROUP_INIT_TYPE_ISCSI_IQN
iSCSI IQN. * LSM_ACCESS_GROUP_INIT_TYPE_WWPN
FC WWPN
Output pointer of the updated lsm_access_group. Returned value must be freed with lsm_access_group_record_free.
Reserved for future use, must be LSM_CLIENT_FLAG_RSVD.

VERSION

1.0

DESCRIPTION

Delete an initiator to the specified access group.

CAPABILITY

LSM_CAP_ACCESS_GROUP_INITIATOR_DELETE

RETURN

Error code as enumerated by 'lsm_error_number'.
* LSM_ERR_OK
On success.
* LSM_ERR_INVALID_ARGUMENT
When any argument is NULL or not a valid lsm_connect pointer
or invalid flags or invalid lsm_access_group pointer or
illegal initiator or invalid init_type.
* LSM_ERR_NOT_FOUND_ACCESS_GROUP
When access group not found.
* LSM_ERR_NO_STATE_CHANGE
When specified initiator is not in specified access group.
* LSM_ERR_LAST_INIT_IN_ACCESS_GROUP
When specified initiator is the last initiator in specified
access group. Please use lsm_access_group_delete instead.
* LSM_ERR_NO_SUPPORT
Not supported.

lsm_access_group_initiator_delete April 2023