google.cloud.gcp_compute_ssl_policy – Создаёт GCP SslPolicy

Примечание

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

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

Для использования в книге задач укажите: google.cloud.gcp_compute_ssl_policy.

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

Описание

Представляет политику SSL. Политики SSL позволяют управлять функциями SSL, которые ваш прокси SSL или балансировщик нагрузки HTTPS согласуют.

Требования

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательный	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
custom_features список / элементы=строка		Список функций, включенных при выбранном профиле CUSTOM. Метод возвращает набор функций, которые могут быть указаны в этом списке. Это поле должно быть пустым, если профиль не CUSTOM.
description строка		Необязательное описание этого ресурса.
env_type строка		Указывает, в какой среде Ansible вы выполняете этот модуль. Это поле не следует устанавливать, если вы не знаете, что делаете. Это изменяет только строку User Agent для всех запросов к API.
min_tls_version строка		Минимальная версия протокола SSL, которую клиенты могут использовать для установления соединения с балансировщиком нагрузки. Некоторые допустимые значения: «TLS_1_0», «TLS_1_1», «TLS_1_2»
name строка / обязательный		Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно иметь длину от 1 до 63 символов и соответствовать RFC1035. То есть длина должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
profile строка		Профиль определяет набор функций SSL, которые могут использоваться балансировщиком нагрузки при согласовании SSL с клиентами. При использовании `CUSTOM` набор функций SSL, которые необходимо включить, должен быть указан в поле `customFeatures`. Некоторые допустимые значения: «COMPATIBLE», «MODERN», «RESTRICTED», «CUSTOM»
project строка		Проект Google Cloud Platform, который следует использовать.
scopes список / элементы=строка		Массив используемых областей
service_account_contents jsonarg		Содержимое файла JSON учетной записи службы, либо в виде словаря, либо как строка JSON, которая его представляет.
service_account_email строка		Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь		Путь к файлу JSON учетной записи службы, если выбран тип serviceaccount.
state строка	Варианты: present ← absent	Нужно ли существование объекта в GCP

Примечания

Примечание

Ссылка на API: https://cloud.google.com/compute/docs/reference/rest/v1/sslPolicies
Использование политик SSL: https://cloud.google.com/compute/docs/load-balancing/ssl-policies
для аутентификации можно установить 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: create a SSL policy
  google.cloud.gcp_compute_ssl_policy:
    name: test_object
    profile: CUSTOM
    min_tls_version: TLS_1_2
    custom_features:
    - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
    - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

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

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

Ключ		Возвращаемое значение	Описание
creationTimestamp строка		success	Дата и время создания в формате RFC3339.
customFeatures список / элементы=строка		success	Список функций, включенных при выбранном профиле CUSTOM. Метод возвращает набор функций, которые могут быть указаны в этом списке. Это поле должно быть пустым, если профиль не CUSTOM.
description строка		success	Необязательное описание этого ресурса.
enabledFeatures список / элементы=строка		success	Список функций, включенных в политику SSL.
fingerprint строка		success	Отпечаток этого ресурса. Хэш содержимого, хранящегося в этом объекте. Это поле используется для оптимистической блокировки.
id целое число		success	Уникальный идентификатор ресурса.
minTlsVersion строка		success	Минимальная версия протокола SSL, которую клиенты могут использовать для установления соединения с балансировщиком нагрузки.
name строка		success	Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно иметь длину от 1 до 63 символов и соответствовать RFC1035. То есть длина должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
profile строка		success	Профиль определяет набор функций SSL, которые могут использоваться балансировщиком нагрузки при согласовании SSL с клиентами. При использовании `CUSTOM` набор функций SSL, которые необходимо включить, должен быть указан в поле `customFeatures`.
warnings сложное		success	Если для этой политики SSL обнаружены потенциальные неправильные настройки, это поле будет заполнено предупреждающими сообщениями.
	code строка	success	Код предупреждения, если применимо.
	message строка	success	Читаемое человеком описание кода предупреждения.

Авторы

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