- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# cs_user – Manages users on Apache CloudStack based clouds

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- Create, update, disable, lock, enable and remove users.

## Requirements

The below requirements are needed on the host that executes this module.

- python >= 2.6
- cs >= 0.6.10

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
account string |  | Account the user will be created under. Required on state=present.
api_http_method string | Choices: get post | 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 string |  | 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 string | Default: "cloudstack" | Name of the ini section in the `cloustack.ini` file. If not given, the `CLOUDSTACK_REGION` env variable is considered.
api_secret string |  | 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 integer |  | 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 string |  | 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 string | Default: "ROOT" | Domain the user is related to.
email string |  | Email of the user. Required on state=present.
first_name string |  | First name of the user. Required on state=present.
keys_registered boolean added in 2.4 | Choices: no ← yes | If API keys of the user should be generated. Note: Keys can not be removed by the API again.
last_name string |  | Last name of the user. Required on state=present.
password string |  | 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 boolean | Choices: no yes ← | Poll async jobs until job has finished.
state string | Choices: present ← absent enabled disabled locked unlocked | State of the user. `unlocked` is an alias for `enabled`.
timezone string |  | Timezone of the user.
username string / required |  | Username of the user.

## 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 in the CloudStack Cloud Guide.
- This module supports check mode.

## Examples

    - name: Create an user in domain 'CUSTOMERS'
      cs_user:
        account: developers
        username: johndoe
        password: S3Cur3
        last_name: Doe
        first_name: John
        email: john.doe@example.com
        domain: CUSTOMERS
      delegate_to: localhost

    - name: Lock an existing user in domain 'CUSTOMERS'
      cs_user:
        username: johndoe
        domain: CUSTOMERS
        state: locked
      delegate_to: localhost

    - name: Disable an existing user in domain 'CUSTOMERS'
      cs_user:
        username: johndoe
        domain: CUSTOMERS
        state: disabled
      delegate_to: localhost

    - name: Enable/unlock an existing user in domain 'CUSTOMERS'
      cs_user:
        username: johndoe
        domain: CUSTOMERS
        state: enabled
      delegate_to: localhost

    - name: Remove an user in domain 'CUSTOMERS'
      cs_user:
        name: customer_xy
        domain: CUSTOMERS
        state: absent
      delegate_to: localhost

## Return Values

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 | Emailof the user. Sample: john.doe@example.com
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

## Status

- This module is guaranteed to have backward compatible interface changes going forward. [stableinterface]
- This module is maintained by the Ansible Community. [community]

### Authors

- René Moser (@resmo)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.