Модуль google.cloud.gcp_compute_snapshot_info — Сбор информации о снимке GCP
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.4.1).
Вы, возможно, уже установили эту коллекцию, если используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля требуются дополнительные зависимости, подробности см. в разделе Требования.
Для использования в книге задач укажите: google.cloud.gcp_compute_snapshot_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. |
filters список / элементы=строка | Список пар значений фильтров. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке будет добавлен как условие И (filter1 и filter2). |
project строка | Проект Google Cloud Platform, который использовать. |
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 a snapshot
gcp_compute_snapshot_info:
filters:
- name = test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
resources complex | Список ресурсов Возвращается: всегда |
|
creationTimestamp string |
Метка времени создания в текстовом формате RFC3339. Возвращается: успешно |
|
description string |
Необязательное описание этого ресурса. Возвращается: успешно |
|
diskSizeGb integer |
Размер снимка, указанный в ГБ. Возвращается: успешно |
|
id integer |
Уникальный идентификатор ресурса. Возвращается: успешно |
|
labelFingerprint string |
Отпечаток пальца, используемый для оптимистичной блокировки этого ресурса. Используется внутренне во время обновлений. Возвращается: успешно |
|
labels dictionary |
Метки, которые нужно применить к этому снимку. Возвращается: успешно |
|
licenses list / elements=string |
Список общедоступных лицензий, которые применяются к этому снимку. Это может быть связано с тем, что к исходному образу были прикреплены лицензии (например, образ Windows). snapshotEncryptionKey вложенный объект Шифрует снимок с использованием ключа шифрования, предоставленного клиентом. Возвращается: успешно |
|
name string |
Имя ресурса; предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. Возвращается: успешно |
|
snapshotEncryptionKey complex |
Предоставленный клиентом ключ шифрования снимка. Требуется, если исходный снимок защищен предоставленным клиентом ключом шифрования. Возвращается: успешно |
|
kmsKeyName string |
Имя ключа шифрования, хранящегося в Google Cloud KMS. Возвращается: успешно |
|
kmsKeyServiceAccount string |
Учетная запись сервисного агента, используемая для запроса шифрования для данного ключа KMS. Если отсутствует, используется учетная запись сервисного агента Compute Engine Service Agent. Возвращается: успешно |
|
rawKey string |
Указывает 256-битный ключ шифрования, предоставленный клиентом, закодированный в RFC 4648 base64 для шифрования или расшифровки этого ресурса. Возвращается: успешно |
|
sha256 string |
Хеш SHA-256, закодированный в RFC 4648 base64, предоставленного клиентом ключа шифрования, который защищает этот ресурс. Возвращается: успешно |
|
sourceDisk dictionary |
Ссылка на диск, используемый для создания этого снимка. Возвращается: успешно |
|
sourceDiskEncryptionKey complex |
Предоставленный клиентом ключ шифрования исходного снимка. Требуется, если исходный снимок защищен предоставленным клиентом ключом шифрования. Возвращается: успешно |
|
kmsKeyName string |
Имя ключа шифрования, хранящегося в Google Cloud KMS. Возвращается: успешно |
|
kmsKeyServiceAccount string |
Учетная запись сервисного агента, используемая для запроса шифрования для данного ключа KMS. Если отсутствует, используется учетная запись сервисного агента Compute Engine Service Agent. Возвращается: успешно |
|
rawKey string |
Указывает 256-битный ключ шифрования, предоставленный клиентом, закодированный в RFC 4648 base64 для шифрования или расшифровки этого ресурса. Возвращается: успешно |
|
storageBytes integer |
Размер хранилища, используемого снимком. Поскольку снимки используют общее хранилище, это число может меняться при создании/удалении снимка. Возвращается: успех |
|
storageLocations список / элементы=строка |
Расположение хранилища Cloud Storage снимка (региональное или многорегиональное). Возвращается: успех |
|
zone строка |
Ссылка на зону, в которой размещен диск. Возвращается: успех |
Ссылки на сборку
© 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_compute_snapshot_info_module.html
