ibmcloud.ansible_collection.ibm_compute_vm_instance (1.2.2) — module

Configure 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

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


Requirements

Inputs

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

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

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

disks:
    description:
    - None
    elements: int
    required: false
    type: list

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

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

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

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

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

bulk_vms:
    description:
    - None
    elements: dict
    required: false
    type: list

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

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

transient:
    description:
    - None
    required: false
    type: bool

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

local_disk:
    default: true
    description:
    - None
    required: false
    type: bool

ssh_key_ids:
    description:
    - None
    elements: int
    required: false
    type: list

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

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

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

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

network_speed:
    default: 100
    description:
    - None
    required: false
    type: int

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

resource_name:
    description:
    - The name of the resource
    required: false
    type: str

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

hourly_billing:
    default: true
    description:
    - None
    required: false
    type: bool

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

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

flavor_key_name:
    description:
    - Flavor key name used to provision vm.
    required: false
    type: str

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

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

resource_status:
    description:
    - The status of the resource
    required: false
    type: str

file_storage_ids:
    description:
    - None
    elements: int
    required: false
    type: list

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

block_storage_ids:
    description:
    - None
    elements: int
    required: false
    type: list

datacenter_choice:
    description:
    - The user provided datacenter options
    elements: dict
    required: false
    type: list

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

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

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

wait_time_minutes:
    default: 90
    description:
    - None
    required: false
    type: int

placement_group_id:
    description:
    - The placement group id
    required: false
    type: int

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

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

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

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

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

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

placement_group_name:
    description:
    - The placement group name
    required: false
    type: str

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

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

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

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

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

post_install_script_uri:
    description:
    - None
    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 this instance
    required: false
    type: str

dedicated_acct_host_only:
    description:
    - None
    required: false
    type: bool

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

public_security_group_ids:
    description:
    - None
    elements: int
    required: false
    type: list

private_security_group_ids:
    description:
    - None
    elements: int
    required: false
    type: list

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