ibmcloud.ansible_collection.ibm_kp_key (1.2.2) — module

Configure IBM Cloud 'ibm_kp_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_kp_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 the key
    required: false
    type: str

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

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

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

iv_value:
    description:
    - Only for imported root key
    required: false
    type: str

key_name:
    description:
    - (Required for new resource)
    required: false
    type: str

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

standard_key:
    default: false
    description:
    - None
    required: false
    type: bool

resource_name:
    description:
    - "The\_name\_of\_the\_resource"
    required: false
    type: str

key_protect_id:
    description:
    - (Required for new resource)
    required: false
    type: str

encrypted_nonce:
    description:
    - Only for imported root key
    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_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