A library and command line interface for cloudscale.ch
Project description
Cloudscale
A cloudscale.ch API client for Python3 and your command line.
Install / Update
pip3 install -U cloudscale --user
export PATH=$PATH:$HOME/.local/bin
cloudscale-cli version
Command Line Interface
Autocompletion
zsh:
eval "$(_CLOUDSCALE_CLI_COMPLETE=source_zsh cloudscale-cli)"
bash:
eval "$(_CLOUDSCALE_CLI_COMPLETE=source cloudscale-cli)"
Authentication
Evironment variable
Using the ENV CLOUDSCALE_API_TOKEN
variable:
export CLOUDSCALE_API_TOKEN=<your token>
cloudscale-cli flavor list
Command line argument
Passing the --api-token
parameter:
cloudscale-cli server --api-token <your_token> create ...
Config file
Creating an ini file .cloudscale.ini
(leading dot) in your $HOME
or a cloudscale.ini
(without leading dot) in the CWD
with the following schema:
[default]
api_token = <token>
The default profile taken if available is default
. The profile can be chosen by passing --profile
or CLOUDSCALE_PROFILE
ENV variable.
export CLOUDSCALE_PROFILE=staging
[production]
api_token = <token>
[staging]
api_token = <token>
Passing the command line option will overwrite the ENV var as one would expect:
cloudscale-cli server --profile production list
Help
See all options:
$ cloudscale-cli
Usage: cloudscale-cli [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
Commands:
flavor
floating-ip
image
network
objects-user
region
server
server-group
subnet
version
volume
Usage Examples
Create a server
cloudscale-cli server create --flavor flex-2 --name my-server --image centos-7 --ssh-key "$(cat ~/.ssh/id_rsa.pub)"
List all servers
cloudscale-cli server list
List servers having the tag project with value gemini
cloudscale-cli server list --filter-tag project=gemini
List servers having a tag project
cloudscale-cli server list --filter-tag project
Update servers tags (but keep all existing)
cloudscale-cli server update <uuid> --tag project=apollo --tag stage=prod
Update server tags, remove a specific tag key
cloudscale-cli server update <uuid> --tag project=apollo --tag stage=prod --clear-tag status
Update server tags, remove other tags
cloudscale-cli server update <uuid> --tag project=apollo --tag stage=prod --clear-all-tags
Stop a server
cloudscale-cli server stop <uuid>
Start a server
cloudscale-cli server start <uuid>
Usage in Python
List the slug of all flavors
import os
from cloudscale import Cloudscale, CloudscaleApiException
api_token = os.getenv('CLOUDSCALE_API_TOKEN')
cloudscale = Cloudscale(api_token=api_token)
flavors = cloudscale.flavor.get_all()
for flavor in flavors:
print(flavor['slug'])
Print the server names of running servers
import os
from cloudscale import Cloudscale, CloudscaleApiException
api_token = os.getenv('CLOUDSCALE_API_TOKEN')
cloudscale = Cloudscale(api_token=api_token)
servers = cloudscale.server.get_all()
for server in servers:
if server['status'] == "running":
print(server['name'])
Print the server names of all servers having a specifc tag project
import os
from cloudscale import Cloudscale, CloudscaleApiException
api_token = os.getenv('CLOUDSCALE_API_TOKEN')
cloudscale = Cloudscale(api_token=api_token)
servers = cloudscale.server.get_all(filter_tag='project')
for server in servers:
print(server['name'])
Print the server names of all servers having a specifc tag project with value apollo
import os
from cloudscale import Cloudscale, CloudscaleApiException
api_token = os.getenv('CLOUDSCALE_API_TOKEN')
cloudscale = Cloudscale(api_token=api_token)
servers = cloudscale.server.get_all(filter_tag='project=apollo')
for server in servers:
print(server['name'])
Get resource by UUID
import os
from cloudscale import Cloudscale, CloudscaleApiException
api_token = os.getenv('CLOUDSCALE_API_TOKEN')
try:
cloudscale = Cloudscale(api_token=api_token)
server_group = cloudscale.server_group.get_by_uuid(uuid="5a1e5b28-d354-47a8-bfb2-01b048c20204")
print(server_group['name'])
except CloudscaleApiException as e:
print(e)
Error handling
import os
from cloudscale import Cloudscale, CloudscaleApiException
api_token = os.getenv('CLOUDSCALE_API_TOKEN')
try:
cloudscale = Cloudscale(api_token=api_token)
server = cloudscale.server.get_by_uuid(uuid="does-not-exist")
print(server['name'])
except CloudscaleApiException as e:
# Prints "API Response Error (404): Not found."
print(e)
# Prints "404"
print(e.status_code)
# Prints raw API response
print(e.response)
Development
Run tests with coverage
tox -e coverage
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
cloudscale-0.12.1.tar.gz
(20.5 kB
view hashes)
Built Distribution
Close
Hashes for cloudscale-0.12.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4a1dec8a26b26a4c8b6c91cbbd0cf066ca4acc0f26aac89ac61774ded29a059c |
|
MD5 | 9f64184e80698e13aea197172cc487f9 |
|
BLAKE2b-256 | afbc721bc21b7d07d1d0fb31fa8c1849ff9c92351754361a831e66b254029436 |