google.cloud.gcp_kms_crypto_key_info – Сбор информации о GCP CryptoKey

Примечание

Этот плагин входит в состав коллекции google.cloud (версия 1.0.2).

Для его установки используйте: ansible-galaxy collection install google.cloud.

Чтобы использовать его в книге задач, укажите: google.cloud.gcp_kms_crypto_key_info.

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

Обзор

Сбор информации о GCP CryptoKey

Требования

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
env_type строка		Указывает, в какой среде Ansible вы запускаете этот модуль. Не устанавливайте это значение, если вы не знаете, что делаете. Это изменяет только строку User-Agent для всех запросов к API.
key_ring строка / обязательно		KeyRing, к которому относится этот ключ. Формат: `'projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}'`.
project строка		Проект Google Cloud Platform, который необходимо использовать.
scopes список / элементы=строка		Массив используемых областей видимости
service_account_contents jsonarg		Содержимое файла JSON учетной записи службы, представленное либо словарем, либо строкой JSON, которая его представляет.
service_account_email строка		Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес электронной почты по умолчанию.
service_account_file путь		Путь к файлу JSON учетной записи службы, если тип выбран как serviceaccount.

Примечания

Примечание

для аутентификации можно установить service_account_file, используя переменную среды gcp_service_account_file.
для аутентификации можно установить service_account_contents, используя переменную среды 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 crypto key
  gcp_kms_crypto_key_info:
    key_ring: projects/{{ gcp_project }}/locations/us-central1/keyRings/key-key-ring
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

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

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

Ключ			Возвращаемое значение	Описание
resources сложный			всегда	Список ресурсов
	createTime строка		успех	Время создания этого ресурса на сервере. Формат - RFC3339.
	keyRing строка		успех	KeyRing, к которому относится этот ключ. Формат: `'projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}'`.
	labels словарь		успех	Метки с пользовательскими метаданными для применения к этому ресурсу.
	name строка		успех	Имя ресурса CryptoKey.
	nextRotationTime строка		успех	Время, когда KMS создаст новую версию этого Crypto Key.
	purpose строка		успех	Неизменяемая цель CryptoKey. См. https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys#CryptoKeyPurpose для ввода.
	rotationPeriod строка		успех	Каждый раз, когда проходит этот период, генерируется новая версия CryptoKey и устанавливается в качестве основной. Первый цикл обновления произойдет после указанного периода. Период обновления имеет формат десятичного числа с точностью до 9 десятичных знаков, за которым следует буква `s` (секунды). Он должен быть больше суток (т. е., 86400).
	skipInitialVersionCreation булево		успех	Если установлено в значение true, запрос создаст CryptoKey без каких-либо версий CryptoKeyVersion. Для импорта CryptoKeyVersion необходимо использовать ресурс `google_kms_key_ring_import_job`.
	versionTemplate сложный		успех	Шаблон, описывающий параметры для новых версий криптоключа.
		algorithm строка	успех	Алгоритм, используемый при создании версии на основе этого шаблона. См. [справочник по алгоритмам](https://cloud.google.com/kms/docs/reference/rest/v1/CryptoKeyVersionAlgorithm) для возможных значений.
		protectionLevel строка	успех	Уровень защиты, используемый при создании версии на основе этого шаблона.

Авторы

Google Inc. (@googlecloudplatform)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_kms_crypto_key_info_module.html