google.cloud.gcp_kms_crypto_key_info – Сбор информации о GCP CryptoKey
Примечание
Этот плагин входит в состав коллекции google.cloud (версия 1.0.1).
Для его установки используйте: 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
строка / обязательно
|
|
Тип используемых учетных данных.
|
|
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 создаст новую версию данного CryptoKey.
|
||
|
purpose
строка
|
успех |
Неизменяемое назначение CryptoKey. См. https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys#CryptoKeyPurpose для возможных значений.
|
||
|
rotationPeriod
строка
|
успех |
Каждый раз, когда проходит этот период, генерируется новая версия CryptoKey и устанавливается в качестве основной.
Первая ротация произойдёт после указанного периода. Период ротации имеет формат десятичного числа с до 9 знаками после запятой, после чего следует буква `s` (секунды). Он должен быть больше одного дня (например, 86400).
|
||
|
versionTemplate
сложное
|
успех |
Шаблон, описывающий настройки для новых версий криптоключа.
|
||
|
algorithm
строка
|
успех |
Алгоритм, который используется при создании версии на основе этого шаблона.
См. [справочник по алгоритмам](https://cloud.google.com/kms/docs/reference/rest/v1/CryptoKeyVersionAlgorithm) для возможных значений.
|
||
|
protectionLevel
строка
|
успех |
Уровень защиты, используемый при создании версии на основе этого шаблона.
|
||
Авторы
- 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.10/collections/google/cloud/gcp_kms_crypto_key_info_module.html
