Skip to content

Commit 5a7c3cc

Browse files
committed
Update VM SSH-ENDPOINT to show we can access by id or name
1 parent e2739ff commit 5a7c3cc

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

docs/reference/replicated-cli-vm-ssh-endpoint.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,19 @@ Get the SSH endpoint and port of a VM.
88

99
The output will be in the format: hostname:port
1010

11+
You can identify the VM either by its unique ID or by its name.
12+
13+
Note: SSH endpoints can only be retrieved from VMs in the "running" state.
14+
1115
```
12-
replicated vm ssh-endpoint VM_ID [flags]
16+
replicated vm ssh-endpoint VM_ID_OR_NAME [flags]
1317
```
1418

1519
### Examples
1620

1721
```
1822
# Get SSH endpoint for a specific VM by ID
19-
replicated vm ssh-endpoint <id>
23+
replicated vm ssh-endpoint <id-or-name>
2024
```
2125

2226
### Options

0 commit comments

Comments
 (0)