ngine_io.cloudstack.api lookup — взаимодействие с Cloudstack API с помощью lookup

Примечание

Этот плагин lookup входит в состав коллекции ngine_io.cloudstack (версия 3.0.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install ngine_io.cloudstack. Для работы с этим плагином lookup необходимы дополнительные требования. Подробнее см. в разделе Требования.

Чтобы использовать его в playbook, укажите: ngine_io.cloudstack.api.

Краткое описание
Требования
Аргументы
Параметры-ключевые слова
Примечания
Примеры
Возвращаемое значение

Краткое описание

Возвращает результаты GET-запросов к Cloudstack API.

Требования

Следующие требования необходимы на локальном узле контроллера, который выполняет этот lookup.

Нет
cs >= 0.9.0
python >= 2.6

Аргументы

Параметр	Комментарии
Аргументы string / обязательный	Конечная точка для запроса, например listUserData, listVirtualMachines и т. д.

Параметры-ключевые слова

Здесь описаны параметры-ключевые слова lookup. Это значения key1=value1, key2=value2 и т. д. в следующих примерах: lookup('ngine_io.cloudstack.api', key1=value1, key2=value2, ...) и query('ngine_io.cloudstack.api', key1=value1, key2=value2, ...)

Параметр	Комментарии
api_http_method string	Метод HTTP, используемый для запроса конечной точки API. Если параметр не задан, используется переменная окружения `CLOUDSTACK_METHOD`. Варианты: `"get"` ← (по умолчанию) `"post"`
api_key string / обязательный	Ключ API CloudStack. Если параметр не задан, используется переменная окружения `CLOUDSTACK_KEY`.
api_secret string / обязательный	Секретный ключ API CloudStack. Если параметр не задан, используется переменная окружения `CLOUDSTACK_SECRET`.
api_timeout integer	Тайм-аут HTTP в секундах. Если параметр не задан, используется переменная окружения `CLOUDSTACK_TIMEOUT`. По умолчанию: `10`
api_url string / обязательный	URL API CloudStack, например https://cloud.example.com/client/api. Если параметр не задан, используется переменная окружения `CLOUDSTACK_ENDPOINT`.
api_verify_ssl_cert string	Проверять файл сертификата центра сертификации. Если параметр не задан, используется переменная окружения `CLOUDSTACK_VERIFY`.
query_params dictionary	Параметры запроса для поиска в виде пар ключ/значение.
validate_certs boolean добавлено в ngine_io.cloudstack 2.4.0	Если задано `false`, сертификаты SSL не будут проверяться. Если параметр не задан, используется переменная окружения `CLOUDSTACK_DANGEROUS_NO_TLS_VERIFY`. Используйте этот параметр только на сайтах под вашим личным контролем, где применяются самоподписанные сертификаты. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

При совместном использовании параметров-ключевых слов и позиционных параметров позиционные параметры необходимо указывать перед параметрами-ключевыми словами: lookup('ngine_io.cloudstack.api', term1, term2, key1=value1, key2=value2) и query('ngine_io.cloudstack.api', term1, term2, key1=value1, key2=value2)
Если запрос отфильтрован неправильно, это может снизить производительность.
Подробное руководство по модулям CloudStack см. в руководстве по облаку CloudStack.
Этот модуль поддерживает режим проверки.

Примеры

- name: List all UserData from the API
  set_fact:
    controller_settings: "{{ lookup('ngine_io.cloudstack.api', 'listUserData', query_params={ 'listall': true }) }}"

- name: List all Virtual Machines from the API
  set_fact:
    virtual_machines: "{{ lookup('ngine_io.cloudstack.api', 'listVirtualMachines') }}"

- name: List specific Virtual Machines from the API
  set_fact:
    virtual_machines: "{{ lookup('ngine_io.cloudstack.api', 'listVirtualMachines', query_params={ 'name': 'myvmname' }) }}"

Возвращаемое значение

Ключ	Описание
Возвращаемое значение dictionary	Ответ API Возвращается: при успешном запросе

Авторы

Lorenzo Tanganelli (@tanganellilore)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/ngine_io/cloudstack/api_lookup.html