docker_host_info

Read Docker host information using the native Engine API

Collection: community.docker

Full Name: community.docker.docker_host_info

Synopsis

Read Docker host information using the native Engine API

Name	Type	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
containers	bool	`false`	List containers
containers_filters	dict		Docker API filters, including lists of label expressions
images	bool	`false`	List images
images_filters	dict		Docker API filters, including lists of label expressions
networks	bool	`false`	List networks
networks_filters	dict		Docker API filters, including lists of label expressions
volumes	bool	`false`	List volumes
volumes_filters	dict		Docker API filters, including lists of label expressions
containers_all	bool	`false`	Enable containers_all
disk_usage	bool	`false`	Enable disk_usage
verbose_output	bool	`false`	Enable verbose_output

yaml

- name: Inspect Docker host information
  community.docker.docker_host_info: {}
  register: docker_information