PARALLAX

docker_network_info

Read Docker network information using the native Engine API

Collection: community.docker

Full Name: community.docker.docker_network_info

Synopsis

Read Docker network information using the native Engine API

Parameters

NameTypeRequiredDefaultDescription
docker_hoststringDocker socket or TCP URL; defaults to DOCKER_HOST or unix:///var/run/docker.sock
api_versionstringDocker API version; defaults to DOCKER_API_VERSION or auto
timeoutintRequest timeout in seconds; defaults to DOCKER_TIMEOUT or 60
tlsboolEnable TLS without server verification; defaults to DOCKER_TLS
validate_certsboolVerify TLS certificates; defaults to DOCKER_TLS_VERIFY
tls_hostnamestringExpected TLS server name; defaults to DOCKER_TLS_HOSTNAME
ca_pathstringCA certificate file
client_certstringTLS client certificate
client_keystringTLS client private key
use_ssh_clientboolfalseSelect OpenSSH for SSH Docker transports
debugboolfalseEnable diagnostic mode
namestringyesObject name or identifier to inspect

Example

yaml
- name: Inspect Docker network information
  community.docker.docker_network_info:
    name: example
  register: docker_information
Search
    ↑ ↓ move↵ openesc close