README.md in cloudstack-cli-0.0.3 vs README.md in cloudstack-cli-0.0.4
- old
+ new
@@ -2,20 +2,12 @@
Cloudstack CLI gives command line access to the CloudStack API commands.
## Installation
-Add this line to your application's Gemfile:
+Install the cloudstack-cli gem:
- gem "cloudstack-cli"
-
-And then execute:
-
- $ bundle
-
-Or install it yourself as:
-
$ gem install cloudstack-cli
## Setup
Create the initial configuration:
@@ -30,25 +22,58 @@
:api_key: "cloudstack-api-key"
:secret_key: "cloudstack-api-secret"
## Usage
-See the help screen
+See the help screen:
- $ bin/cs
+ $ cs
-Example: Bootsrap a server
+### Example 1
- $ bin/cs server create delete-me-10 --zone ZUERICH_IX --port-forwarding 146.159.95.194:22 146.159.95.194:80 --template CentOS-6.4-x64-v1.2 --offering demo_1cpu_1gb --networks M_ZRH_NMC-Demo
+Bootsrap a server:
-Example: Run a custom API command
+ $ cs server create server01 --zone ZUERICH_IX --port-forwarding 193.218.104.10:22 193.218.104.10:80 --template CentOS-6.4-x64-v1.4 --offering 1cpu_1gb --networks M_Demo
- bin/cs command listAlerts type=8
+### Example 2
+Run a custom API command:
+ cs command listAlerts type=8
+
+### Example 3
+
+Sort all computing offerings by CPU and Memory grouped my Domain:
+
+ cs offering sort
+
+### Example 4
+
+Stop all virtual routers of project Demo (you could filter by Zone too):
+(This command is helpful if you have to deploy new versions of Cloudstack when using redumdant routers)
+
+ cs router list --project Demo --status running --redundant-state BACKUP --command stop
+
+Hint: You can watch the status of the command with watch.
+
+ watch -n cs router list --project Demo
+
+
+## References
+- [Cloudstack API documentation](http://cloudstack.apache.org/docs/api/apidocs-4.1/TOC_Root_Admin.html)
+- This tool was inspired by the Knife extension for Cloudstack: [knife-cloudstack](https://github.com/CloudStack-extras/knife-cloudstack)
+
+
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
+
+
+## License
+
+Released under the MIT License. See the [LICENSE][] file for further details.
+
+[license]: LICENSE.txt