ngine_io.cloudstack.cs_instance_info – Сбор информации из API экземпляров из облаков на основе Apache CloudStack.
Примечание
Этот плагин входит в коллекцию ngine_io.cloudstack (версия 2.0.0).
Для его установки используйте: ansible-galaxy collection install ngine_io.cloudstack.
Для использования в книге задач укажите: ngine_io.cloudstack.cs_instance_info.
Новое в версии 0.1.0: плагина ngine_io.cloudstack
Обзор
- Сбор информации из API экземпляра.
Требования
Ниже приведены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- cs >= 0.9.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| account строка | Аккаунт, к которому относится экземпляр. | |
| api_http_method строка |
| HTTP-метод, используемый для запроса к API-точке. Если не указан, используется переменная среды CLOUDSTACK_METHOD. |
| api_key строка / обязательно | API-ключ API CloudStack. Если не указан, используется переменная среды CLOUDSTACK_KEY. | |
| api_secret строка / обязательно | Секретный ключ API CloudStack. Если не задан, используется переменная среды CLOUDSTACK_SECRET. | |
| api_timeout целое число | Значение по умолчанию: 10 | Таймаут HTTP в секундах. Если не указан, используется переменная среды CLOUDSTACK_TIMEOUT. |
| api_url строка / обязательно | URL API CloudStack, например, https://cloud.example.com/client/api. Если не указан, используется переменная среды CLOUDSTACK_ENDPOINT. | |
| api_verify_ssl_cert строка | Проверка сертификата CA. Если не указан, используется переменная среды CLOUDSTACK_VERIFY. | |
| domain строка | Домен, к которому относится экземпляр. | |
| name строка | Имя или отображаемое имя экземпляра. Если не указано, возвращаются все экземпляры. | |
| project строка | Проект, к которому относится экземпляр. |
Примечания
Примечание
- Подробное руководство по модулям cloudstack можно найти в Руководстве по облакам CloudStack.
- Этот модуль поддерживает режим проверки.
Примеры
- name: Gather instance information
ngine_io.cloudstack.cs_instance_info:
name: web-vm-1
register: vm
- name: Show the returned results of the registered variable
debug:
msg: "{{ vm }}"
- name: Gather information from all instances
ngine_io.cloudstack.cs_instance_info:
register: vms
- name: Show information on all instances
debug:
msg: "{{ vms }}"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
END_OF_DOCUMENT_MARKER| Ключ | Возвращено | Описание | ||
|---|---|---|---|---|
| instances список / элементы=строка | успех | Список совпадающих экземпляров. | ||
| account строка | успех | Аккаунт, к которому относится экземпляр. Пример: example account | ||
| affinity_groups список / элементы=строка | успех | Группы сродства, в которых находится экземпляр. Пример: [ "webservers" ] | ||
| created строка | успех | Дата создания экземпляра. Пример: 2014-12-01T14:57:57+0100 | ||
| default_ip строка | успех | Основной IP-адрес экземпляра. Пример: 10.23.37.42 | ||
| display_name строка | успех | Имя отображения экземпляра. Пример: web-01 | ||
| domain строка | успех | Домен, к которому относится экземпляр. Пример: example domain | ||
| group строка | успех | Имя группы, к которой относится экземпляр. Пример: web | ||
| host строка | успех и экземпляр запущен | Хост, на котором запущен экземпляр. Пример: host01.example.com | ||
| hypervisor строка | успех | Гипервизор, связанный с этим экземпляром. Пример: KVM | ||
| id строка | успех | UUID экземпляра. Пример: 04589590-ac63-4ffc-93f5-b698b8ac38b6 | ||
| instance_name строка | успех | Внутреннее имя экземпляра (только для ROOT администратора). Пример: i-44-3992-VM | ||
| iso строка | успех | Имя ISO, с которым был развернут экземпляр. Пример: Debian-8-64bit | ||
| name строка | успех | Имя экземпляра. Пример: web-01 | ||
| nic сложный | успех | Список словарей сетевых адаптеров экземпляра. | ||
| broadcasturi строка | успех | URI широковещательной передачи сетевого адаптера. Пример: vlan://2250 | ||
| gateway строка | успех | Шлюз сетевого адаптера. Пример: 10.1.2.1 | ||
| id строка | успех | Идентификатор сетевого адаптера. Пример: 5dc74fa3-2ec3-48a0-9e0d-6f43365336a9 | ||
| ipaddress строка | успех | IP-адрес сетевого адаптера. Пример: 10.1.2.3 | ||
| isdefault булево | успех | Истина, если сетевой адаптер является основным, ложь в противном случае. Пример: True | ||
| isolationuri строка | успех | URI изоляции сетевого адаптера. Пример: vlan://2250 | ||
| macaddress строка | успех | MAC-адрес сетевого адаптера. Пример: 06:a2:03:00:08:12 | ||
| netmask строка | успех | Маска подсети сетевого адаптера. Пример: 255.255.255.0 | ||
| networkid строка | успех | Идентификатор соответствующей сети. Пример: 432ce27b-c2bb-4e12-a88c-a919cd3a3017 | ||
| networkname строка | успех | Имя соответствующей сети. Пример: network1 | ||
| traffictype строка | успех | Тип трафика сетевого адаптера. Пример: Guest | ||
| type строка | успех | Тип сети. Пример: Shared | ||
| password строка | успех | Пароль экземпляра, если он есть. Пример: Ge2oe7Do | ||
| password_enabled булево | успех | Истина, если настройка пароля включена. Пример: True | ||
| project строка | успех | Имя проекта, к которому относится экземпляр. Пример: Production | ||
| public_ip строка | успех | Публичный IP-адрес экземпляра через статическое правило NAT. Пример: 1.2.3.4 | ||
| security_groups список / элементы=строка | успех | Безопасные группы, к которым принадлежит экземпляр. Пример: [ "default" ] | ||
| service_offering строка | успех | Имя предлагаемой услуги, которая имеется у экземпляра. Пример: 2cpu_2gb | ||
| ssh_key строка | успех | Имя SSH-ключа, развернутого на экземпляре. Пример: key@work | ||
| state строка | успех | Состояние экземпляра. Пример: Запущен | ||
| tags список / элементы=строка | успех | Список тегов ресурсов, связанных с экземпляром. Пример: [ { "ключ": "foo", "значение": "bar" } ] | ||
| template строка | успех | Имя шаблона, с которым был развернут экземпляр. Пример: Debian-8-64bit | ||
| volumes список / элементы=строка | успех | Список словарей томов, подключенных к экземпляру. Пример: [ { name: "ROOT-1369", type: "ROOT", size: 10737418240 }, { name: "data01, type: "DATADISK", size: 10737418240 } ] | ||
| zone строка | успех | Имя зоны, в которой находится экземпляр. Пример: ch-gva-2 | ||
Авторы
- René Moser (@resmo)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ngine_io/cloudstack/cs_instance_info_module.html
