Obtaining the Information of the Hosts Logged In to a CA Port

GET /host/connected

Introduction

Obtains the information of the Hosts logged in to the CA Port.

The response order for the information of the Hosts logged in to the CA Port is as follows.

  • After a response with all the information of the Hosts logged in to the FC Port is returned, the information of the Hosts logged in to the iSCSI Port is returned.

  • The information of the Hosts logged in to the FC Port is returned in ascending order of WWNs.

  • The information of the Hosts logged in to the iSCSI Port is returned in ascending order of IP Addresses.

Caution

  • Only the information of the FC Hosts and iSCSI Hosts logged in to the CA Port is returned.

  • For tenant users, the information of the CA Port is returned when a Host belonging to the tenant of the current user and a host that is unregistered are logged in.

    If an unregistered host is left connected to a CA Port, information such as the IP Address and WWN may be exposed to other tenants. Therefore, register the target Host immediately after connecting it to a CA Port.

Request Examples

  • This is an example of obtaining information about the FC Host that is logged in to a CA Port.

$ curl -i -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X GET "https://192.168.1.1:5665/api/v1/host/connected?type=FC"

Response Examples

{
  "total_count": 512,
  "list_count": 1,
  "connected_host_list": [
    {
      "type": "FC",
      "host_id": 256,
      "host_href": "/api/v1/host/256",
      "host_name": "HBA#1",
      "connected_caport_href_list": [
        "/api/v1/caport/0000",
        "/api/v1/caport/0100"
      ],
      "wwn": "40000000abc80e38",
      "ip_address": "192.168.1.10",
      "iscsi_name": "iqn.1991-05.com.microsoft"
    }
  ],
  "next_href": "/api/v1/volume?is_used_status_attention=true&fields=number,name&last_get_id=100005"
}

Parameters

QUERY PARAMETERS

fields

Array of strings

Parameter to display.

Only the information of the specified Parameter name (Response Body Parameter) is extracted and obtained.

For details about the specification methods, see Property Filter.
host_id

Array of integers

Host ID.

Specify the Host ID for which you want information.

Input criteria:

  • You can specify up to 256 values.
type

Array of strings

Host type.

Specify the Host type for which you want information.
Item Description
FC FC Host
iSCSI iSCSI Host

Input criteria:

  • You can specify up to 2 values.
is_unregistered_host

boolean

Specify whether to return only the information of hosts that are not registered to the storage system.

If true is specified, only the information of the hosts that are not registered to the storage system is returned.
max_records

integer

The maximum number of resources for which you want information.

Specify this parameter when you want to limit the number of pieces of information that can be answered.

Input criteria:

  • The range of allowed values is 1 to 512.
last_get_id

string

The identifier of the resource for which to obtain further information.

If all resources matching the response conditions cannot be answered at once, next_href is returned.

The last_get_id is the information given to next_href to obtain further information.

Input criteria:

  • For FC Hosts, specify fc_"WWN".

  • For iSCSI Hosts, specify iscsi_"IP Address".

    • For example, fc_40000000abc80e38 and iscsi_192.168.1.161 can be specified.

Responses

If successful, the HTTP status code is 200 (OK) and the response body is returned.

RESPONSE BODY

total_count

integer

The total number of Resources present in the device.

If a filter is applied, this is the total number of Resources that meet the criteria.
list_count

integer

Number of Lists to respond.
connected_host_list

Array of objects

type

string

Host type.
Item Description
FC FC Host
iSCSI iSCSI Host
host_id

integer

Host ID.

Respond only if the Host is registered to the storage system.
host_href

string

Link to Host Resource.

Respond only if the Host is registered to the storage system.
host_name

string

Host Name.

Respond only if the Host is registered to the storage system.
connected_caport_href_list

Array of strings

Resource link of the CA Port to which the Host is logged in.
wwn

string

FC Host WWN.

It will not respond if it is not FC.
ip_address

string

The IP address of the iSCSI Host.

It will not respond if it is not iSCSI.
iscsi_name

string

iSCSI Name of the iSCSI Host.

It will not respond if it is not iSCSI.
next_href

string

Link to get more information.

This item is returned only when it is not possible to respond all information at once.

For example, this item is returned if there are more Resources that match the response condition than the number specified by max_records.