/ home / pulp / pulp.squeezer / 0.0.15 / module / purge_tasks

pulp.squeezer.purge_tasks (0.0.15) — module

Purge finished tasks

Authors: Matthias Dellweg (@mdellweg)

Install collection

Install with ansible-galaxy collection install pulp.squeezer:==0.0.15

Add to requirements.yml

  collections:
    - name: pulp.squeezer
      version: 0.0.15

Description

Purge tasks in specific finished states with a certain minimal age.

Usage examples

Scanned by Steampunk Spotter

- name: Remove old finished tasks
  pulp.squeezer.purge_tasks:
    pulp_url: https://pulp.example.org
    username: admin
    password: password
  register: task_purge_summary

Scanned by Steampunk Spotter

- name: Report removed tasks
  debug:
    var: task_purge_summary

Inputs

    
states:
    choices:
    - canceled
    - completed
    - failed
    description:
    - Pulp reference of the task to query or manipulate
    elements: str
    type: list

timeout:
    default: 10
    description:
    - Time in seconds to wait for tasks.
    type: int

password:
    description:
    - Password of api user.
    - If no value is specified, the value of the environment variable C(SQUEEZER_PASSWORD)
      will be used as a fallback.
    required: false
    type: str

pulp_url:
    description:
    - URL of the server to connect to (without 'pulp/api/v3').
    - If no value is specified, the value of the environment variable C(SQUEEZER_PULP_URL)
      will be used as a fallback.
    required: true
    type: str

user_key:
    description:
    - Client certificate key of api user.
    required: false
    type: str

username:
    description:
    - Username of api user.
    - If no value is specified, the value of the environment variable C(SQUEEZER_USERNAME)
      will be used as a fallback.
    required: false
    type: str

user_cert:
    description:
    - Client certificate of api user.
    required: false
    type: str

validate_certs:
    default: true
    description:
    - Whether SSL certificates should be verified.
    - If no value is specified, the value of the environment variable C(SQUEEZER_VALIDATE_CERTS)
      will be used as a fallback.
    type: bool

finished_before:
    description:
    - Datetime to specify the least age of tasks to purge.
    type: str

refresh_api_cache:
    default: false
    description:
    - Whether the cached API specification should be invalidated.
    - It is recommended to use this once with the M(pulp.squeezer.status) module at the
      beginning of the playbook.
    type: bool

Outputs

summary:
  description: Task purge details
  returned: always
  type: dict