From 5a7c3cc61a3b011e5b46c9ea5c11531df9894775 Mon Sep 17 00:00:00 2001 From: Marc Campbell Date: Wed, 30 Apr 2025 10:46:56 -0600 Subject: [PATCH] Update VM SSH-ENDPOINT to show we can access by id or name --- docs/reference/replicated-cli-vm-ssh-endpoint.mdx | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/reference/replicated-cli-vm-ssh-endpoint.mdx b/docs/reference/replicated-cli-vm-ssh-endpoint.mdx index d0a9aa8757..c764455380 100644 --- a/docs/reference/replicated-cli-vm-ssh-endpoint.mdx +++ b/docs/reference/replicated-cli-vm-ssh-endpoint.mdx @@ -8,15 +8,19 @@ Get the SSH endpoint and port of a VM. The output will be in the format: hostname:port +You can identify the VM either by its unique ID or by its name. + +Note: SSH endpoints can only be retrieved from VMs in the "running" state. + ``` -replicated vm ssh-endpoint VM_ID [flags] +replicated vm ssh-endpoint VM_ID_OR_NAME [flags] ``` ### Examples ``` # Get SSH endpoint for a specific VM by ID -replicated vm ssh-endpoint +replicated vm ssh-endpoint ``` ### Options