cloudn_cli 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d3e7c5c8dedd1933c60f278ecb7bfc7207539a27
+  data.tar.gz: 1ba67cf707cb3a9ceb9b75e10b09a1cd1ca96043
+SHA512:
+  metadata.gz: ce8194f55730af02f3c2e5b16cf8c8332933cfc96b518d10221323c0329032fceb9dfeced2b81feaf66ff35bf7dcbe7cf59db899ebea71159c828a544f326f06
+  data.tar.gz: 4842d5f2050f5ef26681cda4306c3369a7faf74b55543a8f5b5afd173c060ac9329066fe168837302cfaa55ff74eb230c4b89bee1493050ec0f76e669059c225

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cloudn_cli.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,18 @@
+# Copyright (C) 2013 NTT Communications
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.

data/README.md

@@ -0,0 +1,117 @@
+# Cloudn CLI
+
+Cloudn CLI is command line tool for calling CloudStack API easily.
+
+You can use this for your environment, or for commercial services such as Cloudn which is provided by NTT Communications.
+
+Also, you can refer the list of all the APIs with following URL.
+
+http://cloudstack.apache.org/docs/api/
+
+## Installation
+This step will be shown how to use Cloudn CLI.
+
+We can roughly divide into two steps , one is the preparing part for executing the Ruby because Cloudn CLI is made by Ruby, and another one is environment settings for local.
+
+## Setup the Ruby
+
+At first, rbenv should be installed, which is tool for version administration of Ruby.
+If you haven't installed git, please install that before this step.
+
+1.Copy the rbenv from github
+
+	$ git clone git://github.com/sstephenson/rbenv.git .rbenv 
+
+2.Register the environment variables
+
+	$ echo 'export PATH="~/.rbenv/bin:$PATH"' >> ~/.bash_profile
+    $ echo 'eval "$(rbenv init -)"' >> ~/.bash_profile
+	$ source ~/.bash_profile
+
+3.Install some necessary packages
+   
+	$ git clone git://github.com/sstephenson/ruby-build.git ~/.rbenv/plugins/ruby-build
+    $ yum install readline libtool openssl openssl-devel
+
+4.Installing the Ruby by using rbenv
+
+    $ rbenv install 2.0.0-p353
+    $ rbenv global 2.0.0-p353
+    $ ruby --version
+
+## Setup the Cloudn CLI
+In this step, cloning Cloudn CLI and follow some necessary steps to execute
+
+1.Clone the Cloudn CLI to your machine
+
+	$ git clone https://github.com/nttcom/cloudn-cli.git
+
+2.Install some necessary packages
+    
+    $ gem install bundler rb-readline
+    $ rbenv rehash 
+    $ bundle install --path=vender/bundle
+    
+3.Register the environment variables
+
+    $ echo 'export PATH=$PATH:/<Your directory>/bin' >> ~/.bash_profile source ~/.bash_profile
+
+4.Describe your settings which are api key, secret key, end endpoint of API into config.yml
+
+	$ vi config.yml
+	
+5.Execute Cloudn CLI, and you can call any api refering the list of APIs
+
+	$ cloudn_cli
+	`> listUsers`
+
+## Commands
+Cloudn CLI has some original commands as follows
+
+1.Refer the commands you can execute
+
+    > help
+
+2.Terminate the Cloudn CLI
+
+	> exit
+
+3.Display the current settings
+
+	> config
+
+4.Display the description of APIs
+
+	> doc <name of APIs>
+
+5.Change the format of return value
+
+	> format <xml | json>
+
+6.Choose the return value attribute
+
+	> raw true | false
+
+7.Choose the accounts which you want
+
+	> user <name of account>
+
+8.Display all the accounts in your config.yml
+
+	> users
+
+9.To be implemented
+
+	> eval
+
+## 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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/api_list.json

@@ -0,0 +1 @@
+["authorizeSecurityGroupIngress","authorizeSecurityGroupEgress","restoreVirtualMachine","suspendProject","revokeSecurityGroupIngress","revokeSecurityGroupEgress","disassociateIpAddress","dissociateLun","reconnectHost","cancelHostMaintenance","cancelStorageMaintenance","queryAsyncJobResult","detachVolume","detachIso","prepareTemplate","prepareHostForMaintenance","attachVolume","attachIso","createLoadBalancerRule","createSecurityGroup","createPod","createZone","createStoragePool","createVpnGateway","createAutoScaleVmGroup","createPrivateGateway","createVolume","createVPC","createCondition","createAutoScaleVmProfile","createAccount","createNetworkOffering","createVpnCustomerGateway","createLunOnFiler","createProject","createVlanIpRange","createDomain","createSnapshotPolicy","createDiskOffering","createPortForwardingRule","createIpForwardingRule","createVpnConnection","createLBStickinessPolicy","createVPCOffering","createNetwork","createRemoteAccessVpn","createInstanceGroup","createAutoScalePolicy","createServiceOffering","createTemplate","createNetworkACL","createTags","createVolumeOnFiler","createStaticRoute","createUser","createStorageNetworkIpRange","createPool","createFirewallRule","createPhysicalNetwork","createCounter","createSnapshot","createVirtualRouterElement","createSSHKeyPair","markDefaultZoneForAccount","startSystemVm","startRouter","startVirtualMachine","addTrafficMonitor","addNetscalerLoadBalancer","addCluster","addS3","addAccountToProject","addExternalLoadBalancer","addVpnUser","addSecondaryStorage","addTrafficType","addNiciraNvpDevice","addHost","addF5LoadBalancer","addNetworkDevice","addSrxFirewall","addSwift","addExternalFirewall","addNetworkServiceProvider","restartNetwork","restartVPC","ldapConfig","ldapRemove","enableAccount","enableStorageMaintenance","enableCiscoNexusVSM","enableStaticNat","enableUser","enableAutoScaleVmGroup","configureSrxFirewall","configureF5LoadBalancer","configureVirtualRouterElement","configureNetscalerLoadBalancer","getCloudIdentifier","getVMPassword","getUser","getApiLimit","stopSystemVm","stopRouter","stopVirtualMachine","copyIso","copyTemplate","resizeVolume","resetApiLimit","resetPasswordForVirtualMachine","resetVpnConnection","listInstanceGroups","listPhysicalNetworks","listNetworks","listCapabilities","listClusters","listResourceLimits","listFirewallRules","listSupportedNetworkServices","listLoadBalancerRules","listAutoScalePolicies","listNiciraNvpDevices","listF5LoadBalancerNetworks","listTemplatePermissions","listProjects","listSystemVms","listPortForwardingRules","listExternalFirewalls","listVpnGateways","listLoadBalancerRuleInstances","listHosts","listPools","listCounters","listConfigurations","listUsageRecords","listStoragePools","listSnapshots","listZones","listServiceOfferings","listCiscoNexusVSMs","listNetworkServiceProviders","listCapacity","listDiskOfferings","listLBStickinessPolicies","listSrxFirewallNetworks","listSecurityGroups","listConditions","listSwifts","listHypervisorCapabilities","listTags","listRouters","listTrafficTypes","listProjectInvitations","listIsos","listUsers","listSSHKeyPairs","listPrivateGateways","listUsageTypes","listDomainChildren","listDomains","listExternalLoadBalancers","listNetscalerLoadBalancers","listS3s","listHypervisors","listAccounts","listNetworkDevice","listVlanIpRanges","listTrafficTypeImplementors","listStorageNetworkIpRange","listIsoPermissions","listSnapshotPolicies","listAutoScaleVmGroups","listProjectAccounts","listAutoScaleVmProfiles","listApis","listVPCs","listF5LoadBalancers","listVpnCustomerGateways","listNetworkOfferings","listVirtualMachines","listNetscalerLoadBalancerNetworks","listOsCategories","listVirtualRouterElements","listLunsOnFiler","listAsyncJobs","listOsTypes","listNetworkACLs","listVolumesOnFiler","listEventTypes","listRemoteAccessVpns","listAlerts","listVPCOfferings","listNiciraNvpDeviceNetworks","listEvents","listTemplates","listPublicIpAddresses","listIpForwardingRules","listSrxFirewalls","listVpnConnections","listTrafficMonitors","listVpnUsers","listStaticRoutes","listVolumes","listPods","uploadVolume","uploadCustomCertificate","removeFromLoadBalancerRule","removeVpnUser","deleteLoadBalancerRule","deleteProjectInvitation","deleteSecurityGroup","deleteAccountFromProject","deleteNetworkDevice","deletePod","deleteSrxFirewall","deleteSnapshotPolicies","deleteZone","deleteNiciraNvpDevice","deleteStoragePool","deleteVpnGateway","deleteAutoScaleVmGroup","deleteTrafficMonitor","deletePrivateGateway","deleteVolume","deleteVPC","deleteCondition","deleteAutoScaleVmProfile","deleteAccount","deleteFirewallRule","deleteNetworkOffering","deleteVpnCustomerGateway","deleteProject","deletePhysicalNetwork","deleteDomain","deleteDiskOffering","deleteExternalLoadBalancer","deletePortForwardingRule","deleteCluster","deleteIpForwardingRule","deleteVpnConnection","deleteLBStickinessPolicy","deleteVPCOffering","deleteNetwork","deleteRemoteAccessVpn","deleteInstanceGroup","deleteAutoScalePolicy","deleteServiceOffering","deleteTemplate","deleteSnapshot","deleteNetworkACL","deleteTags","deleteStaticRoute","deleteTrafficType","deleteHost","deleteUser","deleteStorageNetworkIpRange","deleteExternalFirewall","deletePool","deleteCiscoNexusVSM","deleteNetscalerLoadBalancer","deleteVlanIpRange","deleteCounter","deleteF5LoadBalancer","deleteIso","deleteNetworkServiceProvider","deleteSSHKeyPair","activateProject","migrateSystemVm","migrateVolume","migrateVirtualMachine","lockAccount","lockUser","recoverVirtualMachine","extractVolume","extractIso","extractTemplate","deployVirtualMachine","rebootSystemVm","rebootRouter","rebootVirtualMachine","destroySystemVm","destroyRouter","destroyVolumeOnFiler","destroyLunOnFiler","destroyVirtualMachine","associateIpAddress","associateLun","modifyPool","updateLoadBalancerRule","updateDomain","updateInstanceGroup","updateDiskOffering","updateVirtualMachine","updateVPCOffering","updatePortForwardingRule","updateCluster","updateHost","updateUser","updateVPC","updateHostPassword","updatePod","updateConfiguration","updateStorageNetworkIpRange","updateIsoPermissions","updateResourceLimit","updateTrafficType","updateAccount","updateStoragePool","updateResourceCount","updateNetwork","updateZone","updateNetworkOffering","updatePhysicalNetwork","updateProjectInvitation","updateAutoScalePolicy","updateTemplatePermissions","updateProject","updateVpnCustomerGateway","updateServiceOffering","updateTemplate","updateIso","updateNetworkServiceProvider","updateAutoScaleVmProfile","updateHypervisorCapabilities","updateAutoScaleVmGroup","disableAccount","disableAutoScaleVmGroup","disableCiscoNexusVSM","disableStaticNat","disableUser","generateUsageRecords","changeServiceForVirtualMachine","changeServiceForSystemVm","changeServiceForRouter","registerUserKeys","registerIso","registerSSHKeyPair","registerTemplate","assignToLoadBalancerRule","assignVirtualMachine"]

data/bin/cloudn_cli

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require_relative "../lib/cloudn_cli/shell"
+
+source_dir = File.dirname(__FILE__)
+Cloudn::Shell.new(File.expand_path("~/.config.yml", File.dirname(__FILE__)))

data/cache.py

@@ -0,0 +1,6 @@
+import json
+from precache import precached_verbs
+
+f = open("precache.json", "w")
+print json.dumps(precached_verbs)
+json.dump(precached_verbs, f)

data/cloudn_cli.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cloudn_cli/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cloudn_cli"
+  spec.version       = Cloudn::Shell::VERSION
+  spec.authors       = [""]
+  spec.email         = [""]
+  spec.description   = %q{Shell for Cloudn API}
+  spec.summary       = %q{Shell for Cloudn API}
+  spec.homepage      = ""
+  spec.license       = ""
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  
+  spec.add_dependency("termcolor")
+  spec.add_dependency("crack")
+  spec.add_dependency("coderay")
+  spec.add_dependency("httpclient")
+end
+

data/config.yml

@@ -0,0 +1,14 @@
+:url:    "<Set your default endpoint of CloudStack APIs>"
+:raw_output: true
+:json: true
+:users:
+ :<Set your name 1>:
+    :api_key:    "<Set your api key>"
+    :secret_key: "<Set your secret key>"
+    :url:        "<Set your endpoint of CloudStack API>"
+    :api_location: "Cloudn"
+ :<Set your name 2>:
+    :api_key:    "<Set your api key>"
+    :secret_key: "<Set your secret key>"
+    :url:        "<Set your endpoint of CloudStack API>"
+    :api_location: "Cloudn"

data/lib/cloudn_cli/api_list.json

