ansible / ansible.builtin / v2.9.18 / module / cs_user Manages users on Apache CloudStack based clouds. | "added in version" 2.0 of ansible.builtin" Authors: René Moser (@resmo) stableinterface | supported by communityansible.builtin.cs_user (v2.9.18) — module
pip
Install with pip install ansible==2.9.18
Create, update, disable, lock, enable and remove users.
- 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
email: description: - Email of the user. - Required on I(state=present). type: str state: choices: - present - absent - enabled - disabled - locked - unlocked default: present description: - State of the user. - C(unlocked) is an alias for C(enabled). type: str domain: default: ROOT description: - Domain the user is related to. type: str account: description: - Account the user will be created under. - Required on I(state=present). type: str api_key: description: - API key of the CloudStack API. - If not given, the C(CLOUDSTACK_KEY) env variable is considered. required: true type: str api_url: description: - URL of the CloudStack API e.g. https://cloud.example.com/client/api. - If not given, the C(CLOUDSTACK_ENDPOINT) env variable is considered. required: true type: str password: description: - Password of the user to be created. - Required on I(state=present). - Only considered on creation and will not be updated if user exists. type: str timezone: description: - Timezone of the user. type: str username: description: - Username of the user. required: true type: str last_name: description: - Last name of the user. - Required on I(state=present). type: str api_secret: description: - Secret key of the CloudStack API. - If not set, the C(CLOUDSTACK_SECRET) env variable is considered. required: true type: str first_name: description: - First name of the user. - Required on I(state=present). type: str poll_async: default: true description: - Poll async jobs until job has finished. type: bool api_timeout: default: 10 description: - HTTP timeout in seconds. - If not given, the C(CLOUDSTACK_TIMEOUT) env variable is considered. type: int api_http_method: choices: - get - post default: get description: - HTTP method used to query the API endpoint. - If not given, the C(CLOUDSTACK_METHOD) env variable is considered. type: str keys_registered: default: false description: - If API keys of the user should be generated. - 'Note: Keys can not be removed by the API again.' type: bool version_added: '2.4' version_added_collection: ansible.builtin api_verify_ssl_cert: description: - Verify CA authority cert file. - If not given, the C(CLOUDSTACK_VERIFY) env variable is considered. type: str
account: description: Account name of the user. returned: success sample: developers type: str account_type: description: Type of the account. returned: success sample: user type: str created: description: Date the user was created. returned: success sample: Doe type: str domain: description: Domain the user is related. returned: success sample: ROOT type: str email: description: Emailof the user. returned: success sample: john.doe@example.com type: str fist_name: description: First name of the user. returned: success sample: John type: str id: description: UUID of the user. returned: success sample: 87b1e0ce-4e01-11e4-bb66-0050569e64b8 type: str last_name: description: Last name of the user. returned: success sample: Doe type: str state: description: State of the user. returned: success sample: enabled type: str timezone: description: Timezone of the user. returned: success sample: enabled type: str user_api_key: description: API key of the user. returned: success sample: JLhcg8VWi8DoFqL2sSLZMXmGojcLnFrOBTipvBHJjySODcV4mCOo29W2duzPv5cALaZnXj5QxDx3xQfaQt3DKg type: str user_api_secret: description: API secret of the user. returned: success sample: FUELo3LB9fa1UopjTLPdqLv_6OXQMJZv9g9N4B_Ao3HFz8d6IGFCV9MbPFNM8mwz00wbMevja1DoUNDvI8C9-g type: str username: description: Username of the user. returned: success sample: johndoe type: str