/ home / pulp / pulp.squeezer / 0.0.15 / module / file_content

pulp.squeezer.file_content (0.0.15) — module

Manage file content of a pulp api server instance

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

This performs CRUD operations on file content in a pulp api server instance.

Usage examples

Scanned by Steampunk Spotter

- name: Read list of file content units from pulp api server
  pulp.squeezer.file_content:
    pulp_url: https://pulp.example.org
    username: admin
    password: password
  register: content_status

Scanned by Steampunk Spotter

- name: Report pulp file content units
  debug:
    var: content_status

Scanned by Steampunk Spotter

- name: Create a file content unit
  pulp.squeezer.file_content:
    pulp_url: https://pulp.example.org
    username: admin
    password: password
    sha256: 0000111122223333444455556666777788889999aaaabbbbccccddddeeeeffff
    relative_path: "data/important_file.txt"
    state: present

Inputs

    
state:
    choices:
    - present
    - absent
    description:
    - State the entity should be in
    type: str

sha256:
    aliases:
    - digest
    description:
    - sha256 digest of the file content to query or manipulate
    type: str

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

relative_path:
    description:
    - Relative path of the file content unit
    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

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

content:
  description: File content unit details
  returned: when digest and relative_path is given
  type: dict
contents:
  description: List of file content units
  returned: when digest or relative_path is not given
  type: list