ansible.builtin.cs_vpn_gateway (v2.5.11) — module

Install Ansible via pip

Install with pip install ansible==2.5.11

Description

Creates and removes VPN site-to-site gateways.

Requirements

• python >= 2.6
• cs >= 0.9.0

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Ensure a vpn gateway is present
- local_action:
    module: cs_vpn_gateway
    vpc: my VPC

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Ensure a vpn gateway is absent
- local_action:
    module: cs_vpn_gateway
    vpc: my VPC
    state: absent

Inputs

    
vpc:
    description:
    - Name of the VPC.
    required: true

zone:
    default: null
    description:
    - Name of the zone the VPC is related to.
    - If not set, default zone is used.
    required: false

state:
    choices:
    - present
    - absent
    default: present
    description:
    - State of the VPN gateway.
    required: false

domain:
    default: null
    description:
    - Domain the VPN gateway is related to.
    required: false

account:
    default: null
    description:
    - Account the VPN gateway is related to.
    required: false

api_key:
    description:
    - API key of the CloudStack API.
    - If not given, the C(CLOUDSTACK_KEY) env variable is considered.
    required: true
    type: str

api_url:
    description:
    - URL of the CloudStack API e.g. https://cloud.example.com/client/api.
    - If not given, the C(CLOUDSTACK_ENDPOINT) env variable is considered.
    required: true
    type: str

project:
    default: null
    description:
    - Name of the project the VPN gateway is related to.
    required: false

api_secret:
    description:
    - Secret key of the CloudStack API.
    - If not set, the C(CLOUDSTACK_SECRET) env variable is considered.
    required: true
    type: str

poll_async:
    default: true
    description:
    - Poll async jobs until job has finished.
    required: false

api_timeout:
    default: 10
    description:
    - HTTP timeout in seconds.
    - If not given, the C(CLOUDSTACK_TIMEOUT) env variable is considered.
    type: int

api_http_method:
    choices:
    - get
    - post
    default: get
    description:
    - HTTP method used to query the API endpoint.
    - If not given, the C(CLOUDSTACK_METHOD) env variable is considered.
    type: str

api_verify_ssl_cert:
    description:
    - Verify CA authority cert file.
    - If not given, the C(CLOUDSTACK_VERIFY) env variable is considered.
    type: str

Outputs

account:
  description: Account the VPN site-to-site gateway is related to.
  returned: success
  sample: example account
  type: string
domain:
  description: Domain the VPN site-to-site gateway is related to.
  returned: success
  sample: example domain
  type: string
id:
  description: UUID of the VPN site-to-site gateway.
  returned: success
  sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6
  type: string
project:
  description: Name of project the VPN site-to-site gateway is related to.
  returned: success
  sample: Production
  type: string
public_ip:
  description: IP address of the VPN site-to-site gateway.
  returned: success
  sample: 10.100.212.10
  type: string
vpc:
  description: Name of the VPC.
  returned: success
  sample: My VPC
  type: string