clusterctl login

clusterctl login

clusterctl login

Open a shell on a host, or run one command there

Synopsis

Log in to an infrastructure role, a host or a node.

With no argument the login role is used. A name that matches a configured role connects to that role with its own account and options; any other name is taken as a host or a node and resolved through the naming rules.

Everything after – is run on the remote host instead of opening a shell. The argument vector is quoted once and reassembled by the remote shell exactly as it was given, so globs, quotes and whitespace survive:

clusterctl login install – ls ‘/srv/pxesrv/boot/*’ clusterctl login -r mgmt clusterctl login exe0001

clusterctl login [ROLE|HOST|NODE] [-- COMMAND...] [flags]

Options

  -A, --forward-agent   forward the ssh agent
  -h, --help            help for login
  -J, --jump string     role or host to jump through
  -T, --no-tty          never allocate a terminal
  -r, --root            log in as root
  -t, --tty             force a terminal even for a command
  -u, --user string     remote account to log in as
  -X, --x11             forward X11

Options inherited from parent commands

      --config strings        configuration file or directory to read, repeatable (default: CLUSTERCTL_CONFIG or the search path)
      --context string        context to act on (default: the current one)
      --dry-run               report what would be done and change nothing
      --fanout int            how many hosts to work on at once, at least 1; caps the service processors and the names asked at once too, which fanout.max and CLUSTERCTL_FANOUT do not (default: from the configuration)
      --force                 allow protected hosts, and nodes the inventory does not know, to be touched
  -n, --nodes stringArray     node set to act on, for example 'exe[1-10],@rack:R02' (default: CLUSTERCTL_NODES)
  -o, --output string         output format: table, wide, json, yaml, nodeset, name, jq= (default "table")
      --progress string       how to show the progress of a command on standard error: auto, tty, counter, plain, none (default: CLUSTERCTL_PROGRESS, else auto, a live tree when standard error is a terminal; plain writes lines for a log)
      --progress-log string   append the progress events of a command to this file, one JSON object per line, created readable by you alone (default: CLUSTERCTL_PROGRESS_LOG; an empty one writes none)
      --set stringArray       override one configuration value as PATH=VALUE, repeatable
  -y, --yes                   answer the confirmation prompts with yes

SEE ALSO

  • clusterctl - Administer HPC clusters from one binary