Skip to main content
List all machines that are part of your Uncloud cluster, showing their status, network information, and identifiers.

Usage

uc machine ls
Alias: uc machine list

Output

The command displays a table with the following columns:
  • NAME - Machine name
  • STATE - Current state (Active, Joining, etc.)
  • ADDRESS - Machine’s internal network address (CIDR)
  • PUBLIC IP - Public IP address for ingress (or - if none)
  • WIREGUARD ENDPOINTS - WireGuard endpoint addresses for peer connections
  • MACHINE ID - Unique machine identifier

Examples

List all machines

uc machine ls
Example output:
NAME       STATE    ADDRESS          PUBLIC IP      WIREGUARD ENDPOINTS        MACHINE ID
vps1       Active   10.210.0.0/24    203.0.113.10   203.0.113.10:51820         m_abc123
worker1    Active   10.210.1.0/24    203.0.113.20   203.0.113.20:51820         m_def456
worker2    Active   10.210.2.0/24    -              192.168.1.100:51820        m_ghi789

Understanding the Output

Machine State

  • Active - Machine is running and part of the cluster
  • Joining - Machine is in the process of joining the cluster
  • Left - Machine has left the cluster

Network Address

The internal cluster network address assigned to the machine. Containers on this machine will receive IP addresses from this subnet.

Public IP

The public IP address used for ingress traffic. Shows - if the machine has no public IP configured (internal-only machine).

WireGuard Endpoints

The IP and port combinations that other machines use to establish WireGuard VPN connections to this machine. A machine can have multiple endpoints for different network interfaces.

Build docs developers (and LLMs) love