Spec-Zone.ru › Ansible

Модуль 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.

Если не указано, используется переменная окружения CLOUDSTACK_METHOD.

Допустимые значения:

  • "get" ← (по умолчанию)
  • "post"

api_key

string / обязательный

Ключ 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.
  • Этот модуль поддерживает режим проверки.

Примеры

- 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

Учетная запись, с которой связан экземпляр.

Возвращается: при успешном выполнении

Пример: "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

URI широковещательной передачи сетевого интерфейса.

Возвращается: при успешном выполнении

Пример: "vlan://2250"

gateway

string

Шлюз сетевого интерфейса.

Возвращается: при успешном выполнении

Пример: "10.1.2.1"

id

string

Идентификатор сетевого интерфейса.

Возвращается: при успешном выполнении

Пример: "5dc74fa3-2ec3-48a0-9e0d-6f43365336a9"

ipaddress

string

IP-адрес сетевого интерфейса.

Возвращается: при успешном выполнении

Пример: "10.1.2.3"

isdefault

boolean

True, если сетевой интерфейс является интерфейсом по умолчанию, иначе false.

Возвращается: при успешном выполнении

Пример: true

isolationuri

string

URI изоляции сетевого интерфейса.

Возвращается: при успешном выполнении

Пример: "vlan://2250"

macaddress

string

MAC-адрес сетевого интерфейса.

Возвращается: при успешном выполнении

Пример: "06:a2:03:00:08:12"

netmask

string

Маска подсети сетевого интерфейса.

Возвращается: при успешном выполнении

Пример: "255.255.255.0"

networkid

string

Идентификатор соответствующей сети.

Возвращается: при успешном выполнении

Пример: "432ce27b-c2bb-4e12-a88c-a919cd3a3017"

networkname

string

Имя соответствующей сети.

Возвращается: при успешном выполнении

Пример: "network1"

traffictype

string

Тип трафика сетевого интерфейса.

Возвращается: при успешном выполнении

Пример: "Guest"

type

string

Тип сети.

Возвращается: при успешном выполнении

Пример: "Shared"

password

string

Пароль экземпляра, если он существует.

Возвращается: при успешном выполнении

Пример: "Ge2oe7Do"

password_enabled

boolean

True, если включена настройка пароля.

Возвращается: при успешном выполнении

Пример: true

project

string

Имя проекта, с которым связан экземпляр.

Возвращается: при успешном выполнении

Пример: "Production"

public_ip

string

Публичный IP-адрес экземпляра, назначенный с помощью правила статического NAT.

Возвращается: при успешном выполнении

Пример: "1.2.3.4"

security_groups

list / elements=string

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

Возвращается: при успешном выполнении

Пример: ["[ \"default\" ]"]

service_offering

string

Название предложения услуг, назначенного экземпляру.

Возвращается: при успешном выполнении

Пример: "2cpu_2gb"

ssh_key

string

Имя SSH-ключа, установленного на экземпляре.

Возвращается: при успешном выполнении

Пример: "key@work"

state

string

Состояние экземпляра.

Возвращается: при успешном выполнении

Пример: "Running"

tags

list / elements=string

Список тегов ресурсов, связанных с экземпляром.

Возвращается: при успешном выполнении

Пример: ["[ { \"key\": \"foo\"", " \"value\": \"bar\" } ]"]

template

string

Имя шаблона, с помощью которого был развернут экземпляр.

Возвращается: при успешном выполнении

Пример: "Debian-8-64bit"

volumes

list / elements=string

Список словарей томов, подключенных к экземпляру.

Возвращается: при успешном выполнении

Пример: ["[ { name: \"ROOT-1369\"", " type: \"ROOT\"", " size: 10737418240 }", " { name: \"data01", " type: \"DATADISK\"", " size: 10737418240 } ]"]

zone

string

Имя зоны, в которой находится экземпляр.

Возвращается: при успешном выполнении

Пример: "ch-gva-2"

Авторы

  • René Moser (@resmo)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)

© 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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API