W3cubDocs

/Ansible 2.11

ngine_io.cloudstack.cs_project – Manages projects on Apache CloudStack based clouds.

Note

This plugin is part of the ngine_io.cloudstack collection (version 2.0.0).

To install it use: ansible-galaxy collection install ngine_io.cloudstack.

To use it in a playbook, specify: ngine_io.cloudstack.cs_project.

New in version 0.1.0: of ngine_io.cloudstack

Synopsis

  • Create, update, suspend, activate and remove projects.

Requirements

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

  • python >= 2.6
  • cs >= 0.9.0

Parameters

Parameter Choices/Defaults Comments
account
string
Account the project is related to.
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.
api_key
string / required
API key of the CloudStack API.
If not given, the CLOUDSTACK_KEY env variable is considered.
api_secret
string / required
Secret key of the CloudStack API.
If not set, the CLOUDSTACK_SECRET env variable is considered.
api_timeout
integer
Default:
10
HTTP timeout in seconds.
If not given, the CLOUDSTACK_TIMEOUT env variable is considered.
api_url
string / required
URL of the CloudStack API e.g. https://cloud.example.com/client/api.
If not given, the CLOUDSTACK_ENDPOINT env variable is considered.
api_verify_ssl_cert
string
Verify CA authority cert file.
If not given, the CLOUDSTACK_VERIFY env variable is considered.
display_text
string
Display text of the project.
If not specified, name will be used as display_text.
domain
string
Domain the project is related to.
name
string / required
Name of the project.
poll_async
boolean
    Choices:
  • no
  • yes ←
Poll async jobs until job has finished.
state
string
    Choices:
  • present ←
  • absent
  • active
  • suspended
State of the project.
tags
list / elements=dictionary
List of tags. Tags are a list of dictionaries having keys key and value.
If you want to delete all tags, set a empty list e.g. tags: [].

aliases: tag

Notes

Note

  • A detailed guide about cloudstack modules can be found in the CloudStack Cloud Guide.
  • This module supports check mode.

Examples

- name: Create a project
  ngine_io.cloudstack.cs_project:
    name: web
    tags:
      - { key: admin, value: john }
      - { key: foo,   value: bar }

- name: Rename a project
  ngine_io.cloudstack.cs_project:
    name: web
    display_text: my web project

- name: Suspend an existing project
  ngine_io.cloudstack.cs_project:
    name: web
    state: suspended

- name: Activate an existing project
  ngine_io.cloudstack.cs_project:
    name: web
    state: active

- name: Remove a project
  ngine_io.cloudstack.cs_project:
    name: web
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
account
string
success
Account the project is related to.

Sample:
example account
display_text
string
success
Display text of the project.

Sample:
web project
domain
string
success
Domain the project is related to.

Sample:
example domain
id
string
success
UUID of the project.

Sample:
04589590-ac63-4ffc-93f5-b698b8ac38b6
name
string
success
Name of the project.

Sample:
web project
state
string
success
State of the project.

Sample:
Active
tags
list / elements=string
success
List of resource tags associated with the project.

Sample:
[ { "key": "foo", "value": "bar" } ]


Authors

  • René Moser (@resmo)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ngine_io/cloudstack/cs_project_module.html