API Changes Introduced in 4.17.0.0

For the complete list of API commands and params consult the CloudStack Apidocs.

New API Commands

Name

Description

deleteGuestNetworkIpv6Prefix

Deletes an existing guest network IPv6 prefix.

releaseIpAddress

Releases an IP address from the account.

listGuestVlans

Lists all guest vlans

reserveIpAddress

Reserve a public IP to an account.

resetConfiguration

Resets a configuration. The configuration will be set to default value for global setting, and removed from account_details or domain_details for Account/Domain settings

listUsageServerMetrics

Lists Usage Server metrics

listIpv6FirewallRules

Lists all IPv6 firewall rules

patchSystemVm

Attempts to live patch systemVMs - CPVM, SSVM

createNetworkPermissions

Updates network permissions.

listManagementServersMetrics

Lists Management Server metrics

changeOfferingForVolume

Change disk offering of the volume and also an option to auto migrate if required to apply the new disk offering

listTemplateDirectDownloadCertificates

List the uploaded certificates for direct download templates

createIpv6FirewallRule

Creates an Ipv6 firewall rule in the given network (the network has to belong to VPC)

createGuestNetworkIpv6Prefix

Creates a guest network IPv6 prefix.

listGuestNetworkIpv6Prefixes

Lists guest network IPv6 prefixes

listVirtualMachinesUsageHistory

Lists VM stats

provisionTemplateDirectDownloadCertificate

Provisions a host with a direct download certificate

resetNetworkPermissions

Resets network permissions.

listDbMetrics

list the db hosts and statistics

listNetworkPermissions

List network visibility and all accounts that have permissions to view this network.

updateIpv6FirewallRule

Updates Ipv6 firewall rule with specified ID

deleteIpv6FirewallRule

Deletes a IPv6 firewall rule

removeNetworkPermissions

Removes network permissions.

Removed API Commands

Name

Description

deleteExternalLoadBalancer

Deletes a F5 external load balancer appliance added in a zone.

configureF5LoadBalancer

configures a F5 load balancer device

listF5LoadBalancers

lists F5 load balancer devices

listExternalLoadBalancers

Lists F5 external load balancer appliances added in a zone.

deleteF5LoadBalancer

delete a F5 load balancer device

addExternalLoadBalancer

Adds F5 external load balancer appliance.

addF5LoadBalancer

Adds a F5 BigIP load balancer device

listF5LoadBalancerNetworks

lists network that are using a F5 load balancer device

Parameters Changed API Commands

Name

Description

createVPCOffering

Request:

New Parameters:

  • internetprotocol (optional)

Response:

New Parameters:

  • internetprotocol

listVirtualMachinesMetrics

Request:

New Parameters:

  • accumulate (optional)

  • backupofferingid (optional)

Removed Parameters:

  • hostid

  • podid

  • storageid

listNetworks

Request:

New Parameters:

  • associatednetworkid (optional)

  • networkfilter (optional)

  • vlan (optional)

Response:

New Parameters:

  • associatednetwork

  • associatednetworkid

  • egressdefaultpolicy

  • internetprotocol

  • ip6routes

  • ip6routing

updateFirewallRule

Response:

New Parameters:

  • traffictype

restoreVirtualMachine

Response:

New Parameters:

  • keypairs

Removed Parameters:

  • keypair

createEgressFirewallRule

Response:

New Parameters:

  • traffictype

listVPCOfferings

Response:

New Parameters:

  • internetprotocol

uploadVolume

Response:

New Parameters:

  • externaluuid

stopRouter

Response:

New Parameters:

  • softwareversion

listEgressFirewallRules

Response:

New Parameters:

  • traffictype

startRouter

Response:

New Parameters:

  • softwareversion

changeServiceForVirtualMachine

Request:

New Parameters:

  • automigrate (optional)

  • maxiops (optional)

  • miniops (optional)

  • shrinkok (optional)

Response:

New Parameters:

  • keypairs

Removed Parameters:

  • keypair

listFirewallRules

Response:

New Parameters:

  • traffictype

rebootVirtualMachine

Response:

New Parameters:

  • keypairs

Removed Parameters:

  • keypair

updateNetworkOffering

Response:

New Parameters:

  • internetprotocol

updateVPC

Response:

New Parameters:

  • ip6routes

createNetworkOffering

Request:

New Parameters:

  • internetprotocol (optional)

Response:

New Parameters:

  • internetprotocol

updateVmNicIp

Response:

New Parameters:

  • keypairs

Removed Parameters:

  • keypair

startInternalLoadBalancerVM

Response:

New Parameters:

  • softwareversion

updateDiskOffering

