Модуль openstack.cloud.baremetal_node — создание/удаление ресурсов bare metal в OpenStack

api_timeout

integer

Время ожидания на уровне сокета перед превышением времени ожидания вызовов API. Если параметр не указан, в библиотеку requests ничего не передаётся.

auth

dictionary

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

auth_type

string

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

bios_interface

string

Интерфейс BIOS для этого узла, например no-bios.

boot_interface

string

Интерфейс загрузки для этого узла, например pxe.

ca_cert

псевдонимы: cacert

string

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

chassis_id

псевдонимы: chassis_uuid

string

Связать узел с предварительно определённым шасси.

client_cert

псевдонимы: cert

string

Путь к сертификату клиента, используемому при обмене данными по SSL.

client_key

псевдонимы: key

string

Путь к ключу клиента, используемому при обмене данными по SSL.

cloud

any

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

console_interface

string

Интерфейс консоли для этого узла, например no-console.

deploy_interface

string

Интерфейс развёртывания для этого узла, например iscsi.

driver

string

Имя драйвера Ironic, используемого для этого узла.

Обязателен, если state имеет значение present

driver_info

dictionary / обязательный

Информация о драйвере этого узла. Содержимое зависит от используемого драйвера. Все заполненные вложенные поля проверяются при создании. Для совместимости вложенные поля `power`, `deploy`, `management` и `console` представлены на одном уровне.

id

псевдонимы: uuid

string

Идентификатор bare metal-узла. При создании генерируется автоматически, если он не указан, а параметр name задан.

Значение id всегда имеет приоритет над значением name.

inspect_interface

string

Интерфейс для проверки узла, например no-inspect.

interface

псевдонимы: endpoint_type

string

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

Варианты:

• "admin"
• "internal"
• "public" ← (по умолчанию)

management_interface

string

Интерфейс для внеполосного управления этим узлом, например «ipmitool».

name

string

Уникальное имя, назначаемое ресурсу.

network_interface

string

Поставщик сетевого интерфейса, используемый при описании подключений для этого узла.

nics

list / элементы=dictionary / обязательный

Список сетевых адаптеров, например - mac: aa:bb:cc:aa:bb:cc

Этот атрибут узла нельзя обновить.

mac

string / обязательный

MAC-адрес сетевого адаптера.

power_interface

string

Интерфейс для управления питанием этого узла, например ipmitool.

properties

dictionary

Описание физических характеристик этого узла

Используется для планирования размещения

capabilities

string

Специальные возможности этого узла, например boot_option и т. д.

Дополнительные сведения см. в разделе https://docs.openstack.org/ironic/latest/install/advanced.html.

cpu_arch

string

Архитектура ЦП (x86_64, i686, …)

cpus

string

Количество ядер ЦП в этой машине

local_gb

псевдонимы: disk_size

string

Объём первого устройства хранения данных в этой машине в ГБ (обычно /dev/sda)

memory_mb

псевдонимы: ram

string

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

root_device

dictionary

Подсказки об устройстве корневого диска для развёртывания.

Допустимые подсказки см. в разделе https://docs.openstack.org/ironic/latest/install/advanced.html.

raid_interface

string

Интерфейс для настройки RAID на этом узле.

region_name

string

Имя региона.

rescue_interface

string

Интерфейс для восстановления узла, например no-rescue.

resource_class

string

Тип ресурса, к которому относится этот узел.

sdk_log_level

string

Уровень ведения журнала OpenStackSDK

Варианты:

• "INFO" ← (по умолчанию)
• "DEBUG"

sdk_log_path

string

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

skip_update_of_masked_password

boolean

Устарел, больше не используется.

Задание или обновление пароля не поддерживается уже некоторое время.

Варианты:

• false
• true

state

string

Указывает требуемое состояние ресурса

Варианты:

• "present" ← (по умолчанию)
• "absent"

storage_interface

string

Интерфейс для подключения и отключения томов на этом узле, например cinder.

timeout

integer

Количество секунд ожидания, пока созданный узел не перейдёт в состояние доступности.

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

validate_certs

псевдонимы: verify

boolean

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

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

Варианты:

• false
• true

vendor_interface

string

Интерфейс для всех специфичных для поставщика операций с этим узлом, например no-vendor.

wait

boolean

Следует ли Ansible ожидать завершения операции с запрошенным ресурсом.

Варианты:

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

node

dictionary

Словарь с описанием физического узла.

Возвращается: При успешном выполнении, если state имеет значение ‘present’.

allocation_id

string

UUID выделения, связанного с узлом. Если значение не равно null, оно будет совпадать с instance_id (обратное верно не всегда). В отличие от instance_id, это поле доступно только для чтения. Для удаления выделений используйте API выделений.

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

bios_interface

string

Интерфейс BIOS, используемый для этого узла.

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

boot_interface

string

Интерфейс загрузки узла, например «pxe».

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

boot_mode

string

Режим загрузки узла: «uefi» или «bios»

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

chassis_id

string

UUID корпуса, связанного с этим узлом. Может быть пустым или иметь значение None.

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

clean_step

string

Текущий этап очистки.

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

conductor

string

Кондуктор, который в данный момент обслуживает узел.

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

conductor_group

string

Группа кондукторов для узла.

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

console_interface

string

Интерфейс консоли узла, например «no-console».

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

created_at

string

Временная метка создания физического узла.

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

deploy_interface

string

Интерфейс развертывания узла, например «direct».

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

deploy_step

string

Текущий этап развертывания.

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

driver

