New in version 2.3.
- python >= 2.6
- cs >= 0.6.10
parameter | required | default | choices | comments |
---|---|---|---|---|
api_http_method |
no | get |
|
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. | ||
description |
no | Description of the role. | ||
id |
no | ID of the role. If provided,
id is used as key.aliases: uuid | ||
name |
yes | Name of the role. | ||
role_type |
no | User |
|
Type of the role. Only considered for creation. |
state |
no | present |
|
State of the role. |
# Ensure an user role is present - local_action: module: cs_role name: myrole_user # Ensure a role having particular ID is named as myrole_user - local_action: module: cs_role name: myrole_user id: 04589590-ac63-4ffc-93f5-b698b8ac38b6 # Ensure a role is absent - local_action: module: cs_role name: myrole_user state: absent
Common return values are documented here Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
name | Name of the role. | success | string | myrole |
description | Description of the role. | success | string | This is my role description |
role_type | Type of the role. | success | string | User |
id | UUID of the role. | success | string | 04589590-ac63-4ffc-93f5-b698b8ac38b6 |
Note
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.This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is community maintained without core committer oversight.
For more information on what this means please read Module Support
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.