ngine_io.cloudstack.cs_account module – Manages accounts on Apache CloudStack based clouds.
Note
This module is part of the ngine_io.cloudstack collection (version 2.4.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.cs_account
.
New in ngine_io.cloudstack 0.1.0
Synopsis
Create, disable, lock, enable and remove accounts.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.6
cs >= 0.9.0
Parameters
Parameter |
Comments |
---|---|
Type of the account. Choices:
|
|
HTTP method used to query the API endpoint. If not given, the Choices:
|
|
API key of the CloudStack API. If not given, the |
|
Secret key of the CloudStack API. If not set, the |
|
HTTP timeout in seconds. If not given, the Default: |
|
URL of the CloudStack API e.g. https://cloud.example.com/client/api. If not given, the |
|
Verify CA authority cert file. If not given, the |
|
Domain the account is related to. Default: |
|
Email of the user to be created if account did not exist. Required on state=present if ldap_domain is not set. |
|
First name of the user to be created if account did not exist. Required on state=present if ldap_domain is not set. |
|
Last name of the user to be created if account did not exist. Required on state=present if ldap_domain is not set. |
|
Name of the LDAP group or OU to bind. If set, account will be linked to LDAP. |
|
Type of the ldap name. GROUP or OU, defaults to GROUP. Choices:
|
|
Name of account. |
|
Network domain of the account. |
|
Password of the user to be created if account did not exist. Required on state=present if ldap_domain is not set. |
|
Poll async jobs until job has finished. Choices:
|
|
Creates the account under the specified role name or id. |
|
State of the account.
Choices:
|
|
Timezone of the user to be created if account did not exist. |
|
Username of the user to be created if account did not exist. Required on state=present. |
|
If If not given, the This should only be used on personally controlled sites using self-signed certificates. Choices:
|
Notes
Note
A detailed guide about cloudstack modules can be found in the CloudStack Cloud Guide.
This module supports check mode.
Examples
- name: create an account in domain 'CUSTOMERS'
ngine_io.cloudstack.cs_account:
name: customer_xy
username: customer_xy
password: S3Cur3
last_name: Doe
first_name: John
email: [email protected]
domain: CUSTOMERS
role: Domain Admin
- name: Lock an existing account in domain 'CUSTOMERS'
ngine_io.cloudstack.cs_account:
name: customer_xy
domain: CUSTOMERS
state: locked
- name: Disable an existing account in domain 'CUSTOMERS'
ngine_io.cloudstack.cs_account:
name: customer_xy
domain: CUSTOMERS
state: disabled
- name: Enable an existing account in domain 'CUSTOMERS'
ngine_io.cloudstack.cs_account:
name: customer_xy
domain: CUSTOMERS
state: enabled
- name: Remove an account in domain 'CUSTOMERS'
ngine_io.cloudstack.cs_account:
name: customer_xy
domain: CUSTOMERS
state: absent
- name: Create a single user LDAP account in domain 'CUSTOMERS'
ngine_io.cloudstack.cs_account:
name: customer_xy
username: customer_xy
domain: CUSTOMERS
ldap_domain: cn=customer_xy,cn=team_xy,ou=People,dc=domain,dc=local
- name: Create a LDAP account in domain 'CUSTOMERS' and bind it to a LDAP group
ngine_io.cloudstack.cs_account:
name: team_xy
username: customer_xy
domain: CUSTOMERS
ldap_domain: cn=team_xy,ou=People,dc=domain,dc=local
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Type of the account. Returned: success Sample: |
|
Domain the account is related. Returned: success Sample: |
|
UUID of the account. Returned: success Sample: |
|
Name of the account. Returned: success Sample: |
|
Network domain of the account. Returned: success Sample: |
|
The role name of the account Returned: success Sample: |
|
State of the account. Returned: success Sample: |