cs_account – Manages accounts on Apache CloudStack based clouds.
cs_account – Manages accounts on Apache CloudStack based clouds.
New in version 2.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.6.10
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
account_type - |
|
Type of the account. |
api_http_method - |
|
HTTP method used to query the API endpoint. If not given, the As the last option, the value is taken from the ini config file, also see the notes. Fallback value is |
api_key - |
API key of the CloudStack API. If not given, the 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 If not given, the |
api_secret - |
Secret key of the CloudStack API. If not set, the 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 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 As the last option, the value is taken from the ini config file, also see the notes. | |
domain - |
Default: "ROOT" |
Domain the account is related to. |
- |
Email of the user to be created if account did not exist. Required on | |
first_name - |
First name of the user to be created if account did not exist. Required on | |
last_name - |
Last name of the user to be created if account did not exist. Required on | |
name - / required |
Name of account. | |
network_domain - |
Network domain of the account. | |
password - |
Password of the user to be created if account did not exist. Required on | |
poll_async boolean |
|
Poll async jobs until job has finished. |
state - |
|
State of the account.
|
timezone - |
Timezone of the user to be created if account did not exist. | |
username - |
Username of the user to be created if account did not exist. Required on |
Notes
Note
- Ansible uses the
cs
library’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_SECRET
andCLOUDSTACK_METHOD
.CLOUDSTACK_TIMEOUT
environment variables. ACLOUDSTACK_CONFIG
environment variable pointing to an.ini
file. Acloudstack.ini
file in the current working directory. A.cloudstack.ini
file in the users home directory. Optionally multiple credentials and endpoints can be specified using ini sections incloudstack.ini
. Use the argumentapi_region
to 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 in the CloudStack Cloud Guide.
- This module supports check mode.
Examples
# create an account in domain 'CUSTOMERS'
- local_action:
module: cs_account
name: customer_xy
username: customer_xy
password: S3Cur3
last_name: Doe
first_name: John
email: [email protected]
domain: CUSTOMERS
# Lock an existing account in domain 'CUSTOMERS'
- local_action:
module: cs_account
name: customer_xy
domain: CUSTOMERS
state: locked
# Disable an existing account in domain 'CUSTOMERS'
- local_action:
module: cs_account
name: customer_xy
domain: CUSTOMERS
state: disabled
# Enable an existing account in domain 'CUSTOMERS'
- local_action:
module: cs_account
name: customer_xy
domain: CUSTOMERS
state: enabled
# Remove an account in domain 'CUSTOMERS'
- local_action:
module: cs_account
name: customer_xy
domain: CUSTOMERS
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
account_type string |
success |
Type of the account.
Sample: user |
domain string |
success |
Domain the account is related.
Sample: ROOT |
id string |
success |
UUID of the account.
Sample: 87b1e0ce-4e01-11e4-bb66-0050569e64b8 |
name string |
success |
Name of the account.
Sample: |
network_domain string |
success |
Network domain of the account.
Sample: example.local |
state string |
success |
State of the account.
Sample: enabled |
Status
- This module is guaranteed to have no backward incompatible interface changes going forward. [stableinterface]
- This module is maintained by the Ansible Community. [community]
Authors
- René Moser (@resmo)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/cs_account_module.html