@@ -0,0 +1 @@
+{"authorizeSecurityGroupIngress":[["account","cidrlist","domainid","endport","icmpcode","icmptype","isAsync","projectid","protocol","securitygroupid","securitygroupname","startport","usersecuritygrouplist"],"Authorizes a particular ingress rule for this security group\nArgs: account cidrlist domainid endport icmpcode icmptype isAsync projectid protocol securitygroupid securitygroupname startport usersecuritygrouplist",[]],"authorizeSecurityGroupEgress":[["account","cidrlist","domainid","endport","icmpcode","icmptype","isAsync","projectid","protocol","securitygroupid","securitygroupname","startport","usersecuritygrouplist"],"Authorizes a particular egress rule for this security group\nArgs: account cidrlist domainid endport icmpcode icmptype isAsync projectid protocol securitygroupid securitygroupname startport usersecuritygrouplist",[]],"restoreVirtualMachine":[["isAsync","virtualmachineid"],"Restore a VM to original template or specific snapshot\nRequired args: virtualmachineid\nArgs: isAsync virtualmachineid",["virtualmachineid"]],"suspendProject":[["id","isAsync"],"Suspends a project\nRequired args: id\nArgs: id isAsync",["id"]],"revokeSecurityGroupIngress":[["id","isAsync"],"Deletes a particular ingress rule from this security group\nRequired args: id\nArgs: id isAsync",["id"]],"revokeSecurityGroupEgress":[["id","isAsync"],"Deletes a particular egress rule from this security group\nRequired args: id\nArgs: id isAsync",["id"]],"disassociateIpAddress":[["id","isAsync"],"Disassociates an ip address from the account.\nRequired args: id\nArgs: id isAsync",["id"]],"dissociateLun":[["iqn","isAsync","path"],"Dissociate a LUN\nRequired args: iqn path\nArgs: iqn isAsync path",["iqn","path"]],"reconnectHost":[["id","isAsync"],"Reconnects a host.\nRequired args: id\nArgs: id isAsync",["id"]],"cancelHostMaintenance":[["id","isAsync"],"Cancels host maintenance.\nRequired args: id\nArgs: id isAsync",["id"]],"cancelStorageMaintenance":[["id","isAsync"],"Cancels maintenance for primary storage\nRequired args: id\nArgs: id isAsync",["id"]],"queryAsyncJobResult":[["isAsync","jobid"],"Retrieves the current status of asynchronous job.\nRequired args: jobid\nArgs: isAsync jobid",["jobid"]],"detachVolume":[["deviceid","id","isAsync","virtualmachineid"],"Detaches a disk volume from a virtual machine.\nArgs: deviceid id isAsync virtualmachineid",[]],"detachIso":[["isAsync","virtualmachineid"],"Detaches any ISO file (if any) currently attached to a virtual machine.\nRequired args: virtualmachineid\nArgs: isAsync virtualmachineid",["virtualmachineid"]],"prepareTemplate":[["isAsync","templateid","zoneid"],"load template into primary storage\nRequired args: templateid zoneid\nArgs: isAsync templateid zoneid",["templateid","zoneid"]],"prepareHostForMaintenance":[["id","isAsync"],"Prepares a host for maintenance.\nRequired args: id\nArgs: id isAsync",["id"]],"attachVolume":[["deviceid","id","isAsync","virtualmachineid"],"Attaches a disk volume to a virtual machine.\nRequired args: id virtualmachineid\nArgs: deviceid id isAsync virtualmachineid",["id","virtualmachineid"]],"attachIso":[["id","isAsync","virtualmachineid"],"Attaches an ISO to a virtual machine.\nRequired args: id virtualmachineid\nArgs: id isAsync virtualmachineid",["id","virtualmachineid"]],"createLoadBalancerRule":[["account","algorithm","cidrlist","description","domainid","isAsync","name","networkid","openfirewall","privateport","publicipid","publicport","zoneid"],"Creates a load balancer rule\nRequired args: algorithm name privateport publicport\nArgs: account algorithm cidrlist description domainid isAsync name networkid openfirewall privateport publicipid publicport zoneid",["algorithm","name","privateport","publicport"]],"createSecurityGroup":[["account","description","domainid","isAsync","name","projectid"],"Creates a security group\nRequired args: name\nArgs: account description domainid isAsync name projectid",["name"]],"createPod":[["allocationstate","endip","gateway","isAsync","name","netmask","startip","zoneid"],"Creates a new Pod.\nRequired args: gateway name netmask startip zoneid\nArgs: allocationstate endip gateway isAsync name netmask startip zoneid",["gateway","name","netmask","startip","zoneid"]],"createZone":[["allocationstate","dns1","dns2","domain","domainid","guestcidraddress","internaldns1","internaldns2","isAsync","localstorageenabled","name","networktype","securitygroupenabled"],"Creates a Zone.\nRequired args: dns1 internaldns1 name networktype\nArgs: allocationstate dns1 dns2 domain domainid guestcidraddress internaldns1 internaldns2 isAsync localstorageenabled name networktype securitygroupenabled",["dns1","internaldns1","name","networktype"]],"createStoragePool":[["clusterid","details","isAsync","name","podid","tags","url","zoneid"],"Creates a storage pool.\nRequired args: clusterid name podid url zoneid\nArgs: clusterid details isAsync name podid tags url zoneid",["clusterid","name","podid","url","zoneid"]],"createVpnGateway":[["isAsync","vpcid"],"Creates site to site vpn local gateway\nRequired args: vpcid\nArgs: isAsync vpcid",["vpcid"]],"createAutoScaleVmGroup":[["interval","isAsync","lbruleid","maxmembers","minmembers","scaledownpolicyids","scaleuppolicyids","vmprofileid"],"Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.\nRequired args: lbruleid maxmembers minmembers scaledownpolicyids scaleuppolicyids vmprofileid\nArgs: interval isAsync lbruleid maxmembers minmembers scaledownpolicyids scaleuppolicyids vmprofileid",["lbruleid","maxmembers","minmembers","scaledownpolicyids","scaleuppolicyids","vmprofileid"]],"createPrivateGateway":[["gateway","ipaddress","isAsync","netmask","physicalnetworkid","vlan","vpcid"],"Creates a private gateway\nRequired args: gateway ipaddress netmask vlan vpcid\nArgs: gateway ipaddress isAsync netmask physicalnetworkid vlan vpcid",["gateway","ipaddress","netmask","vlan","vpcid"]],"createVolume":[["account","diskofferingid","domainid","isAsync","name","projectid","size","snapshotid","zoneid"],"Creates a disk volume from a disk offering. This disk volume must still be attached to a virtual machine to make use of it.\nRequired args: name\nArgs: account diskofferingid domainid isAsync name projectid size snapshotid zoneid",["name"]],"createVPC":[["account","cidr","displaytext","domainid","isAsync","name","networkdomain","projectid","vpcofferingid","zoneid"],"Creates a VPC\nRequired args: cidr displaytext name vpcofferingid zoneid\nArgs: account cidr displaytext domainid isAsync name networkdomain projectid vpcofferingid zoneid",["cidr","displaytext","name","vpcofferingid","zoneid"]],"createCondition":[["account","counterid","domainid","isAsync","relationaloperator","threshold"],"Creates a condition\nRequired args: counterid relationaloperator threshold\nArgs: account counterid domainid isAsync relationaloperator threshold",["counterid","relationaloperator","threshold"]],"createAutoScaleVmProfile":[["autoscaleuserid","counterparam","destroyvmgraceperiod","isAsync","otherdeployparams","serviceofferingid","templateid","zoneid"],"Creates a profile that contains information about the virtual machine which will be provisioned automatically by autoscale feature.\nRequired args: serviceofferingid templateid zoneid\nArgs: autoscaleuserid counterparam destroyvmgraceperiod isAsync otherdeployparams serviceofferingid templateid zoneid",["serviceofferingid","templateid","zoneid"]],"createAccount":[["account","accountdetails","accounttype","domainid","email","firstname","isAsync","lastname","networkdomain","password","timezone","username"],"Creates an account\nRequired args: accounttype email firstname lastname password username\nArgs: account accountdetails accounttype domainid email firstname isAsync lastname networkdomain password timezone username",["accounttype","email","firstname","lastname","password","username"]],"createNetworkOffering":[["availability","conservemode","displaytext","guestiptype","isAsync","name","networkrate","servicecapabilitylist","serviceofferingid","serviceproviderlist","specifyipranges","specifyvlan","supportedservices","tags","traffictype"],"Creates a network offering.\nRequired args: displaytext guestiptype name supportedservices traffictype\nArgs: availability conservemode displaytext guestiptype isAsync name networkrate servicecapabilitylist serviceofferingid serviceproviderlist specifyipranges specifyvlan supportedservices tags traffictype",["displaytext","guestiptype","name","supportedservices","traffictype"]],"createVpnCustomerGateway":[["account","cidrlist","domainid","dpd","esplifetime","esppolicy","gateway","ikelifetime","ikepolicy","ipsecpsk","isAsync","name"],"Creates site to site vpn customer gateway\nRequired args: cidrlist esppolicy gateway ikepolicy ipsecpsk\nArgs: account cidrlist domainid dpd esplifetime esppolicy gateway ikelifetime ikepolicy ipsecpsk isAsync name",["cidrlist","esppolicy","gateway","ikepolicy","ipsecpsk"]],"createLunOnFiler":[["isAsync","name","size"],"Create a LUN from a pool\nRequired args: name size\nArgs: isAsync name size",["name","size"]],"createProject":[["account","displaytext","domainid","isAsync","name"],"Creates a project\nRequired args: displaytext name\nArgs: account displaytext domainid isAsync name",["displaytext","name"]],"createVlanIpRange":[["account","domainid","endip","forvirtualnetwork","gateway","isAsync","netmask","networkid","physicalnetworkid","podid","projectid","startip","vlan","zoneid"],"Creates a VLAN IP range.\nRequired args: startip\nArgs: account domainid endip forvirtualnetwork gateway isAsync netmask networkid physicalnetworkid podid projectid startip vlan zoneid",["startip"]],"createDomain":[["isAsync","name","networkdomain","parentdomainid"],"Creates a domain\nRequired args: name\nArgs: isAsync name networkdomain parentdomainid",["name"]],"createSnapshotPolicy":[["intervaltype","isAsync","maxsnaps","schedule","timezone","volumeid"],"Creates a snapshot policy for the account.\nRequired args: intervaltype maxsnaps schedule timezone volumeid\nArgs: intervaltype isAsync maxsnaps schedule timezone volumeid",["intervaltype","maxsnaps","schedule","timezone","volumeid"]],"createDiskOffering":[["customized","disksize","displaytext","domainid","isAsync","name","storagetype","tags"],"Creates a disk offering.\nRequired args: displaytext name\nArgs: customized disksize displaytext domainid isAsync name storagetype tags",["displaytext","name"]],"createPortForwardingRule":[["cidrlist","ipaddressid","isAsync","networkid","openfirewall","privateendport","privateport","protocol","publicendport","publicport","virtualmachineid"],"Creates a port forwarding rule\nRequired args: ipaddressid privateport protocol publicport virtualmachineid\nArgs: cidrlist ipaddressid isAsync networkid openfirewall privateendport privateport protocol publicendport publicport virtualmachineid",["ipaddressid","privateport","protocol","publicport","virtualmachineid"]],"createIpForwardingRule":[["cidrlist","endport","ipaddressid","isAsync","openfirewall","protocol","startport"],"Creates an ip forwarding rule\nRequired args: ipaddressid protocol startport\nArgs: cidrlist endport ipaddressid isAsync openfirewall protocol startport",["ipaddressid","protocol","startport"]],"createVpnConnection":[["isAsync","s2scustomergatewayid","s2svpngatewayid"],"Create site to site vpn connection\nRequired args: s2scustomergatewayid s2svpngatewayid\nArgs: isAsync s2scustomergatewayid s2svpngatewayid",["s2scustomergatewayid","s2svpngatewayid"]],"createLBStickinessPolicy":[["description","isAsync","lbruleid","methodname","name","param"],"Creates a Load Balancer stickiness policy\nRequired args: lbruleid methodname name\nArgs: description isAsync lbruleid methodname name param",["lbruleid","methodname","name"]],"createVPCOffering":[["displaytext","isAsync","name","supportedservices"],"Creates VPC offering\nRequired args: displaytext name supportedservices\nArgs: displaytext isAsync name supportedservices",["displaytext","name","supportedservices"]],"createNetwork":[["account","acltype","displaytext","domainid","endip","gateway","isAsync","name","netmask","networkdomain","networkofferingid","physicalnetworkid","projectid","startip","subdomainaccess","vlan","vpcid","zoneid"],"Creates a network\nRequired args: displaytext name networkofferingid zoneid\nArgs: account acltype displaytext domainid endip gateway isAsync name netmask networkdomain networkofferingid physicalnetworkid projectid startip subdomainaccess vlan vpcid zoneid",["displaytext","name","networkofferingid","zoneid"]],"createRemoteAccessVpn":[["account","domainid","iprange","isAsync","openfirewall","publicipid"],"Creates a l2tp/ipsec remote access vpn\nRequired args: publicipid\nArgs: account domainid iprange isAsync openfirewall publicipid",["publicipid"]],"createInstanceGroup":[["account","domainid","isAsync","name","projectid"],"Creates a vm group\nRequired args: name\nArgs: account domainid isAsync name projectid",["name"]],"createAutoScalePolicy":[["action","conditionids","duration","isAsync","quiettime"],"Creates an autoscale policy for a provision or deprovision action, the action is taken when the all the conditions evaluates to true for the specified duration. The policy is in effect once it is attached to a autscale vm group.\nRequired args: action conditionids duration\nArgs: action conditionids duration isAsync quiettime",["action","conditionids","duration"]],"createServiceOffering":[["cpunumber","cpuspeed","displaytext","domainid","hosttags","isAsync","issystem","limitcpuuse","memory","name","networkrate","offerha","storagetype","systemvmtype","tags"],"Creates a service offering.\nRequired args: cpunumber cpuspeed displaytext memory name\nArgs: cpunumber cpuspeed displaytext domainid hosttags isAsync issystem limitcpuuse memory name networkrate offerha storagetype systemvmtype tags",["cpunumber","cpuspeed","displaytext","memory","name"]],"createTemplate":[["bits","details","displaytext","isAsync","isfeatured","ispublic","name","ostypeid","passwordenabled","requireshvm","snapshotid","templatetag","url","virtualmachineid","volumeid"],"Creates a template of a virtual machine. The virtual machine must be in a STOPPED state. A template created from this command is automatically designated as a private template visible to the account that created it.\nRequired args: displaytext name ostypeid\nArgs: bits details displaytext isAsync isfeatured ispublic name ostypeid passwordenabled requireshvm snapshotid templatetag url virtualmachineid volumeid",["displaytext","name","ostypeid"]],"createNetworkACL":[["cidrlist","endport","icmpcode","icmptype","isAsync","networkid","protocol","startport","traffictype"],"Creates a ACL rule the given network (the network has to belong to VPC)\nRequired args: networkid protocol\nArgs: cidrlist endport icmpcode icmptype isAsync networkid protocol startport traffictype",["networkid","protocol"]],"createTags":[["customer","isAsync","resourceids","resourcetype","tags"],"Creates resource tag(s)\nRequired args: resourceids resourcetype tags\nArgs: customer isAsync resourceids resourcetype tags",["resourceids","resourcetype","tags"]],"createVolumeOnFiler":[["aggregatename","ipaddress","isAsync","password","poolname","size","snapshotpolicy","snapshotreservation","username","volumename"],"Create a volume\nRequired args: aggregatename ipaddress password poolname size username volumename\nArgs: aggregatename ipaddress isAsync password poolname size snapshotpolicy snapshotreservation username volumename",["aggregatename","ipaddress","password","poolname","size","username","volumename"]],"createStaticRoute":[["cidr","gatewayid","isAsync"],"Creates a static route\nRequired args: cidr gatewayid\nArgs: cidr gatewayid isAsync",["cidr","gatewayid"]],"createUser":[["account","domainid","email","firstname","isAsync","lastname","password","timezone","username"],"Creates a user for an account that already exists\nRequired args: account email firstname lastname password username\nArgs: account domainid email firstname isAsync lastname password timezone username",["account","email","firstname","lastname","password","username"]],"createStorageNetworkIpRange":[["endip","gateway","isAsync","netmask","podid","startip","vlan"],"Creates a Storage network IP range.\nRequired args: gateway netmask podid startip\nArgs: endip gateway isAsync netmask podid startip vlan",["gateway","netmask","podid","startip"]],"createPool":[["algorithm","isAsync","name"],"Create a pool\nRequired args: algorithm name\nArgs: algorithm isAsync name",["algorithm","name"]],"createFirewallRule":[["cidrlist","endport","icmpcode","icmptype","ipaddressid","isAsync","protocol","startport","type"],"Creates a firewall rule for a given ip address\nRequired args: ipaddressid protocol\nArgs: cidrlist endport icmpcode icmptype ipaddressid isAsync protocol startport type",["ipaddressid","protocol"]],"createPhysicalNetwork":[["broadcastdomainrange","domainid","isAsync","isolationmethods","name","networkspeed","tags","vlan","zoneid"],"Creates a physical network\nRequired args: name zoneid\nArgs: broadcastdomainrange domainid isAsync isolationmethods name networkspeed tags vlan zoneid",["name","zoneid"]],"createCounter":[["isAsync","name","source","value"],"Adds metric counter\nRequired args: name source value\nArgs: isAsync name source value",["name","source","value"]],"createSnapshot":[["account","domainid","isAsync","policyid","volumeid"],"Creates an instant snapshot of a volume.\nRequired args: volumeid\nArgs: account domainid isAsync policyid volumeid",["volumeid"]],"createVirtualRouterElement":[["isAsync","nspid"],"Create a virtual router element.\nRequired args: nspid\nArgs: isAsync nspid",["nspid"]],"createSSHKeyPair":[["account","domainid","isAsync","name","projectid"],"Create a new keypair and returns the private key\nRequired args: name\nArgs: account domainid isAsync name projectid",["name"]],"markDefaultZoneForAccount":[["account","domainid","isAsync","zoneid"],"Marks a default zone for this account\nRequired args: account domainid zoneid\nArgs: account domainid isAsync zoneid",["account","domainid","zoneid"]],"startSystemVm":[["id","isAsync"],"Starts a system virtual machine.\nRequired args: id\nArgs: id isAsync",["id"]],"startRouter":[["id","isAsync"],"Starts a router.\nRequired args: id\nArgs: id isAsync",["id"]],"startVirtualMachine":[["hostid","id","isAsync"],"Starts a virtual machine.\nRequired args: id\nArgs: hostid id isAsync",["id"]],"addTrafficMonitor":[["excludezones","includezones","isAsync","url","zoneid"],"Adds Traffic Monitor Host for Direct Network Usage\nRequired args: url zoneid\nArgs: excludezones includezones isAsync url zoneid",["url","zoneid"]],"addNetscalerLoadBalancer":[["isAsync","networkdevicetype","password","physicalnetworkid","url","username"],"Adds a netscaler load balancer device\nRequired args: networkdevicetype password physicalnetworkid url username\nArgs: isAsync networkdevicetype password physicalnetworkid url username",["networkdevicetype","password","physicalnetworkid","url","username"]],"addCluster":[["allocationstate","clustername","clustertype","hypervisor","isAsync","password","podid","url","username","vsmipaddress","vsmpassword","vsmusername","zoneid"],"Adds a new cluster\nRequired args: clustername clustertype hypervisor podid zoneid\nArgs: allocationstate clustername clustertype hypervisor isAsync password podid url username vsmipaddress vsmpassword vsmusername zoneid",["clustername","clustertype","hypervisor","podid","zoneid"]],"addS3":[["accesskey","bucket","connectiontimeout","endpoint","isAsync","maxerrorretry","secretkey","sockettimeout","usehttps"],"Adds S3\nRequired args: accesskey bucket secretkey\nArgs: accesskey bucket connectiontimeout endpoint isAsync maxerrorretry secretkey sockettimeout usehttps",["accesskey","bucket","secretkey"]],"addAccountToProject":[["account","email","isAsync","projectid"],"Adds acoount to a project\nRequired args: projectid\nArgs: account email isAsync projectid",["projectid"]],"addExternalLoadBalancer":[["isAsync","password","url","username","zoneid"],"Adds F5 external load balancer appliance.\nRequired args: password url username zoneid\nArgs: isAsync password url username zoneid",["password","url","username","zoneid"]],"addVpnUser":[["account","domainid","isAsync","password","projectid","username"],"Adds vpn users\nRequired args: password username\nArgs: account domainid isAsync password projectid username",["password","username"]],"addSecondaryStorage":[["isAsync","url","zoneid"],"Adds secondary storage.\nRequired args: url\nArgs: isAsync url zoneid",["url"]],"addTrafficType":[["isAsync","kvmnetworklabel","physicalnetworkid","traffictype","vlan","vmwarenetworklabel","xennetworklabel"],"Adds traffic type to a physical network\nRequired args: physicalnetworkid traffictype\nArgs: isAsync kvmnetworklabel physicalnetworkid traffictype vlan vmwarenetworklabel xennetworklabel",["physicalnetworkid","traffictype"]],"addNiciraNvpDevice":[["hostname","isAsync","l3gatewayserviceuuid","password","physicalnetworkid","transportzoneuuid","username"],"Adds a Nicira NVP device\nRequired args: hostname password physicalnetworkid transportzoneuuid username\nArgs: hostname isAsync l3gatewayserviceuuid password physicalnetworkid transportzoneuuid username",["hostname","password","physicalnetworkid","transportzoneuuid","username"]],"addHost":[["allocationstate","clusterid","clustername","hosttags","hypervisor","isAsync","password","podid","url","username","zoneid"],"Adds a new host.\nRequired args: hypervisor password podid url username zoneid\nArgs: allocationstate clusterid clustername hosttags hypervisor isAsync password podid url username zoneid",["hypervisor","password","podid","url","username","zoneid"]],"addF5LoadBalancer":[["isAsync","networkdevicetype","password","physicalnetworkid","url","username"],"Adds a F5 BigIP load balancer device\nRequired args: networkdevicetype password physicalnetworkid url username\nArgs: isAsync networkdevicetype password physicalnetworkid url username",["networkdevicetype","password","physicalnetworkid","url","username"]],"addNetworkDevice":[["isAsync","networkdeviceparameterlist","networkdevicetype"],"Adds a network device of one of the following types: ExternalDhcp, ExternalFirewall, ExternalLoadBalancer, PxeServer\nArgs: isAsync networkdeviceparameterlist networkdevicetype",[]],"addSrxFirewall":[["isAsync","networkdevicetype","password","physicalnetworkid","url","username"],"Adds a SRX firewall device\nRequired args: networkdevicetype password physicalnetworkid url username\nArgs: isAsync networkdevicetype password physicalnetworkid url username",["networkdevicetype","password","physicalnetworkid","url","username"]],"addSwift":[["account","isAsync","key","url","username"],"Adds Swift.\nRequired args: url\nArgs: account isAsync key url username",["url"]],"addExternalFirewall":[["isAsync","password","url","username","zoneid"],"Adds an external firewall appliance\nRequired args: password url username zoneid\nArgs: isAsync password url username zoneid",["password","url","username","zoneid"]],"addNetworkServiceProvider":[["destinationphysicalnetworkid","isAsync","name","physicalnetworkid","servicelist"],"Adds a network serviceProvider to a physical network\nRequired args: name physicalnetworkid\nArgs: destinationphysicalnetworkid isAsync name physicalnetworkid servicelist",["name","physicalnetworkid"]],"restartNetwork":[["cleanup","id","isAsync"],"Restarts the network; includes 1) restarting network elements - virtual routers, dhcp servers 2) reapplying all public ips 3) reapplying loadBalancing/portForwarding rules\nRequired args: id\nArgs: cleanup id isAsync",["id"]],"restartVPC":[["id","isAsync"],"Restarts a VPC\nArgs: id isAsync",[]],"ldapConfig":[["binddn","bindpass","hostname","isAsync","port","queryfilter","searchbase","ssl","truststore","truststorepass"],"Configure the LDAP context for this site.\nRequired args: hostname queryfilter searchbase\nArgs: binddn bindpass hostname isAsync port queryfilter searchbase ssl truststore truststorepass",["hostname","queryfilter","searchbase"]],"ldapRemove":[["isAsync"],"Remove the LDAP context for this site.\nArgs: isAsync",[]],"enableAccount":[["account","domainid","id","isAsync"],"Enables an account\nArgs: account domainid id isAsync",[]],"enableStorageMaintenance":[["id","isAsync"],"Puts storage pool into maintenance state\nRequired args: id\nArgs: id isAsync",["id"]],"enableCiscoNexusVSM":[["id","isAsync"],"Enable a Cisco Nexus VSM device\nRequired args: id\nArgs: id isAsync",["id"]],"enableStaticNat":[["ipaddressid","isAsync","networkid","virtualmachineid"],"Enables static nat for given ip address\nRequired args: ipaddressid virtualmachineid\nArgs: ipaddressid isAsync networkid virtualmachineid",["ipaddressid","virtualmachineid"]],"enableUser":[["id","isAsync"],"Enables a user account\nRequired args: id\nArgs: id isAsync",["id"]],"enableAutoScaleVmGroup":[["id","isAsync"],"Enables an AutoScale Vm Group\nRequired args: id\nArgs: id isAsync",["id"]],"configureSrxFirewall":[["fwdevicecapacity","fwdeviceid","isAsync"],"Configures a SRX firewall device\nRequired args: fwdeviceid\nArgs: fwdevicecapacity fwdeviceid isAsync",["fwdeviceid"]],"configureF5LoadBalancer":[["isAsync","lbdevicecapacity","lbdeviceid"],"configures a F5 load balancer device\nRequired args: lbdeviceid\nArgs: isAsync lbdevicecapacity lbdeviceid",["lbdeviceid"]],"configureVirtualRouterElement":[["enabled","id","isAsync"],"Configures a virtual router element.\nRequired args: id enabled\nArgs: enabled id isAsync",["id","enabled"]],"configureNetscalerLoadBalancer":[["inline","isAsync","lbdevicecapacity","lbdevicededicated","lbdeviceid","podids"],"configures a netscaler load balancer device\nRequired args: lbdeviceid\nArgs: inline isAsync lbdevicecapacity lbdevicededicated lbdeviceid podids",["lbdeviceid"]],"getCloudIdentifier":[["isAsync","userid"],"Retrieves a cloud identifier.\nRequired args: userid\nArgs: isAsync userid",["userid"]],"getVMPassword":[["id","isAsync"],"Returns an encrypted password for the VM\nRequired args: id\nArgs: id isAsync",["id"]],"getUser":[["isAsync","userapikey"],"Find user account by API key\nRequired args: userapikey\nArgs: isAsync userapikey",["userapikey"]],"getApiLimit":[["isAsync"],"Get API limit count for the caller\nArgs: isAsync",[]],"stopSystemVm":[["forced","id","isAsync"],"Stops a system VM.\nRequired args: id\nArgs: forced id isAsync",["id"]],"stopRouter":[["forced","id","isAsync"],"Stops a router.\nRequired args: id\nArgs: forced id isAsync",["id"]],"stopVirtualMachine":[["forced","id","isAsync"],"Stops a virtual machine.\nRequired args: id\nArgs: forced id isAsync",["id"]],"copyIso":[["destzoneid","id","isAsync","sourcezoneid"],"Copies an iso from one zone to another.\nRequired args: id destzoneid sourcezoneid\nArgs: destzoneid id isAsync sourcezoneid",["id","destzoneid","sourcezoneid"]],"copyTemplate":[["destzoneid","id","isAsync","sourcezoneid"],"Copies a template from one zone to another.\nRequired args: id destzoneid sourcezoneid\nArgs: destzoneid id isAsync sourcezoneid",["id","destzoneid","sourcezoneid"]],"resizeVolume":[["diskofferingid","id","isAsync","shrinkok","size"],"Resizes a volume\nArgs: diskofferingid id isAsync shrinkok size",[]],"resetApiLimit":[["account","isAsync"],"Reset api count\nArgs: account isAsync",[]],"resetPasswordForVirtualMachine":[["id","isAsync"],"Resets the password for virtual machine. The virtual machine must be in a \"Stopped\" state and the template must already support this feature for this command to take effect. [async]\nRequired args: id\nArgs: id isAsync",["id"]],"resetVpnConnection":[["account","domainid","id","isAsync"],"Reset site to site vpn connection\nRequired args: id\nArgs: account domainid id isAsync",["id"]],"listInstanceGroups":[["account","domainid","id","isAsync","isrecursive","keyword","listall","name","page","pagesize","projectid"],"Lists vm groups\nArgs: account domainid id isAsync isrecursive keyword listall name page pagesize projectid",[]],"listPhysicalNetworks":[["id","isAsync","keyword","name","page","pagesize","zoneid"],"Lists physical networks\nArgs: id isAsync keyword name page pagesize zoneid",[]],"listNetworks":[["account","acltype","canusefordeploy","domainid","forvpc","id","isAsync","isrecursive","issystem","keyword","listall","page","pagesize","physicalnetworkid","projectid","specifyipranges","supportedservices","tags","traffictype","type","vpcid","zoneid"],"Lists all available networks.\nArgs: account acltype canusefordeploy domainid forvpc id isAsync isrecursive issystem keyword listall page pagesize physicalnetworkid projectid specifyipranges supportedservices tags traffictype type vpcid zoneid",[]],"listCapabilities":[["isAsync"],"Lists capabilities\nArgs: isAsync",[]],"listClusters":[["allocationstate","clustertype","hypervisor","id","isAsync","keyword","managedstate","name","page","pagesize","podid","showcapacities","zoneid"],"Lists clusters.\nArgs: allocationstate clustertype hypervisor id isAsync keyword managedstate name page pagesize podid showcapacities zoneid",[]],"listResourceLimits":[["account","domainid","id","isAsync","isrecursive","keyword","listall","page","pagesize","projectid","resourcetype"],"Lists resource limits.\nArgs: account domainid id isAsync isrecursive keyword listall page pagesize projectid resourcetype",[]],"listFirewallRules":[["account","domainid","id","ipaddressid","isAsync","isrecursive","keyword","listall","page","pagesize","projectid","tags"],"Lists all firewall rules for an IP address.\nArgs: account domainid id ipaddressid isAsync isrecursive keyword listall page pagesize projectid tags",[]],"listSupportedNetworkServices":[["isAsync","keyword","page","pagesize","provider","service"],"Lists all network services provided by CloudStack or for the given Provider.\nArgs: isAsync keyword page pagesize provider service",[]],"listLoadBalancerRules":[["account","domainid","id","isAsync","isrecursive","keyword","listall","name","page","pagesize","projectid","publicipid","tags","virtualmachineid","zoneid"],"Lists load balancer rules.\nArgs: account domainid id isAsync isrecursive keyword listall name page pagesize projectid publicipid tags virtualmachineid zoneid",[]],"listAutoScalePolicies":[["account","action","conditionid","domainid","id","isAsync","isrecursive","keyword","listall","page","pagesize","vmgroupid"],"Lists autoscale policies.\nArgs: account action conditionid domainid id isAsync isrecursive keyword listall page pagesize vmgroupid",[]],"listNiciraNvpDevices":[["isAsync","keyword","nvpdeviceid","page","pagesize","physicalnetworkid"],"Lists Nicira NVP devices\nArgs: isAsync keyword nvpdeviceid page pagesize physicalnetworkid",[]],"listF5LoadBalancerNetworks":[["isAsync","keyword","lbdeviceid","page","pagesize"],"lists network that are using a F5 load balancer device\nRequired args: lbdeviceid\nArgs: isAsync keyword lbdeviceid page pagesize",["lbdeviceid"]],"listTemplatePermissions":[["id","isAsync"],"List template visibility and all accounts that have permissions to view this template.\nRequired args: id\nArgs: id isAsync",["id"]],"listProjects":[["account","displaytext","domainid","id","isAsync","isrecursive","keyword","listall","name","page","pagesize","state","tags"],"Lists projects and provides detailed information for listed projects\nArgs: account displaytext domainid id isAsync isrecursive keyword listall name page pagesize state tags",[]],"listSystemVms":[["hostid","id","isAsync","keyword","name","page","pagesize","podid","state","storageid","systemvmtype","zoneid"],"List system virtual machines.\nArgs: hostid id isAsync keyword name page pagesize podid state storageid systemvmtype zoneid",[]],"listPortForwardingRules":[["account","domainid","id","ipaddressid","isAsync","isrecursive","keyword","listall","page","pagesize","projectid","tags"],"Lists all port forwarding rules for an IP address.\nArgs: account domainid id ipaddressid isAsync isrecursive keyword listall page pagesize projectid tags",[]],"listExternalFirewalls":[["isAsync","keyword","page","pagesize","zoneid"],"List external firewall appliances.\nRequired args: zoneid\nArgs: isAsync keyword page pagesize zoneid",["zoneid"]],"listVpnGateways":[["account","domainid","id","isAsync","isrecursive","keyword","listall","page","pagesize","projectid","vpcid"],"Lists site 2 site vpn gateways\nArgs: account domainid id isAsync isrecursive keyword listall page pagesize projectid vpcid",[]],"listLoadBalancerRuleInstances":[["applied","id","isAsync","keyword","page","pagesize"],"List all virtual machine instances that are assigned to a load balancer rule.\nRequired args: id\nArgs: applied id isAsync keyword page pagesize",["id"]],"listHosts":[["clusterid","details","hahost","id","isAsync","keyword","name","page","pagesize","podid","resourcestate","state","type","virtualmachineid","zoneid"],"Lists hosts.\nArgs: clusterid details hahost id isAsync keyword name page pagesize podid resourcestate state type virtualmachineid zoneid",[]],"listPools":[["isAsync"],"List Pool\nArgs: isAsync",[]],"listCounters":[["id","isAsync","keyword","name","page","pagesize","source"],"List the counters\nArgs: id isAsync keyword name page pagesize source",[]],"listConfigurations":[["category","isAsync","keyword","name","page","pagesize"],"Lists all configurations.\nArgs: category isAsync keyword name page pagesize",[]],"listUsageRecords":[["account","accountid","domainid","enddate","isAsync","keyword","page","pagesize","projectid","startdate","type"],"Lists usage records for accounts\nRequired args: enddate startdate\nArgs: account accountid domainid enddate isAsync keyword page pagesize projectid startdate type",["enddate","startdate"]],"listStoragePools":[["clusterid","id","ipaddress","isAsync","keyword","name","page","pagesize","path","podid","zoneid"],"Lists storage pools.\nArgs: clusterid id ipaddress isAsync keyword name page pagesize path podid zoneid",[]],"listSnapshots":[["account","domainid","id","intervaltype","isAsync","isrecursive","keyword","listall","name","page","pagesize","projectid","snapshottype","tags","volumeid"],"Lists all available snapshots for the account.\nArgs: account domainid id intervaltype isAsync isrecursive keyword listall name page pagesize projectid snapshottype tags volumeid",[]],"listZones":[["available","domainid","id","isAsync","keyword","page","pagesize","showcapacities"],"Lists zones\nArgs: available domainid id isAsync keyword page pagesize showcapacities",[]],"listServiceOfferings":[["domainid","id","isAsync","issystem","keyword","name","page","pagesize","systemvmtype","virtualmachineid"],"Lists all available service offerings.\nArgs: domainid id isAsync issystem keyword name page pagesize systemvmtype virtualmachineid",[]],"listCiscoNexusVSMs":[["clusterid","isAsync","keyword","page","pagesize","zoneid"],"Retrieves a Cisco Nexus 1000v Virtual Switch Manager device associated with a Cluster\nArgs: clusterid isAsync keyword page pagesize zoneid",[]],"listNetworkServiceProviders":[["isAsync","keyword","name","page","pagesize","physicalnetworkid","state"],"Lists network serviceproviders for a given physical network.\nArgs: isAsync keyword name page pagesize physicalnetworkid state",[]],"listCapacity":[["clusterid","fetchlatest","isAsync","keyword","page","pagesize","podid","sortby","type","zoneid"],"Lists all the system wide capacities.\nArgs: clusterid fetchlatest isAsync keyword page pagesize podid sortby type zoneid",[]],"listDiskOfferings":[["domainid","id","isAsync","keyword","name","page","pagesize"],"Lists all available disk offerings.\nArgs: domainid id isAsync keyword name page pagesize",[]],"listLBStickinessPolicies":[["isAsync","keyword","lbruleid","page","pagesize"],"Lists LBStickiness policies.\nRequired args: lbruleid\nArgs: isAsync keyword lbruleid page pagesize",["lbruleid"]],"listSrxFirewallNetworks":[["isAsync","keyword","lbdeviceid","page","pagesize"],"lists network that are using SRX firewall device\nRequired args: lbdeviceid\nArgs: isAsync keyword lbdeviceid page pagesize",["lbdeviceid"]],"listSecurityGroups":[["account","domainid","id","isAsync","isrecursive","keyword","listall","page","pagesize","projectid","securitygroupname","tags","virtualmachineid"],"Lists security groups\nArgs: account domainid id isAsync isrecursive keyword listall page pagesize projectid securitygroupname tags virtualmachineid",[]],"listConditions":[["account","counterid","domainid","id","isAsync","isrecursive","keyword","listall","page","pagesize","policyid"],"List Conditions for the specific user\nArgs: account counterid domainid id isAsync isrecursive keyword listall page pagesize policyid",[]],"listSwifts":[["id","isAsync","keyword","page","pagesize"],"List Swift.\nArgs: id isAsync keyword page pagesize",[]],"listHypervisorCapabilities":[["hypervisor","id","isAsync","keyword","page","pagesize"],"Lists all hypervisor capabilities.\nArgs: hypervisor id isAsync keyword page pagesize",[]],"listTags":[["account","customer","domainid","isAsync","isrecursive","key","keyword","listall","page","pagesize","projectid","resourceid","resourcetype","value"],"List resource tag(s)\nArgs: account customer domainid isAsync isrecursive key keyword listall page pagesize projectid resourceid resourcetype value",[]],"listRouters":[["account","domainid","forvpc","hostid","id","isAsync","isrecursive","keyword","listall","name","networkid","page","pagesize","podid","projectid","state","vpcid","zoneid"],"List routers.\nArgs: account domainid forvpc hostid id isAsync isrecursive keyword listall name networkid page pagesize podid projectid state vpcid zoneid",[]],"listTrafficTypes":[["isAsync","keyword","page","pagesize","physicalnetworkid"],"Lists traffic types of a given physical network.\nRequired args: physicalnetworkid\nArgs: isAsync keyword page pagesize physicalnetworkid",["physicalnetworkid"]],"listProjectInvitations":[["account","activeonly","domainid","id","isAsync","isrecursive","keyword","listall","page","pagesize","projectid","state"],"Lists projects and provides detailed information for listed projects\nArgs: account activeonly domainid id isAsync isrecursive keyword listall page pagesize projectid state",[]],"listIsos":[["account","bootable","domainid","hypervisor","id","isAsync","isofilter","ispublic","isready","isrecursive","keyword","listall","name","page","pagesize","projectid","tags","zoneid"],"Lists all available ISO files.\nArgs: account bootable domainid hypervisor id isAsync isofilter ispublic isready isrecursive keyword listall name page pagesize projectid tags zoneid",[]],"listUsers":[["account","accounttype","domainid","id","isAsync","isrecursive","keyword","listall","page","pagesize","state","username"],"Lists user accounts\nArgs: account accounttype domainid id isAsync isrecursive keyword listall page pagesize state username",[]],"listSSHKeyPairs":[["account","domainid","fingerprint","isAsync","isrecursive","keyword","listall","name","page","pagesize","projectid"],"List registered keypairs\nArgs: account domainid fingerprint isAsync isrecursive keyword listall name page pagesize projectid",[]],"listPrivateGateways":[["account","domainid","id","ipaddress","isAsync","isrecursive","keyword","listall","page","pagesize","projectid","state","vlan","vpcid"],"List private gateways\nArgs: account domainid id ipaddress isAsync isrecursive keyword listall page pagesize projectid state vlan vpcid",[]],"listUsageTypes":[["isAsync"],"List Usage Types\nArgs: isAsync",[]],"listDomainChildren":[["id","isAsync","isrecursive","keyword","listall","name","page","pagesize"],"Lists all children domains belonging to a specified domain\nArgs: id isAsync isrecursive keyword listall name page pagesize",[]],"listDomains":[["id","isAsync","keyword","level","listall","name","page","pagesize"],"Lists domains and provides detailed information for listed domains\nArgs: id isAsync keyword level listall name page pagesize",[]],"listExternalLoadBalancers":[["isAsync","keyword","page","pagesize","zoneid"],"Lists F5 external load balancer appliances added in a zone.\nArgs: isAsync keyword page pagesize zoneid",[]],"listNetscalerLoadBalancers":[["isAsync","keyword","lbdeviceid","page","pagesize","physicalnetworkid"],"lists netscaler load balancer devices\nArgs: isAsync keyword lbdeviceid page pagesize physicalnetworkid",[]],"listS3s":[["isAsync","keyword","page","pagesize"],"Lists S3s\nArgs: isAsync keyword page pagesize",[]],"listHypervisors":[["isAsync","zoneid"],"List hypervisors\nArgs: isAsync zoneid",[]],"listAccounts":[["accounttype","domainid","id","isAsync","isrecursive","keyword","listall","name","page","pagesize","state"],"Lists accounts and provides detailed account information for listed accounts\nArgs: accounttype domainid id isAsync isrecursive keyword listall name page pagesize state",[]],"listNetworkDevice":[["isAsync","keyword","networkdeviceparameterlist","networkdevicetype","page","pagesize"],"List network devices\nArgs: isAsync keyword networkdeviceparameterlist networkdevicetype page pagesize",[]],"listVlanIpRanges":[["account","domainid","forvirtualnetwork","id","isAsync","keyword","networkid","page","pagesize","physicalnetworkid","podid","projectid","vlan","zoneid"],"Lists all VLAN IP ranges.\nArgs: account domainid forvirtualnetwork id isAsync keyword networkid page pagesize physicalnetworkid podid projectid vlan zoneid",[]],"listTrafficTypeImplementors":[["isAsync","keyword","page","pagesize","traffictype"],"Lists implementors of implementor of a network traffic type or implementors of all network traffic types\nArgs: isAsync keyword page pagesize traffictype",[]],"listStorageNetworkIpRange":[["id","isAsync","keyword","page","pagesize","podid","zoneid"],"List a storage network IP range.\nArgs: id isAsync keyword page pagesize podid zoneid",[]],"listIsoPermissions":[["id","isAsync"],"List iso visibility and all accounts that have permissions to view this iso.\nRequired args: id\nArgs: id isAsync",["id"]],"listSnapshotPolicies":[["isAsync","keyword","page","pagesize","volumeid"],"Lists snapshot policies.\nRequired args: volumeid\nArgs: isAsync keyword page pagesize volumeid",["volumeid"]],"listAutoScaleVmGroups":[["account","domainid","id","isAsync","isrecursive","keyword","lbruleid","listall","page","pagesize","policyid","projectid","vmprofileid","zoneid"],"Lists autoscale vm groups.\nArgs: account domainid id isAsync isrecursive keyword lbruleid listall page pagesize policyid projectid vmprofileid zoneid",[]],"listProjectAccounts":[["account","isAsync","keyword","page","pagesize","projectid","role"],"Lists project's accounts\nRequired args: projectid\nArgs: account isAsync keyword page pagesize projectid role",["projectid"]],"listAutoScaleVmProfiles":[["account","domainid","id","isAsync","isrecursive","keyword","listall","otherdeployparams","page","pagesize","projectid","templateid"],"Lists autoscale vm profiles.\nArgs: account domainid id isAsync isrecursive keyword listall otherdeployparams page pagesize projectid templateid",[]],"listApis":[["isAsync","name"],"lists all available apis on the server, provided by the Api Discovery plugin\nArgs: isAsync name",[]],"listVPCs":[["account","cidr","displaytext","domainid","id","isAsync","isrecursive","keyword","listall","name","page","pagesize","projectid","state","supportedservices","tags","vpcofferingid","zoneid"],"Lists VPCs\nArgs: account cidr displaytext domainid id isAsync isrecursive keyword listall name page pagesize projectid state supportedservices tags vpcofferingid zoneid",[]],"listF5LoadBalancers":[["isAsync","keyword","lbdeviceid","page","pagesize","physicalnetworkid"],"lists F5 load balancer devices\nArgs: isAsync keyword lbdeviceid page pagesize physicalnetworkid",[]],"listVpnCustomerGateways":[["account","domainid","id","isAsync","isrecursive","keyword","listall","page","pagesize","projectid"],"Lists site to site vpn customer gateways\nArgs: account domainid id isAsync isrecursive keyword listall page pagesize projectid",[]],"listNetworkOfferings":[["availability","displaytext","forvpc","guestiptype","id","isAsync","isdefault","istagged","keyword","name","networkid","page","pagesize","sourcenatsupported","specifyipranges","specifyvlan","state","supportedservices","tags","traffictype","zoneid"],"Lists all available network offerings.\nArgs: availability displaytext forvpc guestiptype id isAsync isdefault istagged keyword name networkid page pagesize sourcenatsupported specifyipranges specifyvlan state supportedservices tags traffictype zoneid",[]],"listVirtualMachines":[["account","details","domainid","forvirtualnetwork","groupid","hostid","hypervisor","id","isAsync","isoid","isrecursive","keyword","listall","name","networkid","page","pagesize","podid","projectid","state","storageid","tags","templateid","vpcid","zoneid"],"List the virtual machines owned by the account.\nArgs: account details domainid forvirtualnetwork groupid hostid hypervisor id isAsync isoid isrecursive keyword listall name networkid page pagesize podid projectid state storageid tags templateid vpcid zoneid",[]],"listNetscalerLoadBalancerNetworks":[["isAsync","keyword","lbdeviceid","page","pagesize"],"lists network that are using a netscaler load balancer device\nRequired args: lbdeviceid\nArgs: isAsync keyword lbdeviceid page pagesize",["lbdeviceid"]],"listOsCategories":[["id","isAsync","keyword","name","page","pagesize"],"Lists all supported OS categories for this cloud.\nArgs: id isAsync keyword name page pagesize",[]],"listVirtualRouterElements":[["enabled","id","isAsync","keyword","nspid","page","pagesize"],"Lists all available virtual router elements.\nArgs: enabled id isAsync keyword nspid page pagesize",[]],"listLunsOnFiler":[["isAsync","poolname"],"List LUN\nRequired args: poolname\nArgs: isAsync poolname",["poolname"]],"listAsyncJobs":[["account","domainid","isAsync","isrecursive","keyword","listall","page","pagesize","startdate"],"Lists all pending asynchronous jobs for the account.\nArgs: account domainid isAsync isrecursive keyword listall page pagesize startdate",[]],"listOsTypes":[["description","id","isAsync","keyword","oscategoryid","page","pagesize"],"Lists all supported OS types for this cloud.\nArgs: description id isAsync keyword oscategoryid page pagesize",[]],"listNetworkACLs":[["account","domainid","id","isAsync","isrecursive","keyword","listall","networkid","page","pagesize","projectid","tags","traffictype"],"Lists all network ACLs\nArgs: account domainid id isAsync isrecursive keyword listall networkid page pagesize projectid tags traffictype",[]],"listVolumesOnFiler":[["isAsync","poolname"],"List Volumes\nRequired args: poolname\nArgs: isAsync poolname",["poolname"]],"listEventTypes":[["isAsync"],"List Event Types\nArgs: isAsync",[]],"listRemoteAccessVpns":[["account","domainid","isAsync","isrecursive","keyword","listall","page","pagesize","projectid","publicipid"],"Lists remote access vpns\nRequired args: publicipid\nArgs: account domainid isAsync isrecursive keyword listall page pagesize projectid publicipid",["publicipid"]],"listAlerts":[["id","isAsync","keyword","page","pagesize","type"],"Lists all alerts.\nArgs: id isAsync keyword page pagesize type",[]],"listVPCOfferings":[["displaytext","id","isAsync","isdefault","keyword","name","page","pagesize","state","supportedservices"],"Lists VPC offerings\nArgs: displaytext id isAsync isdefault keyword name page pagesize state supportedservices",[]],"listNiciraNvpDeviceNetworks":[["isAsync","keyword","nvpdeviceid","page","pagesize"],"lists network that are using a nicira nvp device\nRequired args: nvpdeviceid\nArgs: isAsync keyword nvpdeviceid page pagesize",["nvpdeviceid"]],"listEvents":[["account","domainid","duration","enddate","entrytime","id","isAsync","isrecursive","keyword","level","listall","page","pagesize","projectid","startdate","type"],"A command to list events.\nArgs: account domainid duration enddate entrytime id isAsync isrecursive keyword level listall page pagesize projectid startdate type",[]],"listTemplates":[["account","domainid","hypervisor","id","isAsync","isrecursive","keyword","listall","name","page","pagesize","projectid","tags","templatefilter","zoneid"],"List all public, private, and privileged templates.\nRequired args: templatefilter\nArgs: account domainid hypervisor id isAsync isrecursive keyword listall name page pagesize projectid tags templatefilter zoneid",["templatefilter"]],"listPublicIpAddresses":[["account","allocatedonly","associatednetworkid","domainid","forloadbalancing","forvirtualnetwork","id","ipaddress","isAsync","isrecursive","issourcenat","isstaticnat","keyword","listall","page","pagesize","physicalnetworkid","projectid","tags","vlanid","vpcid","zoneid"],"Lists all public ip addresses\nArgs: account allocatedonly associatednetworkid domainid forloadbalancing forvirtualnetwork id ipaddress isAsync isrecursive issourcenat isstaticnat keyword listall page pagesize physicalnetworkid projectid tags vlanid vpcid zoneid",[]],"listIpForwardingRules":[["account","domainid","id","ipaddressid","isAsync","isrecursive","keyword","listall","page","pagesize","projectid","virtualmachineid"],"List the ip forwarding rules\nArgs: account domainid id ipaddressid isAsync isrecursive keyword listall page pagesize projectid virtualmachineid",[]],"listSrxFirewalls":[["fwdeviceid","isAsync","keyword","page","pagesize","physicalnetworkid"],"lists SRX firewall devices in a physical network\nArgs: fwdeviceid isAsync keyword page pagesize physicalnetworkid",[]],"listVpnConnections":[["account","domainid","id","isAsync","isrecursive","keyword","listall","page","pagesize","projectid","vpcid"],"Lists site to site vpn connection gateways\nArgs: account domainid id isAsync isrecursive keyword listall page pagesize projectid vpcid",[]],"listTrafficMonitors":[["isAsync","keyword","page","pagesize","zoneid"],"List traffic monitor Hosts.\nRequired args: zoneid\nArgs: isAsync keyword page pagesize zoneid",["zoneid"]],"listVpnUsers":[["account","domainid","id","isAsync","isrecursive","keyword","listall","page","pagesize","projectid","username"],"Lists vpn users\nArgs: account domainid id isAsync isrecursive keyword listall page pagesize projectid username",[]],"listStaticRoutes":[["account","domainid","gatewayid","id","isAsync","isrecursive","keyword","listall","page","pagesize","projectid","tags","vpcid"],"Lists all static routes\nArgs: account domainid gatewayid id isAsync isrecursive keyword listall page pagesize projectid tags vpcid",[]],"listVolumes":[["account","domainid","hostid","id","isAsync","isrecursive","keyword","listall","name","page","pagesize","podid","projectid","tags","type","virtualmachineid","zoneid"],"Lists all volumes.\nArgs: account domainid hostid id isAsync isrecursive keyword listall name page pagesize podid projectid tags type virtualmachineid zoneid",[]],"listPods":[["allocationstate","id","isAsync","keyword","name","page","pagesize","showcapacities","zoneid"],"Lists all Pods.\nArgs: allocationstate id isAsync keyword name page pagesize showcapacities zoneid",[]],"uploadVolume":[["account","checksum","domainid","format","isAsync","name","url","zoneid"],"Uploads a data disk.\nRequired args: format name url zoneid\nArgs: account checksum domainid format isAsync name url zoneid",["format","name","url","zoneid"]],"uploadCustomCertificate":[["certificate","domainsuffix","id","isAsync","name","privatekey"],"Uploads a custom certificate for the console proxy VMs to use for SSL. Can be used to upload a single certificate signed by a known CA. Can also be used, through multiple calls, to upload a chain of certificates from CA to the custom certificate itself.\nRequired args: certificate domainsuffix\nArgs: certificate domainsuffix id isAsync name privatekey",["certificate","domainsuffix"]],"removeFromLoadBalancerRule":[["id","isAsync","virtualmachineids"],"Removes a virtual machine or a list of virtual machines from a load balancer rule.\nRequired args: id virtualmachineids\nArgs: id isAsync virtualmachineids",["id","virtualmachineids"]],"removeVpnUser":[["account","domainid","isAsync","projectid","username"],"Removes vpn user\nRequired args: username\nArgs: account domainid isAsync projectid username",["username"]],"deleteLoadBalancerRule":[["id","isAsync"],"Deletes a load balancer rule.\nRequired args: id\nArgs: id isAsync",["id"]],"deleteProjectInvitation":[["id","isAsync"],"Accepts or declines project invitation\nRequired args: id\nArgs: id isAsync",["id"]],"deleteSecurityGroup":[["account","domainid","id","isAsync","name","projectid"],"Deletes security group\nArgs: account domainid id isAsync name projectid",[]],"deleteAccountFromProject":[["account","isAsync","projectid"],"Deletes account from the project\nRequired args: account projectid\nArgs: account isAsync projectid",["account","projectid"]],"deleteNetworkDevice":[["id","isAsync"],"Deletes network device.\nRequired args: id\nArgs: id isAsync",["id"]],"deletePod":[["id","isAsync"],"Deletes a Pod.\nRequired args: id\nArgs: id isAsync",["id"]],"deleteSrxFirewall":[["fwdeviceid","isAsync"],"delete a SRX firewall device\nRequired args: fwdeviceid\nArgs: fwdeviceid isAsync",["fwdeviceid"]],"deleteSnapshotPolicies":[["id","ids","isAsync"],"Deletes snapshot policies for the account.\nArgs: id ids isAsync",[]],"deleteZone":[["id","isAsync"],"Deletes a Zone.\nRequired args: id\nArgs: id isAsync",["id"]],"deleteNiciraNvpDevice":[["isAsync","nvpdeviceid"],"delete a nicira nvp device\nRequired args: nvpdeviceid\nArgs: isAsync nvpdeviceid",["nvpdeviceid"]],"deleteStoragePool":[["forced","id","isAsync"],"Deletes a storage pool.\nRequired args: id\nArgs: forced id isAsync",["id"]],"deleteVpnGateway":[["id","isAsync"],"Delete site to site vpn gateway\nRequired args: id\nArgs: id isAsync",["id"]],"deleteAutoScaleVmGroup":[["id","isAsync"],"Deletes a autoscale vm group.\nRequired args: id\nArgs: id isAsync",["id"]],"deleteTrafficMonitor":[["id","isAsync"],"Deletes an traffic monitor host.\nRequired args: id\nArgs: id isAsync",["id"]],"deletePrivateGateway":[["id","isAsync"],"Deletes a Private gateway\nRequired args: id\nArgs: id isAsync",["id"]],"deleteVolume":[["id","isAsync"],"Deletes a detached disk volume.\nRequired args: id\nArgs: id isAsync",["id"]],"deleteVPC":[["id","isAsync"],"Deletes a VPC\nRequired args: id\nArgs: id isAsync",["id"]],"deleteCondition":[["id","isAsync"],"Removes a condition\nRequired args: id\nArgs: id isAsync",["id"]],"deleteAutoScaleVmProfile":[["id","isAsync"],"Deletes a autoscale vm profile.\nRequired args: id\nArgs: id isAsync",["id"]],"deleteAccount":[["id","isAsync"],"Deletes a account, and all users associated with this account\nRequired args: id\nArgs: id isAsync",["id"]],"deleteFirewallRule":[["id","isAsync"],"Deletes a firewall rule\nRequired args: id\nArgs: id isAsync",["id"]],"deleteNetworkOffering":[["id","isAsync"],"Deletes a network offering.\nRequired args: id\nArgs: id isAsync",["id"]],"deleteVpnCustomerGateway":[["id","isAsync"],"Delete site to site vpn customer gateway\nRequired args: id\nArgs: id isAsync",["id"]],"deleteProject":[["id","isAsync"],"Deletes a project\nRequired args: id\nArgs: id isAsync",["id"]],"deletePhysicalNetwork":[["id","isAsync"],"Deletes a Physical Network.\nRequired args: id\nArgs: id isAsync",["id"]],"deleteDomain":[["cleanup","id","isAsync"],"Deletes a specified domain\nRequired args: id\nArgs: cleanup id isAsync",["id"]],"deleteDiskOffering":[["id","isAsync"],"Updates a disk offering.\nRequired args: id\nArgs: id isAsync",["id"]],"deleteExternalLoadBalancer":[["id","isAsync"],"Deletes a F5 external load balancer appliance added in a zone.\nRequired args: id\nArgs: id isAsync",["id"]],"deletePortForwardingRule":[["id","isAsync"],"Deletes a port forwarding rule\nRequired args: id\nArgs: id isAsync",["id"]],"deleteCluster":[["id","isAsync"],"Deletes a cluster.\nRequired args: id\nArgs: id isAsync",["id"]],"deleteIpForwardingRule":[["id","isAsync"],"Deletes an ip forwarding rule\nRequired args: id\nArgs: id isAsync",["id"]],"deleteVpnConnection":[["id","isAsync"],"Delete site to site vpn connection\nRequired args: id\nArgs: id isAsync",["id"]],"deleteLBStickinessPolicy":[["id","isAsync"],"Deletes a LB stickiness policy.\nRequired args: id\nArgs: id isAsync",["id"]],"deleteVPCOffering":[["id","isAsync"],"Deletes VPC offering\nRequired args: id\nArgs: id isAsync",["id"]],"deleteNetwork":[["id","isAsync"],"Deletes a network\nRequired args: id\nArgs: id isAsync",["id"]],"deleteRemoteAccessVpn":[["isAsync","publicipid"],"Destroys a l2tp/ipsec remote access vpn\nRequired args: publicipid\nArgs: isAsync publicipid",["publicipid"]],"deleteInstanceGroup":[["id","isAsync"],"Deletes a vm group\nRequired args: id\nArgs: id isAsync",["id"]],"deleteAutoScalePolicy":[["id","isAsync"],"Deletes a autoscale policy.\nRequired args: id\nArgs: id isAsync",["id"]],"deleteServiceOffering":[["id","isAsync"],"Deletes a service offering.\nRequired args: id\nArgs: id isAsync",["id"]],"deleteTemplate":[["id","isAsync","zoneid"],"Deletes a template from the system. All virtual machines using the deleted template will not be affected.\nRequired args: id\nArgs: id isAsync zoneid",["id"]],"deleteSnapshot":[["id","isAsync"],"Deletes a snapshot of a disk volume.\nRequired args: id\nArgs: id isAsync",["id"]],"deleteNetworkACL":[["id","isAsync"],"Deletes a Network ACL\nRequired args: id\nArgs: id isAsync",["id"]],"deleteTags":[["isAsync","resourceids","resourcetype","tags"],"Deleting resource tag(s)\nRequired args: resourceids resourcetype\nArgs: isAsync resourceids resourcetype tags",["resourceids","resourcetype"]],"deleteStaticRoute":[["id","isAsync"],"Deletes a static route\nRequired args: id\nArgs: id isAsync",["id"]],"deleteTrafficType":[["id","isAsync"],"Deletes traffic type of a physical network\nRequired args: id\nArgs: id isAsync",["id"]],"deleteHost":[["forced","forcedestroylocalstorage","id","isAsync"],"Deletes a host.\nRequired args: id\nArgs: forced forcedestroylocalstorage id isAsync",["id"]],"deleteUser":[["id","isAsync"],"Creates a user for an account\nRequired args: id\nArgs: id isAsync",["id"]],"deleteStorageNetworkIpRange":[["id","isAsync"],"Deletes a storage network IP Range.\nRequired args: id\nArgs: id isAsync",["id"]],"deleteExternalFirewall":[["id","isAsync"],"Deletes an external firewall appliance.\nRequired args: id\nArgs: id isAsync",["id"]],"deletePool":[["isAsync","poolname"],"Delete a pool\nRequired args: poolname\nArgs: isAsync poolname",["poolname"]],"deleteCiscoNexusVSM":[["id","isAsync"],"delete a Cisco Nexus VSM device\nRequired args: id\nArgs: id isAsync",["id"]],"deleteNetscalerLoadBalancer":[["isAsync","lbdeviceid"],"delete a netscaler load balancer device\nRequired args: lbdeviceid\nArgs: isAsync lbdeviceid",["lbdeviceid"]],"deleteVlanIpRange":[["id","isAsync"],"Creates a VLAN IP range.\nRequired args: id\nArgs: id isAsync",["id"]],"deleteCounter":[["id","isAsync"],"Deletes a counter\nRequired args: id\nArgs: id isAsync",["id"]],"deleteF5LoadBalancer":[["isAsync","lbdeviceid"],"delete a F5 load balancer device\nRequired args: lbdeviceid\nArgs: isAsync lbdeviceid",["lbdeviceid"]],"deleteIso":[["id","isAsync","zoneid"],"Deletes an ISO file.\nRequired args: id\nArgs: id isAsync zoneid",["id"]],"deleteNetworkServiceProvider":[["id","isAsync"],"Deletes a Network Service Provider.\nRequired args: id\nArgs: id isAsync",["id"]],"deleteSSHKeyPair":[["account","domainid","isAsync","name","projectid"],"Deletes a keypair by name\nRequired args: name\nArgs: account domainid isAsync name projectid",["name"]],"activateProject":[["id","isAsync"],"Activates a project\nRequired args: id\nArgs: id isAsync",["id"]],"migrateSystemVm":[["hostid","isAsync","virtualmachineid"],"Attempts Migration of a system virtual machine to the host specified.\nRequired args: hostid virtualmachineid\nArgs: hostid isAsync virtualmachineid",["hostid","virtualmachineid"]],"migrateVolume":[["isAsync","storageid","volumeid"],"Migrate volume\nRequired args: storageid volumeid\nArgs: isAsync storageid volumeid",["storageid","volumeid"]],"migrateVirtualMachine":[["hostid","isAsync","storageid","virtualmachineid"],"Attempts Migration of a VM to a different host or Root volume of the vm to a different storage pool\nRequired args: virtualmachineid\nArgs: hostid isAsync storageid virtualmachineid",["virtualmachineid"]],"lockAccount":[["account","domainid","isAsync"],"Locks an account\nRequired args: account domainid\nArgs: account domainid isAsync",["account","domainid"]],"lockUser":[["id","isAsync"],"Locks a user account\nRequired args: id\nArgs: id isAsync",["id"]],"recoverVirtualMachine":[["id","isAsync"],"Recovers a virtual machine.\nRequired args: id\nArgs: id isAsync",["id"]],"extractVolume":[["id","isAsync","mode","url","zoneid"],"Extracts volume\nRequired args: id mode zoneid\nArgs: id isAsync mode url zoneid",["id","mode","zoneid"]],"extractIso":[["id","isAsync","mode","url","zoneid"],"Extracts an ISO\nRequired args: id mode\nArgs: id isAsync mode url zoneid",["id","mode"]],"extractTemplate":[["id","isAsync","mode","url","zoneid"],"Extracts a template\nRequired args: id mode\nArgs: id isAsync mode url zoneid",["id","mode"]],"deployVirtualMachine":[["account","diskofferingid","displayname","domainid","group","hostid","hypervisor","ipaddress","iptonetworklist","isAsync","keyboard","keypair","name","networkids","projectid","securitygroupids","securitygroupnames","serviceofferingid","size","startvm","templateid","userdata","zoneid"],"Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.\nRequired args: serviceofferingid templateid zoneid\nArgs: account diskofferingid displayname domainid group hostid hypervisor ipaddress iptonetworklist isAsync keyboard keypair name networkids projectid securitygroupids securitygroupnames serviceofferingid size startvm templateid userdata zoneid",["serviceofferingid","templateid","zoneid"]],"rebootSystemVm":[["id","isAsync"],"Reboots a system VM.\nRequired args: id\nArgs: id isAsync",["id"]],"rebootRouter":[["id","isAsync"],"Starts a router.\nRequired args: id\nArgs: id isAsync",["id"]],"rebootVirtualMachine":[["id","isAsync"],"Reboots a virtual machine.\nRequired args: id\nArgs: id isAsync",["id"]],"destroySystemVm":[["id","isAsync"],"Destroyes a system virtual machine.\nRequired args: id\nArgs: id isAsync",["id"]],"destroyRouter":[["id","isAsync"],"Destroys a router.\nRequired args: id\nArgs: id isAsync",["id"]],"destroyVolumeOnFiler":[["aggregatename","ipaddress","isAsync","volumename"],"Destroy a Volume\nRequired args: aggregatename ipaddress volumename\nArgs: aggregatename ipaddress isAsync volumename",["aggregatename","ipaddress","volumename"]],"destroyLunOnFiler":[["isAsync","path"],"Destroy a LUN\nRequired args: path\nArgs: isAsync path",["path"]],"destroyVirtualMachine":[["id","isAsync"],"Destroys a virtual machine. Once destroyed, only the administrator can recover it.\nRequired args: id\nArgs: id isAsync",["id"]],"associateIpAddress":[["account","domainid","isAsync","networkid","projectid","vpcid","zoneid"],"Acquires and associates a public IP to an account.\nArgs: account domainid isAsync networkid projectid vpcid zoneid",[]],"associateLun":[["iqn","isAsync","name"],"Associate a LUN with a guest IQN\nRequired args: iqn name\nArgs: iqn isAsync name",["iqn","name"]],"modifyPool":[["algorithm","isAsync","poolname"],"Modify pool\nRequired args: algorithm poolname\nArgs: algorithm isAsync poolname",["algorithm","poolname"]],"updateLoadBalancerRule":[["algorithm","description","id","isAsync","name"],"Updates load balancer\nRequired args: id\nArgs: algorithm description id isAsync name",["id"]],"updateDomain":[["id","isAsync","name","networkdomain"],"Updates a domain with a new name\nRequired args: id\nArgs: id isAsync name networkdomain",["id"]],"updateInstanceGroup":[["id","isAsync","name"],"Updates a vm group\nRequired args: id\nArgs: id isAsync name",["id"]],"updateDiskOffering":[["displaytext","id","isAsync","name","sortkey"],"Updates a disk offering.\nRequired args: id\nArgs: displaytext id isAsync name sortkey",["id"]],"updateVirtualMachine":[["displayname","group","haenable","id","isAsync","ostypeid","userdata"],"Updates properties of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect. UpdateVirtualMachine does not first check whether the VM is stopped. Therefore, stop the VM manually before issuing this call.\nRequired args: id\nArgs: displayname group haenable id isAsync ostypeid userdata",["id"]],"updateVPCOffering":[["displaytext","id","isAsync","name","state"],"Updates VPC offering\nArgs: displaytext id isAsync name state",[]],"updatePortForwardingRule":[["ipaddressid","isAsync","privateip","privateport","protocol","publicport","virtualmachineid"],"Updates a port forwarding rule.  Only the private port and the virtual machine can be updated.\nRequired args: ipaddressid privateport protocol publicport\nArgs: ipaddressid isAsync privateip privateport protocol publicport virtualmachineid",["ipaddressid","privateport","protocol","publicport"]],"updateCluster":[["allocationstate","clustername","clustertype","hypervisor","id","isAsync","managedstate"],"Updates an existing cluster\nRequired args: id\nArgs: allocationstate clustername clustertype hypervisor id isAsync managedstate",["id"]],"updateHost":[["allocationstate","hosttags","id","isAsync","oscategoryid","url"],"Updates a host.\nRequired args: id\nArgs: allocationstate hosttags id isAsync oscategoryid url",["id"]],"updateUser":[["email","firstname","id","isAsync","lastname","password","timezone","userapikey","username","usersecretkey"],"Updates a user account\nRequired args: id\nArgs: email firstname id isAsync lastname password timezone userapikey username usersecretkey",["id"]],"updateVPC":[["displaytext","id","isAsync","name"],"Updates a VPC\nArgs: displaytext id isAsync name",[]],"updateHostPassword":[["clusterid","hostid","isAsync","password","username"],"Update password of a host/pool on management server.\nRequired args: password username\nArgs: clusterid hostid isAsync password username",["password","username"]],"updatePod":[["allocationstate","endip","gateway","id","isAsync","name","netmask","startip"],"Updates a Pod.\nRequired args: id\nArgs: allocationstate endip gateway id isAsync name netmask startip",["id"]],"updateConfiguration":[["isAsync","name","value"],"Updates a configuration.\nRequired args: name\nArgs: isAsync name value",["name"]],"updateStorageNetworkIpRange":[["endip","id","isAsync","netmask","startip","vlan"],"Update a Storage network IP range, only allowed when no IPs in this range have been allocated.\nRequired args: id\nArgs: endip id isAsync netmask startip vlan",["id"]],"updateIsoPermissions":[["accounts","id","isAsync","isextractable","isfeatured","ispublic","op","projectids"],"Updates iso permissions\nRequired args: id\nArgs: accounts id isAsync isextractable isfeatured ispublic op projectids",["id"]],"updateResourceLimit":[["account","domainid","isAsync","max","projectid","resourcetype"],"Updates resource limits for an account or domain.\nRequired args: resourcetype\nArgs: account domainid isAsync max projectid resourcetype",["resourcetype"]],"updateTrafficType":[["id","isAsync","kvmnetworklabel","vmwarenetworklabel","xennetworklabel"],"Updates traffic type of a physical network\nRequired args: id\nArgs: id isAsync kvmnetworklabel vmwarenetworklabel xennetworklabel",["id"]],"updateAccount":[["account","accountdetails","domainid","id","isAsync","networkdomain","newname"],"Updates account information for the authenticated user\nRequired args: newname\nArgs: account accountdetails domainid id isAsync networkdomain newname",["newname"]],"updateStoragePool":[["id","isAsync","tags"],"Updates a storage pool.\nRequired args: id\nArgs: id isAsync tags",["id"]],"updateResourceCount":[["account","domainid","isAsync","projectid","resourcetype"],"Recalculate and update resource count for an account or domain.\nRequired args: domainid\nArgs: account domainid isAsync projectid resourcetype",["domainid"]],"updateNetwork":[["changecidr","displaytext","id","isAsync","name","networkdomain","networkofferingid"],"Updates a network\nRequired args: id\nArgs: changecidr displaytext id isAsync name networkdomain networkofferingid",["id"]],"updateZone":[["allocationstate","details","dhcpprovider","dns1","dns2","dnssearchorder","domain","guestcidraddress","id","internaldns1","internaldns2","isAsync","ispublic","localstorageenabled","name"],"Updates a Zone.\nRequired args: id\nArgs: allocationstate details dhcpprovider dns1 dns2 dnssearchorder domain guestcidraddress id internaldns1 internaldns2 isAsync ispublic localstorageenabled name",["id"]],"updateNetworkOffering":[["availability","displaytext","id","isAsync","name","sortkey","state"],"Updates a network offering.\nArgs: availability displaytext id isAsync name sortkey state",[]],"updatePhysicalNetwork":[["id","isAsync","networkspeed","state","tags","vlan"],"Updates a physical network\nRequired args: id\nArgs: id isAsync networkspeed state tags vlan",["id"]],"updateProjectInvitation":[["accept","account","isAsync","projectid","token"],"Accepts or declines project invitation\nRequired args: projectid\nArgs: accept account isAsync projectid token",["projectid"]],"updateAutoScalePolicy":[["conditionids","duration","id","isAsync","quiettime"],"Updates an existing autoscale policy.\nRequired args: id\nArgs: conditionids duration id isAsync quiettime",["id"]],"updateTemplatePermissions":[["accounts","id","isAsync","isextractable","isfeatured","ispublic","op","projectids"],"Updates a template visibility permissions. A public template is visible to all accounts within the same domain. A private template is visible only to the owner of the template. A priviledged template is a private template with account permissions added. Only accounts specified under the template permissions are visible to them.\nRequired args: id\nArgs: accounts id isAsync isextractable isfeatured ispublic op projectids",["id"]],"updateProject":[["account","displaytext","id","isAsync"],"Updates a project\nRequired args: id\nArgs: account displaytext id isAsync",["id"]],"updateVpnCustomerGateway":[["account","cidrlist","domainid","dpd","esplifetime","esppolicy","gateway","id","ikelifetime","ikepolicy","ipsecpsk","isAsync","name"],"Update site to site vpn customer gateway\nRequired args: id cidrlist esppolicy gateway ikepolicy ipsecpsk\nArgs: account cidrlist domainid dpd esplifetime esppolicy gateway id ikelifetime ikepolicy ipsecpsk isAsync name",["id","cidrlist","esppolicy","gateway","ikepolicy","ipsecpsk"]],"updateServiceOffering":[["displaytext","id","isAsync","name","sortkey"],"Updates a service offering.\nRequired args: id\nArgs: displaytext id isAsync name sortkey",["id"]],"updateTemplate":[["bootable","displaytext","format","id","isAsync","name","ostypeid","passwordenabled","sortkey"],"Updates attributes of a template.\nRequired args: id\nArgs: bootable displaytext format id isAsync name ostypeid passwordenabled sortkey",["id"]],"updateIso":[["bootable","displaytext","format","id","isAsync","name","ostypeid","passwordenabled","sortkey"],"Updates an ISO file.\nRequired args: id\nArgs: bootable displaytext format id isAsync name ostypeid passwordenabled sortkey",["id"]],"updateNetworkServiceProvider":[["id","isAsync","servicelist","state"],"Updates a network serviceProvider of a physical network\nRequired args: id\nArgs: id isAsync servicelist state",["id"]],"updateAutoScaleVmProfile":[["autoscaleuserid","counterparam","destroyvmgraceperiod","id","isAsync","templateid"],"Updates an existing autoscale vm profile.\nRequired args: id\nArgs: autoscaleuserid counterparam destroyvmgraceperiod id isAsync templateid",["id"]],"updateHypervisorCapabilities":[["id","isAsync","maxguestslimit","securitygroupenabled"],"Updates a hypervisor capabilities.\nArgs: id isAsync maxguestslimit securitygroupenabled",[]],"updateAutoScaleVmGroup":[["id","interval","isAsync","maxmembers","minmembers","scaledownpolicyids","scaleuppolicyids"],"Updates an existing autoscale vm group.\nRequired args: id\nArgs: id interval isAsync maxmembers minmembers scaledownpolicyids scaleuppolicyids",["id"]],"disableAccount":[["account","domainid","id","isAsync","lock"],"Disables an account\nRequired args: lock\nArgs: account domainid id isAsync lock",["lock"]],"disableAutoScaleVmGroup":[["id","isAsync"],"Disables an AutoScale Vm Group\nRequired args: id\nArgs: id isAsync",["id"]],"disableCiscoNexusVSM":[["id","isAsync"],"disable a Cisco Nexus VSM device\nRequired args: id\nArgs: id isAsync",["id"]],"disableStaticNat":[["ipaddressid","isAsync"],"Disables static rule for given ip address\nRequired args: ipaddressid\nArgs: ipaddressid isAsync",["ipaddressid"]],"disableUser":[["id","isAsync"],"Disables a user account\nRequired args: id\nArgs: id isAsync",["id"]],"generateUsageRecords":[["domainid","enddate","isAsync","startdate"],"Generates usage records. This will generate records only if there any records to be generated, i.e if the scheduled usage job was not run or failed\nRequired args: enddate startdate\nArgs: domainid enddate isAsync startdate",["enddate","startdate"]],"changeServiceForVirtualMachine":[["id","isAsync","serviceofferingid"],"Changes the service offering for a virtual machine. The virtual machine must be in a \"Stopped\" state for this command to take effect.\nRequired args: id serviceofferingid\nArgs: id isAsync serviceofferingid",["id","serviceofferingid"]],"changeServiceForSystemVm":[["id","isAsync","serviceofferingid"],"Changes the service offering for a system vm (console proxy or secondary storage). The system vm must be in a \"Stopped\" state for this command to take effect.\nRequired args: id serviceofferingid\nArgs: id isAsync serviceofferingid",["id","serviceofferingid"]],"changeServiceForRouter":[["id","isAsync","serviceofferingid"],"Upgrades domain router to a new service offering\nRequired args: id serviceofferingid\nArgs: id isAsync serviceofferingid",["id","serviceofferingid"]],"registerUserKeys":[["id","isAsync"],"This command allows a user to register for the developer API, returning a secret key and an API key. This request is made through the integration API port, so it is a privileged command and must be made on behalf of a user. It is up to the implementer just how the username and password are entered, and then how that translates to an integration API request. Both secret key and API key should be returned to the user\nRequired args: id\nArgs: id isAsync",["id"]],"registerIso":[["account","bootable","checksum","displaytext","domainid","isAsync","isextractable","isfeatured","ispublic","name","ostypeid","projectid","url","zoneid"],"Registers an existing ISO into the CloudStack Cloud.\nRequired args: displaytext name url zoneid\nArgs: account bootable checksum displaytext domainid isAsync isextractable isfeatured ispublic name ostypeid projectid url zoneid",["displaytext","name","url","zoneid"]],"registerSSHKeyPair":[["account","domainid","isAsync","name","projectid","publickey"],"Register a public key in a keypair under a certain name\nRequired args: name publickey\nArgs: account domainid isAsync name projectid publickey",["name","publickey"]],"registerTemplate":[["account","bits","checksum","details","displaytext","domainid","format","hypervisor","isAsync","isextractable","isfeatured","ispublic","name","ostypeid","passwordenabled","projectid","requireshvm","sshkeyenabled","templatetag","url","zoneid"],"Registers an existing template into the CloudStack cloud.\nRequired args: displaytext format hypervisor name ostypeid url zoneid\nArgs: account bits checksum details displaytext domainid format hypervisor isAsync isextractable isfeatured ispublic name ostypeid passwordenabled projectid requireshvm sshkeyenabled templatetag url zoneid",["displaytext","format","hypervisor","name","ostypeid","url","zoneid"]],"assignToLoadBalancerRule":[["id","isAsync","virtualmachineids"],"Assigns virtual machine or a list of virtual machines to a load balancer rule.\nRequired args: id virtualmachineids\nArgs: id isAsync virtualmachineids",["id","virtualmachineids"]],"assignVirtualMachine":[["account","domainid","isAsync","networkids","securitygroupids","virtualmachineid"],"Move a user VM to another user under same domain.\nRequired args: account domainid virtualmachineid\nArgs: account domainid isAsync networkids securitygroupids virtualmachineid",["account","domainid","virtualmachineid"]]}

