Модуль google.cloud.gcp_bigtable_instance_info — Сбор информации о виртуальной машине GCP

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 строка	Токен доступа 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_bigtable_instance_info:
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

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

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

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

Авторы

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