Модуль google.cloud.gcp_kms_key_ring_info – Сбор информации о GCP KeyRing

Примечание

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

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

Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля требуются дополнительные зависимости. Подробнее см. раздел Требования.

Чтобы использовать его в плейбуке, укажите: google.cloud.gcp_kms_key_ring_info.

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

Описание

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

Требования

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

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.
location строка / обязательно	Расположение KeyRing. Полный список допустимых расположений можно получить, выполнив `gcloud kms locations list`.
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.
для аутентификации можно установить access_token, используя переменную среды GCP_ACCESS_TOKEN.
для аутентификации можно установить auth_kind, используя переменную среды GCP_AUTH_KIND.
для аутентификации можно установить scopes, используя переменную среды GCP_SCOPES.
Значения переменных среды будут использоваться только в том случае, если значения плейбука не заданы.
Параметры service_account_email и service_account_file взаимоисключающие.

Примеры

- name: get info on a key ring
  gcp_kms_key_ring_info:
    location: us-central1
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

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

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

Ключ	Описание
resources сложный	Список ресурсов Возвращается: всегда
createTime строка	Время создания этого ресурса на сервере. Формат RFC3339. Возвращается: при успешном выполнении
location строка	Расположение KeyRing. Полный список допустимых расположений можно получить, выполнив `gcloud kms locations list`. Возвращается: при успешном выполнении
name строка	Имя ресурса KeyRing. Возвращается: при успешном выполнении

Авторы

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_key_ring_info_module.html