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

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

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

Обзор

Сбор информации о 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 строка / обязательно		Ключевой набор, к которому принадлежит данный ключ. Формат: `'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, используя переменную среды 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.
Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
Параметры 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 сложное			всегда	Список ресурсов
	creationTime строка		успешно	Время создания этого ресурса на сервере. Формат RFC3339.
	keyRing строка		успешно	Ключевой набор, к которому принадлежит данный ключ. Формат: `'projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}'`.
	labels словарь		успешно	Метки с пользовательскими метаданными, применяемыми к этому ресурсу.
	name строка		успешно	Имя ресурса CryptoKey.
	purpose строка		успешно	Неизменяемое назначение CryptoKey. Смотрите https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys#CryptoKeyPurpose для входных данных.
	rotationPeriod строка		успешно	Каждые период времени генерируется новый CryptoKeyVersion и устанавливается в качестве основного. Первый цикл обновления будет выполнен через указанный период. Период обновления имеет формат десятичного числа с до 9 знаками после запятой, за которым следует буква `s` (секунды). Он должен быть больше одного дня (например, 86400).
	versionTemplate сложное		успешно	Шаблон, описывающий настройки для новых версий криптоключа.
		algorithm строка	успешно	Используемый алгоритм при создании версии на основе этого шаблона. См. [справочник по алгоритмам](https://cloud.google.com/kms/docs/reference/rest/v1/CryptoKeyVersionAlgorithm) для возможных входных данных.
		protectionLevel строка	успешно	Уровень защиты, используемый при создании версии на основе этого шаблона.

Статус

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