unregister-host

Description

Unregister a host

Delete a host from the state file. This command will not connect to the host, nor will it perform any operations on its nodes. To destroy an existing cluster and deploy a new one by deleting all data, deleting all nodes, uninstalling all singlestoredb-server packages, and unregistering all hosts, use sdb-deploy destroy-cluster.

Usage

Usage:
  sdb-toolbox-config unregister-host [flags]

  For flags that can accept multiple values (indicated by VALUES after the name of the flag),
  separate each value with a comma.

Flags:
  -a, --all           Unregister all hosts
  -h, --help          Help for unregister-host
      --host string   The host to unregister

Global Flags:
      --backup-cache FILE_PATH                File path for the backup cache
      --cache-file FILE_PATH                  File path for the Toolbox node cache
  -c, --config FILE_PATH                      File path for the Toolbox configuration
      --disable-colors                        Disable color output in console, which some terminal sessions/environments may have difficulty with
      --disable-spinner                       Disable the progress spinner, which some terminal sessions/environments may have issues with
  -j, --json                                  Enable JSON output
      --parallelism POSITIVE_INTEGER          Maximum number of operations to run in parallel
      --runtime-dir DIRECTORY_PATH            Where to store Toolbox runtime data
      --ssh-max-sessions POSITIVE_INTEGER     Maximum number of SSH sessions to open per host, must be at least 3
      --ssh-strict-host-key-checking          Enable strict host key checking for SSH connections
      --ssh-user-known-hosts-file FILE_PATH   Path to the user known_hosts file for SSH connections. If not set, /dev/null will be used
      --state-file FILE_PATH                  Toolbox state file path
  -v, --verbosity count                       Increase logging verbosity: valid values are 1, 2, 3. Usage -v=count or --verbosity=count
  -y, --yes                                   Enable non-interactive mode and assume the user would like to move forward with the proposed actions by default

Remarks

This command is interactive unless you use either --yes or --json flag to override interactive behavior.

Output

The following example uses the unregister-host command to unregister the local host.

Shell

sdb-toolbox-config unregister-host --host host-1

Toolbox is about to unregister the following host:
  · Host: host-1
  · Localhost: true

Would you like to continue? [y/N]: y
✓ Successfully unregistered host host-1
+----------------+------------+-------------+---------------+
|      Host      | Local Host | SSH address | Identity File |
+----------------+------------+-------------+---------------+
| host-1         | Yes        |             |               |
+----------------+------------+-------------+---------------+