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

Примечание

Этот модуль является частью коллекции openstack.cloud (версия 2.2.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 целое число	Сколько времени должна ждать сокетная прослойка, прежде чем произойдёт таймаут для вызовов API. Если это опущено, ничего не будет передано в библиотеку запросов.
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.
extra словарь	Набор одного или нескольких произвольных пар ключ-значение метаданных.
id псевдонимы: uuid строка	ID шаблона развертывания. Будет сгенерирован автоматически, если не указан.
interface псевдонимы: endpoint_type строка	Тип URL конечной точки для получения из каталога служб. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
name строка	Имя шаблона развертывания. Должен быть отформатирован как имя свойства (см. справку по API). Требуется при создании шаблона развертывания, после чего можно использовать имя или ID.
region_name строка	Имя региона.
sdk_log_level строка	Уровень логирования OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path строка	Путь к файлу журнала OpenStackSDK. Если пусто, журнал не будет записан
state строка	Указывает желаемое состояние ресурса Варианты: `"present"` ← (по умолчанию) `"absent"`
steps список / элементы=словарь	Список шагов развертывания для применения. Требуется при создании шаблона развертывания.
timeout целое число	Сколько времени Ansible должно ждать запрашиваемого ресурса. По умолчанию: `180`
validate_certs псевдонимы: verify логический	Необходимо ли проверять запросы 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 словарь	Словарь шаблона развертывания, подмножество ключей словаря может быть возвращено в зависимости от вашего облачного провайдера. Возвращается: success
created_at строка	Отметка времени создания шаблона развертывания Bare Metal. Возвращается: success
extra словарь	Набор одного или нескольких произвольных пар ключ-значение метаданных. Возвращается: success
id строка	UUID для ресурса шаблона развертывания Bare Metal. Возвращается: success
links список / элементы=строка	Список относительных ссылок, включая ссылки self и bookmark. Возвращается: success
location словарь	Расположение ресурса в облаке (облако, проект, регион, зона) Возвращается: success
name строка	Имя шаблона развертывания Bare Metal. Возвращается: success
steps список / элементы=словарь	Список шагов развертывания. Возвращается: success
updated_at строка	Отметка времени обновления шаблона развертывания Bare Metal. Возвращается: success

Авторы

OpenStack Ansible SIG

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

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