Spec-Zone.ru › Ansible

Модуль openstack.cloud.server_info — получение сведений об одном или нескольких вычислительных экземплярах

Примечание

Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).

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

Для установки используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в сценарии, укажите: openstack.cloud.server_info.

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

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

  • Получение сведений об экземплярах серверов из OpenStack.

Требования

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

  • python >= 3.6
  • openstacksdk >= 1.0.0

Параметры

Параметр

Описание

all_projects

логическое значение

Следует ли выводить серверы из всех проектов или только из проекта, заданного в текущей области авторизации.

Варианты:

  • false ← (по умолчанию)
  • true

api_timeout

целое число

Как долго уровень сокетов должен ожидать ответа, прежде чем истечёт время ожидания вызова API. Если параметр не указан, библиотеке requests не передаётся никакое значение.

auth

словарь

Словарь с данными для аутентификации, необходимыми стратегии плагина аутентификации облака. Для стандартного плагина password здесь указываются auth_url, username, password, project_name и данные о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать необходимые им данные. Этот параметр не требуется, если указано именованное облако или заданы переменные среды OpenStack OS_*.

auth_type

строка

Имя используемого плагина аутентификации. Если облако использует не парольную аутентификацию, здесь следует указать имя плагина и соответствующим образом обновить содержимое параметра auth.

ca_cert

псевдонимы: cacert

строка

Путь к пакету сертификатов центра сертификации, используемому для проверки запросов к API по SSL.

client_cert

псевдонимы: cert

строка

Путь к сертификату клиента, используемому в SSL-транзакции.

client_key

псевдонимы: key

строка

Путь к ключу клиента, используемому в SSL-транзакции.

cloud

любой тип

Именованное облако или конфигурация облака, с которой нужно работать. Если cloud — строка, она указывает на именованную конфигурацию облака, заданную в файле OpenStack clouds.yaml. Параметр задаёт значения по умолчанию для auth и auth_type. Он не требуется, если указан auth или заданы переменные среды OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, аналогичную разделу в clouds.yaml.

detailed

логическое значение

Если значение равно true, возвращаются дополнительные сведения о серверах за счёт дополнительных вызовов API.

Варианты:

  • false ← (по умолчанию)
  • true

filters

словарь

Используется для дополнительной фильтрации результатов. Может быть строкой с выражением JMESPath или словарём метаданных. Значения словаря также могут быть словарями.

interface

псевдонимы: endpoint_type

строка

Тип URL конечной точки, получаемой из каталога служб.

Варианты:

  • "admin"
  • "internal"
  • "public" ← (по умолчанию)

name

псевдонимы: server

строка

Ограничивает результаты серверами, имена или UUID которых соответствуют этому шаблону glob, например web*.

region_name

строка

Имя региона.

sdk_log_level

строка

Уровень ведения журнала OpenStackSDK.

Варианты:

  • "INFO" ← (по умолчанию)
  • "DEBUG"

sdk_log_path

строка

Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не ведётся.

timeout

целое число

Как долго Ansible должен ожидать запрошенный ресурс.

По умолчанию: 180

validate_certs

псевдонимы: verify

логическое значение

Следует ли проверять запросы к API по SSL.

До Ansible 2.3 значением по умолчанию было true.

Варианты:

  • false
  • true

wait

логическое значение

Должен ли Ansible ожидать завершения операции с запрошенным ресурсом.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Результат содержит список серверов.
  • Вместо явного указания значений можно использовать стандартные переменные среды OpenStack, например OS_USERNAME.
  • Данные аутентификации обрабатываются openstacksdk. Это означает, что значения могут поступать из файла конфигурации YAML /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды и, наконец, из явных параметров в сценариях. Дополнительную информацию см. на странице https://docs.openstack.org/openstacksdk/

Примеры

- name: Gather information about all 'web*' servers in active state
  openstack.cloud.server_info:
    cloud: devstack
    name: web*
    filters:
      vm_state: active

- name: Filter servers with nested dictionaries
  openstack.cloud.server_info:
    cloud: devstack
    filters:
      metadata:
        key1: value1
        key2: value2

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

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

Ключ

Описание

servers

list / elements=dictionary

Список серверов, соответствующих фильтрам

Возвращается: всегда

access_ipv4

string

IPv4-адрес для доступа к этому серверу. Может задаваться провайдером автоматически.

Возвращается: при успехе

access_ipv6

string

IPv6-адрес для доступа к этому серверу. Может задаваться провайдером автоматически.

Возвращается: при успехе

addresses

dictionary

Словарь адресов, через которые доступен этот сервер. Словарь содержит такие ключи, как ‘private’ и ‘public’, каждый из которых содержит список словарей с адресами соответствующего типа. Адреса представлены в словаре с ключами ‘addr’ и ‘version’; значение последнего — 4 или 6 в зависимости от протокола IP-адреса.

Возвращается: при успехе

admin_password

string

При первом создании сервера возвращает пароль администратора.

Возвращается: при успехе

attached_volumes

list / elements=string

Список подключённых томов. Каждый элемент списка содержит как минимум ключ ‘id’, идентифицирующий конкретный том.

Возвращается: при успехе

availability_zone

string

Название зоны доступности, к которой относится этот сервер.

Возвращается: при успехе

block_device_mapping

string

Позволяет детально настраивать сопоставление блочных устройств для экземпляра. Обычно используется для загрузки серверов с томов.

Возвращается: при успехе

compute_host

string

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

Возвращается: при успехе

config_drive

string

Указывает, использовался ли для этого сервера конфигурационный диск.

Возвращается: при успехе

