os_ironic_inspect - Явно запускает интроспекцию узла baremetal в ironic.
Новая версия с 2.1.
- Описание
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Описание
- Запрашивает Ironic установить узел в состояние интроспекции, чтобы собрать метаданные об узле. Эта команда может быть вне очереди или в очереди в зависимости от конфигурации драйвера ironic. Это возможно только для узлов в состояниях «управляемый» и «доступный».
Требования (к хосту, на котором выполняется модуль)
- python >= 2.7
- shade
Параметры
| параметр | обязательно | по умолчанию | возможные значения | комментарии |
|---|---|---|---|---|
| api_timeout | нет | None | Сколько времени должна ждать сокетная связь, прежде чем истечет время ожидания для API-вызовов. Если этот параметр опущен, ничего не будет передано в библиотеку запросов. | |
| auth | нет | Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля аутентификации облака. Для стандартного подключаемого модуля password он должен содержать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать необходимые параметры. Этот параметр не нужен, если указано имя облака или присутствуют переменные среды OpenStack OS_*. | ||
| auth_type | нет | password | Имя используемого подключаемого модуля аутентификации. Если облако использует аутентификацию, отличную от парольной, здесь должно быть указано имя подключаемого модуля, и содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone | нет | Игнорируется. Присутствует для обратной совместимости | ||
| cacert | нет | None | Путь к пакету сертификатов CA, который можно использовать для проверки SSL-API-запросов. | |
| cert | нет | None | Путь к клиенту сертификату для использования в рамках SSL-транзакции. | |
| cloud | нет | Наименование облака для работы с ним. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если задан параметр auth или если присутствуют переменные среды OpenStack OS_*. | ||
| endpoint_type | нет | public |
| Тип URL-адреса конечной точки для извлечения из каталога служб. |
| ironic_url | нет | None | Если используется режим noauth, необходимо установить значение endpoint URL для API Ironic. Используйте с настройками "auth" и "auth_type" установленные в None. | |
| key | нет | None | Путь к клиентскому ключу для использования в рамках SSL-транзакции. | |
| mac | нет | None | Уникальный MAC-адрес, используемый для идентификации хоста. | |
| name | нет | None | Уникальный идентификатор имени для идентификации хоста в Ironic. | |
| region_name | нет | Имя региона. | ||
| timeout | нет | 1200 | Время ожидания в секундах для указания роли ожидать завершения интроспекции узла, если wait установлен в True. | |
| uuid | нет | None | Глобально уникальный идентификатор (UUID) для идентификации хоста. | |
| validate_certs | нет | Необходимо ли проверять SSL-API-запросы. До версии 2.3 значение по умолчанию было True. псевдонимы: verify | ||
| wait | нет | да |
| Должен ли Ansible ожидать завершения запрошенного ресурса? |
Примеры
# Invoke node inspection
- os_ironic_inspect:
name: "testnode1"
Возвращаемые значения
Общие значения возврата документированы здесь Возвращаемые значения, следующие являются полями, уникальными для данного модуля:
| имя | описание | возвращается | тип | пример | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ansible_facts | Словарь новых фактов, представляющих обнаруженные свойства узла. | изменилось | сложное | ||||||||||||||||||||||||||
| содержит: |
| ||||||||||||||||||||||||||||
Примечания
Примечание
- Стандартные переменные окружения OpenStack, такие как
OS_USERNAME, могут использоваться вместо явного задания значений. - Информация об авторизации управляется os-client-config, что означает, что значения могут поступать из файла yaml-конфигурации в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, и наконец, из явных параметров в задачах. Более подробную информацию можно найти по адресу http://docs.openstack.org/developer/os-client-config
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантированно будет обратной совместимостью.
Для получения помощи в разработке модулей, если вы так решите, ознакомьтесь с Информация о сообществе и вклад, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/os_ironic_inspect_module.html