Parameter |
Choices/Defaults |
Comments |
account
|
|
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
|
|
Email of the user.
Required on state=present .
|
first_name
|
|
First name of the user.
Required on state=present .
|
keys_registered
bool
(added in 2.4) |
|
If API keys of the user should be generated.
Note: Keys can not be removed by the API again.
|
last_name
|
|
Last name of the user.
Required on state=present .
|
password
|
|
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
bool |
|
Poll async jobs until job has finished.
|
state
|
Choices:
present ←
- absent
- enabled
- disabled
- locked
- unlocked
|
State of the user.
unlocked is an alias for enabled .
|
timezone
|
|
Timezone of the user.
|
username
required |
|
Username of the user.
|