ibmcloud.ansible_collection.ibm_resource_instance_info (1.2.2) — module

Retrieve IBM Cloud 'ibm_resource_instance' 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_resource_instance' resource


Requirements

Inputs

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

name:
    description:
    - Resource instance name for example, myobjectstorage
    required: true
    type: str

plan:
    description:
    - The plan type of the instance
    required: false
    type: str

status:
    description:
    - The resource instance status
    required: false
    type: dict

service:
    description:
    - The service type of the instance
    required: false
    type: str

location:
    description:
    - The location or the environment in which instance exists
    required: false
    type: str

resource_crn:
    description:
    - "The\_crn\_of\_the\_resource"
    required: false
    type: str

resource_name:
    description:
    - "The\_name\_of\_the\_resource"
    required: false
    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

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:
    - The id of the resource group in which the instance is present
    required: false
    type: str

resource_group_name:
    description:
    - "The\_resource\_group\_name\_in\_which\_resource\_is\_provisioned"
    required: false
    type: str

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