github.com/flavio/docker@v0.1.3-0.20170117145210-f63d1a6eec47/docs/reference/commandline/plugin_set.md (about)

     1  ---
     2  title: "plugin set"
     3  description: "the plugin set command description and usage"
     4  keywords: "plugin, set"
     5  ---
     6  
     7  <!-- This file is maintained within the docker/docker Github
     8       repository at https://github.com/docker/docker/. Make all
     9       pull requests against that repo. If you see this file in
    10       another repository, consider it read-only there, as it will
    11       periodically be overwritten by the definitive file. Pull
    12       requests which include edits to this file in other repositories
    13       will be rejected.
    14  -->
    15  
    16  # plugin set
    17  
    18  ```markdown
    19  Usage:  docker plugin set PLUGIN KEY=VALUE [KEY=VALUE...]
    20  
    21  Change settings for a plugin
    22  
    23  Options:
    24        --help                    Print usage
    25  ```
    26  
    27  Change settings for a plugin. The plugin must be disabled.
    28  
    29  The settings currently supported are:
    30   * env variables
    31   * source of mounts
    32   * path of devices
    33   * args
    34  
    35  The following example change the env variable `DEBUG` on the
    36  `sample-volume-plugin` plugin.
    37  
    38  ```bash
    39  $ docker plugin inspect -f {{.Settings.Env}} tiborvass/sample-volume-plugin
    40  [DEBUG=0]
    41  
    42  $ docker plugin set tiborvass/sample-volume-plugin DEBUG=1
    43  
    44  $ docker plugin inspect -f {{.Settings.Env}} tiborvass/sample-volume-plugin
    45  [DEBUG=1]
    46  ```
    47  
    48  The following example change the source of the `mymount` mount on
    49  the `myplugin` plugin.
    50  
    51  ```bash
    52  $ docker plugin inspect -f '{{with $mount := index .Settings.Mounts 0}}{{$mount.Source}}{{end}}' myplugin
    53  /foo
    54  
    55  $ docker plugins set myplugin mymount.source=/bar
    56  
    57  $ docker plugin inspect -f '{{with $mount := index .Settings.Mounts 0}}{{$mount.Source}}{{end}}' myplugin
    58  /bar
    59  ```
    60  
    61  Note: since only `source` is settable in `mymount`, `docker plugins set mymount=/bar myplugin` would work too.
    62  
    63  The following example change the path of the `mydevice` device on
    64  the `myplugin` plugin.
    65  
    66  ```bash
    67  $ docker plugin inspect -f '{{with $device := index .Settings.Devices 0}}{{$device.Path}}{{end}}' myplugin
    68  /dev/foo
    69  
    70  $ docker plugins set myplugin mydevice.path=/dev/bar
    71  
    72  $ docker plugin inspect -f '{{with $device := index .Settings.Devices 0}}{{$device.Path}}{{end}}' myplugin
    73  /dev/bar
    74  ```
    75  
    76  Note: since only `path` is settable in `mydevice`, `docker plugins set mydevice=/dev/bar myplugin` would work too.
    77  
    78  The following example change the source of the args on the `myplugin` plugin.
    79  
    80  ```bash
    81  $ docker plugin inspect -f '{{.Settings.Args}}' myplugin
    82  ["foo", "bar"]
    83  
    84  $ docker plugins set myplugin args="foo bar baz"
    85  
    86  $ docker plugin inspect -f '{{.Settings.Args}}' myplugin
    87  ["foo", "bar", "baz"]
    88  ```
    89  
    90  ## Related information
    91  
    92  * [plugin create](plugin_create.md)
    93  * [plugin disable](plugin_disable.md)
    94  * [plugin enable](plugin_enable.md)
    95  * [plugin inspect](plugin_inspect.md)
    96  * [plugin install](plugin_install.md)
    97  * [plugin ls](plugin_ls.md)
    98  * [plugin push](plugin_push.md)
    99  * [plugin rm](plugin_rm.md)