ngine_io.cloudstack.api_request module – Executes ad-hoc Apache CloudStack API requests.

Note

This module is part of the ngine_io.cloudstack collection (version 3.3.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install ngine_io.cloudstack. You need further requirements to be able to use this module, see Requirements for details.

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

New in ngine_io.cloudstack 3.1.0

Synopsis

  • Executes ad-hoc CloudStack API requests.

  • This is a command-style module and is never idempotent.

  • Request parameters can be provided either as free-form key=value pairs after the command name or as a params dictionary.

Note

This module has a corresponding action plugin.

Requirements

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

  • python >= 2.6

  • cs >= 0.9.0

Parameters

Parameter

Comments

api_http_method

string

HTTP method used to query the API endpoint.

If not given, the CLOUDSTACK_METHOD env variable is considered.

Choices:

  • "get" ← (default)

  • "post"

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

HTTP timeout in seconds.

If not given, the CLOUDSTACK_TIMEOUT env variable is considered.

Default: 10

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.

command

string

API command to execute, for example listVirtualMachines or listCapabilities.

Optional when using the free-form syntax, where the first token is used as the command name.

free_form

string

API command followed by optional key=value request parameters.

There is no actual parameter named free_form.

Example: listVPCs keyword=my-vpc listall=true.

params

aliases: query_params

dictionary

Arbitrary API parameters passed to the command.

Explicit params values override free-form key=value pairs with the same key.

validate_certs

boolean

added in ngine_io.cloudstack 2.4.0

If false, SSL certificates will not be validated.

If not given, the CLOUDSTACK_DANGEROUS_NO_TLS_VERIFY env variable is considered.

This should only be used on personally controlled sites using self-signed certificates.

Choices:

  • false

  • true ← (default)

Notes

Note

  • This module is not idempotent, nor supports check mode. This means, idempotency must be manually handled in your playbooks.

  • It always reports changed=true when a request is executed successfully.

  • Free-form tokens after the command must be written as key=value.

  • A detailed guide about cloudstack modules can be found in the CloudStack Cloud Guide.

  • This module supports check mode.

Examples

- name: Execute an API request with free-form parameters
  ngine_io.cloudstack.api_request: listVPCs keyword=my-vpc listall=true
  register: api_result

- name: Execute an API request with structured parameters
  ngine_io.cloudstack.api_request:
    command: listCapabilities
  register: api_result

- name: Execute an API request with explicit parameters
  ngine_io.cloudstack.api_request:
    command: listVirtualMachines
    params:
      keyword: my-vm
      listall: true
  register: api_result

Return Values

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

Key

Description

command

string

API command that was executed.

Returned: success

Sample: "listCapabilities"

params

dictionary

Effective API parameters sent with the request.

Returned: success

Sample: {"keyword": "my-vm", "listall": true}

response

any

Raw CloudStack API response.

Returned: success

Authors

  • René Moser (@resmo)