opentelekomcloud.cloud.deh_host (0.14.2) — module

Install collection

Install with ansible-galaxy collection install opentelekomcloud.cloud:==0.14.2

Add to requirements.yml

  collections:
    - name: opentelekomcloud.cloud
      version: 0.14.2

Description

Manage Dedicated Hosts on Open Telekom Cloud

Requirements

• openstacksdk
• openstacksdk >= 0.36.0
• otcextensions
• python >= 3.6

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Allocate Dedicated host
- opentelekomcloud.cloud.deh_host:
    cloud: otc
    availability_zone: eu-de-01
    host_type: s2-medium
    name: "{{ deh_host_name }}"
    state: present
    quantity: 1
    tags:
      - key: key1
        value: value1
      - key: key2
        value: value2
  register: deh

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Modify Dedicated Host
- opentelekomcloud.cloud.deh_host:
    cloud: otc
    id: "{{ deh.deh_host.dedicated_host_ids[0] }}"
    auto_placement: false
  when:
    - deh is defined
  register: deh

Inputs

    
id:
    description:
    - ID of the DeH.
    - Parameter is usable for update or deletion of a DeH host.
    type: str

auth:
    description:
    - Dictionary containing auth information as needed by the cloud's auth plugin strategy.
      For the default I(password) plugin, this would contain I(auth_url), I(username),
      I(password), I(project_name) and any information about domains (for example, I(os_user_domain_name)
      or I(os_project_domain_name)) if the cloud supports them. For other plugins, this
      param will need to contain whatever parameters that auth plugin requires. This parameter
      is not needed if a named cloud is provided or OpenStack OS_* environment variables
      are present.
    type: dict

name:
    description:
    - Name or ID of the DeH.
    - Mandatory for DeH creation.
    type: str

tags:
    description:
    - Specifies the DeH tags.
    elements: dict
    type: list

wait:
    default: true
    description:
    - Should ansible wait until the requested resource is complete.
    type: bool

cloud:
    description:
    - Named cloud or cloud config to operate against. If I(cloud) is a string, it references
      a named cloud config as defined in an OpenStack clouds.yaml file. Provides default
      values for I(auth) and I(auth_type). This parameter is not needed if I(auth) is
      provided or if OpenStack OS_* environment variables are present. If I(cloud) is
      a dict, it contains a complete cloud configuration like would be in a section of
      clouds.yaml.
    type: raw

state:
    choices:
    - present
    - absent
    default: present
    description: Instance state
    type: str

ca_cert:
    aliases:
    - cacert
    description:
    - A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
    type: str

timeout:
    default: 180
    description:
    - How long should ansible wait for the requested resource.
    type: int

quantity:
    default: 1
    description:
    - Number of DeHs to allocate.
    type: int

auth_type:
    description:
    - Name of the auth plugin to use. If the cloud uses something other than password
      authentication, the name of the plugin should be indicated here and the contents
      of the I(auth) parameter should be updated accordingly.
    type: str

host_type:
    description:
    - Specifies the DeH type.
    - Mandatory for DeH creation.
    type: str

interface:
    aliases:
    - endpoint_type
    choices:
    - admin
    - internal
    - public
    default: public
    description:
    - Endpoint URL type to fetch from the service catalog.
    type: str

client_key:
    aliases:
    - key
    description:
    - A path to a client key to use as part of the SSL transaction.
    type: str

api_timeout:
    description:
    - How long should the socket layer wait before timing out for API calls. If this is
      omitted, nothing will be passed to the requests library.
    type: int

client_cert:
    aliases:
    - cert
    description:
    - A path to a client certificate to use as part of the SSL transaction.
    type: str

region_name:
    description:
    - Name of the region.
    type: str

sdk_log_path:
    description:
    - Path to the logfile of the OpenStackSDK. If empty no log is written
    type: str

sdk_log_level:
    choices:
    - ERROR
    - WARN
    - INFO
    - DEBUG
    default: WARN
    description: Log level of the OpenStackSDK
    type: str

auto_placement:
    default: true
    description:
    - Specifies whether to allow an ECS to be placed on any available DeH if
    - its DeH ID is not specified during its creation.
    type: bool

validate_certs:
    aliases:
    - verify
    description:
    - Whether or not SSL API requests should be verified.
    - Before Ansible 2.3 this defaulted to C(yes).
    type: bool

availability_zone:
    description:
    - Specifies the Availability zone to which the Dedicated host belongs.
    - Mandatory for DeH creation.
    type: str

Outputs

deh_host:
  description: Dictionary of DeH host
  returned: changed
  sample:
    deh_host:
      allocated_at: null
      auto_placement: 'true'
      availability_zone: eu-de-01
      available_memory: null
      available_vcpus: null
      dedicated_host_ids:
      - 6d113075-038c-403c-b9cd-fc567f1fd123
      host_properties: null
      host_type: s2-medium
      id: null
      instance_total: null
      instance_uuids: null
      name: deh-host
      project_id: null
      quantity: 1
      released_at: null
      status: null
      tags:
      - key: key1
        value: value1
      - key: key2
        value: value2
  type: dict