docker.models.plugins.Plugin

class documentation

class Plugin(Model): (source)

View In Hierarchy

A plugin on the server.

Method __repr__ Undocumented
Method configure Update the plugin's settings.
Method disable Disable the plugin.
Method enable Enable the plugin.
Method push Push the plugin to a remote registry.
Method remove Remove the plugin from the server.
Method upgrade Upgrade the plugin.
Property enabled Whether the plugin is enabled.
Property name The plugin's name.
Property settings A dictionary representing the plugin's configuration.

Inherited from Model:

Method __eq__ Undocumented
Method __hash__ Undocumented
Method __init__ Undocumented
Method reload Load this object from the server again and update ``attrs`` with the new data.
Class Variable id_attribute Undocumented
Instance Variable attrs Undocumented
Instance Variable client Undocumented
Instance Variable collection Undocumented
Property id The ID of the object.
Property short_id The ID of the object, truncated to 12 characters.
def __repr__(self): (source)
overrides docker.models.resource.Model.__repr__

Undocumented

def configure(self, options): (source)

Update the plugin's settings. Args: options (dict): A key-value mapping of options. Raises: :py:class:`docker.errors.APIError` If the server returns an error.

def disable(self, force=False): (source)

Disable the plugin. Args: force (bool): Force disable. Default: False Raises: :py:class:`docker.errors.APIError` If the server returns an error.

def enable(self, timeout=0): (source)

Enable the plugin. Args: timeout (int): Timeout in seconds. Default: 0 Raises: :py:class:`docker.errors.APIError` If the server returns an error.

def push(self): (source)

Push the plugin to a remote registry. Returns: A dict iterator streaming the status of the upload. Raises: :py:class:`docker.errors.APIError` If the server returns an error.

def remove(self, force=False): (source)

Remove the plugin from the server. Args: force (bool): Remove even if the plugin is enabled. Default: False Raises: :py:class:`docker.errors.APIError` If the server returns an error.

def upgrade(self, remote=None): (source)

Upgrade the plugin. Args: 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

@property
enabled = (source)

Whether the plugin is enabled.

@property
name = (source)

The plugin's name.

@property
settings = (source)

A dictionary representing the plugin's configuration.