google.cloud.gcp_redis_instance_info модуль — Сбор информации о виртуальной машине GCP
Примечание
Этот модуль является частью коллекции google.cloud (версия 1.4.1).
Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля требуются дополнительные зависимости. Подробнее см. раздел Требования.
Чтобы использовать его в книге задач, укажите: google.cloud.gcp_redis_instance_info.
Описание
- Сбор информации о виртуальной машине GCP
Требования
Ниже приведены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен доступа OAuth2, если тип учетных данных — accesstoken. |
auth_kind строка / обязательно | Тип используемых учетных данных. Варианты:
|
env_type строка | Указывает среду Ansible, в которой выполняется этот модуль. Не следует устанавливать, если вы не знаете, что делаете. Это влияет только на строку User Agent для запросов к API. |
project строка | Проект Google Cloud Platform для использования. |
region строка / обязательно | Название региона Redis для экземпляра. |
scopes список / элементы=строка | Массив используемых областей |
service_account_contents jsonarg | Содержимое JSON-файла учетной записи сервиса, либо в виде словаря, либо как строка JSON, представляющая его. |
service_account_email строка | Дополнительный адрес электронной почты учетной записи сервиса, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. |
service_account_file путь | Путь к файлу 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_redis_instance_info:
region: us-central1
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
resources complex | Список ресурсов Возвращается: всегда |
|
alternativeLocationId string |
Применимо только к уровню STANDARD_HA, который защищает экземпляр от сбоев в зонах, предоставляя его в двух зонах. Если указано, оно должно быть другой зоной, чем та, которая указана в [locationId]. Возвращается: успешно |
|
authEnabled boolean |
Необязательно. Указывает, включена ли аутентификация OSS Redis для экземпляра. Если установлено значение «true», аутентификация включена в экземпляре. Значение по умолчанию — «false», что означает, что аутентификация отключена. Возвращается: успешно |
|
authorizedNetwork string |
Полное имя сети Google Compute Engine, к которой подключен экземпляр. Если не указано, будет использоваться сеть по умолчанию. Возвращается: успешно |
|
connectMode string |
Режим подключения экземпляра Redis. Возвращается: успешно |
|
createTime string |
Время создания экземпляра в формате RFC3339 UTC «Zulu», точное до наносекунд. Возвращается: успешно |
|
currentLocationId string |
Текущая зона, где размещена конечная точка Redis. Для экземпляров базового уровня это всегда будет совпадать с [locationId], предоставленным пользователем во время создания. Для экземпляров стандартного уровня это может быть [locationId] или [alternativeLocationId], и может измениться после события отработки отказа. Возвращается: успешно |
|
displayName string |
Произвольное и необязательное имя, предоставленное пользователем для экземпляра. Возвращается: успешно |
|
host string |
Имя хоста или IP-адрес открытой конечной точки Redis, используемой клиентами для подключения к службе. Возвращается: успешно |
|
labels dictionary |
Метки ресурсов для представления метаданных, предоставленных пользователем. Возвращается: успешно |
|
locationId string |
Зона, в которой будет предоставлен экземпляр. Если не указано, служба выберет зону для экземпляра. Для уровня STANDARD_HA экземпляры будут создаваться в двух зонах для защиты от сбоев в зонах. Если также указан [alternativeLocationId], он должен отличаться от [locationId]. Возвращается: успешно |
|
memorySizeGb integer |
Размер памяти Redis в GiB. Возвращается: успешно |
|
name string |
Идентификатор экземпляра или полностью определенный идентификатор для экземпляра. Возвращается: успешно |
|
persistenceIamIdentity string |
Только для вывода. Идентификатор Cloud IAM, используемый операциями импорта/экспорта для передачи данных в/из Cloud Storage. Формат — «serviceAccount:». Значение может изменяться со временем для данного экземпляра, поэтому его следует проверять перед каждой операцией импорта/экспорта. Возвращается: успешно |
|
port integer |
Номер порта открытой конечной точки Redis. Возвращается: успешно |
|
redisConfigs dictionary |
Параметры конфигурации Redis в соответствии с http://redis.io/topics/config. Проверьте документацию Memorystore для списка поддерживаемых параметров: https://cloud.google.com/memorystore/docs/redis/reference/rest/v1/projects.locations.instances#Instance.FIELDS.redis_configs . Возвращается: успешно |
|
redisVersion string |
Версия программного обеспечения Redis. Если не указано, будет использоваться последняя поддерживаемая версия. Проверьте документацию API, приведенную выше, для получения последних допустимых значений. Возвращается: успешно |
|
region string |
Имя региона Redis экземпляра. Возвращается: успешно |
|
reservedIpRange string |
Диапазон CIDR внутренних адресов, зарезервированных для этого экземпляра. Если не указан, служба выберет неиспользуемый блок /29, например, 10.0.0.0/29 или 192.168.0.0/29. Диапазоны должны быть уникальными и не перекрываться с существующими подсетями в авторизованной сети. Возвращается: success |
|
serverCaCerts complex |
Список сертификатов серверной CA для экземпляра. Возвращается: success |
|
cert string |
Серийный номер, извлеченный из сертификата. Возвращается: success |
|
createTime string |
Время создания сертификата. Возвращается: success |
|
expireTime string |
Время истечения срока действия сертификата. Возвращается: success |
|
serialNumber string |
Серийный номер, извлеченный из сертификата. Возвращается: success |
|
sha1Fingerprint string |
Отпечаток SHA1 сертификата. Возвращается: success |
|
tier string |
Уровень сервиса экземпляра. Должно быть одно из этих значений: - BASIC: автономный экземпляр - STANDARD_HA: высокодоступные экземпляры первичный/реплики. Возвращается: success |
|
transitEncryptionMode string |
Режим TLS экземпляра Redis. Если не указан, TLS отключен для экземпляра.
Возвращается: success |
Ссылки на коллекции
© 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_redis_instance_info_module.html
