CLOUDSTACK-3546 edits and additions

This commit is contained in:
Radhika PC 2013-08-05 11:49:00 +05:30
parent 149f4ffcb4
commit 3e203f63b0
2 changed files with 206 additions and 136 deletions

View File

@ -135,328 +135,405 @@
<para>The request parameters are elastic ip id and region id.</para>
</listitem>
<listitem>
<para>createVMSnapshot (create a virtual machine snapshot)</para>
<para>createVMSnapshot</para>
<para>Creates a virtual machine snapshot.</para>
</listitem>
<listitem>
<para>deleteVMSnapshot (delete a virtual machine snapshot)</para>
<para>deleteVMSnapshot </para>
<para>Deletes a virtual machine snapshot.</para>
</listitem>
<listitem>
<para>listVMSnapshot (show a virtual machine snapshot)</para>
<para>listVMSnapshot</para>
<para>Shows a virtual machine snapshot.</para>
</listitem>
<listitem>
<para>revertToVMSnapshot (return a virtual machine to the state and data saved in a given
snapshot)</para>
<para>revertToVMSnapshot </para>
<para>Returns a virtual machine to the state and data saved in a given snapshot.</para>
</listitem>
<listitem>
<para>createLBHealthCheckPolicy (creates a new health check policy for a load balancer rule;
see <xref linkend="health-check"/>)</para>
<para>createLBHealthCheckPolicy </para>
<para>Creates a new health check policy for a load balancer rule.</para>
</listitem>
<listitem>
<para>deleteLBHealthCheckPolicy (deletes an existing health check policy from a load balancer
rule)</para>
<para>deleteLBHealthCheckPolicy</para>
<para>Deletes an existing health check policy from a load balancer rule.</para>
</listitem>
<listitem>
<para>listLBHealthCheckPolicies (displays the health check policy for a load balancer
rule)</para>
<para>listLBHealthCheckPolicies</para>
<para>Displays the health check policy for a load balancer rule.</para>
</listitem>
<listitem>
<para>createEgressFirewallRules (creates an egress firewall rule on the guest network; see
<xref linkend="egress-firewall"/>)</para>
<para>createEgressFirewallRules </para>
<para>Creates an egress firewall rule on the guest network.</para>
</listitem>
<listitem>
<para>deleteEgressFirewallRules (deletes a egress firewall rule on the guest network.)</para>
<para>deleteEgressFirewallRules </para>
<para>Deletes a egress firewall rule on the guest network.</para>
</listitem>
<listitem>
<para>listEgressFirewallRules (lists the egress firewall rules configured for a guest
network.)</para>
<para>listEgressFirewallRules </para>
<para>Lists the egress firewall rules configured for a guest network.</para>
</listitem>
<listitem>
<para>resetSSHKeyForVirtualMachine (Resets the SSHkey for virtual machine.)</para>
<para>resetSSHKeyForVirtualMachine </para>
<para>Resets the SSHkey for virtual machine.</para>
</listitem>
<listitem>
<para>addBaremetalHost (Adds a new host. Technically, this API command was present in v3.0.6,
but its functionality was disabled. See <xref linkend="baremetal"/>)</para>
<para>addBaremetalHost </para>
<para>Adds a new host. Technically, this API command was present in v3.0.6, but its
functionality was disabled.</para>
</listitem>
<listitem>
<para>addBaremetalDhcp (Adds a DHCP server for bare metal hosts)</para>
<para>addBaremetalDhcp </para>
<para>Adds a DHCP server for bare metal hosts.</para>
</listitem>
<listitem>
<para> addBaremetalPxePingServer (Adds a PXE PING server for bare metal hosts)</para>
<para> addBaremetalPxePingServer </para>
<para>Adds a PXE PING server for bare metal hosts.</para>
</listitem>
<listitem>
<para> addBaremetalPxeKickStartServer (Adds a PXE server for bare metal hosts)</para>
</listitem>
<listitem>
<para> listBaremetalDhcp (Shows the DHCP servers currently defined for bare metal
hosts)</para>
<para> listBaremetalDhcp </para>
<para>Shows the DHCP servers currently defined for bare metal hosts.</para>
</listitem>
<listitem>
<para> listBaremetalPxePingServer (Shows the PXE PING servers currently defined for bare metal
hosts)</para>
<para> listBaremetalPxePingServer </para>
<para>Shows the PXE PING servers currently defined for bare metal hosts.</para>
</listitem>
<listitem>
<para>addNicToVirtualMachine (Adds a new NIC to the specified VM on a selected network; see
<xref linkend="multiple-ip-nic"/>)</para>
<para>addNicToVirtualMachine </para>
<para>Adds a new NIC to the specified VM on a selected network.</para>
</listitem>
<listitem>
<para>removeNicFromVirtualMachine (Removes the specified NIC from a selected VM.)</para>
<para>removeNicFromVirtualMachine </para>
<para>Removes the specified NIC from a selected VM.</para>
</listitem>
<listitem>
<para>updateDefaultNicForVirtualMachine (Updates the specified NIC to be the default one for a
selected VM.)</para>
<para>updateDefaultNicForVirtualMachine </para>
<para>Updates the specified NIC to be the default one for a selected VM.</para>
</listitem>
<listitem>
<para>addRegion (Registers a Region into another Region; see <xref linkend="regions"/>)</para>
<para>addRegion </para>
<para>Registers a Region into another Region.</para>
</listitem>
<listitem>
<para>updateRegion (Updates Region details: ID, Name, Endpoint, User API Key, and User Secret
Key.)</para>
<para>updateRegion </para>
<para>Updates Region details: ID, Name, Endpoint, User API Key, and User Secret Key.</para>
</listitem>
<listitem>
<para>removeRegion (Removes a Region from current Region.)</para>
<para>removeRegion </para>
<para>Removes a Region from current Region.</para>
</listitem>
<listitem>
<para>listRegions (Get all the Regions. They can be filtered by using the ID or Name.)</para>
<para>listRegions </para>
<para>Get all the Regions. They can be filtered by using the ID or Name.</para>
</listitem>
<listitem>
<para>getUser (This API can only be used by the Admin. Get user account details by using the
API Key.) </para>
<para>getUser </para>
<para>This API can only be used by the Admin. Get user account details by using the API
Key.</para>
</listitem>
<listitem>
<para>getApiLimit (Show number of remaining APIs for the invoking user in current
window)</para>
<para>getApiLimit </para>
<para>Shows number of remaining APIs for the invoking user in current window.</para>
</listitem>
<listitem>
<para>resetApiLimit (For root admin, if account ID parameter is passed, it will reset count
for that particular account, otherwise it will reset all counters)</para>
<para>resetApiLimit </para>
<para>For root admin, if account ID parameter is passed, it will reset count for that
particular account, otherwise it will reset all counters.</para>
</listitem>
<listitem>
<para>lockAccount (Locks an account)</para>
<para>lockAccount </para>
<para>Locks an account.</para>
</listitem>
<listitem>
<para>lockUser (Locks a user account)</para>
<para>lockUser </para>
<para>Locks a user account.</para>
</listitem>
<listitem>
<para>scaleVirtualMachine (Scales the virtual machine to a new service offering.) </para>
<para>scaleVirtualMachine </para>
<para>Scales the virtual machine to a new service offering.</para>
</listitem>
<listitem>
<para>migrateVirtualMachineWithVolume (Attempts migrating VM with its volumes to a different
host.) </para>
<para>migrateVirtualMachineWithVolume </para>
<para>Attempts migrating VM with its volumes to a different host. </para>
</listitem>
<listitem>
<para>dedicatePublicIpRange (Dedicates a Public IP range to an account.) </para>
<para>dedicatePublicIpRange </para>
<para>Dedicates a Public IP range to an account.</para>
</listitem>
<listitem>
<para>releasePublicIpRange (Releases a Public IP range back to the system pool.) </para>
<para>releasePublicIpRange </para>
<para>Releases a Public IP range back to the system pool. </para>
</listitem>
<listitem>
<para>dedicateGuestVlanRange (Dedicates a guest VLAN range to an account.) </para>
<para>dedicateGuestVlanRange </para>
<para>Dedicates a guest VLAN range to an account. </para>
</listitem>
<listitem>
<para>releaseDedicatedGuestVlanRange (Releases a dedicated guest VLAN range to the system.)
</para>
<para>releaseDedicatedGuestVlanRange </para>
<para>Releases a dedicated guest VLAN range to the system.</para>
</listitem>
<listitem>
<para>listDedicatedGuestVlanRanges (Lists dedicated guest VLAN ranges.) </para>
<para>listDedicatedGuestVlanRanges </para>
<para>Lists dedicated guest VLAN ranges.</para>
</listitem>
<listitem>
<para>updatePortForwardingRule (Updates a port forwarding rule. Only the private port and the
VM can be updated.) </para>
<para>updatePortForwardingRule </para>
<para>Updates a port forwarding rule. Only the private port and the VM can be updated. </para>
</listitem>
<listitem>
<para>scaleSystemVm (Scale the service offering for a systemVM, console proxy, or secondary
storage. The system VM must be in Stopped state for this command to take effect.) </para>
<para>scaleSystemVm </para>
<para>Scales the service offering for a systemVM, console proxy, or secondary storage. The
system VM must be in Stopped state for this command to take effect.</para>
</listitem>
<listitem>
<para>listDeploymentPlanners (Lists all the deployment planners available.) </para>
<para>listDeploymentPlanners </para>
<para>Lists all the deployment planners available.</para>
</listitem>
<listitem>
<para>addS3 (Adds a Amazon Simple Storage Service instance.) </para>
<para>addS3 </para>
<para>Adds a Amazon Simple Storage Service instance.</para>
</listitem>
<listitem>
<para>listS3s (Lists all the Amazon Simple Storage Service instances.) </para>
<para>listS3s </para>
<para>Lists all the Amazon Simple Storage Service instances. </para>
</listitem>
<listitem>
<para>findHostsForMigration (Find hosts suitable for migrating a VM to.) </para>
<para>findHostsForMigration </para>
<para>Finds hosts suitable for migrating a VM to.</para>
</listitem>
<listitem>
<para>releaseHostReservation (Releases host reservation.) </para>
<para>releaseHostReservation </para>
<para>Releases host reservation.</para>
</listitem>
<listitem>
<para>resizeVolume (Resizes a volume.) </para>
<para>resizeVolume </para>
<para>Resizes a volume.</para>
</listitem>
<listitem>
<para>updateVolume (Updates the volume.) </para>
<para>updateVolume </para>
<para>Updates the volume.</para>
</listitem>
<listitem>
<para>listStorageProviders (Lists storage providers.) </para>
<para>listStorageProviders </para>
<para>Lists storage providers. </para>
</listitem>
<listitem>
<para>findStoragePoolsForMigration (Lists storage pools available for migrating a volume.)
</para>
<para>findStoragePoolsForMigration </para>
<para>Lists storage pools available for migrating a volume. </para>
</listitem>
<listitem>
<para>createEgressFirewallRule (Creates a egress firewall rule for a given network. ) </para>
<para>createEgressFirewallRule </para>
<para>Creates a egress firewall rule for a given network. </para>
</listitem>
<listitem>
<para>deleteEgressFirewallRule (Deletes an egress firewall rule.) </para>
<para>deleteEgressFirewallRule </para>
<para>Deletes an egress firewall rule.</para>
</listitem>
<listitem>
<para>listEgressFirewallRules (Lists all egress firewall rules for network.) </para>
<para>listEgressFirewallRules </para>
<para>Lists all egress firewall rules for network.</para>
</listitem>
<listitem>
<para>updateNetworkACLItem (Updates ACL item with specified ID.) </para>
<para>updateNetworkACLItem </para>
<para>Updates ACL item with specified ID.</para>
</listitem>
<listitem>
<para>createNetworkACLList (Creates a Network ACL for the given VPC.) </para>
<para>createNetworkACLList </para>
<para>Creates a Network ACL for the given VPC. </para>
</listitem>
<listitem>
<para>deleteNetworkACLList (Deletes a Network ACL.) </para>
<para>deleteNetworkACLList </para>
<para>Deletes a Network ACL. </para>
</listitem>
<listitem>
<para>replaceNetworkACLList (Replaces ACL associated with a Network or private gateway.)
</para>
<para>replaceNetworkACLList </para>
<para>Replaces ACL associated with a Network or private gateway.</para>
</listitem>
<listitem>
<para>listNetworkACLLists (Lists all network ACLs.) </para>
<para>listNetworkACLLists </para>
<para>Lists all network ACLs.</para>
</listitem>
<listitem>
<para>addResourceDetail (Adds detail for the Resource.) </para>
<para>addResourceDetail </para>
<para>Adds detail for the Resource. </para>
</listitem>
<listitem>
<para>removeResourceDetail (Removes detail for the Resource.) </para>
<para>removeResourceDetail </para>
<para>Removes details of the resource.</para>
</listitem>
<listitem>
<para>listResourceDetails (List resource details.) </para>
<para>listResourceDetails </para>
<para>Lists resource details. </para>
</listitem>
<listitem>
<para>addNiciraNvpDevice (Adds a Nicira NVP device.) </para>
<para>addNiciraNvpDevice </para>
<para>Adds a Nicira NVP device.</para>
</listitem>
<listitem>
<para>deleteNiciraNvpDevice (Deletes a Nicira NVP device.) </para>
<para>deleteNiciraNvpDevice </para>
<para>Deletes a Nicira NVP device.</para>
</listitem>
<listitem>
<para>listNiciraNvpDevices (Lists Nicira NVP devices.) </para>
<para>listNiciraNvpDevices </para>
<para>Lists Nicira NVP devices.</para>
</listitem>
<listitem>
<para>listNiciraNvpDeviceNetworks (Lists network that are using a Nicira NVP device.) </para>
<para>listNiciraNvpDeviceNetworks </para>
<para>Lists network that are using a Nicira NVP device.</para>
</listitem>
<listitem>
<para>addBigSwitchVnsDevice (Adds a BigSwitch VNS device.) </para>
<para>addBigSwitchVnsDevice </para>
<para>Adds a BigSwitch VNS device.</para>
</listitem>
<listitem>
<para>deleteBigSwitchVnsDevice (Deletes a BigSwitch VNS device.) </para>
<para>deleteBigSwitchVnsDevice </para>
<para>Deletes a BigSwitch VNS device.</para>
</listitem>
<listitem>
<para>listBigSwitchVnsDevices (Lists BigSwitch VNS devices.) </para>
<para>listBigSwitchVnsDevices </para>
<para>Lists BigSwitch VNS devices.</para>
</listitem>
<listitem>
<para>configureSimulator (Configures a simulator.) </para>
<para>configureSimulator </para>
<para>Configures a simulator.</para>
</listitem>
<listitem>
<para>listApis (Lists all the available APIs on the server, provided by the API Discovery
plugin.) </para>
<para>listApis </para>
<para>Lists all the available APIs on the server, provided by the API Discovery plugin. </para>
</listitem>
<listitem>
<para>getApiLimit (Get the API limit count for the caller.) </para>
<para>getApiLimit </para>
<para>Gets the API limit count for the caller. </para>
</listitem>
<listitem>
<para>resetApiLimit (Reset the API count.) </para>
<para>resetApiLimit </para>
<para>Resets the API count.</para>
</listitem>
<listitem>
<para>assignToGlobalLoadBalancerRule (Assign load balancer rule or list of load balancer rules
to a global load balancer rules.) </para>
<para>assignToGlobalLoadBalancerRule </para>
<para>Assigns load balancer rule or list of load balancer rules to a global load balancer
rules.</para>
</listitem>
<listitem>
<para>removeFromGlobalLoadBalancerRule (Removes a load balancer rule association with global
load balancer rule) </para>
<para>removeFromGlobalLoadBalancerRule </para>
<para>Removes a load balancer rule association with global load balancer rule.</para>
</listitem>
<listitem>
<para>listVMSnapshot (List virtual machine snapshot by conditions) </para>
<para>listVMSnapshot </para>
<para>Lists virtual machine snapshot by conditions.</para>
</listitem>
<listitem>
<para>createLoadBalancer (Creates a Load Balancer) </para>
<para>createLoadBalancer </para>
<para>Creates a load balancer.</para>
</listitem>
<listitem>
<para>listLoadBalancers (Lists Load Balancers) </para>
<para>listLoadBalancers </para>
<para>Lists load balancers.</para>
</listitem>
<listitem>
<para>deleteLoadBalancer (Deletes a load balancer) </para>
<para>deleteLoadBalancer </para>
<para>Deletes a load balancer. </para>
</listitem>
<listitem>
<para>configureInternalLoadBalancerElement (Configures an Internal Load Balancer element.)
</para>
<para>configureInternalLoadBalancerElement </para>
<para>Configures an Internal Load Balancer element.</para>
</listitem>
<listitem>
<para>createInternalLoadBalancerElement (Create an Internal Load Balancer element.) </para>
<para>createInternalLoadBalancerElement </para>
<para>Creates an Internal Load Balancer element.</para>
</listitem>
<listitem>
<para>listInternalLoadBalancerElements (Lists all available Internal Load Balancer elements.)
</para>
<para>listInternalLoadBalancerElements </para>
<para>Lists all available Internal Load Balancer elements.</para>
</listitem>
<listitem>
<para>createAffinityGroup (Creates an affinity or anti-affinity group.) </para>
<para>createAffinityGroup </para>
<para>Creates an affinity or anti-affinity group.</para>
</listitem>
<listitem>
<para>deleteAffinityGroup (Deletes an affinity group.) </para>
<para>deleteAffinityGroup </para>
<para>Deletes an affinity group.</para>
</listitem>
<listitem>
<para>listAffinityGroups (Lists all the affinity groups.)</para>
<para>listAffinityGroups </para>
<para>Lists all the affinity groups.</para>
</listitem>
<listitem>
<para>updateVMAffinityGroup (Updates the affinity or anti-affinity group associations of a VM.
The VM has to be stopped and restarted for the new properties to take effect.) </para>
<para>updateVMAffinityGroup </para>
<para>Updates the affinity or anti-affinity group associations of a VM. The VM has to be
stopped and restarted for the new properties to take effect.</para>
</listitem>
<listitem>
<para>listAffinityGroupTypes (Lists affinity group types available.) </para>
<para>listAffinityGroupTypes </para>
<para>Lists affinity group types available. </para>
</listitem>
<listitem>
<para>stopInternalLoadBalancerVM (Stops an Internal LB VM.) </para>
<para>stopInternalLoadBalancerVM </para>
<para>Stops an Internal LB VM.</para>
</listitem>
<listitem>
<para>startInternalLoadBalancerVM (Starts an existing Internal LB VM.) </para>
<para>startInternalLoadBalancerVM </para>
<para>Starts an existing Internal LB VM.</para>
</listitem>
<listitem>
<para>listInternalLoadBalancerVMs (List internal LB VMs.) </para>
<para>listInternalLoadBalancerVMs </para>
<para>Lists internal LB VMs.</para>
</listitem>
<listitem>
<para>listNetworkIsolationMethods (Lists supported methods of network isolation.) </para>
<para>listNetworkIsolationMethods </para>
<para>Lists supported methods of network isolation.</para>
</listitem>
<listitem>
<para>dedicateZone (Dedicates a zone.) </para>
<para>dedicateZone </para>
<para>Dedicates a zone.</para>
</listitem>
<listitem>
<para>dedicatePod (Dedicates a pod.) </para>
<para>dedicatePod </para>
<para>Dedicates a pod. </para>
</listitem>
<listitem>
<para>dedicateCluster (Dedicate an existing cluster.) </para>
<para>dedicateCluster </para>
<para>Dedicates an existing cluster. </para>
</listitem>
<listitem>
<para>dedicateHost (Dedicates a host.) </para>
<para>dedicateHost </para>
<para>Dedicates a host.</para>
</listitem>
<listitem>
<para>releaseDedicatedZone (Release dedication of zone.) </para>
<para>releaseDedicatedZone </para>
<para>Releases dedication of zone. </para>
</listitem>
<listitem>
<para>releaseDedicatedPod (Release dedication for the pod.) </para>
<para>releaseDedicatedPod </para>
<para>Releases dedication for the pod. </para>
</listitem>
<listitem>
<para>releaseDedicatedCluster (Release dedication for cluster.) </para>
<para>releaseDedicatedCluster </para>
<para>Releases dedication for cluster. </para>
</listitem>
<listitem>
<para>releaseDedicatedHost (Release dedication for host.) </para>
<para>releaseDedicatedHost </para>
<para>Releases dedication for host. </para>
</listitem>
<listitem>
<para>listDedicatedZones (List dedicated zones.) </para>
<para>listDedicatedZones </para>
<para>Lists dedicated zones. </para>
</listitem>
<listitem>
<para>listDedicatedPods (Lists dedicated pods.) </para>
<para>listDedicatedPods </para>
<para>Lists dedicated pods.</para>
</listitem>
<listitem>
<para>listDedicatedClusters (Lists dedicated clusters.) </para>
<para>listDedicatedClusters </para>
<para>Lists dedicated clusters.</para>
</listitem>
<listitem>
<para>listDedicatedHosts (Lists dedicated hosts.) </para>
<para>listDedicatedHosts </para>
<para>Lists dedicated hosts. </para>
</listitem>
</itemizedlist>
</section>

