redhat_cop.ah_configuration.ah_namespace (0.9.2) — module

create, update, or destroy Automation Hub Namespace.

Authors: Sean Sullivan (@sean-m-sullivan)

preview | supported by community

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

Create, update, or destroy Automation Hub Namespace. See U(https://www.ansible.com/) for an overview.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create Tower Ping job template
  ah_namespace:
    name: Redhat
    company: Redhat
    email: user@example.com
    avatar_url: https://pnt.redhat.com/pnt/d-11633955/LogoRedHatHatColorRGB.png
    description: This is the Redhat Namespace
    links:
      - name: "homepage"
        url: "http://www.redhat.com"
    groups:
      - name: system:partner-engineers
        object_permissions:
          - "change_namespace"
          - "upload_to_namespace"

Inputs

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

email:
    description:
    - Namespace contact email.
    type: str

links:
    description:
    - A list of dictionaries of Name and url values for links related the Namespace.
    elements: dict
    suboptions:
      name:
        description:
        - Link Text.
        required: true
        type: str
      url:
        description:
        - Link URL.
        required: true
        type: str
    type: list

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Desired state of the resource.
    type: str

groups:
    default: []
    description:
    - A list of dictionaries of the Names and object_permissions values for groups that
      control the Namespace.
    elements: dict
    suboptions:
      name:
        description:
        - Group Name or ID.
        required: true
        type: str
      object_permissions:
        choices:
        - change_namespace
        - upload_to_namespace
        description:
        - List of Permisions granted to the group.
        required: true
        type: list
    type: list

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

company:
    description:
    - Namespace owner company name.
    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

new_name:
    description:
    - Setting this option will change the existing name (looked up via the name field.
    type: str

resources:
    description:
    - Namespace resource page in Markdown format.
    type: str

avatar_url:
    description:
    - Namespace logo URL.
    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

description:
    description:
    - Description to use for the Namespace.
    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