github.com/fabiokung/docker@v0.11.2-0.20170222101415-4534dcd49497/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  ## Description
    28  
    29  Change settings for a plugin. The plugin must be disabled.
    30  
    31  The settings currently supported are:
    32   * env variables
    33   * source of mounts
    34   * path of devices
    35   * args
    36  
    37  ## Examples
    38  
    39  ### Change an environment variable
    40  
    41  The following example change the env variable `DEBUG` on the
    42  `sample-volume-plugin` plugin.
    43  
    44  ```bash
    45  {% raw %}
    46  $ docker plugin inspect -f {{.Settings.Env}} tiborvass/sample-volume-plugin
    47  
    48  [DEBUG=0]
    49  
    50  $ docker plugin set tiborvass/sample-volume-plugin DEBUG=1
    51  
    52  $ docker plugin inspect -f {{.Settings.Env}} tiborvass/sample-volume-plugin
    53  [DEBUG=1]
    54  {% endraw %}
    55  ```
    56  
    57  ### Change the source of a mount
    58  
    59  The following example change the source of the `mymount` mount on
    60  the `myplugin` plugin.
    61  
    62  ```bash
    63  {% raw %}
    64  $ docker plugin inspect -f '{{with $mount := index .Settings.Mounts 0}}{{$mount.Source}}{{end}}' myplugin
    65  /foo
    66  
    67  $ docker plugins set myplugin mymount.source=/bar
    68  
    69  $ docker plugin inspect -f '{{with $mount := index .Settings.Mounts 0}}{{$mount.Source}}{{end}}' myplugin
    70  /bar
    71  {% endraw %}
    72  ```
    73  
    74  > **Note**: Since only `source` is settable in `mymount`,
    75  > `docker plugins set mymount=/bar myplugin` would work too.
    76  
    77  ### Change a device path
    78  
    79  The following example change the path of the `mydevice` device on
    80  the `myplugin` plugin.
    81  
    82  ```bash
    83  {% raw %}
    84  $ docker plugin inspect -f '{{with $device := index .Settings.Devices 0}}{{$device.Path}}{{end}}' myplugin
    85  /dev/foo
    86  
    87  $ docker plugins set myplugin mydevice.path=/dev/bar
    88  
    89  $ docker plugin inspect -f '{{with $device := index .Settings.Devices 0}}{{$device.Path}}{{end}}' myplugin
    90  /dev/bar
    91  {% endraw %}
    92  ```
    93  
    94  > **Note**: Since only `path` is settable in `mydevice`,
    95  > `docker plugins set mydevice=/dev/bar myplugin` would work too.
    96  
    97  ### Change the source of the arguments
    98  
    99  The following example change the source of the args on the `myplugin` plugin.
   100  
   101  ```bash
   102  {% raw %}
   103  $ docker plugin inspect -f '{{.Settings.Args}}' myplugin
   104  ["foo", "bar"]
   105  
   106  $ docker plugins set myplugin args="foo bar baz"
   107  
   108  $ docker plugin inspect -f '{{.Settings.Args}}' myplugin
   109  ["foo", "bar", "baz"]
   110  {% endraw %}
   111  ```
   112  
   113  ## Related commands
   114  
   115  * [plugin create](plugin_create.md)
   116  * [plugin disable](plugin_disable.md)
   117  * [plugin enable](plugin_enable.md)
   118  * [plugin inspect](plugin_inspect.md)
   119  * [plugin install](plugin_install.md)
   120  * [plugin ls](plugin_ls.md)
   121  * [plugin push](plugin_push.md)
   122  * [plugin rm](plugin_rm.md)