libcloud.common.cloudstack module

class libcloud.common.cloudstack.CloudStackConnection(user_id, key, secure=True, host=None, port=None, url=None, timeout=None, proxy_url=None, backoff=None, retry_delay=None)

Bases: ConnectionUserAndKey, PollingConnection

Initialize user_id and key; set secure to an int based on passed value.

ASYNC_FAILURE = 2

ASYNC_PENDING = 0

ASYNC_SUCCESS = 1

add_default_params(params)

Adds default parameters (such as API key, version, etc.) to the passed params

Should return a dictionary.

encode_data(data)

Must of the data is sent as part of query params (eeww), but in newer versions, userdata argument can be sent as a urlencoded data in the request body.

get_poll_request_kwargs(response, context, request_kwargs)

Return keyword arguments which are passed to the request() method when polling for the job status.

Parameters:

• response (dict) – Response object returned by poll request.

• request_kwargs – Kwargs previously used to initiate the poll request.

:return dict Keyword arguments

get_request_kwargs(action, params=None, data='', headers=None, method='GET', context=None)

Arguments which are passed to the initial request() call inside async_request.

has_completed(response)

Return job completion status.

Parameters:

response (HTTPResponse) – Response object returned by poll request.

:return bool True if the job has completed, False otherwise.

poll_interval = 1

pre_connect_hook(params, headers)

A hook which is called before connecting to the remote server. This hook can perform a final manipulation on the params, headers and url parameters.

Parameters:

• params (dict) – Request parameters.

• headers (dict) – Request headers.

request_method = '_sync_request'

responseCls

alias of CloudStackResponse

timeout: int | float | None = 600

class libcloud.common.cloudstack.CloudStackDriverMixIn(key, secret=None, secure=True, host=None, port=None)

Bases: object

connectionCls

alias of CloudStackConnection

host = None

path = None

class libcloud.common.cloudstack.CloudStackResponse(response, connection)

Bases: JsonResponse

Parameters:

• response (httplib.HTTPResponse) – HTTP response object. (optional)

• connection (Connection) – Parent connection object.

parse_error()

Parse the error messages.

Override in a provider’s subclass.

Returns:

Parsed error.

Return type:

str