Back to Yugabyte Db

Yba Login

managed/yba-cli/docs/yba_login.md

2026.1.0.0-b252.6 KB
Original Source

yba login

Authenticate yba cli using email and password

Synopsis

Connect to YugabyteDB Anywhere host machine using email and password. If non-interactive mode is set, provide the host, email and password using flags. Default for host is "http://localhost:9000".

yba login [flags]

Examples

yba login -f -e <email> -p <password> -H <host>

Options

  -e, --email string      [Optional] Email or username for the user. Required for non-interactive usage.
  -p, --password string   [Optional] Password for the user. Required for non-interactive usage. Use single quotes ('') to provide values with special characters.
      --show-api-token    [Optional] Show the API token after login. (default false)
  -f, --force             [Optional] Bypass the prompt for non-interactive usage.
  -h, --help              help for login

Options inherited from parent commands

  -a, --apiToken string    YugabyteDB Anywhere api token.
      --ca-cert string     CA certificate file path for secure connection to YugabyteDB Anywhere. Required when the endpoint is https and --insecure is not set.
      --config string      Full path to a specific configuration file for YBA CLI. If provided, this takes precedence over the directory specified via --directory, and the generated files are added to the same path. If not provided, the CLI will look for '.yba-cli.yaml' in the directory specified by --directory. Defaults to '$HOME/.yba-cli/.yba-cli.yaml'.
      --debug              Use debug mode, same as --logLevel debug.
      --directory string   Directory containing YBA CLI configuration and generated files. If specified, the CLI will look for a configuration file named '.yba-cli.yaml' in this directory. Defaults to '$HOME/.yba-cli/'.
      --disable-color      Disable colors in output. (default false)
  -H, --host string        YugabyteDB Anywhere Host (default "http://localhost:9000")
      --insecure           Allow insecure connections to YugabyteDB Anywhere. Value ignored for http endpoints. Defaults to false for https.
  -l, --logLevel string    Select the desired log level format. Allowed values: debug, info, warn, error, fatal. (default "info")
  -o, --output string      Select the desired output format. Allowed values: table, json, pretty. (default "table")
      --timeout duration   Wait command timeout, example: 5m, 1h. (default 168h0m0s)
      --wait               Wait until the task is completed, otherwise it will exit immediately. (default true)

SEE ALSO

  • yba - yba - Command line tools to manage your YugabyteDB Anywhere (Self-managed Database-as-a-Service) resources.