Documentation

PLEASE NOTE: This document applies to latest version and not to the latest stable release v2.20

Documentation for other releases can be found by using the version selector in the top right of any doc page.

docker_login

Manage Docker registry authentication.

check_mode:
  support: full

Parameter	Type	Values	Description
email	string		Email address for the registry account.
password	string		Password for authentication.
reauthorize	boolean		Force re-authorization even if already logged in.
registry	string		Registry URL (default: Docker Hub).
state	string	present absent	Desired state of the registry login.
username	string		Username for authentication.

```yaml

name: Login to Docker Hub docker_login: username: myuser password: mypassword
name: Login to private registry docker_login: registry: registry.example.com username: deploy password: “{{ registry_password }}”
name: Login with email docker_login: registry: registry.example.com username: deploy password: “{{ registry_password }” /// email: deploy@example.com /// /// - name: Logout from Docker Hub /// docker_login: /// state: absent /// /// - name: Logout from private registry /// docker_login: /// registry: registry.example.com /// state: absent /// /// - name: Re-authorize (force login even if already logged in) /// docker_login: /// registry: registry.example.com /// username: deploy /// password: “{{ registry_password }}” /// reauthorize: true /// ```}