Модуль google.cloud.gcp_sql_user_info – Сбор информации о пользователе GCP

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: google.cloud.gcp_sql_user_info.

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

Описание

Сбор информации о пользователе GCP

Требования

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

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

Параметры

Параметр	Комментарии
access_token строка	Токен доступа OAuth2, если тип аутентификации — accesstoken.
auth_kind строка / обязательно	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
env_type строка	Указывает среду Ansible, в которой выполняется этот модуль. Это поле следует устанавливать только при необходимости. Это влияет только на строку User Agent для запросов к API.
instance словарь / обязательно	Имя экземпляра Cloud SQL. Не включает идентификатор проекта. Это поле представляет ссылку на ресурс Instance в GCP. Его можно указать двумя способами. Во-первых, можно указать словарь с ключом ‘name’ и значением имени ресурса. Во-вторых, можно добавить `register: name-of-resource` к задаче gcp_sql_instance, а затем установить это поле instance в «{{ name-of-resource }}».
project строка	Проект Google Cloud Platform для использования.
scopes список / элементы=строка	Массив используемых областей
...	...

Примечания

Примечание

для аутентификации можно установить service_account_file с помощью переменной среды GCP_SERVICE_ACCOUNT_FILE.
для аутентификации можно установить service_account_contents с помощью переменной среды GCP_SERVICE_ACCOUNT_CONTENTS.
для аутентификации можно установить service_account_email с помощью переменной среды GCP_SERVICE_ACCOUNT_EMAIL.
для аутентификации можно установить access_token с помощью переменной среды GCP_ACCESS_TOKEN.
для аутентификации можно установить auth_kind с помощью переменной среды GCP_AUTH_KIND.
для аутентификации можно установить scopes с помощью переменной среды GCP_SCOPES.
Значения переменных среды будут использоваться только в случае, если значения в книге задач не заданы.
Параметры service_account_email и service_account_file взаимоисключающие.

Примеры

- name: get info on a user
  gcp_sql_user_info:
    instance: "{{ instance }}"
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

END_OF_DOCUMENT_MARKER

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

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

Ключ	Описание
resources сложный	Список ресурсов Возвращается: всегда
host строка	Имя хоста, с которого пользователь может подключиться. Для операций вставки хост по умолчанию пустая строка. Для операций обновления хост указан в URL-адресе запроса. Имя хоста нельзя обновить после вставки. Возвращается: успех
instance словарь	Имя экземпляра Cloud SQL. Это не включает идентификатор проекта. Возвращается: успех
name строка	Имя пользователя в экземпляре Cloud SQL. Возвращается: успех
password строка	Пароль для пользователя. Возвращается: успех

Авторы

Google Inc. (@googlecloudplatform)

Ссылки на коллекцию

© 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/google/cloud/gcp_sql_user_info_module.html