Files
coder/docs/reference/cli/ping.md
T

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

77 lines
1.8 KiB
Markdown
Raw Normal View History

---
# Code generated by make gen. DO NOT EDIT.
title: "`coder ping`"
description: Ping a workspace.
---
2023-03-23 17:42:20 -05:00
<!-- DO NOT EDIT | GENERATED CONTENT -->
Ping a workspace
## Usage
```console
coder ping [flags] <workspace>
```
## Options
### --wait
2023-03-23 17:42:20 -05:00
| Property | Value |
|----------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>1s</code> |
2023-03-23 17:42:20 -05:00
Specifies how long to wait between pings.
2023-03-23 17:42:20 -05:00
### -t, --timeout
| Property | Value |
|----------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>5s</code> |
2023-03-23 17:42:20 -05:00
Specifies how long to wait for a ping to complete.
### -n, --num
2023-03-23 17:42:20 -05:00
| Property | Value |
|----------|------------------|
| Type | <code>int</code> |
2023-03-23 17:42:20 -05:00
Specifies the number of pings to perform. By default, pings will continue until interrupted. Required with --output json.
### --time
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Show the response time of each pong in local time.
### --utc
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Show the response time of each pong in UTC (implies --time).
### -c, --column
| Property | Value |
|----------|----------------------------------------------------------------------|
| Type | <code>[workspace\|total\|successful\|min\|avg\|max\|variance]</code> |
| Default | <code>workspace,total,successful,min,avg,max,variance</code> |
Columns to display in table output.
### -o, --output
| Property | Value |
|----------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.