google.cloud.gcp_compute_interconnect_attachment 模块 – 创建 GCP InterconnectAttachment

注意

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

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

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

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

注意

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

概要

  • 表示 InterconnectAttachment（VLAN 附件）资源。有关更多信息，请参阅创建 VLAN 附件。

要求

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

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

参数

参数

注释

access_token

字符串

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

admin_enabled

布尔值

VLAN 附件是启用还是禁用。当使用 PARTNER 类型时，这将预激活互连附件。

选项

  • false

  • true ←（默认）

auth_kind

字符串 / 必需

使用的凭据类型。

选项

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

bandwidth

字符串

互连附件的预置带宽容量。

对于 DEDICATED 类型的附件，用户可以设置带宽。

对于 PARTNER 类型的附件，运营互连的 Google 合作伙伴必须设置带宽。

仅对 PARTNER 类型输出，对 PARTNER_PROVIDER 和 DEDICATED 可变，默认为 BPS_10G 。

一些有效的选项包括：“BPS_50M”、“BPS_100M”、“BPS_200M”、“BPS_300M”、“BPS_400M”、“BPS_500M”、“BPS_1G”、“BPS_2G”、“BPS_5G”、“BPS_10G”、“BPS_20G”、“BPS_50G”

candidate_subnets

列表 / 元素=字符串

最多 16 个候选前缀，可用于限制此附件的 cloudRouterIpAddress 和 customerRouterIpAddress 的分配。

所有前缀都必须在链路本地地址空间 (169.254.0.0/16) 内，并且必须是 /29 或更短（/28、/27 等）。Google 将尝试从提供的候选前缀中选择未使用的 /29。如果 Google 边缘上所有可能的 /29 都已在使用中，则请求将失败。如果未提供，Google 将从所有链路本地空间中随机选择未使用的 /29。

description

字符串

此资源的可选描述。

edge_availability_domain

字符串

附件所需的可用性域。仅在创建时可用于 PARTNER 类型。为了提高可靠性，客户应配置一对附件，每个可用性域一个。所选的可用性域将通过配对密钥提供给合作伙伴，以便配置的电路位于指定的域中。如果未指定，则该值将默认为 AVAILABILITY_DOMAIN_ANY。

encryption

字符串

指示此互连附件的用户提供的加密选项：NONE 是默认值，这意味着附件传输未加密的流量。虚拟机可以向此类型的附件发送流量或从中接收流量。

IPSEC 表示附件仅传输由 IPsec 设备（如 HA VPN 网关）加密的流量。虚拟机不能直接向此类附件发送流量或从中接收流量。要使用 IPsec 加密的云互连，请使用此选项创建附件。

目前不公开可用。

一些有效的选项包括：“NONE”、“IPSEC”

默认值： "NONE"

env_type

字符串

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

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

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

interconnect

字符串

此附件的流量将通过的底层互连对象的 URL。如果类型为 DEDICATED，则为必需；如果类型为 PARTNER，则不得设置。

ipsec_internal_addresses

列表 / 元素=字典

已为互连附件保留的地址的 URL，仅用于加密选项为 IPSEC 的互连附件。

这些地址必须是 RFC 1918 IP 地址范围。在互连附件上创建 HA VPN 网关时，如果将附件配置为使用 RFC 1918 IP 地址，则 VPN 网关的 IP 地址将从此处指定的 IP 地址范围分配。

例如，如果 HA VPN 网关的接口 0 与此互连附件配对，则 VPN 网关接口 0 的 RFC 1918 IP 地址将从为此互连附件指定的 IP 地址分配。

如果未为加密选项为 IPSEC 的互连附件指定此字段，则稍后在此互连附件上创建 HA VPN 网关时，HA VPN 网关的 IP 地址将从区域外部 IP 地址池分配。

mtu

字符串

通过此互连附件的报文的最大传输单元 (MTU)，以字节为单位。目前，仅允许 1440 和 1500。如果未指定，则该值将默认为 1440。

name

字符串 / 必需

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

project

字符串

要使用的 Google Cloud Platform 项目。

region

字符串 / 必需

区域互连附件所在的区域。

router

字典 / 必需

用于动态路由的云路由器的 URL。此路由器必须与此 InterconnectAttachment 位于同一区域。InterconnectAttachment 将自动将互连连接到配置云路由器的网络和区域内。

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

scopes

列表 / 元素=字符串

要使用的作用域数组

service_account_contents

jsonarg

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

service_account_email

字符串

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

service_account_file

path

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

state

字符串

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

选项

  • "present" ← (默认)

  • "absent"

type

字符串

您希望创建的 InterconnectAttachment 的类型。默认为 DEDICATED。

一些有效的选择包括：“DEDICATED”、“PARTNER”、“PARTNER_PROVIDER”

vlan_tag8021q

integer

此附件的 IEEE 802.1Q VLAN 标记，范围为 2-4094。当使用 PARTNER 类型时，此标记将由上游管理。

示例

- name: create a interconnect attachment
  google.cloud.gcp_compute_interconnect_attachment:
    name: test_object
    region: us-central1
    project: test_project
    auth_kind: serviceaccount
    interconnect: https://googleapis.com/compute/v1/projects/test_project/global/interconnects/...
    router: https://googleapis.com/compute/v1/projects/test_project/regions/us-central1/routers/...
    service_account_file: "/tmp/auth.pem"
    state: present
  register: disk

