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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 string	Токен доступа OAuth2, если тип учетных данных — accesstoken.
auth_kind string / обязательный	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
env_type string	Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте этот параметр, если не знаете, что делаете. Он изменяет только строку User Agent для любых запросов API.
instance string / обязательный	Имя экземпляра Cloud SQL. Идентификатор проекта не включается.
project string	Проект Google Cloud Platform, который следует использовать.
scopes list / элементы=string	Массив областей доступа, которые следует использовать
service_account_contents jsonarg	Содержимое JSON-файла учетной записи службы — в виде словаря или JSON-строки, представляющей его.
service_account_email string	Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию.
service_account_file path	Путь к JSON-файлу учетной записи службы, если в качестве типа выбрано serviceaccount.

Примечания

Примечание

Для аутентификации можно задать 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 string	Значение набора символов. Подробную информацию и список поддерживаемых значений см. в разделах 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 string	Значение правила сортировки. Подробную информацию и список поддерживаемых значений см. в разделах 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 string	Имя экземпляра Cloud SQL. Идентификатор проекта не включается. Возвращается: при успешном выполнении
name string	Имя базы данных в экземпляре Cloud SQL. Идентификатор проекта и имя экземпляра не включаются. Возвращается: при успешном выполнении

Авторы

Google Inc. (@googlecloudplatform)

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

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