os_project_info – Получение информации о проектах OpenStack

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

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

Получение информации о проектах OpenStack
Этот модуль назывался os_project_facts до Ansible 2.9, возвращая ansible_facts. Обратите внимание, что модуль os_project_info больше не возвращает ansible_facts!

Псевдонимы: os_project_facts

Требования

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

openstacksdk
openstacksdk >= 0.12.0
python >= 2.7

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout целое число		Сколько времени должна ждать транспортная среда, прежде чем произойдёт таймаут при выполнении API-запросов. Если параметр не указан, то в библиотеку запросов ничего не будет передано.
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 -		Имя или идентификатор домена, содержащего проект, если облако поддерживает домены
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, а затем из стандартных переменных среды, и наконец, из явных параметров в задачах. Более подробная информация доступна по адресу https://docs.openstack.org/openstacksdk/

Примеры

# Gather information about previously created projects
- os_project_info:
    cloud: awesomecloud
  register: result
- debug:
    msg: "{{ result.openstack_projects }}"

# Gather information about a previously created project by name
- os_project_info:
    cloud: awesomecloud
    name: demoproject
  register: result
- debug:
    msg: "{{ result.openstack_projects }}"

# Gather information about a previously created project in a specific domain
- os_project_info:
    cloud: awesomecloud
    name: demoproject
    domain: admindomain
  register: result
- debug:
    msg: "{{ result.openstack_projects }}"

# Gather information about a previously created project in a specific domain with filter
- os_project_info:
    cloud: awesomecloud
    name: demoproject
    domain: admindomain
    filters:
      enabled: False
  register: result
- debug:
    msg: "{{ result.openstack_projects }}"

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

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

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

Статус

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

Авторы

Ricardo Carrillo Cruz (@rcarrillocruz)

Подсказка

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

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