openstack.cloud.baremetal_inspect модуль — Явно запускает интроспекцию узла Baremetal в ironic.
Примечание
Этот модуль входит в состав коллекции openstack.cloud (версия 2.2.0).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для её установки используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля необходимы дополнительные требования, см. Требования для подробностей.
Для использования в playbook укажите: openstack.cloud.baremetal_inspect.
Описание
- Запрашивает от Ironic установить узел в состояние инспекции для сбора метаданных об узле. Эта команда может быть вне очереди или в режиме реального времени в зависимости от конфигурации драйвера ironic. Это возможно только для узлов в состояниях «управляемый» и «доступный».
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 3.6
- openstacksdk >= 1.0.0
Параметры
Параметр | Комментарии |
|---|---|
api_timeout целое число | Сколько времени уровень сокета должен ждать перед истечением времени ожидания для вызовов API. Если это опущено, в библиотеку запросов ничего не будет передано. |
auth словарь | Словарь, содержащий информацию об авторизации, необходимую для стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать необходимые параметры подключаемого модуля авторизации. Этот параметр не требуется, если указано имя облака или присутствуют переменные среды OpenStack OS_*. |
auth_type строка | Имя подключаемого модуля авторизации для использования. Если облако использует что-то помимо парольной аутентификации, здесь должно быть указано имя подключаемого модуля, а содержимое параметра auth должно быть соответствующим образом обновлено. |
ca_cert алиасы: cacert строка | Путь к пакету CA-сертификата, который может быть использован в качестве части проверки запросов SSL API. |
client_cert алиасы: cert строка | Путь к клиенту сертификату для использования в рамках транзакции SSL. |
client_key алиасы: key строка | Путь к ключу клиента для использования в рамках транзакции SSL. |
cloud любой | Именованное облако или конфигурация облака для работы. Если cloud — строка, она ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не требуется, если задан auth или присутствуют переменные среды OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml. |
interface алиасы: endpoint_type строка | Тип URL конечной точки для извлечения из каталога служб. Варианты:
|
mac строка | уникальный MAC-адрес, используемый для идентификации узла. |
name алиасы: id, uuid строка | Имя или идентификатор узла для проверки. Взаимоисключающие с mac |
region_name строка | Имя региона. |
sdk_log_level строка | Уровень ведения журнала OpenStackSDK Варианты:
|
sdk_log_path строка | Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается |
timeout целое число | Сколько времени Ansible должно ждать запрашиваемого ресурса. По умолчанию: |
validate_certs алиасы: verify булево | Должны ли проверяться запросы SSL API. До Ansible 2.3 по умолчанию было Варианты:
|
wait булево | Должен ли 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 словарь | Словарь, описывающий узел после инспекции Возвращено: изменено |
|
allocation_id строка |
UUID выделения, связанного с узлом. Возвращено: успех |
|
bios_interface строка |
Интерфейс BIOS для данного узла. Возвращено: успех |
|
boot_interface строка |
Интерфейс загрузки для узла, например, “pxe”. Возвращено: успех |
|
boot_mode строка |
Текущее состояние режима загрузки (uefi/bios). Возвращено: успех |
|
chassis_id строка |
UUID корпуса, связанного с этим узлом. Возвращено: успех |
|
clean_step строка |
Текущая стадия очистки. Введено с функцией очистки. Возвращено: успех |
|
conductor строка |
Кондуктор, который в данный момент обслуживает узел. Возвращено: успех |
|
conductor_group строка |
Группа кондукторов для узла. Возвращено: успех |
|
console_interface строка |
Интерфейс консоли для работы с последовательной консолью. Возвращено: успех Пример: |
|
created_at строка |
Отметка времени последнего обновления узла. Возвращено: успех |
|
deploy_interface строка |
Интерфейс развертывания для узла Возвращено: успех Пример: |
|
deploy_step строка |
Текущая стадия развертывания. Возвращено: успех |
|
driver строка |
Имя драйвера. Возвращено: успех |
|
driver_info словарь |
Все метаданные, необходимые драйверу для управления этим узлом. Список полей варьируется в зависимости от драйвера. Возвращено: успех |
|
driver_internal_info словарь |
Внутренние метаданные, установленные и сохраненные драйвером узла. Возвращено: успех |
|
extra словарь |
Набор одного или нескольких произвольных пар ключ-значение метаданных. Возвращено: успех |
|
fault строка |
Ошибка указывает на обнаруженную ошибку ironic, как правило, узел находится в «режиме обслуживания». None означает, что ошибка ironic не обнаружена. «Отказ питания» указывает на то, что ironic не смог получить состояние питания этого узла. Возможны и другие типы ошибок, например, «отказ очистки» и «отказ аварийного восстановления». Возвращено: успех |
|
id строка |
UUID для ресурса. Возвращено: успех |
|
inspect_interface строка |
Интерфейс, используемый для инспекции узла. Возвращено: успех Пример: |
|
instance_id строка |
UUID экземпляра Nova, связанного с этим узлом. Возвращено: успех |
|
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 |
Читаемый человеком идентификатор ресурса узла. Некоторые слова зарезервированы. Возвращено: 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 |
Текущее состояние питания этого узла. Обычно «питание включено» или «питание выключено», но может быть «Нет», если 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 string |
Если был запрошен переход состояния питания, это поле представляет запрошенное (т. е. «целевое») состояние, либо «включено», либо «выключено». Возвращено: success |
|
target_provision_state string |
Если было запрошено действие подготовки, это поле представляет запрошенное (т. е. «целевое») состояние. Обратите внимание, что узел может пройти через несколько состояний во время перехода к этому целевому состоянию. Например, при запросе развертывания экземпляра на доступном узле узел может пройти через следующую последовательность изменений состояния: ДОСТУПНЫЙ -> РАЗВЕРТЫВАЕТСЯ -> ОЖИДАНИЕ_РАЗВЕРТЫВАНИЯ -> РАЗВЕРТЫВАЕТСЯ -> АКТИВНЫЙ. Возвращено: success |
|
target_raid_config dictionary |
Представляет запрошенную конфигурацию RAID узла, которая будет применена, когда узел в следующий раз перейдет через состояние ОЧИСТКИ. Введено с функцией очистки. Возвращено: success |
|
traits list / elements=string |
Список признаков для этого узла. Возвращено: success |
|
updated_at string |
TODO Возвращаемое значение: success |
|
vendor_interface string |
Интерфейс для функциональности, специфичной для поставщика, для этого узла, например, “no-vendor”. Возвращаемое значение: success |
Ссылки на коллекции
© 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/baremetal_inspect_module.html
