Модуль ngine_io.cloudstack.cs_instance_info – Сбор информации из API экземпляров из облаков на основе Apache CloudStack.

Примечание

Этот модуль является частью коллекции ngine_io.cloudstack (версия 2.5.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install ngine_io.cloudstack. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.

Для использования в playbook, укажите: ngine_io.cloudstack.cs_instance_info.

Новое в ngine_io.cloudstack 0.1.0

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

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

Псевдонимы: cs_instance_facts

Требования

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

python >= 2.6
cs >= 0.9.0

Параметры

Параметр	Комментарии
account string	Учетная запись, с которой связан экземпляр.
api_http_method string	HTTP-метод, используемый для запроса к конечному API-адресу. Если не указан, используется переменная окружения `CLOUDSTACK_METHOD`. Варианты: `"get"` ← (по умолчанию) `"post"`
api_key string / обязательно	API-ключ API CloudStack. Если не указан, используется переменная окружения `CLOUDSTACK_KEY`.
api_secret string / обязательно	Секретный ключ API CloudStack. Если не установлен, используется переменная окружения `CLOUDSTACK_SECRET`.
api_timeout integer	Таймаут HTTP в секундах. Если не указан, используется переменная окружения `CLOUDSTACK_TIMEOUT`. По умолчанию: `10`
api_url string / обязательно	URL API CloudStack, например https://cloud.example.com/client/api. Если не указан, используется переменная окружения `CLOUDSTACK_ENDPOINT`.
api_verify_ssl_cert string	Проверить файл сертификата центра сертификации. Если не указан, используется переменная окружения `CLOUDSTACK_VERIFY`.
domain string	Домен, с которым связан экземпляр.
host string добавлено в ngine_io.cloudstack 2.2.0	Фильтр по имени хоста.
name string	Имя или отображаемое имя экземпляра. Если не указано, возвращаются все экземпляры
project string	Проект, с которым связан экземпляр.
validate_certs boolean добавлено в ngine_io.cloudstack 2.4.0	Если `false`, SSL-сертификаты проверяться не будут. Если не указано, используется переменная окружения `CLOUDSTACK_DANGEROUS_NO_TLS_VERIFY`. Это следует использовать только на лично контролируемых сайтах, использующих самоподписанные сертификаты. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Подробное руководство по модулям cloudstack можно найти в CloudStack Cloud Guide.
Этот модуль поддерживает режим проверки.

Примеры

- name: Gather instance information
  ngine_io.cloudstack.cs_instance_info:
    name: web-vm-1
  register: vm

- name: Show the returned results of the registered variable
  debug:
    msg: "{{ vm }}"

- name: Gather information from all instances
  ngine_io.cloudstack.cs_instance_info:
  register: vms

- name: Show information on all instances
  debug:
    msg: "{{ vms }}"

- name: Gather information from all instances on a host
  ngine_io.cloudstack.cs_instance_info:
    host: host01.example.com
  register: vms

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

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

Ключ	Описание
instances list / elements=string	Список совпадающих экземпляров. Возвращается: успех
account string	Учетная запись, к которой относится экземпляр. Возвращается: успех Пример: `"example account"`
affinity_groups list / elements=string	Группы сродства, в которых находится экземпляр. Возвращается: успех Пример: `["[ \"webservers\" ]"]`
created string	Дата создания экземпляра. Возвращается: успех Пример: `"2014-12-01T14:57:57+0100"`
default_ip string	IP-адрес по умолчанию экземпляра. Возвращается: успех Пример: `"10.23.37.42"`
display_name string	Отображаемое имя экземпляра. Возвращается: успех Пример: `"web-01"`
domain string	Домен, к которому относится экземпляр. Возвращается: успех Пример: `"example domain"`
group string	Имя группы, к которой относится экземпляр. Возвращается: успех Пример: `"web"`
host string	Хост, на котором работает экземпляр. Возвращается: успех и экземпляр запущен Пример: `"host01.example.com"`
hypervisor string	Гипервизор, связанный с этим экземпляром. Возвращается: успех Пример: `"KVM"`
id string	UUID экземпляра. Возвращается: успех Пример: `"04589590-ac63-4ffc-93f5-b698b8ac38b6"`
instance_name string	Внутреннее имя экземпляра (только для ROOT-администратора). Возвращается: успех Пример: `"i-44-3992-VM"`
iso string	Имя ISO, с которым был развернут экземпляр. Возвращается: успех Пример: `"Debian-8-64bit"`
name string	Имя экземпляра. Возвращается: успех Пример: `"web-01"`
nic complex	Список словарей сетевых интерфейсов экземпляра. Возвращается: успех
broadcasturi string	Broadcast URI сетевого интерфейса. Возвращается: успех Пример: `"vlan://2250"`
gateway string	Шлюз сетевого интерфейса. Возвращается: успех Пример: `"10.1.2.1"`
id string	ID сетевого интерфейса. Возвращается: успех Пример: `"5dc74fa3-2ec3-48a0-9e0d-6f43365336a9"`
ipaddress string	IP-адрес сетевого интерфейса. Возвращается: успех Пример: `"10.1.2.3"`
isdefault boolean	True, если сетевой интерфейс является основным, false в противном случае. Возвращается: успех Пример: `true`
isolationuri string	Isolation URI сетевого интерфейса. Возвращается: успех Пример: `"vlan://2250"`
macaddress string	MAC-адрес сетевого интерфейса. Возвращается: успех Пример: `"06:a2:03:00:08:12"`

netmask string	Маска подсети для сетевого интерфейса. Возвращено: success Пример: `"255.255.255.0"`
networkid string	Идентификатор соответствующей сети. Возвращено: success Пример: `"432ce27b-c2bb-4e12-a88c-a919cd3a3017"`
networkname string	Имя соответствующей сети. Возвращено: success Пример: `"network1"`
traffictype string	Тип трафика сетевого интерфейса. Возвращено: success Пример: `"Guest"`
type string	Тип сети. Возвращено: success Пример: `"Shared"`
password string	Пароль экземпляра, если существует. Возвращено: success Пример: `"Ge2oe7Do"`
password_enabled boolean	True, если настройка пароля включена. Возвращено: success Пример: `true`
project string	Имя проекта, с которым связан экземпляр. Возвращено: success Пример: `"Production"`
public_ip string	Публичный IP-адрес экземпляра через правило статического NAT. Возвращено: success Пример: `"1.2.3.4"`
security_groups list / elements=string	Группы безопасности, в которых находится экземпляр. Возвращено: success Пример: `["[ \"default\" ]"]`
service_offering string	Имя предложения сервиса, которым обладает экземпляр. Возвращено: success Пример: `"2cpu_2gb"`
ssh_key string	Имя ключа SSH, развернутого на экземпляре. Возвращено: success Пример: `"key@work"`
state string	Состояние экземпляра. Возвращено: success Пример: `"Running"`
tags list / elements=string	Список тегов ресурсов, связанных с экземпляром. Возвращено: success Пример: `["[ { \"key\": \"foo\"", " \"value\": \"bar\" } ]"]`
template string	Имя шаблона, с которым был развернут экземпляр. Возвращено: success Пример: `"Debian-8-64bit"`
volumes list / elements=string	Список словарей томов, подключенных к экземпляру. Возвращено: success Пример: `["[ { name: \"ROOT-1369\"", " type: \"ROOT\"", " size: 10737418240 }", " { name: \"data01", " type: \"DATADISK\"", " size: 10737418240 } ]"]`
zone string	Имя зоны, в которой находится экземпляр. Возвращено: success Пример: `"ch-gva-2"`

Авторы

René Moser (@resmo)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ngine_io/cloudstack/cs_instance_info_module.html