Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
python library for interacting with the enStratus API
branch: master

This branch is 396 commits behind enStratus:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin Fixed no attribute error in dcm-describe-job
docs
mixcoatl Added an option to disable SSL certificate verification against HTTPS…
tests adding vlanid to server test data
.gitignore
.pylintrc disabling I0011 because...wtf
.travis.yml test fixes on py26
LICENSE adding setup setup
README.rst Added an option to disable SSL certificate verification against HTTPS…
TODO.md adding todo
requirements.txt
setup.cfg
setup.py

README.rst

Read Me

Mixcoatl was the father of Quetzalcoatl. His name means "Cloud Serpent". Fitting for a Python library for the DCM API.

Build Status

https://secure.travis-ci.org/enStratus/mixcoatl.png

Word of warning

This repository is not feature complete in that not all operations are supported. At this point read access to all resources documented in the API doc are working.

Usage notes

The following environment variables will need to be set:

  • ES_SECRET_KEY
  • ES_ACCESS_KEY

By default, API calls will be made against the DCM production SaaS and API version 2012-06-15. These can be overridden with the following variables:

  • ES_ENDPOINT
  • ES_API_VERSION

When overriding the endpoint, it should be in the form:

http[s]://api.endpoint.domain/api/enstratus/<api version>

Note that setting both ES_API_VERSION and ES_ENDPOINT is not cumulative. If you wish to use a private endpoint, it must include the version in the URL.

  • ES_SSL_VERIFY

By default, SSL certificate verification is required against HTTPS endpoint. To disable the verfication in case you use a self-signed certificate, set the value to 0. For example, ES_SSL_VERIFY=0

dcm-get

mixcoatl also ships with a small script for querying arbitrary objects via the DCM API called dcm-get. It's very minimal and only dumps the JSON results of your query:

example:

dcm-get admin/Job
{
  "jobs": []
}

It can also accept query parameters in the form of a python dictionary (the same format the requests library uses:

dcm-get geography/DataCenter "{'regionId':19344}"
{
  "dataCenters": [
    {
      "dataCenterId": 64351,
      "description": "us-west-2a",
      "name": "us-west-2a",
      "providerId": "us-west-2a",
      "region": {
        "cloud": {
          "cloudId": 1
        },
        "customer": {
          "customerId": 14334
        },
        "description": "AWS Western United States (2)",
        "jurisdiction": "US",
        "name": "Oregon (us-west-2)",
        "providerId": "us-west-2",
        "regionId": 19344,
        "status": "ACTIVE"
      },
      "status": "ACTIVE"
    }
  ]
}

You'll need to set the environment variables as described above obviously.

Lazy loading

By default, any object you request by its id will not actually hit the endpoint. Only when you request the object in full or a specific attribute, will it actually make the API call. If the API call fails, the error will be returned to you. You can always check the object's last_error attribute to determine if it failed or not.

example:

>>> from mixcoatl.geography.cloud import Cloud
>>> c = Cloud(1)
>>> # returns immediately
>>> c.cloud_id
1
>>> c.name
>>> # api call is made.
u'Amazon Web Services'

.all()

All objects should support a call to return all resources of that type. This will actually return a list of objects. Note that calling .all() actually deferences the objects so an API call will be made for each object:

example:

>>> from mixcoatl.geography.cloud import Cloud
>>> c = Cloud.all()
>>> # Initial call made for all Clouds
>>> c
>>> # Delay while each cloud object is dereferenced
>>> c[0]
{'status': 'ACTIVE', 'current_job': None, 'last_request': '<Response [200]>', 'name': 'Amazon Web Services', 'last_error': None, 'cloud_provider_name': 'Amazon', 'cloud_provider_console_url': 'http://aws.amazon.com', 'cloud_provider_logo_url': '/clouds/aws.gif', 'compute_endpoint': 'https://ec2.us-east-1.amazonaws.com,https://ec2.us-west-1.amazonaws.com,https://ec2.eu-west-1.amazonaws.com', 'compute_secret_key_label': 'AWS_SECRET_ACCESS_KEY', 'documentation_label': None, 'compute_delegate': 'org.dasein.cloud.aws.AWSCloud', 'path': 'geography/Cloud/1', 'compute_account_number_label': 'AWS_ACCOUNT_NUMBER', 'private_cloud': False}
>>> type(c[0])
mixcoatl.geography.cloud.Cloud
>>> c[0].__class__.__name__
'Cloud'

Pretty-printing

Every resource has a .pprint() function available which returns the 'prettyprinted' object

example:

>>> from mixcoatl.geography.cloud import Cloud
>>> c = Cloud(1)
>>> c
>>> c.pprint()
>>> # pretty print representation

Other notes

In general, most resources should support read-only access. If you know the id of an resource, you can simply request the resource by name with the id as a parameter:

>>> from mixcoatl.infrastructure.server import Server
>>> s = Server(12345)
>>> s

Importing resources generally follows the API directly i.e.:

>>> from mixcoatl.scope.resource import ResourceName

For Firewalls

>>> from mixcoatl.network.firewall import Firewall
>>> f = Firewall(12345)
>>> f

For Servers

>>> from mixcoatl.infrastucture.server import Server
>>> s = Server(12345)
>>> s

Further Reading

For specific examples per resource, see the wiki or the documentation

Something went wrong with that request. Please try again.