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

УСТЕРЕШЕНО
Описание
Требования
Параметры
Примечания
Примеры
Значения возврата
Статус

УСТЕРЕШЕНО

Удалено в Ansible:
	версия: 2.13
Почему:	Преобразован в модуль информации.
Альтернатива:	Используйте cs_instance_info вместо этого.

Описание

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

Требования

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

python >= 2.6
cs >= 0.6.10

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
account строка		Аккаунт, к которому относится экземпляр.
api_http_method строка	Варианты: get post	HTTP-метод, используемый для запроса конечной точки API. Если не указано, используется переменная среды `CLOUDSTACK_METHOD`. В качестве последнего варианта, значение берется из файла конфигурации ini, также см. примечания. Значение по умолчанию `get` если не указано.
api_key строка		API-ключ API CloudStack. Если не указано, используется переменная среды `CLOUDSTACK_KEY`. В качестве последнего варианта, значение берется из файла конфигурации ini, также см. примечания.
api_region строка	Значение по умолчанию: "cloudstack"	Имя раздела ini в файле `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 указывает на файл .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
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 логическое		успех	Истина, если настройка пароля включена. Пример: True
project строка		успех	Название проекта, к которому относится экземпляр. Пример: Production
public_ip строка		успех	Публичный IP-адрес экземпляра через статическое правило NAT. Пример: 1.2.3.4

security_groups список	success	Группа безопасности, в которой находится экземпляр. Пример: [ "default" ]
service_offering строка	success	Имя предложения сервиса, которым обладает экземпляр. Пример: 2cpu_2gb
ssh_key строка	success	Имя SSH-ключа, развернутого на экземпляре. Пример: key@work
state строка	success	Состояние экземпляра. Пример: Запущен
tags список	success	Список тегов ресурсов, связанных с экземпляром. Пример: [ { "key": "foo", "value": "bar" } ]
template строка	success	Имя шаблона, с помощью которого был развернут экземпляр. Пример: Debian-8-64bit
volumes список	success	Список словарей объёмов, подключенных к экземпляру. Пример: [ { name: "ROOT-1369", type: "ROOT", size: 10737418240 }, { name: "data01, type: "DATADISK", size: 10737418240 } ]
zone строка	success	Имя зоны, в которой находится экземпляр. Пример: ch-gva-2

Статус

Этот модуль будет удален в версии 2.13. [устарел]
Для получения дополнительной информации см. УСТАРЕВШЕЕ.

Авторы

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_facts_module.html