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

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for cs-0.6.5.tar.gz
Algorithm Hash digest
SHA256 afe13af2d4722a7ff57c678dcb6e0c24cc2f21c1ada9f2d55e3ff3cd18fb6bb6
MD5 f455b5919c74bb3dfec918035f81b7e8
BLAKE2b-256 1b9ddd7ffe9af8cd480b7abb22c7bbbb8be92e450d653efd6cf7976e555d1b50

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cs-0.6.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 85b5009f7e2e011e72079417128cd46dff6b602bcf41902973d7357bba2d2ed0
MD5 2058a9713d28ec152a78ed37d3df6ddc
BLAKE2b-256 67d26b3c9147114c54d7348e9c58ab5983b09b513bde99b25cda51dde2c36c58

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