Get List of Compute Zones

To get an array of compute zones set up within your cloud, use the following request:

GET /settings/hypervisor_zones.xml
GET /settings/hypervisor_zones.json

XML Request Example

curl -i -X GET -H 'Accept: application/xml' -H 'Content-type: application/xml' -u account_email:API_key --url http://onapp.test/settings/hypervisor_zones.xml

JSON Request Example

curl -i -X GET -H 'Accept: application/json' -H 'Content-type: application/json' -u account_email:API_key --url http://onapp.test/settings/hypervisor_zones.json 

XML Output Example

<hypervisor_groups type="array">
  <created_at type="datetime">2013-04-11T11:39:01+03:00</created_at>
  <failover_timeout type="integer">15</failover_timeout>
  <id type="integer">1</id>
  <location_group_id type="integer">38</location_group_id>
  <preconfigured_only type="boolean">true</preconfigured_only>
  <max_vms_start_at_once type="integer">2</max_vms_start_at_once>
  <network_failure type="boolean">false</network_failure>
  <prefer_local_reads type="boolean">false</prefer_local_reads>
  <run_sysprep type="boolean">true</run_sysprep>
  <storage_channel type="integer">2</storage_channel>
  <updated_at type="datetime">2013-05-08T11:00:02+03:00</updated_at>
  <vlan nil="true"/>
  <max_host_free_memory type="integer">6435</max_host_free_memory>
  <max_host_cpu type="integer">4</max_host_cpu>
  <cpu_units type="integer">282</cpu_units>
  <supplier_version nil="true"/>
  <supplier_provider nil="true"/>
  <cpu_flags_enabled type="boolean">true</cpu_flags_enabled>
  <cpu_flags type="array"/>


created_at - the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format

updated_at - the date when the compute zone was updated in the [YYYY][MM][DD]T[hh][mm][ss]Z format

default_gateway - external gateway IP address used for the VMware utilization with the external firewall. All virtual machines within a compute zone will be rerouted to this gateway

vlan - address of a VLAN the default gateway is located on. 

id - the compute zone ID

label* - the title of a compute zone

location_group_id - ID of a location group the compute zone is assigned to

preconfigured_only - 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.

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

network_failure - true if all compute resources in the compute zone failed

prefer_local_reads - 1 if the network throughput dependency for read-heavy workloads, otherwise set 0. When the Use Local Read Path feature is enabled, reads go over the local software bridge to a local replica of the data rather than traverse a physical NIC + switch

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

  • roundrobin - set the roundrobin type to select the compute resource with maximum free RAM during the VS recovery
  • fillnext - select the fillnext type to select the compute resource with the minimum required free RAM. This option allows filling compute resource as tightly as possible before starting to use the next appliance in the zone

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. 

  • 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 free memory of running virtual servers is calculated.

    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.

failover_timeout - the time period for which the iterations will run during the failover

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

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

storage_channel - storage channel for the communication with the

max_host_free_memory  - compute resource with maximum RAM value in this zone

max_host_cpu - compute resource with maximum RAM value in this zone

cpu_units - the number of CPU units applied to this zone

cpu_flags_enabled - true if CPU flags are enabled for the compute zone; otherwise false

cpu_flags - an array of CPU flags enabled for this compute zone

Page History


  • added the following parameter:
    • preconfigured_only
    • cpu_flags_enabled
    • cpu_flags


  • added cpu_units parameter


  • added the following parameters:
    • server_type
    • release_resource_type
    • recovery_type
    • run_sysprep
    • failover_timeout
    • storage_channel
    • max_host_free_memory   
    • max_host_cpu