table of contents
lsm_target_port_list(3) | Libstoragemgmt C API Manual | lsm_target_port_list(3) |
NAME¶
lsm_target_port_list - Gets a list of target ports on this connection.
SYNOPSIS¶
int lsm_target_port_list (lsm_connect *conn, const char *search_key, const char *search_value, lsm_target_port **target_ports[], uint32_t *count, lsm_flag flags);
ARGUMENTS¶
- conn
- Valid connection.
- search_key
- Search key(NULL for all). Valid search keys are: "id", and "system_id".
- search_value
- Search value.
- target_ports[]
- Output pointer of lsm_target_port array. Return value must be freed with a call to lsm_target_port_record_array_free.
- count
- Output pointer of uint32_t. Number of target ports.
- flags
- Reserved for future use, must be LSM_CLIENT_FLAG_RSVD.
VERSION¶
1.0
DESCRIPTION¶
Gets a list of target ports on this connection. Target port are
the front-end port of storage system which storage user/client connect to
and get storage service from. Target port properties could be retrieved by
these functions:
* lsm_target_port_id_get
* lsm_target_port_type_get
* lsm_target_port_system_id_get
* lsm_target_port_network_address_get
* lsm_target_port_physical_address_get
* lsm_target_port_physical_name_get
* lsm_target_port_service_address_get
CAPABILITY¶
LSM_CAP_TARGET_PORTS
RETURN¶
Error code as enumerated by 'lsm_error_number'.
* LSM_ERR_OK
On success or searched value not found.
* LSM_ERR_INVALID_ARGUMENT
When any argument is NULL or invalid flags or invalid search
key.
* LSM_ERR_NO_SUPPORT
Not supported.
lsm_target_port_list | January 2023 |