Getting server information

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/simple/v1/objects/servers

Request message

Object ID

None.

Query parameters

Parameter	Type	Filter Condition
nickname	string	(Optional) Server nickname Information is obtained about the server that has the nickname is a perfect match of the specified value.
hbaWwn	string	(Optional) WWN of the HBA Information is obtained about the server that has the WWN of the HBA that is a perfect match to the specified value.
iscsiName	string	(Optional) iSCSI name Information is obtained about the server that has the iSCSI name that is a perfect match to the specified value.

Body

None.

Response message

Body

The following is an example of output when getting information about the servers whose nicknames are hostA and hostB respectively (if hostA and hostB are specified for the query parameter nickname of the corresponding servers).

{
  "data": [
    {
      "id": 10,
      "nickname": "hostA",
      "protocol": "FC",
      "osType": "Linux",
      "totalCapacity": 1024,
      "usedCapacity": 42,
      "numberOfPaths": 2,
      "isInconsistent": false,
      "modificationInProgress": false,
      "compatibility": "DKCMAIN_8802010000",
      "isReserved": false,
      "hasUnalignedOsTypes": false
    },
    {
      "id": 11,
      "nickname": "hostB",
      "protocol": "iSCSI",
      "osType": "Linux",
      "totalCapacity": 1024,
      "usedCapacity": 42,
      "numberOfPaths": 2,
      "isInconsistent": false,
      "modificationInProgress": false,
      "compatibility": "DKCMAIN_8802010000",
      "isReserved": false,
      "hasUnalignedOsTypes": false
    }
  ],
  "count": 2
}

The following is an example of output when getting information about the servers whose nicknames are hostC and hostD respectively, and to which host groups are added (if hostC and hostD are specified for the query parameter nickname of the corresponding servers).

{
  "data": [
    {
      "id": 8,
      "nickname": "hostC",
      "protocol": "Undefined",
      "osType": "Undefined",
      "totalCapacity": 0,
      "usedCapacity": 0,
      "numberOfPaths": 0,
      "isInconsistent": false,
      "modificationInProgress": false,
      "compatibility": "DKCMAIN_8802010000",
      "isReserved": true,
      "hasUnalignedOsTypes": false
    },
    {
      "id": 9,
      "nickname": "hostD",
      "protocol": "Undefined",
      "osType": "Undefined",
      "totalCapacity": 0,
      "usedCapacity": 0,
      "numberOfPaths": 0,
      "isInconsistent": false,
      "modificationInProgress": false,
      "compatibility": "DKCMAIN_8802010000",
      "isReserved": true,
      "hasUnalignedOsTypes": false
    }
  ],
  "count": 2
}

Attribute	Type	Description
id	int	Server ID
nickname	string	Server nickname
protocol	string	Protocol One of the following values appears: FC iSCSI Undefined This value appears if host groups are added to the server.
osType	string	OS type One of the following values appears: Linux DeprecatedVMware HP-UX OpenVMS Tru64 Solaris NetWare DeprecatedWindows AIX VMware Windows Undefined This value appears if this server is a server to which host groups are to be added. Unknown
totalCapacity	long	Total capacity of attached volumes (MiB)
usedCapacity	long	Used capacity of attached volumes (MiB)
numberOfPaths	int	Number of HBAs registered on the server
isInconsistent	boolean	Whether the server configuration information is consistent or not: true: Inconsistent false: Consistent
modificationInProgress	boolean	Not currently used
compatibility	string	Not currently used
isReserved	boolean	The following information appears: whether host groups are added to the server. true: Indicates a server to which host groups are added false: Indicates a server other than the above
hasUnalignedOsTypes	boolean	The following information appears: whether inconsistencies exist in the information on the server if a host group (or an iSCSI target) is added to a server for which the OS type is defined, and if the value of the host mode defined for the host group differs from the value of the server's OS type. true: Inconsistencies exist false: Inconsistencies do not exist

Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/servers