Cloudforms.ProvisionRequestManager

Provision Request Manager

license:MIT, see LICENSE for more details.

class Cloudforms.managers.provision_request.ProvisionRequestManager(client)

Manages Provision Requests.

Parameters:client (Cloudforms.API.Client) – an API client instance

Example:

import Cloudforms
client = Cloudforms.Client()
preq_mgr = Cloudforms.ProvisionRequestManager(client)

create(params=None)

Creates a new provision request on the account

Parameters:params (dict) – Additional POST request data Returns:ProvisionRequest dictionary object

get(_id, params=None)

Retrieve details about a provision request on the account

Parameters:

• _id (string) – Specifies which provision request the request is for
• params (dict) – response-level options (attributes, limit, etc.)

Returns:

Dictionary representing the matching provision request

Example:

# Gets a list of all provision requests (returns IDs only)
preqs = preq_mgr.list({'attributes': 'id'})
for preq in preqs:
    preq_details = preq_mgr.get(preq['id'])

list(params=None)

Retrieve a list of all provision requests on the account

Parameters:params (dict) – response-level options (attributes, limit, etc.) Returns:List of dictionaries representing the matching provision requests

Example:

# Gets a list of all provision requests (returns IDs only)
preqs = preq_mgr.list({'attributes': 'id'})

perform_action(_id, action, params=None)

Sends a request to perform an action on a provision request

Parameters:

• _id (string) – Specifies which provision request the request is for
• action (string) – The action to request (delete, refresh, etc.)
• params (dict) – Additional POST request data

Returns:

ProvisionRequest dictionary object

wait(_id, timeout=30, request_state='finished', params=None)

Waits for a provision request to reach a certain request_state

Parameters:

• request_state (string) – wait until the provision request reaches this request_state (case insensitive)
• timeout (integer) – operation timeout (in seconds)
• params (dict) – response-level options (attributes, limit, etc.)

Returns bool:

True on success, False on error or timeout