---
title: Docker Prune
slug: homologacao-atmosphere/docker-prune
description: Learn how to effectively use the Docker Prune API with this comprehensive document. Discover the various parameters available, including API version selection, SSL/TLS usage, and targeted pruning of containers, images, networks, and volumes. Explore pract
docTags:
createdAt: 2021-03-18T13:29:58.000Z
---
## Resumo
- Permite executar `docker container prune`, `docker image prune`, `docker network prune` e `docker volume prune` por meio da API.
## Parâmetros
| **Parâmetro** | **Tipo** | **Escolhas \| Valor Padrão** | **Comentários** |
| -------------------------------------------------------------- | ---------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| api\_version
aliases: docker\_api\_version | string | Default:
- "auto" | A versão da API Docker em execução no Docker Host.O padrão é a versão mais recente da API suportada pelo Docker SDK para Python e o docker daemon.Se o valor não for especificado na tarefa, o valor da variável de ambiente `DOCKER_API_VERSION` será usado. Se a variável de ambiente não for definida, o valor padrão será usado. |
| builder\_cache | boolean | Escolhas:
- false (default)
- true | Se deve limpar o cache do construtor.Requer a versão 3.3.0 do Docker SDK para Python ou mais recente. |
| ca\_cert
aliases: tls\_ca\_cert, cacert\_path | path | | Use um certificado CA ao executar a verificação do servidor, fornecendo o caminho para um arquivo de certificado CA.Se o valor não for especificado na tarefa e a variável de ambiente `DOCKER_CERT_PATH` for definida, o arquivo `ca.pem` do diretório especificado na variável de ambiente `DOCKER_CERT_PATH` será usado. |
| client\_cert
aliases: tls\_client\_cert, cert\_path | path | | Caminho para o arquivo de certificado TLS do cliente.Se o valor não for especificado na tarefa e a variável de ambiente `DOCKER_CERT_PATH` for definida, o arquivo `cert.pem` do diretório especificado na variável de ambiente `DOCKER_CERT_PATH` será usado. |
| client\_key
aliases: tls\_client\_key, key\_path | path | | Caminho para o arquivo de chave TLS do cliente.Se o valor não for especificado na tarefa e a variável de ambiente `DOCKER_CERT_PATH` for definida, o arquivo `key.pem` do diretório especificado na variável de ambiente `DOCKER_CERT_PATH` será usado. |
| containers | boolean | Escolhas:
- false (default)
- true | Se deve realizar o Prune containers. |
| containers\_filters | dictionary | | Um dicionário de valores de filtro usado para selecionar contêineres a serem excluídos. Por exemplo `until: 24h`. Consulte a documentação do docker para obter mais informações sobre os filtros possíveis. |
| debug | boolean | Escolhas:
- false (default)
- true | Modo de depuração |
| docker\_host
aliases: docker\_url | string | Default:
- "unix: //var/run/docker.sock" | O URL ou o caminho do soquete Unix usado para se conectar à API Docker. Para se conectar a um host remoto, forneça a string de conexão TCP. Por exemplo `tcp://192.0.2.23:2376`. Se TLS for usado para criptografar a conexão, o módulo será automaticamente substituído tcpno URL de conexão por `https`.Se o valor não for especificado na tarefa, o valor da variável de ambiente `DOCKER_HOST` será usado. Se a variável de ambiente não for definida, o valor padrão será usado. |
| images | boolean | Escolhas:
- false (default)
- true | Se deve usar imagens. |
| images\_filters | dictionary | | Um dicionário de valores de filtro usado para selecionar imagens a serem excluídas.Por exemplo `dangling: true`. |
| networks | boolean | Escolhas:
- false (default)
- true | Se deve usar redes. |
| networks\_filters | dictionary | | Um dicionário de valores de filtro usado para selecionar as redes a serem excluídas. |
| ssl\_version | string | | Forneça um número de versão SSL válido. Valor padrão determinado pelo módulo ssl.py.Se o valor não for especificado na tarefa, o valor da variável de ambiente `DOCKER_SSL_VERSION` será usado. |
| timeout | integer | Default:
- 60 | O tempo máximo em segundos de espera por uma resposta da API.Se o valor não for especificado na tarefa, o valor da variável de ambiente DOCKER\_TIMEOUTserá usado. Se a variável de ambiente não for definida, o valor padrão será usado. |
| tls | boolean | Escolhas:
- false (default)
- true | Proteja a conexão com a API usando TLS sem verificar a autenticidade do servidor host Docker. Observe que se *validate\_certs também* for definido yescomo, ele terá precedência.Se o valor não for especificado na tarefa, o valor da variável de ambiente DOCKER\_TLSserá usado. Se a variável de ambiente não for definida, o valor padrão será usado. |
| tls\_hostname | string | Default:
- "localhost" | Ao verificar a autenticidade do servidor Docker Host, forneça o nome esperado do servidor.Se o valor não for especificado na tarefa, o valor da variável de ambiente DOCKER\_TLS\_HOSTNAMEserá usado. Se a variável de ambiente não for definida, o valor padrão será usado. |
| validate\_certs
aliases: tls\_verify | boolean | Escolhas:
- false (default)
- true | Proteja a conexão com a API usando TLS e verificando a autenticidade do servidor host Docker.Se o valor não for especificado na tarefa, o valor da variável de ambiente DOCKER\_TLS\_VERIFYserá usado. Se a variável de ambiente não for definida, o valor padrão será usado. |
| volumes | boolean | Escolhas:
- false (default)
- true | Se deseja dar Prune nos volumes. |
| volumes\_filters | dictionary | | Um dicionário de valores de filtro usado para selecionar os volumes a serem excluídos. |
## Exemplos
```yaml
# Prune containers com mais de 24h
docker_prune:
containers: yes
containers_filters:
# considere apenas containers criados há mais de 24 horas
until: 24h
# Prune tudo
docker_prune:
containers: yes
images: yes
networks: yes
volumes: yes
builder_cache: yes
# Prune tudo (incluindo imagens não pendentes)
docker_prune:
containers: yes
images: yes
images_filters:
dangling: false
networks: yes
volumes: yes
builder_cache: yes
```
## Valores Retornados
| **Chave** | **Tipo** | **Retornado quando** | **Descrição** |
| -------------------------------- | ---------------------- | ----------------------- | ------------------------------------------------------------------------------------ |
| builder\_cache\_space\_reclaimed | integer | *builder\_cache* = true | Quantidade de espaço em disco recuperado da limpeza do cache do construtor em bytes. |
| containers | list / elements=string | *containers* = true | Lista de IDs de contêineres excluídos. |
| containers\_space\_reclaimed | integer | *containers* = true | Quantidade de espaço em disco recuperado pela remoção do contêiner em bytes. |
| images | list / elements=string | *images* = true | Lista de IDs de imagens excluídas. |
| images\_space\_reclaimed | integer | *images* = true | Quantidade de espaço em disco recuperado pela remoção de imagens em bytes. |
| networks | list / elements=string | *networks* = true | Lista de IDs de redes excluídas. |
| volumes | list / elements=string | *volumes* = true | Lista de IDs de volumes excluídos. |
| volumes\_space\_reclaimed | integer | *volumes* = true | Quantidade de espaço em disco recuperado a partir da remoção de volumes em bytes. |