Obtaining All the Host Information

Introduction

Obtains Host information.

Information is stored by Host ID in ascending order.

Caution

Only the FC Host information and iSCSI Host information are returned.

Request Examples

This is an example of obtaining information about an FC Host.

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

Response Examples

{
  "total_count": 512,
  "list_count": 1,
  "host_list": [
    {
      "host_id": 256,
      "host_href": "/api/v1/host/256",
      "type": "FC",
      "number": 256,
      "name": "HBA#1",
      "wwn": "40000000abc80e38",
      "host_response_name": "Default",
      "is_shared_host_exist": false
    }
  ]
}

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.

status

Array of strings

Status.

Specify the status of the Host for which you want information.

Item	Description
Unused	Unused host.
Normal	All connected Volumes are Normal.
Maintenance	Some of the connected Volumes are in the Maintenance state and there are no Volumes in the Error or Warning state.
Warning	Some of the connected Volumes are in the Warning state and there are no Volumes in the Error state.
Error	Some of the connected Volumes are in the Error state.

Input criteria:

You can specify up to 5 values.

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.

start_number

integer

Default: 0

The first number of the resource for which you want information.

last_get_id

integer

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.

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.
host_list	Array of objects The information that can be obtained with GET /host/host_id as the number specified for list_count is output. For more information, see "Responses" in Obtaining Host Information.
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 responded if there are more Resources that match the response condition than the number specified by max_records.