D2IQD2IQ
D2iQDC/OS Documentation
  • DC/OS
  • Services
  • Support
Ksphere
  • Konvoy
  • Partner Solutions
English
  • 中文 (简体)
  • Ksphere
  • Konvoy
  • Partner Solutions
  • Mesosphere
  • DC/OS
  • DC/OS Services
  • Support
  • Mesosphere DC/OS 1.13
  • Mesosphere DC/OS 2.0
  • Mesosphere DC/OS 1.12
  • Mesosphere DC/OS 1.11
  • Mesosphere DC/OS 1.10
  • Mesosphere DC/OS 1.9

DC/OS 1.12

  • Release Notes
    • Release Notes for 1.12.4
    • Release Notes for 1.12.3
    • Release Notes for 1.12.2
    • Release Notes for 1.12.1
    • Release Notes for 1.12.0
    • Open Source Attribution
    • Versioning and Release Policy
  • Overview
    • What is DC/OS
    • Architecture
      • Node Types
      • Task Types
      • Components
      • Distributed Process Management
      • Boot Sequence
    • Features
    • Concepts
    • High Availability
    • Telemetry
    • Design
      • Authentication Architecture
      • ACS
      • Distributed DNS
      • Installation
      • Overlay
    • Feature Maturity
  • Installing
    • Cloud Installation
      • AWS
        • AWS Multi-Region Support
        • AWS Replaceable Masters
        • Configuration Reference
        • Universal Installer FAQ
      • Azure
        • Azure Multi-Region Support
        • Configuration Reference
      • GCP
        • GCP Multi-Region Support
        • Configuration Reference
      • Other Installation methods
        • AWS
          • Basic
          • Advanced
            • Template Reference
          • Uninstalling
        • Azure
        • DigitalOcean
        • Packet
    • On-Prem Installation
      • Virtual Infrastructure
      • System Requirements
        • Docker on CentOS/RHEL
        • Ports
        • Custom AMI
        • Azure
      • Deploying DC/OS
        • Configuration
          • Examples
        • Production Installation
        • Opt-Out
        • Node and Cluster Health Checks
      • Advanced Configuration
        • Configuration Reference
        • Configuring GPU nodes
        • Configuring Zones and Regions
          • Multiple Zones
          • Multiple Regions
      • DC/OS with Ansible
        • Ansible Quickstart
        • DC/OS Ansible FAQ
      • Patching
      • Upgrading
      • Uninstalling
    • Frequently Asked Questions
    • Troubleshooting
  • GUI
    • Dashboard
    • Services
    • Jobs
    • Catalog
    • Nodes
    • Networking
    • Secrets
    • Cluster
    • Components
    • Settings
    • Organization
  • CLI
    • Installing the CLI
    • Configuring the CLI
    • Updating the CLI
    • Uninstalling the CLI
    • CLI Plugins
    • DC/OS Enterprise CLI
    • Experiments
    • CLI Autocompletion
    • Command Reference
      • dcos
      • dcos auth
        • dcos auth list-providers
        • dcos auth login
        • dcos auth logout
      • dcos backup
        • dcos backup create
        • dcos backup delete
        • dcos backup list
        • dcos backup restore
        • dcos backup show
      • dcos cluster
        • dcos cluster attach
        • dcos cluster link
        • dcos cluster list
        • dcos cluster unlink
        • dcos cluster remove
        • dcos cluster rename
        • dcos cluster setup
      • dcos config
        • dcos config set
        • dcos config show
        • dcos config unset
      • dcos help
      • dcos job
        • dcos job add
        • dcos job history
        • dcos job kill
        • dcos job list
        • dcos job remove
        • dcos job run
        • dcos job schedule add
        • dcos job schedule remove
        • dcos job schedule show
        • dcos job schedule update
        • dcos job show
        • dcos job show runs
        • dcos job update
      • dcos license
        • dcos license audit
        • dcos license get
        • dcos license list
        • dcos license renew
        • dcos license status
      • dcos marathon
        • dcos marathon about
        • dcos marathon app add
        • dcos marathon app kill
        • dcos marathon app list
        • dcos marathon app remove
        • dcos marathon app restart
        • dcos marathon app show
        • dcos marathon app start
        • dcos marathon app stop
        • dcos marathon app update
        • dcos marathon app version list
        • dcos marathon debug details
        • dcos marathon debug list
        • dcos marathon debug summary
        • dcos marathon deployment list
        • dcos marathon deployment rollback
        • dcos marathon deployment stop
        • dcos marathon deployment watch
        • dcos marathon group add
        • dcos marathon group list
        • dcos marathon group remove
        • dcos marathon group scale
        • dcos marathon group show
        • dcos marathon group update
        • dcos marathon pod add
        • dcos marathon pod kill
        • dcos marathon pod list
        • dcos marathon pod remove
        • dcos marathon pod show
        • dcos marathon pod update
        • dcos marathon task list
        • dcos marathon task show
        • dcos marathon task stop
      • dcos node
        • dcos node decommission
        • dcos node diagnostics
        • dcos node diagnostics create
        • dcos node diagnostics delete
        • dcos node diagnostics download
        • dcos node dns
        • dcos node list-components
        • dcos node log
        • dcos node metrics details
        • dcos node metrics summary
        • dcos node ssh
      • dcos package
        • dcos package describe
        • dcos package install
        • dcos package list
        • dcos package repo add
        • dcos package repo import
        • dcos package repo list
        • dcos package search
        • dcos package uninstall
        • dcos package repo remove
      • dcos plugin
        • dcos plugin add
        • dcos plugin list
        • dcos plugin remove
      • dcos security
        • dcos security cluster
          • dcos security cluster ca
            • dcos security cluster ca newcert
            • dcos security cluster ca cacert
            • dcos security cluster ca newkey
            • dcos security cluster ca profile
            • dcos security cluster ca sign
          • dcos security cluster oidc
            • dcos security cluster oidc add
            • dcos security cluster oidc delete
            • cos security cluster oidc modify
            • dcos security cluster oidc show
          • dcos security cluster directory
            • dcos security cluster directory get_config
            • dcos security cluster directory import_group
            • dcos security cluster directory import_user
            • dcos security cluster directory test
          • dcos security cluster saml
            • dcos security cluster saml delete
            • dcos security cluster saml add
            • dcos security cluster saml modify
            • dcos security cluster saml show
          • dcos security cluster secret-store
            • dcos security cluster secret-store seal-status
            • dcos security cluster secret-store show
            • dcos security cluster secret-store status
            • dcos security cluster secret-store unseal
        • dcos security org
          • dcos security org groups
            • dcos security org groups add_user
            • dcos security org groups create
            • dcos security org groups del_user
            • dcos security org groups delete
            • dcos security org groups members
            • dcos security org groups revoke
            • dcos security org groups show
            • dcos security org groups show
          • dcos security org service-accounts
            • dcos security org service-accounts create
            • dcos security org service-accounts delete
            • dcos security org service-accounts keypair
            • dcos security org service-accounts show
          • dcos security org users
            • dcos security org users create
            • dcos security org users delete
            • dcos security org users grant
            • dcos security org users revoke
            • dcos security org users show
        • dcos security secrets
          • dcos security secrets create
          • dcos security secrets create-sa-secret
          • dcos security secrets delete
          • dcos security secrets get
          • dcos security secrets list
          • dcos security secrets update
      • dcos service
        • dcos service log
        • dcos service shutdown
      • dcos task
        • dcos task attach
        • dcos task exec
        • dcos task log
        • dcos task ls
        • dcos task metrics details
        • dcos task metrics summary
  • Administering Clusters
    • SSHing into Nodes
    • Finding a Public Agent IP
    • Multiple Clusters
      • Cluster Connections
      • Cluster Link API
      • Cluster Links
    • Component Management
    • Backup and Restore
      • Backup and Restore CLI
      • Backup and Restore API
    • Securing a cluster
    • Managing AWS
    • Managing Package Repositories
      • Package Registry
        • Getting Started with Package Registry
        • Operating Package Registry
          • Planning
          • Installing
          • Managing
    • Converting Agent Node Types
    • Adding Agent Nodes
    • Replace a master node
    • Updating Nodes
    • Shut Down and Decommission Nodes
    • Recovering Agent Disk Space
    • Deploying a Local Universe
    • Licenses
      • License CLI
      • License API
  • Networking
    • Load Balancing and Virtual IPs (VIPs)
      • Using Virtual IP Addresses
    • Software Defined Networks
      • DC/OS Overlay
      • Using SDNs
      • CNI Plugin Support
    • DNS
      • Mesos-DNS
        • Service Naming
        • Mesos DNS API
        • Exposing Mesos Zones Outside
        • Troubleshooting
  • Security
    • DC/OS Enterprise Security
      • Managing users and groups
        • Adding local users
        • Adding external users
        • Resetting the Superuser
        • Overriding the default Linux user
      • Granting Access to the GUI
        • Granting Access to the Services Tab
        • Granting Access to the Jobs Screen
        • Granting Access to the Mesos UI
        • Granting Access to the Marathon UI
        • Granting Access to the Networking Tab
        • Granting Access to the Secrets Tab
        • Granting Access to the Components Screen
        • Granting Access to the Settings and Organization tabs
        • Granting Access to the Catalog Screen
      • Permissions Management
      • Permissions Reference
      • LDAP authentication
        • Configuration
        • Specifying Authentication and Parameters
        • Verification
        • Synchronization
      • Secrets
        • Creating secrets
        • Configuring services and pods
        • Sealing the Secret Store
        • Unsealing the Secret Store
        • Secrets API
      • Identity provider-based authentication
        • Configuring a SAML IdP
        • Configuring an OpenID Connect IdP
      • Service Authentication
        • Authenticating DC/OS Services
        • Managing JSON Web Tokens
      • Restricting Access to DC/OS Service Groups
      • Hardening
      • Identity and Access Management API
      • Securing Communication with TLS
        • Configuring HAProxy in Front of Admin Router
        • Configuring a Custom CA Certificate
        • Obtaining the DC/OS CA bundle
        • Establishing trust in your DC/OS CA
        • Establishing trust in your CLI
        • Establishing trust in your curl commands
        • Securing Exhibitor with mutual TLS
        • Using the Certificate Authority API
    • DC/OS Open Source Security
      • User Access Management
      • Managing Authentication
        • Troubleshooting Authentication
        • HTTP API Endpoint Authentication
      • HAProxy and Admin Router
  • Storage
    • Mount Disk Resources
    • NFS Server
    • Local Persistent Volumes
    • External Persistent Volumes
  • Metrics
    • Metrics Plugin Architecture
    • Quick Start
    • Enable Mesos Metrics
    • Export DC/OS Metrics to Datadog
    • Export DC/OS Metrics to Prometheus
    • Metrics API
    • Metrics Reference
  • Monitoring, Logging, and Debugging
    • Performance Monitoring
      • Monitoring with Nagios
    • Logging
      • Quick Start
      • Accessing system and component logs
      • Configuring Task Log Output and Retention
      • Controlling Access to Task Logs
      • Log Aggregation
        • Log Management with ELK
        • Filtering Logs with ELK
        • Log Management with Splunk
        • Filtering Logs with Splunk
      • Logging API
      • Logging API Examples
    • Debugging
      • Debugging from the DC/OS Web Interface
      • Granting Access to dcos task exec
      • Debugging from the DC/OS CLI
      • Using dcos task exec
      • Stuck Deployments
      • Slow Docker Apps and Deployments
  • Hybrid Cloud
    • Cluster Links
    • Fault Domain Awareness with Zones
    • Capacity Extensions with Regions
    • Decommission Nodes
  • Deploying Jobs
    • Metronome Placement Constraints
    • Running Jobs in Remote Regions
    • Creating Jobs
    • Examples
    • Granting Access to Jobs
  • Deploying Services and Pods
    • Installing Services
    • Marathon Configuration Reference
    • Creating Services
      • Deploying a Docker-based Service
      • Health Checks
    • Task Handling
      • Configure Task Handling
    • Configuring Universe Services
    • Fault Domain Awareness and Capacity Extension
    • Granting Access to Services and Groups
    • Marathon Placement Constraints
    • Monitoring Services
    • Scaling a Service
    • Service Endpoints
    • Service Ports
    • Updating a User-Created Service
    • Using a Private Docker Registry
    • Deployments
    • Exposing a Service
    • Uninstalling Services
    • Package Management API
    • Using Custom Marathon
      • Deploying Services Using a Custom Marathon Instance
      • Deploying Services using a Custom Marathon with Security Features
    • Marathon API
    • Using Containerizers
      • Universal Container Runtime (UCR)
      • Docker Engine
    • Pods
      • Quick Start
      • Technical Overview
      • Using Pods
      • Pod Examples
    • Multi-Tenancy Primitives
    • Using GPUs
    • Frequently Asked Questions
  • Tutorials
    • DC/OS 101
      • First Steps
      • Installing the First Package
      • Deploying First Application
      • Service Discovery
      • Native Applications
      • Exposing Apps Publicly
      • Understanding Resources
      • Load-Balancing
    • Creating and Running a Service
    • Running Stateful Services on DC/OS
    • Autoscaling with Marathon
      • Autoscaling Marathon services using CPU and memory
      • Understanding Autoscaling
      • Microscaling
    • Deploying a Load-Balanced Data Pipeline
    • Deploying Marathon Apps with Jenkins
    • Labeling Tasks and Jobs
    • Debugging Applications on DC/OS
      • Problems
      • Tools
      • Strategy
      • Practice Deployment Debugging Scenarios on DC/OS
        • Scenario 1
        • Scenario 2
        • Scenario 3
  • API Reference
    • Cluster Access
    • API Versioning
    • Master Routes
    • Agent Routes
  • Developing DC/OS Services
    • CLI Specification
    • Using a DC/OS Tunnel
Terms of ServicePrivacy Policy
© 2019 D2iQ, Inc. All rights reserved.

dcos cluster

Managing connections to DC/OS clusters

  • Share
  • Print
  • Contribute
  • Discuss
  • Feedback

Description

The dcos cluster command lets you manage your DC/OS clusters.

Usage

dcos cluster [command]

Options

Name Description
--help, h Display usage.

Commands

dcos cluster attach

Attaching the CLI to a connected or linked cluster…Read More

dcos cluster link

ENTERPRISE

Linking a connected cluster to another cluster…Read More

dcos cluster list

Listing connected clusters…Read More

dcos cluster unlink

ENTERPRISE

Unlinking a cluster from another cluster…Read More

dcos cluster remove

Removing a connected cluster from the DC/OS CLI…Read More

dcos cluster rename

Renaming a cluster…Read More

dcos cluster setup

Configuring the CLI to communicate with a cluster…Read More

  • Description
  • Usage
  • Options
  • Commands