Outdated Version

You are viewing an older version of this section. View current production version.

register-node

Info

SingleStore Managed Service does not support this command.

Register an existing SingleStoreDB node on a specific host so it can be managed by sdb-admin and memsqlctl.

Usage

Register an existing SingleStoreDB node on a specific host so it can be managed by `sdb-admin` and `memsqlctl`

Usage:
  sdb-admin register-node [flags]

Flags:
      --auditlogsdir string    Path to the auditlogsdir of the node, if not already specified in the node config file)
      --datadir string         Path to the datadir of the node, if not already specified in the node config file
      --force                  Skip safety checks that require the node be online (e.g., if the password is correct). Use this flag to register an offline node
  -h, --help                   Help for register-node
      --host string            Host of the SingleStoreDB node to be registered
      --memsql-config string   Path to the node config file path of the node
  -p, --password STRING        The current database root password for the node. If a password is specified on the command line, it must not contain an unescaped '$' character as it will be replaced by the shell.
                               If a password is not specified on the command line, Toolbox will attempt to read the password from the ‘MEMSQL_PASSWORD’ environment variable.
                               If this variable is present but does not contain a value, or if the variable does not exist, Toolbox will prompt for a password
      --pid-file string        Path to the current pid file of the node, if not already specified in the node config file
      --plancachedir string    Path to the plancachedir of the node, if not already specified in the node config file
  -P, --port PORT              The node's current port, if not already specified in the node config file
      --ssl-fips-mode string   Whether the node operates in OpenSSL/FIPS mode
      --tracelogsdir string    Path to the tracelogsdir of the node, if not already specified in the node config file

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-control-persist SECONDS           Enable SSH ControlPersist and set it to the specified duration in seconds
      --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 the --yes or --json flags to override interactive behavior.