}}

CLI

Enterprise DC/OS Updated: March 30, 2017

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 help:

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'.

Environment Variables

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:

export DCOS_CONFIG=/home/jdoe/config/dcos.toml

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:

export DCOS_SSL_VERIFY=false

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:

export DCOS_LOG_LEVEL=warning

DCOS_DEBUG Indicates whether to print additional debug messages to stdout. By default this is set to false. For example:

export DCOS_DEBUG=true

Configuration Files

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 the public master IP of your DC/OS installation. This is set by default during installation. For example:

dcos config set core.dcos_url 52.36.102.191

email Your email address. This is set by default during installation. For example, to reset your email address:

dcos config set core.email jdoe@mesosphere.com

mesos_master_url The Mesos mast 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 52.34.160.132: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

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 fol...

Configuring the CLI

You can access DC/OS CLI configuration with this command: dcos config show You should see this output: core.dcos_url=http://dcos.example.com core.email=jdoe@example.com core.report...

Updating the CLI

You can update the DC/OS CLI to the latest version or downgrade to an older version. Upgrade the CLI Important: If you downloaded the CLI from PyPI or from the DC/OS UI version 1.7...

Uninstalling the CLI

You can uninstall the CLI with these commands for your operating system. Unix, Linux, and macOS Windows Unix, Linux, and macOS Delete the hidden .dcos directory. This will delete t...

CLI Command Reference

dcos Description: The Mesosphere Datacenter Operating System (DC/OS) spans all of the machines in your datacenter or cloud and treats them as a single, shared set of resources. Usa...

Enterprise DC/OS CLI

Requirements A Mac OS X or Linux operating system. Windows is not currently supported. Installing the Enterprise DC/OS CLI Prerequisite: The DC/OS CLI must already be installed. Ti...