Note: Applies to CLI v2.
bosh -hshows global flags described here and all available commands
bosh <command> -hshows command specific options
-vflag shows CLI version.
Note: To see Director version use `bosh env` command.
-e) flag allows to specify Director VM address or environment alias (
--ca-certflag allows to specify CA certificate used for connecting for Director and UAA (
CLI does not provide a way to skip SSL certificate validation to encourage secure Director configuration.
See CLI environments for details.
--clientflag allows to specify basic auth username or UAA client ID (
--client-secretflag allows to specify basic auth password or UAA client secret (
CLI does not provide a way to specify UAA user login information since all non-interactive use (in scripts) should use UAA clients.
bosh log-in command allows to log in interactively as a UAA user.
--nflag affirms any confirmation that typically requires use input (
--jsonflag changes output format to JSON
--ttyflag forces output to include all decorative text typically visible when command is not redirected
--no-colorflag disables colors (enabled by default when command is redirected)
CLI makes a distinction between decorative text (table headings) and primary content (such as tables). To make it eas easy to parse command output via other tools (such as grep) when decorative text is automatically hidden when command output is redirected.
-d) flag allows to specify deployment for a command (
Several commands that can operate in a Director and a deployment context (such as
bosh tasks command) account for presence of this flag and filter their output based on a deployment.
See tunneling for details.
Along with the UI output (stdout) and UI errors (stderr), CLI can output more verbose logs.
Logging is disabled by default (
BOSH_LOG_LEVEL defaults to
To enable logging, set the
BOSH_LOG_LEVEL environment variable to one of the following values:
Logs write to stdout (debug & info) & stderr (warn & error) by default.
To write logs to a file, set the
BOSH_LOG_PATH environment variable to the path of the file to create and/or append to.