docker_container_info
Read Docker container information using the native Engine API
Collection: community.docker
Full Name: community.docker.docker_container_info
Synopsis
Read Docker container information using the native Engine API
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| docker_host | string | Docker socket or TCP URL; defaults to DOCKER_HOST or unix:///var/run/docker.sock | ||
| api_version | string | Docker API version; defaults to DOCKER_API_VERSION or auto | ||
| timeout | int | Request timeout in seconds; defaults to DOCKER_TIMEOUT or 60 | ||
| tls | bool | Enable TLS without server verification; defaults to DOCKER_TLS | ||
| validate_certs | bool | Verify TLS certificates; defaults to DOCKER_TLS_VERIFY | ||
| tls_hostname | string | Expected TLS server name; defaults to DOCKER_TLS_HOSTNAME | ||
| ca_path | string | CA certificate file | ||
| client_cert | string | TLS client certificate | ||
| client_key | string | TLS client private key | ||
| use_ssh_client | bool | false | Select OpenSSH for SSH Docker transports | |
| debug | bool | false | Enable diagnostic mode | |
| name | string | yes | Object name or identifier to inspect |
Example
yaml
- name: Inspect Docker container information
community.docker.docker_container_info:
name: example
register: docker_information