Obtaining CA Port Information
GET /caport/{caport_id}Introduction
Obtains CA Port information.
Request Examples
This is an example of obtaining only the CA Port ID, Interface Type, and status for CA Port ID 0101.
$ curl -i -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X GET "https://192.168.1.1:5665/api/v1/caport/0101?fields=status,type"
Response Examples
{
"caport_id": "0011",
"caport_href": "/api/v1/caport/0011",
"status": "Normal",
"ce_id": 0,
"cm_number": 0,
"ca_number": 1,
"port_number": 1,
"type": "iSCSI",
"max_speed": 1,
"mode": "CA",
"sfp_type": "16G_SWL_SFP_Plus",
"link_speed": 1,
"is_host_affinity_disabled": false,
"is_used_for_storage_cluster": false,
"mac_address": "01:02:03:04:05:06",
"iscsi_name": "iqn.2000-09.com.fujitsu:storage-system.eternus_dxl:000000",
"iscsi_alias_name": "ALIAS00",
"is_vlan_enable": true,
"ip_address_list": [
{
"ipv4_address": "192.168.1.1",
"vlan_id": 0
},
{
"link_local_ipv6_address": "fe80::290:ccff:fea4:3a49",
"connect_ipv6_address": "2001:db8::8:800:200c:417a",
"vlan_id": 1
}
]
}
Parameters
PATH PARAMETERS
| caport_id (required) |
string The CA Port ID. Format is as follows: wxyz
|
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. |
Responses
If successful, the HTTP status code is 200 (OK) and the response body is returned.
RESPONSE BODY
| caport_id | string The CA Port ID. Format is as follows: wxyz
|
||||||||||||||||
| caport_href | string Link to the CA Port. |
||||||||||||||||
| status | string Status.
|
||||||||||||||||
| ce_id | string The CE ID under which the CA Port is implemented. |
||||||||||||||||
| cm_number | integer The CM Number where the CA Port is implemented. |
||||||||||||||||
| ca_number | integer The CA Slot Number where the CA Port is implemented. |
||||||||||||||||
| port_number | integer The Port Number of the CA where the CA Port is implemented. |
||||||||||||||||
| type | string The Interface Type of the CA Port.
|
||||||||||||||||
| max_speed | integer The maximum transfer rate of the CA Port. The unit is Gbit/s. If the maximum transfer rate is less than 1 Gbit/s, 0 is returned. |
||||||||||||||||
| mode | string Port operating mode.
|
||||||||||||||||
| sfp_type | string SFP type.
|
||||||||||||||||
| link_speed | integer Link state of the Port. Responds only if Type is FC or iSCSI. The unit is Gbit/s. If the link is down, 0 is answered. |
||||||||||||||||
| is_host_affinity_disabled | boolean Whether the Host Affinity Mode is an invalid Port. If true, Host Affinity Mode is set to Disable and the Connection cannot be set. Responds only if Type is FC or iSCSI and Mode is CA or CARA. |
||||||||||||||||
| is_used_for_storage_cluster | boolean Whether the Port is used by the Storage Cluster function. If true, the Storage Cluster function is using it and the Connection cannot be set. Responds only if Type is FC or iSCSI and Mode is CA or CARA. |
||||||||||||||||
| wwpn | string World Wide Port Name. Responds only if Type is FC. |
||||||||||||||||
| mac_address | string The MAC address of the Port. Responds only if Type is iSCSI. |
||||||||||||||||
| iscsi_name | string iSCSI Name. Responds only if Type is iSCSI. |
||||||||||||||||
| iscsi_alias_name | string iSCSI Alias Name. Responds only if Type is iSCSI. |
||||||||||||||||
| is_vlan_enable | boolean Whether the VLAN feature is enabled. If true, the VLAN feature is enabled. Responds only if Type is iSCSI. |
||||||||||||||||
| ip_address_list | Array of objects A list of IP addresses and VLAN IDs. Responds only if Type is iSCSI. If the VLAN feature is disabled, the VLAN ID does not respond. It responds with an empty List if no IP Address is configured.
|