os_group_info – Получение информации о группе OpenStack

Новая версия 2.9.

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

Описание

Получение информации о группе OpenStack.

Требования

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

openstacksdk
openstacksdk >= 0.12.0
python >= 2.7

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout целое число		Время ожидания сокета при таймауте API-запросов. Если этот параметр опущен, он не будет передан в библиотеку requests.
auth словарь		Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, os_user_domain_name или os_project_domain_name), если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать требуемые параметры. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*.
auth_type строка		Имя подключаемого модуля авторизации для использования. Если облако использует что-то помимо аутентификации по паролю, здесь должно быть указано имя подключаемого модуля, а содержимое параметра auth должно быть соответствующим образом обновлено.
availability_zone строка		Игнорируется. Присутствует для обратной совместимости.
ca_cert строка		Путь к пакету CA-сертификатов, который может использоваться при проверке SSL-API-запросов. псевдонимы: cacert
client_cert строка		Путь к клиенту сертификат для использования в рамках SSL-транзакции. псевдонимы: cert
client_key строка		Путь к ключу клиента для использования в рамках SSL-транзакции. псевдонимы: key
cloud сырые данные		Именованное облако или конфигурация облака для работы. Если cloud является строкой, она ссылается на конфигурацию именованного облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные окружения OpenStack OS_. Если cloud* является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml.
domain строка		Имя или ID домена, содержащего группу, если облако поддерживает домены.
filters словарь		Словарь метаданных для дополнительной фильтрации. Элементы этого словаря могут быть дополнительными словарями.
interface строка	Варианты: admin internal public ←	Тип URL-адреса конечной точки для извлечения из каталога сервисов. псевдонимы: endpoint_type
name строка / обязательно		Имя или ID группы.
region_name строка		Имя региона.
timeout целое число	Значение по умолчанию: 180	Время ожидания Ansible для запрашиваемого ресурса.
validate_certs булево	Варианты: нет ← да	Нужно ли проверять SSL API-запросы. До Ansible 2.3 по умолчанию было `yes`. псевдонимы: verify
wait булево	Варианты: нет да ←	Нужно ли ожидать, пока Ansible завершит запрашиваемый ресурс.

Примечания

Примечание

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

Примеры

# Gather info about previously created groups
- os_group_info:
    cloud: awesomecloud
  register: openstack_groups
- debug:
    var: openstack_groups

# Gather info about a previously created group by name
- os_group_info:
    cloud: awesomecloud
    name: demogroup
  register: openstack_groups
- debug:
    var: openstack_groups

# Gather info about a previously created group in a specific domain
- os_group_info:
    cloud: awesomecloud
    name: demogroup
    domain: admindomain
  register: openstack_groups
- debug:
    var: openstack_groups

# Gather info about a previously created group in a specific domain with filter
- os_group_info:
    cloud: awesomecloud
    name: demogroup
    domain: admindomain
    filters:
      enabled: False
  register: openstack_groups
- debug:
    var: openstack_groups

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

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

Ключ		Возвращается	Описание
openstack_groups сложное		всегда, но может быть пустым	Словарь, описывающий все соответствующие группы.
	description строка	успешно	Описание группы.
	domain_id булево	успешно	Идентификатор домена, содержащего группу (только облака keystone v3).
	id строка	успешно	Уникальный UUID.
	name строка	успешно	Имя, заданное группе.

Статус

Гарантии обратной совместимости интерфейса этого модуля нет. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Phillipe Smith (@phsmith)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/os_group_info_module.html