google.cloud.gcp_compute_route_info 模块 – 收集 GCP 路由信息

注意

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

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

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

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

注意

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

概要

  • 收集 GCP 路由信息

要求

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

  • 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 项目。

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 a route
  gcp_compute_route_info:
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值

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

键

描述

resources

复杂类型

资源列表

返回：始终

description

字符串

此资源的可选描述。创建资源时提供此属性。

返回：成功

destRange

字符串

此路由应用到的传出数据包的目标范围。

仅支持 IPv4。

返回：成功

name

字符串

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

返回：成功

网络

字典

此路由适用的网络。

返回：成功

nextHopGateway

字符串

应处理匹配数据包的网关的 URL。

目前，您只能使用完整或部分有效的 URL 指定互联网网关：* https://www.googleapis.com/compute/v1/projects/project/global/gateways/default-internet-gateway * projects/project/global/gateways/default-internet-gateway * global/gateways/default-internet-gateway。

返回：成功

nextHopIlb

字典

应处理匹配数据包的类型为 loadBalancingScheme=INTERNAL 的转发规则的 URL。

您只能指定转发规则作为部分或完整的 URL。例如，以下所有 URL 都是有效的：https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule regions/region/forwardingRules/forwardingRule 请注意，只有当 destinationRange 是公共（非 RFC 1918）IP CIDR 范围时，才能使用此方法。

返回：成功

nextHopInstance

字典

应处理匹配数据包的实例的 URL。

您可以将其指定为完整或部分 URL。例如：* https://www.googleapis.com/compute/v1/projects/project/zones/zone/ instances/instance * projects/project/zones/zone/instances/instance * zones/zone/instances/instance。

返回：成功

nextHopIp

字符串

应处理匹配数据包的实例的网络 IP 地址。

返回：成功

nextHopNetwork

字符串

应处理匹配数据包的网络的 URL。

返回：成功

nextHopVpnTunnel

字典

应处理匹配数据包的 VpnTunnel 的 URL。

返回：成功

优先级

整数

此路由的优先级。当存在多个具有相同前缀长度的匹配路由时，优先级用于打破平局。

对于两个具有相同前缀长度的路由，优先级数值最低者获胜。

默认值为 1000。有效范围为 0 到 65535。

返回：成功

标签

列表 / 元素=字符串

此路由适用的实例标签列表。

返回：成功

作者

  • Google Inc. (@googlecloudplatform)