table of contents
lsm_access_group_create(3) | Libstoragemgmt C API Manual | lsm_access_group_create(3) |
NAME¶
lsm_access_group_create - Create a new access group.
SYNOPSIS¶
int lsm_access_group_create (lsm_connect *conn, const char *name, const char *init_id, lsm_access_group_init_type init_type, lsm_system *system, lsm_access_group **access_group, lsm_flag flags);
ARGUMENTS¶
- conn
- Valid lsm_connect pointer.
- name
- String. Human recognizable name, might be altered or ignored by certain storage system.
- init_id
- String. Initiator id to be added to 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 - system
- Pointer of lsm_system to create access group for.
- access_group
- Output pointer of newly created lsm_access_group. Returned value must be freed with function lsm_access_group_record_free.
- flags
- Reserved for future use, must be LSM_CLIENT_FLAG_RSVD.
VERSION¶
1.0
DESCRIPTION¶
Creates a new access group with one initiator in it. You may expand the access group by adding more initiators via lsm_access_group_initiator_add.
CAPABILITY¶
LSM_CAP_ACCESS_GROUP_CREATE_WWPN LSM_CAP_ACCESS_GROUP_CREATE_ISCSI_IQN
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 system
pointer or invalid init_type or illegal initiator ID string.
* LSM_ERR_NO_SUPPORT
Not supported.
* LSM_ERR_NOT_FOUND_SYSTEM
When the specified system does not exist.
lsm_access_group_create | April 2021 |