cloudmesh_client.api package

Module contents

This module defines the main API for operating with cloudmesh.

class cloudmesh_client.api.Cluster[source]

Bases: object

A Cluster is a collection of Node’s that need to interact

db = <cloudmesh_client.db.CloudmeshDatabase.CloudmeshDatabase object>
class cloudmesh_client.api.Config[source]

Bases: object

The Cloudmesh configuration

class cloudmesh_client.api.Layer[source]

Bases: object

db = <cloudmesh_client.db.CloudmeshDatabase.CloudmeshDatabase object>
class cloudmesh_client.api.Node[source]

Bases: object

A Node is machine running on some Provider

create_ip()[source]
db = <cloudmesh_client.db.CloudmeshDatabase.CloudmeshDatabase object>
delete()[source]
name

The name of this machine

private_ip

The private ip address of this node

public_ip

The public ip address of this node

ssh(cmd=None, user=None)[source]

ssh into and optionally run a command on this node

Parameters:
  • cmd (list(str)) – the command to run
  • user (str) – the user to login as (defaults to self.name
start(selfs)[source]
stop()[source]
username

The login username for this machine. None if unknown

class cloudmesh_client.api.Provider(cloud)[source]

Bases: object

A Provider is a collection of Resources that may be operated upon.

boot()[source]

Boots a single VM

cfg = <cloudmesh_client.common.ConfigDict.ConfigDict object>
cloud
create_ip(node)[source]

Creates and associeates a public ip with given node

Parameters:node (Node) –
Returns:
db = <cloudmesh_client.db.CloudmeshDatabase.CloudmeshDatabase object>
delete(node)[source]

Deletes a running Node

classmethod from_cloud(cloud_name)[source]
Parameters:cloud_name (str) – name of the cloud as found in cloudmesh.yaml
node()[source]

Factory method to create an instance of the appropriate subclass of Node

resources()[source]
class cloudmesh_client.api.Resource[source]

Bases: object

create()[source]
db = <cloudmesh_client.db.CloudmeshDatabase.CloudmeshDatabase object>
delete()[source]
list()[source]
refresh()[source]
class cloudmesh_client.api.Stack[source]

Bases: object

db = <cloudmesh_client.db.CloudmeshDatabase.CloudmeshDatabase object>