返回值

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

键

描述

adminEnabled

布尔值

VLAN 附件是启用还是禁用。当使用 PARTNER 类型时，这将预激活互连附件。

返回：成功

bandwidth

字符串

互连附件的预置带宽容量。

对于 DEDICATED 类型的附件，用户可以设置带宽。

对于 PARTNER 类型的附件，运营互连的 Google 合作伙伴必须设置带宽。

仅对 PARTNER 类型输出，对 PARTNER_PROVIDER 和 DEDICATED 可变，默认为 BPS_10G 。

返回：成功

candidateSubnets

列表 / 元素=字符串

最多 16 个候选前缀，可用于限制此附件的 cloudRouterIpAddress 和 customerRouterIpAddress 的分配。

所有前缀都必须在链路本地地址空间 (169.254.0.0/16) 内，并且必须是 /29 或更短（/28、/27 等）。Google 将尝试从提供的候选前缀中选择未使用的 /29。如果 Google 边缘上所有可能的 /29 都已在使用中，则请求将失败。如果未提供，Google 将从所有链路本地空间中随机选择未使用的 /29。

返回：成功

cloudRouterIpAddress

字符串

要在此互连附件的 Cloud Router 接口上配置的 IPv4 地址 + 前缀长度。

返回：成功

creationTimestamp

字符串

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

返回：成功

customerRouterIpAddress

字符串

要在此互连附件的客户路由器子接口上配置的 IPv4 地址 + 前缀长度。

返回：成功

description

字符串

此资源的可选描述。

返回：成功

edgeAvailabilityDomain

字符串

附件所需的可用性域。仅在创建时可用于 PARTNER 类型。为了提高可靠性，客户应配置一对附件，每个可用性域一个。所选的可用性域将通过配对密钥提供给合作伙伴，以便配置的电路位于指定的域中。如果未指定，则该值将默认为 AVAILABILITY_DOMAIN_ANY。

返回：成功

encryption

字符串

指示此互连附件的用户提供的加密选项：NONE 是默认值，这意味着附件传输未加密的流量。虚拟机可以向此类型的附件发送流量或从中接收流量。

IPSEC 表示附件仅传输由 IPsec 设备（如 HA VPN 网关）加密的流量。虚拟机不能直接向此类附件发送流量或从中接收流量。要使用 IPsec 加密的云互连，请使用此选项创建附件。

目前不公开可用。

返回：成功

googleReferenceId

字符串

Google 参考 ID，用于在向 Google 提出支持请求时或以其他方式调试后端连接问题时使用。

返回：成功

id

字符串

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

返回：成功

interconnect

字符串

此附件的流量将通过的底层互连对象的 URL。如果类型为 DEDICATED，则为必需；如果类型为 PARTNER，则不得设置。

返回：成功

ipsecInternalAddresses

列表 / 元素=字符串

已为互连附件保留的地址的 URL，仅用于加密选项为 IPSEC 的互连附件。

这些地址必须是 RFC 1918 IP 地址范围。在互连附件上创建 HA VPN 网关时，如果将附件配置为使用 RFC 1918 IP 地址，则 VPN 网关的 IP 地址将从此处指定的 IP 地址范围分配。

例如，如果 HA VPN 网关的接口 0 与此互连附件配对，则 VPN 网关接口 0 的 RFC 1918 IP 地址将从为此互连附件指定的 IP 地址分配。

如果未为加密选项为 IPSEC 的互连附件指定此字段，则稍后在此互连附件上创建 HA VPN 网关时，HA VPN 网关的 IP 地址将从区域外部 IP 地址池分配。

返回：成功

mtu

字符串

通过此互连附件的报文的最大传输单元 (MTU)，以字节为单位。目前，仅允许 1440 和 1500。如果未指定，则该值将默认为 1440。

返回：成功

name

字符串

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

返回：成功

pairingKey

字符串

[仅输出，适用于 PARTNER 类型。不适用于 DEDICATED]。PARTNER 附件的不透明标识符，用于启动与选定合作伙伴的配置。格式为 “XXXXX/region/domain”。

返回：成功

partnerAsn

字符串

[仅输出，适用于 PARTNER 类型。不适用于 DEDICATED]。如果第 3 层合作伙伴代表客户配置了 BGP，则此为可选的路由器 BGP ASN。

返回：成功

privateInterconnectInfo

complex

特定于 InterconnectAttachment 的信息。如果此附件所连接的互连类型为 DEDICATED，则会填充此属性。

返回：成功

tag8021q

integer

用于在 Google 和客户之间、以及来往此网络和区域的流量的 802.1q 封装标记。

返回：成功

region

字符串

区域互连附件所在的区域。

返回：成功

router

dictionary

用于动态路由的云路由器的 URL。此路由器必须与此 InterconnectAttachment 位于同一区域。InterconnectAttachment 将自动将互连连接到配置云路由器的网络和区域内。

返回：成功

state

字符串

[仅输出] 此附件当前功能的当前状态。

返回：成功

type

字符串

您希望创建的 InterconnectAttachment 的类型。默认为 DEDICATED。

返回：成功

vlanTag8021q

integer

此附件的 IEEE 802.1Q VLAN 标记，范围为 2-4094。当使用 PARTNER 类型时，此标记将由上游管理。

返回：成功

作者

  • Google Inc. (@googlecloudplatform)