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.3.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for cs-0.6.3.tar.gz
Algorithm Hash digest
SHA256 da6837f190dff94c7e9e17903f4c1920fbc581ecc2698853781bbe4b756690c7
MD5 9f15579444b1593d37b26ce653c78577
BLAKE2b-256 aa78cb476ead986b2504f86c629de416bd84140079c428079a14d45b7198bf75

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cs-0.6.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 eb118d437dadb535c17c7c3faa53ded40cfe4498cf065c88e9e20b40a20885f6
MD5 d4f0fc196f981a4ac2ab3b5b516539eb
BLAKE2b-256 e66ca1002cb926058a858fac7b739f189aee8bca7ab4b495d97a2b9dfc350bdf

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