redhat_cop.ah_configuration.ah_collection (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

Upload, or destroy Automation Hub Collections. 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: Upload collection to automation hub
  ah_collection:
    namespace: awx
    name: awx
    path: /var/tmp/collections/awx_awx-15.0.0.tar.gz

Scanned by Steampunk Spotter

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

- name: Remove collection
  ah_collection:
    namespace: test_collection
    name: test
    version: 4.1.2
    state: absent

Inputs

    
name:
    description:
    - Collection name. Must be lower case containing only alphanumeric characters and
      underscores.
    required: true
    type: str

path:
    description:
    - Collection artifact file path.
    type: str

wait:
    default: true
    description:
    - Waits for the collection to be uploaded
    type: bool

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Desired state of the resource.
    - If present with a path, will upload a collection artifact to Automation hub.
    - If present will return data on a collection.
    - If present with version, will return data on a collection version.
    - If absent without version, will delete the collection and all versions.
    - If absent with version, will delete only specified version.
    type: str

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

version:
    description:
    - Collection Version. Must be lower case containing only alphanumeric characters and
      underscores.
    type: str

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

namespace:
    description:
    - Namespace name. Must be lower case containing only alphanumeric characters and underscores.
    required: true
    type: str

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

auto_approve:
    default: true
    description:
    - Approves a collection.
    - Requires version to be set.
    type: bool

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

overwrite_existing:
    default: true
    description:
    - Overwrites an existing collection.
    - Requires version to be set.
    type: bool