Skip to main content

A simple yet powerful CloudStack API client for Python and the command-line.

Project description

Build Status

A simple, yet powerful CloudStack API client for python and the command-line.

  • Python 2.6+ and 3.3+ support.

  • All present and future CloudStack API calls and parameters are supported.

  • Syntax highlight in the command-line client if Pygments is installed.

  • BSD license.

Installation

pip install cs

Usage

In Python:

from cs import CloudStack

cs = CloudStack(endpoint='https://api.exoscale.ch/compute',
                key='cloudstack api key',
                secret='cloudstack api secret')

vms = cs.listVirtualMachines()

cs.createSecurityGroup(name='web', description='HTTP traffic')

>From the command-line, this requires some configuration:

cat $HOME/.cloudstack.ini
[cloudstack]
endpoint = https://api.exoscale.ch/compute
key = cloudstack api key
secret = cloudstack api secret

Then:

$ cs listVirtualMachines
{
  "count": 1,
  "virtualmachine": [
    {
      "account": "...",
      ...
    }
  ]
}

$ cs authorizeSecurityGroupIngress \
    cidrlist="0.0.0.0/0" endport=443 startport=443 \
    securitygroupname="blah blah" protocol=tcp

The command-line client polls when async results are returned. To disable polling, use the --async flag.

Configuration is read from several locations, in the following order:

  • The CLOUDSTACK_ENDPOINT, CLOUDSTACK_KEY, CLOUDSTACK_SECRET and CLOUDSTACK_METHOD environment variables,

  • A CLOUDSTACK_CONFIG environment variable pointing to an .ini file,

  • A cloudstack.ini file in the current working directory,

  • A .cloudstack.ini file in the home directory.

To use that configuration scheme from your Python code:

from cs import CloudStack, read_config

cs = CloudStack(**read_config())

Note that read_config() can raise SystemExit if no configuration is found.

CLOUDSTACK_METHOD or the method entry in the configuration file can be used to change the HTTP verb used to make CloudStack requests. By default, requests are made with the GET method but CloudStack supports POST requests. POST can be useful to overcome some length limits in the CloudStack API.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cs-0.6.6.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

cs-0.6.6-py2.py3-none-any.whl (6.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file cs-0.6.6.tar.gz.

File metadata

  • Download URL: cs-0.6.6.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for cs-0.6.6.tar.gz
Algorithm Hash digest
SHA256 4d748b30e99a6af5a6cdb7bc87b255acba4d4f4a0e07bf6be6d35337f1c31335
MD5 2d272ccb79efaa3d9ecea17972fc3c2a
BLAKE2b-256 55b24aba14868cbc420f66b5c304f8277d2302f82eb74d659beec2308669911d

See more details on using hashes here.

File details

Details for the file cs-0.6.6-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for cs-0.6.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 50467872f7c9b9acf757afa1cf4ed7310c9e419c0290202cb55669a06c770999
MD5 4bf3c540beda38660d0a2e2881e43624
BLAKE2b-256 fcd0c52c1bb4c7834daee289927ab6dddc6bd62750f9e3cc3c8d4704cfc6d845

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page