Cloudforms API v2 Python Client’s documentation!¶

This is the documentation for the community-supported Red Hat Cloudforms (ManageIQ) API v2 Python client.

Contents:

API Documentation¶

Available managers:

Cloudforms.ProviderManager¶

Provider Manager

license:	MIT, see LICENSE for more details.

class Cloudforms.managers.provider.ProviderManager(client)[source]¶

Manages Providers.

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

Example:

import Cloudforms
client = Cloudforms.Client()
provider_mgr = Cloudforms.ProviderManager(client)

create(params=None)[source]¶

Creates a new provider on the account (pass-through params)

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

Example:

# Creates a new provider using pass-through params
provider = provider_mgr.create({
    'type': 'EmsRedhat',
    'name': 'rhevm101',
    'hostname': 'rhevm101',
    'ipaddress': '127.0.0.1',
    'credentials': {
        'userid': 'admin',
        'password': 'smartvm'
    }
})
# Refresh the provider
provider_mgr.refresh(provider['id'])

create_amazon(name, region, access_key, secret_key, params=None)[source]¶

Creates a new Amazon (AWS) provider on the account

Parameters:	string (secret_key) – Display name of the provider string – AWS region (ex. us-east-1) string – AWS API Access Key ID string – AWS API Access Secret Key params (dict) – Additional POST request data
Returns:	Provider dictionary object

Example:

# Creates a new Amazon (AWS) provider
provider = provider_mgr.create_amazon(
    name='MyAWSProvider',
    region='us-east-1',
    access_key='MY4CC3SSK3Y',
    secret_key='My$Freak1shly/L0ng=S3cr3t&K3y'
)
# Refresh the provider
provider_mgr.refresh(provider['id'])

delete(_id, params=None)[source]¶

Sends a request to delete a provider

Parameters:	_id (string) – Specifies which provider the request is for params (dict) – Additional POST request data
Returns:	Task request dictionary (see TaskManager)

Example:

# Gets a list of all providers
for provider in provider_mgr.list():
    # Send requests to delete all providers
    task = provider_mgr.delete(provider['id'])
    # Wait for the request to be processed
    task_mgr.wait_for_task(task.get('task_id'))

get(_id, params=None)[source]¶

Retrieve details about a provider on the account

Parameters:	_id (string) – Specifies which provider the request is for params (dict) – response-level options (attributes, limit, etc.)
Returns:	Dictionary representing the matching provider

Example:

# Gets a list of all providers (returns IDs only)
providers = provider_mgr.list({'attributes': 'id'})
for provider in providers:
    provider_details = provider_mgr.get(provider['id'])

list(params=None)[source]¶

Retrieve a list of all providers on the account

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

Example:

# Gets a list of all providers (returns IDs only)
providers = provider_mgr.list({'attributes': 'id'})

perform_action(_id, action, params=None)[source]¶

Sends a request to perform an action on a provider

Parameters:	_id (string) – Specifies which provider the request is for action (string) – The action to request (delete, refresh, etc.) params (dict) – Additional POST request data
Returns:	Task request, or Provider, dictionary object

Example:

# Gets a list of all providers
for provider in provider_mgr.list():
    # Send requests to refresh all providers
    provider_mgr.perform_action(provider['id'], 'refresh')

refresh(_id, params=None)[source]¶

Sends a request to refresh a provider

Parameters:	_id (string) – Specifies which provider the request is for params (dict) – Additional POST request data
Returns:	JSON object with a ‘success’ key

Example:

# Gets a list of all providers
for provider in provider_mgr.list():
    # Send requests to refresh all providers
    res = provider_mgr.refresh(provider['id'])
    if not res or not res.get('success'):
        raise RuntimeError('An error occurred')

update(_id, params=None)[source]¶

Sends a request to update a provider

Parameters:	_id (string) – Specifies which provider the request is for params (dict) – Additional POST request data
Returns:	Provider dictionary object (with updates applied)

Example:

