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

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

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

Описание

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

Псевдонимы: gcp_compute_region_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, который нужно использовать.
region строка / обязательно		Ссылка на регион, в котором находится диск.
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 region disk
  gcp_compute_region_disk_info:
    region: us-central1
    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		успешно	Шифрует диск с помощью предоставленного пользователем ключа шифрования. После шифрования диска с помощью предоставленного пользователем ключа, необходимо предоставить тот же ключ, если вы впоследствии используете диск (например, для создания снимка диска или образа, или для подключения диска к виртуальной машине). Ключи шифрования, предоставленные пользователем, не защищают доступ к метаданным диска. Если вы не предоставите ключ шифрования при создании диска, то диск будет зашифрован с помощью автоматически сгенерированного ключа, и вам не нужно предоставлять ключ для последующего использования диска.
		rawKey string	успешно	Указывает 256-битный ключ шифрования, предоставленный пользователем, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса.
		sha256 string	успешно	Кодированный в RFC 4648 base64 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, в будущем могут быть добавлены другие размеры. Если запрашивается неподдерживаемое значение, сообщение об ошибке перечислит поддерживаемые значения для проекта вызывающего.
	region string		успешно	Ссылка на регион, где находится диск.
	replicaZones list		успешно	URL-адреса зон, в которые должен быть скопирован диск.
	sizeGb integer		успешно	Размер постоянного диска в ГБ. Вы можете указать это поле при создании постоянного диска, используя параметр sourceImage или sourceSnapshot, или указать его отдельно для создания пустого постоянного диска. Если вы укажете это поле вместе с sourceImage или sourceSnapshot, значение sizeGb не должно быть меньше размера sourceImage или размера снимка.
	sourceSnapshot dictionary		успешно	Источник снимка, используемого для создания диска. Вы можете предоставить его в виде частичного или полного URL-адреса ресурса.
	sourceSnapshotEncryptionKey complex		успешно	Ключ шифрования, предоставленный пользователем, для исходного снимка. Требуется, если исходный снимок защищён ключом шифрования, предоставленным пользователем.
		rawKey string	успешно	Указывает 256-битный ключ шифрования, предоставленный пользователем, закодированный в RFC 4648 base64 для шифрования или дешифрования этого ресурса.
		sha256 string	успешно	Кодированный в RFC 4648 base64 SHA-256 хэш ключа шифрования, предоставленного пользователем, который защищает этот ресурс.
	sourceSnapshotId string		успешно	Уникальный идентификатор снимка, используемого для создания диска. Это значение идентифицирует точную версию снимка, которая была использована для создания этого постоянного диска. Например, если вы создали постоянный диск из снимка, который был позже удалён и воссоздан под тем же именем, то идентификатор исходного снимка будет идентифицировать точную версию снимка, которая была использована.
	type string		успешно	URL ресурса типа диска, описывающего тип диска, который следует использовать для создания диска. Укажите это при создании диска.
	users list		успешно	Ссылки на пользователей диска (присоединённые экземпляры) в формате: project/zones/zone/instances/instance.

Статус

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