Модуль google.cloud.gcp_redis_instance_info — сбор сведений об экземпляре GCP
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет 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 string | Токен доступа OAuth2, если тип учётных данных — accesstoken. |
auth_kind string / обязательный | Тип используемых учётных данных. Варианты:
|
env_type string | Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте этот параметр, если не уверены в его назначении. Он изменяет только строку User Agent для всех запросов API. |
project string | Проект Google Cloud Platform, который будет использоваться. |
region string / обязательный | Название региона Redis, в котором находится экземпляр. |
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_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 AUTH. Если задано значение «true», аутентификация AUTH включена для экземпляра. Значение по умолчанию — «false», то есть аутентификация AUTH отключена. Возвращается: при успехе |
|
authorizedNetwork string |
Полное имя сети Google Compute Engine, к которой подключён экземпляр. Если значение не указано, будет использоваться сеть по умолчанию. Возвращается: при успехе |
|
connectMode string |
Режим подключения экземпляра Redis. Возвращается: при успехе |
|
createTime string |
Время создания экземпляра в формате RFC3339 UTC «Zulu» с точностью до наносекунд. Возвращается: при успехе |
|
currentLocationId string |
Текущая зона размещения конечной точки Redis. Для экземпляров уровня Basic это всегда та же зона, которую пользователь указал при создании в [locationId]. Для экземпляров уровня Standard это может быть [locationId] или [alternativeLocationId]; значение может измениться после переключения при сбое. Возвращается: при успехе |
|
displayName string |
Произвольное необязательное имя экземпляра, заданное пользователем. Возвращается: при успехе |
|
host string |
Имя хоста или IP-адрес опубликованной конечной точки Redis, используемой клиентами для подключения к службе. Возвращается: при успехе |
|
labels dictionary |
Метки ресурса, содержащие метаданные, заданные пользователем. Возвращается: при успехе |
|
locationId string |
Зона, в которой будет размещён экземпляр. Если значение не указано, служба выберет зону самостоятельно. Для уровня STANDARD_HA экземпляры будут созданы в двух зонах для защиты от сбоев зоны. Если также задан параметр [alternativeLocationId], его значение должно отличаться от [locationId]. Возвращается: при успехе |
|
memorySizeGb integer |
Объём памяти Redis в ГиБ. Возвращается: при успехе |
|
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. Диапазоны должны быть уникальными и не пересекаться с существующими подсетями в авторизованной сети. Возвращается: при успехе |
|
serverCaCerts complex |
Список сертификатов центра сертификации сервера для экземпляра. Возвращается: при успехе |
|
cert string |
Серийный номер, извлечённый из сертификата. Возвращается: при успехе |
|
createTime string |
Время создания сертификата. Возвращается: при успехе |
|
expireTime string |
Время истечения срока действия сертификата. Возвращается: при успехе |
|
serialNumber string |
Серийный номер, извлечённый из сертификата. Возвращается: при успехе |
|
sha1Fingerprint string |
Отпечаток SHA-1 сертификата. Возвращается: при успехе |
|
tier string |
Уровень обслуживания экземпляра. Допустимые значения: - BASIC: автономный экземпляр - STANDARD_HA: экземпляры с высокой доступностью, основной и реплика . Возвращается: при успехе |
|
transitEncryptionMode string |
Режим TLS для экземпляра Redis. Если значение не указано, TLS для экземпляра отключён. - SERVER_AUTHENTICATION: шифрование трафика от клиента к серверу включено с аутентификацией сервера . Возвращается: при успехе |
Ссылки на коллекцию
© 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_redis_instance_info_module.html