# Gets a list of all providers
for provider in provider_mgr.list():
    # Send requests to update all providers
    provider_mgr.update(
        provider['id'],
        params={
            'credentials': [{
                'userid': 'metrics_userid',
                'password': 'metrics_password',
                'auth_type': 'metrics'
            }]
        }
    )

Cloudforms.ProvisionRequestManager¶

Provision Request Manager

license:	MIT, see LICENSE for more details.

class Cloudforms.managers.provision_request.ProvisionRequestManager(client)[source]¶

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)[source]¶

Creates a new provision request on the account

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

get(_id, params=None)[source]¶

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)[source]¶

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)[source]¶

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)[source]¶

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

Cloudforms.TagManager¶

Tag Manager

license:	MIT, see LICENSE for more details.

class Cloudforms.managers.tag.ServiceTagManager(client, svc)[source]¶

Manages Tags for Services.

Parameters:	client (Cloudforms.API.Client) – an API client instance svc (string) – a service name to bind to

assign(_id, names)[source]¶

Assigns one or more tags to a service

Parameters:	_id (string) – Specifies which service item the request is for names (list) – Names of tags to assign ([‘/my/tag’, ‘/a/tag’])

Example:

# Add the tag /environment/prod to all providers
for prov in prov_mgr.list_providers():
    prov_mgr.tags.assign(prov.get('id'), [
        '/environment/prod'
    ])

unassign(_id, names)[source]¶

Un-assigns one or more tags to a service

Parameters:	_id (string) – Specifies which service item the request is for names (list) – Names of tags to un-assign ([‘/my/tag’, ‘/a/tag’])

Example:

# Removes the tag /environment/prod from all providers
for prov in prov_mgr.list_providers():
    prov_mgr.tags.unassign(prov.get('id'), [
        '/environment/prod'
    ])

class Cloudforms.managers.tag.TagManager(client)[source]¶

Manages Tags.

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

Example:

import Cloudforms
client = Cloudforms.Client()
tag_mgr = Cloudforms.TagManager(client)

get(_id, params=None)[source]¶

Retrieve details about a tag on the account

Parameters:	_id (string) – Specifies which tag the request is for params (dict) – response-level options (attributes, limit, etc.)
Returns:	Dictionary representing the matching tag

Example:

# Gets a list of all tags (returns IDs only)
tags = tag_mgr.list({'attributes': 'id'})
for tag in tags:
    tag_details = tag_mgr.get(tag['id'])

list(params=None)[source]¶

Retrieve a list of all tags on the account

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

Example:

# Gets a list of all tags (returns IDs only)
tags = tag_mgr.list({'attributes': 'id'})

Cloudforms.TaskManager¶

Task Manager

license:	MIT, see LICENSE for more details.

class Cloudforms.managers.task.TaskManager(client)[source]¶

Manages Tasks.

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

Example:

import Cloudforms
client = Cloudforms.Client()
task_mgr = Cloudforms.TaskManager(client)

get(_id, params=None)[source]¶

Retrieve details about a task on the account

Parameters:	_id (string) – Specifies which task the request is for params (dict) – response-level options (attributes, limit, etc.)
Returns:	Dictionary representing the matching task

Example:

# Gets a list of all tasks (returns IDs only)
tasks = task_mgr.list({'attributes': 'id'})
for task in tasks:
    task_details = task_mgr.get(task['id'])

list(params=None)[source]¶

Retrieve a list of all tasks on the account

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

Example:

# Gets a list of all tasks (returns IDs only)
tasks = task_mgr.list({'attributes': 'id'})

wait(_id, timeout=30, state='finished', params=None)[source]¶

Waits for a task to reach a certain state

Parameters:	state (string) – wait until the task reaches this 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

Example:

# Gets a list of all virtual servers
vms = vs_mgr.list()
for vm in vms:
    # Send a request to stop the virtual server
    task = vs_mgr.stop(vms.get('id'))
    # Wait for the task to finish and collect the result
    task_succeeded = task_mgr.wait(task.get('task_id'))

