ngine_io.cloudstack.cs_vpn_gateway – Manages site-to-site VPN gateways on Apache CloudStack based clouds.

Note

This plugin is part of the ngine_io.cloudstack collection (version 2.0.0).

To install it use: ansible-galaxy collection install ngine_io.cloudstack.

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

New in version 0.1.0: of ngine_io.cloudstack

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis

Creates and removes VPN site-to-site gateways.

Requirements

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

python >= 2.6
cs >= 0.9.0

Parameters

Parameter	Choices/Defaults	Comments
account string		Account the VPN gateway is related to.
api_http_method string	get ← post	HTTP method used to query the API endpoint. If not given, the `CLOUDSTACK_METHOD` env variable is considered.
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	Default: 10	HTTP timeout in seconds. If not given, the `CLOUDSTACK_TIMEOUT` env variable is considered.
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 gateway is related to.
poll_async boolean	no yes ←	Poll async jobs until job has finished.
project string		Name of the project the VPN gateway is related to.
state string	present ← absent	State of the VPN gateway.
vpc string / required		Name of the VPC.
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: Ensure a vpn gateway is present
  ngine_io.cloudstack.cs_vpn_gateway:
    vpc: my VPC
    zone: zone01

- name: Ensure a vpn gateway is absent
  ngine_io.cloudstack.cs_vpn_gateway:
    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	Returned	Description
account string	success	Account the VPN site-to-site gateway is related to. Sample: example account
domain string	success	Domain the VPN site-to-site gateway is related to. Sample: example domain
id string	success	UUID of the VPN site-to-site gateway. Sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6
project string	success	Name of project the VPN site-to-site gateway is related to. Sample: Production
public_ip string	success	IP address of the VPN site-to-site gateway. Sample: 10.100.212.10
vpc string	success	Name of the VPC. Sample: My VPC

Authors

René Moser (@resmo)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ngine_io/cloudstack/cs_vpn_gateway_module.html