Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Usable as a command line tool and interactive shell
  • Management server profiles: select, customize and use different server profiles using 
  • All commands are lowercase unlike API
  • Api Discovery using sync feature, with build time api precaching for failsafe sync
  • Raw api execution support
  • Auto-completion via double <tab>
  • Reverse search using Ctrl+R
  • Emacs compatible keybindings
  • Pipeable output
  • Unix shell execution
  • Support to handle async jobs using user defined blocking or non-blocking way
  • Tabular or JSON output with filtering of table columns
  • Colored output
  • Unicode support
  • Api parameter value completion

NOTE: Version 6.x+ wiki has moved here https://github.com/apache/cloudstack-cloudmonkey/wiki, for usage see https://github.com/apache/cloudstack-cloudmonkey/wiki/Usage

Installation

Requirements

cloudmonkey 5.x requires Python 2.6 or above and has following dependencies:

...

The following configuration parameters can be configured by using the 'set' command in cloudmonkey:

Key

Purpose

Default

profileManagement server profile namelocal

url

Management server API url (it should contain full url with protocol, port etc and paths)

http://localhost:8080/client/api

timeout

Timeout interval for polling async commands

3600

apikey

User api key

""

secretkey

User secret key

""

verifysslcertEnables/Disables SSL certification verification when making HTTP calls (per server profile)true
usernameCloudStack user nameadmin
passwordCloudStack user passwordpassword

color

Enable coloured output, set to false to disable

true

prompt

cloudmonkey prompt

>

display

Line based, JSON, or tabular output, set to default or json or table

default

log_file

Log file

~/.cloudmonkey/log

history_file

History file

~/.cloudmonkey/history

asyncblock

Poll for async commands, making it false will cause cloudmonkey to return jobid

true

paramcompletion

Tries to predict api for listing a parameter value for an api, experimental may fail

true

Note: If both username/password and apikey/secretkey are set (i.e. have non-empty values), apikey and secretkey are used while making HTTP API calls.

...