cs_instance_facts - Сбор фактов из API экземпляров облаков на базе Apache CloudStack.
Новое в версии 2.1.
Обзор
- Сбор фактов из API экземпляра.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- cs >= 0.6.10
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| account | Аккаунт, к которому относится экземпляр. | |
| api_http_method |
| HTTP-метод, используемый для запроса к API-точке. Если не указано, используется значение переменной среды CLOUDSTACK_METHOD. В качестве последнего варианта, значение берется из файла конфигурации ini, см. также примечания. Значение по умолчанию — get, если не указано. |
| api_key | API-ключ API CloudStack. Если не указано, используется значение переменной среды CLOUDSTACK_KEY. В качестве последнего варианта, значение берется из файла конфигурации ini, см. также примечания. | |
| api_region | Значение по умолчанию: cloudstack | Имя раздела в файле конфигурации cloustack.ini. Если не указано, используется значение переменной среды CLOUDSTACK_REGION. |
| api_secret | Секретный ключ API CloudStack. Если не указано, используется значение переменной среды CLOUDSTACK_SECRET. В качестве последнего варианта, значение берется из файла конфигурации ini, см. также примечания. | |
| api_timeout | Таймаут HTTP в секундах. Если не указано, используется значение переменной среды CLOUDSTACK_TIMEOUT. В качестве последнего варианта, значение берется из файла конфигурации ini, см. также примечания. Значение по умолчанию — 10 секунд, если не указано. | |
| api_url | URL API CloudStack, например, https://cloud.example.com/client/api. Если не указано, используется значение переменной среды CLOUDSTACK_ENDPOINT. В качестве последнего варианта, значение берется из файла конфигурации ini, см. также примечания. | |
| domain | Домен, к которому относится экземпляр. | |
| name обязательно | Имя или отображаемое имя экземпляра. | |
| project | Проект, к которому относится экземпляр. |
Примечания
Примечание
- Ansible использует метод конфигурации библиотеки
cs, если учетные данные не предоставлены аргументамиapi_url,api_key,api_secret. Конфигурация считывается из нескольких мест в следующем порядке. Переменные средыCLOUDSTACK_ENDPOINT,CLOUDSTACK_KEY,CLOUDSTACK_SECRETиCLOUDSTACK_METHOD. Переменная средыCLOUDSTACK_TIMEOUTуказывающая на файлCLOUDSTACK_CONFIG. Файлcloudstack.iniв текущей рабочей директории. Файл.cloudstack.iniв домашней директории пользователя. Допускается указание нескольких учетных данных и конечных точек с помощью разделов ini в файлеcloudstack.ini. Используйте аргументapi_regionдля выбора имени раздела, раздел по умолчанию —cloudstack. Дополнительную информацию см. на странице https://github.com/exoscale/cs. - Подробное руководство по модулям cloudstack можно найти в руководстве по облаку CloudStack.
- Этот модуль поддерживает режим проверки.
Примеры
- name: gather instance facts
cs_instance_facts:
name: web-vm-1
delegate_to: localhost
- debug:
var: cloudstack_instance
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращённое значение | Описание |
|---|---|---|
| cloudstack_instance.account строка | успех | Аккаунт, к которому относится виртуальная машина. Пример: example account |
| cloudstack_instance.affinity_groups список | успех | Группы родства, к которым относится виртуальная машина. Пример: [ "webservers" ] |
| cloudstack_instance.default_ip строка | успех | Основной IP-адрес виртуальной машины. Пример: 10.23.37.42 |
| cloudstack_instance.display_name строка | успех | Отображаемое имя виртуальной машины. Пример: web-01 |
| cloudstack_instance.domain строка | успех | Домен, к которому относится виртуальная машина. Пример: example domain |
| cloudstack_instance.group строка | успех | Имя группы, к которой относится виртуальная машина. Пример: web |
| cloudstack_instance.hypervisor строка | успех | Гипервизор, связанный с этой виртуальной машиной. Пример: KVM |
| cloudstack_instance.id строка | успех | UUID виртуальной машины. Пример: 04589590-ac63-4ffc-93f5-b698b8ac38b6 |
| cloudstack_instance.instance_name строка | успех | Внутреннее имя виртуальной машины (только для администратора ROOT). Пример: i-44-3992-VM |
| cloudstack_instance.iso строка | успех | Имя ISO, с которым была развернута виртуальная машина. Пример: Debian-8-64bit |
| cloudstack_instance.name строка | успех | Имя виртуальной машины. Пример: web-01 |
| cloudstack_instance.password строка | успех | Пароль виртуальной машины, если он существует. Пример: Ge2oe7Do |
| cloudstack_instance.password_enabled логическое | успех | Истина, если настройка пароля включена. Пример: True |
| cloudstack_instance.project строка | успех | Название проекта, к которому относится виртуальная машина. Пример: Production |
| cloudstack_instance.public_ip строка | успех | Публичный IP-адрес виртуальной машины через статическое правило NAT. Пример: 1.2.3.4 |
| cloudstack_instance.security_groups список | успех | Группы безопасности, к которым относится виртуальная машина. Пример: [ "default" ] |
| cloudstack_instance.service_offering строка | успех | Название предложения сервиса, которым обладает виртуальная машина. Пример: 2cpu_2gb |
| cloudstack_instance.ssh_key строка | успех | Имя SSH-ключа, развернутого для виртуальной машины. Пример: key@work |
| cloudstack_instance.state строка | успех | Состояние виртуальной машины. Пример: Запущенная |
| cloudstack_instance.tags словарь | успех | Список тегов ресурсов, связанных с виртуальной машиной. Пример: [ { "key": "foo", "value": "bar" } ] |
| cloudstack_instance.template строка | успех | Имя шаблона, с которым была развернута виртуальная машина. Пример: Debian-8-64bit |
| cloudstack_instance.volumes список | успех | Список словарей томов, подключенных к виртуальной машине. Пример: [ { name: "ROOT-1369", type: "ROOT", size: 10737418240 }, { name: "data01, type: "DATADISK", size: 10737418240 } ] |
| cloudstack_instance.zone строка | успех | Имя зоны, в которой находится виртуальная машина. Пример: ch-gva-2 |
| created строка | успех | Дата создания виртуальной машины. Пример: 2014-12-01T14:57:57+0100 |
Статус
Этот модуль помечен как stableinterface, что означает, что разработчики этого модуля гарантируют, что не будет вноситься обратной совместимости с изменениями интерфейса.
Автор
- 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.5/modules/cs_instance_facts_module.html