.. Document meta

:orphan:

.. Anchors

.. _ansible_collections.opentelekomcloud.cloud.deh_server_info_module:

.. Anchors: short name for ansible.builtin

.. Anchors: aliases



.. Title

opentelekomcloud.cloud.deh_server_info -- Get info about ECSs on a Dedicated host
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. Collection note

.. note::
    This plugin is part of the `opentelekomcloud.cloud collection <https://galaxy.ansible.com/opentelekomcloud/cloud>`_ (version 0.9.0).

    To install it use: :code:`ansible-galaxy collection install opentelekomcloud.cloud`.

    To use it in a playbook, specify: :code:`opentelekomcloud.cloud.deh_server_info`.

.. version_added

.. versionadded:: 0.1.2 of opentelekomcloud.cloud

.. contents::
   :local:
   :depth: 1

.. Deprecated


Synopsis
--------

.. Description

- Get info about ECSs on a Dedicated host


.. Aliases


.. Requirements

Requirements
------------
The below requirements are needed on the host that executes this module.

- openstacksdk
- openstacksdk >= 0.36.0
- otcextensions
- python >= 3.6


.. Options

Parameters
----------

.. raw:: html

    <table  border=0 cellpadding=0 class="documentation-table">
        <tr>
            <th colspan="1">Parameter</th>
            <th>Choices/<font color="blue">Defaults</font></th>
                        <th width="100%">Comments</th>
        </tr>
                    <tr>
                                                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-api_timeout"></div>
                    <b>api_timeout</b>
                    <a class="ansibleOptionLink" href="#parameter-api_timeout" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">integer</span>
                                                                    </div>
                                                        </td>
                                <td>
                                                                                                                                                            </td>
                                                                <td>
                                            <div>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.</div>
                                                        </td>
            </tr>
                                <tr>
                                                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-auth"></div>
                    <b>auth</b>
                    <a class="ansibleOptionLink" href="#parameter-auth" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">dictionary</span>
                                                                    </div>
                                                        </td>
                                <td>
                                                                                                                                                            </td>
                                                                <td>
                                            <div>Dictionary containing auth information as needed by the cloud&#x27;s auth plugin strategy. For the default <em>password</em> plugin, this would contain <em>auth_url</em>, <em>username</em>, <em>password</em>, <em>project_name</em> and any information about domains (for example, <em>os_user_domain_name</em> or <em>os_project_domain_name</em>) 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.</div>
                                                        </td>
            </tr>
                                <tr>
                                                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-auth_type"></div>
                    <b>auth_type</b>
                    <a class="ansibleOptionLink" href="#parameter-auth_type" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">string</span>
                                                                    </div>
                                                        </td>
                                <td>
                                                                                                                                                            </td>
                                                                <td>
                                            <div>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 <em>auth</em> parameter should be updated accordingly.</div>
                                                        </td>
            </tr>
                                <tr>
                                                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-ca_cert"></div>
                    <b>ca_cert</b>
                    <a class="ansibleOptionLink" href="#parameter-ca_cert" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">string</span>
                                                                    </div>
                                                        </td>
                                <td>
                                                                                                                                                            </td>
                                                                <td>
                                            <div>A path to a CA Cert bundle that can be used as part of verifying SSL API requests.</div>
                                                                <div style="font-size: small; color: darkgreen"><br/>aliases: cacert</div>
                                    </td>
            </tr>
                                <tr>
                                                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-client_cert"></div>
                    <b>client_cert</b>
                    <a class="ansibleOptionLink" href="#parameter-client_cert" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">string</span>
                                                                    </div>
                                                        </td>
                                <td>
                                                                                                                                                            </td>
                                                                <td>
                                            <div>A path to a client certificate to use as part of the SSL transaction.</div>
                                                                <div style="font-size: small; color: darkgreen"><br/>aliases: cert</div>
                                    </td>
            </tr>
                                <tr>
                                                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-client_key"></div>
                    <b>client_key</b>
                    <a class="ansibleOptionLink" href="#parameter-client_key" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">string</span>
                                                                    </div>
                                                        </td>
                                <td>
                                                                                                                                                            </td>
                                                                <td>
                                            <div>A path to a client key to use as part of the SSL transaction.</div>
                                                                <div style="font-size: small; color: darkgreen"><br/>aliases: key</div>
                                    </td>
            </tr>
                                <tr>
                                                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-cloud"></div>
                    <b>cloud</b>
                    <a class="ansibleOptionLink" href="#parameter-cloud" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">raw</span>
                                                                    </div>
                                                        </td>
                                <td>
                                                                                                                                                            </td>
                                                                <td>
                                            <div>Named cloud or cloud config to operate against. If <em>cloud</em> is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for <em>auth</em> and <em>auth_type</em>. This parameter is not needed if <em>auth</em> is provided or if OpenStack OS_* environment variables are present. If <em>cloud</em> is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml.</div>
                                                        </td>
            </tr>
                                <tr>
                                                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-dedicated_host"></div>
                    <b>dedicated_host</b>
                    <a class="ansibleOptionLink" href="#parameter-dedicated_host" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">string</span>
                                                 / <span style="color: red">required</span>                    </div>
                                                        </td>
                                <td>
                                                                                                                                                            </td>
                                                                <td>
                                            <div>ID of a Dedicated Host</div>
                                                        </td>
            </tr>
                                <tr>
                                                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-interface"></div>
                    <b>interface</b>
                    <a class="ansibleOptionLink" href="#parameter-interface" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">string</span>
                                                                    </div>
                                                        </td>
                                <td>
                                                                                                                            <ul style="margin: 0; padding: 0"><b>Choices:</b>
                                                                                                                                                                <li>admin</li>
                                                                                                                                                                                                <li>internal</li>
                                                                                                                                                                                                <li><div style="color: blue"><b>public</b>&nbsp;&larr;</div></li>
                                                                                    </ul>
                                                                            </td>
                                                                <td>
                                            <div>Endpoint URL type to fetch from the service catalog.</div>
                                                                <div style="font-size: small; color: darkgreen"><br/>aliases: endpoint_type</div>
                                    </td>
            </tr>
                                <tr>
                                                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-region_name"></div>
                    <b>region_name</b>
                    <a class="ansibleOptionLink" href="#parameter-region_name" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">string</span>
                                                                    </div>
                                                        </td>
                                <td>
                                                                                                                                                            </td>
                                                                <td>
                                            <div>Name of the region.</div>
                                                        </td>
            </tr>
                                <tr>
                                                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-timeout"></div>
                    <b>timeout</b>
                    <a class="ansibleOptionLink" href="#parameter-timeout" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">integer</span>
                                                                    </div>
                                                        </td>
                                <td>
                                                                                                                                                                    <b>Default:</b><br/><div style="color: blue">180</div>
                                    </td>
                                                                <td>
                                            <div>How long should ansible wait for the requested resource.</div>
                                                        </td>
            </tr>
                                <tr>
                                                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-validate_certs"></div>
                    <b>validate_certs</b>
                    <a class="ansibleOptionLink" href="#parameter-validate_certs" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">boolean</span>
                                                                    </div>
                                                        </td>
                                <td>
                                                                                                                                                                                                                    <ul style="margin: 0; padding: 0"><b>Choices:</b>
                                                                                                                                                                <li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
                                                                                                                                                                                                <li>yes</li>
                                                                                    </ul>
                                                                            </td>
                                                                <td>
                                            <div>Whether or not SSL API requests should be verified.</div>
                                            <div>Before Ansible 2.3 this defaulted to <code>yes</code>.</div>
                                                                <div style="font-size: small; color: darkgreen"><br/>aliases: verify</div>
                                    </td>
            </tr>
                                <tr>
                                                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-wait"></div>
                    <b>wait</b>
                    <a class="ansibleOptionLink" href="#parameter-wait" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">boolean</span>
                                                                    </div>
                                                        </td>
                                <td>
                                                                                                                                                                                                                    <ul style="margin: 0; padding: 0"><b>Choices:</b>
                                                                                                                                                                <li>no</li>
                                                                                                                                                                                                <li><div style="color: blue"><b>yes</b>&nbsp;&larr;</div></li>
                                                                                    </ul>
                                                                            </td>
                                                                <td>
                                            <div>Should ansible wait until the requested resource is complete.</div>
                                                        </td>
            </tr>
                        </table>
    <br/>

