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

Uploaded Source

Built Distribution

cs-0.5.1-py2.py3-none-any.whl (6.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for cs-0.5.1.tar.gz
Algorithm Hash digest
SHA256 a27d08d764630d91658bc28185d130a4904f7c05be8b6ab9c40aee922d2f5479
MD5 3747d7a8de826da5777530799c35c9df
BLAKE2b-256 d4fc781ea5f3cc8d9c1975a0384186caa0542e178bdaa7e0b6a45a4546db1c34

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cs-0.5.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 466ad36b5dad4a6a6b27ac403343f52382a720115b9f74be73479500ca332d34
MD5 c70142dbca73ed5b5e22216e8de13c19
BLAKE2b-256 617af26a0a3f45bb1fd47cc3628d20ae2711ae6b3f4e88a0a9e3b711a97c9b61

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