From 7da1e8a7f3224400e746844baca72dfed735d390 Mon Sep 17 00:00:00 2001 From: radhikap Date: Tue, 16 Jul 2013 14:21:54 +0530 Subject: [PATCH] CLOUDSTACK-3547 --- docs/en-US/added-API-commands-4.2.xml | 335 +++++++++++++++++++++++++- 1 file changed, 330 insertions(+), 5 deletions(-) diff --git a/docs/en-US/added-API-commands-4.2.xml b/docs/en-US/added-API-commands-4.2.xml index 177c9a0e6ea..ddf80b19f13 100644 --- a/docs/en-US/added-API-commands-4.2.xml +++ b/docs/en-US/added-API-commands-4.2.xml @@ -118,20 +118,345 @@ key/value pairs) - createPortableIpAddressRange - Creates portable IP addresses from the portable public IP address pool. + createPortableIpRange + Creates portable IP addresses in the portable public IP address pool. The request parameters are region id, start ip, end ip, netmask, gateway, and vlan. - deletePortableIpAddressRange + deletePortableIpRange Deletes portable IP addresses from the portable public IP address pool. The request parameters is portable ip address range id. - createPortableIpAddressRange - Lists portable IP addresses in the portable public IP address pool. + listPortableIpRange + Lists portable IP addresses in the portable public IP address pool associated with a + Region. The request parameters are elastic ip id and region id. + + createVMSnapshot (create a virtual machine snapshot) + + + deleteVMSnapshot (delete a virtual machine snapshot) + + + listVMSnapshot (show a virtual machine snapshot) + + + revertToVMSnapshot (return a virtual machine to the state and data saved in a given + snapshot) + + + createLBHealthCheckPolicy (creates a new health check policy for a load balancer rule; + see ) + + + deleteLBHealthCheckPolicy (deletes an existing health check policy from a load balancer + rule) + + + listLBHealthCheckPolicies (displays the health check policy for a load balancer + rule) + + + createEgressFirewallRules (creates an egress firewall rule on the guest network; see + ) + + + deleteEgressFirewallRules (deletes a egress firewall rule on the guest network.) + + + listEgressFirewallRules (lists the egress firewall rules configured for a guest + network.) + + + resetSSHKeyForVirtualMachine (Resets the SSHkey for virtual machine.) + + + addBaremetalHost (Adds a new host. Technically, this API command was present in v3.0.6, + but its functionality was disabled. See ) + + + addBaremetalDhcp (Adds a DHCP server for bare metal hosts) + + + addBaremetalPxePingServer (Adds a PXE PING server for bare metal hosts) + + + addBaremetalPxeKickStartServer (Adds a PXE server for bare metal hosts) + + + listBaremetalDhcp (Shows the DHCP servers currently defined for bare metal + hosts) + + + listBaremetalPxePingServer (Shows the PXE PING servers currently defined for bare metal + hosts) + + + addNicToVirtualMachine (Adds a new NIC to the specified VM on a selected network; see + ) + + + removeNicFromVirtualMachine (Removes the specified NIC from a selected VM.) + + + updateDefaultNicForVirtualMachine (Updates the specified NIC to be the default one for a + selected VM.) + + + addRegion (Registers a Region into another Region; see ) + + + updateRegion (Updates Region details: ID, Name, Endpoint, User API Key, and User Secret + Key.) + + + removeRegion (Removes a Region from current Region.) + + + listRegions (Get all the Regions. They can be filtered by using the ID or Name.) + + + getUser (This API can only be used by the Admin. Get user account details by using the + API Key.) + + + getApiLimit (Show number of remaining APIs for the invoking user in current + window) + + + resetApiLimit (For root admin, if account ID parameter is passed, it will reset count + for that particular account, otherwise it will reset all counters) + + + lockAccount (Locks an account) + + + lockUser (Locks a user account) + + + scaleVirtualMachine (Scales the virtual machine to a new service offering.) + + + migrateVirtualMachineWithVolume (Attempts migrating VM with its volumes to a different + host.) + + + dedicatePublicIpRange (Dedicates a Public IP range to an account.) + + + releasePublicIpRange (Releases a Public IP range back to the system pool.) + + + dedicateGuestVlanRange (Dedicates a guest VLAN range to an account.) + + + releaseDedicatedGuestVlanRange (Releases a dedicated guest VLAN range to the system.) + + + + listDedicatedGuestVlanRanges (Lists dedicated guest VLAN ranges.) + + + updatePortForwardingRule (Updates a port forwarding rule. Only the private port and the + VM can be updated.) + + + 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.) + + + listDeploymentPlanners (Lists all the deployment planners available.) + + + addS3 (Adds a Amazon Simple Storage Service instance.) + + + listS3s (Lists all the Amazon Simple Storage Service instances.) + + + findHostsForMigration (Find hosts suitable for migrating a VM to.) + + + releaseHostReservation (Releases host reservation.) + + + resizeVolume (Resizes a volume.) + + + updateVolume (Updates the volume.) + + + listStorageProviders (Lists storage providers.) + + + findStoragePoolsForMigration (Lists storage pools available for migrating a volume.) + + + + createEgressFirewallRule (Creates a egress firewall rule for a given network. ) + + + deleteEgressFirewallRule (Deletes an egress firewall rule.) + + + listEgressFirewallRules (Lists all egress firewall rules for network.) + + + updateNetworkACLItem (Updates ACL item with specified ID.) + + + createNetworkACLList (Creates a Network ACL for the given VPC.) + + + deleteNetworkACLList (Deletes a Network ACL.) + + + replaceNetworkACLList (Replaces ACL associated with a Network or private gateway.) + + + + listNetworkACLLists (Lists all network ACLs.) + + + addResourceDetail (Adds detail for the Resource.) + + + removeResourceDetail (Removes detail for the Resource.) + + + listResourceDetails (List resource details.) + + + addNiciraNvpDevice (Adds a Nicira NVP device.) + + + deleteNiciraNvpDevice (Deletes a Nicira NVP device.) + + + listNiciraNvpDevices (Lists Nicira NVP devices.) + + + listNiciraNvpDeviceNetworks (Lists network that are using a Nicira NVP device.) + + + addBigSwitchVnsDevice (Adds a BigSwitch VNS device.) + + + deleteBigSwitchVnsDevice (Deletes a BigSwitch VNS device.) + + + listBigSwitchVnsDevices (Lists BigSwitch VNS devices.) + + + configureSimulator (Configures a simulator.) + + + listApis (Lists all the available APIs on the server, provided by the API Discovery + plugin.) + + + getApiLimit (Get the API limit count for the caller.) + + + resetApiLimit (Reset the API count.) + + + assignToGlobalLoadBalancerRule (Assign load balancer rule or list of load balancer rules + to a global load balancer rules.) + + + removeFromGlobalLoadBalancerRule (Removes a load balancer rule association with global + load balancer rule) + + + listVMSnapshot (List virtual machine snapshot by conditions) + + + createLoadBalancer (Creates a Load Balancer) + + + listLoadBalancers (Lists Load Balancers) + + + deleteLoadBalancer (Deletes a load balancer) + + + configureInternalLoadBalancerElement (Configures an Internal Load Balancer element.) + + + + createInternalLoadBalancerElement (Create an Internal Load Balancer element.) + + + listInternalLoadBalancerElements (Lists all available Internal Load Balancer elements.) + + + + createAffinityGroup (Creates an affinity or anti-affinity group.) + + + deleteAffinityGroup (Deletes an affinity group.) + + + listAffinityGroups (Lists all the affinity groups.) + + + 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.) + + + listAffinityGroupTypes (Lists affinity group types available.) + + + stopInternalLoadBalancerVM (Stops an Internal LB VM.) + + + startInternalLoadBalancerVM (Starts an existing Internal LB VM.) + + + listInternalLoadBalancerVMs (List internal LB VMs.) + + + listNetworkIsolationMethods (Lists supported methods of network isolation.) + + + dedicateZone (Dedicates a zone.) + + + dedicatePod (Dedicates a pod.) + + + dedicateCluster (Dedicate an existing cluster.) + + + dedicateHost (Dedicates a host.) + + + releaseDedicatedZone (Release dedication of zone.) + + + releaseDedicatedPod (Release dedication for the pod.) + + + releaseDedicatedCluster (Release dedication for cluster.) + + + releaseDedicatedHost (Release dedication for host.) + + + listDedicatedZones (List dedicated zones.) + + + listDedicatedPods (Lists dedicated pods.) + + + listDedicatedClusters (Lists dedicated clusters.) + + + listDedicatedHosts (Lists dedicated hosts.) +