ngine_io.cloudstack.cs_vpn_connection 模块 – 管理基于 Apache CloudStack 云的站点到站点 VPN 连接。

注意

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

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

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

要在 playbook 中使用它，请指定： ngine_io.cloudstack.cs_vpn_connection。

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 环境变量。
domain 字符串	VPN 连接相关的域。
force 布尔值	如果在 state=present 时尚未激活，则激活 VPN 网关。 另请参见 ngine_io.cloudstack.cs_vpn_gateway。 选项 false ← (默认) true
passive 布尔值	VPN 连接的状态。 仅在 state=present 时考虑。 选项 false ← (默认) true
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 ← (默认)
vpc 字符串 / 必需	VPN 连接相关的 VPC 的名称。
vpn_customer_gateway 字符串 / 必需	VPN 客户网关的名称。
zone 字符串 / 必需	VPC 相关的区域的名称。

备注

注意

• 有关 cloudstack 模块的详细指南，请参见 CloudStack 云指南。

• 此模块支持检查模式。

示例

- name: Create a VPN connection with activated VPN gateway
  ngine_io.cloudstack.cs_vpn_connection:
    vpn_customer_gateway: my vpn connection
    vpc: my vpc
    zone: zone01

- name: Create a VPN connection and force VPN gateway activation
  ngine_io.cloudstack.cs_vpn_connection:
    vpn_customer_gateway: my vpn connection
    vpc: my vpc
    zone: zone01
    force: yes

- name: Remove a vpn connection
  ngine_io.cloudstack.cs_vpn_connection:
    vpn_customer_gateway: my vpn connection
    vpc: my vpc
    zone: zone01
    state: absent

返回值

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

键	描述
account 字符串	VPN 连接相关的账户。 返回： success 示例： "example account"
cidrs 列表 / 元素=字符串	客户网关的 CIDR 列表。 返回： success 示例： ["10.10.10.0/24"]
created 字符串	连接创建的日期。 返回： success 示例： "2014-12-01T14:57:57+0100"
domain 字符串	VPN 连接相关的域。 返回： success 示例： "example domain"
dpd 布尔值	是否启用了死对等检测。 返回： success 示例： true
esp_lifetime 整数	第 2 阶段 VPN 连接的生存时间（秒）。 返回： success 示例： 86400
esp_policy 字符串	VPN 连接的 IKE 策略。 返回： success 示例： "aes256-sha1;modp1536"
force_encap 布尔值	是否强制执行用于 NAT 遍历的封装。 返回： success 示例： true
gateway 字符串	VPN 客户网关的 IP 地址。 返回： success 示例： "10.101.214.10"
id 字符串	VPN 连接的 UUID。 返回： success 示例： "04589590-ac63-4ffc-93f5-b698b8ac38b6"
ike_lifetime 整数	第 1 阶段 VPN 连接的生存时间（秒）。 返回： success 示例： 86400
ike_policy 字符串	VPN 连接的 ESP 策略。 返回： success 示例： "aes256-sha1;modp1536"
passive 布尔值	连接是否处于被动状态。 返回： success 示例： false
project 字符串	VPN 连接相关的项目的名称。 返回： success 示例： "Production"
public_ip 字符串	VPN 网关的IP地址。 返回： success 示例： "10.100.212.10"
state 字符串	VPN 连接的状态。 返回： success 示例： "已连接"
vpn_gateway_id 字符串	VPN 网关的UUID。 返回： success 示例： "04589590-ac63-93f5-4ffc-b698b8ac38b6"

作者

• René Moser (@resmo)

资源链接

• 问题追踪器
• 代码仓库