---
title: "Initiate a Ping test on a AOS-S Switch"
method: POST
path: "/network-troubleshooting/v1/aos-s/{serial-number}/ping"
tags: ["AOS-S Switches"]
---

# Initiate a Ping test on a AOS-S Switch

`POST /network-troubleshooting/v1/aos-s/{serial-number}/ping`

## Request

- Base URL: `https://sso.common.cloud.hpe.com`
- URL: `https://sso.common.cloud.hpe.com/network-troubleshooting/v1/aos-s/{serial-number}/ping`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://sso.common.cloud.hpe.com/as/token.oauth2`
- TypeScript: <https://skmtc.dev/arubanetworks/apis/authorization/docs/network-troubleshooting/v1/aos-s/:serial-number/ping/post.ts> (a function with typed inputs; its response is checked against the schema)

Starts an asynchronous Ping test on the specified AOS-S Switch.

## Path parameters

- `serial-number` string, required

## Request body

- PingHppcRequest
  - `destination` string, required: Hostname/IP address required
  - `useIpv6` boolean: Use IPv6
  - `packetSize` integer: The packet size in bytes (10-2000)
  - `count` integer: Number of probes to send (1-100)
  - `loopbackPort` integer
  - `vlan` integer
  - `ipAddress` string
  - `includeRawOutput` boolean: Whether to include raw output in the response.

## Response `202`

Accepted. The operation has been successfully initiated. The response includes the location to track the operation's status.

- AsyncOperationStatus
  - `location` string, uri-reference: The relative URL path to query the status and result of the asynchronous operation.
  - `status` 'INITIATED': The initial status of the operation.
  - `startTime` string, date-time: ISO 8601 timestamp indicating when the operation was initiated.

## Other responses

- `400`: Bad Request. Validation errors in the request body or parameters, or invalid parameters for the specific device.
- `401`: Unauthorized. Authentication credentials are required or invalid.
- `403`: Forbidden: Access is denied.
- `404`: Not Found. The device with the specified serial number was not found.
- `409`: Conflict. The device is currently offline.
- `429`: Too Many Requests. The user has sent too many requests in a given amount of time.
- `500`: Internal Server Error. An unexpected error occurred on the server.

---

[API](https://skmtc.dev/arubanetworks/apis/authorization.md) - [All operations](https://skmtc.dev/arubanetworks/apis/authorization/llms.txt) - [OpenAPI document](https://skmtc.dev/arubanetworks/apis/authorization/revisions/74c95058b11f?raw)
