Модуль google.cloud.gcp_compute_ssl_policy – Создает GCP SslPolicy
Примечание
Этот модуль является частью коллекции google.cloud (версия 1.4.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install google.cloud. Вам потребуются дополнительные требования для использования этого модуля, см. Требования для получения подробной информации.
Чтобы использовать его в playbook, укажите: google.cloud.gcp_compute_ssl_policy.
Краткое описание
- Представляет политику SSL. Политики SSL предоставляют вам возможность контролировать функции SSL, которые ваш прокси SSL или балансировщик нагрузки HTTPS согласуют.
Требования
Ниже приведены требования, необходимые на хосте, который выполняет этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен доступа OAuth2, если тип учетных данных — accesstoken. |
auth_kind строка / обязательно | Тип используемых учетных данных. Варианты:
|
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 строка | 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 строка | Должен ли данный объект существовать в GCP Варианты:
|
Примечания
Примечание
- API Reference: 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. - Для аутентификации вы можете установить access_token с помощью переменной среды
GCP_ACCESS_TOKEN. - Для аутентификации вы можете установить auth_kind с помощью переменной среды
GCP_AUTH_KIND. - Для аутентификации вы можете установить scopes с помощью переменной среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения playbook не установлены.
- Параметры 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 string | Метка времени создания в текстовом формате RFC3339. Возвращается: успех |
customFeatures list / elements=string | Список функций, включенных при выборе профиля CUSTOM. Метод возвращает набор функций, которые могут быть указаны в этом списке. Это поле должно быть пустым, если профиль не CUSTOM. Возвращается: успех |
description string | Необязательное описание этого ресурса. Возвращается: успех |
enabledFeatures list / elements=string | Список функций, включенных в политике SSL. Возвращается: успех |
fingerprint string | Отпечаток этого ресурса. Хеш содержимого, хранящегося в этом объекте. Это поле используется в оптимистической блокировке. Возвращается: успех |
id integer | Уникальный идентификатор ресурса. Возвращается: успех |
minTlsVersion string | Минимальная версия протокола SSL, которая может использоваться клиентами для установления соединения с балансировщиком нагрузки. Возвращается: успех |
name string | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. Возвращается: успех |
profile string | Профиль указывает набор функций SSL, которые могут использоваться балансировщиком нагрузки при согласовании SSL с клиентами. При использовании `CUSTOM` набор функций SSL для включения должен быть указан в поле `customFeatures`. Возвращается: успех |
warnings complex | Если для этой политики SSL обнаружены потенциальные неверные конфигурации, это поле будет заполнено предупреждающими сообщениями. Возвращается: успех |
|
code string |
Код предупреждения, если применимо. Возвращается: успех |
|
message string |
Описание кода предупреждения, понятное человеку. Возвращается: успех |
Ссылки на коллекцию
© 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_compute_ssl_policy_module.html