docs/data/engine-cli/docker_plugin_disable.yaml

64 lines
1.8 KiB
YAML

command: docker plugin disable
short: Disable a plugin
long: |-
Disables a plugin. The plugin must be installed before it can be disabled,
see [`docker plugin install`](/reference/cli/docker/plugin/install/). Without the `-f` option,
a plugin that has references (e.g., volumes, networks) cannot be disabled.
usage: docker plugin disable [OPTIONS] PLUGIN
pname: docker plugin
plink: docker_plugin.yaml
options:
- option: force
shorthand: f
value_type: bool
default_value: "false"
description: Force the disable of an active plugin
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: help
value_type: bool
default_value: "false"
description: Print usage
deprecated: false
hidden: true
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
The following example shows that the `sample-volume-plugin` plugin is installed
and enabled:
```console
$ docker plugin ls
ID NAME DESCRIPTION ENABLED
69553ca1d123 tiborvass/sample-volume-plugin:latest A test plugin for Docker true
```
To disable the plugin, use the following command:
```console
$ docker plugin disable tiborvass/sample-volume-plugin
tiborvass/sample-volume-plugin
$ docker plugin ls
ID NAME DESCRIPTION ENABLED
69553ca1d123 tiborvass/sample-volume-plugin:latest A test plugin for Docker false
```
deprecated: false
hidden: false
min_api_version: "1.25"
experimental: false
experimentalcli: false
kubernetes: false
swarm: false