From c5669d5dc58a70cd15c1de984b7d2b26f5c5fd79 Mon Sep 17 00:00:00 2001 From: Joe Brockmeier Date: Wed, 17 Apr 2013 18:40:18 -0500 Subject: [PATCH] CLOUDSTACK-1102: Adding APIs to the release notes. --- docs/en-US/Release_Notes.xml | 677 ++++++++++++++++++++--------------- 1 file changed, 385 insertions(+), 292 deletions(-) diff --git a/docs/en-US/Release_Notes.xml b/docs/en-US/Release_Notes.xml index 42ab6eac7d7..d07c18e4956 100644 --- a/docs/en-US/Release_Notes.xml +++ b/docs/en-US/Release_Notes.xml @@ -5184,297 +5184,390 @@ under the License. API Changes in 4.1.0
- New API commands in 4.1 - - - lockAccount (Locks an account) - - - lockUser (Locks a user account) - - - resetSSHKeyForVirtualMachine (Resets the SSH Key for virtual machine. The virtual machine must be in a "Stopped" state. [async]) - - - updatePortForwardingRule (Updates a port forwarding rule. Only the private port and the virtual machine can be updated.) - - - createCounter (Adds metric counter) - - - createCondition (Creates a condition) - - - createAutoScalePolicy - (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.) - - - createAutoScaleVmProfile - (Creates a profile that contains information about the virtual machine which will be provisioned automatically by autoscale feature.) - - - createAutoScaleVmGroup (Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.) - - - deleteCounter (Deletes a counter) - - - deleteCondition (Removes a condition) - - - deleteAutoScalePolicy (Deletes a autoscale policy.) - - - deleteAutoScaleVmProfile (Deletes a autoscale vm profile.) - - - deleteAutoScaleVmGroup (Deletes a autoscale vm group.) - - - listCounters (List the counters) - - - listConditions (List Conditions for the specific user) - - - listAutoScalePolicies (Lists autoscale policies.) - - - listAutoScaleVmProfiles (Lists autoscale vm profiles.) - - - listAutoScaleVmGroups (Lists autoscale vm groups.) - - - enableAutoScaleVmGroup (Enables an AutoScale Vm Group) - - - disableAutoScaleVmGroup (Disables an AutoScale Vm Group) - - - updateAutoScalePolicy (Updates an existing autoscale policy.) - - - updateAutoScaleVmProfile (Updates an existing autoscale vm profile.) - - - updateAutoScaleVmGroup (Updates an existing autoscale vm group.) - - - addS3 (Adds S3) - - - listS3s (Lists S3s) - - - resizeVolume (Resizes a volume) - - - addNicToVirtualMachine (Adds VM to specified network by creating a NIC) - - - removeNicFromVirtualMachine (Removes VM from specified network by deleting a NIC) - - - updateDefaultNicForVirtualMachine (Changes the default NIC on a VM) - - - createEgressFirewallRule (Creates a egress firewall rule for a given network ) - - - deleteEgressFirewallRule (Deletes an ggress firewall rule) - - - listEgressFirewallRules (Lists all egress firewall rules for network id.) - - - addBigSwitchVnsDevice (Adds a BigSwitch VNS device) - - - deleteBigSwitchVnsDevice ( delete a bigswitch vns device) - - - listBigSwitchVnsDevices (Lists BigSwitch Vns devices) - - - listApis (lists all available apis on the server, provided by the Api Discovery plugin) - - - getApiLimit (Get API limit count for the caller) - - - resetApiLimit (Reset api count) - - - addRegion (Adds a Region) - - - updateRegion (Updates a region) - - - removeRegion (Removes specified region) - - - listRegions (Lists Regions) - - + New API commands in 4.1 + + + lockAccount (Locks an account) + + + lockUser (Locks a user account) + + + resetSSHKeyForVirtualMachine (Resets the SSH Key for virtual machine. The virtual machine must be in a "Stopped" state. [async]) + + + updatePortForwardingRule (Updates a port forwarding rule. Only the private port and the virtual machine can be updated.) + + + createCounter (Adds metric counter) + + + createCondition (Creates a condition) + + + createAutoScalePolicy + (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.) + + + createAutoScaleVmProfile + (Creates a profile that contains information about the virtual machine which will be provisioned automatically by autoscale feature.) + + + createAutoScaleVmGroup (Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.) + + + deleteCounter (Deletes a counter) + + + deleteCondition (Removes a condition) + + + deleteAutoScalePolicy (Deletes a autoscale policy.) + + + deleteAutoScaleVmProfile (Deletes a autoscale vm profile.) + + + deleteAutoScaleVmGroup (Deletes a autoscale vm group.) + + + listCounters (List the counters) + + + listConditions (List Conditions for the specific user) + + + listAutoScalePolicies (Lists autoscale policies.) + + + listAutoScaleVmProfiles (Lists autoscale vm profiles.) + + + listAutoScaleVmGroups (Lists autoscale vm groups.) + + + enableAutoScaleVmGroup (Enables an AutoScale Vm Group) + + + disableAutoScaleVmGroup (Disables an AutoScale Vm Group) + + + updateAutoScalePolicy (Updates an existing autoscale policy.) + + + updateAutoScaleVmProfile (Updates an existing autoscale vm profile.) + + + updateAutoScaleVmGroup (Updates an existing autoscale vm group.) + + + addS3 (Adds S3) + + + listS3s (Lists S3s) + + + resizeVolume (Resizes a volume) + + + addNicToVirtualMachine (Adds VM to specified network by creating a NIC) + + + removeNicFromVirtualMachine (Removes VM from specified network by deleting a NIC) + + + updateDefaultNicForVirtualMachine (Changes the default NIC on a VM) + + + createEgressFirewallRule (Creates a egress firewall rule for a given network ) + + + deleteEgressFirewallRule (Deletes an ggress firewall rule) + + + listEgressFirewallRules (Lists all egress firewall rules for network id.) + + + addBigSwitchVnsDevice (Adds a BigSwitch VNS device) + + + deleteBigSwitchVnsDevice ( delete a bigswitch vns device) + + + listBigSwitchVnsDevices (Lists BigSwitch Vns devices) + + + listApis (lists all available apis on the server, provided by the Api Discovery plugin) + + + getApiLimit (Get API limit count for the caller) + + + resetApiLimit (Reset api count) + + + addRegion (Adds a Region) + + + updateRegion (Updates a region) + + + removeRegion (Removes specified region) + + + listRegions (Lists Regions) + +
- Changed API commands in 4.1 -
- Changes in command type (sync versus async) - - - deleteNiciraNvpDevice became Async - - - addNiciraNvpDevice became Async - - -
-
- Changes in command arguments - - - copyTemplate Response: New parameters: sshkeyenabled - - - listRouters Response: New parameters: ip6dns1, ip6dns2 - - - listNiciraNvpDeviceNetworks Response: New parameters: ip6cidr, ip6gateway, ispersistent - - - createVlanIpRange Request: New parameters: endipv6 (optional), ip6cidr (optional), ip6gateway (optional), startipv6 (optional) Changed parameters: startip (old version - required, new version - optional) Response: New parameters: endipv6, ip6cidr, ip6gateway, startipv6 - - - listNetworkOfferings Response: New parameters: ispersistent registerTemplate Response: New parameters: sshkeyenabled - - - addTrafficMonitor Request: New parameters: excludezones (optional), includezones (optional) Response: Removed parameters: privateinterface, privatezone, publicinterface, publiczone, usageinterface, username - - - createAccount Request: New parameters: accountid (optional), userid (optional) Response: New parameters: iscallerchilddomain - - - listTrafficMonitors Response: Removed parameters: privateinterface, privatezone, publicinterface, publiczone, usageinterface, username - - - registerSSHKeyPair Response: New parameters: privatekey - - - createNetwork Request: New parameters: endipv6 (optional), ip6cidr (optional), ip6gateway (optional), startipv6 (optional) Response: New parameters: ip6cidr, ip6gateway, ispersistent getUser Response: New parameters: iscallerchilddomain - - - stopRouter Response: New parameters: ip6dns1, ip6dns2 - - - listTemplates Response: New parameters: sshkeyenabled - - - listNetworks Response: New parameters: ip6cidr, ip6gateway, ispersistent prepareTemplate Response: New parameters: sshkeyenabled - - - changeServiceForRouter Response: New parameters: ip6dns1, ip6dns2 - - - updateZone Request: New parameters: ip6dns1 (optional), ip6dns2 (optional) Response: New parameters: ip6dns1, ip6dns2 - - - createSSHKeyPair Response: New parameters: privatekey - - - listFirewallRules Response: New parameters: networkid - - - updateUser Response: New parameters: iscallerchilddomain - - - createZone Request: New parameters: ip6dns1 (optional), ip6dns2 (optional) Response: New parameters: ip6dns1, ip6dns2 - - - createStoragePool Request: Changed parameters: podid (old version - optional, new version - required), clusterid (old version - optional, new version - required) - - - updateTemplate Response: New parameters: sshkeyenabled disableUser Response: New parameters: iscallerchilddomain - - - listSSHKeyPairs Response: New parameters: privatekey - - - listNiciraNvpDevices Response: New parameters: hostname, l3gatewayserviceuuid, transportzoneuuid - - - registerIso Response: New parameters: sshkeyenabled - - - listZones Request: New parameters: name (optional) Response: New parameters: ip6dns1, ip6dns2 - - - startRouter Response: New parameters: ip6dns1, ip6dns2 - - - listCapabilities Response: New parameters: apilimitinterval, apilimitmax - - - deployVirtualMachine Request: New parameters: ip6address (optional - - - addVpnUser Response: New parameters: state - - - destroyRouter Response: New parameters: ip6dns1, ip6dns2 - - - enableUser Response: New parameters: iscallerchilddomain - - - addNiciraNvpDevice Request: New parameters: l3gatewayserviceuuid (optional) Response: New parameters: hostname, l3gatewayserviceuuid, transportzoneuuid - - - createNetworkOffering Request: New parameters: ispersistent (optional) Response: New parameters: ispersistent - - - copyIso Response: New parameters: sshkeyenabled - - - createDomain Request: New parameters: domainid (optional) - - - updateIso Response: New parameters: sshkeyenabled - - - updateNetwork Response: New parameters: ip6cidr, ip6gateway, ispersistent - - - rebootRouter Response: New parameters: ip6dns1, ip6dns2 - - - createFirewallRule Response: New parameters: networkid - - - createUser Request: New parameters: userid (optional) Response: New parameters: iscallerchilddomain - - - deleteUser Response: New parameters: displaytext, success Removed parameters: id, account, accountid, accounttype, apikey, created, domain, domainid, email, firstname, lastname, secretkey, state, timezone, username - - - listVlanIpRanges Response: New parameters: endipv6, ip6cidr, ip6gateway, startipv6 - - - updateNetworkOffering Response: New parameters: ispersistent - - - listVpnUsers Response: New parameters: state - - - listUsers Response: New parameters: iscallerchilddomain - - - listIsos Response: New parameters: sshkeyenabled - - -
-
- - + Changed API commands in 4.1 +
+ Changes in command type (sync versus async) + + + deleteNiciraNvpDevice became Async + + + addNiciraNvpDevice became Async + + +
+
+ Changes in command arguments + + + + + + + API Commands + Change Description + + + + + + copyTemplate + + + New response parameters: sshkeyenabled + + + + listRouters + New response parameters: ip6dns1, ip6dns2 + + + listNiciraNvpDeviceNetworks + New response parameters: ip6cidr, ip6gateway, ispersistent + + + createVlanIpRange + New request parameters: endipv6 (optional), ip6cidr (optional), ip6gateway (optional), startipv6 (optional) + Changed parameters: startip (old version - required, new version - optional) + New response parameters: endipv6, ip6cidr, ip6gateway, startipv6 + + + + listNetworkOfferings + New response parameters: ispersistent + + + registerTemplate + New response parameters: sshkeyenabled + + + addTrafficMonitor + New request parameters: excludezones (optional), includezones (optional) + Removed response parameters: privateinterface, privatezone, publicinterface, publiczone, usageinterface, username + + + + createAccount + New request parameters: accountid (optional), userid (optional) + New response parameters: iscallerchilddomain + + + + listTrafficMonitors + Removed response parameters: privateinterface, privatezone, publicinterface, publiczone, usageinterface, username + + + registerSSHKeyPair + New response parameters: privatekey + + + createNetwork + New request parameters: endipv6 (optional), ip6cidr (optional), ip6gateway (optional), startipv6 (optional) + New response parameters: ip6cidr, ip6gateway, ispersistent + + + getUser + New response parameters: iscallerchilddomain + + + stopRouter + New response parameters: ip6dns1, ip6dns2 + + + listTemplates + New response parameters: sshkeyenabled + + + listNetworks + New response parameters: ip6cidr, ip6gateway, ispersistent + + + prepareTemplate + New response parameters: sshkeyenabled + + + changeServiceForRouter + New response parameters: ip6dns1, ip6dns2 + + + updateZone + New request parameters: ip6dns1 (optional), ip6dns2 (optional) + New response parameters: ip6dns1, ip6dns2 + + + createSSHKeyPair + New response parameters: privatekey + + + listFirewallRules + New response parameters: networkid + + + updateUser + New response parameters: iscallerchilddomain + + + createZone + New request parameters: ip6dns1 (optional), ip6dns2 (optional) + New response parameters: ip6dns1, ip6dns2 + + + createStoragePool + Changed request parameters: podid (old version - optional, new version - required), clusterid (old version - optional, new version - required) + + + updateTemplate + New response parameters: sshkeyenabled + + + disableUser + New response parameters: iscallerchilddomain + + + listSSHKeyPairs + New response parameters: privatekey + + + listNiciraNvpDevices + New response parameters: hostname, l3gatewayserviceuuid, transportzoneuuid + + + registerIso + New response parameters: sshkeyenabled + + + listZones + New request parameters: name (optional) + New response parameters: ip6dns1, ip6dns2 + + + startRouter + New response parameters: ip6dns1, ip6dns2 + + + listCapabilities + New response parameters: apilimitinterval, apilimitmax + + + deployVirtualMachine + New request parameters: ip6address (optional) + + + addVpnUser + New response parameters: state + + + destroyRouter + New response parameters: ip6dns1, ip6dns2 + + + enableUser + New response parameters: iscallerchilddomain + + + addNiciraNvpDevice + New request parameters: l3gatewayserviceuuid (optional) + New response parameters: hostname, l3gatewayserviceuuid, transportzoneuuid + + + createNetworkOffering + New request parameters: ispersistent (optional) + New response parameters: ispersistent + + + copyIso + New response parameters: sshkeyenabled + + + createDomain + New request parameters: domainid (optional) + + + updateIso + New response parameters: sshkeyenabled + + + updateNetwork + New response parameters: ip6cidr, ip6gateway, ispersistent + + + rebootRouter + New response parameters: ip6dns1, ip6dns2 + + + createFirewallRule + New response parameters: networkid + + + createUser + New request parameters: userid (optional) + New response parameters: iscallerchilddomain + + + deleteUser + New response parameters: displaytext, success + Removed parameters: id, account, accountid, accounttype, apikey, created, domain, domainid, email, firstname, lastname, secretkey, state, timezone, username + + + listVlanIpRanges + New response parameters: endipv6, ip6cidr, ip6gateway, startipv6 + + + updateNetworkOffering + New response parameters: ispersistent + + + listVpnUsers + New response parameters: state + + + listUsers + New response parameters: iscallerchilddomain + + + listIsos + New response parameters: sshkeyenabled + + + + +
+ + +