---
title: docker/ucp overview
description: Learn about the commands available in the docker/ucp image.
keywords: ucp, cli, ucp
---

>{% include enterprise_label_shortform.md %}

This image has commands to install and manage
Docker Universal Control Plane (UCP) on a Docker Engine.

You can configure the commands using flags or environment variables. When using
environment variables, use the `docker container run -e VARIABLE_NAME` syntax to pass the
value from your shell, or `docker container run -e VARIABLE_NAME=value` to specify the
value explicitly on the command line.

The container running this image needs to be named `ucp` and bind-mount the
Docker daemon socket. Below you can find an example of how to run this image.

Additional help is available for each command with the `--help` flag.

## Usage

```bash
docker container run -it --rm \
    --name ucp \
    -v /var/run/docker.sock:/var/run/docker.sock \
    docker/ucp \
    command [command arguments]
```

## Commands

| Option              | Description                                               |
|:--------------------|:----------------------------------------------------------|
| `backup`            | Create a backup of a UCP manager node                     |
| `dump-certs`        | Print the public certificates used by this UCP web server |
| `example-config`    | Display an example configuration file for UCP             |
| `help`              | Shows a list of commands or help for one command          |
| `id`                | Print the ID of UCP running on this node                  |
| `images`            | Verify the UCP images on this node                        |
| `install`           | Install UCP on this node                                  |
| `port-check-server` | Checks the ports on a node before a UCP installation      |
| `restart`           | Start or restart UCP components running on this node      |
| `restore`           | Restore a UCP cluster from a backup                       |
| `stop`              | Stop UCP components running on this node                  |
| `support`           | Create a support dump for this UCP node                   |
| `uninstall-ucp`     | Uninstall UCP from this swarm                             |
| `upgrade`           | Upgrade the UCP cluster                                   |