Модуль openstack.cloud.baremetal_node_info — получение информации об узлах Bare Metal из OpenStack
Примечание
Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: openstack.cloud.baremetal_node_info.
Краткое описание
- Получение информации об узлах Bare Metal из OpenStack.
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
- 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 | Путь к набору сертификатов ЦС, который используется для проверки запросов 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 псевдонимы: node string | Имя или идентификатор узла bare metal. |
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/
Примеры
- name: Gather information about all baremeal nodes
openstack.cloud.baremetal_node_info:
cloud: "devstack"
register: nodes
- debug: var=nodes
- name: Gather information about a baremeal node
openstack.cloud.baremetal_node_info:
cloud: "devstack"
name: "00000000-0000-0000-0000-000000000002"
register: nodes
- debug: var=nodes
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, относящиеся только к этому модулю:
Ключ | Описание |
|---|---|
baremetal_nodes list / elements=dictionary | То же, что и Возвращается: всегда |
nodes list / elements=dictionary | Список узлов Bare Metal. В зависимости от поставщика облачных услуг может возвращаться подмножество перечисленных ниже ключей словаря. Возвращается: всегда |
|
allocation_id string |
UUID связанного с узлом выделения ресурсов. Если значение не равно null, оно совпадает с instance_id (обратное верно не всегда). В отличие от instance_id, это поле доступно только для чтения. Для удаления выделений ресурсов используйте API Allocation. Возвращается: при успешном выполнении |
|
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 |
Временная метка создания узла Bare Metal. Возвращается: при успешном выполнении |
|
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 |
Ошибка указывает на активную неисправность, обнаруженную 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 |
Список относительных ссылок, включая ссылки self и bookmark. Возвращается: при успешном выполнении |
|
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 |
Временная метка обновления узла Bare Metal. Возвращается: при успехе |
|
vendor_interface string |
Интерфейс для функций, специфичных для поставщика, на этом узле, например «no-vendor». Возвращается: при успехе |
Ссылки коллекции
© 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_node_info_module.html