ibmcloud.ansible_collection.ibm_resource_key_info (1.2.2) — module

Retrieve IBM Cloud 'ibm_resource_key' 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_key' resource


Requirements

Inputs

    
crn:
    description:
    - crn of resource key
    required: false
    type: str

name:
    description:
    - The name of the resource key
    required: true
    type: str

role:
    description:
    - User role
    required: false
    type: str

status:
    description:
    - Status of resource key
    required: false
    type: str

credentials:
    description:
    - Credentials asociated with the key
    required: false
    type: dict

most_recent:
    default: false
    description:
    - If true and multiple entries are found, the most recently created resource key is
      used. If false, an error is returned
    required: false
    type: bool

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

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_alias_id:
    description:
    - The id of the resource alias
    required: false
    type: str

resource_instance_id:
    description:
    - The id of the resource instance
    required: false
    type: str