Files
uncloud/website/docs/9-cli-reference/uc_machine_update.md
T

2.1 KiB

uc machine update

Update machine configuration in the cluster.

Synopsis

Update machine configuration in the cluster.

Change the name, public IP address, or WireGuard endpoints of an existing machine. At least one flag must be specified to perform an update.

uc machine update MACHINE [flags]

Examples

  # Rename a machine.
  uc machine update machine1 --name web-server

  # Set the public IP address of a machine.
  uc machine update machine1 --public-ip 203.0.113.10

  # Remove the public IP address from a machine.
  uc machine update machine1 --public-ip none

  # Update WireGuard endpoints for a machine.
  uc machine update machine1 --endpoint 203.0.113.10 --endpoint 192.168.1.5

  # Update multiple properties at once.
  uc machine update machine1 --name web-server --public-ip 203.0.113.10

Options

      --endpoint strings   WireGuard endpoint address in format: IP, IP:PORT, IPv6, or [IPv6]:PORT. Default port 51820 is used if omitted.
                           Other machines in the cluster will use these endpoints to establish a WireGuard connection to this machine.
                           Multiple endpoints can be specified by repeating the flag or using a comma-separated list.
  -h, --help               help for update
      --name string        New name for the machine
      --public-ip string   Public IP address of the machine for ingress configuration. Use 'none' or '' to remove the public IP.

Options inherited from parent commands

      --connect string          Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
                                Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock
  -c, --context string          Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT]
      --uncloud-config string   Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")

See also