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

字符串

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

address

字符串

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

address_type

字符串

要保留的地址类型。

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

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

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

默认值： "EXTERNAL"

auth_kind

字符串 / 必需

使用的凭据类型。

选项

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

description

字符串

此资源的可选描述。

env_type

字符串

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

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

这只会更改任何 API 请求的用户代理字符串。

ip_version

字符串

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

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

name

字符串 / 必需

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

network

字典

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

仅当使用内部地址时才应设置此项。

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

prefix_length

整数

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

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

project

字符串

要使用的 Google Cloud Platform 项目。

purpose

字符串

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

scopes

列表 / elements=字符串

要使用的范围数组

service_account_contents

jsonarg

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

service_account_email

字符串

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

service_account_file

路径

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

state

字符串

给定对象是否应存在于 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

字符串

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

返回：成功

addressType

字符串

要保留的地址类型。

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

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

返回：成功

creationTimestamp

字符串

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

返回：成功

description

字符串

此资源的可选描述。

返回：成功

id

整数

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

返回：成功

ipVersion

字符串

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

返回：成功

name

字符串

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

返回：成功

network

字典

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

仅当使用内部地址时才应设置此项。

返回：成功

prefixLength

整数

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

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

返回：成功

purpose

字符串

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

返回：成功

region

字符串

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

返回：成功

作者

  • Google Inc. (@googlecloudplatform)