Cloudforms.VSManager¶

VS Manager (abstracts virtual machines and cloud instances)

license:	MIT, see LICENSE for more details.

class Cloudforms.managers.vs.VSManager(client)[source]¶

Manages Virtual Servers.

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

Example:

import Cloudforms
client = Cloudforms.Client()
vs_mgr = Cloudforms.VSManager(client)

delete(_id, params=None)[source]¶

Sends a request to delete a virtual server

Parameters:	_id (string) – Specifies which virtual server the request is for params (dict) – Additional POST request data
Returns:	Task request dictionary (see TaskManager)

Example:

# Gets a list of all virtual server instances
for vsi in vs_mgr.list():
    # Send requests to delete all virtual server instances
    vs_mgr.delete(vsi['id'])

get(_id, params=None)[source]¶

Retrieve details about a virtual server on the account

Parameters:	_id (string) – Specifies which virtual server the request is for params (dict) – response-level options (attributes, limit, etc.)
Returns:	Dictionary representing the matching virtual server

Example:

# Gets a list of all virtual server instances (returns IDs only)
instances = vs_mgr.list({'attributes': 'id'})
for instance in instances:
    vs_details = vs_mgr.get(instance['id'])

list(params=None)[source]¶

Retrieve a list of all virtual servers on the account

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

Example:

# Gets a list of all virtual server instances (returns IDs only)
instances = vs_mgr.list({'attributes': 'id'})

perform_action(_id, action, params=None)[source]¶

Sends a request to perform an action on a virtual server

Parameters:	_id (string) – Specifies which virtual server the request is for action (string) – The action to request (start, stop, suspend) params (dict) – Additional POST request data
Returns:	Task request dictionary (see TaskManager)

Example:

# Gets a list of all virtual server instances
for vsi in vs_mgr.list():
    # Send requests to start all virtual server instances
    vs_mgr.perform_action(vsi['id'], 'start')

start(_id, params=None)[source]¶

Sends a request to start a virtual server

Parameters:	_id (string) – Specifies which virtual server the request is for params (dict) – Additional POST request data
Returns:	Task request dictionary (see TaskManager)

Example:

# Gets a list of all virtual server instances
for vsi in vs_mgr.list():
    # Send requests to start all virtual server instances
    vs_mgr.start(vsi['id'])

stop(_id, params=None)[source]¶

Sends a request to stop a virtual server

Parameters:	_id (string) – Specifies which virtual server the request is for params (dict) – Additional POST request data
Returns:	Task request dictionary (see TaskManager)

Example:

# Gets a list of all virtual server instances
for vsi in vs_mgr.list():
    # Send requests to stop all virtual server instances
    vs_mgr.stop(vsi['id'])

suspend(_id, params=None)[source]¶

Sends a request to suspend a virtual server

Parameters:	_id (string) – Specifies which virtual server the request is for params (dict) – Additional POST request data
Returns:	Task request dictionary (see TaskManager)

Example:

# Gets a list of all virtual server instances
for vsi in vs_mgr.list():
    # Send requests to suspend all virtual server instances
    vs_mgr.suspend(vsi['id'])

Examples¶

List all virtual servers for the account:

from Cloudforms import (
    Client,
    VSManager
)

client = Client(
    username='admin',
    password='smartvm',
    host='127.0.0.1'
)
vs_mgr = VSManager(client)
instances = vs_mgr.list()
for instance in instances:
    print 'Server #%s: %s (%s)' % (
        instance.get('id'),
        instance.get('name'),
        instance.get('raw_power_state')
    )

Cloudforms API v2 Python Client’s documentation!¶

API Documentation¶

Cloudforms.ProviderManager¶

Cloudforms.ProvisionRequestManager¶

Cloudforms.TagManager¶

Cloudforms.TaskManager¶

Cloudforms.VSManager¶

Examples¶

External Links¶