created_at

string

Время создания сервера.

Возвращается: при успехе

description

string

Описание сервера. До микроверсии 2.19 здесь указывалось имя сервера.

Возвращается: при успехе

disk_config

string

Конфигурация диска: AUTO или MANUAL.

Возвращается: при успехе

flavor

dictionary

Свойство типа сервера, возвращённое сервером.

Возвращается: при успехе

flavor_id

string

Ссылка на тип сервера в виде ID или полного URL, указывающая тип, который следует использовать для этого сервера.

Возвращается: при успехе

has_config_drive

string

Указывает, позволяет ли конфигурационный диск внедрять метаданные. Эту функцию поддерживают не все облачные провайдеры.

Возвращается: при успехе

host_id

string

ID узла, на котором размещён этот сервер.

Возвращается: при успехе

host_status

string

Состояние узла.

Возвращается: при успехе

hostname

string

Имя хоста, назначаемое экземпляру при загрузке. По умолчанию отображается в ответе только для пользователей с правами администратора.

Возвращается: при успехе

hypervisor_hostname

string

Имя узла гипервизора. В ответе отображается только для пользователей с правами администратора.

Возвращается: при успехе

id

string

ID сервера.

Возвращается: при успехе

image

dictionary

Свойство образа, возвращённое сервером.

Возвращается: при успехе

image_id

string

Ссылка на образ в виде ID или полного URL, указывающая образ, который следует использовать для этого сервера.

Возвращается: при успехе

instance_name

string

Имя экземпляра. Compute API формирует его на основе шаблона имени экземпляра. В ответе отображается только для пользователей с правами администратора.

Возвращается: при успехе

is_locked

boolean

Состояние блокировки сервера

Возвращается: при успехе

kernel_id

string

UUID образа ядра при использовании AMI. Если он не используется, значение будет null. По умолчанию отображается в ответе только для пользователей с правами администратора.

Возвращается: при успехе

key_name

string

Имя связанной пары ключей.

Возвращается: при успехе

launch_index

integer

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

Возвращается: при успехе

launched_at

string

Время запуска сервера.

Возвращается: при успехе

links

string

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

Возвращается: при успехе

max_count

string

Максимальное количество создаваемых серверов.

Возвращается: при успехе

metadata

dictionary

Список строк с тегами.

Возвращается: при успехе

min_count

string

Минимальное количество создаваемых серверов.

Возвращается: при успехе

name

string

Имя сервера

Возвращается: при успехе

networks

string

Объект сетей. Обязательный параметр, если для арендатора определено несколько сетей. Если параметр networks не указан, сервер подключается к единственной сети, созданной для текущего арендатора.

Возвращается: при успехе

power_state

string

Состояние питания этого сервера.

Возвращается: при успехе

progress

integer

Пока сервер создаётся, это значение показывает процент выполнения. После завершения оно будет равно 100.

Возвращается: при успехе

project_id

string

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

Возвращается: при успехе

ramdisk_id

string

UUID образа ramdisk при использовании AMI. Если он не используется, значение будет null. По умолчанию отображается в ответе только для пользователей с правами администратора.

Возвращается: при успехе

reservation_id

string

ID резервирования сервера. Этот идентификатор полезен для отслеживания групп серверов, созданных посредством массового создания: у всех них будет одинаковое значение reservation_id. По умолчанию отображается в ответе только для пользователей с правами администратора.

Возвращается: при успехе

root_device_name

string

Имя корневого устройства экземпляра. По умолчанию отображается в ответе только для пользователей с правами администратора.

Возвращается: при успехе

scheduler_hints

dictionary

Словарь данных, передаваемых планировщику.

Возвращается: при успехе

security_groups

list / elements=dictionary

Список применимых групп безопасности. Каждая группа содержит ключи description, name, id и rules.

Возвращается: при успехе

server_groups

list / elements=string

UUID групп серверов, к которым относится сервер. В настоящее время список может содержать не более одного элемента.

Возвращается: при успехе

status

string

Текущее состояние сервера. Допустимые значения: ‘ACTIVE’, ‘BUILDING’, ‘DELETED’, ‘ERROR’, ‘HARD_REBOOT’, ‘PASSWORD’, ‘PAUSED’, ‘REBOOT’, ‘REBUILD’, ‘RESCUED’, ‘RESIZED’, ‘REVERT_RESIZE’, ‘SHUTOFF’, ‘SOFT_DELETED’, ‘STOPPED’, ‘SUSPENDED’, ‘UNKNOWN’ или ‘VERIFY_RESIZE’.

Возвращается: при успехе

tags

list / elements=string

Список связанных тегов.

Возвращается: при успехе

task_state

string

Состояние задачи этого сервера.

Возвращается: при успехе

terminated_at

string

Время завершения работы сервера (если он был завершён).

Возвращается: при успехе

trusted_image_certificates

list / elements=string

Список ID доверенных сертификатов, использованных при проверке подписи образа для проверки сертификата подписанта.

Возвращается: при успехе

updated_at

string

Время последнего обновления этого сервера.

Возвращается: при успехе

user_data

string

Конфигурационные данные или сценарии, используемые при запуске. Кодируются в Base64.

Возвращается: при успехе

user_id

string

ID владельцев этого сервера.

Возвращается: при успехе

vm_state

string

Состояние виртуальной машины этого сервера.

Возвращается: при успехе

volumes

list / elements=string

То же, что и attached_volumes.

Возвращается: при успехе

Авторы

  • OpenStack Ansible SIG

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

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

© 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/openstack/cloud/server_info_module.html

Spec-Zone.ru

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