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。

注意

由于违反 Ansible 包含要求，google.cloud 集合将从 Ansible 12 中删除。该集合有 未解决的健全性测试失败。有关更多信息，请参阅 讨论主题。

概要

  • 表示 SSL 策略。SSL 策略使您能够控制 SSL 代理或 HTTPS 负载均衡器协商的 SSL 功能。

要求

执行此模块的主机需要以下要求。

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

参数

参数

注释

access_token

字符串

如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。

auth_kind

字符串 / 必需

使用的凭据类型。

选项

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

custom_features

列表 / 元素=字符串

当选择的配置文件为 CUSTOM 时启用的功能列表。该方法返回可以在此列表中指定的功能集。如果配置文件不是 CUSTOM，则此字段必须为空。

description

字符串

此资源的可选描述。

env_type

字符串

指定您正在其中运行此模块的 Ansible 环境。

除非您知道自己在做什么，否则不应设置此项。

这只会更改任何 API 请求的 User Agent 字符串。

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`，则必须在 `customFeatures` 字段中指定要启用的 SSL 功能集。

一些有效的选择包括：“COMPATIBLE”、“MODERN”、“RESTRICTED”、“CUSTOM”

project

字符串

要使用的 Google Cloud Platform 项目。

scopes

列表 / 元素=字符串

要使用的作用域数组

service_account_contents

jsonarg

Service Account JSON 文件的内容，可以是字典形式，也可以是表示它的 JSON 字符串。

service_account_email

字符串

如果选择了 machineaccount 并且用户不希望使用默认电子邮件，则为可选的服务帐户电子邮件地址。

service_account_file

路径

如果选择 serviceaccount 作为类型，则为 Service Account JSON 文件的路径。

state

字符串

给定的对象是否应存在于 GCP 中

选项

  • "present" ←（默认）

  • "absent"

注释

注意

  • API 参考：https://cloud.google.com/compute/docs/reference/rest/v1/sslPolicies

  • 使用 SSL 策略：https://cloud.google.com/compute/docs/load-balancing/ssl-policies

  • 对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_FILE 环境变量设置 service_account_file。

  • 对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_CONTENTS 环境变量设置 service_account_contents。

  • 对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_EMAIL 环境变量设置 service_account_email。

  • 对于身份验证，您可以使用 GCP_ACCESS_TOKEN 环境变量设置 access_token。

  • 对于身份验证，您可以使用 GCP_AUTH_KIND 环境变量设置 auth_kind。

  • 对于身份验证，您可以使用 GCP_SCOPES 环境变量设置 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

字符串

以 RFC3339 文本格式表示的创建时间戳。

返回：成功

customFeatures

列表 / 元素=字符串

当选择的配置文件为 CUSTOM 时启用的功能列表。该方法返回可以在此列表中指定的功能集。如果配置文件不是 CUSTOM，则此字段必须为空。

返回：成功

description

字符串

此资源的可选描述。

返回：成功

enabledFeatures

列表 / 元素=字符串

SSL 策略中启用的功能列表。

返回：成功

fingerprint

字符串

此资源的指纹。存储在此对象中的内容的哈希值。此字段用于乐观锁定。

返回：成功

id

整数

资源的唯一标识符。

返回：成功

minTlsVersion

字符串

客户端可用于与负载均衡器建立连接的最低 SSL 协议版本。

返回：成功

name

字符串

资源的名称。由客户端在创建资源时提供。名称长度必须为 1-63 个字符，并符合 RFC1035。具体而言，名称长度必须为 1-63 个字符，并与正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?` 匹配，这意味着第一个字符必须是小写字母，并且所有后续字符必须是破折号、小写字母或数字，但最后一个字符不能是破折号。

返回：成功

profile

字符串

配置文件指定负载均衡器在与客户端协商 SSL 时可以使用的 SSL 功能集。如果使用 `CUSTOM`，则必须在 `customFeatures` 字段中指定要启用的 SSL 功能集。

返回：成功

warnings

复杂

如果检测到此 SSL 策略的潜在配置错误，则此字段将填充警告消息。

返回：成功

code

字符串

警告代码（如果适用）。

返回：成功

message

字符串

警告代码的人类可读描述。

返回：成功

作者

  • Google Inc. (@googlecloudplatform)