docker.stop
Stops a Docker container. The container's behavior depends on the state of the cluster.
- If the cluster is not in maintenance mode, the container will restart.
- If the cluster is in maintenance mode, the container will stop and will not restart.
JSON-RPC Request
{"jsonrpc":"2.0","id":1,"method":"docker.stop","params":{"name":"<container_name>"}}Request parameters
| Parameter | Description |
|---|---|
name | The name of the Docker container to stop. The container name can be retrieved using the rvc docker containers command. |
JSON-RPC Response
{
"jsonrpc": "2.0",
"id": 1,
"result": "Docker container <container_name> stop requested."
}CLI Example
rvc docker stop --name <container_name>Response
Docker container docker-container-httpd-resource stop requested.