agonzalezrh.install_openshift.list_clusters (1.0.4) — module

Retrieves the list of OpenShift clusters.

| "added in version" 1.0.0 of agonzalezrh.install_openshift"

Authors: Alberto Gonzalez (@agonzalezrh)

Install collection

Install with ansible-galaxy collection install agonzalezrh.install_openshift:==1.0.4


Add to requirements.yml

  collections:
    - name: agonzalezrh.install_openshift
      version: 1.0.4

Description

Retrieves the list of OpenShift cluster using Assisted Installer.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create a new SNO Assisted Installer Cluster
  agonzalezrh.install_openshift.clusters:
    name: "{{ cluster_name }}"
    high_availability_mode: "None"
    openshift_version: "{{ cluster_version }}"
    base_dns_domain: "{{ cluster_domain }}"
    offline_token: "{{ offline_token }}"
    pull_secret: "{{ pull_secret }}"
    high_availability_mode: "None"
  register: newcluster

Inputs

    
owner:
    description: If provided, returns only clusters that are owned by the specified user.
    required: false
    type: str

with_hosts:
    description: Include hosts in the returned list.
    required: false
    type: bool

offline_token:
    description: Offline token from console.redhat.com
    required: true
    type: str

ams_subscription_ids:
    description: If non-empty, returned Clusters are filtered to those with matching subscription
      IDs.
    required: false
    type: list

openshift_cluster_id:
    choices:
    - absent
    - present
    description: A specific cluster to retrieve.
    required: false
    type: str

get_unregistered_clusters:
    description: Whether to return clusters that have been unregistered.
    required: false
    type: bool

Outputs

result:
  description: Result from the API call
  returned: always
  type: dict