ibmcloud.ansible_collection.ibm_resource_key (1.2.2) — module

Configure 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

Create, update or destroy an IBM Cloud 'ibm_resource_key' resource


Requirements

Inputs

    
id:
    description:
    - (Required when updating or destroying existing resource) IBM Cloud Resource ID.
    required: false
    type: str

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

name:
    description:
    - (Required for new resource) The name of the resource key
    required: false
    type: str

role:
    description:
    - (Required for new resource) Name of the user role.Valid roles are Writer, Reader,
      Manager, Administrator, Operator, Viewer, Editor.
    required: false
    type: str

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

state:
    choices:
    - available
    - absent
    default: available
    description:
    - State of resource
    required: false

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

parameters:
    description:
    - Arbitrary parameters to pass. Must be a JSON object
    required: false
    type: dict

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

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 for which to create resource key
    required: false
    type: str

resource_instance_id:
    description:
    - The id of the resource instance for which to create resource key
    required: false
    type: str