ibmcloud.ansible_collection.ibm_container_cluster_info (1.2.2) — module

Retrieve IBM Cloud 'ibm_container_cluster' resource

| "added in version" 2.8 of ibmcloud.ansible_collection"

Authors: Jay Carman (@jaywcarman)

preview | supported by community

Install collection

Install with ansible-galaxy collection install ibmcloud.ansible_collection:==1.2.2


Add to requirements.yml

  collections:
    - name: ibmcloud.ansible_collection
      version: 1.2.2

Description

Retrieve an IBM Cloud 'ibm_container_cluster' resource


Requirements

Inputs

    
crn:
    description:
    - CRN of resource instance
    required: false
    type: str

albs:
    description:
    - None
    elements: dict
    required: false
    type: list

vlans:
    description:
    - None
    elements: dict
    required: false
    type: list

region:
    description:
    - The cluster region
    required: false
    type: str

workers:
    description:
    - None
    elements: str
    required: false
    type: list

alb_type:
    default: all
    description:
    - None
    required: false
    type: str

org_guid:
    description:
    - The bluemix organization guid this cluster belongs to
    required: false
    type: str

is_trusted:
    description:
    - None
    required: false
    type: bool

server_url:
    description:
    - None
    required: false
    type: str

space_guid:
    description:
    - The bluemix space guid this cluster belongs to
    required: false
    type: str

account_guid:
    description:
    - The bluemix account guid this cluster belongs to
    required: false
    type: str

resource_crn:
    description:
    - The crn of the resource
    required: false
    type: str

worker_count:
    description:
    - Number of workers
    required: false
    type: int

worker_pools:
    description:
    - None
    elements: dict
    required: false
    type: list

resource_name:
    description:
    - The name of the resource
    required: false
    type: str

cluster_name_id:
    description:
    - Name or id of the cluster
    required: true
    type: str

ibmcloud_region:
    default: us-south
    description:
    - Denotes which IBM Cloud region to connect to
    required: false

resource_status:
    description:
    - The status of the resource
    required: false
    type: str

bounded_services:
    description:
    - None
    elements: dict
    required: false
    type: list

ibmcloud_api_key:
    description:
    - The API Key used for authentification. This can also be provided via the environment
      variable 'IC_API_KEY'.
    required: true

resource_group_id:
    description:
    - ID of the resource group.
    required: false
    type: str

resource_group_name:
    description:
    - The resource group name in which resource is provisioned
    required: false
    type: str

public_service_endpoint:
    description:
    - None
    required: false
    type: bool

resource_controller_url:
    description:
    - The URL of the IBM Cloud dashboard that can be used to explore and view details
      about this cluster
    required: false
    type: str

private_service_endpoint:
    description:
    - None
    required: false
    type: bool

public_service_endpoint_url:
    description:
    - None
    required: false
    type: str

private_service_endpoint_url:
    description:
    - None
    required: false
    type: str