Ping

POST

/api/operate/namespaces/{namespace}/sites/{site}/ver/ping

curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/operate/namespaces/example/sites/example/ver/ping \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "count": 1, "dest": { "hostname": "example", "ip": "example" }, "interval": 1, "intf": { "any_intf": {}, "intf": "example" }, "namespace": "example", "node": "example", "pkt_size": 1, "site": "example" }'

• F5 Distributed Cloud Console

Run ping to a destination.

Authorizations

• ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace Namespace for which the request is sent (system)

site

required

string

Site Name Name of the site from which ping is initiated.

Request Body^required

Media typeapplication/json

Ping Request

Request to run ping to a destination.

object

count

Count

Number of ping requests to be sent.

integer format: int64

dest

object

hostname

Hostname

Exclusive with [IP] DNS name of the host.

string

<= 256 characters

ip

IP

Exclusive with [hostname] IP address of the host.

string

<= 1024 characters

interval

Interval

Interval between ping requests, in milliseconds.

integer format: int64

intf

object

any_intf

object

intf

Interface Name

Exclusive with [any_intf] Name of the chosen interface on the node.

string

>= 1 characters <= 256 characters

namespace

Namespace

Namespace for which the request is sent (system)

string

>= 6 characters <= 1024 characters

node

Node Name

Name of the node from which ping is initiated Required: YES.

string

>= 1 characters <= 64 characters

pkt_size

Packet Size

Ping packet size.

integer format: int64

site

Site Name

Name of the site from which ping is initiated.

string

<= 1024 characters

Example^generated

{
  "count": 1,
  "dest": {
    "hostname": "example",
    "ip": "example"
  },
  "interval": 1,
  "intf": {
    "any_intf": {},
    "intf": "example"
  },
  "namespace": "example",
  "node": "example",
  "pkt_size": 1,
  "site": "example"
}

Responses

200

A successful response.

Media typeapplication/json

Ping Response

Response to the ping request.

object

avg_rtt

Average RTT

Average round trip time.

string

<= 1024 characters

dest

Destination

Destination address used for ping.

string

<= 1024 characters

lost

Lost

Number of packets lost.

integer format: int64

max_rtt

Max RTT

Maximum round trip time.

string

<= 1024 characters

min_rtt

Min RTT

Minimum round trip time.

string

<= 1024 characters

received

Received

Number of responses received.

integer format: int64

sent

Sent

Number of packets sent.

integer format: int64

std_dev_rtt

RTT Standard Deviation

Standard Deviation RTT.

string

<= 1024 characters

Example^generated

{
  "avg_rtt": "example",
  "dest": "example",
  "lost": 1,
  "max_rtt": "example",
  "min_rtt": "example",
  "received": 1,
  "sent": 1,
  "std_dev_rtt": "example"
}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example