Модуль google.cloud.gcp_kms_crypto_key_info — Сбор информации о GCP CryptoKey

Примечание

Этот модуль входит в коллекцию google.cloud (версия 1.4.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: 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

Параметры

Параметр	Комментарии
access_token строка	Токен доступа OAuth2, если тип учетных данных — accesstoken.
auth_kind строка / обязательно	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
env_type строка	Указывает, в какой среде Ansible выполняется этот модуль. Это значение не следует устанавливать, если вы не знаете, что делаете. Это изменяет только строку пользовательского агента для любых запросов к API.
key_ring строка / обязательно	Ключевое хранилище, к которому принадлежит этот ключ. Формат: `’projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}’`.
...	...

Примечания

Примечание

для аутентификации можно установить service_account_file, используя переменную среды GCP_SERVICE_ACCOUNT_FILE.
для аутентификации можно установить service_account_contents, используя переменную среды GCP_SERVICE_ACCOUNT_CONTENTS.
для аутентификации можно установить service_account_email, используя переменную среды GCP_SERVICE_ACCOUNT_EMAIL.
для аутентификации можно установить access_token, используя переменную среды GCP_ACCESS_TOKEN.
для аутентификации можно установить 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 строка	Каждый раз, когда проходит этот период, генерируется новая CryptoKeyVersion и назначается первичной. Первый цикл обновления произойдёт после указанного периода. Период обновления имеет формат десятичного числа с до 9 знаками после запятой, за которым следует буква `s` (секунды). Он должен быть больше одного дня (т.е., 86400). Возвращается: успешно
skipInitialVersionCreation логическое	Если установлено в `true`, запрос создаст CryptoKey без CryptoKeyVersions. Для импорта 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/google/cloud/gcp_kms_crypto_key_info_module.html