gcp_compute_region_disk_facts – Сбор фактов для GCP RegionDisk

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

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

Обзор

Сбор фактов для GCP RegionDisk

Требования

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

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 для использования.
region - / обязательно		Ссылка на регион, где находится диск.
scopes список		Массив используемых областей.
service_account_contents строка		Строка, представляющая содержимое файла JSON учетной записи сервиса. Это не должно передаваться как словарь, а как строка с точным содержимым файла json учетной записи сервиса (валидный JSON).
service_account_email строка		Необязательный адрес электронной почты учетной записи сервиса, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь		Путь к файлу JSON учетной записи сервиса, если тип serviceaccount выбран как тип.

Примечания

Примечание

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

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

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

Ключ			Возвращаемое значение	Описание
items сложный тип			всегда	Список элементов
	creationTimestamp строка		успех	Маркер создания в формате RFC3339.
	description строка		успех	Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.
	diskEncryptionKey сложный тип		успех	Шифрует диск с использованием предоставленного пользователем ключа шифрования. После шифрования диска с использованием предоставленного пользователем ключа, вы должны предоставить тот же ключ, если в дальнейшем используете диск (например, для создания снимка диска или образа, или для подключения диска к виртуальной машине). Ключи шифрования, предоставленные пользователем, не защищают доступ к метаданным диска. Если вы не предоставите ключ шифрования при создании диска, диск будет зашифрован с использованием автоматически сгенерированного ключа, и вам не нужно предоставлять ключ для дальнейшего использования диска.
		rawKey строка	успех	Указывает 256-битный ключ шифрования, предоставленный пользователем, закодированный в формате RFC 4648 base64 для шифрования или дешифрования этого ресурса.
		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, в будущем могут быть добавлены другие размеры. Если запрашивается неподдерживаемое значение, сообщение об ошибке перечислит поддерживаемые значения для проекта вызывающего.
	region строка		успех	Ссылка на регион, в котором находится диск.
	replicaZones список		успех	URL-адреса зон, в которые должен быть скопирован диск.
	sizeGb целое число		успех	Размер постоянного диска, указанный в ГБ. Вы можете указать это поле при создании постоянного диска, используя параметр sourceImage или sourceSnapshot, или указать его отдельно, чтобы создать пустой постоянный диск. Если вы укажете это поле вместе с sourceImage или sourceSnapshot, значение sizeGb не должно быть меньше размера sourceImage или размера снимка.
	sourceSnapshot словарь		успех	Исходный снимок, используемый для создания этого диска. Вы можете предоставить его как частичный или полный URL-адрес ресурса.
	sourceSnapshotEncryptionKey сложный тип		успех	Ключ шифрования, предоставленный пользователем, для исходного снимка. Требуется, если исходный снимок защищен ключом шифрования, предоставленным пользователем.
		rawKey строка	успех	Указывает 256-битный ключ шифрования, предоставленный пользователем, закодированный в формате RFC 4648 base64 для шифрования или дешифрования этого ресурса.
		sha256 строка	успех	RFC 4648 base64 закодированный SHA-256 хэш ключа шифрования, предоставленного пользователем, который защищает этот ресурс.
	sourceSnapshotId строка		успех	Уникальный идентификатор снимка, используемого для создания этого диска. Это значение идентифицирует точный снимок, который был использован для создания этого постоянного диска. Например, если вы создали постоянный диск из снимка, который был позже удален и воссоздан под тем же именем, идентификатор исходного снимка будет идентифицировать точную версию снимка, которая была использована.
	type строка		успех	URL ресурса типа диска, описывающего тип диска, который следует использовать для создания диска. Укажите это при создании диска.
	users список		успех	Ссылки на пользователей диска (подключенные экземпляры) в формате: 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.8/modules/gcp_compute_region_disk_facts_module.html