cs_instance_facts – Сбор фактов об экземплярах из облаков на основе 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 строка		Проект, к которому относится экземпляр.

Примечания

Примечание

Если учетные данные не предоставлены аргументами api_url, api_key, api_secret, Ansible использует метод конфигурации библиотеки cs. Конфигурация считывается из нескольких источников в указанном порядке: CLOUDSTACK_ENDPOINT, CLOUDSTACK_KEY, CLOUDSTACK_SECRET и CLOUDSTACK_METHOD. Переменные среды CLOUDSTACK_TIMEOUT. Переменная среды CLOUDSTACK_CONFIG, указывающая на файл .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 строка		успех	Аккаунт, к которому относится экземпляр. Пример: примерный аккаунт
affinity_groups список		успех	Группы сродства, в которых находится экземпляр. Пример: [ "webсерверы" ]
created строка		успех	Дата создания экземпляра. Пример: 2014-12-01T14:57:57+0100
default_ip строка		успех	Основной IP-адрес экземпляра. Пример: 10.23.37.42
display_name строка		успех	Имя для отображения экземпляра. Пример: web-01
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 логическое значение	успех	Истинно, если сетевой интерфейс является основным, ложно в противном случае. Пример: Истина
	isolationuri строка	успех	URI изоляции сетевого интерфейса. Пример: vlan://2250
	macaddress строка	успех	MAC-адрес сетевого интерфейса. Пример: 06:a2:03:00:08:12
	netmask строка	успех	Маска подсети сетевого интерфейса. Пример: 255.255.255.0
	networkid строка	успех	Идентификатор соответствующей сети. Пример: 432ce27b-c2bb-4e12-a88c-a919cd3a3017
	networkname строка	успех	Имя соответствующей сети. Пример: сеть1
	traffictype строка	успех	Тип трафика сетевого интерфейса. Пример: Гость
	type строка	успех	Тип сети. Пример: Общий
password строка		успех	Пароль экземпляра, если он существует. Пример: Ge2oe7Do
password_enabled логическое значение		успех	Истина, если настройка пароля включена. Пример: Истина
project строка		успех	Имя проекта, к которому относится экземпляр. Пример: Производство
public_ip строка		успех	Публичный IP-адрес экземпляра через статическое правило NAT. Пример: 1.2.3.4
security_groups список		успех	Группы безопасности, в которых находится экземпляр. Пример: [ "по умолчанию" ]
service_offering строка		успех	Имя предложения услуг, которым обладает экземпляр. Пример: 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.8/modules/cs_instance_facts_module.html