cs_instance_info – Сбор информации из API экземпляров облаков на основе Apache CloudStack
Новая версия 2.9.
Обзор
- Сбор информации из API экземпляра.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- cs >= 0.6.10
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| account строка | Аккаунт, к которому относится экземпляр. | |
| api_http_method строка |
| HTTP-метод, используемый для запроса к API-точке. Если не указано, используется значение переменной среды CLOUDSTACK_METHOD. В качестве последнего варианта, значение берется из файла конфигурации ini, см. также примечания. Значение по умолчанию get, если не указано. |
| api_key строка | Ключ API CloudStack API. Если не указано, используется значение переменной среды CLOUDSTACK_KEY. В качестве последнего варианта, значение берется из файла конфигурации ini, см. также примечания. | |
| api_region строка | По умолчанию: "cloudstack" | Имя раздела ini в файле cloustack.ini. Если не указано, используется значение переменной среды CLOUDSTACK_REGION. |
| api_secret строка | Секретный ключ CloudStack API. Если не задано, используется значение переменной среды CLOUDSTACK_SECRET. В качестве последнего варианта, значение берется из файла конфигурации ini, см. также примечания. | |
| api_timeout целое число | Таймаут HTTP в секундах. Если не указано, используется значение переменной среды CLOUDSTACK_TIMEOUT. В качестве последнего варианта, значение берется из файла конфигурации ini, см. также примечания. Значение по умолчанию 10 секунд, если не указано. | |
| api_url строка | URL CloudStack API, например, https://cloud.example.com/client/api. Если не указано, используется значение переменной среды CLOUDSTACK_ENDPOINT. В качестве последнего варианта, значение берется из файла конфигурации ini, см. также примечания. | |
| domain строка | Домен, к которому относится экземпляр. | |
| name строка | Имя или отображаемое имя экземпляра. Если не указано, возвращаются все экземпляры. | |
| project строка | Проект, к которому относится экземпляр. |
Примечания
Примечание
- Если учетные данные не предоставлены аргументами
api_url,api_key,api_secret, Ansible использует метод конфигурации библиотекиcs. Конфигурация читается из нескольких источников в следующем порядке. Переменные средыCLOUDSTACK_ENDPOINT,CLOUDSTACK_KEY,CLOUDSTACK_SECRETиCLOUDSTACK_METHOD. Переменная средыCLOUDSTACK_CONFIGуказывает на файл.ini. Файлcloudstack.iniв текущей рабочей директории. Файл.cloudstack.iniв домашней директории пользователя. Допускается указание нескольких учетных данных и конечных точек с помощью разделов ini в файлеcloudstack.ini. Используйте аргументapi_regionдля выбора имени раздела, по умолчанию используется разделcloudstack. Более подробная информация доступна на странице https://github.com/exoscale/cs. - Подробное руководство по модулям cloudstack можно найти в руководстве по облаку CloudStack CloudStack Cloud Guide.
- Этот модуль поддерживает режим проверки.
Примеры
- name: Gather instance information
cs_instance_info:
name: web-vm-1
delegate_to: localhost
register: vm
- name: Show the returned results of the registered variable
debug:
msg: "{{ vm }}"
- name: Gather information from all instances
cs_instance_info:
delegate_to: localhost
register: vms
- name: Show information on all instances
debug:
msg: "{{ vms }}"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| 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 строка добавлено в 2.6 | успех и экземпляр запущен | Хост, на котором запущен экземпляр. Пример: 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 сложный добавлено в 2.8 | успех | Список словарей сетевых интерфейсов экземпляра. | ||
| 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 boolean | success | Истинно, если настройка пароля включена. Пример: True | ||
| project string | success | Имя проекта, к которому относится экземпляр. Пример: Production | ||
| public_ip string | success | Общедоступный IP-адрес экземпляра через статическое правило NAT. Пример: 1.2.3.4 | ||
| security_groups list | success | Группы безопасности, в которых находится экземпляр. Пример: [ "default" ] | ||
| service_offering string | success | Имя предлагаемого сервиса, которым обладает экземпляр. Пример: 2cpu_2gb | ||
| ssh_key string | success | Имя развернутого SSH-ключа на экземпляре. Пример: key@work | ||
| state string | success | Состояние экземпляра. Пример: Запущен | ||
| tags list | success | Список тегов ресурсов, связанных с экземпляром. Пример: [ { "key": "foo", "value": "bar" } ] | ||
| template string | success | Имя шаблона, с помощью которого был развернут экземпляр. Пример: Debian-8-64bit | ||
| volumes list | success | Список словарей объёмов, подключенных к экземпляру. Пример: [ { name: "ROOT-1369", type: "ROOT", size: 10737418240 }, { name: "data01, type: "DATADISK", size: 10737418240 } ] | ||
| zone string | success | Имя зоны, в которой находится экземпляр. Пример: ch-gva-2 | ||
Статус
- В данном модуле гарантируются изменения интерфейса, совместимые с предыдущими версиями. [stableinterface]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- René Moser (@resmo)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/cs_instance_info_module.html
