google.cloud.gcp_compute_global_address 模块 – 创建一个 GCP GlobalAddress

注意

此模块是 google.cloud 集合（版本 1.4.1）的一部分。

如果您正在使用 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install google.cloud。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。

要在 Playbook 中使用它，请指定：google.cloud.gcp_compute_global_address。

注意

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

概要

  • 表示全局地址资源。全局地址用于 HTTP(S) 负载均衡。

要求

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

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

参数

参数

注释

access_token

string

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

address

string

此资源表示的静态外部 IP 地址。

address_type

string

要保留的地址类型。

* EXTERNAL 表示公共/外部单个 IP 地址。

* INTERNAL 表示属于某些网络的内部 IP 范围。

一些有效选项包括：“EXTERNAL”、“INTERNAL”

默认值： "EXTERNAL"

auth_kind

string / 必需

使用的凭证类型。

选项

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

description

string

此资源的可选描述。

env_type

string

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

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

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

ip_version

string

此地址将使用的 IP 版本。默认值为 `IPV4`。

一些有效选项包括：“IPV4”、“IPV6”

name

string / 必需

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

network

dictionary

要在其中保留 IP 范围的网络的 URL。IP 范围必须在 RFC1918 空间中。如果存在任何引用该网络的保留 IP 范围，则不能删除该网络。

这仅应在使用内部地址时设置。

此字段表示指向 GCP 中网络资源的链接。它可以通过两种方式指定。首先，您可以放置一个字典，其中键为 ‘selfLink’，值为资源的 selfLink。或者，您可以将 `register: name-of-resource` 添加到 gcp_compute_network 任务，然后将此网络字段设置为“{{ name-of-resource }}”。

prefix_length

integer

IP 范围的前缀长度。如果不存在，则表示地址字段是单个 IP 地址。

此字段不适用于 addressType=EXTERNAL 的地址，或 purpose=PRIVATE_SERVICE_CONNECT 时 addressType=INTERNAL 的地址。

project

string

要使用的 Google Cloud Platform 项目。

purpose

string

资源的目的。可能的值包括：* VPC_PEERING - 用于对等网络 * PRIVATE_SERVICE_CONNECT - 用于（[Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html) 仅）私有服务连接网络。

scopes

list / elements=string

要使用的范围数组

service_account_contents

jsonarg

服务帐户 JSON 文件的内容，可以是字典形式，也可以是表示它的 JSON 字符串。

service_account_email

string

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

service_account_file

path

如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。

state

string

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

选项

  • "present" ← （默认）

  • "absent"

备注

注意

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

  • 保留静态外部 IP 地址：https://cloud.google.com/compute/docs/ip-addresses/reserve-static-external-ip-address

  • 对于身份验证，您可以使用 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 global address
  google.cloud.gcp_compute_global_address:
    name: test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

返回值

通用返回值已在此处记录 此处，以下是此模块特有的字段

键

描述

address

string

此资源表示的静态外部 IP 地址。

返回: 成功

addressType

string

要保留的地址类型。

* EXTERNAL 表示公共/外部单个 IP 地址。

* INTERNAL 表示属于某些网络的内部 IP 范围。

返回: 成功

creationTimestamp

string

采用 RFC3339 文本格式的创建时间戳。

返回: 成功

description

string

此资源的可选描述。

返回: 成功

id

integer

资源的唯一标识符。此标识符由服务器定义。

返回: 成功

ipVersion

string

此地址将使用的 IP 版本。默认值为 `IPV4`。

返回: 成功

name

string

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

返回: 成功

network

dictionary

要在其中保留 IP 范围的网络的 URL。IP 范围必须在 RFC1918 空间中。如果存在任何引用该网络的保留 IP 范围，则不能删除该网络。

这仅应在使用内部地址时设置。

返回: 成功

prefixLength

integer

IP 范围的前缀长度。如果不存在，则表示地址字段是单个 IP 地址。

此字段不适用于 addressType=EXTERNAL 的地址，或 purpose=PRIVATE_SERVICE_CONNECT 时 addressType=INTERNAL 的地址。

返回: 成功

purpose

string

资源的目的。可能的值包括：* VPC_PEERING - 用于对等网络 * PRIVATE_SERVICE_CONNECT - 用于（[Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html) 仅）私有服务连接网络。

返回: 成功

region

string

对区域地址所在的区域的引用。

返回: 成功

作者

  • Google Inc. (@googlecloudplatform)