dockerStopContainer

Stop a Docker container. This operation uses Docker CLI, it requires the docker executable to be on the path of the docker endpoint.

Target Properties

Property Name

Property Code

Required

Description

Property Name

Property Code

Required

Description

Docker Unix Socket

FDDKR_UNIX_SOCKET

No

The socket the Docker daemon listens on. Required if Docker Server and Docker Port are not set. Default value is [/var/run/docker.sock]

Docker Server Address

FDDKR_DOCKER_SERVER

Yes

The IP address of the Docker server.

Docker Port

FDDKR_DOCKER_PORT

Yes

The port the Docker service is listening on.

Inputs

Input Name

Input Code

Required

Description

Input Name

Input Code

Required

Description

Container ID

FDDKR_INP_CONTAINER_ID

Yes

The ID of the container to stop.

Kill Container

FDDKR_INP_KILL

No

Whether or not to kill the container.

Continue on Error

FDDKR_INP_CONTINUE_ON_ERROR

No

Optionally do not fail the workflow if the operation fails.

Additional Options

FDDKR_INP_ADDITIONAL_PARAMS

No

Add any additional options, which will be concatenated to the stop command.

Artifacts

This operation does not produce or consume artifacts.

Endpoint Selection

This operation will select all available endpoints associated to the Target.

Endpoint Execution

This operation will execute on any one of the selected endpoints and will be random in the determination of which one.

The following macros are not currently supported in the footer:
  • style