gcp_compute_snapshot_info – Сбор информации о снимке GCP
Новая версия с 2.9.
Обзор
- Сбор информации о снимке GCP
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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, используя переменную среды c(gcp_service_account_file).
- для аутентификации можно установить service_account_contents, используя переменную среды c(GCP_SERVICE_ACCOUNT_CONTENTS).
- для аутентификации можно установить service_account_email, используя переменную среды
GCP_SERVICE_ACCOUNT_EMAIL. - для аутентификации можно установить 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 сложное | всегда | Список ресурсов | ||
| creationTimestamp строка | успех | Дата и время создания в формате RFC3339. | ||
| description строка | успех | Необязательное описание этого ресурса. | ||
| diskSizeGb целое число | успех | Размер снимка в ГБ. | ||
| id целое число | успех | Уникальный идентификатор ресурса. | ||
| labelFingerprint строка | успех | Отпечаток, используемый для оптимистической блокировки этого ресурса. Используется во внутренних обновлениях. | ||
| labels словарь | успех | Метки, применяемые к этому снимку. | ||
| licenses список | успех | Список публичных лицензий, применимых к этому снимку. Это может быть связано с тем, что к исходному изображению были прикреплены лицензии (например, изображение Windows). snapshotEncryptionKey вложенный объект Шифрует снимок с использованием предоставленного клиентом ключа шифрования. | ||
| name строка | успех | Имя ресурса; предоставляется клиентом при создании ресурса. Длина имени должна быть от 1 до 63 символов и соответствовать RFC1035. То есть длина имени должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире. | ||
| snapshotEncryptionKey сложное | успех | Ключ шифрования, предоставленный клиентом, для снимка. Требуется, если исходный снимок защищен предоставленным клиентом ключом шифрования. | ||
| kmsKeyName строка | успех | Имя ключа шифрования, хранящегося в Google Cloud KMS. | ||
| rawKey строка | успех | Указывает 256-битный ключ шифрования, предоставленный клиентом, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса. | ||
| sha256 строка | успех | Закодированный в RFC 4648 base64 SHA-256 хэш ключа шифрования, предоставленного клиентом, который защищает этот ресурс. | ||
| sourceDisk словарь | успех | Ссылка на диск, используемый для создания этого снимка. | ||
| sourceDiskEncryptionKey сложное | успех | Ключ шифрования, предоставленный клиентом, для исходного снимка. Требуется, если исходный снимок защищен предоставленным клиентом ключом шифрования. | ||
| kmsKeyName строка | успех | Имя ключа шифрования, хранящегося в Google Cloud KMS. | ||
| rawKey строка | успех | Указывает 256-битный ключ шифрования, предоставленный клиентом, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса. | ||
| storageBytes целое число | успех | Размер хранилища, используемого снимком. Так как снимки используют общее хранилище, это число ожидается, что оно изменится при создании/удалении снимка. | ||
| zone строка | успех | Ссылка на зону размещения диска. | ||
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [предварительная версия]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Google Inc. (@googlecloudplatform)
Подсказка
Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/gcp_compute_snapshot_info_module.html