2016-11-09 20:49:09 -05:00
|
|
|
# plugin disable
|
2016-06-09 17:57:15 -04:00
|
|
|
|
2023-01-06 13:04:05 -05:00
|
|
|
<!---MARKER_GEN_START-->
|
2016-07-07 14:43:18 -04:00
|
|
|
Disable a plugin
|
2016-06-09 17:57:15 -04:00
|
|
|
|
2023-01-06 13:04:05 -05:00
|
|
|
### Options
|
|
|
|
|
2024-07-03 02:29:57 -04:00
|
|
|
| Name | Type | Default | Description |
|
|
|
|
|:----------------|:-------|:--------|:--------------------------------------|
|
|
|
|
| `-f`, `--force` | `bool` | | Force the disable of an active plugin |
|
2023-01-06 13:04:05 -05:00
|
|
|
|
|
|
|
|
|
|
|
<!---MARKER_GEN_END-->
|
2016-06-09 17:57:15 -04:00
|
|
|
|
2017-02-07 18:42:48 -05:00
|
|
|
## Description
|
|
|
|
|
2016-06-09 17:57:15 -04:00
|
|
|
Disables a plugin. The plugin must be installed before it can be disabled,
|
2016-12-20 11:26:58 -05:00
|
|
|
see [`docker plugin install`](plugin_install.md). Without the `-f` option,
|
2017-04-27 17:24:49 -04:00
|
|
|
a plugin that has references (e.g., volumes, networks) cannot be disabled.
|
2016-06-09 17:57:15 -04:00
|
|
|
|
2017-02-07 18:42:48 -05:00
|
|
|
## Examples
|
2016-06-09 17:57:15 -04:00
|
|
|
|
2016-12-14 03:35:34 -05:00
|
|
|
The following example shows that the `sample-volume-plugin` plugin is installed
|
2016-08-04 19:19:46 -04:00
|
|
|
and enabled:
|
2016-06-09 17:57:15 -04:00
|
|
|
|
2021-08-21 08:54:14 -04:00
|
|
|
```console
|
2016-06-09 17:57:15 -04:00
|
|
|
$ docker plugin ls
|
2016-07-20 17:37:55 -04:00
|
|
|
|
2020-06-18 10:37:36 -04:00
|
|
|
ID NAME DESCRIPTION ENABLED
|
|
|
|
69553ca1d123 tiborvass/sample-volume-plugin:latest A test plugin for Docker true
|
2016-06-09 17:57:15 -04:00
|
|
|
```
|
2016-07-20 17:37:55 -04:00
|
|
|
|
2016-06-09 17:57:15 -04:00
|
|
|
To disable the plugin, use the following command:
|
|
|
|
|
2021-08-21 08:54:14 -04:00
|
|
|
```console
|
2016-12-14 03:35:34 -05:00
|
|
|
$ docker plugin disable tiborvass/sample-volume-plugin
|
2016-07-20 17:37:55 -04:00
|
|
|
|
2016-12-14 03:35:34 -05:00
|
|
|
tiborvass/sample-volume-plugin
|
2016-06-09 17:57:15 -04:00
|
|
|
|
|
|
|
$ docker plugin ls
|
2016-07-20 17:37:55 -04:00
|
|
|
|
2020-06-18 10:37:36 -04:00
|
|
|
ID NAME DESCRIPTION ENABLED
|
|
|
|
69553ca1d123 tiborvass/sample-volume-plugin:latest A test plugin for Docker false
|
2016-06-09 17:57:15 -04:00
|
|
|
```
|
|
|
|
|
2017-02-07 18:42:48 -05:00
|
|
|
## Related commands
|
2016-06-09 17:57:15 -04:00
|
|
|
|
2016-10-04 15:01:19 -04:00
|
|
|
* [plugin create](plugin_create.md)
|
2016-06-09 17:57:15 -04:00
|
|
|
* [plugin enable](plugin_enable.md)
|
|
|
|
* [plugin inspect](plugin_inspect.md)
|
|
|
|
* [plugin install](plugin_install.md)
|
2016-11-14 11:38:06 -05:00
|
|
|
* [plugin ls](plugin_ls.md)
|
|
|
|
* [plugin push](plugin_push.md)
|
2016-06-09 17:57:15 -04:00
|
|
|
* [plugin rm](plugin_rm.md)
|
2016-10-31 20:07:05 -04:00
|
|
|
* [plugin set](plugin_set.md)
|
2017-01-28 19:54:32 -05:00
|
|
|
* [plugin upgrade](plugin_upgrade.md)
|