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.7+ 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 and CLOUDSTACK_SECRET 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.

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

Uploaded Source

Built Distribution

cs-0.5.5-py2.py3-none-any.whl (6.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for cs-0.5.5.tar.gz
Algorithm Hash digest
SHA256 db46a6ddfdda4d4bc529959b78faa3c0d3b2844d6b1aa934d3e5bff1709e19f9
MD5 4cdfd97757c7574d7a78362a6c2b119e
BLAKE2b-256 156b0d8437c0517fdcbc46a17c284cff60be69e7be57ae12e37db0f8b77a26e5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cs-0.5.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ca4239a86339fce099701a45ca0fc1bd1c0bbeac27d141a38259e377bcc1c90d
MD5 b2ac8c467152bb59bc1db4bb45112e2f
BLAKE2b-256 6e8c44089677d364bc8df4928c4d2befc3bf7f2502be127c4f75f899f01a75a8

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