ngine_io.cloudstack.vpn_user module – Manages VPN users 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.vpn_user.

New in ngine_io.cloudstack 3.1.0

Synopsis

• Create and remove VPN users.

• Passwords are only used during creation and are not updated afterwards.

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 VPN user is related to. Must be used together with domain.
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.
domain string	Domain the VPN user is related to.
password string	Password of the VPN user. Required on state=present. Only considered on creation and will not be updated if the VPN user already exists.
project string	Name of the project the VPN user is related to.
state string	State of the VPN user. Choices: "present" ← (default) "absent"
username string / required	Username of the VPN user.
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)

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 user is present for an account
  ngine_io.cloudstack.vpn_user:
    username: johndoe
    password: S3Cur3
    account: developers
    domain: ROOT

- name: Ensure a VPN user is absent for an account
  ngine_io.cloudstack.vpn_user:
    username: johndoe
    account: developers
    domain: ROOT
    state: absent

- name: Ensure a project VPN user is present
  ngine_io.cloudstack.vpn_user:
    username: ci-user
    password: S3Cur3
    project: Production

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
account string	Account of the VPN user. Returned: success Sample: "developers"
domain string	Domain of the VPN user. Returned: success Sample: "ROOT"
id string	UUID of the VPN user. Returned: success Sample: "87b1e0ce-4e01-11e4-bb66-0050569e64b8"
project string	Project of the VPN user. Returned: success Sample: "Production"
state string	State of the VPN user. Returned: success Sample: "Active"
username string	Username of the VPN user. Returned: success Sample: "johndoe"

Authors

• René Moser (@resmo)

Collection links

• Issue Tracker
• Repository (Sources)