You can use the DC/OS command-line interface (CLI) to manage your cluster nodes, install DC/OS packages, inspect the cluster state, and administer the DC/OS service subcommands. You can install the CLI from the DC/OS web interface.
To list available commands, either run
dcos with no parameters or run
dcos Command line utility for the Mesosphere Datacenter Operating System (DC/OS). The Mesosphere DC/OS is a distributed operating system built around Apache Mesos. This utility provides tools for easy management of a DC/OS installation. Available DC/OS commands: auth Authenticate to DCOS cluster config Get and set DC/OS CLI configuration properties help Display command line usage information marathon Deploy and manage applications on the DC/OS node Manage DC/OS nodes package Install and manage DC/OS packages service Manage DC/OS services task Manage DC/OS tasks Get detailed command description with 'dcos <command> --help'.
For easy reference, these environment variables are supported by the DC/OS CLI:
The DC/OS CLI supports several environment variables that you can set dynamically.
DCOS_CONFIG Set the path to the DC/OS configuration file. By default, this variable is set to
DCOS_CONFIG=/<home-directory>/.dcos/dcos.toml. For example, if you moved your DC/OS configuration file to
/home/jdoe/config/ you can specify this command:
DCOS_SSL_VERIFY Indicates whether to verify SSL certificates for HTTPS (
true) or set the path to the SSL certificates (
false). By default, this is variable is set to
true. This is equivalent to setting the
core.ssl_config option in the DC/OS configuration file. For example, to set the path to SSL certificates:
DCOS_LOG_LEVEL Prints log messages to stderr at or above the level indicated. This is equivalent to the
--log-level command-line option. The severity levels are:
- debug Prints all messages to stderr, including informational, warning, error, and critical.
- info Prints informational, warning, error, and critical messages to stderr.
- warning Prints warning, error, and critical messages to stderr.
- error Prints error and critical messages to stderr.
- critical Prints only critical messages to stderr.
For example, to set the log level to warning:
DCOS_DEBUG Indicates whether to print additional debug messages to
stdout. By default this is set to
false. For example:
By default, the DC/OS command line stores its configuration files in a directory called
~/.dcos within your HOME directory. However, you can specify a different location by using the
DCOS_CONFIG environment variable.
The configuration settings are stored in the
dcos.toml file. You can modify these settings with the
dcos config command.
dcos_url The public master IP of your DC/OS installation. This is set by default during installation. For example:
dcos config set core.dcos_url 188.8.131.52
email Your email address. This is set by default during installation. For example, to reset your email address:
dcos config set core.email email@example.com
mesos_master_url The Mesos master URL. This must be of the format:
http://<host>:<port>. For example, to set your Mesos master URL:
dcos config set core.mesos_master_url 184.108.40.206:5050
reporting Indicate whether to report usage events to Mesosphere. By default this is set to
True. For example, to set to false:
dcos config set core.reporting False
ssl_verify Indicates whether to verify SSL certs for HTTPS or path to certs. By default this is set to
False. For example, to set to true:
dcos config set core.ssl_verify True
timeout Request timeout in seconds, with a minimum value of 1 second. By default this is set to 5 seconds. For example, to set to 3 seconds:
dcos config set core.timeout 3
token The OAuth access token. For example, to change the OAuth token:
dcos config set core.token <token>
Installing the CLI
Important: DC/OS 1.8 introduces binary CLIs for Linux, Windows, and Mac. The install script is replaced with a simple binary CLI. The 1.8 CLI (version 0.4.x) is compatible with DC/OS 1.7, 1.8, and 1.9. For more information, see the documentation.…Read More
Configuring the CLI
You can access DC/OS CLI configuration with this command:…Read More
Updating the CLI
You can update the DC/OS CLI to the latest version or downgrade to an older version.…Read More
Uninstalling the CLI
You can uninstall the CLI with these commands.…Read More
CLI Command Reference
By default, dcos node ssh connects to the private IP of the node, which is only accessible from hosts within the same network, so you must use the --master-proxy option to access your cluster from an outside network. For example, in the default AWS configuration, the private agents are unreachable from the public internet, but you can SSH to them using this option, which will proxy the SSH connection through the publicly reachable master.…Read More