Return-Path: X-Original-To: apmail-cloudstack-commits-archive@www.apache.org Delivered-To: apmail-cloudstack-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id CDDA7109A9 for ; Tue, 8 Oct 2013 19:29:15 +0000 (UTC) Received: (qmail 25611 invoked by uid 500); 8 Oct 2013 19:28:07 -0000 Delivered-To: apmail-cloudstack-commits-archive@cloudstack.apache.org Received: (qmail 24882 invoked by uid 500); 8 Oct 2013 19:27:34 -0000 Mailing-List: contact commits-help@cloudstack.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@cloudstack.apache.org Delivered-To: mailing list commits@cloudstack.apache.org Received: (qmail 24161 invoked by uid 99); 8 Oct 2013 19:27:13 -0000 Received: from tyr.zones.apache.org (HELO tyr.zones.apache.org) (140.211.11.114) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 08 Oct 2013 19:27:13 +0000 Received: by tyr.zones.apache.org (Postfix, from userid 65534) id 3FE98912FD2; Tue, 8 Oct 2013 19:27:07 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit From: ke4qqq@apache.org To: commits@cloudstack.apache.org Date: Tue, 08 Oct 2013 19:27:46 -0000 Message-Id: <3b20fcce76524a4e9f3540cc3df20e77@git.apache.org> In-Reply-To: <10a2402bd76a487daf6b925f5230a8e3@git.apache.org> References: <10a2402bd76a487daf6b925f5230a8e3@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [42/70] [partial] Adding documents from 4.2 http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/change-to-behavior-of-list-commands.xml ---------------------------------------------------------------------- diff --git a/en-US/change-to-behavior-of-list-commands.xml b/en-US/change-to-behavior-of-list-commands.xml new file mode 100644 index 0000000..69b9e4d --- /dev/null +++ b/en-US/change-to-behavior-of-list-commands.xml @@ -0,0 +1,108 @@ + + +%BOOK_ENTITIES; +]> + +
+ Change to Behavior of List Commands + There was a major change in how our List* API commands work in CloudStack 3.0 compared to + 2.2.x. The rules below apply only for managed resources – those that belong to an account, + domain, or project. They are irrelevant for the List* commands displaying unmanaged (system) + resources, such as hosts, clusters, and external network resources. + When no parameters are passed in to the call, the caller sees only resources owned by the + caller (even when the caller is the administrator). Previously, the administrator saw everyone + else's resources by default. + When accountName and domainId are passed in: + + + The caller sees the resources dedicated to the account specified. + + + If the call is executed by a regular user, the user is authorized to specify only the + user's own account and domainId. + + + If the caller is a domain administrator, CloudStack performs an authorization check to + see whether the caller is permitted to view resources for the given account and + domainId. + + + When projectId is passed in, only resources belonging to that project are listed. + When domainId is passed in, the call returns only resources belonging to the domain + specified. To see the resources of subdomains, use the parameter isRecursive=true. Again, the + regular user can see only resources owned by that user, the root administrator can list + anything, and a domain administrator is authorized to see only resources of the administrator's + own domain and subdomains. + To see all resources the caller is authorized to see, except for Project resources, use the + parameter listAll=true. + To see all Project resources the caller is authorized to see, use the parameter + projectId=-1. + There is one API command that doesn't fall under the rules above completely: the + listTemplates command. This command has its own flags defining the list rules: + + + + + + + listTemplates Flag + Description + + + + + featured + Returns templates that have been marked as featured and + public. + + + self + Returns templates that have been registered or created by the calling + user. + + + selfexecutable + Same as self, but only returns templates that are ready to be deployed + with. + + + sharedexecutable + Ready templates that have been granted to the calling user by another + user. + + + executable + Templates that are owned by the calling user, or public templates, that can + be used to deploy a new VM. + + + community + Returns templates that have been marked as public but not + featured. + + + all + Returns all templates (only usable by admins). + + + + + The &PRODUCT; UI on a general view will display all resources that the logged-in user is + authorized to see, except for project resources. To see the project resources, select the + project view. +
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/changed-API-commands-4.2.xml ---------------------------------------------------------------------- diff --git a/en-US/changed-API-commands-4.2.xml b/en-US/changed-API-commands-4.2.xml new file mode 100644 index 0000000..8fda9cc --- /dev/null +++ b/en-US/changed-API-commands-4.2.xml @@ -0,0 +1,1129 @@ + + +%BOOK_ENTITIES; +]> + +
+ Changed API Commands in 4.2 + + + + + + + API Commands + Description + + + + + listNetworkACLs + The following new request parameters are added: aclid (optional), action + (optional), protocol (optional) + The following new response parameters are added: aclid, action, + number + + + copyTemplate + + The following new response parameters are added: isdynamicallyscalable, + sshkeyenabled + + + listRouters + + The following new response parameters are added: ip6dns1, ip6dns2, + role + + + updateConfiguration + The following new request parameters are added: accountid (optional), + clusterid (optional), storageid (optional), zoneid (optional) + The following new response parameters are added: id, scope + + + listVolumes + The following request parameter is removed: details + The following new response parameter is added: displayvolume + + + suspendProject + + The following new response parameters are added: cpuavailable, cpulimit, cputotal, + ipavailable, iplimit, iptotal, memoryavailable, memorylimit, memorytotal, + networkavailable, networklimit, networktotal, primarystorageavailable, + primarystoragelimit, primarystoragetotal, secondarystorageavailable, + secondarystoragelimit, secondarystoragetotal, snapshotavailable, snapshotlimit, + snapshottotal, templateavailable, templatelimit, templatetotal, vmavailable, vmlimit, + vmrunning, vmstopped, vmtotal, volumeavailable, volumelimit, volumetotal, + vpcavailable, vpclimit, vpctotal + + + listRemoteAccessVpns + + The following new response parameters are added: id + + + registerTemplate + The following new request parameters are added: imagestoreuuid (optional), + isdynamicallyscalable (optional), isrouting (optional) + The following new response parameters are added: isdynamicallyscalable, + sshkeyenabled + + + addTrafficMonitor + + The following response parameters are removed: privateinterface, privatezone, + publicinterface, publiczone, usageinterface, username + + + createTemplate + The following response parameters are removed: clusterid, clustername, + disksizeallocated, disksizetotal, disksizeused, ipaddress, path, podid, podname, + state, tags, type + The following new response parameters are added: account, accountid, bootable, + checksum, crossZones, details, displaytext, domain, domainid, format, hostid, + hostname, hypervisor, isdynamicallyscalable, isextractable, isfeatured, ispublic, + isready, ostypeid, ostypename, passwordenabled, project, projectid, removed, size, + sourcetemplateid, sshkeyenabled, status, templatetag, templatetype, + tags + + + listLoadBalancerRuleInstances + + The following new response parameters are added: diskioread, diskiowrite, + diskkbsread, diskkbswrite, displayvm, isdynamicallyscalable, + affinitygroup + + + migrateVolume + The following new request parameters is added: livemigrate (optional) + The following new response parameters is added: displayvolume + + + createAccount + The following new request parameters are added: accountid (optional), userid + (optional) + The following new response parameters are added: accountdetails, cpuavailable, + cpulimit, cputotal, defaultzoneid, ipavailable, iplimit, iptotal, iscleanuprequired, + isdefault, memoryavailable, memorylimit, memorytotal, name, networkavailable, + networkdomain, networklimit, networktotal, primarystorageavailable, + primarystoragelimit, primarystoragetotal, projectavailable, projectlimit, + projecttotal, receivedbytes, secondarystorageavailable, secondarystoragelimit, + secondarystoragetotal, sentbytes, snapshotavailable, snapshotlimit, snapshottotal, + templateavailable, templatelimit, templatetotal, vmavailable, vmlimit, vmrunning, + vmstopped, vmtotal, volumeavailable, volumelimit, volumetotal, vpcavailable, vpclimit, + vpctotal, user + The following parameters are removed: account, accountid, apikey, created, email, + firstname, lastname, secretkey, timezone, username + + + updatePhysicalNetwork + The following new request parameters is added: removevlan (optional) + + + + listTrafficMonitors + + The following response parameters are removed: privateinterface, privatezone, + publicinterface, publiczone, usageinterface, username + + + attachIso + + The following new response parameters are added: diskioread, diskiowrite, + diskkbsread, diskkbswrite, displayvm, isdynamicallyscalable, + affinitygroup + + + listProjects + The following new request parameters are added: cpuavailable, cpulimit, + cputotal, ipavailable, iplimit, iptotal, memoryavailable, memorylimit, memorytotal, + networkavailable, networklimit, networktotal, primarystorageavailable, + primarystoragelimit, primarystoragetotal, secondarystorageavailable, + secondarystoragelimit, secondarystoragetotal, snapshotavailable, snapshotlimit, + snapshottotal, templateavailable, templatelimit, templatetotal, vmavailable, vmlimit, + vmrunning, vmstopped, vmtotal, volumeavailable, volumelimit, volumetotal, + vpcavailable, vpclimit, vpctotal + + + enableAccount + + The following new response parameters are added: cpuavailable, cpulimit, cputotal, + isdefault, memoryavailable, memorylimit, memorytotal, primarystorageavailable, + primarystoragelimit, primarystoragetotal, secondarystorageavailable, + secondarystoragelimit, secondarystoragetotal + + + listPublicIpAddresses + + The following new response parameters are added: isportable, vmipaddress + + + + enableStorageMaintenance + + The following new response parameters are added: hypervisor, scope, + suitableformigration + + + listLoadBalancerRules + The following new request parameters is added: networkid (optional) + The following new response parameters is added: networkid + + + stopRouter + + The following new response parameters are added: ip6dns1, ip6dns2, role + + + + listClusters + + The following new response parameters are added: cpuovercommitratio, + memoryovercommitratio + + + attachVolume + + The following new response parameter is added: displayvolume + + + updateVPCOffering + The following request parameters is made mandatory: id + + + resetSSHKeyForVirtualMachine + The following new request parameter is added: keypair (required) + The following parameter is removed: name + The following new response parameters are added: diskioread, diskiowrite, + diskkbsread, diskkbswrite, displayvm, isdynamicallyscalable, + affinitygroup + + + updateCluster + The following new request parameters are removed: cpuovercommitratio, + memoryovercommitratio + The following new response parameters are removed: cpuovercommitratio, + memoryovercommitratio + + + listPrivateGateways + The following new response parameters are added: aclid, sourcenatsupported + + + + ldapConfig + The following new request parameters are added: listall (optional) + The following parameters has been made optional: searchbase, hostname, + queryfilter + The following new response parameter is added: ssl + + + listTemplates + + The following new response parameters are added: isdynamicallyscalable, + sshkeyenabled + + + listNetworks + + The following new response parameters are added: aclid, displaynetwork, ip6cidr, + ip6gateway, ispersistent, networkcidr, reservediprange + + + restartNetwork + + The following new response parameters are added: isportable, vmipaddress + + + + prepareTemplate + + The following new response parameters are added: isdynamicallyscalable, + sshkeyenabled + + + rebootVirtualMachine + + The following new response parameters are added: diskioread, diskiowrite, + diskkbsread, diskkbswrite, displayvm, isdynamicallyscalable, + affinitygroup + + + changeServiceForRouter + The following new request parameters are added: aclid (optional), action + (optional), protocol (optional) + The following new response parameters are added: id, scope + + + updateZone + The following new request parameters are added: ip6dns1 (optional), ip6dns2 + (optional) + The following new response parameters are added: ip6dns1, ip6dns2 + + + ldapRemove + + The following new response parameters are added: ssl + + + updateServiceOffering + + The following new response parameters are added: deploymentplanner, isvolatile + + + + updateStoragePool + + The following new response parameters are added: hypervisor, scope, + suitableformigration + + + listFirewallRules + The following request parameter is removed: traffictype + The following new response parameters are added: networkid + + + updateUser + + The following new response parameters are added: iscallerchilddomain, isdefault + + + + updateProject + + The following new response parameters are added: cpuavailable, cpulimit, cputotal, + ipavailable, iplimit, iptotal, memoryavailable, memorylimit, memorytotal, + networkavailable, networklimit, networktotal, primarystorageavailable, + primarystoragelimit, primarystoragetotal, secondarystorageavailable, + secondarystoragelimit, secondarystoragetotal, snapshotavailable, snapshotlimit, + snapshottotal, templateavailable, templatelimit, templatetotal, vmavailable, vmlimit, + vmrunning, vmstopped, vmtotal, volumeavailable, volumelimit, volumetotal, + vpcavailable, vpclimit, vpctotal + + + updateTemplate + The following new request parameters are added: isdynamicallyscalable + (optional), isrouting (optional) + The following new response parameters are added: isdynamicallyscalable, + sshkeyenabled + + + disableUser + + The following new response parameters are added: iscallerchilddomain, isdefault + + + + activateProject + + The following new response parameters are added: cpuavailable, cpulimit, cputotal, + ipavailable, iplimit, iptotal, memoryavailable, memorylimit, memorytotal, + networkavailable, networklimit, networktotal, primarystorageavailable, + primarystoragelimit, primarystoragetotal, secondarystorageavailable, + secondarystoragelimit, secondarystoragetotal, snapshotavailable, snapshotlimit, + snapshottotal, templateavailable, templatelimit, templatetotal, vmavailable, vmlimit, + vmrunning, vmstopped, vmtotal, volumeavailable, volumelimit, volumetotal, + vpcavailable, vpclimit, vpctotal + + + createNetworkACL + The following new request parameters are added: aclid (optional), action + (optional), number (optional) + The following request parameter is now optional: networkid + The following new response parameters are added: aclid, action, number + + + + enableStaticNat + The following new request parameters are added: vmguestip (optional) + + + + registerIso + The following new request parameters are added: imagestoreuuid (optional), + isdynamicallyscalable (optional) + The following new response parameters are added: isdynamicallyscalable, + sshkeyenabled + + + createIpForwardingRule + + The following new response parameter is added: vmguestip + + + resetPasswordForVirtualMachine + + The following new response parameters are added: diskioread, diskiowrite, + diskkbsread, diskkbswrite, displayvm, isdynamicallyscalable, + affinitygroup + + + createVolume + The following new request parameter is added: displayvolume (optional) + The following new response parameter is added: displayvolume + + + startRouter + + The following new response parameters are added: ip6dns1, ip6dns2, role + + + + listCapabilities + The following new response parameters are added: apilimitinterval and + apilimitmax. + + + createServiceOffering + The following new request parameters are added: deploymentplanner (optional), + isvolatile (optional), serviceofferingdetails (optional). + isvolatie indicates whether the service offering includes Volatile VM capability, + which will discard the VM's root disk and create a new one on reboot. + The following new response parameters are added: deploymentplanner, isvolatile + + + + restoreVirtualMachine + The following request parameter is added: templateID (optional). This is used to point to the + new template ID when the base image is updated. The parameter templateID can be an ISO + ID in case of restore vm deployed using ISO. + The following response parameters are added: diskioread, diskiowrite, diskkbsread, + diskkbswrite, displayvm, isdynamicallyscalable, affinitygroup + + + createNetwork + The following new request parameters are added: aclid (optional), + displaynetwork (optional), endipv6 (optional), ip6cidr (optional), ip6gateway + (optional), isolatedpvlan (optional), startipv6 (optional) + The following new response parameters are added: aclid, displaynetwork, ip6cidr, + ip6gateway, ispersistent, networkcidr, reservediprange + + + createVlanIpRange + The following new request parameters are added: startipv6, endipv6, + ip6gateway, ip6cidr + Changed parameters: startip (is now optional) + The following new response parameters are added: startipv6, endipv6, ip6gateway, + ip6cidr + + + CreateZone + The following new request parameters are added: ip6dns1, ip6dns2 + The following new response parameters are added: ip6dns1, ip6dns2 + + + deployVirtualMachine + The following request parameters are added: affinitygroupids (optional), + affinitygroupnames (optional), displayvm (optional), ip6address (optional) + The following request parameter is modified: iptonetworklist has a new possible + value, ipv6 + The following new response parameters are added: diskioread, diskiowrite, + diskkbsread, diskkbswrite, displayvm, isdynamicallyscalable, + affinitygroup + + + + createNetworkOffering + + + The following request parameters are added: details (optional), + egressdefaultpolicy (optional), ispersistent (optional) + ispersistent determines if the network or network offering created or listed by + using this offering are persistent or not. + The following response parameters are added: details, egressdefaultpolicy, + ispersistent + + + + + listNetworks + + + The following request parameters is added: isPersistent. + This parameter determines if the network or network offering created or listed by + using this offering are persistent or not. + + + + + listNetworkOfferings + + + The following request parameters is added: isPersistent. + This parameter determines if the network or network offering created or listed by + using this offering are persistent or not. + For listNetworkOfferings, the following response parameter has been added: + details, egressdefaultpolicy, ispersistent + + + + + addF5LoadBalancer + configureNetscalerLoadBalancer + addNetscalerLoadBalancer + listF5LoadBalancers + configureF5LoadBalancer + listNetscalerLoadBalancers + + + The following response parameter is removed: inline. + + + + + listRouters + + + For nic responses, the following fields have been added. + + + ip6address + + + ip6gateway + + + ip6cidr + + + + + + + listVirtualMachines + + + The following request parameters are added: affinitygroupid (optional), vpcid + (optional) + The following response parameters are added: diskioread, diskiowrite, diskkbsread, + diskkbswrite, displayvm, isdynamicallyscalable, affinitygroup + + + + + listRouters + listZones + + + For DomainRouter and DataCenter response, the following fields have been + added. + + + ip6dns1 + + + ip6dns2 + + + For listZones, the following optional request parameters are added: name, + networktype + + + + listFirewallRules + createFirewallRule + + The following request parameter is added: traffictype (optional). + The following response parameter is added: networkid + + + + listUsageRecords + The following response parameter is added: virtualsize. + + + + + deleteIso + + + The following request parameter is removed: forced + + + + addCluster + The following request parameters are added: guestvswitchtype (optional), guestvswitchtype + (optional), publicvswitchtype (optional), publicvswitchtype (optional) + The following request parameters are removed: cpuovercommitratio, + memoryovercommitratio + + + + updateCluster + The following request parameters are added: cpuovercommitratio, + ramovercommitratio + + + + + createStoragePool + + + The following request parameters are added: hypervisor (optional), provider + (optional), scope (optional) + The following request parameters have been made mandatory: podid, clusterid + The following response parameter has been added: hypervisor, scope, + suitableformigration + + + + listStoragePools + The following request parameter is added: scope (optional) + The following response parameters are added: hypervisor, scope, + suitableformigration + + + + updateDiskOffering + + + The following response parameter is added: displayoffering + + + + + changeServiceForVirtualMachine + + + The following response parameter are added: diskioread, diskiowrite, diskkbsread, + diskkbswrite, displayvm, isdynamicallyscalable, affinitygroup + + + + + recoverVirtualMachine + + + The following response parameters are added: diskioread, diskiowrite, diskkbsread, + diskkbswrite, displayvm, isdynamicallyscalable, affinitygroup + + + + + listCapabilities + + + The following response parameters are added: apilimitinterval, apilimitmax + + + + + createRemoteAccessVpn + + + The following response parameters are added: id + + + + + startVirtualMachine + + + The following response parameters are added: diskioread, diskiowrite, diskkbsread, + diskkbswrite, displayvm, isdynamicallyscalable, affinitygroup + + + + + detachIso + + + The following response parameters are added: diskioread, diskiowrite, diskkbsread, + diskkbswrite, displayvm, isdynamicallyscalable, affinitygroup + + + + + updateVPC + + + The following request parameters has been made mandatory: id, name + + + + + associateIpAddress + + + The following request parameters are added: isportable (optional), regionid + (optional) + The following response parameters are added: isportable, vmipaddress + + + + + listProjectAccounts + + + The following response parameters are added: cpuavailable, cpulimit, cputotal, + ipavailable, iplimit, iptotal, memoryavailable, memorylimit, memorytotal, + networkavailable, networklimit, networktotal, primarystorageavailable, + primarystoragelimit, primarystoragetotal, secondarystorageavailable, + secondarystoragelimit, secondarystoragetotal, snapshotavailable, snapshotlimit, + snapshottotal, templateavailable, templatelimit, templatetotal, vmavailable, vmlimit, + vmrunning, vmstopped, vmtotal, volumeavailable, volumelimit, volumetotal, + vpcavailable, vpclimit, vpctotal + + + + + disableAccount + + + The following response parameters are added: cpuavailable, cpulimit, cputotal, + isdefault, memoryavailable, memorylimit, memorytotal, primarystorageavailable, + primarystoragelimit, primarystoragetotal, secondarystorageavailable, + secondarystoragelimit, secondarystoragetotal + + + + + listPortForwardingRules + + + The following response parameters are added: vmguestip + + + + + migrateVirtualMachine + + + The following response parameters are added: diskioread, diskiowrite, diskkbsread, + diskkbswrite, displayvm, isdynamicallyscalable, affinitygroup + + + + + cancelStorageMaintenance + + + The following response parameters are added: hypervisor, scope, + suitableformigration + + + + + createPortForwardingRule + + The following request parameter is added: vmguestip (optional) The + following response parameter is added: vmguestip + + + + addVpnUser + + + The following response parameter is added: state + + + + + createVPCOffering + + + The following request parameter is added: serviceproviderlist (optional) + + + + + assignVirtualMachine + + + The following response parameters are added: diskioread, diskiowrite, diskkbsread, + diskkbswrite, displayvm, isdynamicallyscalable, affinitygroup + + + + + listConditions + + + The following response parameters are added: account, counter, domain, domainid, + project, projectid, relationaloperator, threshold + Removed response parameters: name, source, value + + + + + createPrivateGateway + + + The following request parameters are added: aclid (optional), sourcenatsupported + (optional) + The following response parameters are added: aclid, sourcenatsupported + + + + + updateVirtualMachine + + + The following request parameters are added: displayvm (optional), + isdynamicallyscalable (optional) + The following response parameters are added: diskioread, diskiowrite, diskkbsread, + diskkbswrite, displayvm, isdynamicallyscalable, affinitygroup + + + + + destroyRouter + + + The following response parameters are added: ip6dns1, ip6dns2, role + + + + + listServiceOfferings + + + The following response parameters are added: deploymentplanner, isvolatile + + + + + listUsageRecords + + + The following response parameters are removed: virtualsize + + + + + createProject + + + The following response parameters are added: cpuavailable, cpulimit, cputotal, + ipavailable, iplimit, iptotal, memoryavailable, memorylimit, memorytotal, + networkavailable, networklimit, networktotal, primarystorageavailable, + primarystoragelimit, primarystoragetotal, secondarystorageavailable, + secondarystoragelimit, secondarystoragetotal, snapshotavailable, snapshotlimit, + snapshottotal, templateavailable, templatelimit, templatetotal, vmavailable, vmlimit, + vmrunning, vmstopped, vmtotal, volumeavailable, volumelimit, volumetotal, + vpcavailable, vpclimit, vpctotal + + + + + enableUser + + + The following response parameters are added: iscallerchilddomain, isdefault + + + + + + createLoadBalancerRule + + + The following response parameter is added: networkid + + + + + updateAccount + + + The following response parameters are added: cpuavailable, cpulimit, cputotal, + isdefault, memoryavailable, memorylimit, memorytotal, primarystorageavailable, + primarystoragelimit, primarystoragetotal, secondarystorageavailable, + secondarystoragelimit, secondarystoragetotal + + + + + copyIso + + + The following response parameters are added: isdynamicallyscalable, sshkeyenabled + + + + + + uploadVolume + + + The following request parameters are added: imagestoreuuid (optional), projectid + (optional + The following response parameters are added: displayvolume + + + + + createDomain + + + The following request parameter is added: domainid (optional) + + + + + stopVirtualMachine + + + The following response parameters are added: diskioread, diskiowrite, diskkbsread, + diskkbswrite, displayvm, isdynamicallyscalable, affinitygroup + + + + + listAccounts + + + The following response parameters are added: cpuavailable, cpulimit, cputotal, + isdefault, memoryavailable, memorylimit, memorytotal, primarystorageavailable, + primarystoragelimit, primarystoragetotal, secondarystorageavailable, + secondarystoragelimit, secondarystoragetotal + + + + + createSnapshot + + + The following response parameter is added: zoneid + + + + + updateIso + + + The following request parameters are added: isdynamicallyscalable (optional), + isrouting (optional) + The following response parameters are added: isdynamicallyscalable, + sshkeyenabled + + + + + listIpForwardingRules + + + The following response parameter is added: vmguestip + + + + + updateNetwork + + + The following request parameters are added: displaynetwork (optional), guestvmcidr + (optional) + The following response parameters are added: aclid, displaynetwork, ip6cidr, + ip6gateway, ispersistent, networkcidr, reservediprange + + + + + destroyVirtualMachine + + + The following response parameters are added: diskioread, diskiowrite, diskkbsread, + diskkbswrite, displayvm, isdynamicallyscalable, affinitygroup + + + + + createDiskOffering + + + The following request parameter is added: displayoffering (optional) + The following response parameter is added: displayoffering + + + + + rebootRouter + + + The following response parameters are added: ip6dns1, ip6dns2, role + + + + + listConfigurations + + + The following request parameters are added: accountid (optional), clusterid + (optional), storageid (optional), zoneid (optional) + The following response parameters are added: id, scope + + + + + createUser + + + The following request parameter is added: userid (optional) + The following response parameters are added: iscallerchilddomain, isdefault + + + + + listDiskOfferings + + + The following response parameter is added: displayoffering + + + + + detachVolume + + + The following response parameter is added: displayvolume + + + + + deleteUser + + + The following response parameters are added: displaytext, success + Removed parameters: id, account, accountid, accounttype, apikey, created, domain, + domainid, email, firstname, lastname, secretkey, state, timezone, username + + + + + listSnapshots + + + The following request parameter is added: zoneid (optional) + The following response parameter is added: zoneid + + + + + markDefaultZoneForAccount + + + The following response parameters are added: cpuavailable, cpulimit, cputotal, + isdefault, memoryavailable, memorylimit, memorytotal, primarystorageavailable, + primarystoragelimit, primarystoragetotal, secondarystorageavailable, + secondarystoragelimit, secondarystoragetotal + + + + + restartVPC + + + The following request parameters are made mandatory: id + + + + + updateHypervisorCapabilities + + + The following response parameters are added: hypervisor, hypervisorversion, + maxdatavolumeslimit, maxguestslimit, maxhostspercluster, securitygroupenabled, + storagemotionenabled + Removed parameters: cpunumber, cpuspeed, created, defaultuse, displaytext, domain, + domainid, hosttags, issystem, limitcpuuse, memory, name, networkrate, offerha, + storagetype, systemvmtype, tags + + + + + updateLoadBalancerRule + + + The following response parameter is added: networkid + + + + + listVlanIpRanges + + + The following response parameters are added: endipv6, ip6cidr, ip6gateway, + startipv6 + + + + + listHypervisorCapabilities + + + The following response parameters are added: maxdatavolumeslimit, + maxhostspercluster, storagemotionenabled + + + + + updateNetworkOffering + + + The following response parameters are added: details, egressdefaultpolicy, + ispersistent + + + + + createVirtualRouterElement + + + The following request parameters are added: providertype (optional) + + + + + listVpnUsers + + + The following response parameter is added: state + + + + + listUsers + + + The following response parameters are added: iscallerchilddomain, isdefault + + + + + + listSupportedNetworkServices + + + The following response parameter is added: provider + + + + + listIsos + + + The following response parameters are added: isdynamicallyscalable, sshkeyenabled + + + + + + +
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/changed-apicommands-4-0.xml ---------------------------------------------------------------------- diff --git a/en-US/changed-apicommands-4-0.xml b/en-US/changed-apicommands-4-0.xml new file mode 100644 index 0000000..042d5e2 --- /dev/null +++ b/en-US/changed-apicommands-4-0.xml @@ -0,0 +1,268 @@ + + +%BOOK_ENTITIES; +]> + +
+ Changed API Commands in 4.0.0-incubating + + + + + + + API Commands + Description + + + + + + copyTemplate + prepareTemplate + registerTemplate + updateTemplate + createProject + activateProject + suspendProject + updateProject + listProjectAccounts + createVolume + migrateVolume + attachVolume + detachVolume + uploadVolume + createSecurityGroup + registerIso + copyIso + updateIso + createIpForwardingRule + listIpForwardingRules + createLoadBalancerRule + updateLoadBalancerRule + createSnapshot + + + The commands in this list have a single new response parameter, and no other + changes. + New response parameter: tags(*) + + Many other commands also have the new tags(*) parameter in addition to other + changes; those commands are listed separately. + + + + + rebootVirtualMachine + attachIso + detachIso + listLoadBalancerRuleInstances + resetPasswordForVirtualMachine + changeServiceForVirtualMachine + recoverVirtualMachine + startVirtualMachine + migrateVirtualMachine + deployVirtualMachine + assignVirtualMachine + updateVirtualMachine + restoreVirtualMachine + stopVirtualMachine + destroyVirtualMachine + + + The commands in this list have two new response parameters, and no other + changes. + New response parameters: keypair, tags(*) + + + + + listSecurityGroups + listFirewallRules + listPortForwardingRules + listSnapshots + listIsos + listProjects + listTemplates + listLoadBalancerRules + + The commands in this list have the following new parameters, and no other + changes. + New request parameter: tags (optional) + New response parameter: tags(*) + + + + + listF5LoadBalancerNetworks + listNetscalerLoadBalancerNetworks + listSrxFirewallNetworks + updateNetwork + + + The commands in this list have three new response parameters, and no other + changes. + New response parameters: canusefordeploy, vpcid, tags(*) + + + + + createZone + updateZone + + The commands in this list have the following new parameters, and no other + changes. + New request parameter: localstorageenabled (optional) + New response parameter: localstorageenabled + + + + listZones + New response parameter: localstorageenabled + + + + rebootRouter + changeServiceForRouter + startRouter + destroyRouter + stopRouter + + The commands in this list have two new response parameters, and no other + changes. + New response parameters: vpcid, nic(*) + + + + updateAccount + disableAccount + listAccounts + markDefaultZoneForAccount + enableAccount + + The commands in this list have three new response parameters, and no other + changes. + New response parameters: vpcavailable, vpclimit, vpctotal + + + listRouters + + New request parameters: forvpc (optional), vpcid (optional) + New response parameters: vpcid, nic(*) + + + + listNetworkOfferings + + New request parameters: forvpc (optional) + New response parameters: forvpc + + + + listVolumes + + New request parameters: details (optional), tags (optional) + New response parameters: tags(*) + + + + addTrafficMonitor + + New request parameters: excludezones (optional), includezones (optional) + + + + createNetwork + + New request parameters: vpcid (optional) + New response parameters: canusefordeploy, vpcid, tags(*) + + + + listPublicIpAddresses + + New request parameters: tags (optional), vpcid (optional) + New response parameters: vpcid, tags(*) + + + + listNetworks + + New request parameters: canusefordeploy (optional), forvpc (optional), tags + (optional), vpcid (optional) + New response parameters: canusefordeploy, vpcid, tags(*) + + + + restartNetwork + + New response parameters: vpcid, tags(*) + + + + enableStaticNat + + New request parameter: networkid (optional) + + + + createDiskOffering + + New request parameter: storagetype (optional) + New response parameter: storagetype + + + + listDiskOfferings + + New response parameter: storagetype + + + + updateDiskOffering + + New response parameter: storagetype + + + + createFirewallRule + + Changed request parameters: ipaddressid (old version - optional, new version - + required) + New response parameter: tags(*) + + + + listVirtualMachines + + New request parameters: isoid (optional), tags (optional), templateid + (optional) + New response parameters: keypair, tags(*) + + + + updateStorageNetworkIpRange + + New response parameters: id, endip, gateway, netmask, networkid, podid, startip, + vlan, zoneid + + + + + +
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/changed-apicommands-4.1.xml ---------------------------------------------------------------------- diff --git a/en-US/changed-apicommands-4.1.xml b/en-US/changed-apicommands-4.1.xml new file mode 100644 index 0000000..1667aaf --- /dev/null +++ b/en-US/changed-apicommands-4.1.xml @@ -0,0 +1,253 @@ + + +%BOOK_ENTITIES; +]> + +
+ Changed API Commands in 4.1 + + + + + + + API Commands + Description + + + + + + createNetworkOffering + + + The following request parameters have been added: + + + isPersistent + + + startipv6 + + + endipv6 + + + ip6gateway + + + ip6cidr + + + + + + + listNetworkOfferings + listNetworks + + + The following request parameters have been added: + + + isPersistent + This parameter determines if the network or network offering listed are + persistent or not. + + + ip6gateway + + + ip6cidr + + + + + + + createVlanIpRange + + + The following request parameters have been added: + + + startipv6 + + + endipv6 + + + ip6gateway + + + ip6cidr + + + + + + + deployVirtualMachine + + + The following parameter has been added: ip6Address. + The following parameter is updated to accept the IPv6 address: + iptonetworklist. + + + + + CreateZoneCmd + + + The following parameter have been added: ip6dns1, ip6dns2. + + + + + listRouters + listVirtualMachines + + + For nic responses, the following fields have been added. + + + ip6address + + + ip6gateway + + + ip6cidr + + + + + + + listVlanIpRanges + + + For nic responses, the following fields have been added. + + + startipv6 + + + endipv6 + + + ip6gateway + + + ip6cidr + + + + + + + listRouters + listZones + + + For DomainRouter and DataCenter response, the following fields have been + added. + + + ip6dns1 + + + ip6dns2 + + + + + + + addF5LoadBalancer + configureNetscalerLoadBalancer + addNetscalerLoadBalancer + listF5LoadBalancers + configureF5LoadBalancer + listNetscalerLoadBalancers + + + The following response parameter is removed: inline. + + + + listFirewallRules + createFirewallRule + + The following request parameter is added: traffictype (optional). + + + + listUsageRecords + The following response parameter is added: virtualsize. + + + + + deleteIso + + + The following request parameter is added: forced (optional). + + + + + createStoragePool + + + The following request parameters are made mandatory: + + + podid + + + clusterid + + + + + + + listZones + + + The following request parameter is added: securitygroupenabled + + + + createAccount + The following new request parameters are added: accountid, userid + + + createUser + The following new request parameter is added: userid + + + createDomain + The following new request parameter is added: domainid + + + + +
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/changing-root-password.xml ---------------------------------------------------------------------- diff --git a/en-US/changing-root-password.xml b/en-US/changing-root-password.xml new file mode 100644 index 0000000..880f50f --- /dev/null +++ b/en-US/changing-root-password.xml @@ -0,0 +1,50 @@ + + +%BOOK_ENTITIES; +]> + + +
+ Changing the Root Password + During installation and ongoing cloud administration, you will need to log in to the UI as the root administrator. + The root administrator account manages the &PRODUCT; deployment, including physical infrastructure. + The root administrator can modify configuration settings to change basic functionality, create or delete user accounts, and take many actions that should be performed only by an authorized person. + When first installing &PRODUCT;, be sure to change the default password to a new, unique value. + + Open your favorite Web browser and go to this URL. Substitute the IP address of your own Management Server: + http://<management-server-ip-address>:8080/client + + Log in to the UI using the current root user ID and password. The default is admin, password. + Click Accounts. + Click the admin account name. + Click View Users. + Click the admin user name. + + Click the Change Password button. + + + + + change-password.png: button to change a user's password + + + Type the new password, and click OK. + +
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/changing-secondary-storage-ip.xml ---------------------------------------------------------------------- diff --git a/en-US/changing-secondary-storage-ip.xml b/en-US/changing-secondary-storage-ip.xml new file mode 100644 index 0000000..34f93e3 --- /dev/null +++ b/en-US/changing-secondary-storage-ip.xml @@ -0,0 +1,44 @@ + + +%BOOK_ENTITIES; +]> + + +
+ Changing the Secondary Storage IP Address + You can change the secondary storage IP address after it has been provisioned. After changing the IP address on the host, log in to your management server and execute the following commands. Replace HOSTID below with your own value, and change the URL to use the appropriate IP address and path for your server: + + # mysql -p + mysql> use cloud; + mysql> select id from host where type = 'SecondaryStorage'; + mysql> update host_details set value = 'nfs://192.168.160.20/export/mike-ss1' + where host_id = HOSTID and name = 'orig.url'; + mysql> update host set name = 'nfs://192.168.160.20/export/mike-ss1' where type + = 'SecondaryStorage' and id = #; + mysql> update host set url = 'nfs://192.168.160.20/export/mike-ss1' where type + = 'SecondaryStorage' and id = #; + mysql> update host set guid = 'nfs://192.168.160.20/export/mike-ss1' where type + = 'SecondaryStorage' and id = #; + + When copying and pasting a command, be sure the command has pasted as a single line before executing. Some document viewers may introduce unwanted line breaks in copied text. + Then log in to the cloud console UI and stop and start (not reboot) the Secondary Storage VM for that Zone. + +
+ http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/changing-secondary-storage-servers.xml ---------------------------------------------------------------------- diff --git a/en-US/changing-secondary-storage-servers.xml b/en-US/changing-secondary-storage-servers.xml new file mode 100644 index 0000000..a628eec --- /dev/null +++ b/en-US/changing-secondary-storage-servers.xml @@ -0,0 +1,36 @@ + + +%BOOK_ENTITIES; +]> + + + +
+ Changing Secondary Storage Servers + You can change the secondary storage NFS mount. Perform the following steps to do so: + + Stop all running Management Servers. + Wait 30 minutes. This allows any writes to secondary storage to complete. + Copy all files from the old secondary storage mount to the new. + Use the procedure above to change the IP address for secondary storage if required. + Start the Management Server. + +
+