View Source DockerEngineAPI.Api.Plugin (docker_engine_api v1.43.0)

API calls for all endpoints tagged Plugin.

Summary

Functions

List plugins Returns information about installed plugins.

Install a plugin Pulls and installs a plugin. After the plugin is installed, it can be enabled using the `POST /plugins/{name}/enable` endpoint.

Push a plugin Push a plugin to the registry.

Functions

Link to this function

get_plugin_privileges(connection, remote, opts \\ [])

View Source

Get plugin privileges

Parameters

  • connection (DockerEngineAPI.Connection): Connection to server
  • remote (String.t): The name of the plugin. The `:latest` tag is optional, and is the default if omitted.
  • opts (KeywordList): [optional] Optional parameters

Returns

, ...]} on success {:error, info} on failure

Link to this function

plugin_create(connection, name, opts \\ [])

View Source

Create a plugin

Parameters

  • connection (DockerEngineAPI.Connection): Connection to server
  • name (String.t): The name of the plugin. The `:latest` tag is optional, and is the default if omitted.
  • opts (KeywordList): [optional] Optional parameters
    • :tar_context (binary()): Path to tar containing plugin rootfs and manifest

Returns

} on success {:error, info} on failure

Link to this function

plugin_delete(connection, name, opts \\ [])

View Source

Remove a plugin

Parameters

  • connection (DockerEngineAPI.Connection): Connection to server
  • name (String.t): The name of the plugin. The `:latest` tag is optional, and is the default if omitted.
  • opts (KeywordList): [optional] Optional parameters
    • :force (boolean()): Disable the plugin before removing. This may result in issues if the plugin is in use by a container.

Returns

} on success {:error, info} on failure

Link to this function

plugin_disable(connection, name, opts \\ [])

View Source

Disable a plugin

Parameters

  • connection (DockerEngineAPI.Connection): Connection to server
  • name (String.t): The name of the plugin. The `:latest` tag is optional, and is the default if omitted.
  • opts (KeywordList): [optional] Optional parameters
    • :force (boolean()): Force disable a plugin even if still in use.

Returns

} on success {:error, info} on failure

Link to this function

plugin_enable(connection, name, opts \\ [])

View Source

Enable a plugin

Parameters

  • connection (DockerEngineAPI.Connection): Connection to server
  • name (String.t): The name of the plugin. The `:latest` tag is optional, and is the default if omitted.
  • opts (KeywordList): [optional] Optional parameters
    • :timeout (integer()): Set the HTTP client timeout (in seconds)

Returns

} on success {:error, info} on failure

Link to this function

plugin_inspect(connection, name, opts \\ [])

View Source

Inspect a plugin

Parameters

  • connection (DockerEngineAPI.Connection): Connection to server
  • name (String.t): The name of the plugin. The `:latest` tag is optional, and is the default if omitted.
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

plugin_list(connection, opts \\ [])

View Source

List plugins Returns information about installed plugins.

Parameters

  • connection (DockerEngineAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters
    • :filters (String.t): A JSON encoded value of the filters (a `map[string][]string`) to process on the plugin list. Available filters: - `capability=<capability name>` - `enable=<true>|<false>`

Returns

, ...]} on success {:error, info} on failure

Link to this function

plugin_pull(connection, remote, opts \\ [])

View Source

Install a plugin Pulls and installs a plugin. After the plugin is installed, it can be enabled using the `POST /plugins/{name}/enable` endpoint.

Parameters

  • connection (DockerEngineAPI.Connection): Connection to server
  • remote (String.t): Remote reference for plugin to install. The `:latest` tag is optional, and is used as the default if omitted.
  • opts (KeywordList): [optional] Optional parameters
    • :name (String.t): Local name for the pulled plugin. The `:latest` tag is optional, and is used as the default if omitted.
    • :x_registry_auth (String.t): A base64url-encoded auth configuration to use when pulling a plugin from a registry. Refer to the authentication section for details.
    • :body ([PluginPrivilege]):

Returns

} on success {:error, info} on failure

Link to this function

plugin_push(connection, name, opts \\ [])

View Source

Push a plugin Push a plugin to the registry.

Parameters

  • connection (DockerEngineAPI.Connection): Connection to server
  • name (String.t): The name of the plugin. The `:latest` tag is optional, and is the default if omitted.
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

plugin_set(connection, name, opts \\ [])

View Source

Configure a plugin

Parameters

  • connection (DockerEngineAPI.Connection): Connection to server
  • name (String.t): The name of the plugin. The `:latest` tag is optional, and is the default if omitted.
  • opts (KeywordList): [optional] Optional parameters
    • :body ([String.t]):

Returns

} on success {:error, info} on failure

Link to this function

plugin_upgrade(connection, name, remote, opts \\ [])

View Source

Upgrade a plugin

Parameters

  • connection (DockerEngineAPI.Connection): Connection to server
  • name (String.t): The name of the plugin. The `:latest` tag is optional, and is the default if omitted.
  • remote (String.t): Remote reference to upgrade to. The `:latest` tag is optional, and is used as the default if omitted.
  • opts (KeywordList): [optional] Optional parameters
    • :x_registry_auth (String.t): A base64url-encoded auth configuration to use when pulling a plugin from a registry. Refer to the authentication section for details.
    • :body ([PluginPrivilege]):

Returns

} on success {:error, info} on failure