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

Uploaded Source

Built Distribution

cs-0.5.7-py2.py3-none-any.whl (6.5 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for cs-0.5.7.tar.gz
Algorithm Hash digest
SHA256 1a5d1ca5a27f9143ddd03ddbf3fecdb690681f62ef125a5748d1b9f8686a4ee6
MD5 fa542b83dab6d2fe7c36a1914beb2081
BLAKE2b-256 ce7687a93459584676ffed0f438a6ef10c26db0c5651ab70677598db7fba1e35

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cs-0.5.7-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 22a304779863117c448e01cec15371da2d829e35b4f15c4c11753d3bdd1d063d
MD5 a5ad3f577ccef66706cad007dc2c4ac9
BLAKE2b-256 47b1cd62221552734523093525351ac9310a7a30fb7b77d3058afee90bf08401

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