Documentation

cs_account - Manages accounts on Apache CloudStack based clouds.

New in version 2.0.

Synopsis

  • Create, disable, lock, enable and remove accounts.

Options

parameter required default choices comments
account_type
no user
  • user
  • root_admin
  • domain_admin
Type of the account.
api_http_method
no get
  • get
  • post
HTTP method used.
api_key
no
API key of the CloudStack API.
api_region
no cloudstack
Name of the ini section in the cloustack.ini file.
api_secret
no
Secret key of the CloudStack API.
api_timeout
no 10
HTTP timeout.
api_url
no
URL of the CloudStack API e.g. https://cloud.example.com/client/api.
domain
no ROOT
Domain the account is related to.
email
no
Email of the user to be created if account did not exist.
Required on state=present.
first_name
no
First name of the user to be created if account did not exist.
Required on state=present.
last_name
no
Last name of the user to be created if account did not exist.
Required on state=present.
name
yes
Name of account.
network_domain
no
Network domain of the account.
password
no
Password of the user to be created if account did not exist.
Required on state=present.
poll_async
no True
Poll async jobs until job has finished.
state
no present
  • present
  • absent
  • enabled
  • disabled
  • locked
  • unlocked
State of the account.
unlocked is an alias for enabled.
timezone
no
Timezone of the user to be created if account did not exist.
username
no
Username of the user to be created if account did not exist.
Required on state=present.

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 Return Values, the following are the fields unique to this module:

name description returned type sample
domain
Domain the account is related.
success string ROOT
account_type
Type of the account.
success string user
name
Name of the account.
success string [email protected]
network_domain
Network domain of the account.
success string example.local
state
State of the account.
success string enabled
id
UUID of the account.
success string 87b1e0ce-4e01-11e4-bb66-0050569e64b8


Notes

Note

  • Ansible uses the 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.
  • A detailed guide about cloudstack modules can be found on http://docs.ansible.com/ansible/guide_cloudstack.html
  • This module supports check mode.

Status

This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.