Plugins¶
Manage plugins on the server.
Methods available on client.plugins
:
Plugin objects¶
-
class
Plugin
¶ A plugin on the server.
-
id
¶ The ID of the object.
-
short_id
¶ The ID of the object, truncated to 10 characters.
-
name
¶ The plugin’s name.
-
enabled
¶ Whether the plugin is enabled.
-
settings
¶ A dictionary representing the plugin’s configuration.
-
attrs
¶ The raw representation of this object from the server.
-
configure
(options)¶ Update the plugin’s settings.
Parameters: options (dict) – A key-value mapping of options. Raises: docker.errors.APIError
– If the server returns an error.
-
disable
()¶ Disable the plugin.
Raises: docker.errors.APIError
– If the server returns an error.
-
enable
(timeout=0)¶ Enable the plugin.
Parameters: timeout (int) – Timeout in seconds. Default: 0 Raises: docker.errors.APIError
– If the server returns an error.
-
reload
()¶ Load this object from the server again and update
attrs
with the new data.
-
push
()¶ Push the plugin to a remote registry.
Returns: A dict iterator streaming the status of the upload. Raises: docker.errors.APIError
– If the server returns an error.
-
remove
(force=False)¶ Remove the plugin from the server.
Parameters: force (bool) – Remove even if the plugin is enabled. Default: False Raises: docker.errors.APIError
– If the server returns an error.
-
upgrade
(remote=None)¶ Upgrade the plugin.
Parameters: remote (string) – Remote reference to upgrade to. The :latest
tag is optional and is the default if omitted. Default: this plugin’s name.Returns: A generator streaming the decoded API logs
-