gcp_compute_disk_facts – Сбор фактов о диске GCP

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

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

Описание

Сбор фактов о диске GCP

Требования

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
filters -		Список пар значений фильтров. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке будет добавлен как условие И (filter1 и filter2).
project строка		Проект Google Cloud Platform, который следует использовать.
scopes список		Массив используемых областей.
service_account_contents строка		Строка, представляющая содержимое файла JSON учетной записи службы. Это не должно передаваться как словарь, а как строка с точным содержимым файла service account json (валидный JSON)
service_account_email строка		Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь		Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount.
zone - / обязательно		Ссылка на зону, в которой находится диск.

Примечания

Примечание

Для аутентификации можно задать service_account_file с помощью переменной среды GCP_SERVICE_ACCOUNT_FILE.
Для аутентификации можно задать service_account_email с помощью переменной среды GCP_SERVICE_ACCOUNT_EMAIL.
Для аутентификации можно задать service_account_contents с помощью переменной среды GCP_SERVICE_ACCOUNT_CONTENTS.
Для аутентификации можно задать auth_kind с помощью переменной среды GCP_AUTH_KIND.
Для аутентификации можно задать scopes с помощью переменной среды GCP_SCOPES.
Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
Параметры service_account_email и service_account_file взаимоисключающие.

Примеры

- name: " a disk facts"
  gcp_compute_disk_facts:
    zone: us-central1-a
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: facts

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

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

Ключ			Возвращаемое значение	Описание
items сложный тип			всегда	Список элементов
	creationTimestamp строка		успех	Отметка времени создания в формате RFC3339.
	description строка		успех	Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.
	diskEncryptionKey сложный тип		успех	Шифрует диск с помощью предоставленного пользователем ключа шифрования. После шифрования диска с помощью предоставленного пользователем ключа, вы должны использовать тот же ключ, если используете диск позже (например, для создания снимка диска или образа или для подключения диска к виртуальной машине). Ключи шифрования, предоставленные пользователем, не защищают доступ к метаданным диска. Если вы не предоставите ключ шифрования при создании диска, то диск будет зашифрован с помощью автоматически сгенерированного ключа, и вам не нужно предоставлять ключ для дальнейшего использования диска.
		kmsKeyName строка	успех	Имя ключа шифрования, хранящегося в Google Cloud KMS.
		rawKey строка	успех	Указывает 256-битный ключ шифрования, предоставленный пользователем, закодированный в формате base64 RFC 4648 для шифрования или дешифрования этого ресурса.
		sha256 строка	успех	RFC 4648 base64 закодированный SHA-256 хэш ключа шифрования, предоставленного пользователем, который защищает этот ресурс.
	id целое число		успех	Уникальный идентификатор ресурса.
	labelFingerprint строка		успех	Отпечаток, используемый для оптимистической блокировки этого ресурса. Используется во внутренних операциях обновления.
	labels словарь		успех	Метки для применения к этому диску. Список пар «ключ-значение».
	lastAttachTimestamp строка		успех	Последняя метка времени подключения в формате RFC3339.
	lastDetachTimestamp строка		успех	Последняя метка времени отключения в формате RFC3339.
	licenses список		успех	Любые применимые публично видимые лицензии.
	name строка		успех	Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
	physicalBlockSizeBytes целое число		успех	Физический размер блока диска в байтах. Если отсутствует в запросе, используется значение по умолчанию. В настоящее время поддерживаются размеры 4096 и 16384, другие размеры могут быть добавлены в будущем. Если запрашивается недопустимое значение, сообщение об ошибке перечислит поддерживаемые значения для проекта вызывающего лица.
	sizeGb целое число		успех	Размер диска в ГБ. Вы можете указать это поле при создании диска с использованием параметра sourceImage или sourceSnapshot, или указать его в одиночку для создания пустого диска. Если вы укажете это поле вместе с sourceImage или sourceSnapshot, значение sizeGb не должно быть меньше размера sourceImage или размера снимка.
	sourceImage строка		успех	Образ, используемый для создания этого диска. Если образ удален, это поле не будет установлено. Чтобы создать диск с одним из общедоступных образов операционных систем, укажите образ по его семейному имени. Например, укажите family/debian-8 для использования последнего образа Debian 8: projects/debian-cloud/global/images/family/debian-8 В качестве альтернативы используйте конкретную версию общедоступного образа операционной системы: projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD Чтобы создать диск с частным образом, который вы создали, укажите имя образа в формате: global/images/my-private-image Вы также можете указать частный образ по его семейству образов, что возвращает последнюю версию образа в этом семействе. Замените имя образа на family/family-name: global/images/family/my-private-family.
	sourceImageEncryptionKey сложный тип		успех	Ключ шифрования, предоставленный пользователем, для исходного образа. Требуется, если исходный образ защищен ключом шифрования, предоставленным пользователем.
		kmsKeyName строка	успех	Имя ключа шифрования, хранящегося в Google Cloud KMS.
		rawKey строка	успех	Указывает 256-битный ключ шифрования, предоставленный пользователем, закодированный в формате base64 RFC 4648 для шифрования или дешифрования этого ресурса.
		sha256 строка	успех	RFC 4648 base64 закодированный SHA-256 хэш ключа шифрования, предоставленного пользователем, который защищает этот ресурс.
	sourceImageId строка		успех	Значение ID образа, используемого для создания этого диска. Это значение идентифицирует точный образ, который был использован для создания этого постоянного диска. Например, если вы создали постоянный диск из образа, который был позже удален и воссоздан под тем же именем, идентификатор исходного образа определит точную версию образа, которая была использована.
	sourceSnapshot словарь		успех	Исходный снимок, используемый для создания этого диска. Вы можете предоставить его в виде частичного или полного URL-адреса ресурса.
	sourceSnapshotEncryptionKey сложный тип		успех	Ключ шифрования, предоставленный пользователем, для исходного снимка. Требуется, если исходный снимок защищен ключом шифрования, предоставленным пользователем.
		kmsKeyName строка	успех	Имя ключа шифрования, хранящегося в Google Cloud KMS.
		rawKey строка	успех	Указывает 256-битный ключ шифрования, предоставленный пользователем, закодированный в формате base64 RFC 4648 для шифрования или дешифрования этого ресурса.
		sha256 строка	успех	RFC 4648 base64 закодированный SHA-256 хэш ключа шифрования, предоставленного пользователем, который защищает этот ресурс.
	sourceSnapshotId строка		успех	Уникальный ID снимка, используемого для создания этого диска. Это значение идентифицирует точный снимок, который был использован для создания этого постоянного диска. Например, если вы создали постоянный диск из снимка, который был позже удален и воссоздан под тем же именем, идентификатор исходного снимка определит точную версию снимка, которая была использована.
	type строка		успех	URL ресурса типа диска, описывающего тип диска, который нужно использовать для создания диска. Укажите это при создании диска.
	users список		успех	Ссылки на пользователей диска (подключенных экземпляров) в формате: project/zones/zone/instances/instance.
	zone строка		успех	Ссылка на зону, где находится диск.

Статус

Данный модуль не гарантирует обратной совместимости интерфейса. [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.8/modules/gcp_compute_disk_facts_module.html