New in version 2.0.
The below requirements are needed on the host that executes this module.
Parameter |
Choices/Defaults |
Comments |
---|---|---|
account
|
Default:
None
|
Account the user will be created under.
Required on
state=present . |
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 user is related to.
|
email
|
Default:
None
|
Email of the user.
Required on
state=present . |
first_name
|
Default:
None
|
First name of the user.
Required on
state=present . |
keys_registered
(added in 2.4) |
Default:
None
|
If API keys of the user should be generated.
Note: Keys can not be removed by the API again.
|
last_name
|
Default:
None
|
Last name of the user.
Required on
state=present . |
password
|
Default:
None
|
Password of the user to be created.
Required on
state=present .Only considered on creation and will not be updated if user exists.
|
poll_async
|
Default:
yes
|
Poll async jobs until job has finished.
|
state
|
|
State of the user.
unlocked is an alias for enabled . |
timezone
|
Default:
None
|
Timezone of the user.
|
username
required |
|
Username of the user.
|
Note
# create an user in domain 'CUSTOMERS'
- local_action:
module: cs_user
account: developers
username: johndoe
password: S3Cur3
last_name: Doe
first_name: John
email: [email protected]
domain: CUSTOMERS
# Lock an existing user in domain 'CUSTOMERS'
- local_action:
module: cs_user
username: johndoe
domain: CUSTOMERS
state: locked
# Disable an existing user in domain 'CUSTOMERS'
- local_action:
module: cs_user
username: johndoe
domain: CUSTOMERS
state: disabled
# Enable/unlock an existing user in domain 'CUSTOMERS'
- local_action:
module: cs_user
username: johndoe
domain: CUSTOMERS
state: enabled
# Remove an user in domain 'CUSTOMERS'
- local_action:
module: cs_user
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
string
|
success |
Account name of the user.
Sample:
developers
|
account_type
string
|
success |
Type of the account.
Sample:
user
|
created
string
|
success |
Date the user was created.
Sample:
Doe
|
domain
string
|
success |
Domain the user is related.
Sample:
ROOT
|
email
string
|
success |
|
fist_name
string
|
success |
First name of the user.
Sample:
John
|
id
string
|
success |
UUID of the user.
Sample:
87b1e0ce-4e01-11e4-bb66-0050569e64b8
|
last_name
string
|
success |
Last name of the user.
Sample:
Doe
|
state
string
|
success |
State of the user.
Sample:
enabled
|
timezone
string
|
success |
Timezone of the user.
Sample:
enabled
|
user_api_key
string
|
success |
API key of the user.
Sample:
JLhcg8VWi8DoFqL2sSLZMXmGojcLnFrOBTipvBHJjySODcV4mCOo29W2duzPv5cALaZnXj5QxDx3xQfaQt3DKg
|
user_api_secret
string
|
success |
API secret of the user.
Sample:
FUELo3LB9fa1UopjTLPdqLv_6OXQMJZv9g9N4B_Ao3HFz8d6IGFCV9MbPFNM8mwz00wbMevja1DoUNDvI8C9-g
|
username
string
|
success |
Username of the user.
Sample:
johndoe
|
This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.
Hint
If you notice any issues in this documentation you can edit this document to improve it.