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 quickly install the CLI from the DC/OS web interface.
To list available commands, either run
dcos with no parameters or run
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 DC/OS cluster config Manage the DC/OS configuration file experimental Experimental commands. These commands are under development and are subject to change help Display help information about DC/OS job Deploy and manage jobs in DC/OS marathon Deploy and manage applications to DC/OS node Administer and manage DC/OS cluster nodes package Install and manage DC/OS software packages service Manage DC/OS services task Manage DC/OS tasks Get detailed command description with 'dcos <command> --help'.
These environment variables are supported by the DC/OS CLI and can be set dynamically.
Specifies 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:
Indicates whether to verify SSL certificates or set the path to the SSL certificates. You must set this variable manually. Setting this environment variable is equivalent to setting the
dcos config set core.ssl_verify option in the DC/OS configuration file. For example, to indicate that you want to set the path to SSL certificates:
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:
Indicates whether to print additional debug messages to
stdout. By default this is set to
false. For example:
By default, the DC/OS CLI 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.
The public master IP of your DC/OS installation. This is set by default during installation. For example:
dcos config set core.dcos_url 220.127.116.11
The token generated by authenticating to DC/OS with the Access Control Service (ACS). To set the ACS token, run:
dcos config set core.dcos_acs_token <token>
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 18.104.22.168:5050
Indicates whether to paginate output. By default this is set to
True. For example, to set to false:
dcos config set core.pagination False
Indicates whether to verify SSL certs for HTTPS or path to certs. By default this is set to
True. For example, to set to false:
dcos config set core.ssl_verify False
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
Installing the CLI
The recommended method to install the DC/OS CLI is by clicking the quick-launch icon on the lower-left panel of the DC/OS web interface. Or, you can manually install the CLI by following these instructions.…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
Connecting to Multiple Clusters
You can connect the CLI to multiple DC/OS clusters at the same time by using the DCOS_CONFIG environment variable. With this variable you can specify a terminal-specific CLI configurations.…Read More
Uninstalling the CLI
You can uninstall the CLI with these commands for your operating system.…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
DC/OS Enterprise CLI
A macOS or Linux operating system. Windows is not currently supported.…Read More