redhat_cop.ah_configuration.ah_repository_sync (0.9.2) — module

Install collection

Install with ansible-galaxy collection install redhat_cop.ah_configuration:==0.9.2

Add to requirements.yml

  collections:
    - name: redhat_cop.ah_configuration
      version: 0.9.2

Description

Configure an Automation Hub remote Repository. See U(https://www.ansible.com/) for an overview.

Usage examples

Scanned by Steampunk Spotter

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

- name: Sync rh-certified repo without waiting
  ah_repository_sync:
    name: rh-certified
    wait: false

Scanned by Steampunk Spotter

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

- name: Sync community repo and wait up to 60 seconds
  ah_repository_sync:
    name: community
    wait: true
    timeout: 60

Inputs

    
name:
    description:
    - Repository name. Probably one of community or rh-certified.
    required: true
    type: str

wait:
    default: true
    description:
    - Wait for the repository to finish syncing before returning.
    required: false
    type: bool

ah_host:
    aliases:
    - ah_hostname
    description:
    - URL to Ansible Galaxy or Automation Hub instance.
    - If value not set, will try environment variable C(AH_HOST)
    - If value not specified by any means, the value of C(127.0.0.1) will be used
    type: str

timeout:
    description:
    - If waiting for the project to update this will abort after this amount of seconds
    type: int

ah_token:
    description:
    - The Ansible Galaxy or Automation Hub API token to use.
    - This value can be in one of two formats.
    - A string which is the token itself. (i.e. bqV5txm97wqJqtkxlMkhQz0pKhRMMX)
    - A dictionary structure as returned by the ah_token module.
    - If value not set, will try environment variable C(AH_API_TOKEN)
    type: raw

interval:
    default: 1
    description:
    - The interval to request an update from Automation Hub.
    required: false
    type: float

ah_password:
    description:
    - Password for your Ansible Galaxy or Automation Hub instance.
    - If value not set, will try environment variable C(AH_PASSWORD)
    type: str

ah_username:
    description:
    - Username for your Ansible Galaxy or Automation Hub instance.
    - If value not set, will try environment variable C(AH_USERNAME)
    type: str

ah_path_prefix:
    default: galaxy
    description:
    - API path used to access the api.
    - For galaxy_ng this is either 'automation-hub' or the custom prefix used on install
      with GALAXY_API_PATH_PREFIX
    - For Automation Hub this is 'galaxy'
    type: str

validate_certs:
    aliases:
    - ah_verify_ssl
    description:
    - Whether to allow insecure connections to Galaxy or Automation Hub Server.
    - If C(no), SSL certificates will not be validated.
    - This should only be used on personally controlled sites using self-signed certificates.
    - If value not set, will try environment variable C(AH_VERIFY_SSL)
    type: bool