data/lib/cloudn_cli/client.rb

@@ -0,0 +1,103 @@
+require "open-uri"
+require "openssl"
+require "base64"
+require "json" #XXX: should i use Crack::JSON?
+require "crack"
+
+module Cloudn
+  class Client
+    def initialize(opt)
+      @api_key    = opt[:api_key].freeze
+      @secret_key = opt[:secret_key].freeze
+      url = opt[:url]
+      @url = url.is_a?(URI::HTTP) ? url : URI.parse(url)
+      @url.freeze      
+      @api_location = opt[:api_location].freeze
+      @json       = opt[:json].freeze
+    end
+
+    attr_reader :json, :api_location
+
+    def get_raw(param_hash)
+      param_str = make_param_str(param_hash)
+      url = @url.dup
+      url.query = param_str
+      begin
+        response_text = OpenURI.open_uri(url,
+	:ssl_verify_mode => OpenSSL::SSL::VERIFY_NONE,
+        "User-Agent" => "Cloudn_cli/#{RUBY_VERSION}",
+        "X-api-location" => @api_location
+        ).read
+      rescue OpenURI::HTTPError => ex
+        raise ex.exception("status: #{ex.message} desc: #{ex.io.meta["x-description"]}") # update error message in detail
+      end
+      return response_text
+    end
+
+    def get(param_hash)
+      response_text = get_raw(param_hash)
+      response = @json ? JSON.parse(response_text) : Crack::XML.parse(response_text)
+      command = param_hash.fetch(:command).to_s
+      command.downcase!
+      key = command + "response"
+      begin
+        result = response.fetch(key)
+      rescue KeyError => ex
+        case key
+        when "restorevirtualmachineresponse"
+          key = "restorevmresponse"
+        else
+          raise ex
+        end
+        retry
+      end
+      return result
+    end
+
+    private
+
+    def hash_to_param_str(param_hash)
+      sorted_params = param_hash.sort_by(&:first) # sort by key
+      param_str = sorted_params.flat_map {|k, v| "#{k}=#{v}" }.join("&")
+      #return param_str
+      string = URI.encode(param_str)
+      #string = CGI::escape(param_str)
+      string = string.gsub("/","%2f")
+      string = string.gsub(":","%3a")
+      string = string.gsub("[","%5b")
+      string = string.gsub("]","%5d")
+      pp string
+      return string
+    end
+
+    def string_to_sign(param_hash)
+      param_hash = param_hash.merge(apikey: @api_key)
+      param_str = hash_to_param_str(param_hash)
+      param_str.downcase!
+      return param_str
+    end
+
+    def sign(param_hash)
+      param_str = string_to_sign(param_hash)
+      hmac = ::OpenSSL::HMAC::digest(::OpenSSL::Digest::SHA1.new, @secret_key, param_str)
+      base64 = Base64.encode64(hmac).chomp
+      return URI.encode(base64, "+=")
+    end
+
+    def make_param_str(param_hash)
+      param_hash.merge!(response: :json) if @json
+      signature = sign(param_hash)
+      param_str = hash_to_param_str(param_hash)
+      param_str.concat("&apiKey=#{@api_key}&signature=#{signature}")
+      return param_str
+    end
+  end
+end
+
+if $PROGRAM_NAME == __FILE__
+  require "pp"
+
+  config = YAML.load_file("config.yml")
+  cs = Cloudn::Client.new(config)
+  pp cs.get(command: :listServiceOfferings)
+end

