ngine_io.cloudstack.vpc_private_gateway module – Manages private gateways for VPCs on Apache CloudStack based clouds.

Note

This module is part of the ngine_io.cloudstack collection (version 3.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.vpc_private_gateway.

New in ngine_io.cloudstack 3.1.0

Synopsis

  • Create and remove private gateways attached to a VPC.

  • Existing private gateways are matched by IP address within the VPC scope.

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 private gateway 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.

bypass_vlan_overlap_check

boolean

Whether to bypass VLAN overlap checks during creation.

Choices:

  • false

  • true

domain

string

Domain the private gateway is related to.

gateway

string

Gateway of the private gateway.

Required on state=present.

ip_address

string / required

IP address of the private gateway.

netmask

string

Netmask of the private gateway.

Required on state=present.

network

string

Name of the isolated network this private gateway is associated with.

network_acl

string

Name of the network ACL to attach to the private gateway.

network_offering

string

Network offering to use for the private gateway network connection.

physical_network

string

Name of the physical network the private gateway belongs to.

poll_async

boolean

Poll async jobs until job has finished.

Choices:

  • false

  • true ← (default)

project

string

Name of the project the private gateway is related to.

source_nat_supported

boolean

Whether source NAT should be enabled on the private gateway.

Choices:

  • false

  • true

state

string

State of the private gateway.

Choices:

  • "present" ← (default)

  • "absent"

validate_certs

boolean

added in ngine_io.cloudstack 2.4.0

If false, SSL certificates will not be validated.

If not given, the CLOUDSTACK_DANGEROUS_NO_TLS_VERIFY env variable is considered.

This should only be used on personally controlled sites using self-signed certificates.

Choices:

  • false

  • true ← (default)

vlan

string

VLAN identifier or URI of the private gateway.

Required on state=present.

vpc

string / required

Name of the VPC.

zone

string / required

Name of the zone the VPC belongs 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 private gateway is present on a VPC
  ngine_io.cloudstack.vpc_private_gateway:
    vpc: my-vpc
    zone: zone01
    ip_address: 10.11.11.2
    gateway: 10.11.11.1
    netmask: 255.255.255.0
    vlan: "400"

- name: Ensure a private gateway is absent from a VPC
  ngine_io.cloudstack.vpc_private_gateway:
    vpc: my-vpc
    zone: zone01
    ip_address: 10.11.11.2
    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 private gateway is related to.

Returned: when available

Sample: "example-account"

domain

string

Domain the private gateway is related to.

Returned: when available

Sample: "ROOT"

gateway

string

Gateway of the private gateway.

Returned: success

Sample: "10.11.11.1"

id

string

UUID of the private gateway.

Returned: success

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

ip_address

string

IP address of the private gateway.

Returned: success

Sample: "10.11.11.2"

netmask

string

Netmask of the private gateway.

Returned: success

Sample: "255.255.255.0"

network_acl

string

Name of the ACL associated with the private gateway.

Returned: when available

Sample: "default-vpc-acl"

network_acl_id

string

UUID of the ACL associated with the private gateway.

Returned: when available

Sample: "a6f7a5fc-43f8-11e5-a151-feff819cdc9f"

project

string

Name of the project the private gateway is related to.

Returned: when available

Sample: "Production"

source_nat_supported

boolean

Whether source NAT is supported on the private gateway.

Returned: success

Sample: false

state

string

State of the private gateway.

Returned: success

Sample: "Ready"

vlan

string

VLAN identifier or URI of the private gateway.

Returned: success

Sample: "400"

vpc

string

Name of the VPC the private gateway belongs to.

Returned: success

Sample: "my-vpc"

vpc_id

string

UUID of the VPC the private gateway belongs to.

Returned: success

Sample: "87b1e0ce-4e01-11e4-bb66-0050569e64b8"

zone

string

Name of the zone the private gateway belongs to.

Returned: success

Sample: "Sandbox-simulator-advanced"

Authors

  • René Moser (@resmo)