Модуль openstack.cloud.baremetal_deploy_template – создание/удаление ресурсов шаблонов развертывания на голом железе в OpenStack

Примечание

Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля необходимы дополнительные требования. Подробнее см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: openstack.cloud.baremetal_deploy_template.

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Создание, обновление и удаление шаблонов развертывания ironic в 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	Путь к набору сертификатов CA, который можно использовать для проверки запросов API по SSL.
client_cert псевдонимы: cert string	Путь к сертификату клиента, используемому при обмене данными по SSL.
client_key псевдонимы: key string	Путь к ключу клиента, используемому при обмене данными по SSL.
cloud any	Именованное облако или конфигурация облака, для которых выполняются операции. Если cloud — строка, она указывает на конфигурацию именованного облака из файла clouds.yaml OpenStack. Задает значения по умолчанию для auth и auth_type. Этот параметр не требуется, если указан auth или заданы переменные среды OpenStack OS_. Если cloud* — словарь, он содержит полную конфигурацию облака, аналогичную разделу файла clouds.yaml.
extra dictionary	Один или несколько произвольных пар «ключ — значение» метаданных.
id псевдонимы: uuid string	Идентификатор шаблона развертывания. Если не указан, создается автоматически.
interface псевдонимы: endpoint_type string	Тип URL конечной точки, получаемой из каталога служб. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
name string	Имя шаблона развертывания. Должно быть задано в формате имени характеристики (см. справочник API). Обязательно при создании шаблона развертывания. После этого можно использовать имя или идентификатор.
region_name string	Имя региона.
sdk_log_level string	Уровень ведения журнала OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path string	Путь к файлу журнала OpenStackSDK. Если значение не указано, журнал не ведется.
state string	Желаемое состояние ресурса Варианты: `"present"` ← (по умолчанию) `"absent"`
steps list / elements=dictionary	Список применяемых шагов развертывания. Обязательно при создании шаблона развертывания.
timeout integer	Сколько времени Ansible должен ожидать запрошенный ресурс. По умолчанию: `180`
validate_certs псевдонимы: verify boolean	Следует ли проверять запросы API по SSL. До Ansible 2.3 значение по умолчанию было `true`. Варианты: `false` `true`
wait boolean	Должен ли Ansible ожидать завершения операции с запрошенным ресурсом. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Вместо явного указания значений можно использовать стандартные переменные среды OpenStack, например OS_USERNAME.
Данные аутентификации обрабатываются openstacksdk. Это означает, что значения могут поступать из файла конфигурации yaml /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды и, наконец, из явно заданных параметров в плейбуках. Дополнительную информацию см. на странице https://docs.openstack.org/openstacksdk/

Примеры

- name: Create Bare Metal deploy template
  openstack.cloud.baremetal_deploy_template:
    cloud: devstack
    state: present
    name: CUSTOM_FOO
    steps:
      - interface: bios
        step: apply_configuration
        args:
          settings:
            - name: LogicalProc
              value: Enabled
        priority: 110
    extra:
      something: extra
  register: result

- name: Delete Bare Metal deploy template
  openstack.cloud.baremetal_deploy_template:
    cloud: devstack
    state: absent
    id: 1a85ebca-22bf-42eb-ad9e-f640789b8098
  register: result

- name: Update Bare Metal deploy template
  openstack.cloud.baremetal_deploy_template:
    cloud: devstack
    state: present
    id: 1a85ebca-22bf-42eb-ad9e-f640789b8098
    extra:
      something: new

Возвращаемые значения

Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
template dictionary	Словарь шаблона развертывания. В зависимости от поставщика облака может быть возвращено подмножество перечисленных ниже ключей словаря. Возвращается: success
created_at string	Время создания шаблона развертывания на голом железе (метка времени). Возвращается: success
extra dictionary	Один или несколько произвольных пар «ключ — значение» метаданных. Возвращается: success
id string	UUID ресурса шаблона развертывания на голом железе. Возвращается: success
links list / elements=string	Список относительных ссылок, включая ссылки на сам ресурс и закладку. Возвращается: success
location dictionary	Расположение ресурса в облаке (облако, проект, регион, зона) Возвращается: success
name string	Имя шаблона развертывания на голом железе. Возвращается: success
steps list / elements=dictionary	Список шагов развертывания. Возвращается: success
updated_at string	Время обновления шаблона развертывания на голом железе (метка времени). Возвращается: success

Авторы

Специальная группа OpenStack Ansible (SIG)

Ссылки на коллекцию

© 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_deploy_template_module.html