Модуль google.cloud.gcp_compute_image_info – Сбор информации о GCP-образе
Примечание
Этот модуль является частью коллекции google.cloud (версия 1.4.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля необходимы дополнительные требования, см. Требования для подробностей.
Чтобы использовать его в книге задач, укажите: google.cloud.gcp_compute_image_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. Каждый дополнительный фильтр в списке будет добавлен как условие И (фильтр1 и фильтр2). |
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 an image
gcp_compute_image_info:
filters:
- name = test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Значения возврата
Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:
Ключ | Описание |
|---|---|
resources сложный | Список ресурсов Возвращается: всегда |
|
archiveSizeBytes целое число |
Размер архива образа tar.gz, хранящегося в Google Cloud Storage (в байтах). Возвращается: успешно |
|
creationTimestamp строка |
Дата и время создания в формате RFC3339. Возвращается: успешно |
|
deprecated сложный |
Статус устаревания этого образа. Возвращается: успешно |
|
deleted строка |
Необязательная метка времени RFC3339, после которой состояние этого ресурса предполагается изменить на УДАЛЁННЫЙ. Эта информация носит только информативный характер, и статус не изменится, если клиент не изменит его явно. Возвращается: успешно |
|
deprecated строка |
Необязательная метка времени RFC3339, после которой состояние этого ресурса предполагается изменить на УСТАРЕВШИЙ. Эта информация носит только информативный характер, и статус не изменится, если клиент не изменит его явно. Возвращается: успешно |
|
obsolete строка |
Необязательная метка времени RFC3339, после которой состояние этого ресурса предполагается изменить на УСТАРЕВШИЙ. Эта информация носит только информативный характер, и статус не изменится, если клиент не изменит его явно. Возвращается: успешно |
|
replacement строка |
URL рекомендуемого ресурса, заменяющего устаревший. Рекомендуемый заменяющий ресурс должен быть того же типа, что и устаревший ресурс. Возвращается: успешно |
|
state строка |
Состояние устаревания этого ресурса. Это может быть УСТАРЕВШИЙ, УСТАРЕВШИЙ или УДАЛЁННЫЙ. Операции, создающие новый ресурс с помощью устаревшего ресурса, будут выполнены успешно, но с предупреждением об устаревшем ресурсе и рекомендацией его замены. Операции с использованием устаревших или удалённых ресурсов будут отклонены и приведут к ошибке. Возвращается: успешно |
|
description строка |
Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. Возвращается: успешно |
|
diskSizeGb целое число |
Размер образа при восстановлении на постоянный диск (в ГБ). Возвращается: успешно |
|
family строка |
Имя семейства образов, к которому принадлежит этот образ. Вы можете создавать диски, указав семейство образов вместо имени конкретного образа. Семейство образов всегда возвращает свой последний образ, который не устарел. Имя семейства образов должно соответствовать RFC1035. Возвращается: успешно |
|
guestOsFeatures сложный |
Список функций, которые нужно включить в гостевой операционной системе. Применимо только для загружаемых образов. Возвращается: успешно |
|
type строка |
Тип поддерживаемой функции. Возвращается: успешно |
|
id целое число |
Уникальный идентификатор ресурса. Этот идентификатор определяется сервером. Возвращается: успешно |
|
imageEncryptionKey сложный |
Шифрует образ с помощью предоставленного клиентом ключа шифрования. После шифрования образа с помощью ключа, предоставленного клиентом, вы должны предоставить тот же ключ, если вы позже используете образ (например, для создания диска из образа). Возвращается: успешно |
|
rawKey строка |
Указывает 256-битный ключ шифрования, предоставленный клиентом, закодированный в RFC 4648 base64 для шифрования или расшифрования этого ресурса. Возвращается: успешно |
|
sha256 строка |
Кодированный в RFC 4648 base64 SHA-256 хэш ключа шифрования, предоставленного клиентом, который защищает этот ресурс. Возвращается: успешно |
|
labelFingerprint string |
Отпечаток, используемый для оптимистичной блокировки этого ресурса. Используется внутренне во время обновлений. Возвращено: success |
|
labels dictionary |
Метки, которые нужно применить к этому изображению. Возвращено: success |
|
licenses list / elements=string |
Любой применимый URI лицензии. Возвращено: success |
|
name string |
Имя ресурса; предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. Возвращено: success |
|
rawDisk complex |
Параметры образа необработанного дискового устройства. Возвращено: success |
|
containerType string |
Формат, используемый для кодирования и передачи блочного устройства, который должен быть TAR. Это всего лишь контейнер и формат передачи, а не формат времени выполнения. Предоставляется клиентом при создании образа диска. Возвращено: success |
|
sha1Checksum string |
Необязательная контрольная сумма SHA1 образа диска до распаковки. Это предоставляется клиентом при создании образа диска. Возвращено: success |
|
source string |
Полный URL-адрес Google Cloud Storage, где хранится хранилище дисков. Вы должны указать либо это свойство, либо свойство sourceDisk, но не оба. Возвращено: success |
|
sourceDisk dictionary |
Исходный диск, на основе которого создается это изображение. Вы должны указать либо это свойство, либо свойство rawDisk.source, но не оба, чтобы создать изображение. Возвращено: success |
|
sourceDiskEncryptionKey complex |
Предоставленный клиентом ключ шифрования исходного диска. Требуется, если исходный диск защищен ключом шифрования, предоставленным клиентом. Возвращено: success |
|
rawKey string |
Указывает 256-битный ключ шифрования, предоставленный клиентом, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса. Возвращено: success |
|
sha256 string |
Хеш SHA-256, закодированный в RFC 4648 base64, предоставленного клиентом ключа шифрования, который защищает этот ресурс. Возвращено: success |
|
sourceDiskId string |
Значение ID диска, используемого для создания этого образа. Это значение может использоваться для определения того, был ли образ взят из текущего или предыдущего экземпляра данного имени диска. Возвращено: success |
|
sourceImage dictionary |
URL исходного изображения, используемого для создания этого изображения. Для создания изображения необходимо указать полный или частичный URL-адрес одного из следующих элементов: * URL selfLink * Это свойство * URL rawDisk.source * URL sourceDisk. Возвращено: success |
|
sourceSnapshot dictionary |
URL исходного снимка, используемого для создания этого изображения. Для создания изображения необходимо указать полный или частичный URL-адрес одного из следующих элементов: * URL selfLink * Это свойство * URL sourceImage * URL rawDisk.source * URL sourceDisk. Возвращено: success |
|
sourceType string |
Тип изображения, используемого для создания этого диска. Значение по умолчанию и единственное значение — RAW. Возвращено: 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_compute_image_info_module.html
