pytoccaz.docker.docker_ps (2.2.0) — module

Install collection

Install with ansible-galaxy collection install pytoccaz.docker:==2.2.0

Add to requirements.yml

  collections:
    - name: pytoccaz.docker
      version: 2.2.0

Description

Retrieves information on running containers using the C(docker ps) command

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

  - name: List running containers
    pytoccaz.docker.docker_ps:
    register: containers_list

Inputs

    
all:
    default: false
    description:
    - whether to list stopped containers
    type: bool
    version_added: 2.2.0
    version_added_collection: pytoccaz.docker

name_contains:
    description:
    - A search string to filter container list on names
    type: str
    version_added: 2.1.0
    version_added_collection: pytoccaz.docker

Outputs

results:
  description: 'List of containers running on the target host

    '
  elements: dict
  returned: success
  sample:
  - command: nginx
    created: 10 days ago
    id: e7f4ccdb8680cb1dfca60d57252b031a77d3e060741dda1de662b80c22bf9b60
    image: web:latest
    names: web-server
    ports: 80/tcp
    status: Up 19 minutes
  type: list