openstack.cloud.os_group_info – Получение информации об одной или нескольких группах OpenStack

Примечание

Этот плагин является частью коллекции openstack.cloud (версия 1.2.1).

Для его установки используйте: ansible-galaxy collection install openstack.cloud.

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

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата

Обзор

Получение информации об одной или нескольких группах OpenStack.

Требования

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

openstacksdk
openstacksdk >= 0.12.0
python >= 3.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout целое число		Сколько времени (в секундах) сокет должен ожидать при таймауте вызовов API. Если этот параметр опущен, ничего не будет передано в библиотеку requests.
auth словарь		Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для плагина password по умолчанию он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или 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 строка		Имя или идентификатор домена, содержащего группу, если облако поддерживает домены
filters словарь		Словарь метаданных для дальнейшего фильтрации. Элементы этого словаря могут быть дополнительными словарями.
interface строка	Варианты: admin internal public ←	Тип URL конечной точки для получения из каталога служб. псевдонимы: endpoint_type
name строка		Имя или идентификатор группы.
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, затем из стандартных переменных среды, а затем из явных параметров в playbooks. Дополнительную информацию можно найти на https://docs.openstack.org/openstacksdk/

Примеры

# Gather info about previously created groups
- name: gather info
  hosts: localhost
  tasks:
    - name: Gather info about previously created groups
      openstack.cloud.identity_group_info:
        cloud: awesomecloud
      register: openstack_groups
    - debug:
        var: openstack_groups

# Gather info about a previously created group by name
- name: gather info
  hosts: localhost
  tasks:
    - name: Gather info about a previously created group by name
      openstack.cloud.identity_group_info:
        cloud: awesomecloud
        name: demogroup
      register: openstack_groups
    - debug:
        var: openstack_groups

# Gather info about a previously created group in a specific domain
- name: gather info
  hosts: localhost
  tasks:
    - name: Gather info about a previously created group in a specific domain
      openstack.cloud.identity_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
- name: gather info
  hosts: localhost
  tasks:
    - name: Gather info about a previously created group in a specific domain with filter
      openstack.cloud.identity_group_info:
        cloud: awesomecloud
        name: demogroup
        domain: admindomain
        filters:
          enabled: False
      register: openstack_groups
    - debug:
        var: openstack_groups

Значения возврата

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

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

Авторы

OpenStack Ansible SIG

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