Parameter |
Choices/Defaults |
Comments |
account_type
|
Choices:
user ←
- root_admin
- domain_admin
|
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
bool |
|
Poll async jobs until job has finished.
|
state
|
Choices:
present ←
- absent
- enabled
- disabled
- locked
- unlocked
|
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 .
|