cs_instance_facts – Сбор фактов из API экземпляров облаков на основе Apache CloudStack.

Новое в версии 2.1.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Обзор

Сбор фактов из API экземпляра.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

python >= 2.6
cs >= 0.6.10

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
account -		Аккаунт, к которому относится экземпляр.
api_http_method -	Варианты: get post	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 -		Проект, к которому относится экземпляр.

Примечания

Примечание

Ansible использует метод конфигурации библиотеки cs если учетные данные не предоставлены аргументами api_url, api_key, api_secret. Конфигурация считывается из нескольких мест в указанном порядке. Переменные среды CLOUDSTACK_ENDPOINT, CLOUDSTACK_KEY, CLOUDSTACK_SECRET и CLOUDSTACK_METHOD. CLOUDSTACK_TIMEOUT Переменная среды, указывающая на файл .ini. Файл 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
  register: vm

- debug:
    var: cloudstack_instance

- debug:
    var: vm

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

Общие возвращаемые значения описаны в здесь, следующие поля уникальны для данного модуля:

Ключ	Возвращаемое значение	Описание
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
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 словарь	успех	Список тегов ресурсов, связанных с экземпляром. Пример: [ { "key": "foo", "value": "bar" } ]
template строка	успех	Имя шаблона, с которым был развернут экземпляр. Пример: Debian-8-64bit
volumes список	успех	Список словарей томов, подключенных к экземпляру. Пример: [ { name: "ROOT-1369", type: "ROOT", size: 10737418240 }, { name: "data01, type: "DATADISK", size: 10737418240 } ]
zone строка	успех	Имя зоны, в которой находится экземпляр. Пример: 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.7/modules/cs_instance_facts_module.html