Модуль openstack.cloud.baremetal_node_info — Получение информации о узлах Bare Metal из OpenStack
Примечание
Этот модуль входит в коллекцию openstack.cloud (версия 2.2.0).
Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.
Чтобы использовать его в playbook, укажите: openstack.cloud.baremetal_node_info.
Описание
- Получение информации об узлах Bare Metal из OpenStack.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется данный модуль.
- python >= 3.6
- openstacksdk >= 1.0.0
Параметры
Параметр | Комментарии |
|---|---|
api_timeout целое число | Сколько времени должна ждать система сокетов перед истечением времени ожидания для вызовов API. Если это опущено, библиотеке requests ничего не будет передано. |
auth словарь | Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для стандартного плагина password он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если их поддерживает облако. Для других плагинов этот параметр должен содержать любые необходимые параметры плагина авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. |
auth_type строка | Имя плагина авторизации для использования. Если облако использует что-то кроме аутентификации по паролю, здесь должно быть указано имя плагина, и содержимое параметра auth должно быть соответствующим образом обновлено. |
ca_cert алиасы: cacert строка | Путь к пакету сертификата CA, который может использоваться при проверке запросов API SSL. |
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 алиасы: node строка | Имя или ID узла baremetal. |
region_name строка | Название региона. |
sdk_log_level строка | Уровень ведения журнала OpenStackSDK Варианты:
|
sdk_log_path строка | Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается. |
timeout целое число | Сколько времени Ansible должен ждать запрашиваемого ресурса. По умолчанию: |
validate_certs алиасы: verify логическое значение | Нужно ли проверять запросы API SSL. До 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/
Примеры
- 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 |
Интерфейс, используемый для проверки узла. Возвращено: 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 |
Указывает, загружен ли узел в данный момент с включенной функцией secure_boot. Возвращено: 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 |
Список групп портов Ironic на этом узле. Возвращено: success |
|
ports list / elements=string |
Список портов Ironic на этом узле. Возвращено: success |
|
power_interface string |
Интерфейс, используемый для выполнения действий с питанием на узле, например, «ipmitool». Возвращено: success |
|
power_state string |
Текущее состояние питания этого узла. Обычно «power on» или «power off», но может быть «None», если Ironic не может определить состояние питания (например, из-за аппаратного сбоя). Возвращено: success |
|
properties dictionary |
Физические характеристики этого узла. Заполняется ironic-inspector во время проверки. Может быть отредактировано через REST API в любое время. Возвращено: success |
|
protected_reason string |
Причина, по которой узел помечен как защищенный. Возвращено: success |
|
provision_state string |
Текущее состояние подготовки этого узла. Возвращено: success |
|
raid_config dictionary |
Представляет текущую конфигурацию RAID узла. Введено с функцией очистки. Возвращено: success |
|
raid_interface string |
Интерфейс, используемый для настройки RAID на этом узле. Возвращено: success |
|
rescue_interface string |
Интерфейс, используемый для спасения узла, например, «no-rescue». Возвращено: success |
|
reservation string |
Имя узла-проводника Ironic, который удерживает блокировку на этом узле, если блокировка удерживается. Обычно «null», но это поле может быть полезно для отладки. Возвращено: success |
|
resource_class string |
Строка, которая может использоваться внешними планировщиками для идентификации этого узла как единицы определенного типа ресурса. Для получения дополнительной информации см. https://docs.openstack.org/ironic/latest/install/configure-nova-flavors.html Возвращено: success |
|
retired_reason string |
Причина, по которой узел помечен как устаревший. Возвращено: success |
|
states list / elements=string |
Ссылки на коллекцию состояний. Возвращено: success |
|
storage_interface string |
Интерфейс, используемый для подключения и отключения томов на этом узле, например, «cinder». Возвращено: success |
|
target_power_state string |
Если был запрошен переход состояния питания, это поле представляет запрошенное (т.е. «целевое») состояние, либо «power on», либо «power off». Возвращено: success |
|
target_provision_state string |
Если было запрошено действие по подготовке, это поле представляет запрошенное (т.е. «целевое») состояние. Обратите внимание, что узел может пройти через несколько состояний во время перехода в это целевое состояние. Например, при запросе развертывания экземпляра на доступном узле узел может пройти следующую последовательность изменения состояния: AVAILABLE -> DEPLOYING -> DEPLOYWAIT -> DEPLOYING -> ACTIVE Возвращено: success |
|
target_raid_config dictionary |
Представляет запрашиваемую конфигурацию RAID узла, которая будет применена, когда узел в следующий раз перейдет в состояние CLEANING. Введено с функцией очистки. Возвращено: success |
|
traits list / elements=string |
Список признаков для этого узла. Возвращено: success |
|
updated_at string |
Метка времени последнего обновления узла Bare Metal. Возвращено: 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_node_info_module.html
