# containers.podman.podman_login module – Login to a container registry using podman

Note

This module is part of the containers.podman collection (version 1.20.0).

It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`.

To install it, use: `ansible-galaxy collection install containers.podman`. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: `containers.podman.podman_login`.

## Synopsis

- Login to a container registry server using the podman login command If the registry is not specified, the first registry under `[registries.search]` from `registries.conf `will be used. The path of the authentication file can be overridden by the user by setting the `authfile` flag. The default path used is `${XDG_RUNTIME_DIR}/containers/auth.json`.

## Requirements

The below requirements are needed on the host that executes this module.

- Podman installed on host

## Parameters

Parameter | Comments
--- | ---
authfile path | Path of the authentication file. Default is ``${XDG_RUNTIME_DIR}/containers/auth.json`` You can also override the default path of the authentication file by setting the ``REGISTRY_AUTH_FILE`` environment variable. ``export REGISTRY_AUTH_FILE=path``
certdir path | Use certificates at path (*.crt, *.cert, *.key) to connect to the registry. Default certificates directory is /etc/containers/certs.d.
executable string | Path to `podman` executable if it is not in the `$PATH` on the machine running `podman` Default: `"podman"`
password string | Password for the registry server.
registry string | Registry server. If the registry is not specified, the first registry under `[registries.search]` from `registries.conf` will be used.
secret string | Name of an existing `podman` secret to use for authentication to target registry

tlsverify

boolean

Require HTTPS and verify certificates when contacting registries. If explicitly set to true, then TLS verification will be used. If set to false, then TLS verification will not be used. If not specified, TLS verification will be used unless the target registry is listed as an insecure registry in registries.conf.

Choices:

- `false`

- `true`

username string | Username for the registry server.

## Examples

    - name: Login to default registry and create ${XDG_RUNTIME_DIR}/containers/auth.json
      containers.podman.podman_login:
        username: user
        password: 'p4ssw0rd'

    - name: Login to quay.io and create ${XDG_RUNTIME_DIR}/containers/auth.json
      containers.podman.podman_login:
        username: user
        password: 'p4ssw0rd'
        registry: quay.io

    - name: Login to quay.io using existing secret called password
      containers.podman.podman_login:
        username: user
        secret: password
        registry: quay.io

### Authors

- Jason Hiatt (@jthiatt)

- Clemens Lange (@clelange)

- Michael Fox (@spmfox)

### Collection links

- Issue Tracker
- Repository (Sources)