openstack.cloud.os_flavor_info – Получение информации об одном или нескольких флейворах
Примечание
Этот плагин входит в коллекцию openstack.cloud (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install openstack.cloud.
Для использования в playbook, укажите: openstack.cloud.os_flavor_info.
Обзор
- Получение информации о доступных флейворах виртуальных машин OpenStack. По умолчанию, информация о ВСЕХ флейворах извлекается. Фильтры могут быть применены для получения информации только для соответствующих флейворов. Например, вы можете фильтровать по количеству доступной оперативной памяти флейвора, или количеству виртуальных процессоров, или по обоим параметрам. При указании нескольких фильтров, ВСЕ фильтры должны соответствовать флейвору, прежде чем он будет возвращён как факт.
- Этот модуль назывался
openstack.cloud.compute_flavor_factsдо Ansible 2.9, возвращаяansible_facts. Обратите внимание, что модуль openstack.cloud.compute_flavor_info больше не возвращаетansible_facts!
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 3.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Сколько времени должен ожидать уровень сокета перед истечением времени ожидания для вызовов API. Если это опущено, ничего не будет передано в библиотеку запросов. | |
| auth словарь | Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password, он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или 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. | |
| 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, затем из стандартных переменных среды, и, наконец, из явных параметров в playbooks. Более подробную информацию можно найти на https://docs.openstack.org/openstacksdk/
Примеры
# Gather information about all available flavors
- openstack.cloud.compute_flavor_info:
cloud: mycloud
register: result
- debug:
msg: "{{ result.openstack_flavors }}"
# Gather information for the flavor named "xlarge-flavor"
- openstack.cloud.compute_flavor_info:
cloud: mycloud
name: "xlarge-flavor"
# Get all flavors that have exactly 512 MB of RAM.
- openstack.cloud.compute_flavor_info:
cloud: mycloud
ram: "512"
# Get all flavors that have 1024 MB or more of RAM.
- openstack.cloud.compute_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.
- openstack.cloud.compute_flavor_info:
cloud: mycloud
ram: "MIN"
limit: 1
# Get all flavors with 1024 MB of RAM or more, AND exactly 2 virtual CPUs.
- openstack.cloud.compute_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.
- openstack.cloud.compute_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 | |
Авторы
- 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_flavor_info_module.html