.. Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information# regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. API Changes Introduced in 4.20.1.0 ================================== For the complete list of API commands and params consult the `CloudStack Apidocs`_. Parameters Changed API Commands ------------------------------- .. cssclass:: table-striped table-bordered table-hover +--------------------------------------------------+--------------------------------------------------------------------------------+ | Name | Description | +==================================================+================================================================================+ | ``addKubernetesSupportedVersion`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``addNicToVirtualMachine`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``assignVirtualMachine`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``attachIso`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``cancelStorageMaintenance`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``usediops`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``changeServiceForRouter`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``changeServiceForSystemVm`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``changeServiceForVirtualMachine`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``createAccount`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``apikeyaccess`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``createStoragePool`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``usediops`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``createUser`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``apikeyaccess`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``createVPC`` | **Request:** | | | | | | *Changed Parameters:* | | | | | | - ``cidr`` was 'required' and is now 'optional' | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``createVPCOffering`` | **Request:** | | | | | | *Changed Parameters:* | | | | | | - ``supportedservices`` was 'required' and is now 'optional' | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``createZone`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``routedmodeenabled`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``deleteBackupSchedule`` | **Request:** | | | | | | *New Parameters:* | | | | | | - ``id`` (optional) | | | | | | *Changed Parameters:* | | | | | | - ``virtualmachineid`` was 'required' and is now 'optional' | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``deployVirtualMachine`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``deployVnfAppliance`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``destroyRouter`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``destroySystemVm`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``destroyVirtualMachine`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``detachIso`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``disableAccount`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``apikeyaccess`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``disableUser`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``apikeyaccess`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``enableAccount`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``apikeyaccess`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``enableStorageMaintenance`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``usediops`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``enableUser`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``apikeyaccess`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``findStoragePoolsForMigration`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``usediops`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``generateUsageRecords`` | **Request:** | | | | | | *Changed Parameters:* | | | | | | - ``enddate`` was 'required' and is now 'optional' | | | - ``startdate`` was 'required' and is now 'optional' | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``getUser`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``apikeyaccess`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``importUnmanagedInstance`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``importVm`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``isAccountAllowedToCreateOfferingsWithTags`` | **Request:** | | | | | | *Changed Parameters:* | | | | | | - ``id`` was 'optional' and is now 'required' | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``ldapCreateAccount`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``apikeyaccess`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``listAccounts`` | **Request:** | | | | | | *New Parameters:* | | | | | | - ``apikeyaccess`` (optional) | | | | | | **Response:** | | | | | | *New Parameters:* | | | | | | - ``apikeyaccess`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``listClusters`` | **Request:** | | | | | | *New Parameters:* | | | | | | - ``arch`` (optional) | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``listClustersMetrics`` | **Request:** | | | | | | *New Parameters:* | | | | | | - ``arch`` (optional) | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``listHosts`` | **Request:** | | | | | | *New Parameters:* | | | | | | - ``arch`` (optional) | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``listHostsMetrics`` | **Request:** | | | | | | *New Parameters:* | | | | | | - ``arch`` (optional) | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``listInternalLoadBalancerVMs`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``listKubernetesSupportedVersions`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``listManagementServers`` | **Request:** | | | | | | *New Parameters:* | | | | | | - ``peers`` (optional) | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``listManagementServersMetrics`` | **Request:** | | | | | | *New Parameters:* | | | | | | - ``peers`` (optional) | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``listRouters`` | **Request:** | | | | | | *New Parameters:* | | | | | | - ``arch`` (optional) | | | | | | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``listStoragePools`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``usediops`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``listSystemVms`` | **Request:** | | | | | | *New Parameters:* | | | | | | - ``arch`` (optional) | | | | | | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``listUsers`` | **Request:** | | | | | | *New Parameters:* | | | | | | - ``apikeyaccess`` (optional) | | | | | | **Response:** | | | | | | *New Parameters:* | | | | | | - ``apikeyaccess`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``listVirtualMachines`` | **Request:** | | | | | | *New Parameters:* | | | | | | - ``arch`` (optional) | | | - ``userdataid`` (optional) | | | | | | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``listVirtualMachinesMetrics`` | **Request:** | | | | | | *New Parameters:* | | | | | | - ``arch`` (optional) | | | - ``userdataid`` (optional) | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``listVnfAppliances`` | **Request:** | | | | | | *New Parameters:* | | | | | | - ``arch`` (optional) | | | - ``userdataid`` (optional) | | | | | | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``listVsphereStoragePolicyCompatiblePools`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``usediops`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``listZones`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``routedmodeenabled`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``lockAccount`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``apikeyaccess`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``lockUser`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``apikeyaccess`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``markDefaultZoneForAccount`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``apikeyaccess`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``migrateSystemVm`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``migrateVirtualMachine`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``migrateVirtualMachineWithVolume`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``rebootRouter`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``rebootSystemVm`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``rebootVirtualMachine`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``recoverVirtualMachine`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``removeNicFromVirtualMachine`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``resetPasswordForVirtualMachine`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``resetSSHKeyForVirtualMachine`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``resetUserDataForVirtualMachine`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``resizeVolume`` | **Request:** | | | | | | *New Parameters:* | | | | | | - ``automigrate`` (optional) | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``restoreVirtualMachine`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``revertToVMSnapshot`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``scaleSystemVm`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``startInternalLoadBalancerVM`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``startRouter`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``startSystemVm`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``startVirtualMachine`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``stopInternalLoadBalancerVM`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``stopNetScalerVpx`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``stopRouter`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``stopSystemVm`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``stopVirtualMachine`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``syncStoragePool`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``usediops`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``updateAccount`` | **Request:** | | | | | | *New Parameters:* | | | | | | - ``apikeyaccess`` (optional) | | | | | | **Response:** | | | | | | *New Parameters:* | | | | | | - ``apikeyaccess`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``updateDefaultNicForVirtualMachine`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``updateKubernetesSupportedVersion`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``updateStorageCapabilities`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``usediops`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``updateStoragePool`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``usediops`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``updateUser`` | **Request:** | | | | | | *New Parameters:* | | | | | | - ``apikeyaccess`` (optional) | | | | | | **Response:** | | | | | | *New Parameters:* | | | | | | - ``apikeyaccess`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``updateVMAffinityGroup`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``updateVirtualMachine`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``updateVmNicIp`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``arch`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+ | ``updateZone`` | **Response:** | | | | | | *New Parameters:* | | | | | | - ``routedmodeenabled`` | | | | +--------------------------------------------------+--------------------------------------------------------------------------------+