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

Примечание

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

Эта коллекция, возможно, уже установлена, если вы используете пакет 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 строка	Токен доступа OAuth2, если тип учетных данных — accesstoken.
auth_kind строка / обязательно	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
env_type строка	Указывает, в какой среде Ansible выполняется этот модуль. Необходимо устанавливать только при необходимости. Это только изменяет строку User Agent для любых запросов API.
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 an instance
  gcp_spanner_instance_info:
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

END_OF_DOCUMENT_MARKER

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

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

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

Авторы

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