google.cloud.gcp_compute_address 模块 – 创建 GCP 地址

注意

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

如果您使用的是 ansible 软件包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

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

要在 playbook 中使用它，请指定： google.cloud.gcp_compute_address。

注意

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

概要

  • 表示地址资源。

  • 每个虚拟机实例都有一个短暂的内部 IP 地址，以及一个可选的外部 IP 地址。要在同一网络上的实例之间进行通信，可以使用实例的内部 IP 地址。要与互联网和同一网络外部的实例进行通信，必须指定实例的外部 IP 地址。

  • 内部 IP 地址是短暂的，只属于实例在其生命周期内；如果实例被删除并重新创建，则实例将被分配一个新的内部 IP 地址，由 Compute Engine 或您自己分配。外部 IP 地址可以是短暂的或静态的。

要求

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

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

参数

参数

注释

access_token

字符串

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

address

字符串

此资源表示的静态外部 IP 地址。仅支持 IPv4。地址只能为 INTERNAL 地址类型指定。IP 地址必须位于指定的子网内（如果存在）。

address_type

字符串

要保留的地址类型。

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

默认值： "EXTERNAL"

auth_kind

字符串 / 必需

使用的凭据类型。

选项

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

description

字符串

此资源的可选描述。

env_type

字符串

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

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

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

name

字符串 / 必需

资源的名称。名称必须为 1-63 个字符，并符合 RFC1035。具体来说，名称必须为 1-63 个字符，并匹配正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?`，这意味着第一个字符必须是小写字母，所有后续字符必须是短横线、小写字母或数字，最后一个字符不能是短横线。

network

字典

要在其中保留地址的网络的 URL。此字段只能与具有 VPC_PEERING 和 IPSEC_INTERCONNECT 目的的 INTERNAL 类型一起使用。

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

network_tier

字符串

用于配置此地址的网络层。如果未指定此字段，则假定为 PREMIUM。

一些有效的选项包括：“PREMIUM”、“STANDARD”

prefix_length

整数

如果资源表示 IP 范围，则为前缀长度。

project

字符串

要使用的 Google Cloud Platform 项目。

purpose

字符串

此资源的目的，可以是以下值之一：* VM 实例、别名 IP 范围、内部负载均衡器和类似资源使用的地址的 GCE_ENDPOINT。

* 可由多个内部负载均衡器使用的地址的 SHARED_LOADBALANCER_VIP。

* 为 VPC 对等网络保留的地址的 VPC_PEERING。

* 从专用 IP 范围创建的地址的 IPSEC_INTERCONNECT，这些地址为 IPsec 加密的 Cloud Interconnect 配置中的 VLAN 附加保留。这些地址是区域资源。

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

region

字符串 / 必需

区域地址所在的区域的 URL。

此字段不适用于全局地址。

scopes

列表 / 元素=字符串

要使用的作用域数组

service_account_contents

jsonarg

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

service_account_email

字符串

如果选择 machineaccount 并且用户不希望使用默认邮箱，则可以使用可选的服务帐户邮箱地址。

service_account_file

路径

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

状态

字符串

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

选项

  • "present" ← (默认)

  • "absent"

子网

字典

用于预留地址的子网 URL。如果指定了 IP 地址，则它必须位于子网的 IP 范围内。

此字段只能与具有 GCE_ENDPOINT/DNS_RESOLVER 目的的 INTERNAL 类型一起使用。

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

备注

注意

示例

- name: create a address
  google.cloud.gcp_compute_address:
    name: test-address1
    region: us-west1
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

返回值

常见的返回值已记录在 此处，以下是此模块独有的字段

键

描述

address

字符串

此资源表示的静态外部 IP 地址。仅支持 IPv4。地址只能为 INTERNAL 地址类型指定。IP 地址必须位于指定的子网内（如果存在）。

返回：成功

addressType

字符串

要保留的地址类型。

返回：成功

creationTimestamp

字符串

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

返回：成功

description

字符串

此资源的可选描述。

返回：成功

id

整数

资源的唯一标识符。

返回：成功

name

字符串

资源的名称。名称必须为 1-63 个字符，并符合 RFC1035。具体来说，名称必须为 1-63 个字符，并匹配正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?`，这意味着第一个字符必须是小写字母，所有后续字符必须是短横线、小写字母或数字，最后一个字符不能是短横线。

返回：成功

network

字典

要在其中保留地址的网络的 URL。此字段只能与具有 VPC_PEERING 和 IPSEC_INTERCONNECT 目的的 INTERNAL 类型一起使用。

返回：成功

networkTier

字符串

用于配置此地址的网络层。如果未指定此字段，则假定为 PREMIUM。

返回：成功

prefixLength

整数

如果资源表示 IP 范围，则为前缀长度。

返回：成功

purpose

字符串

此资源的目的，可以是以下值之一：* VM 实例、别名 IP 范围、内部负载均衡器和类似资源使用的地址的 GCE_ENDPOINT。

* 可由多个内部负载均衡器使用的地址的 SHARED_LOADBALANCER_VIP。

* 为 VPC 对等网络保留的地址的 VPC_PEERING。

* 从专用 IP 范围创建的地址的 IPSEC_INTERCONNECT，这些地址为 IPsec 加密的 Cloud Interconnect 配置中的 VLAN 附加保留。这些地址是区域资源。

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

返回：成功

region

字符串

区域地址所在的区域的 URL。

此字段不适用于全局地址。

返回：成功

状态

字符串

地址的状态，可以是 RESERVING、RESERVED 或 IN_USE 之一。

处于 RESERVING 状态的地址当前正在预留过程中。

RESERVED 地址当前已预留并可用。IN_USE 地址当前正在被其他资源使用，不可用。

返回：成功

子网

字典

用于预留地址的子网 URL。如果指定了 IP 地址，则它必须位于子网的 IP 范围内。

此字段只能与具有 GCE_ENDPOINT/DNS_RESOLVER 目的的 INTERNAL 类型一起使用。

返回：成功

用户

列表 / 元素=字符串

正在使用此地址的资源的 URL。

返回：成功

作者

  • Google Inc. (@googlecloudplatform)