gcp_compute_disk_info – Сбор информации о диске GCP

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

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

Описание

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

Псевдонимы: gcp_compute_disk_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.
zone строка / обязательный		Ссылка на зону, в которой находится диск.

Примечания

Примечание

для аутентификации можно установить 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 disk
  gcp_compute_disk_info:
    zone: us-central1-a
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

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

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

Ключ			Возвращаемое значение	Описание
resources complex			всегда	Список ресурсов
	creationTimestamp string		успех	Маркер времени создания в формате RFC3339.
	description string		успех	Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.
	diskEncryptionKey complex		успех	Шифрует диск с помощью предоставленного клиентом ключа шифрования. После шифрования диска с помощью предоставленного клиентом ключа, вы должны предоставить тот же ключ, если будете использовать диск позднее (например, для создания снимка диска или образа, или для подключения диска к виртуальной машине). Ключи шифрования, предоставленные клиентом, не защищают доступ к метаданным диска. Если вы не предоставите ключ шифрования при создании диска, диск будет зашифрован с помощью автоматически сгенерированного ключа, и вам не нужно будет предоставлять ключ для использования диска позднее.
		kmsKeyName string	успех	Имя ключа шифрования, хранящегося в Google Cloud KMS.
		rawKey string	успех	Указывает 256-битный ключ шифрования, предоставленный клиентом, закодированный в формате base64 RFC 4648 для шифрования или дешифрования этого ресурса.
		sha256 string	успех	Кодированный в формате base64 RFC 4648 SHA-256 хэш предоставленного клиентом ключа шифрования, защищающего этот ресурс.
	id integer		успех	Уникальный идентификатор ресурса.
	labelFingerprint string		успех	Отпечаток, используемый для оптимистической блокировки этого ресурса. Используется во внутренних обновлениях.
	labels dictionary		успех	Метки для применения к этому диску. Список пар ключ-значение.
	lastAttachTimestamp string		успех	Маркер времени последнего подключения в формате RFC3339.
	lastDetachTimestamp string		успех	Маркер времени последнего отключения в формате RFC3339.
	licenses list		успех	Все применимые публично видимые лицензии.
	name string		успех	Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире.
	physicalBlockSizeBytes integer		успех	Физический размер блока диска в байтах. Если не указан в запросе, используется значение по умолчанию. В настоящее время поддерживаются размеры 4096 и 16384, в будущем могут быть добавлены другие размеры. Если запрашивается неподдерживаемое значение, сообщение об ошибке перечислит поддерживаемые значения для проекта вызывающего.
	sizeGb integer		успех	Размер постоянного диска в ГБ. Вы можете указать это поле при создании постоянного диска с помощью параметра sourceImage или sourceSnapshot, или указать его отдельно для создания пустого постоянного диска. Если вы указываете это поле вместе с sourceImage или sourceSnapshot, значение sizeGb не должно быть меньше размера sourceImage или размера снимка.
	sourceImage string		успех	Образ, используемый для создания этого диска. Если исходный образ удален, это поле не будет установлено. Для создания диска с одним из публичных образов операционных систем укажите имя семейства образа. Например, укажите 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 complex		успех	Ключ шифрования, предоставленный клиентом, для исходного образа. Требуется, если исходный образ защищен ключом шифрования, предоставленным клиентом.
		kmsKeyName string	успех	Имя ключа шифрования, хранящегося в Google Cloud KMS.
		rawKey string	успех	Указывает 256-битный ключ шифрования, предоставленный клиентом, закодированный в формате base64 RFC 4648 для шифрования или дешифрования этого ресурса.
		sha256 string	успех	Кодированный в формате base64 RFC 4648 SHA-256 хэш предоставленного клиентом ключа шифрования, защищающего этот ресурс.
	sourceImageId string		успех	Значение ID образа, используемого для создания этого диска. Это значение идентифицирует точный образ, который был использован для создания этого постоянного диска. Например, если вы создали постоянный диск из образа, который был позже удален и воссоздан под тем же именем, идентификатор исходного образа будет идентифицировать точную версию образа, которая была использована.
	sourceSnapshot dictionary		успех	Исходный снимок, используемый для создания этого диска. Вы можете предоставить его как частичный или полный URL-адрес ресурса.
	sourceSnapshotEncryptionKey complex		успех	Ключ шифрования, предоставленный клиентом, для исходного снимка. Требуется, если исходный снимок защищен ключом шифрования, предоставленным клиентом.
		kmsKeyName string	успех	Имя ключа шифрования, хранящегося в Google Cloud KMS.
		rawKey string	успех	Указывает 256-битный ключ шифрования, предоставленный клиентом, закодированный в формате base64 RFC 4648 для шифрования или дешифрования этого ресурса.
		sha256 string	успех	Кодированный в формате base64 RFC 4648 SHA-256 хэш предоставленного клиентом ключа шифрования, защищающего этот ресурс.
	sourceSnapshotId string		успех	Уникальный идентификатор снимка, используемого для создания этого диска. Это значение идентифицирует точный снимок, который был использован для создания этого постоянного диска. Например, если вы создали постоянный диск из снимка, который был позже удален и воссоздан под тем же именем, идентификатор исходного снимка будет идентифицировать точную версию снимка, которая была использована.
	type string		успех	URL ресурса типа диска, описывающего тип диска, который следует использовать для создания диска. Укажите это при создании диска.

	пользователи список		успех	Ссылки на пользователей диска (присоединённые экземпляры) в формате: проект/зоны/зона/экземпляры/экземпляр.
	зона строка		успех	Ссылка на зону, в которой находится диск.

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

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_disk_info_module.html