os_flavor_info – Получение информации об одном или нескольких флейворах
Описание
- Получение информации о доступных флейворах экземпляров OpenStack. По умолчанию информация о ВСЕХ флейворах извлекается. Можно применять фильтры, чтобы получить информацию только о соответствующих флейворах. Например, можно фильтровать по объёму доступной оперативной памяти, количеству виртуальных ЦП или по обоим параметрам. При указании нескольких фильтров, все фильтры должны соответствовать флейвору, для того чтобы этот флейвор был возвращён как факт.
- Этот модуль назывался
os_flavor_factsдо Ansible 2.9, возвращаяansible_facts. Обратите внимание, что модуль os_flavor_info больше не возвращаетansible_facts!
Псевдонимы: os_flavor_facts
Требования
Ниже перечислены требования к хосту, на котором выполняется данный модуль.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Сколько времени должна ждать сокетная часть, прежде чем истечёт время ожидания для вызовов API. Если это значение опущено, в библиотеку запросов ничего не передаётся. | |
| 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 логический тип |
| Строка, используемая для фильтрации флейворов на основе объёма временного хранилища. Формат аналогичен параметру ram |
| interface строка |
| Тип URL-адреса конечной точки для извлечения из каталога услуг. Псевдонимы: endpoint_type |
| limit - | Ограничивает количество возвращаемых флейворов. По умолчанию возвращаются все соответствующие флейворы. | |
| name - | Название флейвора. Не может использоваться с параметрами ram, vcpus или ephemeral. | |
| ram логический тип |
| Строка, используемая для фильтрации флейворов на основе требуемого объёма оперативной памяти (в МБ). Эта строка принимает следующие специальные значения: 'MIN' (возвращает флейворы с минимальным объёмом ОЗУ), и 'MAX' (возвращает флейворы с максимальным объёмом ОЗУ). Также может быть указан конкретный объём ОЗУ. Будут возвращены все флейворы с этим точным объёмом ОЗУ. Может быть указан диапазон допустимых значений ОЗУ с использованием специального синтаксиса. Просто добавьте перед значением ОЗУ одно из этих допустимых значений диапазона: '<', '>', '<=', '>= ' Эти значения обозначают меньше чем, больше чем, меньше или равно, и больше или равно соответственно. |
| region_name строка | Имя региона. | |
| timeout целое число | По умолчанию: 180 | Сколько времени ansible должно ждать запрашиваемого ресурса. |
| validate_certs логический тип |
| Проверяются ли запросы API SSL. До Ansible 2.3 по умолчанию было yes.Псевдонимы: verify |
| vcpus логический тип |
| Строка, используемая для фильтрации флейворов на основе количества виртуальных ЦП. Формат аналогичен параметру ram. |
| wait логический тип |
| Должен ли 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 available flavors
- os_flavor_info:
cloud: mycloud
register: result
- debug:
msg: "{{ result.openstack_flavors }}"
# Gather information for the flavor named "xlarge-flavor"
- os_flavor_info:
cloud: mycloud
name: "xlarge-flavor"
# Get all flavors that have exactly 512 MB of RAM.
- os_flavor_info:
cloud: mycloud
ram: "512"
# Get all flavors that have 1024 MB or more of RAM.
- os_flavor_info:
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_info:
cloud: mycloud
ram: "MIN"
limit: 1
# Get all flavors with 1024 MB of RAM or more, AND exactly 2 virtual CPUs.
- os_flavor_info:
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_info:
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. [community]
Авторы
- 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.9/modules/os_flavor_info_module.html