openstack.cloud.os_server_info – Получение информации об одном или нескольких вычислительных экземплярах

Примечание

Этот плагин входит в состав коллекции openstack.cloud (версия 1.2.1).

Для его установки используйте: ansible-galaxy collection install openstack.cloud.

Для использования в книге задач укажите: openstack.cloud.os_server_info.

Обзор
Требования
Параметры
Примечания
Примеры

Обзор

Получение информации об экземплярах серверов из OpenStack.
Этот модуль назывался os_server_facts до Ansible 2.9, возвращая ansible_facts. Обратите внимание, что модуль openstack.cloud.server_info больше не возвращает ansible_facts!

Требования

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

openstacksdk
openstacksdk >= 0.12.0
python >= 3.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
all_projects boolean	Варианты: нет ← да	Указывает, следует ли перечислить серверы из всех проектов или только из текущего проекта с учетом аутентификации.
api_timeout integer		Время ожидания сокетом перед истечением времени ожидания для вызовов API. Если этот параметр опущен, в библиотеку запросов ничего не будет передано.
auth dictionary		Словарь, содержащий информацию об аутентификации, необходимую стратегии подключаемого модуля аутентификации облака. Для стандартного подключаемого модуля password он должен содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать любые необходимые параметры. Этот параметр не требуется, если указано имя облака или присутствуют переменные среды OpenStack OS_*.
auth_type string		Имя подключаемого модуля аутентификации для использования. Если облако использует что-то другое, кроме парольной аутентификации, имя подключаемого модуля должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено.
availability_zone string		Игнорируется. Присутствует для обратной совместимости
ca_cert string		Путь к пакету сертификата CA, который можно использовать для проверки запросов API SSL. псевдонимы: cacert
client_cert string		Путь к клиенту сертификат для использования в рамках транзакции SSL. псевдонимы: cert
client_key string		Путь к ключу клиента для использования в рамках транзакции SSL. псевдонимы: key
cloud raw		Именованное облако или конфигурация облака для работы. Если cloud является строкой, она ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не требуется, если предоставлен auth или если присутствуют переменные среды OpenStack OS_. Если cloud* является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml.
detailed boolean	Варианты: нет ← да	При значении true возвращаются дополнительные детали о серверах за счет дополнительных вызовов API.
filters dictionary		ограничивает результаты серверами, соответствующими словариу фильтров
interface string	Варианты: admin internal public ←	Тип URL конечной точки для извлечения из каталога сервисов. псевдонимы: endpoint_type
region_name string		Имя региона.
server string		ограничивает результаты серверами, имена или UUID которых соответствуют этому шаблону (например, <web*>).
timeout integer	Значение по умолчанию: 180	Время ожидания Ansible для запрошенного ресурса.
validate_certs boolean	Варианты: нет ← да	Указывает, следует ли проверять запросы API SSL. До Ansible 2.3 это значение по умолчанию было `yes`. псевдонимы: verify
wait boolean	Варианты: нет да ←	Следует ли Ansible ждать завершения запрошенного ресурса.

Примечания

Примечание

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

Примеры

# Gather information about all servers named <web*> that are in an active state:
- openstack.cloud.server_info:
    cloud: rax-dfw
    server: web*
    filters:
      vm_state: active
  register: result
- debug:
    msg: "{{ result.openstack_servers }}"

Авторы

OpenStack Ansible SIG

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/openstack/cloud/os_server_info_module.html