Модуль google.cloud.gcp_sql_database_info — Сбор информации о базе данных GCP

Примечание

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

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

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

Для использования в плейбуке укажите: google.cloud.gcp_sql_database_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. Не включает идентификатор проекта.
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 database
  gcp_sql_database_info:
    instance: "{{ instance.name }}"
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

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

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

Ключ	Описание
resources complex	Список ресурсов Возвращается: всегда
charset строка	Значение набора символов. Подробнее о наборах символов и сортировках MySQL см. в [Поддерживаемые наборы символов и сортировки](https://dev.mysql.com/doc/refman/5.7/en/charset-charsets.html), а о поддержке наборов символов в Postgres см. в [Поддержка наборов символов](https://www.postgresql.org/docs/9.6/static/multibyte.html). Для баз данных Postgres на этапе создания поддерживается только значение `UTF8`. Возвращается: успех
collation строка	Значение сортировки. Подробнее о наборах символов и сортировках MySQL см. в [Поддерживаемые наборы символов и сортировки](https://dev.mysql.com/doc/refman/5.7/en/charset-charsets.html), а о поддержке сортировок в Postgres см. в [Поддержка сортировок](https://www.postgresql.org/docs/9.6/static/collation.html). Для баз данных Postgres на этапе создания поддерживается только значение `en_US.UTF8`. Возвращается: успех
instance строка	Имя экземпляра Cloud SQL. Не включает идентификатор проекта. Возвращается: успех
name строка	Имя базы данных в экземпляре Cloud SQL. Не включает идентификатор проекта или имя экземпляра. Возвращается: успех

Авторы

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_database_info_module.html