.. Notes

Notes
-----

.. note::
   - The standard OpenStack environment variables, such as ``OS_USERNAME`` may be used instead of providing explicit values.
   - Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at https://docs.openstack.org/openstacksdk/

.. Seealso


.. Examples

Examples
--------

.. code-block:: yaml+jinja

    
    # Query all ECSs on DeH host
    - opentelekomcloud.cloud.deh_server_info:
        dedicated_host: 123456-host-id
      register: server




.. Facts


.. Return values

Return Values
-------------
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:

.. raw:: html

    <table border=0 cellpadding=0 class="documentation-table">
        <tr>
            <th colspan="1">Key</th>
            <th>Returned</th>
            <th width="100%">Description</th>
        </tr>
                    <tr>
                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="return-deh_servers"></div>
                    <b>deh_servers</b>
                    <a class="ansibleOptionLink" href="#return-deh_servers" title="Permalink to this return value"></a>
                    <div style="font-size: small">
                      <span style="color: purple">list</span>
                       / <span style="color: purple">elements=string</span>                    </div>
                                    </td>
                <td>changed</td>
                <td>
                                            <div>Dictionary of ECSs on a Dedicated host</div>
                                        <br/>
                                            <div style="font-size: smaller"><b>Sample:</b></div>
                                                <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">[{&#x27;addresses&#x27;: {&#x27;26ca2783-dc40-4e3a-95b1-5a0756441123&#x27;: [{&#x27;OS-EXT-IPS-MAC:mac_addr&#x27;: &#x27;fa:16:3e:3d:b0:d3&#x27;, &#x27;OS-EXT-IPS:type&#x27;: &#x27;fixed&#x27;, &#x27;addr&#x27;: &#x27;192.168.0.16&#x27;, &#x27;version&#x27;: 4}, {&#x27;OS-EXT-IPS-MAC:mac_addr&#x27;: &#x27;fa:16:3e:3d:b0:d3&#x27;, &#x27;OS-EXT-IPS:type&#x27;: &#x27;floating&#x27;, &#x27;addr&#x27;: &#x27;100.74.198.155&#x27;, &#x27;version&#x27;: 4}]}, &#x27;created_at&#x27;: &#x27;2020-09-30T09:59:01Z&#x27;, &#x27;flavor&#x27;: {&#x27;disk&#x27;: 0, &#x27;ephemeral&#x27;: 0, &#x27;extra_specs&#x27;: {&#x27;cond:compute&#x27;: &#x27;autorecovery&#x27;, &#x27;cond:operation:az&#x27;: &#x27;az01(normal),az02(normal),az03(normal)&#x27;, &#x27;cond:operation:status&#x27;: &#x27;abandon&#x27;, &#x27;ecs:generation&#x27;: &#x27;s3&#x27;, &#x27;ecs:performancetype&#x27;: &#x27;normal&#x27;, &#x27;ecs:virtualization_env_types&#x27;: &#x27;CloudCompute&#x27;, &#x27;hw:cpu_cores&#x27;: &#x27;1&#x27;, &#x27;hw:cpu_sockets&#x27;: &#x27;1&#x27;, &#x27;hw:cpu_threads&#x27;: &#x27;1&#x27;, &#x27;hw:numa_nodes&#x27;: &#x27;1&#x27;, &#x27;quota:conn_limit_total&#x27;: &#x27;1000000&#x27;, &#x27;quota:disk_max_num&#x27;: &#x27;60&#x27;, &#x27;quota:max_pps&#x27;: &#x27;50000&#x27;, &#x27;quota:max_rate&#x27;: &#x27;500&#x27;, &#x27;quota:min_rate&#x27;: &#x27;100&#x27;, &#x27;quota:physics_max_rate&#x27;: &#x27;13500&#x27;, &#x27;quota:scsi_disk_max_num&#x27;: &#x27;60&#x27;, &#x27;quota:vbd_disk_max_num&#x27;: &#x27;24&#x27;, &#x27;quota:vif_max_num&#x27;: &#x27;12&#x27;, &#x27;quota:vif_multiqueue_num&#x27;: &#x27;1&#x27;, &#x27;resource_type&#x27;: &#x27;IOoptimizedS2&#x27;, &#x27;sched:policy&#x27;: &#x27;flat_balance&#x27;}, &#x27;id&#x27;: &#x27;s2.medium.1&#x27;, &#x27;original_name&#x27;: &#x27;s2.medium.1&#x27;, &#x27;ram&#x27;: 1024, &#x27;swap&#x27;: 0, &#x27;vcpus&#x27;: 1}, &#x27;id&#x27;: &#x27;a0c4d7d6-a2ae-4519-92d9-f0780e6f1123&#x27;, &#x27;metadata&#x27;: {&#x27;cascaded.instance_extrainfo&#x27;: &#x27;pcibridge:1&#x27;, &#x27;charging_mode&#x27;: &#x27;0&#x27;, &#x27;image_name&#x27;: &#x27;Standard_Ubuntu_20.04_latest&#x27;, &#x27;metering.cloudServiceType&#x27;: &#x27;sys.service.type.ec2&#x27;, &#x27;metering.image_id&#x27;: &#x27;c8983e9e-1dda-479a-9a95-b41fe325a123&#x27;, &#x27;metering.imagetype&#x27;: &#x27;gold&#x27;, &#x27;metering.resourcespeccode&#x27;: &#x27;deh.linux&#x27;, &#x27;metering.resourcetype&#x27;: &#x27;1&#x27;, &#x27;os_bit&#x27;: &#x27;64&#x27;, &#x27;os_type&#x27;: &#x27;Linux&#x27;, &#x27;vpc_id&#x27;: &#x27;26ca2783-dc40-4e3a-95b1-5a0756441123&#x27;}, &#x27;name&#x27;: &#x27;my-ecs-on-deh&#x27;, &#x27;status&#x27;: &#x27;ACTIVE&#x27;, &#x27;tenant_id&#x27;: &#x27;16d53a84a13b49529d2e2c3646691123&#x27;, &#x27;updated_at&#x27;: &#x27;2020-09-30T09:59:15Z&#x27;, &#x27;user_id&#x27;: &#x27;18569c6d589c4be3a300b6401c74d123&#x27;}]</div>
                                    </td>
            </tr>
                        </table>
    <br/><br/>

..  Status (Presently only deprecated)


.. Authors

Authors
~~~~~~~

- Tino Schreiber (@tischrei)



.. Parsing errors