Response:

New Parameters:

  • disksizestrictness

stopNetScalerVpx

Response:

New Parameters:

  • softwareversion

destroyVolume

Response:

New Parameters:

  • externaluuid

detachVolume

Response:

New Parameters:

  • externaluuid

rebootRouter

Response:

New Parameters:

  • softwareversion

updateHypervisorCapabilities

Request:

New Parameters:

  • maxdatavolumeslimit (optional)

  • maxhostspercluster (optional)

  • storagemotionenabled (optional)

  • vmsnapshotenabled (optional)

Response:

New Parameters:

  • vmsnapshotenabled

addNicToVirtualMachine

Response:

New Parameters:

  • keypairs

Removed Parameters:

  • keypair

updateDefaultNicForVirtualMachine

Response:

New Parameters:

  • keypairs

Removed Parameters:

  • keypair

updateBackupOffering

Request:

New Parameters:

  • allowuserdrivenbackups (optional)

stopInternalLoadBalancerVM

Response:

New Parameters:

  • softwareversion

restartNetwork

Request:

New Parameters:

  • livepatch (optional)

listHypervisorCapabilities

Response:

New Parameters:

  • vmsnapshotenabled

revokeTemplateDirectDownloadCertificate

Request:

New Parameters:

  • id (optional)

Changed Parameters:

  • hypervisor was ‘required’ and is now ‘optional’

  • name was ‘required’ and is now ‘optional’

Response:

New Parameters:

  • details

  • hostid

  • hostname

  • status

Removed Parameters:

  • displaytext

  • success

createServiceOffering

Request:

New Parameters:

  • diskofferingid (optional)

  • diskofferingstrictness (optional)

Response:

New Parameters:

  • diskofferingdisplaytext

  • diskofferingid

  • diskofferingname

  • diskofferingstrictness

listNiciraNvpDeviceNetworks

Response:

New Parameters:

  • associatednetwork

  • associatednetworkid

  • egressdefaultpolicy

  • internetprotocol

  • ip6routes

  • ip6routing

assignVirtualMachine

Response:

New Parameters:

  • keypairs

Removed Parameters:

  • keypair

resizeVolume

Response:

New Parameters:

  • externaluuid

createVlanIpRange

Response:

New Parameters:

  • cidr

listPaloAltoFirewallNetworks

Response:

New Parameters:

  • associatednetwork

  • associatednetworkid

  • egressdefaultpolicy

  • internetprotocol

  • ip6routes

  • ip6routing

listManagementServers

Response:

New Parameters:

  • javadistribution

  • javaversion

  • kernelversion

  • lastboottime

  • lastserverstart

  • lastserverstop

  • osdistribution

changeServiceForRouter

Response:

New Parameters:

  • softwareversion

updateVolume

Response:

New Parameters:

  • externaluuid

updateVirtualMachine

Response:

New Parameters:

  • keypairs

Removed Parameters:

  • keypair

updateNetwork

Response:

New Parameters:

  • associatednetwork

  • associatednetworkid

  • egressdefaultpolicy

  • internetprotocol

  • ip6routes

  • ip6routing

listNetworkACLLists

Response:

New Parameters:

  • vpcname

migrateVirtualMachine

Response:

New Parameters:

  • keypairs

Removed Parameters:

  • keypair

resetPasswordForVirtualMachine

Response:

New Parameters:

  • keypairs

Removed Parameters:

  • keypair

resetSSHKeyForVirtualMachine

Request:

New Parameters:

  • keypairs (optional)

Changed Parameters:

  • keypair was ‘required’ and is now ‘optional’

Response:

New Parameters:

  • keypairs

Removed Parameters:

  • keypair

createVPC

Response:

New Parameters:

  • ip6routes

listInternalLoadBalancerVMs

Response:

New Parameters:

  • softwareversion

listSrxFirewallNetworks

Response:

New Parameters:

  • associatednetwork

  • associatednetworkid

  • egressdefaultpolicy

  • internetprotocol

  • ip6routes

  • ip6routing

detachIso

Response:

New Parameters:

  • keypairs

Removed Parameters:

  • keypair

listVirtualMachines

Request:

New Parameters:

  • accumulate (optional)

  • backupofferingid (optional)

Response:

New Parameters:

  • keypairs

Removed Parameters:

  • keypair

listDiskOfferings

Request:

New Parameters:

  • storageid (optional)

  • volumeid (optional)

Response:

New Parameters:

  • disksizestrictness

revertToVMSnapshot

Response:

New Parameters:

  • keypairs

Removed Parameters:

  • keypair

deployVirtualMachine

Request:

