ngine_io.cloudstack.cs_vpn_customer_gateway 模块 – 在基于 Apache CloudStack 的云上管理站点到站点 VPN 客户网关配置。

注意

此模块是 ngine_io.cloudstack 集合 (版本 2.5.0) 的一部分。

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

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

要在剧本中使用它，请指定： ngine_io.cloudstack.cs_vpn_customer_gateway。

ngine_io.cloudstack 0.1.0 中的新增功能

概要 

创建、更新和删除 VPN 客户网关。

要求 

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

python >= 2.6
cs >= 0.9.0

参数 

参数	注释
account 字符串	VPN 客户网关相关的帐户。
api_http_method 字符串	用于查询 API 端点的 HTTP 方法。如果未给出，则考虑 `CLOUDSTACK_METHOD` 环境变量。选项 `"get"` ← (默认) `"post"`
api_key 字符串 / 必需	CloudStack API 的 API 密钥。如果未给出，则考虑 `CLOUDSTACK_KEY` 环境变量。
api_secret 字符串 / 必需	CloudStack API 的密钥。如果未设置，则考虑 `CLOUDSTACK_SECRET` 环境变量。
api_timeout 整数	HTTP 超时时间（秒）。如果未给出，则考虑 `CLOUDSTACK_TIMEOUT` 环境变量。默认值： `10`
api_url 字符串 / 必需	CloudStack API 的 URL，例如 https://cloud.example.com/client/api。如果未给出，则考虑 `CLOUDSTACK_ENDPOINT` 环境变量。
api_verify_ssl_cert 字符串	验证 CA 权威证书文件。如果未给出，则考虑 `CLOUDSTACK_VERIFY` 环境变量。
cidrs 别名：cidr 列表 / 元素=字符串	网关后面的访客 CIDR 列表。如果 state=present，则必需。
domain 字符串	VPN 客户网关相关的域。
dpd 布尔值	启用死对等检测。如果未设置，则 API 在创建时默认禁用。选项 `false` `true`
esp_lifetime 整数	第 2 阶段 VPN 连接的生存时间（秒）。如果未设置，则 API 在创建时默认为 3600。
esp_policy 字符串	ESP 策略，格式例如 `aes256-sha1;modp1536`。如果 state=present，则必需。
force_encap 布尔值	强制封装以进行 NAT 穿越。如果未设置，则 API 在创建时默认禁用。选项 `false` `true`
gateway 字符串	网关的公共 IP 地址。如果 state=present，则必需。
ike_lifetime 整数	第 1 阶段 VPN 连接的生存时间（秒）。如果未设置，则 API 在创建时默认为 86400。
ike_policy 字符串	IKE 策略，格式例如 `aes256-sha1;modp1536`。如果 state=present，则必需。
ipsec_psk 字符串	IPsec 预共享密钥。不能包含换行符或双引号。如果 state=present，则必需。
name 字符串 / 必需	网关的名称。
poll_async 布尔值	轮询异步作业，直到作业完成。选项 `false` `true` ← (默认)
project 字符串	VPN 网关相关的项目的名称。
state 字符串	VPN 客户网关的状态。选项 `"present"` ← (默认) `"absent"`
validate_certs 布尔值 ngine_io.cloudstack 2.4.0 中新增	如果 `false`，则不会验证 SSL 证书。如果未给出，则考虑 `CLOUDSTACK_DANGEROUS_NO_TLS_VERIFY` 环境变量。这仅应在使用自签名证书的个人控制站点上使用。选项 `false` `true` ← (默认)

注释 

注意

关于CloudStack模块的详细指南，请参阅CloudStack云指南。
此模块支持检查模式。

示例 

- name: Create a vpn customer gateway
  ngine_io.cloudstack.cs_vpn_customer_gateway:
    name: my vpn customer gateway
    cidrs:
    - 192.168.123.0/24
    - 192.168.124.0/24
    esp_policy: aes256-sha1;modp1536
    gateway: 10.10.1.1
    ike_policy: aes256-sha1;modp1536
    ipsec_psk: "S3cr3Tk3Y"

- name: Remove a vpn customer gateway
  ngine_io.cloudstack.cs_vpn_customer_gateway:
    name: my vpn customer gateway
    state: absent

返回值 

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

键	描述
account 字符串	VPN 客户网关相关的帐户。返回：成功示例：`"example account"`
CIDR 列表 / 元素=字符串	此客户网关的CIDR列表。返回：成功示例：`["10.10.10.0/24"]`
domain 字符串	VPN 客户网关相关的域。返回：成功示例：`"example domain"`
dpd 布尔值	是否启用坏梨检测。返回：成功示例：`true`
esp_lifetime 整数	第 2 阶段 VPN 连接的生存时间（秒）。返回：成功示例：`86400`
esp_policy 字符串	VPN客户网关的IKE策略。返回：成功示例：`"aes256-sha1;modp1536"`
force_encap 布尔值	是否强制执行用于NAT遍历的封装。返回：成功示例：`true`
gateway 字符串	VPN客户网关的IP地址。返回：成功示例：`"10.100.212.10"`
ID 字符串	VPN客户网关的UUID。返回：成功示例：`"04589590-ac63-4ffc-93f5-b698b8ac38b6"`
ike_lifetime 整数	第 1 阶段 VPN 连接的生存时间（秒）。返回：成功示例：`86400`
ike_policy 字符串	VPN客户网关的ESP策略。返回：成功示例：`"aes256-sha1;modp1536"`
name 字符串	此客户网关的名称。返回：成功示例：`"my vpn customer gateway"`
project 字符串	VPN客户网关所属项目的名称。返回：成功示例：`"Production"`

作者

René Moser (@resmo)