os_flavor_facts - Получение фактов о вкусах одного или нескольких ароматов
Новое в версии 2.1.
- Обзор
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Обзор
- Получение фактов о доступных ароматах экземпляров OpenStack. По умолчанию извлекаются факты обо всех ароматах. Можно применить фильтры, чтобы получить факты только для соответствующих ароматов. Например, можно фильтровать по объёму оперативной памяти аромата или количеству виртуальных процессоров, доступных для аромата, или по обоим параметрам. При указании нескольких фильтров все фильтры должны соответствовать аромату, прежде чем этот аромат будет возвращён как факт.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.6
- python >= 2.7
- shade
Параметры
| параметр | обязательно | по умолчанию | значения | комментарии |
|---|---|---|---|---|
| api_timeout | нет | None | Сколько времени должна ожидать сокетная часть перед завершением работы при API-вызовах. Если это опущено, ничего не будет передано библиотеке requests. | |
| auth | нет | Словарь, содержащий информацию об авторизации, необходимую для стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password он будет содержать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать любые параметры, необходимые для подключаемого модуля авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные среды OpenStack OS_*. | ||
| auth_type | нет | password | Имя подключаемого модуля авторизации для использования. Если облако использует что-то кроме аутентификации по паролю, имя подключаемого модуля должно быть указано здесь, и содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone | нет | Игнорируется. Присутствует для обратной совместимости | ||
| cacert | нет | None | Путь к пакету сертификатов CA, который может использоваться для проверки SSL-API-запросов. | |
| cert | нет | None | Путь к сертификату клиента для использования в рамках SSL-транзакции. | |
| cloud | нет | Имя облака для работы. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен параметр auth или присутствуют переменные среды OpenStack OS_*. | ||
| endpoint_type | нет | public |
| Тип URL-адреса конечной точки для извлечения из каталога служб. |
| ephemeral (добавлено в 2.3)
| нет | Строка, используемая для фильтрации ароматов на основе объёма временного хранилища. Формат такой же, как у параметра ram | ||
| key | нет | None | Путь к ключу клиента для использования в рамках SSL-транзакции. | |
| limit | нет | None | Ограничивает количество возвращаемых ароматов. По умолчанию возвращаются все соответствующие ароматы. | |
| name | нет | None | Название аромата. Не может использоваться с ram или vcpus или ephemeral. | |
| ram | нет | Строка, используемая для фильтрации ароматов на основе желаемого объёма оперативной памяти (в МБ). Эта строка принимает следующие специальные значения: «MIN» (возвращает ароматы с минимальным объёмом оперативной памяти) и «MAX» (возвращает ароматы с максимальным объёмом оперативной памяти). Также может быть указан конкретный объём оперативной памяти. Будут возвращены все ароматы с этим точным объёмом оперативной памяти. Можно указать диапазон допустимых значений оперативной памяти, используя специальный синтаксис. Просто добавьте одно из этих значений диапазона перед значением оперативной памяти: «<», «>», «<=», «>=». Эти значения соответствуют меньше, больше, меньше или равно и больше или равно соответственно. | ||
| region_name | нет | Имя региона. | ||
| timeout | нет | 180 | Сколько времени Ansible должен ждать запрошенного ресурса. | |
| validate_certs | нет | Проверять ли SSL-API-запросы. До версии 2.3 по умолчанию значение было True. псевдонимы: verify | ||
| vcpus | нет | Строка, используемая для фильтрации ароматов на основе желаемого количества виртуальных процессоров. Формат такой же, как у параметра ram. | ||
| wait | нет | yes |
| Должен ли Ansible ждать завершения запрошенного ресурса. |
Примеры
# 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 | Словарь, описывающий ароматы. | При успехе. | сложный | ||||||||||||||||||||||||||||||||||||||||||||||
| содержит: |
| ||||||||||||||||||||||||||||||||||||||||||||||||
Примечания
Примечание
- Этот модуль создаёт новый факт верхнего уровня
openstack_flavors, который содержит список несортированных ароматов. - Можно использовать стандартные переменные среды OpenStack, такие как
OS_USERNAME, вместо явного указания значений. - Информация об авторизации обрабатывается os-client-config, что означает, что значения могут быть взяты из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, и, наконец, из явных параметров в play. Подробнее можно узнать на http://docs.openstack.org/developer/os-client-config
Статус
Этот модуль помечен как preview, что означает, что его интерфейс не гарантируется обратной совместимостью.
Чтобы помочь в разработке модулей, если у вас есть желание, прочитайте Справочная информация о сообществе и содействие, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/os_flavor_facts_module.html