New Parameters:

  • keypairs (optional)

  • overridediskofferingid (optional)

Response:

New Parameters:

  • keypairs

Removed Parameters:

  • keypair

listVlanIpRanges

Response:

New Parameters:

  • cidr

createDiskOffering

Request:

New Parameters:

  • disksizestrictness (optional)

Response:

New Parameters:

  • disksizestrictness

listVolumes

Response:

New Parameters:

  • externaluuid

listNetworkOfferings

Response:

New Parameters:

  • internetprotocol

createNetwork

Request:

New Parameters:

  • associatednetworkid (optional)

Response:

New Parameters:

  • associatednetwork

  • associatednetworkid

  • egressdefaultpolicy

  • internetprotocol

  • ip6routes

  • ip6routing

listVPCs

Response:

New Parameters:

  • ip6routes

migrateVirtualMachineWithVolume

Response:

New Parameters:

  • keypairs

Removed Parameters:

  • keypair

restartVPC

Request:

New Parameters:

  • livepatch (optional)

attachVolume

Response:

New Parameters:

  • externaluuid

updateVlanIpRange

Response:

New Parameters:

  • cidr

listNetscalerLoadBalancerNetworks

Response:

New Parameters:

  • associatednetwork

  • associatednetworkid

  • egressdefaultpolicy

  • internetprotocol

  • ip6routes

  • ip6routing

createKubernetesCluster

Request:

Removed Parameters:

  • dockerregistryemail

migrateVolume

Response:

New Parameters:

  • externaluuid

listEvents

Request:

New Parameters:

  • resourceid (optional)

  • resourcetype (optional)

Response:

New Parameters:

  • resourceid

  • resourcename

  • resourcetype

updateVMAffinityGroup

Response:

New Parameters:

  • keypairs

Removed Parameters:

  • keypair

migrateVPC

Response:

New Parameters:

  • ip6routes

dedicatePublicIpRange

Response:

New Parameters:

  • cidr

recoverVirtualMachine

Response:

New Parameters:

  • keypairs

Removed Parameters:

  • keypair

listRouters

Response:

New Parameters:

  • softwareversion

listBrocadeVcsDeviceNetworks

Response:

New Parameters:

  • associatednetwork

  • associatednetworkid

  • egressdefaultpolicy

  • internetprotocol

  • ip6routes

  • ip6routing

recoverVolume

Response:

New Parameters:

  • externaluuid

migrateNetwork

Response:

New Parameters:

  • associatednetwork

  • associatednetworkid

  • egressdefaultpolicy

  • internetprotocol

  • ip6routes

  • ip6routing

uploadTemplateDirectDownloadCertificate

Response:

New Parameters:

  • id

  • alias

  • hostsmap

  • hypervisor

  • issuer

  • serialnum

  • subject

  • validity

  • version

  • zoneid

  • zonename

Removed Parameters:

  • displaytext

  • success

importUnmanagedInstance

Response:

New Parameters:

  • keypairs

Removed Parameters:

  • keypair

createVolume

Response:

New Parameters:

  • externaluuid

createFirewallRule

Response:

New Parameters:

  • traffictype

attachIso

Response:

New Parameters:

  • keypairs

Removed Parameters:

  • keypair

listSSHKeyPairs

Request:

New Parameters:

  • id (optional)

destroyRouter

Response:

New Parameters:

  • softwareversion

removeNicFromVirtualMachine

Response:

New Parameters:

  • keypairs

Removed Parameters:

  • keypair

createPrivateGateway

Request:

New Parameters:

  • associatednetworkid (optional)

Changed Parameters:

  • vlan was ‘required’ and is now ‘optional’

updateVPCOffering

Response:

New Parameters:

  • internetprotocol

scaleVirtualMachine

Request:

New Parameters:

  • automigrate (optional)

  • maxiops (optional)

  • miniops (optional)

  • shrinkok (optional)

destroyVirtualMachine

Response:

New Parameters:

  • keypairs

Removed Parameters:

  • keypair

updateEgressFirewallRule

Response:

New Parameters:

  • traffictype

listServiceOfferings

Response:

New Parameters:

  • diskofferingdisplaytext

  • diskofferingid

  • diskofferingname

  • diskofferingstrictness

startVirtualMachine

Response:

New Parameters:

  • keypairs

Removed Parameters:

  • keypair

updateServiceOffering

Response:

New Parameters:

  • diskofferingdisplaytext

  • diskofferingid

  • diskofferingname

  • diskofferingstrictness

stopVirtualMachine

Response:

New Parameters:

  • keypairs

Removed Parameters:

  • keypair

createNetworkACLList

Response:

New Parameters:

  • vpcname