| Parameter | Choices/Defaults | Comments | 
                
                                                            | api_version 
                    string
                                                                 | Default: 
 "auto" | The version of the Docker API running on the Docker Host. Defaults to the latest version of the API supported by Docker SDK for Python and the docker daemon. If the value is not specified in the task, the value of environment variable DOCKER_API_VERSIONwill be used instead. If the environment variable is not set, the default value will be used. aliases: docker_api_version
 | 
                            
                                                            | archive_path 
                    path
                                                                 |  | Use with state presentto archive an image to a .tar file. | 
                            
                                                            | build 
                    dictionary
                                                                 added in 2.8 |  | Specifies options used for building images. | 
                                                        
                                                |  | args 
                    dictionary
                                                                 |  | Provide a dictionary of key:valuebuild arguments that map to Dockerfile ARG directive. Docker expects the value to be a string. For convenience any non-string values will be converted to strings. Requires Docker API >= 1.21. | 
                            
                                                |  | cache_from 
                    list
                     / elements=string                                             |  | List of image names to consider as cache source. | 
                            
                                                |  | container_limits 
                    dictionary
                                                                 |  | A dictionary of limits applied to each container created by the build process. | 
                                                        
                                                |  |  | cpusetcpus 
                    string
                                                                 |  | CPUs in which to allow execution, e.g., "0-3", "0,1". | 
                            
                                                |  |  | cpushares 
                    integer
                                                                 |  | CPU shares (relative weight). | 
                            
                                                |  |  | memory 
                    integer
                                                                 |  | Set memory limit for build. | 
                            
                                                |  |  | memswap 
                    integer
                                                                 |  | Total memory (memory + swap), -1 to disable swap. | 
                                            
                                                |  | dockerfile 
                    string
                                                                 |  | Use with state presentand sourcebuildto provide an alternate name for the Dockerfile to use when building an image. This can also include a relative path (relative to path). | 
                            
                                                |  | etc_hosts 
                    dictionary
                                                                 added in 2.9 |  | Extra hosts to add to /etc/hostsin building containers, as a mapping of hostname to IP address. | 
                            
                                                |  | http_timeout 
                    integer
                                                                 |  | Timeout for HTTP requests during the image build operation. Provide a positive integer value for the number of seconds. | 
                            
                                                |  | network 
                    string
                                                                 |  | The network to use for RUNbuild instructions. | 
                            
                                                |  | nocache 
                    boolean
                                                                 |  | Do not use cache when building an image. | 
                            
                                                |  | path 
                    path
                                             / required                     |  | Use with state 'present' to build an image. Will be the path to a directory containing the context and Dockerfile for building an image. | 
                            
                                                |  | pull 
                    boolean
                                                                 |  | When building an image downloads any updates to the FROM image in Dockerfile. The default is currently yes. This will change tonoin Ansible 2.12. | 
                            
                                                |  | rm 
                    boolean
                                                                 |  | Remove intermediate containers after build. | 
                            
                                                |  | target 
                    string
                                                                 added in 2.9 |  | When building an image specifies an intermediate build stage by name as a final stage for the resulting image. | 
                            
                                                |  | use_config_proxy 
                    boolean
                                                                 |  | If set to yesand a proxy configuration is specified in the docker client configuration (by default$HOME/.docker/config.json), the corresponding environment variables will be set in the container being built. Needs Docker SDK for Python >= 3.7.0. | 
                                            
                                                            | buildargs 
                    dictionary
                                                                 |  | Provide a dictionary of key:valuebuild arguments that map to Dockerfile ARG directive. Docker expects the value to be a string. For convenience any non-string values will be converted to strings. Requires Docker API >= 1.21. Please use build.args instead. This option will be removed in Ansible 2.12. | 
                            
                                                            | ca_cert 
                    path
                                                                 |  | Use a CA certificate when performing server verification by providing the path to a CA certificate file. If the value is not specified in the task and the environment variable DOCKER_CERT_PATHis set, the fileca.pemfrom the directory specified in the environment variableDOCKER_CERT_PATHwill be used. aliases: tls_ca_cert, cacert_path
 | 
                            
                                                            | client_cert 
                    path
                                                                 |  | Path to the client's TLS certificate file. If the value is not specified in the task and the environment variable DOCKER_CERT_PATHis set, the filecert.pemfrom the directory specified in the environment variableDOCKER_CERT_PATHwill be used. aliases: tls_client_cert, cert_path
 | 
                            
                                                            | client_key 
                    path
                                                                 |  | Path to the client's TLS key file. If the value is not specified in the task and the environment variable DOCKER_CERT_PATHis set, the filekey.pemfrom the directory specified in the environment variableDOCKER_CERT_PATHwill be used. aliases: tls_client_key, key_path
 | 
                            
                                                            | container_limits 
                    dictionary
                                                                 |  | A dictionary of limits applied to each container created by the build process. Please use build.container_limits instead. This option will be removed in Ansible 2.12. | 
                                                        
                                                |  | cpusetcpus 
                    string
                                                                 |  | CPUs in which to allow execution, e.g., "0-3", "0,1". | 
                            
                                                |  | cpushares 
                    integer
                                                                 |  | CPU shares (relative weight). | 
                            
                                                |  | memory 
                    integer
                                                                 |  | Set memory limit for build. | 
                            
                                                |  | memswap 
                    integer
                                                                 |  | Total memory (memory + swap), -1 to disable swap. | 
                                            
                                                            | debug 
                    boolean
                                                                 |  | Debug mode | 
                            
                                                            | docker_host 
                    string
                                                                 | Default: 
 "unix://var/run/docker.sock" | The URL or Unix socket path used to connect to the Docker API. To connect to a remote host, provide the TCP connection string. For example, tcp://192.0.2.23:2376. If TLS is used to encrypt the connection, the module will automatically replacetcpin the connection URL withhttps. If the value is not specified in the task, the value of environment variable DOCKER_HOSTwill be used instead. If the environment variable is not set, the default value will be used. aliases: docker_url
 | 
                            
                                                            | dockerfile 
                    string
                                                                 |  | Use with state presentand sourcebuildto provide an alternate name for the Dockerfile to use when building an image. This can also include a relative path (relative to path). Please use build.dockerfile instead. This option will be removed in Ansible 2.12. | 
                            
                                                            | force 
                    boolean
                                                                 |  | Use with state absent to un-tag and remove all images matching the specified name. Use with state presentto build, load or pull an image when the image already exists. Also use with statepresentto force tagging an image. Please stop using this option, and use the more specialized force options force_source, force_absent and force_tag instead. This option will be removed in Ansible 2.12. | 
                            
                                                            | force_absent 
                    boolean
                                                                 added in 2.8 |  | Use with state absent to un-tag and remove all images matching the specified name. | 
                            
                                                            | force_source 
                    boolean
                                                                 added in 2.8 |  | Use with state presentto build, load or pull an image (depending on the value of the source option) when the image already exists. | 
                            
                                                            | force_tag 
                    boolean
                                                                 added in 2.8 |  | Use with state presentto force tagging an image. | 
                            
                                                            | http_timeout 
                    integer
                                                                 |  | Timeout for HTTP requests during the image build operation. Provide a positive integer value for the number of seconds. Please use build.http_timeout instead. This option will be removed in Ansible 2.12. | 
                            
                                                            | load_path 
                    path
                                                                 |  | Use with state presentto load an image from a .tar file. Set source to loadif you want to load the image. The option will be set automatically before Ansible 2.12 if this option is used (except if path is specified as well, in which case building will take precedence). From Ansible 2.12 on, you have to set source toload. | 
                            
                                                            | name 
                    string
                                             / required                     |  | Image name. Name format will be one of: name, repository/name, registry_server:port/name. When pushing or pulling an image the name can optionally include the tag by appending ':tag_name'. Note that image IDs (hashes) are not supported. | 
                            
                                                            | nocache 
                    boolean
                                                                 |  | Do not use cache when building an image. Please use build.nocache instead. This option will be removed in Ansible 2.12. | 
                            
                                                            | path 
                    path
                                                                 |  | Use with state 'present' to build an image. Will be the path to a directory containing the context and Dockerfile for building an image. Set source to buildif you want to build the image. The option will be set automatically before Ansible 2.12 if this option is used. From Ansible 2.12 on, you have to set source tobuild. Please use build.path instead. This option will be removed in Ansible 2.12. aliases: build_path
 | 
                            
                                                            | pull 
                    boolean
                                                                 |  | When building an image downloads any updates to the FROM image in Dockerfile. Please use build.pull instead. This option will be removed in Ansible 2.12. The default is currently yes. This will change tonoin Ansible 2.12. | 
                            
                                                            | push 
                    boolean
                                                                 |  | Push the image to the registry. Specify the registry as part of the name or repository parameter. | 
                            
                                                            | repository 
                    string
                                                                 |  | Full path to a repository. Use with state presentto tag the image into the repository. Expects format repository:tag. If no tag is provided, will use the value of thetagparameter or latest. | 
                            
                                                            | rm 
                    boolean
                                                                 |  | Remove intermediate containers after build. Please use build.rm instead. This option will be removed in Ansible 2.12. | 
                            
                                                            | source 
                    string
                                                                 added in 2.8 | Choices:
                                                                                                                                                            buildloadpulllocal | Determines where the module will try to retrieve the image from. Use buildto build the image from aDockerfile. build.path must be specified when this value is used. Use loadto load the image from a.tarfile. load_path must be specified when this value is used. Use pullto pull the image from a registry. Use localto make sure that the image is already available on the local docker daemon, i.e. do not try to build, pull or load the image. Before Ansible 2.12, the value of this option will be auto-detected to be backwards compatible, but a warning will be issued if it is not explicitly specified. From Ansible 2.12 on, auto-detection will be disabled and this option will be made mandatory. | 
                            
                                                            | ssl_version 
                    string
                                                                 |  | Provide a valid SSL version number. Default value determined by ssl.py module. If the value is not specified in the task, the value of environment variable DOCKER_SSL_VERSIONwill be used instead. | 
                            
                                                            | state 
                    string
                                                                 | Choices:
                                                                                                                                                            absentpresent ←build | Make assertions about the state of an image. When absentan image will be removed. Use the force option to un-tag and remove all images matching the provided name. When presentcheck if an image exists using the provided name and tag. If the image is not found or the force option is used, the image will either be pulled, built or loaded, depending on the source option. By default the image will be pulled from Docker Hub, or the registry specified in the image's name. Note that this will change in Ansible 2.12, so to make sure that you are pulling, set source to pull. To build the image, provide a path value set to a directory containing a context and Dockerfile, and set source tobuild. To load an image, specify load_path to provide a path to an archive file. To tag an image to a repository, provide a repository path. If the name contains a repository path, it will be pushed. *Note:* state=buildis DEPRECATED and will be removed in Ansible 2.11. Specifyingbuildwill behave the same aspresent. | 
                            
                                                            | tag 
                    string
                                                                 | Default: 
 "latest" | Used to select an image when pulling. Will be added to the image when pushing, tagging or building. Defaults to latest. If name parameter format is name:tag, then tag value from name will take precedence. | 
                            
                                                            | timeout 
                    integer
                                                                 | Default: 
 60 | The maximum amount of time in seconds to wait on a response from the API. If the value is not specified in the task, the value of environment variable DOCKER_TIMEOUTwill be used instead. If the environment variable is not set, the default value will be used. | 
                            
                                                            | tls 
                    boolean
                                                                 |  | Secure the connection to the API by using TLS without verifying the authenticity of the Docker host server. Note that if validate_certs is set to yesas well, it will take precedence. If the value is not specified in the task, the value of environment variable DOCKER_TLSwill be used instead. If the environment variable is not set, the default value will be used. | 
                            
                                                            | tls_hostname 
                    string
                                                                 | Default: 
 "localhost" | When verifying the authenticity of the Docker Host server, provide the expected name of the server. If the value is not specified in the task, the value of environment variable DOCKER_TLS_HOSTNAMEwill be used instead. If the environment variable is not set, the default value will be used. | 
                            
                                                            | use_tls 
                    string
                                                                 | Choices:
                                                                                                                                                            noencryptverify | DEPRECATED. Whether to use tls to connect to the docker daemon. Set to encryptto use TLS. And set toverifyto use TLS and verify that the server's certificate is valid for the server. *Note:* If you specify this option, it will set the value of the tls or validate_certs parameters if not set to no. Will be removed in Ansible 2.11. | 
                            
                                                            | validate_certs 
                    boolean
                                                                 |  | Secure the connection to the API by using TLS and verifying the authenticity of the Docker host server. If the value is not specified in the task, the value of environment variable DOCKER_TLS_VERIFYwill be used instead. If the environment variable is not set, the default value will be used. aliases: tls_verify
 |