Spec-Zone.ru › Ansible 2.11

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

Примечание

Этот плагин входит в состав коллекции google.cloud (версия 1.0.2).

Для его установки используйте: 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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
auth_kind
строка / обязательно
    Варианты:
  • application
  • machineaccount
  • serviceaccount
Тип используемых учетных данных.
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_contents
jsonarg
Содержимое файла JSON учетной записи службы, представленное либо в виде словаря, либо как JSON-строка.
service_account_email
строка
Дополнительный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file
путь
Путь к файлу JSON учетной записи службы, если выбран тип serviceaccount.

Примечания

Примечание

  • для аутентификации можно установить service_account_file с помощью переменной среды gcp_service_account_file
  • для аутентификации можно установить service_account_contents с помощью переменной среды GCP_SERVICE_ACCOUNT_CONTENTS
  • для аутентификации можно установить service_account_email с помощью переменной среды GCP_SERVICE_ACCOUNT_EMAIL
  • для аутентификации можно установить 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"

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

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

Ключ Возвращаемое значение Описание
resources
сложное
всегда
Список ресурсов

host
строка
успех
Имя хоста, с которого пользователь может подключиться. Для операций вставки значение хоста по умолчанию - пустая строка. Для операций обновления хост указан в URL-адресе запроса. Имя хоста не может быть обновлено после вставки.

instance
словарь
успех
Имя экземпляра Cloud SQL. Не включает идентификатор проекта.

name
строка
успех
Имя пользователя в экземпляре Cloud SQL.

password
строка
успех
Пароль для пользователя.



Авторы

  • Google Inc. (@googlecloudplatform)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_sql_user_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API