New in version 2.0.
Create, update, suspend, activate and remove projects.
- python >= 2.6
- cs >= 0.6.10
parameter | required | default | choices | comments |
---|---|---|---|---|
account |
no | Account the project is related to. | ||
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. | ||
display_text |
no | Display text of the project. If not specified, name will be used as display_text . | ||
domain |
no | Domain the project is related to. | ||
name |
yes | Name of the project. | ||
poll_async |
no | True | Poll async jobs until job has finished. | |
state |
no | present |
|
State of the project. |
# Create a project - local_action: module: cs_project name: web # Rename a project - local_action: module: cs_project name: web display_text: my web project # Suspend an existing project - local_action: module: cs_project name: web state: suspended # Activate an existing project - local_action: module: cs_project name: web state: active # Remove a project - local_action: module: cs_project name: web state: absent
Common return values are documented here Common Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
display_text | Display text of the project. | success | string | web project |
account | Account the project is related to. | success | string | example account |
state | State of the project. | success | string | Active |
name | Name of the project. | success | string | web project |
tags | List of resource tags associated with the project. | success | dict | [ { "key": "foo", "value": "bar" } ] |
domain | Domain the project is related to. | success | string | example domain |
id | UUID of the project. | success | string | 04589590-ac63-4ffc-93f5-b698b8ac38b6 |
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.
Note
This module supports check mode.
For more information on what this means please read Extras Modules
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.