pulp.squeezer.api_call (0.0.15) — module

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

TBD

Usage examples

Scanned by Steampunk Spotter

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

- name: Read status from pulp api server
  pulp.squeezer.api_call:
    pulp_url: https://pulp.example.org
    username: admin
    password: password
  register: pulp_result

Scanned by Steampunk Spotter

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

- name: Report pulp status
  debug:
    var: pulp_result.response

Inputs

    
body:
    description: JSON representation of the body to send in the request (only POST, PUT
      and PATCH requests.)
    required: false
    type: dict

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

parameters:
    description: Dictionary of (path, query and cookie) parameters to send along with
      the request.
    required: false
    type: dict

operation_id:
    description: ID of the openapi operation to perform.
    required: true
    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

response:
  description: Pulp api response
  returned: always
  type: dict