Модуль openstack.cloud.stack_info – Получение информации о стеках Heat

Примечание

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

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

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

Для использования в playbook, укажите: openstack.cloud.stack_info.

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

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

Получение информации о стеке Heat в OpenStack

Требования

Ниже указаны требования, необходимые на хосте, который выполняет этот модуль.

python >= 3.6
openstacksdk >= 1.0.0

Параметры

Параметр	Комментарии
api_timeout integer	Как долго слой сокетов должен ожидать перед истечением времени ожидания для вызовов API. Если это пропущено, ничего не будет передано в библиотеку запросов.
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	Путь к пакету сертификатов CA, который может использоваться в качестве части проверки запросов 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	Имя или ID родительского стека.
project aliases: project_id string	Имя или ID проекта.
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 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	Идентификатор родительского стека, если таковой имеется. Возвращено: success
replaced string	Список объектов ресурсов, которые будут заменены. Возвращено: success
status string	Статус стека. Возвращено: success
status_reason string	Описание перехода стека в текущее состояние. Возвращено: success
tags list / elements=string	Список строк, используемых в качестве тегов для стека. Возвращено: success
template dictionary	Словарь, содержащий шаблон, используемый для создания стека. Возвращено: success
template_description string	Текст описания шаблона стека. Возвращено: success
template_url string	URL, по которому можно найти шаблон стека. Возвращено: success
timeout_mins string	Тайм-аут операции со стеком в минутах. Возвращено: success
unchanged list / elements=string	Список объектов ресурсов, которые останутся неизменными, если стек. Возвращено: success
updated list / elements=string	Список объектов ресурсов, свойства которых будут обновлены. Возвращено: success
updated_at string	Метка времени последнего обновления стека. Возвращено: success
user_project_id string	Идентификатор пользовательского проекта, созданного для этого стека. Возвращено: 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/stack_info_module.html