New in version 2.4.
The below requirements are needed on the host that executes this module.
Parameter |
Choices/Defaults |
Comments |
---|---|---|
account
|
Default:
None
|
Account the VPN gateway is related to.
|
api_http_method
|
|
HTTP method used to query the API endpoint.
If not given, the
CLOUDSTACK_METHOD env variable is considered.As the last option, the value is taken from the ini config file, also see the notes.
Fallback value is
get if not specified. |
api_key
|
|
API key of the CloudStack API.
If not given, the
CLOUDSTACK_KEY env variable is considered.As the last option, the value is taken from the ini config file, also see the notes.
|
api_region
|
Default:
cloudstack
|
Name of the ini section in the
cloustack.ini file.If not given, the
CLOUDSTACK_REGION env variable is considered. |
api_secret
|
|
Secret key of the CloudStack API.
If not set, the
CLOUDSTACK_SECRET env variable is considered.As the last option, the value is taken from the ini config file, also see the notes.
|
api_timeout
|
|
HTTP timeout in seconds.
If not given, the
CLOUDSTACK_TIMEOUT env variable is considered.As the last option, the value is taken from the ini config file, also see the notes.
Fallback value is 10 seconds if not specified.
|
api_url
|
|
URL of the CloudStack API e.g. https://cloud.example.com/client/api.
If not given, the
CLOUDSTACK_ENDPOINT env variable is considered.As the last option, the value is taken from the ini config file, also see the notes.
|
domain
|
Default:
None
|
Domain the VPN gateway is related to.
|
poll_async
|
Default:
yes
|
Poll async jobs until job has finished.
|
project
|
Default:
None
|
Name of the project the VPN gateway is related to.
|
state
|
|
State of the VPN gateway.
|
vpc
required |
|
Name of the VPC.
|
zone
|
Default:
None
|
Name of the zone the VPC is related to.
If not set, default zone is used.
|
Note
# Ensure a vpn gateway is present
- local_action:
module: cs_vpn_gateway
vpc: my VPC
# Ensure a vpn gateway is absent
- local_action:
module: cs_vpn_gateway
vpc: my VPC
state: absent
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
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.