google.cloud.gcp_compute_target_vpn_gateway 模块 – 创建一个 GCP TargetVpnGateway
注意
此模块是 google.cloud 集合(版本 1.4.1)的一部分。
如果您正在使用 ansible
包,您可能已经安装了此集合。它不包含在 ansible-core
中。要检查是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install google.cloud
。您需要进一步的要求才能使用此模块,请参阅 要求 了解详情。
要在 playbook 中使用它,请指定:google.cloud.gcp_compute_target_vpn_gateway
。
注意
由于违反了 Ansible 包含要求,google.cloud 集合将从 Ansible 12 中删除。该集合有 未解决的健全性测试失败。有关详细信息,请参阅 讨论主题。
概要
表示在 GCP 中运行的 VPN 网关。此虚拟设备由 Google 管理,但仅供您使用。
要求
执行此模块的主机上需要满足以下要求。
python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0
参数
参数 |
注释 |
---|---|
如果凭证类型为 accesstoken,则为 OAuth2 访问令牌。 |
|
使用的凭证类型。 选项
|
|
此资源的可选描述。 |
|
指定您在其中运行此模块的 Ansible 环境。 除非您知道自己在做什么,否则不应设置此项。 这只会更改任何 API 请求的用户代理字符串。 |
|
资源的名称。由客户端在创建资源时提供。名称必须为 1-63 个字符长,并符合 RFC1035。具体而言,名称必须为 1-63 个字符长,并与正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?` 匹配,这意味着第一个字符必须是小写字母,所有后续字符必须是破折号、小写字母或数字,但最后一个字符不能是破折号。 |
|
此 VPN 网关正在接受流量的网络。 此字段表示指向 GCP 中网络资源的链接。它可以通过两种方式指定。首先,您可以放置一个带有键 'selfLink' 和您的资源 selfLink 值的字典。或者,您可以将 `register: name-of-resource` 添加到 gcp_compute_network 任务,然后将此网络字段设置为“{{ name-of-resource }}” |
|
要使用的 Google Cloud Platform 项目。 |
|
此网关应位于的区域。 |
|
要使用的范围数组 |
|
服务帐户 JSON 文件的内容,可以是字典或表示它的 JSON 字符串。 |
|
如果选择了 machineaccount 并且用户不希望使用默认电子邮件,则为可选的服务帐户电子邮件地址。 |
|
如果选择 serviceaccount 作为类型,则为服务帐户 JSON 文件的路径。 |
|
给定对象是否应存在于 GCP 中 选项
|
注释
注意
API 参考:https://cloud.google.com/compute/docs/reference/rest/v1/targetVpnGateways
对于身份验证,您可以使用
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: create a address
google.cloud.gcp_compute_address:
name: address-vpngateway
region: us-west1
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
state: present
register: address
- name: create a network
google.cloud.gcp_compute_network:
name: network-vpngateway
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
state: present
register: network
- name: create a target vpn gateway
google.cloud.gcp_compute_target_vpn_gateway:
name: test_object
region: us-west1
network: "{{ network }}"
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
返回值
通用返回值记录在此处,以下是此模块独有的字段
键 |
描述 |
---|---|
RFC3339 文本格式的创建时间戳。 返回:成功 |
|
此资源的可选描述。 返回:成功 |
|
与此 VPN 网关关联的 ForwardingRule 资源的引用列表。 返回:成功 |
|
资源的唯一标识符。 返回:成功 |
|
资源的名称。由客户端在创建资源时提供。名称必须为 1-63 个字符长,并符合 RFC1035。具体而言,名称必须为 1-63 个字符长,并与正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?` 匹配,这意味着第一个字符必须是小写字母,所有后续字符必须是破折号、小写字母或数字,但最后一个字符不能是破折号。 返回:成功 |
|
此 VPN 网关正在接受流量的网络。 返回:成功 |
|
此网关应位于的区域。 返回:成功 |
|
与此 VPN 网关关联的 VpnTunnel 资源的引用列表。 返回:成功 |