Модуль google.cloud.gcp_bigtable_instance_info — сбор сведений об экземпляре GCP

Примечание

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

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

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

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

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

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

Ключ	Описание
resources complex	Список ресурсов Возвращается: всегда
clusters complex	Массив кластеров. Максимум — 4. Возвращается: при успехе
defaultStorageType string	Тип хранилища, используемого этим кластером для обслуживания таблиц родительского экземпляра, если он не переопределен явно. Возвращается: при успехе
location string	Местоположение узлов и хранилища этого кластера. Для оптимальной производительности клиенты должны находиться как можно ближе к кластеру. Сейчас поддерживаются только зоны, поэтому значения должны иметь вид `projects/<project>/locations/<zone>`. Возвращается: при успехе
name string	Уникальное имя кластера. Возвращается: при успехе
serveNodes integer	Количество узлов, выделенных этому кластеру. Большее количество узлов обеспечивает более высокую пропускную способность и более стабильную производительность. Возвращается: при успехе
state string	Текущее состояние кластера. Возвращается: при успехе
displayName string	Описательное имя экземпляра, отображаемое в пользовательских интерфейсах. Его можно изменить в любое время, но во избежание путаницы оно должно оставаться уникальным в глобальном масштабе. Возвращается: при успехе
labels dictionary	Метки — это гибкий и легковесный механизм организации облачных ресурсов в группы, отражающие организационные потребности и стратегии развертывания клиента. Их можно использовать для фильтрации ресурсов и агрегирования метрик. Возвращается: при успехе
name string	Уникальное имя экземпляра. Возвращается: при успехе
state string	Текущее состояние экземпляра. Возвращается: при успехе
type string	Тип экземпляра. По умолчанию — `PRODUCTION`. Возвращается: при успехе

Авторы

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