gcp_compute_image_info – Сбор информации о GCP-образе

Новое в версии 2.7.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Обзор

Сбор информации о GCP-образе
Этот модуль назывался gcp_compute_image_facts до Ansible 2.9. Способ использования не изменился.

Псевдонимы: gcp_compute_image_facts

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
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 an image
  gcp_compute_image_info:
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:

Ключ			Возвращаемое значение	Описание
resources complex			всегда	Список ресурсов
	archiveSizeBytes integer		успешно	Размер архива изображения tar.gz, хранящегося в Google Cloud Storage (в байтах).
	creationTimestamp string		успешно	Маркер создания в формате RFC3339.
	deprecated complex		успешно	Статус устаревания, связанный с этим изображением.
		deleted string	успешно	Необязательный маркер времени RFC3339, после которого состояние этого ресурса предполагается изменить на DELETED. Эта информация носит только информационный характер, и статус не изменится, пока клиент явно его не изменит.
		deprecated string	успешно	Необязательный маркер времени RFC3339, после которого состояние этого ресурса предполагается изменить на DEPRECATED. Эта информация носит только информационный характер, и статус не изменится, пока клиент явно его не изменит.
		obsolete string	успешно	Необязательный маркер времени RFC3339, после которого состояние этого ресурса предполагается изменить на OBSOLETE. Эта информация носит только информационный характер, и статус не изменится, пока клиент явно его не изменит.
		replacement string	успешно	URL рекомендуемого замены для устаревшего ресурса. Рекомендуемый ресурс замены должен быть того же типа, что и устаревший ресурс.
		state string	успешно	Состояние устаревания этого ресурса. Может быть DEPRECATED, OBSOLETE или DELETED. Операции, создающие новый ресурс, используя DEPRECATED ресурс, будут успешны, но с предупреждением об устаревшем ресурсе и рекомендацией замены. Операции, использующие OBSOLETE или DELETED ресурсы, будут отклонены и приведут к ошибке.
	description string		успешно	Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.
	diskSizeGb integer		успешно	Размер изображения при восстановлении на постоянный диск (в ГБ).
	family string		успешно	Имя семейства изображений, к которому принадлежит это изображение. Вы можете создавать диски, указывая семейство изображений вместо конкретного имени изображения. Семейство изображений всегда возвращает свое последнее изображение, которое не устарело. Имя семейства изображений должно соответствовать RFC1035.
	guestOsFeatures complex		успешно	Список функций для включения в гостевой ОС. Применимо только для загружаемых изображений. В настоящее время может быть включена только одна функция, VIRTIO_SCSI_MULTIQUEUE, которая позволяет каждому виртуальному процессору иметь свою очередь. Для Windows-изображений вы можете включить VIRTIO_SCSI_MULTIQUEUE только для изображений с версией драйвера 1.2.0.1621 или выше. Linux-изображения с ядрами версии 3.17 и выше будут поддерживать VIRTIO_SCSI_MULTIQUEUE. Для новых Windows-изображений сервер также может заполнить это поле значением WINDOWS, чтобы указать, что это Windows-изображение. Это значение носит только информационный характер и не включает или отключает какие-либо функции.
		type string	успешно	Тип поддерживаемой функции. В настоящее время поддерживается только VIRTIO_SCSI_MULTIQUEUE. Для более новых Windows-изображений сервер также может заполнить это свойство значением WINDOWS, чтобы указать, что это Windows-изображение. Это значение носит только информационный характер и не включает или отключает какие-либо функции.
	id integer		успешно	Уникальный идентификатор ресурса. Этот идентификатор определяется сервером.
	imageEncryptionKey complex		успешно	Шифрует изображение с помощью предоставленного клиентом ключа шифрования. После шифрования изображения с помощью предоставленного клиентом ключа, необходимо предоставить тот же ключ, если вы будете использовать изображение позже (например, для создания диска из изображения).
		rawKey string	успешно	Указывает 256-битный предоставленный клиентом ключ шифрования, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса.
		sha256 string	успешно	Закодированный в RFC 4648 base64 SHA-256 хэш предоставленного клиентом ключа шифрования, защищающего этот ресурс.
	labelFingerprint string		успешно	Отпечаток, используемый для оптимистической блокировки этого ресурса. Используется во время обновлений.
	labels dictionary		успешно	Метки для применения к этому изображению.
	licenses list		успешно	Любой применимый URI лицензии.
	name string		успешно	Имя ресурса; предоставляется клиентом при создании ресурса. Имя должно иметь длину от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
	rawDisk complex		успешно	Параметры изображения raw диска.
		containerType string	успешно	Формат кодирования и передачи блочного устройства, который должен быть TAR. Это просто формат контейнера и передачи, а не формат выполнения. Предоставляется клиентом при создании образа диска.
		sha1Checksum string	успешно	Необязательная контрольная сумма SHA1 образа диска до распаковки. Это предоставляется клиентом при создании образа диска.
		source string	успешно	Полный URL Google Cloud Storage, где хранится хранилище диска. Вы должны указать либо это свойство, либо свойство sourceDisk, но не оба.
	sourceDisk dictionary		успешно	Исходный диск для создания этого образа на его основе. Вы должны указать либо это свойство, либо свойство rawDisk.source, но не оба для создания изображения.
	sourceDiskEncryptionKey complex		успешно	Ключ шифрования, предоставленный клиентом, для исходного диска. Требуется, если исходный диск защищен ключом шифрования, предоставленным клиентом.
		rawKey string	успешно	Указывает 256-битный предоставленный клиентом ключ шифрования, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса.
		sha256 string	успешно	Закодированный в RFC 4648 base64 SHA-256 хэш предоставленного клиентом ключа шифрования, защищающего этот ресурс.

	sourceDiskId string		success	Идентификатор диска, используемого для создания этого образа. Это значение может быть использовано для определения, был ли образ взят из текущего или предыдущего экземпляра заданного имени диска.
	sourceType string		success	Тип образа, используемого для создания этого диска. Значение по умолчанию и единственное значение — RAW.

Статус

Данный модуль не гарантирует обратную совместимость интерфейса. [preview]
Этот модуль поддерживается сообществом 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_image_info_module.html