lsm_access_group_initiator_delete man page

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

conn

Valid lsm_connect pointer.

access_group

Pointer of lsm_access_group to modify.

initiator_id

String. Initiator id to be deleted from group.

init_type

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

updated_access_group

Output pointer of the updated lsm_access_group. Returned value must be freed with lsm_access_group_record_free.

flags

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.

Info

lsm_access_group_initiator_delete October 2017 Libstoragemgmt C API Manual