os_flavor_facts – Получение фактов о вкусах (flavors) одного или нескольких
Новое в версии 2.1.
Обзор
- Получение фактов о доступных вкусах (flavors) экземпляров OpenStack. По умолчанию, факты обо всех вкусах (flavors) извлекаются. Фильтры могут применяться для получения фактов только для соответствующих вкусов (flavors). Например, вы можете фильтровать по количеству доступной оперативной памяти вкуса (flavor), количеству виртуальных процессоров, доступных для вкуса (flavor), или по обоим параметрам. При указании нескольких фильтров, все фильтры должны соответствовать вкусу (flavor), прежде чем этот вкус (flavor) будет возвращен как факт.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- openstacksdk
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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, который может использоваться для проверки SSL API-запросов. Псевдонимы: cacert | |
| client_cert строка | Путь к клиенту сертификату для использования в рамках SSL-транзакции. Псевдонимы: cert | |
| client_key строка | Путь к ключу клиента для использования в рамках SSL-транзакции. Псевдонимы: key | |
| cloud необработанные данные | Наименованное облако или конфигурация облака для работы. Если cloud — это строка, она ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен auth или присутствуют переменные окружения OpenStack OS_*. Если cloud — это словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| ephemeral логическое значение добавлено в 2.3 |
| Строка, используемая для фильтрации вкусов (flavors) на основе количества временного хранилища. Формат аналогичен параметру ram. |
| interface строка добавлено в 2.3 |
| Тип URL-адреса конечной точки для извлечения из каталога сервисов. Псевдонимы: endpoint_type |
| limit - | Ограничивает количество возвращаемых вкусов (flavors). По умолчанию возвращаются все соответствующие вкусы (flavors). | |
| name - | Имя вкуса (flavor). Не может использоваться с ram, vcpus или ephemeral. | |
| ram логическое значение |
| Строка, используемая для фильтрации вкусов (flavors) по количеству ОЗУ (в МБ). Эта строка принимает следующие специальные значения: 'MIN' (возвратить вкусы (flavors) с минимальным объёмом ОЗУ), и 'MAX' (возвратить вкусы (flavors) с максимальным объёмом ОЗУ). Также может быть указано конкретное количество ОЗУ. Любые вкусы (flavors) с этим точным объёмом ОЗУ будут возвращены. Можно указать диапазон допустимого ОЗУ, используя специальный синтаксис. Просто добавьте перед объёмом ОЗУ одно из этих значений диапазона: '<', '>', '<=', '>= '. Эти значения представляют меньше чем, больше чем, меньше или равно, и больше или равно, соответственно. |
| region_name строка | Имя региона. | |
| timeout целое число | Значение по умолчанию: 180 | Сколько времени Ansible должен ожидать запрашиваемого ресурса. |
| validate_certs логическое значение |
| Нужно ли проверять SSL API-запросы. До Ansible 2.3 это по умолчанию было yes. Псевдонимы: verify |
| vcpus логическое значение |
| Строка, используемая для фильтрации вкусов (flavors) по количеству виртуальных процессоров. Формат аналогичен параметру ram. |
| wait логическое значение |
| Должен ли Ansible ожидать, пока запрашиваемый ресурс не будет завершён. |
Примечания
Примечание
- Этот модуль создает новый факт верхнего уровня
openstack_flavors, который содержит список несортированных вкусов (flavors). - Можно использовать стандартные переменные окружения OpenStack, такие как
OS_USERNAME, вместо явного указания значений. - Информация об аутентификации управляется openstacksdk, что означает, что значения могут быть взяты из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения, а затем, наконец, из явных параметров в задачах. Дополнительную информацию можно найти по адресу https://docs.openstack.org/openstacksdk/
Примеры
# Gather facts about all available flavors
- os_flavor_facts:
cloud: mycloud
# Gather facts for the flavor named "xlarge-flavor"
- os_flavor_facts:
cloud: mycloud
name: "xlarge-flavor"
# Get all flavors that have exactly 512 MB of RAM.
- os_flavor_facts:
cloud: mycloud
ram: "512"
# Get all flavors that have 1024 MB or more of RAM.
- os_flavor_facts:
cloud: mycloud
ram: ">=1024"
# Get a single flavor that has the minimum amount of RAM. Using the 'limit'
# option will guarantee only a single flavor is returned.
- os_flavor_facts:
cloud: mycloud
ram: "MIN"
limit: 1
# Get all flavors with 1024 MB of RAM or more, AND exactly 2 virtual CPUs.
- os_flavor_facts:
cloud: mycloud
ram: ">=1024"
vcpus: "2"
# Get all flavors with 1024 MB of RAM or more, exactly 2 virtual CPUs, and
# less than 30gb of ephemeral storage.
- os_flavor_facts:
cloud: mycloud
ram: ">=1024"
vcpus: "2"
ephemeral: "<30"
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие — это поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| openstack_flavors сложный | При успехе. | Словарь, описывающий параметры виртуальных машин. | |
| disk целое число | успех | Размер локального диска в ГБ. Пример: 10 | |
| ephemeral целое число | успех | Размер временного хранилища в ГБ. Пример: 10 | |
| id строка | успех | Идентификатор виртуальной машины. Пример: 515256b8-7027-4d73-aa54-4e30a4a4a339 | |
| is_public логический | успех | Доступность виртуальной машины для всех пользователей. Пример: True | |
| name строка | успех | Название виртуальной машины. Пример: tiny | |
| ram целое число | успех | Объем оперативной памяти в МБ. Пример: 1024 | |
| swap целое число | успех | Размер подкачки в МБ. Пример: 100 | |
| vcpus целое число | успех | Количество виртуальных процессоров. Пример: 2 | |
Статус
- Этот модуль не гарантирует обратной совместимости. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- David Shrewsbury (@Shrews)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/os_flavor_facts_module.html
