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

列表 / 元素=字符串

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

列表中的每个附加过滤器都将作为 AND 条件添加（filter1 和 filter2）。

project

字符串

要使用的 Google Cloud Platform 项目。

region

字符串 / 必需

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

scopes

列表 / 元素=字符串

要使用的作用域数组

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

列表 / 元素=字符串

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

返回：成功

加密

字符串

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

IPSEC 指示附件仅承载由 IPsec 设备（例如 HA VPN 网关）加密的流量。虚拟机无法直接向此类附件发送流量，也无法从此类附件接收流量。要使用 IPsec 加密的云互连，请使用此选项创建附件。

目前不公开提供。

返回：成功

googleReferenceId

字符串

Google 参考 ID，用于在向 Google 提交支持工单或调试后端连接问题时使用。

返回：成功

id

字符串

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

返回：成功

互连

字符串

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

返回：成功

ipsecInternalAddresses

列表 / 元素=字符串

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

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

例如，如果 HA VPN 网关的接口 0 与此互连附件配对，则 HA 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，则应由第 3 层合作伙伴提供的可选 BGP ASN。

返回：成功

privateInterconnectInfo

复杂

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

返回：成功

tag8021q

整数

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

返回：成功

region

字符串

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

返回：成功

路由器

字典

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

返回：成功

状态

字符串

【仅输出】此附件功能的当前状态。

返回：成功

类型

字符串

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

返回：成功

vlanTag8021q

整数

此附件的 IEEE 802.1Q VLAN 标签，范围为 2-4094。使用 PARTNER 类型时，这将在上游进行管理。

返回：成功

作者

  • Google Inc. (@googlecloudplatform)