DockerEngineAPI.Api.Plugin (elixir_dea v1.45.7)

@spec get_plugin_privileges(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, [DockerEngineAPI.Model.PluginPrivilege.t()]}
  | {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:error, Tesla.Env.t()}

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 (keyword): Optional parameters

Returns

{:ok, [%PluginPrivilege{}, ...]} on success
{:error, Tesla.Env.t} on failure

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

@spec plugin_create(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil}
  | {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:error, Tesla.Env.t()}

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 (keyword): Optional parameters
- :body (String.t): Path to tar containing plugin rootfs and manifest

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

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

@spec plugin_delete(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DockerEngineAPI.Model.Plugin.t()}
  | {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:error, Tesla.Env.t()}

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 (keyword): Optional parameters
- :force (boolean()): Disable the plugin before removing. This may result in issues if the plugin is in use by a container.

Returns

{:ok, DockerEngineAPI.Model.Plugin.t} on success
{:error, Tesla.Env.t} on failure

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

@spec plugin_disable(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil}
  | {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:error, Tesla.Env.t()}

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 (keyword): Optional parameters
- :force (boolean()): Force disable a plugin even if still in use.

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

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

@spec plugin_enable(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil}
  | {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:error, Tesla.Env.t()}

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 (keyword): Optional parameters
- :timeout (integer()): Set the HTTP client timeout (in seconds)

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

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

@spec plugin_inspect(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DockerEngineAPI.Model.Plugin.t()}
  | {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:error, Tesla.Env.t()}

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 (keyword): Optional parameters

Returns

{:ok, DockerEngineAPI.Model.Plugin.t} on success
{:error, Tesla.Env.t} on failure

plugin_list(connection, opts \\ [])

@spec plugin_list(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:ok, [DockerEngineAPI.Model.Plugin.t()]}
  | {:error, Tesla.Env.t()}

List plugins Returns information about installed plugins.

Parameters

connection (DockerEngineAPI.Connection): Connection to server
opts (keyword): 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

{:ok, [%Plugin{}, ...]} on success
{:error, Tesla.Env.t} on failure

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

@spec plugin_pull(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil}
  | {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:error, Tesla.Env.t()}

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 (keyword): 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 ([DockerEngineAPI.Model.PluginPrivilege.t]):

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

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

@spec plugin_push(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil}
  | {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:error, Tesla.Env.t()}

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 (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

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

@spec plugin_set(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil}
  | {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:error, Tesla.Env.t()}

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 (keyword): Optional parameters
- :body ([String.t]):

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

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

@spec plugin_upgrade(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, nil}
  | {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:error, Tesla.Env.t()}

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 (keyword): 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 ([DockerEngineAPI.Model.PluginPrivilege.t]):

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure