Add Compute Zone

To add a new compute zone, use the following request:

POST /settings/hypervisor_zones.xml
POST /settings/hypervisor_zones.json

Note that the following requests will become deprecated in future releases.

XML Request Example

curl -i -X POST http://onapp.test/settings/hypervisor_zones.xml -d '<hypervisor_group><label>test</label><server_type>virtual</server_type><location_group_id>38</location_group_id><preconfigured_only>true</preconfigured_only><release_resource_type>memory_guarantee</release_resource_type><max_vms_start_at_once>5</max_vms_start_at_once><recovery_type>roundrobin</recovery_type><failover_timeout>15</failover_timeout><run_sysprep>1</run_sysprep><default_gateway></default_gateway><vlan></vlan><cpu_units>1000</cpu_units><cpu_model_configuration>default</cpu_model_configuration><custom_config></custom_config></hypervisor_group>'-u account_email:API_key -H 'Accept: application/xml' -H 'Content-type:application/xml'

JSON Request Example

curl -i -X POST http://onapp.test/settings/hypervisor_zones.json -d '{"hypervisor_group":{"label":"test", "server_type":"virtual","location_group_id":"38","preconfigured_only":"true","release_resource_type":"memory_guarantee","max_vms_start_at_once":"5","recovery_type":"roundrobin",
"failover_timeout":"15","run_sysprep":"1","default_gateway":"","vlan":"","cpu_units":"1000","cpu_model_configuration":"default","custom_config":""}}' -u account_email:API_key -H 'Accept: application/json' -H 'Content-type: application/json' 

New API Requests

XML Request Example

curl -i -X POST -u user:userpass --url http://onapp.test/settings/hypervisor_zones.xml -H 'Accept: application/xml' -H 'Content-type: application/xml' -d '<hypervisor_group><label>ATHypervisorZone</label><server_type>virtual</server_type><location_group_id>null</location_group_id><release_resource_type>memory_guarantee</release_resource_type><max_vms_start_at_once>5</max_vms_start_at_once><recovery_type>roundrobin</recovery_type><failover_timeout>15</failover_timeout><run_sysprep>true</run_sysprep><default_gateway></default_gateway><vlan></vlan><cpu_units>1000</cpu_units><custom_config></custom_config><hot_migration_auto_converge>moderate</hot_migration_auto_converge><override_hot_migration_configuration>true</override_hot_migration_configuration><simultaneous_hot_migrations_per_hypervisor>5</simultaneous_hot_migrations_per_hypervisor><simultaneous_hot_migrations_per_hypervisor_group>2</simultaneous_hot_migrations_per_hypervisor_group></hypervisor_group>'

JSON Request Example

curl -i -X POST -u user:userpass --url http://onapp.test/settings/hypervisor_zones.json -H 'Accept: application/json' -H 'Content-type: application/json' -d '{"hypervisor_group": {"label": "ATHypervisorZone", "server_type": "virtual", "location_group_id": null, "release_resource_type": "memory_guarantee", "max_vms_start_at_once": 5, "recovery_type": "roundrobin", "failover_timeout": 15, "run_sysprep": true, "default_gateway": "", "vlan": "", "cpu_units": 1000, "custom_config": "", "hot_migration_auto_converge": "moderate", "override_hot_migration_configuration": true, "simultaneous_hot_migrations_per_hypervisor": 5, "simultaneous_hot_migrations_per_hypervisor_group": 2}}'


label* - the title of a new compute zone

server_type - specify the type of servers that will reside within this compute zone:

  • virtual  - choose the virtual type to create a Xen, KVM, VMware, or CloudBoot zone
  • smart - choose the smart server type to create a smart server zone
  • baremetal - choose the baremetal server type to create a baremetal server zone
  • vpc - choose the VPC server type to create a vCloud Director server zone

location_group_id -  specify the ID of the location group to which the compute zone will be assigned

preconfigured_only - specify whether the zone can be used for creating Instance Package VSs only. When this option is enabled, the zone cannot be used during custom virtual server (VSs built by setting resources manually) creation.

release_resource_type - specify the release resource type. The release resource option allows freeing up compute resource resources by over-committing RAM, CPU, and CPU shares of virtual servers that are shut down.  By default, the compute zone is created with the Memory Guarantee option enabled. In this case, the release resources option is not used. Then, to enable resource over-committing you should choose either the Ballooning or Only Started VS option.

  • memory_guarantee - the actual free compute resource memory is calculated. All virtual servers residing on the compute resource will be able to start. 

  • ballooning - free compute resource memory is calculated with the ability to use memory over-committing. The ballooning option is only available for KVM compute resources. NOTE: Virtual server may be migrated to another compute resource if there is not enough memory for it to start up on the compute resource with the ballooning option enabled. 

     Do not use the ballooning option if there is at least one edge or storage server within the compute zone. 


  • only_started_vms - only the memory of running virtual servers is calculated.

max_vms_start_at_once - the maximum number of virtual servers that can be started simultaneously within this compute zone

recovery_type - specify the compute resource selection algorithm, which will be used on virtual server provisioning and recovery, per compute zone:

  • roundrobin - set the roundrobin type to select the compute resource with maximum free RAM during the VS recovery

    Note: this option behaves in different ways, depending on the event:

    • On provisioning, the round-robin algorithm will be used on compute resource selection.
    • On recovery, the compute resource with maximum free RAM will be selected.
  • fillnext - select the fillnext type to select the compute resource with the minimum required free RAM. This option allows to fill compute resource as tightly as possible before starting to use next appliance in the zone 

failover_timeout - time period for which the iterations will run during the failover if the compute resource does not respond

prefer_local_reads - set 1 to minimize the network throughput dependency for read-heavy workloads. When this option is enabled, reads go over the local software bridge to a local replica of the data rather than traverse a physical NIC + switch.

run_sysprep - set 1 to enable Windows virtual server deployment without running sysprep

NOTE: It is not possible to set VS password when creating a Windows-based VMware virtual server without running a sysprep.

cpu_units - set the number of cpu units for applied to each compute resource in this compute zone

cpu_model_configuration - select the CPU model for your compute zone (default, cpu_flags_enabled for CPU extended configuration, or host_passthrough_enabled for passthrough host CPU model)

custom_config - specify any custom commands you want to run when a compute zone is booted

(lightbulb)hot_migration_auto_converge - select the preferable type of auto-converge functionality:

  • minor - auto-converge with default CPU throttling during migration
  • moderate - auto-converge with moderate CPU throttling
  • aggressive - auto-converge with aggressive CPU throttling

(lightbulb)override_hot_migration_configuration - set true to enable overriding hot migration configuration, otherwise set false. 

(lightbulb)simultaneous_hot_migrations_per_hypervisor - the maximum amount of transactions per compute resource, the default value is 5. If not set or set to 0, the total count of Hot Migration Transactions is not limited.

(lightbulb)simultaneous_hot_migrations_per_hypervisor_group - the maximum amount of transactions per compute zone. If not set or set to 0, the total count of Hot Migration Transactions is not limited.

VMware parameters:

default_gateway - external gateway IP address. All virtual servers within the compute zone will be rerouted to this gateway.

vlan - address of a VLAN, on which the default gateway is located, with prefix length specified. For example:

Page History

v. 6.8

  • added the following parameters:
    • hot_migration_auto_converge
    • override_hot_migration_configuration
    • simultaneous_hot_migrations_per_hypervisor
    • simultaneous_hot_migrations_per_hypervisor_group

v.6.3 Edge 1

  • replaced the cpu_flags_enabled parameter with the cpu_model_configuration parameter 


  • added the custom_config parameter


  • added the following parameters:
    • preconfigured_only
    • cpu_flags_enabled


  • added cpu_units parameter 


  • added the following parameters:
    • server_type
    • release_resource_type
    • recovery_type
    • run_sysprep
    • failover_timeout