google.cloud.gcp_compute_interconnect_attachment_info 模块 – 收集 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_info。

注意

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

概要

  • 收集 GCP InterconnectAttachment 的信息

要求

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

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

参数

参数

注释

access_token

字符串

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

auth_kind

字符串 / 必需

使用的凭据类型。

选项

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

env_type

字符串

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

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

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

filters

列表 / elements=字符串

过滤器值对的列表。此处列出了可用过滤器 https://cloud.google.com/sdk/gcloud/reference/topic/filters。

列表中每个额外的过滤器都将添加为 AND 条件（过滤器 1 和过滤器 2）。

project

字符串

要使用的 Google Cloud Platform 项目。

region

字符串 / 必需

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

scopes

列表 / elements=字符串

要使用的作用域数组

service_account_contents

jsonarg

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

service_account_email

字符串

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

service_account_file

路径

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

注释

注意

  • 对于身份验证，您可以使用 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: get info on an interconnect attachment
  gcp_compute_interconnect_attachment_info:
    region: us-central1
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值

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

键

描述

resources

复杂

资源列表

已返回： 始终

adminEnabled

布尔值

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

已返回： 成功

bandwidth

字符串

为互连附件预配的带宽容量。

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

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

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

已返回： 成功

candidateSubnets

列表 / elements=字符串

最多 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

列表 / elements=字符串

为互连连接预留的地址的 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

复杂

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

已返回： 成功

tag8021q

整数

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

已返回： 成功

region

字符串

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

已返回： 成功

router

字典

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

已返回： 成功

state

字符串

[仅输出] 此连接功能的当前状态。

已返回： 成功

type

字符串

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

已返回： 成功

vlanTag8021q

整数

此连接的 IEEE 802.1Q VLAN 标记，范围为 2-4094。当使用 PARTNER 类型时，此标记将在上游进行管理。

已返回： 成功

作者

  • Google Inc. (@googlecloudplatform)