ngine_io.cloudstack.cs_vpn_connection module – Manages site-to-site VPN connections on Apache CloudStack based clouds.

Note

This module is part of the ngine_io.cloudstack collection (version 2.3.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install ngine_io.cloudstack. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: ngine_io.cloudstack.cs_vpn_connection.

New in ngine_io.cloudstack 0.1.0

Synopsis

  • Create and remove VPN connections.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6

  • cs >= 0.9.0

Parameters

Parameter

Comments

account

string

Account the VPN connection is related to.

api_http_method

string

HTTP method used to query the API endpoint.

If not given, the CLOUDSTACK_METHOD env variable is considered.

Choices:

  • "get" ← (default)

  • "post"

api_key

string / required

API key of the CloudStack API.

If not given, the CLOUDSTACK_KEY env variable is considered.

api_secret

string / required

Secret key of the CloudStack API.

If not set, the CLOUDSTACK_SECRET env variable is considered.

api_timeout

integer

HTTP timeout in seconds.

If not given, the CLOUDSTACK_TIMEOUT env variable is considered.

Default: 10

api_url

string / required

URL of the CloudStack API e.g. https://cloud.example.com/client/api.

If not given, the CLOUDSTACK_ENDPOINT env variable is considered.

api_verify_ssl_cert

string

Verify CA authority cert file.

If not given, the CLOUDSTACK_VERIFY env variable is considered.

domain

string

Domain the VPN connection is related to.

force

boolean

Activate the VPN gateway if not already activated on state=present.

Also see ngine_io.cloudstack.cs_vpn_gateway.

Choices:

  • false ← (default)

  • true

passive

boolean

State of the VPN connection.

Only considered when state=present.

Choices:

  • false ← (default)

  • true

poll_async

boolean

Poll async jobs until job has finished.

Choices:

  • false

  • true ← (default)

project

string

Name of the project the VPN connection is related to.

state

string

State of the VPN connection.

Choices:

  • "present" ← (default)

  • "absent"

vpc

string / required

Name of the VPC the VPN connection is related to.

vpn_customer_gateway

string / required

Name of the VPN customer gateway.

zone

string / required

Name of the zone the VPC is related to.

Notes

Note

  • A detailed guide about cloudstack modules can be found in the CloudStack Cloud Guide.

  • This module supports check mode.

Examples

- 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

account

string

Account the VPN connection is related to.

Returned: success

Sample: "example account"

cidrs

list / elements=string

List of CIDRs of the customer gateway.

Returned: success

Sample: ["10.10.10.0/24"]

created

string

Date the connection was created.

Returned: success

Sample: "2014-12-01T14:57:57+0100"

domain

string

Domain the VPN connection is related to.

Returned: success

Sample: "example domain"

dpd

boolean

Whether dead pear detection is enabled or not.

Returned: success

Sample: true

esp_lifetime

integer

Lifetime in seconds of phase 2 VPN connection.

Returned: success

Sample: 86400

esp_policy

string

IKE policy of the VPN connection.

Returned: success

Sample: "aes256-sha1;modp1536"

force_encap

boolean

Whether encapsulation for NAT traversal is enforced or not.

Returned: success

Sample: true

gateway

string

IP address of the VPN customer gateway.

Returned: success

Sample: "10.101.214.10"

id

string

UUID of the VPN connection.

Returned: success

Sample: "04589590-ac63-4ffc-93f5-b698b8ac38b6"

ike_lifetime

integer

Lifetime in seconds of phase 1 VPN connection.

Returned: success

Sample: 86400

ike_policy

string

ESP policy of the VPN connection.

Returned: success

Sample: "aes256-sha1;modp1536"

passive

boolean

Whether the connection is passive or not.

Returned: success

Sample: false

project

string

Name of project the VPN connection is related to.

Returned: success

Sample: "Production"

public_ip

string

IP address of the VPN gateway.

Returned: success

Sample: "10.100.212.10"

state

string

State of the VPN connection.

Returned: success

Sample: "Connected"

vpn_gateway_id

string

UUID of the VPN gateway.

Returned: success

Sample: "04589590-ac63-93f5-4ffc-b698b8ac38b6"

Authors

  • René Moser (@resmo)