New in version 2.0.
The below requirements are needed on the host that executes this module.
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
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: ROOT
|
Domain the account is related to.
|
email
-
|
Email of the user to be created if account did not exist.
Required on
state=present . |
|
first_name
-
|
First name of the user to be created if account did not exist.
Required on
state=present . |
|
last_name
-
|
Last name of the user to be created if account did not exist.
Required on
state=present . |
|
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
state=present . |
|
poll_async
boolean
|
|
Poll async jobs until job has finished.
|
state
-
|
|
State of the account.
unlocked is an alias for enabled . |
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
state=present . |
Note
cs
library’s configuration method if credentials are not provided by the arguments api_url
, api_key
, api_secret
. Configuration is read from several locations, in the following order. The CLOUDSTACK_ENDPOINT
, CLOUDSTACK_KEY
, CLOUDSTACK_SECRET
and CLOUDSTACK_METHOD
. CLOUDSTACK_TIMEOUT
environment variables. A CLOUDSTACK_CONFIG
environment variable pointing to an .ini
file. A cloudstack.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 in cloudstack.ini
. Use the argument api_region
to select the section name, default section is cloudstack
. See https://github.com/exoscale/cs for more information.# 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: john.doe@example.com
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
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:
linus@example.com
|
network_domain
string
|
success |
Network domain of the account.
Sample:
example.local
|
state
string
|
success |
State of the account.
Sample:
enabled
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.