opentelekomcloud.cloud.deh_host_info (0.14.2) — module

Get Dedicated host info

| "added in version" 0.1.2 of opentelekomcloud.cloud"

Authors: Tino Schreiber (@tischrei)

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

Get Dedicated host info.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Query all DeH hosts
- opentelekomcloud.cloud.deh_host_info:
    cloud: "{{ test_cloud }}"
  register: deh
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Query specific Dedicated host by ID
- opentelekomcloud.cloud.deh_host_info:
    cloud: "{{ test_cloud }}"
    host: "9b20bd80-c1aa-438c-a499-f5b5308ac123"
  register: deh
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Query DeH hosts with flavor s2-medium
- opentelekomcloud.cloud.deh_host_info:
    cloud: "{{ test_cloud }}"
    host_type: "s2-medium"
  register: deh
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Query all parameters
- opentelekomcloud.cloud.deh_host_info:
    cloud: "{{ test_cloud }}"
    availability_zone: az01
    flavor: s2.medium.8
    instance_uuid: a0c4d7d6-a2ae-4519-92d9-f0780e6f1123
    host: "9b20bd80-c1aa-438c-a499-f5b5308ac123"
    released_at: ""
    tags: [mytag, yourtag]
    host_type: "s2-medium"
    host_type_name: "s2-medium"
  register: deh

Inputs

    
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

host:
    description:
    - Name or ID of the Dedicated host.
    type: str

tags:
    description:
    - Specifies the tags of the Dedicated Host
    elements: str
    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

flavor:
    description:
    - Flavor of the Dedicated host.
    type: str

status:
    choices:
    - available
    - fault
    - released
    description:
    - Specifies the status (state) of the Dedicated Host
    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

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:
    - Type of the dedicated host
    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

released_at:
    description:
    - Specifies the time when the DeH is released.
    type: str

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

changes_since:
    description:
    - Filters the response by date and timestamp when the DeH status
    - changes.
    type: str

instance_uuid:
    description:
    - Specifies the ID of a running VM on this Dedicated host.
    type: str

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

host_type_name:
    description:
    - Specifies the name of the host type.
    type: str

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:
    - Availability zone of the Dedicated host.
    type: str

Outputs

deh_hosts:
  description: Dictionary of DeH hosts
  returned: changed
  sample:
  - allocated_at: '2020-09-30T09:38:15Z'
    auto_placement: 'on'
    availability_zone: az01
    available_memory: 334848
    available_vcpus: 71
    dedicated_host_ids: null
    host_properties:
      available_instance_capacities:
      - flavor: s2.8xlarge.2
        id: null
        location: null
        name: null
      - flavor: s2.8xlarge.1
        id: null
        location: null
        name: null
      cores: 12
      host_type: s2-medium
      host_type_name: s2-medium
      id: null
      location: null
      memory: 335872
      name: null
      sockets: 2
      vcpus: 72
    host_type: null
    id: 9b20bd80-c1aa-438c-a499-f5b5308ac123
    instance_total: 1
    instance_uuids:
    - a0c4d7d6-a2ae-4519-92d9-f0780e6f1123
    name: deh-name
    project_id: 16d53a84a13b49529d2e2c3646691123
    quantity: null
    released_at: ''
    state: available
    tags:
    - mytag: myvalue
      yourtag: yourvalue
  type: list