cs_vpn_gateway - Manages site-to-site VPN gateways on Apache CloudStack based clouds.
New in version 2.4.
Synopsis
- Creates and removes VPN site-to-site gateways.
Requirements (on host that executes module)
- python >= 2.6
- cs >= 0.6.10
Options
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| account |
no |
Account the VPN gateway is related to.
|
||
| api_http_method |
no | get |
|
HTTP method used.
|
| api_key |
no |
API key of the CloudStack API.
|
||
| api_region |
no | cloudstack |
Name of the ini section in the
cloustack.ini file.
|
|
| api_secret |
no |
Secret key of the CloudStack API.
|
||
| api_timeout |
no | 10 |
HTTP timeout.
|
|
| api_url |
no |
URL of the CloudStack API e.g. https://cloud.example.com/client/api.
|
||
| domain |
no |
Domain the VPN gateway is related to.
|
||
| poll_async |
no | True |
Poll async jobs until job has finished.
|
|
| project |
no |
Name of the project the VPN gateway is related to.
|
||
| state |
no | present |
|
State of the VPN gateway.
|
| vpc |
yes |
Name of the VPC.
|
||
| zone |
no |
Name of the zone the VPC is related to.
If not set, default zone is used.
|
Examples
# 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
Return Values
Common return values are documented here Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| account |
Account the VPN site-to-site gateway is related to.
|
success | string | example account |
| domain |
Domain the VPN site-to-site gateway is related to.
|
success | string | example domain |
| id |
UUID of the VPN site-to-site gateway.
|
success | string | 04589590-ac63-4ffc-93f5-b698b8ac38b6 |
| project |
Name of project the VPN site-to-site gateway is related to.
|
success | string | Production |
| public_ip |
IP address of the VPN site-to-site gateway.
|
success | string | 10.100.212.10 |
| vpc |
Name of the VPC.
|
success | string | My VPC |
Notes
Note
- Ansible uses the
cslibrary’s configuration method if credentials are not provided by the argumentsapi_url,api_key,api_secret. Configuration is read from several locations, in the following order. - TheCLOUDSTACK_ENDPOINT,CLOUDSTACK_KEY,CLOUDSTACK_SECRETandCLOUDSTACK_METHOD.CLOUDSTACK_TIMEOUTenvironment variables. - ACLOUDSTACK_CONFIGenvironment variable pointing to an.inifile, - Acloudstack.inifile in the current working directory. - A.cloudstack.inifile in the users home directory. Optionally multiple credentials and endpoints can be specified using ini sections incloudstack.ini. Use the argumentapi_regionto select the section name, default section iscloudstack. See https://github.com/exoscale/cs for more information. - A detailed guide about cloudstack modules can be found on http://docs.ansible.com/ansible/guide_cloudstack.html
- This module supports check mode.
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/cs_vpn_gateway_module.html
