Spec-Zone.ru › Ansible

Модуль openstack.cloud.stack_info — получение сведений о стеках Heat

Примечание

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

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

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

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

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

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

  • Получение сведений о стеке Heat в 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

aliases: cacert

string

Путь к пакету сертификатов ЦС, который можно использовать для проверки SSL-запросов API.

client_cert

aliases: cert

string

Путь к сертификату клиента, используемому при SSL-подключении.

client_key

aliases: key

string

Путь к ключу клиента, используемому при SSL-подключении.

cloud

any

Именованное облако или конфигурация облака, с которым нужно работать. Если cloud — строка, она обозначает именованную конфигурацию облака, заданную в файле OpenStack clouds.yaml. Параметр задает значения по умолчанию для auth и auth_type. Этот параметр не требуется, если указан auth или заданы переменные среды OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, аналогичную разделу файла clouds.yaml.

interface

aliases: endpoint_type

string

Тип URL конечной точки, получаемой из каталога служб.

Варианты:

  • "admin"
  • "internal"
  • "public" ← (по умолчанию)

name

string

Имя стека.

owner

aliases: owner_id

string

Имя или идентификатор родительского стека.

project

aliases: project_id

string

Имя или идентификатор проекта.

region_name

string

Имя региона.

sdk_log_level

string

Уровень ведения журнала OpenStackSDK

Варианты:

  • "INFO" ← (по умолчанию)
  • "DEBUG"

sdk_log_path

string

Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не записывается.

status

string

Состояние стека, например available

timeout

integer

Время ожидания запрошенного ресурса в Ansible.

По умолчанию: 180

validate_certs

aliases: verify

boolean

Нужно ли проверять SSL-запросы API.

До 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: Fetch all Heat stacks
  openstack.cloud.stack_info:
    cloud: devstack

- name: Fetch a single Heat stack
  openstack.cloud.stack_info:
    cloud: devstack
    name: my_stack

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

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

Ключ

Описание

stacks

list / elements=dictionary

Список словарей с описанием стеков.

Возвращается: всегда.

added

list / elements=string

Список объектов ресурсов, которые будут добавлены.

Возвращается: при успехе

capabilities

list / elements=string

Перечень возможностей шаблона, совместимого с AWS.

Возвращается: при успехе

created_at

string

Время создания.

Возвращается: при успехе

Пример: "2016-07-05T17:38:12Z"

deleted

list / elements=string

Список объектов ресурсов, которые будут удалены.

Возвращается: при успехе

deleted_at

string

Время удаления.

Возвращается: при успехе

Пример: "2016-07-05T17:38:12Z"

description

string

Описание стека, указанное в шаблоне heat.

Возвращается: при успехе

Пример: "HOT template to create a new instance and networks"

environment

dictionary

Среда JSON для стека.

Возвращается: при успехе

environment_files

list / elements=string

Упорядоченный список имён файлов среды, найденных в словаре files.

Возвращается: при успехе

files

dictionary

Дополнительные файлы, на которые ссылается шаблон или среда

Возвращается: при успехе

files_container

string

Имя контейнера swift с дочерними шаблонами и файлами.

Возвращается: при успехе

id

string

Идентификатор стека.

Возвращается: при успехе

Пример: "97a3f543-8136-4570-920e-fd7605c989d6"

is_rollback_disabled

boolean

Поддерживает ли стек откат.

Возвращается: при успехе

links

list / elements=dictionary

Ссылки на текущий стек.

Возвращается: при успехе

Пример: "[{'href': 'http://foo:8004/v1/7f6a/stacks/test-stack/ 97a3f543-8136-4570-920e-fd7605c989d6']"

name

string

Имя стека

Возвращается: при успехе

Пример: "test-stack"

notification_topics

string

События, связанные со стеком.

Возвращается: при успехе

Пример: "HOT template to create a new instance and networks"

outputs

list / elements=dictionary

Результат, возвращаемый стеком.

Возвращается: при успехе

Пример: "[{'description': 'IP of server1 in private network', 'output_key': 'server1_private_ip', 'output_value': '10.1.10.103'}]"

owner_id

string

Идентификатор родительского стека, если он есть.

Возвращается: при успехе

parameters

dictionary

Параметры текущего стека

Возвращается: при успехе

Пример: "{'OS::project_id': '7f6a3a3e01164a4eb4eecb2ab7742101', 'OS::stack_id': '97a3f543-8136-4570-920e-fd7605c989d6', 'OS::stack_name': 'test-stack', 'stack_status': 'CREATE_COMPLETE', 'stack_status_reason': 'Stack CREATE completed successfully', 'status': 'COMPLETE', 'template_description': 'HOT template to create a new instance and nets', 'timeout_mins': 60, 'updated_time': null}"

parent_id

string

Идентификатор родительского стека, если он есть.

Возвращается: при успехе

replaced

string

Список объектов ресурсов, которые будут заменены.

Возвращается: при успехе

status

string

Статус стека.

Возвращается: при успехе

status_reason

string

Описание перехода стека в текущее состояние.

Возвращается: при успехе

tags

list / elements=string

Список строк, используемых в качестве тегов стека

Возвращается: при успехе

template

dictionary

Словарь с шаблоном, использованным для создания стека.

Возвращается: при успехе

template_description

string

Текст описания шаблона стека.

Возвращается: при успехе

template_url

string

URL-адрес, по которому находится шаблон стека.

Возвращается: при успехе

timeout_mins

string

Время ожидания операции со стеком в минутах.

Возвращается: при успехе

unchanged

list / elements=string

Список объектов ресурсов, которые останутся без изменений в стеке.

Возвращается: при успехе

updated

list / elements=string

Список объектов ресурсов, свойства которых будут обновлены.

Возвращается: при успехе

updated_at

string

Время последнего обновления стека.

Возвращается: при успехе

user_project_id

string

Идентификатор пользовательского проекта, созданного для этого стека.

Возвращается: при успехе

Авторы

  • 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/stack_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API