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'])