Product SiteDocumentation Site

Chapter 4. API Changes in 4.2

4.1. Added API Commands in 4.2
4.2. Changed API Commands in 4.2
4.3. Deprecated APIs

4.1. Added API Commands in 4.2

4.1.1. Secondary Storage

  • addImageStore (Adds all types of secondary storage providers, S3/Swift/NFS)
  • createSecondaryStagingStore (Adds a staging secondary storage in each zone)
  • listImageStores (Lists all secondary storages, S3/Swift/NFS)
  • listSecondaryStagingStores (Lists all staging secondary storages)
  • addS3 (Adds a Amazon Simple Storage Service instance.) It is recommended to use addImageStore instead.
  • listS3s (Lists all the Amazon Simple Storage Service instances.) It is recommended to use listImageStores instead.

4.1.2. VM Snapshot

  • createVMSnapshot (Creates a virtual machine snapshot; see Section 2.4.16, “Virtual Machine Snapshots for VMware”)
  • deleteVMSnapshot (Deletes a virtual machine snapshot)
  • listVMSnapshot (Shows a virtual machine snapshot)
  • revertToVMSnapshot (Returns a virtual machine to the state and data saved in a given snapshot)

4.1.3. Load Balancer Health Check

  • createLBHealthCheckPolicy (Creates a new health check policy for a load balancer rule; see Section 2.3.19, “Health Checks for Load Balanced Instances”)
  • deleteLBHealthCheckPolicy (Deletes an existing health check policy from a load balancer rule)
  • listLBHealthCheckPolicies (Displays the health check policy for a load balancer rule)

4.1.4. Egress Firewall Rules

4.1.5. SSH Key

  • resetSSHKeyForVirtualMachine (Resets the SSHkey for virtual machine.)

4.1.6. Bare Metal

  • addBaremetalHost (Adds a new host. Technically, this API command was present in v3.0.6, but its functionality was disabled. See Section 2.4.12, “Kickstart Installation for Bare Metal Provisioning”)
  • 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)

4.1.7. NIC

  • addNicToVirtualMachine (Adds a new NIC to the specified VM on a selected network; see Section 2.3.14, “Configuring Multiple IP Addresses on a Single NIC”)
  • removeNicFromVirtualMachine (Removes the specified NIC from a selected VM.)
  • updateDefaultNicForVirtualMachine (Updates the specified NIC to be the default one for a selected VM.)
  • addIpToNic (Assigns secondary IP to a NIC.)
  • removeIpFromNic (Assigns secondary IP to a NIC.)
  • listNics (Lists the NICs associated with a VM.)

4.1.8. Regions

  • addRegion (Registers a Region into another Region; see Section 2.1.1, “Regions”)
  • 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.)

4.1.9. User

  • getUser (This API can only be used by the Admin. Get user account details by using the API Key.)

4.1.10. API Throttling

  • getApiLimit (Show number of remaining APIs for the invoking user in current window)
  • resetApiLimit (For root admin, if accountId parameter is passed, it will reset count for that particular account, otherwise it will reset all counters)
  • resetApiLimit (Reset the API count.)

4.1.11. Locking

  • lockAccount (Locks an account)
  • lockUser (Locks a user account)

4.1.12. VM Scaling

  • scaleVirtualMachine (Scales the virtual machine to a new service offering.)

4.1.13. Migrate Volume

  • migrateVirtualMachineWithVolume (Attempts migrating VM with its volumes to a different host.)
  • listStorageProviders (Lists storage providers.)
  • findStoragePoolsForMigration (Lists storage pools available for migrating a volume.)

4.1.14. Dedicated IP and VLAN

  • 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.)

4.1.15. Port Forwarding

  • updatePortForwardingRule (Updates a port forwarding rule. Only the private port and the VM can be updated.)

4.1.16. Scale System VM

  • scaleSystemVm (Scale the service offering for a systemVM, console proxy, or secondary storage.)

4.1.17. Deployment Planner

  • listDeploymentPlanners (Lists all the deployment planners available.)

