ibmcloud.ansible_collection.ibm_compute_vm_instance_info (1.2.2) — module

Retrieve IBM Cloud 'ibm_compute_vm_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_compute_vm_instance' resource


Requirements

Inputs

    
cores:
    description:
    - Number of cpu cores
    required: false
    type: int

domain:
    description:
    - The domain of the virtual guest
    required: true
    type: str

status:
    description:
    - The VSI status
    required: false
    type: str

hostname:
    description:
    - The hostname of the virtual guest
    required: true
    type: str

datacenter:
    description:
    - Datacenter in which the virtual guest is deployed
    required: false
    type: str

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

power_state:
    description:
    - The current power state of a virtual guest.
    required: false
    type: str

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

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

ip_address_id:
    description:
    - None
    required: false
    type: int

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

ipv6_address_id:
    description:
    - None
    required: false
    type: int

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

public_subnet_id:
    description:
    - None
    required: false
    type: int

private_subnet_id:
    description:
    - None
    required: false
    type: int

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

secondary_ip_count:
    description:
    - None
    required: false
    type: int

public_interface_id:
    description:
    - None
    required: false
    type: int

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

private_interface_id:
    description:
    - None
    required: false
    type: int

ip_address_id_private:
    description:
    - None
    required: false
    type: int

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

last_known_power_state:
    description:
    - The last known power state of a virtual guest in the event the guest is turned off
      outside of IMS or has gone offline.
    required: false
    type: str

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