Spec-Zone.ru › Ansible

openstack.cloud.compute_flavor_info модуль – Получение данных о виртуальных машинах из OpenStack облака

Примечание

Этот модуль является частью коллекции openstack.cloud (версия 2.2.0).

Вы, возможно, уже установили эту коллекцию, если используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить ее, используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля необходимы дополнительные требования. Подробнее см. Требования.

Чтобы использовать его в книге задач, укажите: openstack.cloud.compute_flavor_info.

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

  • Получение данных о виртуальных машинах OpenStack.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

  • python >= 3.6
  • openstacksdk >= 1.0.0

Параметры

Параметр

Комментарии

api_timeout

integer

Сколько времени слой сокетов должен ждать, прежде чем истечет время ожидания для вызовов API. Если этот параметр опущен, ничего не будет передано в библиотеку запросов.

auth

dictionary

Словарь, содержащий информацию об аутентификации, необходимую стратегии плагина аутентификации облака. Для плагина password по умолчанию это будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать все параметры, необходимые этому плагину аутентификации. Этот параметр не требуется, если указано имя облака или присутствуют переменные среды OpenStack OS_*.

auth_type

string

Имя используемого плагина аутентификации. Если облако использует что-то отличное от парольной аутентификации, имя плагина должно быть указано здесь, а содержимое параметра auth должно быть обновлено соответствующим образом.

ca_cert

aliases: cacert

string

Путь к пакету сертификатов CA, который может использоваться в качестве части проверки запросов API SSL.

client_cert

aliases: cert

string

Путь к клиентскому сертификату, используемому в рамках транзакции SSL.

client_key

aliases: key

string

Путь к клиентскому ключу, используемому в рамках транзакции SSL.

cloud

any

Именованное облако или конфигурация облака, с которым нужно работать. Если cloud — это строка, она ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не требуется, если указан auth или если присутствуют переменные среды OpenStack OS_*. Если cloud — это словарь, он содержит полную конфигурацию облака, как это было бы в разделе clouds.yaml.

ephemeral

string

Фильтровать типы по количеству эфемерного хранилища.

ephemeral поддерживает тот же формат, что и параметр ram.

interface

aliases: endpoint_type

string

Тип URL конечной точки для получения из каталога служб.

Варианты:

  • "admin"
  • "internal"
  • "public" ← (default)

limit

integer

Ограничивает количество типов до limit результатов.

По умолчанию возвращаются все совпадающие типы.

name

string

Имя типа.

ram

string

Строка, используемая для фильтрации типов на основе желаемого объема оперативной памяти (в МБ). Эта строка принимает следующие специальные значения: «MIN» (возвращает типы с минимальным объемом оперативной памяти) и «MAX» (возвращает типы с максимальным объемом оперативной памяти).

Можно также указать конкретный объем оперативной памяти. Будут возвращены все типы с этим точным объемом оперативной памяти.

Диапазон допустимой оперативной памяти можно задать с помощью специального синтаксиса. Просто добавьте префикс к объему оперативной памяти одним из этих допустимых значений диапазона: «<», «>», «<=», «>=». Эти значения представляют собой меньше чем, больше чем, меньше или равно и больше или равно соответственно.

region_name

string

Имя региона.

sdk_log_level

string

Уровень логирования OpenStackSDK

Варианты:

  • "INFO" ← (default)
  • "DEBUG"

sdk_log_path

string

Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается

timeout

integer

Как долго ansible должен ждать запрашиваемый ресурс.

По умолчанию: 180

validate_certs

aliases: verify

boolean

Следует ли проверять запросы API SSL.

До Ansible 2.3 это значение по умолчанию было true.

Варианты:

  • false
  • true

vcpus

string

Фильтровать типы по количеству виртуальных ЦП.

vcpus поддерживает тот же формат, что и параметр ram.

wait

boolean

Должен ли Ansible ожидать завершения запрошенного ресурса.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Можно использовать стандартные переменные окружения OpenStack, такие как OS_USERNAME, вместо явного указания значений.
  • Информация об авторизации управляется openstacksdk, что означает, что значения могут быть взяты из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, а затем из стандартных переменных окружения, а затем, наконец, из явных параметров в задачах. Более подробную информацию можно найти по адресу https://docs.openstack.org/openstacksdk/

Примеры

- name: Gather information about all available flavors
  openstack.cloud.compute_flavor_info:
    cloud: mycloud

- name: Gather information for the flavor named "xlarge-flavor"
  openstack.cloud.compute_flavor_info:
    cloud: mycloud
    name: "xlarge-flavor"

- name: Get all flavors with 512 MB of RAM
  openstack.cloud.compute_flavor_info:
    cloud: mycloud
    ram: "512"

- name: Get all flavors with >= 1024 MB RAM
  openstack.cloud.compute_flavor_info:
    cloud: mycloud
    ram: ">=1024"

- name: Get a single flavor with minimum amount of RAM
  openstack.cloud.compute_flavor_info:
    cloud: mycloud
    ram: "MIN"
    limit: 1

- name: Get all flavors with >=1024 MB RAM and 2 vCPUs
  openstack.cloud.compute_flavor_info:
    cloud: mycloud
    ram: ">=1024"
    vcpus: "2"

- name: Get flavors with >= 1024 MB RAM 2 vCPUs and < 30gb ephemeral storage
  openstack.cloud.compute_flavor_info:
    cloud: mycloud
    ram: ">=1024"
    vcpus: "2"
    ephemeral: "<30"

Значения возврата

Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:

Ключ

Описание

flavors

список / элементы=словарь

Список словарей, описывающих виртуальные машины.

Возвращается: всегда

description

строка

Описание виртуальной машины

Возвращается: успешно

Пример: "Small flavor"

disk

целое число

Размер локального диска в ГБ.

Возвращается: успешно

Пример: 10

ephemeral

целое число

Размер временного пространства в ГБ.

Возвращается: успешно

Пример: 10

extra_specs

словарь

Дополнительные параметры для настройки различных вариантов виртуальных машин.

Возвращается: успешно

Пример: {"hw_rng:allowed": true}

id

строка

ID виртуальной машины.

Возвращается: успешно

Пример: "515256b8-7027-4d73-aa54-4e30a4a4a339"

is_disabled

булево

Включена ли виртуальная машина

Возвращается: успешно

Пример: false

is_public

булево

Доступна ли виртуальная машина для публичного использования.

Возвращается: успешно

Пример: true

name

строка

Имя виртуальной машины.

Возвращается: успешно

Пример: "tiny"

original_name

строка

Исходное имя виртуальной машины

Возвращается: успешно

Пример: "tiny"

ram

целое число

Объем оперативной памяти в МБ.

Возвращается: успешно

Пример: 1024

rxtx_factor

вещественное число

Множитель, который умножается на свойство rxtx_base сети, к которой он подключен, чтобы иметь разный лимит пропускной способности.

Возвращается: успешно

Пример: 1.0

swap

целое число

Размер кэша подкачки в МБ.

Возвращается: успешно

Пример: 100

vcpus

целое число

Количество виртуальных процессоров.

Возвращается: успешно

Пример: 2

Авторы

  • OpenStack Ansible SIG

Ссылки на коллекцию

  • Система отслеживания задач
  • Репозиторий (источники)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/openstack/cloud/compute_flavor_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API