data/lib/cloudn_cli/shell.rb

@@ -0,0 +1,296 @@
+require "readline"
+require "pp"
+require "termcolor" # for simple colorize
+require "coderay"   # for syntax highlight
+require "rexml/document"
+require "erb"
+require "open-uri"
+require "cgi"
+require_relative "client"
+
+module Cloudn
+  class User
+    def initialize(name, opt)
+      @name       = name.freeze
+      @api_key    = opt[:api_key].freeze
+      @secret_key = opt[:secret_key].freeze
+      url = opt[:url]
+      @url = url.is_a?(URI::HTTP) ? url : URI.parse(url)
+      @url.freeze      
+      @api_location = opt[:api_location].freeze
+    end
+
+    attr_reader :name, :api_key, :secret_key, :url, :api_location
+  end
+
+  class Shell
+    class SyntaxError < StandardError; end
+
+    def initialize(config_path)
+      @config_path = config_path.freeze
+      @xml_formatter = REXML::Formatters::Pretty.new(2)
+      @xml_formatter.compact = true
+      load_config
+      create_client
+      input_loop
+    end
+    
+    attr_reader :config_path, :url, :json, :raw, :users, :current_user
+    alias user current_user
+
+    def json=(bool)
+      @json = bool
+      update_client
+      return @json
+    end
+    
+    def raw=(bool)
+      @raw = bool
+      update_client
+      return @raw
+    end
+
+    def current_user=(user)
+      user = user.to_sym
+      @current_user = @users[user]
+      update_client
+      return @current_user
+    end
+    alias user= current_user=
+
+    private
+
+    def create_client
+      @client = Cloudn::Client.new(
+        url: @current_user.url,
+        api_key: @current_user.api_key,
+        secret_key: @current_user.secret_key,
+        api_location: @current_user.api_location,
+        json: @json
+      )
+    end
+    alias update_client create_client
+
+    def load_config
+      @config = YAML.load_file(@config_path)
+      @url    = URI.parse(@config[:url])
+      @json   = @config[:json]
+      @raw    = @config[:raw_output]
+      users   = @config[:users]
+      @users  = {}
+      users.each do |name_sym, opt|
+        @users[name_sym] = User.new(name_sym.to_s, opt)
+      end
+      @current_user = @users.values.first
+    end
+
+    def make_param_hash(line)
+      command, *params = line.split
+      param_hash = { command: command }
+      unless params.empty?
+        opt_key_value = params.map do |param| 
+          key, value = param.split("=", 2)
+          raise SyntaxError, "Invalid Parameter: #{param}" unless value
+          #[key.to_sym, CGI.escape(value)]
+          [key.to_sym, value]
+          #[key.to_sym, ERB::Util.u(value)]
+        end
+        opt_hash = Hash[opt_key_value]
+        param_hash.merge!(opt_hash)
+      end
+      return param_hash
+    end
+
+    def syntax_highlight(str, lang)
+      CodeRay.scan(str, lang).term
+    end
+
+    def raw_formatted_output(response_text)
+      if @json
+        response_hash = ::JSON.parse(response_text)
+        pretty_json   = ::JSON.pretty_generate(response_hash)
+        puts syntax_highlight(pretty_json, :json)
+      else # XML
+        response_xml  = ::REXML::Document.new(response_text)
+        @xml_formatter.write(response_xml, formatted = "")
+        puts syntax_highlight(formatted, :xml)
+      end
+    end
+
+    def process_command(line)
+      param_hash = make_param_hash(line)
+      if @raw
+        response_text = @client.get_raw(param_hash)
+        raw_formatted_output(response_text)
+      else
+        response_hash  = @client.get(param_hash)
+        PP.pp(response_hash, pretty_printed = "")
+        puts syntax_highlight(pretty_printed, :ruby)
+      end
+    end
+
+    def info(str)
+      puts ::TermColor.colorize(str.to_s, :green)
+    end
+
+    def alert(str)
+      warn ::TermColor.colorize(str.to_s, :red)
+    end
+
+    def change_format(format)
+      case format
+      when /json/i
+        self.json = true
+      when /xml/i
+        self.json = false
+      else
+        raise ArgumentError, "undefined format: #{format}"
+      end
+    end
+
+    def show_list_users
+      @users.each do |name, user|
+        if user == @current_user
+          info "#{name} *"
+        else
+          info name
+        end
+      end
+    end
+
+    Usage = <<-EOS
+Usage: command [parameter1=value2 parameter2=value2 ...]
+
+Cloudn Cli Command:
+  exit|quit:
+    exit the shell
+  config:
+    show current config
+  doc ${api_name}:
+    show description for the API
+  format (xml|json)?:
+    show or change current format
+  raw (true|false)?:
+    enable/disable raw output
+  user ${user_name}:
+    switch user
+  users:
+    show users
+  eval { # ruby code }:
+    eval ruby code in Cloudn::Client instance context
+    EOS
+
+    NON_WHITESPACE_REGEXP = %r![^\s#{[0x3000].pack("U")}]!
+
+    def process_line(line)
+      return if line !~ NON_WHITESPACE_REGEXP # ignore bland line
+      case line
+      when "help"
+        info Usage
+      when "exit", "quit"
+        exit
+      when "config"
+        PP.pp(@config, pretty_printed = "")
+        puts syntax_highlight(pretty_printed, :ruby)
+      when /^doc (.+)$/
+        query = $1
+        raise ArgumentError, "command not specified" unless query
+        regexp = /^#{query}/i
+        commands = APIList.select {|command| regexp =~ command }
+        commands.each do |command|
+          info command
+          info APIParams[command][1]
+          puts
+        end
+      when /^format ?(.+)?$/
+        format_to_change = $1
+        change_format(format_to_change.to_s) if format_to_change
+        info "Current format is: #{@json ? "JSON" : "XML"}"
+      when /^raw ?(.+)?$/
+        raw = $1
+        self.raw = (raw == "true") if raw
+        info (@raw ? "Raw Output" : "Ruby's Hash Output")
+      when /^user (.+)?$/
+        user_to_change = $1
+        self.user = $1 if $1
+        info "Current user is: #{@current_user.name}"
+      when "users"
+        show_list_users
+      when /^eval \{(.+)\}$/
+        raise ArgumentError, "code is not specified" unless $1
+        code = $1
+        instance_eval(code)
+      else
+        process_command(line)
+      end
+    end
+
+    # API infomation for completion
+    APIParamsPath = File.expand_path("../api_list.json", __FILE__).freeze
+    APIParams     = JSON.parse(File.read(APIParamsPath)).freeze
+    APIList       = APIParams.keys.freeze
+  
+    # libedit(editline) in Mac OS X is broken.
+    # its #line_buffer(rl_line_buffer) is not line buffer but a mere last line.
+    CompletionProc = lambda do |line|
+      words = line.split
+      word  = words.last 
+    
+      case words.size
+      when 0, 1 # command completion
+        Readline.completion_append_character = " "
+        regexp = /^#{word}/i
+        return APIList.select {|key| regexp =~ key }
+      else      # params completion
+        Readline.completion_append_character = "="
+        command          = words.first
+        completing_param = words.pop
+        regexp           = /^#{completing_param}/i
+        api_params       = APIParams[command]
+        return nil unless api_params
+        no_required_params = api_params.first
+        completed_params   = no_required_params.select {|param| regexp =~ param }
+        return completed_params.map {|param| (words + [param]).join(" ") }
+      end
+    end
+
+    def init_readline_completion
+      Readline.basic_word_break_characters = "" # disable readline's word break
+      Readline.completion_proc = CompletionProc
+    end
+   
+    STTY = `stty -g`.chomp rescue nil
+    TrapINT = lambda do |signum|
+      trap(:INT) do
+        (system("stty", STTY) rescue nil) if STTY # reset stty
+        exit
+      end
+      puts "Interrupt again to exit"
+    end
+
+    def register_trap
+      trap(:INT, &TrapINT)
+    end
+
+    PaddingLen = 10
+    Padding = (" " * PaddingLen).freeze
+
+    def input_loop
+      init_readline_completion
+      register_trap
+      while line = Readline.readline("> ", true)
+        register_trap if trap(:INT, nil) != TrapINT
+        begin
+          process_line(line)
+        rescue => ex
+          alert "Exception #{ex.class}: #{ex.message}"
+          ex.backtrace.each {|trace| alert(Padding + trace) }
+        end
+      end
+    end
+  end
+end
+
+if $PROGRAM_NAME == __FILE__
+  p Cloudn::Shell.new("../../config.yml")
+end