mirror of
https://github.com/docker/cli.git
synced 2025-09-02 10:21:16 +03:00
02677bc06e
This allows a plugin to be upgraded without requiring to uninstall/reinstall a plugin. Since plugin resources (e.g. volumes) are tied to a plugin ID, this is important to ensure resources aren't lost. The plugin must be disabled while upgrading (errors out if enabled). This does not add any convenience flags for automatically disabling/re-enabling the plugin during before/after upgrade. Since an upgrade may change requested permissions, the user is required to accept permissions just like `docker plugin install`. Signed-off-by: Brian Goff <cpuguy83@gmail.com>
67 lines
2.0 KiB
Markdown
67 lines
2.0 KiB
Markdown
---
|
|
title: "plugin disable"
|
|
description: "the plugin disable command description and usage"
|
|
keywords: "plugin, disable"
|
|
---
|
|
|
|
<!-- This file is maintained within the docker/docker Github
|
|
repository at https://github.com/docker/docker/. Make all
|
|
pull requests against that repo. If you see this file in
|
|
another repository, consider it read-only there, as it will
|
|
periodically be overwritten by the definitive file. Pull
|
|
requests which include edits to this file in other repositories
|
|
will be rejected.
|
|
-->
|
|
|
|
# plugin disable
|
|
|
|
```markdown
|
|
Usage: docker plugin disable [OPTIONS] PLUGIN
|
|
|
|
Disable a plugin
|
|
|
|
Options:
|
|
-f, --force Force the disable of an active plugin
|
|
--help Print usage
|
|
```
|
|
|
|
Disables a plugin. The plugin must be installed before it can be disabled,
|
|
see [`docker plugin install`](plugin_install.md). Without the `-f` option,
|
|
a plugin that has references (eg, volumes, networks) cannot be disabled.
|
|
|
|
|
|
The following example shows that the `sample-volume-plugin` plugin is installed
|
|
and enabled:
|
|
|
|
```bash
|
|
$ docker plugin ls
|
|
|
|
ID NAME TAG DESCRIPTION ENABLED
|
|
69553ca1d123 tiborvass/sample-volume-plugin latest A test plugin for Docker true
|
|
```
|
|
|
|
To disable the plugin, use the following command:
|
|
|
|
```bash
|
|
$ docker plugin disable tiborvass/sample-volume-plugin
|
|
|
|
tiborvass/sample-volume-plugin
|
|
|
|
$ docker plugin ls
|
|
|
|
ID NAME TAG DESCRIPTION ENABLED
|
|
69553ca1d123 tiborvass/sample-volume-plugin latest A test plugin for Docker false
|
|
```
|
|
|
|
## Related information
|
|
|
|
* [plugin create](plugin_create.md)
|
|
* [plugin enable](plugin_enable.md)
|
|
* [plugin inspect](plugin_inspect.md)
|
|
* [plugin install](plugin_install.md)
|
|
* [plugin ls](plugin_ls.md)
|
|
* [plugin push](plugin_push.md)
|
|
* [plugin rm](plugin_rm.md)
|
|
* [plugin set](plugin_set.md)
|
|
* [plugin upgrade](plugin_upgrade.md)
|