pulp.squeezer.ansible_remote (0.0.15) — module

Manage ansible remotes 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 ansible remotes in a pulp api server instance.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Read list of ansible remotes from pulp api server
  pulp.squeezer.ansible_remote:
    pulp_url: https://pulp.example.org
    username: admin
    password: password
  register: remote_status
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Report pulp ansible remotes
  debug:
    var: remote_status
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create a ansible role remote
  pulp.squeezer.ansible_remote:
    pulp_url: https://pulp.example.org
    username: admin
    password: password
    content_type: role
    name: new_ansible_remote
    url: "https://galaxy.ansible.com/api/v1/roles/?namespace__name=ansible"
    state: present
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create a ansible collection remote
  pulp.squeezer.ansible_remote:
    pulp_url: https://pulp.example.org
    username: admin
    password: password
    content_type: collection
    name: new_ansible_collection_remote
    url: "https://galaxy-dev.ansible.com/"
    collections:
      - testing.ansible_testing_content
    state: present
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete a ansible remote
  pulp.squeezer.ansible_remote:
    pulp_url: https://pulp.example.org
    username: admin
    password: password
    name: new_ansible_remote
    state: absent

Inputs

    
url:
    description:
    - URL to the upstream repository
    type: str

name:
    description:
    - Name of the remote to query or manipulate
    type: str

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

token:
    description:
    - The token key to use for authentication.
    - See U(https://docs.ansible.com/ansible/latest/user_guide/collections_using.html#configuring-the-ansible-galaxy-client)
      for more details.
    type: str

policy:
    choices:
    - immediate
    description:
    - Whether downloads should be performed immediately, or lazy.
    type: str

ca_cert:
    description:
    - Certificate autority to identify the remote repository.
    type: str

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

auth_url:
    description:
    - The URL to receive a session token from, e.g. used with Automation Hub.
    type: str

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

proxy_url:
    description:
    - The proxy URL. Format C(scheme://host:port) .
    type: str

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

client_key:
    description:
    - Client key to authenticate with the remote repository.
    - Using this parameter will always report C(changed=true).
    type: str

rate_limit:
    description:
    - Limits requests per second for each concurrent downloader.
    type: int

client_cert:
    description:
    - Client certificate to authenticate with the remote repository.
    type: str

collections:
    description:
    - List of Collection requirements.
    elements: str
    type: list

max_retries:
    description:
    - Maximum number of retry attempts after a download failure. If not set then the default
      value (3) will be used.
    type: int

signed_only:
    description:
    - Sync only collections that have a signature.
    type: bool

content_type:
    choices:
    - collection
    - role
    default: collection
    description:
    - Content type of the remote
    type: str

total_timeout:
    description:
    - C(aiohttp.ClientTimeout.total) for download-connections. The default is null, which
      will cause the default from the aiohttp library to be used.
    type: float

proxy_password:
    description:
    - The password to authenticate with the proxy.
    - Using this parameter will always report C(changed=true).
    type: str

proxy_username:
    description:
    - The username to authenticate with the proxy.
    - Using this parameter will always report C(changed=true).
    type: str

tls_validation:
    description:
    - If True, TLS peer validation must be performed on remote synchronization.
    type: bool

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

connect_timeout:
    description:
    - C(aiohttp.ClientTimeout.connect) for download-connections. The default is null,
      which will cause the default from the aiohttp library to be used.
    type: float

remote_password:
    description:
    - The password to authenticate with the remote repository.
    - Using this parameter will always report C(changed=true).
    type: str

remote_username:
    description:
    - The username to authenticate with the remote repository.
    - Using this parameter will always report C(changed=true).
    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

sock_read_timeout:
    description:
    - C(aiohttp.ClientTimeout.sock_read) for download-connections. The default is null,
      which will cause the default from the aiohttp library to be used.
    type: float

sync_dependencies:
    description:
    - Sync dependencies for collections specified via requirements file.
    type: bool

download_concurrency:
    description:
    - Total number of simultaneous connections. If not set then the default value will
      be used.
    type: int

sock_connect_timeout:
    description:
    - C(aiohttp.ClientTimeout.sock_connect) for download-connections. The default is null,
      which will cause the default from the aiohttp library to be used.
    type: float

Outputs

remote:
  description: Ansible remote details
  returned: when name is given
  type: dict
remotes:
  description: List of ansible remotes
  returned: when no name is given
  type: list