GET /settings/location_groups/:location_group_id/hypervisor_groups.xml
GET /settings/location_groups/:location_group_id/hypervisor_groups.json

 

On success, an array of compute zones is returned.

XML Output example

 <hypervisor_groups type="array">
<hypervisor_group>
<closed type="boolean">false</closed>
<created_at type="datetime">2013-09-04T12:49:45+03:00</created_at>
<federation_enabled type="boolean">false</federation_enabled>
<federation_id nil="true"/>
<hypervisor_id nil="true"/>
<id type="integer">1</id>
<identifier nil="true"/>
<label>KVM C5 Compute Zone</label>
<location_group_id type="integer">1</location_group_id>
<server_type>virtual</server_type>
<traded type="boolean>false</traded>
    <updated_at type="datetime">2015-04-02T16:47:37+03:00</updated_at>
    <max_host_free_memory type="integer">3819</max_host_free_memory>
    <max_host_cpu type="integer">4</max_host_cpu>
    <prefer_local_reads type="boolean">false</prefer_local_reads>
    <vlan nil="true"/>
    <release_resource_type>ballooning</release_resource_type>
    <network_failure type="boolean">false</network_failure>
    <storage_channel type="integer">2</storage_channel>
    <run_sysprep type="boolean">true</run_sysprep>
    <default_gateway nil="true"/>
    <recovery_type>roundrobin</recovery_type>
    <failover_timeout type="integer">15</failover_timeout>
    <cpu_units type="integer">1000</cpu_units>
    <supplier_version nil="true"/>
    <supplier_provider nil="true"/>
  </hypervisor_group>
  ...
</hypervisor_groups>

Explanation of the data returned:

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

federation_enabled - not relevant to compute zones

federation_id - not relevant to compute zones

closed - not relevant to compute zones

traded - true, if the zone came from the Federation and was subscribed to by the user

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* - title of a compute zone

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

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

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

 

release_resource_type - specify the release resource type. Release resource option allows to free up compute resource resources by over-committing RAM, CPU and CPU shares of virtual servers that are shut down. 

failover_timeout - 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:

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