string

Название драйвера.

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

driver_info

dictionary

Все метаданные, необходимые драйверу для управления этим узлом. Список полей зависит от драйвера; его можно получить из ресурса /v1/drivers/<DRIVER_NAME>/properties.

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

driver_internal_info

dictionary

Внутренние метаданные, заданные и сохраненные драйвером узла.

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

extra

dictionary

Набор из одной или нескольких произвольных пар «ключ — значение» метаданных.

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

fault

string

Поле fault указывает на активную ошибку, обнаруженную ironic; обычно узел находится в «режиме обслуживания». Значение None означает, что ironic не обнаружил ошибок. Значение «power failure» означает, что ironic не удалось получить состояние питания узла. Возможны и другие типы ошибок, например «clean failure» и «rescue abort failure».

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

id

string

UUID ресурса.

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

inspect_interface

string

Интерфейс, используемый для проверки узла.

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

instance_id

string

UUID экземпляра Nova, связанного с этим узлом.

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

instance_info

dictionary

Информация, используемая для настройки развернутого образа. Может включать размер корневого раздела, конфигурационный диск в кодировке base64 и другие метаданные. Обратите внимание: это поле автоматически очищается при удалении экземпляра (для этого запрашивается изменение состояния подготовки узла на DELETED).

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

is_automated_clean_enabled

boolean

Указывает, выполняется ли для узла автоматическая очистка.

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

is_console_enabled

boolean

Указывает, включен ли доступ к консоли этого узла.

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

is_maintenance

boolean

Находится ли узел в данный момент в «режиме обслуживания». Перевод узла в режим обслуживания исключает его из пула доступных ресурсов и приостанавливает некоторые внутренние процессы автоматизации. Это может произойти вручную (например, в результате запроса API) или автоматически, если Ironic обнаружит аппаратную неисправность, мешающую связаться с машиной.

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

is_protected

boolean

Защищен ли узел от отмены развертывания, повторной сборки и удаления.

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

is_retired

boolean

Выведен ли узел из эксплуатации и, следовательно, больше не может быть предоставлен, то есть переведен из состояния manageable в available; после очистки он перейдет в состояние manageable (а не available).

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

is_secure_boot

boolean

Указывает, загружен ли узел в данный момент с включенной функцией secure_boot.

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

last_error

string

Любая ошибка последней транзакции, которая была начата, но не завершилась.

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

links

list / elements=string

Список относительных ссылок, включая ссылки на ресурс и его закладку.

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

maintenance_reason

string

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

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

management_interface

string

Интерфейс для внеполосного управления узлом.

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

name

string

Удобный для чтения идентификатор ресурса узла. Может быть не задан. Некоторые слова зарезервированы.

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

network_interface

string

Провайдер сетевого интерфейса, используемый для настройки сетевых подключений этого узла.

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

owner

string

Строка или UUID арендатора, которому принадлежит объект.

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

port_groups

list / elements=string

Список групп портов ironic на этом узле.

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

ports

list / elements=string

Список портов ironic на этом узле.

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

power_interface

string

Интерфейс для управления питанием узла, например «ipmitool».

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

power_state

string

Текущее состояние питания узла. Обычно это «power on» или «power off», но может быть «None», если Ironic не может определить состояние питания (например, из-за аппаратного сбоя).

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

properties

dictionary

Физические характеристики этого узла. Заполняются ironic-inspector во время проверки. Их можно изменить в любой момент через REST API.

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

protected_reason

string

Причина, по которой узел помечен как защищенный.

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

provision_state

string

Текущее состояние подготовки узла.

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

raid_config

dictionary

Текущая конфигурация RAID узла. Появилась вместе с функцией очистки.

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

raid_interface

string

Интерфейс для настройки RAID на этом узле.

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

rescue_interface

string

Интерфейс для восстановления узла, например «no-rescue».

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

reservation

string

Имя узла Ironic Conductor, заблокировавшего этот узел, если блокировка установлена. Обычно имеет значение «null», но это поле может быть полезно при отладке.

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

resource_class

string

Строка, которую внешние планировщики могут использовать для идентификации узла как единицы ресурса определенного типа. Подробнее см. https://docs.openstack.org/ironic/latest/install/configure-nova-flavors.html

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

retired_reason

string

Причина, по которой узел помечен как выведенный из эксплуатации.

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

states

list / elements=string

Ссылки на коллекцию состояний.

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

storage_interface

string

Интерфейс для подключения и отключения томов на этом узле, например «cinder».

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

target_power_state

string

Если запрошен переход в другое состояние питания, это поле содержит запрошенное (то есть целевое) состояние: «power on» или «power off».

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

target_provision_state

string

Если запрошено действие по подготовке узла, это поле содержит запрошенное (то есть целевое) состояние. Обратите внимание: при переходе к целевому состоянию узел может пройти через несколько промежуточных состояний. Например, при запросе на развертывание экземпляра на узле в состоянии AVAILABLE последовательность смены состояний может быть такой: AVAILABLE -> DEPLOYING -> DEPLOYWAIT -> DEPLOYING -> ACTIVE

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

target_raid_config

dictionary

Запрошенная конфигурация RAID узла, которая будет применена при следующем переходе узла через состояние CLEANING. Появилась вместе с функцией очистки.

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

traits

list / elements=string

Список характеристик этого узла.

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

updated_at

string

Временная метка обновления физического узла.

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

vendor_interface

string

Интерфейс для функций, специфичных для поставщика, на этом узле, например «no-vendor».

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