View File

@ -388,24 +388,21 @@
<row>
<entry><para>listCapabilities</para></entry>
<entry><para>The following new response parameters are added: apilimitinterval and
apilimitmax.</para>
<para>See <xref linkend="api-request-throttling"/>.</para></entry>
apilimitmax.</para></entry>
</row>
<row>
<entry><para>createServiceOffering</para></entry>
<entry><para>The following new request parameters are added: deploymentplanner (optional),
isvolatile (optional), serviceofferingdetails (optional). </para>
<para>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. See <xref
linkend="reset-vm-reboot"/>.</para>
which will discard the VM's root disk and create a new one on reboot.</para>
<para>The following new response parameters are added: deploymentplanner, isvolatile
</para></entry>
</row>
<row>
<entry><para>restoreVirtualMachine</para></entry>
<entry><para>The following request parameter is added: templateID (optional). This is used
to point to the new template ID when the base image is updated. See <xref
linkend="update-vm-image"/>.</para>
<entry><para>The following request parameter is added: templateID (optional). This is used to point to the
new template ID when the base image is updated.</para>
<para>The following response parameters are added: diskioread, diskiowrite, diskkbsread,
diskkbswrite, displayvm, isdynamicallyscalable, affinitygroup</para></entry>
</row>
@ -564,7 +561,6 @@
<entry><para>The following request parameters are added: cpuovercommitratio (optional),
guestvswitchtype (optional), guestvswitchtype (optional), memoryovercommitratio
(optional), publicvswitchtype (optional), publicvswitchtype (optional)</para>
<para>See <xref linkend="cpu-ram-overcommit"/>.</para>
<para>The following request parameters are added: cpuovercommitratio,
memoryovercommitratio </para>
</entry>
@ -573,7 +569,6 @@
<entry><para>updateCluster</para></entry>
<entry><para>The following request parameters are added: cpuovercommitratio,
ramovercommitratio</para>
<para>See <xref linkend="cpu-ram-overcommit"/>.</para>
</entry>
</row>
<row>
@ -584,7 +579,6 @@
<para>The following request parameters are added: hypervisor (optional), provider
(optional), scope (optional) </para>
<para>The following request parameters have been made mandatory: podid, clusterid</para>
<para>See <xref linkend="zone-wide-primary-storage"/>.</para>
<para>The following response parameter has been added: hypervisor, scope,
suitableformigration </para>
</entry>
@ -592,7 +586,6 @@
<row>
<entry><para>listStoragePools</para></entry>
<entry><para>The following request parameter is added: scope (optional)</para>
<para>See <xref linkend="zone-wide-primary-storage"/>.</para>
<para>The following response parameters are added: hypervisor, scope,
suitableformigration </para></entry>
</row>