4.1.18. Archive and Delete Events and Alerts

  • archiveEvents (Archive one or more events.)
  • deleteEvents (Delete one or more events.)
  • archiveAlerts (Archive one or more alerts.)
  • deleteAlerts (Delete one or more alerts.)

4.1.19. Host Reservation

  • releaseHostReservation (Releases host reservation.)

4.1.20. Resize Volume

  • resizeVolume (Resizes a volume.)
  • updateVolume (Updates the volume.)

4.1.21. Egress Firewall Rules

  • createEgressFirewallRule (Creates a egress firewall rule for a given network. )
  • deleteEgressFirewallRule (Deletes an egress firewall rule.)
  • listEgressFirewallRules (Lists all egress firewall rules for network.)

4.1.22. Network ACL

  • 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.)

4.1.23. Resource Detail

  • addResourceDetail (Adds detail for the Resource.)
  • removeResourceDetail (Removes detail for the Resource.)
  • listResourceDetails (List resource details.)

4.1.24. Nicira Integration

  • 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.)

4.1.25. BigSwitch VNS

  • addBigSwitchVnsDevice (Adds a BigSwitch VNS device.)
  • deleteBigSwitchVnsDevice (Deletes a BigSwitch VNS device.)
  • listBigSwitchVnsDevices (Lists BigSwitch VNS devices.)

4.1.26. Simulator

  • configureSimulator (Configures a simulator.)

4.1.27. API Discovery

  • listApis (Lists all the available APIs on the server, provided by the API Discovery plugin.)

4.1.28. Global Load Balancer

  • createGlobalLoadBalancerRule (Creates a global load balancer rule.)
  • deleteGlobalLoadBalancerRule (Deletes a global load balancer rule.)
  • updateGlobalLoadBalancerRule (update global load balancer rules.)
  • listGlobalLoadBalancerRules (Lists load balancer rules.)
  • 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)

4.1.29. Load Balancer

  • 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.)

4.1.30. Affinity Group

  • 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.)

4.1.31. Portable IP

  • createPortableIpRange (Adds a range of portable portable IPs to a Region.)
  • deletePortableIpRange (Deletes a range of portable portable IPs associated with a Region.)
  • listPortableIpRanges (Lists portable IP ranges.)

4.1.32. Internal Load Balancer VM

  • stopInternalLoadBalancerVM (Stops an Internal LB VM.)
  • startInternalLoadBalancerVM (Starts an existing Internal LB VM.)
  • listInternalLoadBalancerVMs (List internal LB VMs.)

4.1.33. Network Isolation

  • listNetworkIsolationMethods (Lists supported methods of network isolation.)

4.1.34. Dedicated Resources

  • 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.)

4.2. 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 request parameters are removed: cpuovercommitratio, memoryovercommitratio (optional)
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.
See Section 2.5.3, “API Request Throttling”.
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. See Section 2.4.15, “Reset VM 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. See Section 2.4.14, “Changing a VM's Base Image”.
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)
See Section 2.4.11, “CPU and Memory Over-Provisioning”.
The following request parameters are removed: cpuovercommitratio, memoryovercommitratio
updateCluster
The following request parameters are added: cpuovercommitratio, ramovercommitratio
See Section 2.4.11, “CPU and Memory Over-Provisioning”.
createStoragePool
The following request parameters are added: hypervisor (optional), provider (optional), scope (optional)
The following request parameters have been made mandatory: podid, clusterid
See Section 2.1.3, “Zone-Wide Primary Storage”.
The following response parameter has been added: hypervisor, scope, suitableformigration
listStoragePools
The following request parameter is added: scope (optional)
See Section 2.1.3, “Zone-Wide Primary Storage”.
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

4.3. Deprecated APIs

  • addExternalLoadBalancer (Adds F5 external load balancer appliance.)
  • deleteExternalLoadBalancer (Deletes a F5 external load balancer appliance added in a zone.)
  • listExternalLoadBalancers (Lists F5 external load balancer appliances added in a zone.)