Модуль ngine_io.cloudstack.instance_info — сбор информации об экземплярах из API облаков на базе Apache CloudStack.
Примечание
Этот модуль входит в коллекцию ngine_io.cloudstack (версия 3.0.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install ngine_io.cloudstack. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: ngine_io.cloudstack.instance_info.
Добавлено в ngine_io.cloudstack 0.1.0
Краткое описание
- Сбор информации об экземпляре через API.
Псевдонимы: cs_instance_info
Требования
Следующие компоненты должны быть установлены на хосте, на котором выполняется этот модуль.
- python >= 2.6
- cs >= 0.9.0
Параметры
Параметр | Комментарии |
|---|---|
account string | Учетная запись, связанная с экземпляром. |
api_http_method string | HTTP-метод, используемый для запроса к конечной точке API. Если не указано, используется переменная окружения Допустимые значения:
|
api_key string / обязательный | Ключ API CloudStack. Если не указано, используется переменная окружения |
api_secret string / обязательный | Секретный ключ API CloudStack. Если не указано, используется переменная окружения |
api_timeout integer | Тайм-аут HTTP в секундах. Если не указано, используется переменная окружения По умолчанию: |
api_url string / обязательный | URL API CloudStack, например https://cloud.example.com/client/api. Если не указано, используется переменная окружения |
api_verify_ssl_cert string | Проверять файл сертификата центра сертификации. Если не указано, используется переменная окружения |
domain string | Домен, связанный с экземпляром. |
host string добавлено в ngine_io.cloudstack 2.2.0 | Фильтрация по имени хоста. |
name string | Имя или отображаемое имя экземпляра. Если не указано, возвращаются все экземпляры |
project string | Проект, связанный с экземпляром. |
validate_certs boolean добавлено в ngine_io.cloudstack 2.4.0 | Если Если не указано, используется переменная окружения Этот параметр следует использовать только на сайтах под вашим личным управлением, использующих самоподписанные сертификаты. Допустимые значения:
|
Примечания
Примечание
- Подробное руководство по модулям CloudStack см. в руководстве по облаку CloudStack.
- Этот модуль поддерживает режим проверки.
Примеры
- name: Gather instance information
ngine_io.cloudstack.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.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.instance_info:
host: host01.example.com
register: vms
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
instances list / elements=string | Список подходящих экземпляров. Возвращается: при успешном выполнении |
|
account string |
Учетная запись, с которой связан экземпляр. Возвращается: при успешном выполнении Пример: |
|
affinity_groups list / elements=string |
Группы схожести, в которые входит экземпляр. Возвращается: при успешном выполнении Пример: |
|
created string |
Дата создания экземпляра. Возвращается: при успешном выполнении Пример: |
|
default_ip string |
IP-адрес экземпляра по умолчанию. Возвращается: при успешном выполнении Пример: |
|
display_name string |
Отображаемое имя экземпляра. Возвращается: при успешном выполнении Пример: |
|
domain string |
Домен, с которым связан экземпляр. Возвращается: при успешном выполнении Пример: |
|
group string |
Имя группы, с которой связан экземпляр. Возвращается: при успешном выполнении Пример: |
|
host string |
Хост, на котором работает экземпляр. Возвращается: при успешном выполнении, если экземпляр работает Пример: |
|
hypervisor string |
Гипервизор, связанный с этим экземпляром. Возвращается: при успешном выполнении Пример: |
|
id string |
UUID экземпляра. Возвращается: при успешном выполнении Пример: |
|
instance_name string |
Внутреннее имя экземпляра (доступно только администратору ROOT). Возвращается: при успешном выполнении Пример: |
|
iso string |
Имя ISO-образа, с которым был развернут экземпляр. Возвращается: при успешном выполнении Пример: |
|
name string |
Имя экземпляра. Возвращается: при успешном выполнении Пример: |
|
nic complex | Список словарей сетевых интерфейсов экземпляра. Возвращается: при успешном выполнении |
|
broadcasturi string |
URI широковещательной передачи сетевого интерфейса. Возвращается: при успешном выполнении Пример: |
|
gateway string |
Шлюз сетевого интерфейса. Возвращается: при успешном выполнении Пример: |
|
id string |
Идентификатор сетевого интерфейса. Возвращается: при успешном выполнении Пример: |
|
ipaddress string |
IP-адрес сетевого интерфейса. Возвращается: при успешном выполнении Пример: |
|
isdefault boolean |
True, если сетевой интерфейс является интерфейсом по умолчанию, иначе false. Возвращается: при успешном выполнении Пример: |
|
isolationuri string |
URI изоляции сетевого интерфейса. Возвращается: при успешном выполнении Пример: |
|
macaddress string |
MAC-адрес сетевого интерфейса. Возвращается: при успешном выполнении Пример: |
|
netmask string |
Маска подсети сетевого интерфейса. Возвращается: при успешном выполнении Пример: |
|
networkid string |
Идентификатор соответствующей сети. Возвращается: при успешном выполнении Пример: |
|
networkname string |
Имя соответствующей сети. Возвращается: при успешном выполнении Пример: |
|
traffictype string |
Тип трафика сетевого интерфейса. Возвращается: при успешном выполнении Пример: |
|
type string |
Тип сети. Возвращается: при успешном выполнении Пример: |
|
password string |
Пароль экземпляра, если он существует. Возвращается: при успешном выполнении Пример: |
|
password_enabled boolean |
True, если включена настройка пароля. Возвращается: при успешном выполнении Пример: |
|
project string |
Имя проекта, с которым связан экземпляр. Возвращается: при успешном выполнении Пример: |
|
public_ip string |
Публичный IP-адрес экземпляра, назначенный с помощью правила статического NAT. Возвращается: при успешном выполнении Пример: |
|
security_groups list / elements=string |
Группы безопасности, в которые входит экземпляр. Возвращается: при успешном выполнении Пример: |
|
service_offering string |
Название предложения услуг, назначенного экземпляру. Возвращается: при успешном выполнении Пример: |
|
ssh_key string |
Имя SSH-ключа, установленного на экземпляре. Возвращается: при успешном выполнении Пример: |
|
state string |
Состояние экземпляра. Возвращается: при успешном выполнении Пример: |
|
tags list / elements=string |
Список тегов ресурсов, связанных с экземпляром. Возвращается: при успешном выполнении Пример: |
|
template string |
Имя шаблона, с помощью которого был развернут экземпляр. Возвращается: при успешном выполнении Пример: |
|
volumes list / elements=string |
Список словарей томов, подключенных к экземпляру. Возвращается: при успешном выполнении Пример: |
|
zone string |
Имя зоны, в которой находится экземпляр. Возвращается: при успешном выполнении Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/ngine_io/cloudstack/instance_info_module.html