[cloudstack-cloudmonkey.wiki] branch master updated: Updated Getting Started (markdown)
This is an automated email from the ASF dual-hosted git repository. rohit pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/cloudstack-cloudmonkey.wiki.git The following commit(s) were added to refs/heads/master by this push: new 6a13985 Updated Getting Started (markdown) 6a13985 is described below commit 6a13985ae71d608eb2e98c0b22eb28b222e3f6a2 Author: Rohit Yadav AuthorDate: Thu Mar 14 13:02:43 2019 +0530 Updated Getting Started (markdown) --- Getting-Started.md | 98 -- 1 file changed, 58 insertions(+), 40 deletions(-) diff --git a/Getting-Started.md b/Getting-Started.md index 3cc7b77..ec4ce11 100644 --- a/Getting-Started.md +++ b/Getting-Started.md @@ -39,51 +39,30 @@ Discovered 610 APIs ``` You can also use the `set` command to set the various server profile specific options. The cloudmonkey configuration is stored at `~/.cmk/config` file. The `~/.cmk` directory also contains the API cache at `~/.cmk/profiles`. -## Making API requests - -Try autocompletion using tabbing: - -``` -> -> list -> list users # for options -> list users -> list users -{ - "count": 1, - "user": [ -{ - "account": "admin", - "accountid": "79665239-3cd4-11e9-bf33-f4d1082409e6", - "accounttype": 1, - "apikey": "...redacted...", - "created": "2019-03-02T15:48:07+", - "domain": "ROOT", - "domainid": "7965d079-3cd4-11e9-bf33-f4d1082409e6", - "email": "ad...@mailprovider.com", - "firstname": "Admin", - "id": "7966afa9-3cd4-11e9-bf33-f4d1082409e6", - "iscallerchilddomain": false, - "isdefault": true, - "lastname": "User", - "roleid": "852a28b1-3cd4-11e9-bf33-f4d1082409e6", - "rolename": "Root Admin", - "roletype": "Admin", - "state": "enabled", - "username": "admin", - "usersource": "native" -} - ] -} -``` -Consult the API docs at http://cloudstack.apache.org/api.html - ## Getting help Help for any API command can be obtained using ` -h`, for example: ``` > help +usage: cmk [flags] [commands|apis] [-h] + +CloudMonkey (cmk) 🐵 is a command line interface for Apache CloudStack. + +Allowed flags: + -hShow this help message or API doc when specified after an API + -vPrint version + -oAPI response output format: json, text, table, column, csv + -pServer profile + -dEnable debug mode + +Default commands: + exit Exits + help Help + set Configures options for cmk + sync Discovers and updates APIs + version Version info + > list users -h > help listUsers ``` @@ -117,4 +96,43 @@ page integer pagesize integer statestring List users by state of the user account. username string List user by the username -``` \ No newline at end of file +``` + +## Making API requests + +Try autocompletion using tabbing: + +``` +> +> list +> list users # for options +> list users +> list users +{ + "count": 1, + "user": [ +{ + "account": "admin", + "accountid": "79665239-3cd4-11e9-bf33-f4d1082409e6", + "accounttype": 1, + "apikey": "...redacted...", + "created": "2019-03-02T15:48:07+", + "domain": "ROOT", + "domainid": "7965d079-3cd4-11e9-bf33-f4d1082409e6", + "email": "ad...@mailprovider.com", + "firstname": "Admin", + "id": "7966afa9-3cd4-11e9-bf33-f4d1082409e6", + "iscallerchilddomain": false, + "isdefault": true, + "lastname": "User", + "roleid": "852a28b1-3cd4-11e9-bf33-f4d1082409e6", + "rolename": "Root Admin", + "roletype": "Admin", + "state": "enabled", + "username": "admin", + "usersource": "native" +} + ] +} +``` +Consult the API docs at http://cloudstack.apache.org/api.html \ No newline at end of file
[cloudstack-cloudmonkey.wiki] branch master updated: Updated Getting Started (markdown)
This is an automated email from the ASF dual-hosted git repository. rohit pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/cloudstack-cloudmonkey.wiki.git The following commit(s) were added to refs/heads/master by this push: new f92a9aa Updated Getting Started (markdown) f92a9aa is described below commit f92a9aa6fcd3a910fc663d517e1525c14e066196 Author: Rohit Yadav AuthorDate: Thu Mar 14 12:53:39 2019 +0530 Updated Getting Started (markdown) --- Getting-Started.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Getting-Started.md b/Getting-Started.md index bd8b75f..3cc7b77 100644 --- a/Getting-Started.md +++ b/Getting-Started.md @@ -1,8 +1,8 @@ -# Installation +## Installation To install the modern Apache CloudStack cloudmonkey or `cmk`, please download the binary from the latest release: https://github.com/apache/cloudstack-cloudmonkey/releases -## Install on Linux and Mac OSX +### Install on Linux and Mac OSX Download the binary for Linux or Mac based on your platform and move it to a directory that is on `$PATH` such as `/usr/local/bin`. For example: ``` @@ -10,7 +10,7 @@ sudo wget -O /usr/local/bin/cmk sudo chmod +x /usr/local/bin/cmk ``` -## Install on Windows +### Install on Windows Download the Windows specific `.exe` executable file and copy it to a directory which on the cmd's PATH such as `C:\Windows\System32\`. Launch cmd.exe or powershell and see if you can run/access `cmk.exe`.
[cloudstack-cloudmonkey.wiki] branch master updated: Updated Getting Started (markdown)
This is an automated email from the ASF dual-hosted git repository. rohit pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/cloudstack-cloudmonkey.wiki.git The following commit(s) were added to refs/heads/master by this push: new a345de5 Updated Getting Started (markdown) a345de5 is described below commit a345de5b39d37f153a77349618708513d4f3690b Author: Rohit Yadav AuthorDate: Thu Mar 14 12:53:11 2019 +0530 Updated Getting Started (markdown) --- Getting-Started.md | 61 -- 1 file changed, 59 insertions(+), 2 deletions(-) diff --git a/Getting-Started.md b/Getting-Started.md index 7cdf0a5..bd8b75f 100644 --- a/Getting-Started.md +++ b/Getting-Started.md @@ -1,4 +1,20 @@ -# First steps +# Installation + +To install the modern Apache CloudStack cloudmonkey or `cmk`, please download the binary from the latest release: https://github.com/apache/cloudstack-cloudmonkey/releases + +## Install on Linux and Mac OSX + +Download the binary for Linux or Mac based on your platform and move it to a directory that is on `$PATH` such as `/usr/local/bin`. For example: +``` +sudo wget -O /usr/local/bin/cmk +sudo chmod +x /usr/local/bin/cmk +``` + +## Install on Windows + +Download the Windows specific `.exe` executable file and copy it to a directory which on the cmd's PATH such as `C:\Windows\System32\`. Launch cmd.exe or powershell and see if you can run/access `cmk.exe`. + +## First steps The default server profile has the name `localcloud` with defaults (such as url and credentials) set to a locally running CloudStack server. Start `cmk`, create a new server profile, configure your CloudStack server's API endpoint and run `sync`, for example: @@ -60,4 +76,45 @@ Try autocompletion using tabbing: ] } ``` -Consult the API docs at http://cloudstack.apache.org/api.html \ No newline at end of file +Consult the API docs at http://cloudstack.apache.org/api.html + +## Getting help + +Help for any API command can be obtained using ` -h`, for example: + +``` +> help +> list users -h +> help listUsers +``` + +A typical help doc for an api will list all available acceptable arguments and required arguments. + +Example help for `listUsers` API: +``` +> list users -h +listUsers: Lists user accounts +API Params Type Description +== === +account string list resources by account. Must be used w + ith the domainId parameter. +accounttype long List users by account type. Valid types i + nclude admin, domain-admin, read-only-ad + min, or user. +domainid uuid list only resources belonging to the doma + in specified +id uuid List user by ID. +isrecursive boolean defaults to false, but if true, lists all + resources from the parent specified by + the domainId till leaves. +keyword string List by keyword +listall boolean If set to false, list only resources belo + nging to the command's caller; if set to + true - list resources that the caller i + s authorized to see. Default value is fa + lse +page integer +pagesize integer +statestring List users by state of the user account. +username string List user by the username +``` \ No newline at end of file
[cloudstack-cloudmonkey.wiki] branch master updated: Updated Getting Started (markdown)
This is an automated email from the ASF dual-hosted git repository. rohit pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/cloudstack-cloudmonkey.wiki.git The following commit(s) were added to refs/heads/master by this push: new 1fe93ce Updated Getting Started (markdown) 1fe93ce is described below commit 1fe93ce891409737ca553f1bdbdf3e3abfc0d05a Author: Rohit Yadav AuthorDate: Thu Mar 14 12:48:32 2019 +0530 Updated Getting Started (markdown) --- Getting-Started.md | 41 - 1 file changed, 40 insertions(+), 1 deletion(-) diff --git a/Getting-Started.md b/Getting-Started.md index 8f3e9dc..7cdf0a5 100644 --- a/Getting-Started.md +++ b/Getting-Started.md @@ -21,4 +21,43 @@ Total APIs: 595 (mycloud) 🐱 > sync Discovered 610 APIs ``` -You can also use the `set` command to set the various server profile specific options. The cloudmonkey configuration is stored at `~/.cmk/config` file. The `~/.cmk` directory also contains the API cache at `~/.cmk/profiles`. \ No newline at end of file +You can also use the `set` command to set the various server profile specific options. The cloudmonkey configuration is stored at `~/.cmk/config` file. The `~/.cmk` directory also contains the API cache at `~/.cmk/profiles`. + +## Making API requests + +Try autocompletion using tabbing: + +``` +> +> list +> list users # for options +> list users +> list users +{ + "count": 1, + "user": [ +{ + "account": "admin", + "accountid": "79665239-3cd4-11e9-bf33-f4d1082409e6", + "accounttype": 1, + "apikey": "...redacted...", + "created": "2019-03-02T15:48:07+", + "domain": "ROOT", + "domainid": "7965d079-3cd4-11e9-bf33-f4d1082409e6", + "email": "ad...@mailprovider.com", + "firstname": "Admin", + "id": "7966afa9-3cd4-11e9-bf33-f4d1082409e6", + "iscallerchilddomain": false, + "isdefault": true, + "lastname": "User", + "roleid": "852a28b1-3cd4-11e9-bf33-f4d1082409e6", + "rolename": "Root Admin", + "roletype": "Admin", + "state": "enabled", + "username": "admin", + "usersource": "native" +} + ] +} +``` +Consult the API docs at http://cloudstack.apache.org/api.html \ No newline at end of file
[cloudstack-cloudmonkey.wiki] branch master updated: Updated Getting Started (markdown)
This is an automated email from the ASF dual-hosted git repository. rohit pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/cloudstack-cloudmonkey.wiki.git The following commit(s) were added to refs/heads/master by this push: new ac0b42d Updated Getting Started (markdown) ac0b42d is described below commit ac0b42def825390d7f639d520b04da437a5138fa Author: Rohit Yadav AuthorDate: Thu Mar 14 12:45:51 2019 +0530 Updated Getting Started (markdown) --- Getting-Started.md | 18 +++--- 1 file changed, 7 insertions(+), 11 deletions(-) diff --git a/Getting-Started.md b/Getting-Started.md index 23ef9d2..8f3e9dc 100644 --- a/Getting-Started.md +++ b/Getting-Started.md @@ -4,10 +4,8 @@ The default server profile has the name `localcloud` with defaults (such as url ``` $ cmk -Loaded in-built API cache. Failed to read API cache, please run 'sync'. -Apache CloudStack 🐵 cloudmonkey 6.x.y -Type "help" for details, "sync" to update API cache or press tab to list options -Report issues here: https://github.com/apache/cloudstack-cloudmonkey/issues +Apache CloudStack 🐵 CloudMonkey 6.0.0 +Report issues: https://github.com/apache/cloudstack-cloudmonkey/issues (localcloud) 🐱 > set profile mycloud Loaded server profile: mycloud @@ -15,14 +13,12 @@ Url: http://localhost:8080/client/api Username:admin Domain: / API Key: +Total APIs: 595 (mycloud) 🐱 > set url http://myprovider.cloud/client/api -(mycloud) 🐱 > login -✔ Username: myusername -✔ Password: ** -✔ Domain: mydomain -Successfully logged in and saved credentials to the server profile. +(mycloud) 🐱 > set username myusername +(mycloud) 🐱 > set password mypassword (mycloud) 🐱 > sync -⣟ 😺 discovering APIs, please wait... +Discovered 610 APIs ``` -You can also use the `set` command to set the various server profile specific options. The cloudmonkey configuration is stored at `~/.cmk/config` file, the `~/.cmk` directory also contains the API cache and history files. \ No newline at end of file +You can also use the `set` command to set the various server profile specific options. The cloudmonkey configuration is stored at `~/.cmk/config` file. The `~/.cmk` directory also contains the API cache at `~/.cmk/profiles`. \ No newline at end of file
[cloudstack-cloudmonkey.wiki] branch master updated: Updated Getting Started (markdown)
This is an automated email from the ASF dual-hosted git repository. rohit pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/cloudstack-cloudmonkey.wiki.git The following commit(s) were added to refs/heads/master by this push: new 56466ad Updated Getting Started (markdown) 56466ad is described below commit 56466ad4099f9ecda78475929c1e582f834c71a6 Author: Rohit Yadav AuthorDate: Tue Jun 26 12:51:25 2018 +0530 Updated Getting Started (markdown) --- Getting-Started.md => Home.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) diff --git a/Getting-Started.md b/Home.md similarity index 100% rename from Getting-Started.md rename to Home.md