Модуль openstack.cloud.baremetal_inspect — явный запуск интроспекции узла baremetal в ironic.
Примечание
Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: openstack.cloud.baremetal_inspect.
Краткое описание
- Отправляет запрос Ironic на перевод узла в состояние интроспекции для сбора метаданных об узле. В зависимости от конфигурации драйвера ironic эта команда может выполняться вне полосы или в полосе. Это возможно только для узлов в состоянии ‘manageable’ и ‘available’.
Требования
На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.
- python >= 3.6
- openstacksdk >= 1.0.0
Параметры
Параметр | Описание |
|---|---|
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 соответствующим образом. |
ca_cert псевдонимы: cacert string | Путь к пакету сертификатов CA, который можно использовать для проверки запросов API по SSL. |
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. |
interface псевдонимы: endpoint_type string | Тип URL конечной точки, получаемой из каталога служб. Варианты:
|
mac string | Уникальный MAC-адрес, используемый для попытки определить хост. |
name псевдонимы: id, uuid string | Имя или идентификатор проверяемого узла. Несовместим с параметром mac |
region_name string | Имя региона. |
sdk_log_level string | Уровень журналирования OpenStackSDK Варианты:
|
sdk_log_path string | Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не записывается. |
timeout integer | Время ожидания запрошенного ресурса со стороны Ansible. По умолчанию: |
validate_certs псевдонимы: verify boolean | Следует ли проверять запросы API по SSL. До Ansible 2.3 значением по умолчанию было Варианты:
|
wait boolean | Должен ли Ansible ожидать завершения обработки запрошенного ресурса. Варианты:
|
Примечания
Примечание
- Вместо явного указания значений можно использовать стандартные переменные среды OpenStack, например
OS_USERNAME. - Данные аутентификации обрабатываются openstacksdk. Это означает, что значения могут быть взяты из файла конфигурации YAML в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды и, наконец, из явных параметров плейбуков. Дополнительные сведения см. на странице https://docs.openstack.org/openstacksdk/
Примеры
# Invoke node inspection
- openstack.cloud.baremetal_inspect:
name: "testnode1"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
node dictionary | Словарь с описанием узла после проверки Возвращается: changed |
|
allocation_id string |
UUID выделения, связанного с узлом. Возвращается: success |
|
bios_interface string |
Интерфейс BIOS, используемый для этого узла. Возвращается: success |
|
boot_interface string |
Интерфейс загрузки узла, например «pxe». Возвращается: success |
|
boot_mode string |
Текущее состояние режима загрузки (uefi/bios). Возвращается: success |
|
chassis_id string |
UUID шасси, связанного с этим узлом. Возвращается: success |
|
clean_step string |
Текущий этап очистки. Добавлено в рамках функции очистки. Возвращается: success |
|
conductor string |
Кондуктор, который в данный момент обслуживает узел. Возвращается: success |
|
conductor_group string |
Группа кондукторов для узла. Возвращается: success |
|
console_interface string |
Интерфейс консоли, используемый при работе с последовательной консолью. Возвращается: success Пример: |
|
created_at string |
Временная метка последнего обновления узла. Возвращается: success |
|
deploy_interface string |
Интерфейс развертывания узла Возвращается: success Пример: |
|
deploy_step string |
Текущий этап развертывания. Возвращается: success |
|
driver string |
Имя драйвера. Возвращается: success |
|
driver_info dictionary |
Все метаданные, необходимые драйверу для управления этим узлом. Список полей различается в зависимости от драйвера. Возвращается: success |
|
driver_internal_info dictionary |
Внутренние метаданные, заданные и сохраненные драйвером узла. Возвращается: success |
|
extra dictionary |
Один или несколько произвольных пар ключ-значение метаданных. Возвращается: success |
|
fault string |
Поле fault указывает на активную неисправность, обнаруженную ironic; обычно узел находится в «режиме обслуживания». Значение None означает, что ironic не обнаружил неисправностей. Значение «power failure» указывает, что ironic не удалось получить состояние питания этого узла. Возможны и другие типы, например «clean failure» и «rescue abort failure». Возвращается: success |
|
id string |
UUID ресурса. Возвращается: success |
|
inspect_interface string |
Интерфейс, используемый для проверки узла. Возвращается: success Пример: |
|
instance_id string |
UUID экземпляра Nova, связанного с этим узлом. Возвращается: success |
|
instance_info dictionary |
Информация, используемая для настройки развернутого образа. Может включать размер корневого раздела, закодированный в base64 диск конфигурации и другие метаданные. Обратите внимание: это поле автоматически очищается при удалении экземпляра (для этого запрашивается изменение состояния подготовки узла на DELETED). Возвращается: success |
|
is_automated_clean_enabled boolean |
Переопределяет включение автоматической очистки. Возвращается: success |
|
is_console_enabled boolean |
Указывает, включен или отключен доступ к консоли на этом узле. Возвращается: success |
|
is_maintenance boolean |
Находится ли этот узел в данный момент в «режиме обслуживания». Перевод узла в режим обслуживания исключает его из пула доступных ресурсов и останавливает часть внутренней автоматизации. Это может быть сделано вручную (например, с помощью запроса API) или автоматически, когда Ironic обнаруживает аппаратную неисправность, препятствующую связи с машиной. Возвращается: success |
|
is_protected boolean |
Защищен ли узел от отмены развертывания, пересборки и удаления. Возвращается: success |
|
is_retired boolean |
Помечен ли узел для вывода из эксплуатации. Возвращается: success |
|
is_secure_boot boolean |
Загружен ли узел в данный момент с включенной безопасной загрузкой. Возвращается: success |
|
last_error string |
Любая ошибка последней транзакции, которая началась, но не завершилась. Возвращается: success |
|
links list / elements=string |
Список относительных ссылок, включая ссылки self и bookmark. Возвращается: success |
|
maintenance_reason string |
Задаваемое пользователем описание причины перевода этого узла в режим обслуживания. Возвращается: success |
|
management_interface string |
Интерфейс для внеполосного управления узлом. Возвращается: success Пример: |
|
name string |
Понятный пользователю идентификатор ресурса Node. Некоторые слова зарезервированы. Возвращается: success |
|
network_interface string |
Поставщик сетевого интерфейса, используемый для настройки сетевых подключений этого узла. Возвращается: success |
|
owner string |
Строка или UUID арендатора, которому принадлежит объект. Возвращается: success |
|
port_groups list / elements=string |
Ссылки на коллекцию групп портов этого узла. Возвращается: success |
|
ports list / elements=string |
Ссылки на коллекцию портов этого узла Возвращается: success |
|
power_interface string |
Интерфейс, используемый для управления питанием узла. Возвращается: success Пример: |
|
power_state string |
Текущее состояние питания этого узла. Обычно это «power on» или «power off», но может быть «None», если Ironic не может определить состояние питания (например, из-за аппаратного сбоя). Возвращается: success |
|
properties dictionary |
Свойства узла, определенные при проверке Возвращается: success |
|
cpu_arch string |
Обнаруженный тип архитектуры ЦП Возвращается: success Пример: |
|
cpus string |
Количество ядер ЦП, указанное в обновленных свойствах узла. Возвращается: success Пример: |
|
local_gb string |
Общий объем локального дискового хранилища, указанный в свойствах узла. Возвращается: success Пример: |
|
memory_mb string |
Объем памяти узла, указанный в свойствах узла Возвращается: success Пример: |
|
protected_reason string |
Причина, по которой узел помечен как защищенный. Возвращается: success |
|
provision_state string |
Текущее состояние подготовки этого узла. Возвращается: success |
|
raid_config dictionary |
Текущая конфигурация RAID узла. Добавлено в рамках функции очистки. Возвращается: success |
|
raid_interface string |
Интерфейс, используемый для настройки RAID на этом узле. Возвращается: success Пример: |
|
rescue_interface string |
Интерфейс, используемый для восстановления узла. Возвращается: success Пример: |
|
reservation string |
Имя узла Ironic Conductor, блокирующего этот узел, если блокировка установлена. Обычно это «null», но это поле может быть полезно для отладки. Возвращается: success |
|
resource_class string |
Строка, с помощью которой внешние планировщики могут идентифицировать этот узел как единицу ресурса определенного типа. Возвращается: success |
|
retired_reason string |
TODO Возвращается: success |
|
states list / elements=string |
Ссылки на коллекцию состояний. Обратите внимание: этот ресурс также используется для запроса переходов между состояниями. Возвращается: success |
|
storage_interface string |
Интерфейс, используемый для подключения и отключения томов на этом узле, например «cinder». Возвращается: success |
|
target_power_state строка |
Если запрошен переход в другое состояние питания, это поле содержит запрошенное (то есть «целевое») состояние: «включено» или «выключено». Возвращается: success |
|
target_provision_state строка |
Если запрошено действие по подготовке, это поле содержит запрошенное (то есть «целевое») состояние. Обратите внимание, что при переходе к этому целевому состоянию узел может пройти через несколько состояний. Например, при запросе на развертывание экземпляра на узле в состоянии AVAILABLE узел может пройти следующую последовательность состояний: AVAILABLE -> DEPLOYING -> DEPLOYWAIT -> DEPLOYING -> ACTIVE. Возвращается: success |
|
target_raid_config словарь |
Запрошенная конфигурация RAID для узла, которая будет применена при следующем переходе узла через состояние CLEANING. Появилась с внедрением функции очистки. Возвращается: success |
|
traits список / elements=string |
Список характеристик этого узла. Возвращается: success |
|
updated_at строка |
TODO Возвращается: success |
|
vendor_interface строка |
Интерфейс для функций, специфичных для поставщика, на этом узле, например «no-vendor». Возвращается: success |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/openstack/cloud/baremetal_inspect_module.html