os_server_info – Получение информации об одном или нескольких вычислительных экземплярах
Описание
- Получение информации о серверных экземплярах из OpenStack.
- Этот модуль назывался
os_server_factsдо Ansible 2.9, возвращаяansible_facts. Обратите внимание, что модуль os_server_info больше не возвращаетansible_facts!
Псевдонимы: os_server_facts
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| all_projects boolean добавлено в 2.8 |
| Указать, нужно ли отобразить серверы из всех проектов или только из текущего проекта, определенного авторизацией. |
| api_timeout целое число | Сколько времени слой сокетов должен ждать перед истечением времени ожидания для вызовов API. Если это опущено, ничто не будет передано библиотеке requests. | |
| auth словарь | Словарь, содержащий информацию об авторизации, необходимую для стратегии плагина авторизации облака. Для плагина по умолчанию password, он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, os_user_domain_name или os_project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать необходимые параметры плагина авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные среды OpenStack OS_*. | |
| auth_type строка | Имя плагина авторизации для использования. Если облако использует что-то кроме парольной аутентификации, здесь должно быть указано имя плагина, и содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone - | Игнорируется. Присутствует для обратной совместимости | |
| ca_cert строка | Путь к пакету сертификатов CA, который может использоваться для проверки запросов API SSL. псевдонимы: cacert | |
| client_cert строка | Путь к клиенту сертификат для использования в рамках транзакции SSL. псевдонимы: cert | |
| client_key строка | Путь к ключу клиента для использования в рамках транзакции SSL. псевдонимы: key | |
| cloud сырые данные | Именованное облако или конфигурация облака для работы. Если cloud — строка, она ссылается на именованную конфигурацию облака, определенную в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен auth или присутствуют переменные среды OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| detailed boolean |
| при значении true, возвращает дополнительные подробности о серверах за счет дополнительных вызовов API. |
| filters - добавлено в 2.8 | ограничить результаты серверами, соответствующими словарю фильтров | |
| interface строка |
| Тип URL конечной точки для получения из каталога сервисов. псевдонимы: endpoint_type |
| region_name строка | Имя региона. | |
| server - | ограничить результаты серверами с именами или UUID, соответствующими этому выражению glob (например, <web*>). | |
| timeout целое число | По умолчанию: 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:
- os_server_info:
cloud: rax-dfw
server: web*
filters:
vm_state: active
register: result
- debug:
msg: "{{ result.openstack_servers }}"
Статус
- Не гарантируется обратная совместимость интерфейса этого модуля. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Monty (@emonty)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/os_server_info_module.html
