Send ARP ping to a host from the node

Request

Runs arping -i {iface} {host} on the node and streams the output. Useful for verifying Layer 2 reachability on a given interface.

Use ?wait=1 to block and receive the command output.

Requires nodes::service:tg-arping or nodes::remote-execute permission.

Security

JWTAuthorizer

Path

nodeIDstringrequired

Node ID

Query

waitinteger

Pass 1 to block until the node responds and return its output.

Value:1

Bodyapplication/jsonrequired

ifacestringrequired

Network interface to send ARP packets from

Example:"eth0"

hoststringrequired

Target host IP address

Example:"192.168.1.1"

curl -i -X POST \
  'https://apidocs.trustgrid.io/_mock/node/{nodeID}/trigger/tg-arping?wait=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "iface": "eth0",
    "host": "192.168.1.1"
  }'

Responses

OK

Bodyapplication/json

boolean

Response

true