---
title: Docker Volume Info
slug: homologacao-atmosphere/docker-volume-info
description: Learn about Docker volumes and how to use the Docker API to inspect and obtain information about them. This document outlines the requirements, parameters, and examples for checking the existence of a volume and retrieving inspection results.
docTags: 
createdAt: 2021-03-17T20:24:17.000Z
---

## Resumo

- Retorna informações sobre os volumes do Docker

## Requisitos

- Docker API >= 1.21

## Parâmetros

| **Parâmetro**     | **Tipo** | **Escolhas \| Valor Padrão** | **Comentários**                                                |
| ----------------- | -------- | ---------------------------- | -------------------------------------------------------------- |
| name - *required* | string   |                              | Nome do volume a inspecionar.<br /><br />aliases: volume\_name |


Exemplos
--------

```yaml
# Exemplo: Obtenha informações sobre o volume
- docker_volume_info:
    name: volume_teste
  register: result

# Exemplo: O volume existe?
- debug:
    msg: "O volume {{ 'existe' if result.exists else 'não existe' }}"

# Exemplo: Imprimir informações sobre o volume
- debug:
    var: result.volume
  when: result.exists
```



## Valores retornados

| **Chave** | **Tipo**   | **Retornado quando** | **Descrição**                                                                                |
| --------- | ---------- | -------------------- | -------------------------------------------------------------------------------------------- |
| exists    | boolean    | Sempre               | Retorna se o volume existe.                                                                  |
| volume    | dictionary | Sucesso              | Resultados da inspeção de volume para o volume afetado. Será nenhum se o volume não existir. |

