Sending the ping command to a specified host

REST API Reference Guide for Virtual Storage Platform 5000, Virtual Storage Platform E Series, and Virtual Storage Platform G/F Series

Version
93-07-0x
90-09-0x
88-08-10
Audience
anonymous
Part Number
MK-98RD9014-17
The request below checks the connection status of a storage system and a host by sending the ping command from a specified iSCSI port on the storage system to the host.

Execution permission

Storage Administrator (View Only)

Request line

POST base-URL/v1/objects/ports/object-ID/actions/ping/invoke

Request message

Object ID

Specify the portId value obtained by getting information about the port.

Attribute

Type

Description

portId

string

(Required) Port number

Query parameters
None.
Body
{
  "parameters" : {
    "ipAddress" : "192.168.0.100"
  }
}

Attribute

Type

Description

ipAddress

string

(Required) IP address of the target host

You can specify an IPv4 address or IPv6 address.

Response message

Body
{
    "transmittedPackets": 5,
    "receivedPackets": 5
}

Attribute

Type

Description

transmittedPackets

int

Number of sent packets

receivedPackets

int

Number of received packets

Action template

None.

Status codes

The following table describes the meaning of the status code of the request for this operation. For details on other status codes, see the description on HTTP status codes.

Status code

Message

Description

503

Service unavailable

The port on the storage system is busy.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/ports/CL1-A/actions/ping/invoke