Модуль google.cloud.gcp_spanner_instance_info — сбор информации об экземпляре GCP

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: google.cloud.gcp_spanner_instance_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.
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 an instance
  gcp_spanner_instance_info:
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

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

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

Ключ	Описание
resources complex	Список ресурсов Возвращается: всегда
config string	Имя конфигурации экземпляра (похожа на регион, но не совсем то же самое), которая определяет географическое размещение и репликацию баз данных в этом экземпляре. Она определяет, где хранятся ваши данные. Обычно значения имеют вид `regional-europe-west1`, `us-central` и т. д. Чтобы получить допустимый список, обратитесь к [разделу документации о конфигурации](https://cloud.google.com/spanner/docs/instances). Возвращается: при успешном выполнении
displayName string	Понятное имя этого экземпляра, отображаемое в пользовательских интерфейсах. Должно быть уникальным в проекте и содержать от 4 до 30 символов. Возвращается: при успешном выполнении
labels dictionary	Объект, содержащий список пар «ключ»: значение. Пример: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }. Возвращается: при успешном выполнении
name string	Уникальный идентификатор экземпляра, который нельзя изменить после его создания. Длина имени должна составлять от 6 до 30 символов. Возвращается: при успешном выполнении
nodeCount integer	Количество узлов, выделенных этому экземпляру. В terraform может присутствовать не более одного из параметров node_count и processing_units. . Возвращается: при успешном выполнении
processingUnits integer	Количество единиц обработки, выделенных этому экземпляру. В terraform может присутствовать не более одного из параметров processing_units и node_count. . Возвращается: при успешном выполнении

Авторы

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