2023-03-23 17:42:20 -05:00
|
|
|
<!-- DO NOT EDIT | GENERATED CONTENT -->
|
|
|
|
|
# ping
|
|
|
|
|
|
|
|
|
|
Ping a workspace
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
coder ping [flags] <workspace>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Options
|
|
|
|
|
|
2024-03-15 11:24:38 -05:00
|
|
|
### --wait
|
2023-03-23 17:42:20 -05:00
|
|
|
|
2024-03-15 11:24:38 -05:00
|
|
|
| | |
|
2025-01-03 18:12:59 +05:00
|
|
|
|---------|-----------------------|
|
2024-03-15 11:24:38 -05:00
|
|
|
| Type | <code>duration</code> |
|
|
|
|
|
| Default | <code>1s</code> |
|
2023-03-23 17:42:20 -05:00
|
|
|
|
2024-03-15 11:24:38 -05:00
|
|
|
Specifies how long to wait between pings.
|
2023-03-23 17:42:20 -05:00
|
|
|
|
|
|
|
|
### -t, --timeout
|
|
|
|
|
|
|
|
|
|
| | |
|
2025-01-03 18:12:59 +05:00
|
|
|
|---------|-----------------------|
|
2023-03-23 17:42:20 -05:00
|
|
|
| Type | <code>duration</code> |
|
|
|
|
|
| Default | <code>5s</code> |
|
|
|
|
|
|
|
|
|
|
Specifies how long to wait for a ping to complete.
|
|
|
|
|
|
2024-03-15 11:24:38 -05:00
|
|
|
### -n, --num
|
2023-03-23 17:42:20 -05:00
|
|
|
|
2024-09-25 13:24:23 +10:00
|
|
|
| | |
|
2025-01-03 18:12:59 +05:00
|
|
|
|------|------------------|
|
2024-09-25 13:24:23 +10:00
|
|
|
| Type | <code>int</code> |
|
2023-03-23 17:42:20 -05:00
|
|
|
|
2024-09-25 13:24:23 +10:00
|
|
|
Specifies the number of pings to perform. By default, pings will continue until interrupted.
|
2025-02-24 07:38:17 +02:00
|
|
|
|
|
|
|
|
### --time
|
|
|
|
|
|
|
|
|
|
| | |
|
|
|
|
|
|------|-------------------|
|
|
|
|
|
| Type | <code>bool</code> |
|
|
|
|
|
|
|
|
|
|
Show the response time of each pong in local time.
|
|
|
|
|
|
|
|
|
|
### --utc
|
|
|
|
|
|
|
|
|
|
| | |
|
|
|
|
|
|------|-------------------|
|
|
|
|
|
| Type | <code>bool</code> |
|
|
|
|
|
|
|
|
|
|
Show the response time of each pong in UTC (implies --time).
|